1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16 {\usepackage{lmodern}}{}
18 \fi % end if pdflatex is used
20 % the pages of the TOC are numbered roman
21 % and a PDF-bookmark for the TOC is added
23 \let\myTOC\tableofcontents
24 \renewcommand{\tableofcontents}{%
25 \pdfbookmark[1]{\contentsname}{}
28 \pagenumbering{arabic}}
30 % redefine the \LyX macro for PDF bookmarks
31 \def\LyX{\texorpdfstring{%
32 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
35 \options bibtotoc, idxtotoc, BCOR7.5mm, titlepage
45 \font_typewriter default
46 \font_default_family default
53 \paperfontsize default
56 \pdf_title "LyX's Extended manual"
57 \pdf_author "LyX Team"
58 \pdf_subject "LyX's extended documentation"
59 \pdf_keywords "LyX, Documentation, Extended"
61 \pdf_bookmarksnumbered true
62 \pdf_bookmarksopen true
63 \pdf_bookmarksopenlevel 1
68 \pdf_pagebackref false
69 \pdf_pdfusetitle false
70 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
77 \paperorientation portrait
80 \paragraph_separation indent
82 \quotes_language english
85 \paperpagestyle headings
86 \tracking_changes false
103 \begin_layout Plain Layout
105 Principal maintainer of this file is
110 If you have comments or error corrections, please send them to the LyX
111 Documentation mailing list, <lyx-docs@lists.lyx.org>.
119 \begin_layout Standard
120 \begin_inset CommandInset toc
121 LatexCommand tableofcontents
128 \begin_layout Chapter
132 \begin_layout Standard
135 Extended LyX Features
137 manual, which you are now reading, is essentially Part II of the
139 User's Guide\SpecialChar \@.
142 The reason for splitting this document is simple: the
146 is already huge, and it contains all of the basic features one needs to
147 know in order to prepare most documents.
148 However, the LyX Team has a long-term goal of making LyX extensible through
149 various configuration files and external packages.
150 That means that if you want to support the Fizzwizzle LaTeX package, you
151 can create a layout file for it without having to alter LyX itself.
152 We've already had contributions of several new features this way.
153 This is the place where all of that gets documented.
156 \begin_layout Standard
157 This manual also documents some special features, like fax support, version
158 control, and SGML support, which require additional software to work properly.
159 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
160 spruce up your documents by directly using the powerful features of LaTeX.
165 only WYSIWYM, and will only ever interface to certain LaTeX features.
168 \begin_layout Standard
169 Of course, with all of this extra documentation,
171 Extended LyX Features
173 may itself grow too big for its britches.
174 In that case, you can just call it the
175 \begin_inset Quotes eld
179 \begin_inset Quotes erd
185 \begin_layout Standard
186 If you haven't read the
190 yet, you are definitely in the wrong manual.
195 is the first place to go, since it will direct you to the correct manual,
196 and it also describes the notation and format of all of the manuals.
197 You should also be thoroughly familiar with the
201 and all of the basic features of LyX.
205 \begin_layout Standard
206 In this document, many sections are independent articles contributed by
207 an individual and are noted as such.
208 This person is generally whoever wrote the layout file for the new document
209 class or LaTeX package, or implemented the feature.
210 If there is no mention of an author to a chapter [or chapter sections],
211 that means it was written by the LyX Documentation Team.
214 \begin_layout Standard
215 Since all the topics in this manual depend heavily on LyX's interaction
216 with LaTeX, this first chapter covers the inner workings of LyX and how
217 to direct LyX to generate exactly the LaTeX code you want.
218 It is obviously for more seasoned LyX users.
221 \begin_layout Chapter
225 \begin_layout Section
229 \begin_layout Standard
230 \begin_inset CommandInset label
232 name "sec:lyxandlatex"
236 This chapter is for both TeX-nicians and the LaTeX-curious.
237 In it, we'll explain how LyX and LaTeX work together to produce printable
239 This is the only place in any of the manuals where we assume you know something
243 \begin_layout Standard
244 At one time, we called LyX a
245 \begin_inset Quotes eld
248 WYSIWYM frontend to LaTeX,
249 \begin_inset Quotes erd
252 but that's no longer true.
253 There are frontends to LaTeX out there.
254 They are basically editors with the ability to run LaTeX and mark any errors
255 in the file you're editing.
264 run LaTeX, and it also marks errors in the file, it also does much, much
266 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
267 LyX has also added a few extensions to LaTeX.
268 Try the following sometime: select
270 Export\SpecialChar \menuseparator
280 menu, then look at the preamble of the resulting
285 You'll notice a variety of new macros defined specifically by LyX.
286 These macros are defined automatically, according to the features you use
290 \begin_layout Standard
291 There are several commands that automatically invoke LaTeX.
295 \begin_layout Itemize
301 iew\SpecialChar \menuseparator
311 \begin_layout Itemize
317 iew\SpecialChar \menuseparator
322 pdate\SpecialChar \menuseparator
328 \begin_layout Itemize
336 \SpecialChar \menuseparator
342 \begin_layout Itemize
350 \SpecialChar \menuseparator
356 \begin_layout Standard
357 They will only invoke LaTeX if the file has changed since the last time
362 \begin_layout Standard
363 When you run LaTeX on the file you're editing, LyX performs these steps:
366 \begin_layout Enumerate
367 Convert the document to LaTeX and save to a file with the extension
378 \begin_layout Enumerate
383 file (maybe several times).
386 \begin_layout Enumerate
387 If there are any errors, insert error boxes in the document to mark where
389 These boxes are transient and are not saved along with the document.
392 \begin_layout Standard
393 If you've run LaTeX using
421 , LyX performs two more steps:
424 \begin_layout Itemize
429 to convert the DVI file to PostScript:
433 \begin_layout Itemize
442 , the output file has the extension
447 \begin_layout Itemize
459 , the output file has the extension
467 \begin_layout Itemize
472 or send the PostScript file to the printer.
475 \begin_layout Section
476 \begin_inset Quotes eld
479 Help! LyX generated an unreadable
484 \begin_inset Quotes erd
490 \begin_layout Standard
491 Die-hard LaTeX users will scream and howl this into the night, then declare
492 LyX useless, simply because they didn't RTFM.
495 \begin_layout Standard
496 We're going to set the record straight.
497 LyX produces two kinds of LaTeX files.
498 One is human readable.
499 The other is LyX readable.
500 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
506 file is not human readable.
507 Don't even try to read it.
512 file that you can send to a colleague, select
517 xport\SpecialChar \menuseparator
534 \begin_layout Section
535 Translating LaTeX files into LyX
536 \begin_inset CommandInset label
538 name "sec:Translating-LaTeX-files"
545 \begin_layout Standard
546 You can import a LaTeX file into LyX by using the
551 ile\SpecialChar \menuseparator
556 mport\SpecialChar \menuseparator
564 This will call a program named
568 ---which will create a file
576 ---and then open that file.
579 \begin_layout Standard
584 will translate most legal LaTeX, but not everything.
585 It will leave things it doesn't understand in TeX mode, so after translating
590 , you can look for red text and hand-edit it to look right.
593 \begin_layout Standard
594 If you just want to put a piece of LaTeX code into a LyX file, see Section
599 \begin_inset CommandInset ref
601 reference "sec:latexcodes"
608 \begin_layout Section
609 Inserting LaTeX Code into LyX Documents
610 \begin_inset CommandInset label
612 name "sec:Inserting-LaTeX-Code"
619 \begin_layout Standard
620 \begin_inset CommandInset label
622 name "sec:latexcodes"
626 This is a rather important point: You can always insert LaTeX code into
628 LyX simply cannot, and will probably never be able to, display every possible
630 If ever you need to insert LaTeX commands into your LyX document, you can
631 use the ERT box, which you can insert into your document with
636 nsert\SpecialChar \menuseparator
644 The ERT box comes in three forms: collapsed, open, and inlined.
645 The first two are used just like any other collapsible (foldable) box (such
646 as footnotes), and are useful for significant amounts of LaTeX commands.
648 \begin_inset Quotes eld
652 \begin_inset Quotes erd
655 ERT box displays its content as part of the button, and is useful for very
656 short sections of LaTeX commands.
661 \begin_layout Plain Layout
671 \begin_layout Standard
672 You can switch between all three by right-clicking on the ERT.
673 Note that if you want more than one line of LaTeX commands, you cannot
674 use the inlined mode.
677 \begin_layout Standard
678 Here's an example of inserting LaTeX commands in a LyX document.
679 The code looks like this:
682 \begin_layout LyX-Code
686 \begin_inset Newline newline
692 \begin_inset Newline newline
695 This is an example for a minipage environment.
697 \begin_inset Newline newline
700 can put nearly everything in it, even (non-floating)
701 \begin_inset Newline newline
706 \begin_inset Newline newline
712 \begin_inset Newline newline
716 \begin_inset Newline newline
722 \begin_inset Newline newline
728 \begin_inset Newline newline
734 \begin_inset Newline newline
739 \begin_inset Newline newline
745 \begin_inset Newline newline
751 \begin_inset Newline newline
757 \begin_inset Newline newline
765 \begin_layout LyX-Code
769 \begin_layout Standard
770 The ERT box containing this text is directly after this paragraph.
771 Those of you reading the manual online will only see a bunch of funky text
773 Those reading a printed version of the manuals will see the actual results:
776 \begin_layout Standard
780 \begin_layout Plain Layout
787 \begin_layout Plain Layout
794 \begin_layout Plain Layout
796 This is an example for a minipage environment.
797 You can put nearly everything in it, even (non-floating) figures and tables.
801 \begin_layout Plain Layout
808 \begin_layout Plain Layout
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
827 \begin_layout Plain Layout
834 \begin_layout Plain Layout
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
854 \begin_layout Plain Layout
861 \begin_layout Plain Layout
873 \begin_layout Standard
874 In addition to these two methods, you can also create a separate file containing
875 some complex LaTeX structure.
881 nsert\SpecialChar \menuseparator
892 to include your file (you should select the type
897 We recommend that you only do this if you have a
906 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
910 \begin_layout Standard
911 There are a few last notes to emphasize:
914 \begin_layout Itemize
915 Inside of LyX, LaTeX code appears
920 \begin_layout Itemize
925 check if your LaTeX code is correct.
928 \begin_layout Itemize
929 Beware reinventing the wheel.
932 \begin_layout Standard
933 That last note refers to two things.
934 First, LyX does have quite a few features tucked into it, and more are
936 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
937 feature before you go off merrily coding LaTeX.
938 Second, there are numerous LaTeX packages out there to do all sorts of
939 things, from labels to envelopes to fancy multipage tables.
940 Check out a CTAN site for details (see Section
941 \begin_inset Quotes eld
945 \begin_inset Quotes erd
956 \begin_layout Plain Layout
961 : I seem to do this an awful lot.
962 Sat down and merrily began coding something to print out labels, only to
963 learn that there were already 2 different LaTeX packages to do this.
964 Worse yet --- I had them already!
972 \begin_layout Standard
973 If you do need to do some wild and fancy things within your document, be
974 sure to check out a good LaTeX book for assistance.
975 There are a number of them listed in the bibliography of the
982 \begin_layout Standard
983 There are a number of LaTeX commands which have to be placed before the
984 beginning of the actual text.
985 They go into the preamble, and this is explained in the next section.
988 \begin_layout Section
989 LyX and the LaTeX Preamble
992 \begin_layout Subsection
993 About the LaTeX Preamble
996 \begin_layout Standard
997 \begin_inset CommandInset label
1003 If you already know LaTeX, there is no need to explain here what the preamble
1005 If you don't, the following will give you some ideas --- we recommend again
1006 that you consult a LaTeX book for further information.
1007 In any case, you should read the points below, because they explain what
1008 you can do and what you don't need to do in the LaTeX preamble of a LyX
1012 \begin_layout Standard
1013 The LaTeX preamble comes at the very beginning of a document,
1021 \begin_layout Itemize
1022 declare the document class.
1023 LyX already does this for you.
1027 \begin_layout Standard
1028 If you're a seasoned LaTeX-nician, and you have some custom document class
1029 you want to use, check out the
1031 Customization Manual
1033 for information on how to make LyX interface to it.
1034 Be sure to submit your efforts to the LyX Team for inclusion in future
1039 \begin_layout Itemize
1040 declare the usage of packages.
1041 LaTeX packages provide special commands, which are only available within
1042 a document when the package has been declared in the preamble.
1043 For example, the package
1047 forces all paragraphs to be indented.
1048 There are other packages for labels, envelopes, margins, etc.
1052 \begin_layout Itemize
1053 set counters, variables, lengths and widths.
1054 There are several LaTeX counters and variables which
1058 be set globally from within the preamble in order to have the desired effect.
1059 [There are other variables which you can set and reset inside the document,
1060 too.] Margins are a good example of something which must be set in the preamble.
1061 Another example is the label format for lists.
1062 You can actually set these just about anywhere, but it's best to do it
1063 just once, inside the preamble.
1066 \begin_layout Itemize
1067 declare user defined commands [with
1079 ], mostly abbreviations for LaTeX commands which appear very often inside
1081 Although the preamble is a good place to declare such commands, they
1085 be declared anywhere else [but
1089 they are used for the first time, of course\SpecialChar \ldots{}
1091 This can be useful if there is a lot of raw LaTeX code in your document,
1092 which normally should not be the case.
1095 \begin_layout Standard
1096 LyX adds its own set of definitions to the preamble of the
1101 This makes LaTeX files generated by LyX portable.
1104 \begin_layout Subsection
1105 Changing the Preamble
1108 \begin_layout Standard
1109 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1110 can't change them without patching LyX itself.
1111 You can, however, add your own stuff to the preamble.
1112 There are two ways to do this:
1115 \begin_layout Enumerate
1122 \begin_inset space ~
1145 \SpecialChar \menuseparator
1153 dialog, depending on your frontend.
1154 Note that the LyX keybindings will not work in this dialog, alas.
1157 \begin_layout Enumerate
1158 Use the preamble contents you've added as your default template (see
1159 \begin_inset Quotes eld
1163 \begin_inset Quotes erd
1170 ), so that it will be the default preamble for any file you create.
1173 \begin_layout Standard
1174 LyX adds anything in the
1181 dialog to its own built-in preamble.
1182 Before adding your own declarations in the preamble, you should make sure
1183 that LyX doesn't already support what you want to do (remember what we
1184 said about reinventing the wheel?).
1187 make sure your preamble code is correct
1190 LyX doesn't check it.
1193 \begin_layout Subsection
1197 \begin_layout Standard
1198 Here are some examples of what you can add to a preamble, and what they
1202 \begin_layout Subsubsection
1206 \begin_layout Standard
1207 There are two variables under LaTeX that control page position:
1220 Their names should be self-explanatory.
1221 These variables are useful if you think for a moment about computer labels.
1222 Sometimes, the size of a print medium and the area of the medium that you
1223 can actually print on aren't the same.
1239 \begin_layout Standard
1240 The default values for
1253 \begin_inset space ~
1257 \begin_inset space ~
1261 \begin_inset space ~
1264 the page isn't shifted.
1267 \begin_layout Standard
1268 Unfortunately, some DVI drivers always seem to shift the page.
1269 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1270 If you're using LyX on a system that you don't personally maintain, and
1271 your sysadmin is a doofus,
1284 Suppose you're left and top margins are always 0.5 inches too big.
1285 You can add this to the preamble:
1288 \begin_layout LyX-Code
1296 \begin_layout LyX-Code
1304 \begin_layout Standard
1305 \SpecialChar \ldots{}
1306 and your margins should now be correct.
1309 \begin_layout Subsubsection
1313 \begin_layout Standard
1314 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1315 There's a rather nice package, available at your nearest CTAN archive,
1316 for printing sheets of labels, called
1321 Now, your system may not have this package installed by default.
1322 We leave that up to you to check.
1323 You'll also want to read the documentation for it; we're not going to do
1325 Since this is an example, however, we'll give you an example of how you
1329 \begin_layout Standard
1330 First, make sure you're using the
1335 Next, you need to put the following in your preamble:
1338 \begin_layout LyX-Code
1344 \begin_layout LyX-Code
1350 \begin_layout LyX-Code
1356 \begin_layout LyX-Code
1362 \begin_layout LyX-Code
1368 \begin_layout LyX-Code
1374 \begin_layout LyX-Code
1380 \begin_layout Standard
1381 This sets things up for Avery® label sheets, stock #5360.
1382 You're now ready to print labels, but you'll need to insert LaTeX code,
1383 placing the commands
1395 around each label text.
1396 This and other special features of
1400 are explained in its documentation.
1403 \begin_layout Standard
1404 Someday, someone may write a LyX layout file to support this package directly.
1405 Maybe that someone is you.
1408 \begin_layout Subsubsection
1409 Example #3: Paragraph Indentation
1412 \begin_layout Standard
1413 Americans are trained to indent the first line of
1418 As with all of their other weird quirks, most Americans will whine and
1419 moan until they can have their way and indent the first line of all paragraphs.
1423 \begin_layout Plain Layout
1428 : This was written by an American ---
1432 ! It's my perception of my fellow countrymen.
1433 Tough if you don't like it.
1442 \begin_layout Standard
1443 Of course, this behavior isn't standard typography.
1444 In books, you typically only indent the first line of a paragraph
1448 it follows another one.
1449 The idea behind indenting the first line of a paragraph is to distinguish
1450 neighboring paragraphs from one another.
1451 If there is no previous paragraph, for example, it follows a figure, or
1452 is the first paragraph in a section, then there is no special indentation.
1456 \begin_layout Standard
1457 If you're a typical American, though, you don't care about such esoteric
1458 things; you want your indentation! Add this to the preamble:
1461 \begin_layout LyX-Code
1464 usepackage{indentfirst}
1467 \begin_layout Standard
1468 If your TeX distribution isn't a braindead one, you'll have this package,
1469 and all of your paragraphs will get the indentation you think they deserve.
1472 \begin_layout Subsubsection
1473 Example #4: This Document
1476 \begin_layout Standard
1477 You can also check out the preamble of this document to get an idea of some
1478 of the advanced things you can do.
1479 You'll probably need to make the
1484 reamble\SpecialChar \ldots{}
1487 dialog full-screen to see most of it.
1488 Also, there are more examples and an assortment of LaTeX
1489 \begin_inset Quotes eld
1493 \begin_inset Quotes erd
1497 \begin_inset space ~
1501 \begin_inset CommandInset ref
1503 reference "cha:secrets"
1511 \begin_layout Section
1512 LyX and LaTeX Errors
1515 \begin_layout Standard
1516 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1518 It then uses the log-file from the LaTeX run to do a post-mortem.
1519 As we stated earlier in the chapter, LyX generates two kinds of
1523 files, one of which it uses to locate errors in the document.
1524 If there was an error someplace, LyX will put a box with the word
1525 \begin_inset Quotes eld
1529 \begin_inset Quotes erd
1532 at the appropriate place in the document.
1536 \begin_layout Plain Layout
1537 LyX will occasionally misguess where the error was.
1538 This will typically happen with tables, figures, math, and the preamble.
1543 It will also display a message alerting you to the fact that there were
1547 \begin_layout Standard
1548 You can navigate through the errors by using
1564 \begin_inset Quotes eld
1568 \begin_inset Quotes erd
1571 the error-boxes and view the error message LaTeX produced by clicking on
1575 \begin_layout Standard
1576 Some folks also like to look at the log file directly, accessible from
1581 ocument\SpecialChar \menuseparator
1587 \begin_inset space ~
1591 \begin_inset space ~
1597 There are some fairly common error messages and warnings.
1598 We'll cover those here.
1599 You should look at a good LaTeX book for a complete listing.
1602 \begin_layout Itemize
1603 \begin_inset Quotes eld
1611 \begin_inset Quotes eld
1618 \begin_layout Standard
1619 Anything beginning with these word is a warning message for the purpose
1621 \begin_inset Quotes eld
1625 \begin_inset Quotes erd
1628 the LaTeX code itself.
1629 You'll get messages like this if you added or changed cross-references
1630 or bibliography entries, in which case, LaTeX is trying to tell you that
1631 you need to make another run.
1634 \begin_layout Standard
1635 You can by-and-large ignore these.
1639 \begin_layout Itemize
1640 \begin_inset Quotes eld
1648 \begin_inset Quotes erd
1655 \begin_layout Standard
1656 Another warning message, this time about fonts which LaTeX couldn't find.
1657 The rest of the message will often say something about a replacement font
1661 \begin_layout Standard
1662 You can safely ignore these.
1666 \begin_layout Itemize
1667 \begin_inset Quotes eld
1677 \begin_inset Quotes erd
1684 \begin_layout Standard
1690 They are warning you about lines that were too long and run past the right
1692 Almost always, this is unnoticeable in the final output.
1693 Or, only one or two characters extend past the margin.
1694 LaTeX seems to generate at least one of these messages for just about any
1698 \begin_layout Standard
1699 You can ignore these stupid messages.
1700 Your eyes will tell you if there's a problem with something that's too
1701 wide; just look at the output.
1705 \begin_layout Itemize
1706 \begin_inset Quotes eld
1716 \begin_inset Quotes erd
1723 \begin_layout Standard
1724 Not quite as common as its cousin.
1725 LaTeX seems to like to print lines that are a bit too wide as opposed to
1726 ones that are a bit too narrow.
1727 We have no idea why.
1730 \begin_layout Standard
1731 You can ignore these, too.
1735 \begin_layout Itemize
1736 \begin_inset Quotes eld
1746 \begin_inset Quotes erd
1750 \begin_inset Quotes eld
1760 \begin_inset Quotes erd
1767 \begin_layout Standard
1768 Warnings about troubles breaking the page.
1769 Once again, just look at the output.
1770 Your eyes will tell you where something has gone wrong.
1774 \begin_layout Itemize
1775 \begin_inset Quotes eld
1781 \begin_inset Quotes els
1785 \begin_inset Quotes ers
1791 \begin_inset Quotes erd
1798 \begin_layout Standard
1800 \begin_inset Quotes eld
1804 \begin_inset Quotes erd
1807 isn't installed on this system.
1808 This usually appears because some package your document needs isn't installed.
1809 If you didn't touch the preamble or didn't use the
1815 command, then one of the packages LyX tried to load is missing.
1821 elp\SpecialChar \menuseparator
1828 , to get a list of packages that LyX knows about.
1829 This file is updated whenever you reconfigure LyX (using
1836 \SpecialChar \menuseparator
1841 ) and tells you which packages have been detected and what they do.
1844 \begin_layout Standard
1855 command, and the package in question isn't installed, you'll need to install
1860 \begin_layout Itemize
1861 \begin_inset Quotes eld
1866 LaTeX Error: Unknown option
1869 \begin_inset Quotes erd
1876 \begin_layout Standard
1877 Error messages beginning with this are trying to tell you that you specified
1878 a bad or undefined option to a package.
1879 Check the package's documentation.
1883 \begin_layout Itemize
1884 \begin_inset Quotes eld
1889 Undefined control sequence
1892 \begin_inset Quotes erd
1899 \begin_layout Standard
1900 If you've inserted LaTeX code into your document, but made a typo, you'll
1902 You may have forgotten to load a package.
1903 In any case, this error message usually means that you used an undefined
1908 \begin_layout Standard
1909 There are other error and warning messages.
1910 Some are self-explanatory.
1911 These are usually LaTeX messages.
1912 Others are downright cryptic.
1913 These are actually TeX error messages, and we really have
1917 what they mean or how to decipher them.
1920 \begin_layout Standard
1921 There's a general sequence you should follow if you get error messages:
1924 \begin_layout Enumerate
1925 Look at the LaTeX code you inserted for typos.
1928 \begin_layout Enumerate
1929 If there are no typos, check and see that you used the command(s) correctly.
1932 \begin_layout Enumerate
1933 If you get a bunch of error boxes piled up at the very top of the document,
1934 it means that there are errors in the preamble.
1935 Start debugging your preamble.
1938 \begin_layout Enumerate
1939 If you didn't add anything to the preamble and didn't add any LaTeX code
1940 to the document, the first suspect is your LaTeX distribution itself.
1941 Check for missing packages and install them.
1944 \begin_layout Enumerate
1945 Okay, so there are no missing packages.
1946 Did you use any of the fine-tuning options in LyX? Specifically, did you
1951 any of them, like trying to manually insert lots of
1954 \begin_inset space ~
1967 s? Did you try to kludge something together with these instead of using
1968 the appropriate paragraph environment?
1971 \begin_layout Enumerate
1972 All right, you didn't use any of the fine-tuning options, you played by
1974 Did you try to pull a fancy maneuver? Did you do something funky inside
1975 a table or an equation, like inserting a graphic into a table cell?
1978 \begin_layout Enumerate
1979 Do you have long sections of text where LaTeX cannot find a place to break
1980 a line? By default, LaTeX is rather strict about how much extra inter-word
1981 spacing it will add in order to break a line.
1982 Preferably, you should rework the paragraph to avoid the problem.
1983 If this isn't an option, you can wrap your text in
1989 to make LaTeX's line breaking more, well, sloppy.
1992 \begin_layout Enumerate
1993 Did you go overboard with the nesting? LyX (currently) doesn't check to
1994 make sure you're in the limits for nesting environments.
1995 If you nested a bunch of environments to the
1996 \begin_inset Formula $17^{\mathrm{th}}$
1999 level, that's the problem.
2002 \begin_layout Enumerate
2003 Okay, you didn't get any error messages, but your output looks whacked.
2004 If you have a table or figure that's too wide or long for the page, you
2009 \begin_layout Enumerate
2010 rescale the figure so it fits.
2013 \begin_layout Enumerate
2014 trim down the table so it fits.
2017 \begin_layout Standard
2018 If something else is wrong with the output, and you didn't try to pull anything
2019 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2023 \begin_layout Standard
2024 If all this doesn't help --- well, then
2028 you might have found a bug in LyX\SpecialChar \ldots{}
2032 \begin_layout Chapter
2036 \begin_layout Section
2037 Preparing a Bibliography with BibTeX
2038 \begin_inset CommandInset label
2040 name "sec:Preparing-a-Bibliography"
2047 \begin_layout Standard
2054 Jürgen Spitzmüller
2057 \begin_layout Standard
2058 \begin_inset VSpace bigskip
2064 \begin_layout Standard
2066 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
2070 \begin_inset space \thinspace{}
2076 \begin_inset space ~
2079 setting up your own bibliographic databases),
2083 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2085 LaTeX: A Document Preparation System
2087 , particularly Appendix B.
2088 The rest of this discussion assumes you have created a correct bibliography
2089 file, that you have all relevant environment variables set correctly (esp.
2102 ), and that if sufficiently desperate, you could create and
2103 \begin_inset Quotes eld
2107 \begin_inset Quotes erd
2110 a LaTeX file with a BibTeX database.
2114 \begin_layout Standard
2115 For those who don't know what BibTeX is, it is a system for creating a large
2116 database of your most used journal references.
2117 For all future articles you write, you only need to include this standard
2118 database and reference the appropriate key to each reference.
2119 Even if you write only a few papers with handful of references each, it
2120 is well worth your time to examine BibTeX and decide whether it will be
2124 \begin_layout Standard
2125 To use BibTeX with LyX, first read the
2129 where it describes how to insert citations.
2130 The basic mechanism for inserting BibTeX references is the same.
2131 Then, at the very end of your document, select
2133 Insert\SpecialChar \menuseparator
2138 TOC\SpecialChar \menuseparator
2142 In the resulting dialog, fill out the dialog boxes as follows:
2145 \begin_layout Description
2146 Database: enter the name of your
2159 For searching multiple
2163 files, just enter them in the desired order, separated by commas.
2167 \begin_layout Description
2168 Style: enter the name of your BibTeX style file *without* the
2173 The default style is
2177 (which should be included in your LaTeX distribution, so you don't have
2178 to worry about creating it).
2181 \begin_layout Standard
2182 For each citation, assuming that the source is in the
2191 nsert\SpecialChar \menuseparator
2198 at the correct location in the text, and enter the appropriate reference
2200 Nothing else is required; when invoking
2205 iew\SpecialChar \menuseparator
2212 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2213 including multiple invocations of LaTeX.
2217 \begin_layout Subsection
2218 Alternative Citation Styles
2221 \begin_layout Standard
2222 Standard BibTeX uses numbers (e.
2223 \begin_inset space \thinspace{}
2227 \begin_inset space \space{}
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2238 ) to refer to a cited work.
2239 However, in many scientific disciplines, other citation styles are in use.
2240 The most common one is the author-year style (e.
2241 \begin_inset space \thinspace{}
2245 \begin_inset space \space{}
2249 \begin_inset Quotes eld
2253 \begin_inset Quotes erd
2257 LyX supports two packages that provide this style,
2266 Both packages have their own pros and cons, which cannot be listed in detail.
2267 If you only want to have simple author-year (or author-numerical) style
2268 or if you want to use one of the countless style files for natbib, than
2273 package is probably your choice.
2274 If you need special features like short title references, ibidem etc., you
2275 might consider the fairly new
2282 \begin_layout Standard
2283 The handling of both packages in LyX is basically the same.
2289 ocument\SpecialChar \menuseparator
2300 pane (with the xforms frontend: the
2314 With both packages, you will get some extra features in the citation dialog
2315 and you can select the style of the reference (
2316 \begin_inset Quotes eld
2320 \begin_inset Quotes erd
2324 \begin_inset Quotes eld
2328 \begin_inset Quotes erd
2332 \begin_inset Quotes eld
2336 \begin_inset Quotes erd
2340 \begin_inset Quotes eld
2344 \begin_inset Quotes erd
2348 Note that both packages need specifically designed style files (they both
2349 ship their own, while there are lots of additional style files and even
2350 an interactive style file builder
2354 \begin_layout Plain Layout
2356 \begin_inset Flex URL
2359 \begin_layout Plain Layout
2361 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2378 \begin_layout Subsection
2379 Sectionated Bibliographies
2380 \begin_inset CommandInset label
2382 name "sub:Sectionated-Bibliographies"
2389 \begin_layout Standard
2390 Sometimes you might need to divide your bibliography into several sections.
2391 If you are, for instance, a historian, the possibility to separate sources
2392 and scientific works is most likely a
2393 \begin_inset Quotes eld
2397 \begin_inset Quotes erd
2401 Unfortunately, BibTeX itself does not allow you to do this.
2402 The good news is, though: With the help of some LaTeX packages, BibTeX
2403 can be extended to fit your historical needs.
2406 \begin_layout Standard
2407 As of version 1.4, LyX provides native support for one of these packages,
2416 \begin_layout Plain Layout
2418 \begin_inset Flex URL
2421 \begin_layout Plain Layout
2423 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2433 The advantage of this package (compared to other packages like
2437 ) is that you don't need to define new citation commands.
2438 Instead, you need to prepare different bibliographic databases which include
2439 the entries for the different sections of the bibliography.
2440 For example: If you want to divide your bibliography into the sections
2442 \begin_inset Quotes eld
2446 \begin_inset Quotes erd
2450 \begin_inset Quotes eld
2454 \begin_inset Quotes erd
2457 , you first need to create two bibliographic databases, e.
2458 \begin_inset space \thinspace{}
2462 \begin_inset space \space{}
2477 \begin_layout Standard
2483 ocument\SpecialChar \menuseparator
2494 pane (with the xforms frontend: the
2502 \begin_inset space ~
2508 Now you can insert multiple BibTeX references (as described in section
2509 \begin_inset space ~
2513 \begin_inset CommandInset ref
2515 reference "sec:Preparing-a-Bibliography"
2519 ), one for each section of your bibliography.
2520 Returning to our example: Insert a BibTeX reference for the database
2524 and a second one for the database
2529 You are free to use the same or different styles for each section.
2530 Additionally, you can chose if the bibliography section should contain
2532 \begin_inset Quotes eld
2535 all cited references
2536 \begin_inset Quotes erd
2539 of the specified database(s) (which is the default),
2540 \begin_inset Quotes eld
2543 all uncited references
2544 \begin_inset Quotes erd
2548 \begin_inset Quotes eld
2552 \begin_inset Quotes erd
2556 This might be useful if you would like to separate your bibliography into
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2566 \begin_inset Quotes eld
2570 \begin_inset Quotes erd
2574 \begin_inset Quotes eld
2578 \begin_inset Quotes erd
2582 The titles for the sections can be added as ordinary sections or subsections.
2587 removes the bibliography title, you have manually re-add that, too (as
2588 a chapter* or section*, for instance).
2591 \begin_layout Subsection
2592 Multiple Bibliographies
2595 \begin_layout Standard
2596 Multiple bibliographies, e.
2597 \begin_inset space \thinspace{}
2601 \begin_inset space \space{}
2604 a bibliography for each section or chapter of the document, are not supported
2610 package, which is used for the creation of sectionated bibliographies in
2612 \begin_inset space ~
2616 \begin_inset space ~
2620 \begin_inset CommandInset ref
2622 reference "sub:Sectionated-Bibliographies"
2626 ), provides an easy way to solve this task, if you are willing to use some
2627 LaTeX-Code (ERT, cf.
2628 \begin_inset space ~
2632 \begin_inset space ~
2636 \begin_inset CommandInset ref
2638 reference "sec:Inserting-LaTeX-Code"
2646 \begin_layout Plain Layout
2647 An alternative approach is to use the
2655 package, respectively.
2663 \begin_layout Standard
2669 ocument\SpecialChar \menuseparator
2680 pane (with the xforms frontend: the
2688 \begin_inset space ~
2694 In the document, you have to enclose the sections, which shall contain
2695 their own bibliography (including the BibTeX reference itself), between
2708 (those commands have to be inserted as ERT).
2709 The bibliography will contain all references which have been cited in the
2712 \begin_inset space \thinspace{}
2715 B.: If you are using this approach, then
2719 citation reference has to be inside some btUnit.
2720 Also, the btUnits cannot be nested.
2723 \begin_layout Standard
2727 \begin_layout Section
2731 \begin_layout Subsection
2735 \begin_layout Standard
2736 When you are working on a large file with many sections, it is often convenient
2737 to break up the document into several files, or perhaps you have something
2738 where a table may change from time to time, but the preceding text does
2740 In these cases, you should seriously consider using multipart documents.
2741 For example, scientific papers often have five major sections: the introduction
2742 , observations, results, discussion, and conclusion.
2743 Each of these could be its own separate LyX file, with one
2744 \begin_inset Quotes eld
2748 \begin_inset Quotes erd
2751 file which contains the title, authors, abstract, references, etc., plus
2752 the five included files.
2753 It is important to note that each of these files is a full LyX file which
2754 can be formatted and printed on its own, as well as included in a master
2756 Each of these files must have the same document class, however--- don't
2757 attempt to mix book classes with article classes.
2758 You may also include LaTeX files; however, these files must not have their
2764 everything up to and including the
2776 line must be deleted) or else errors will be generated when you try to
2780 \begin_layout Standard
2781 LyX allows you to include files quite easily with
2786 nsert\SpecialChar \menuseparator
2792 \begin_inset space ~
2798 When you click on this selection a small box is inserted into the file
2799 at the current cursor location.
2800 Clicking on the box raises a dialog which allows you to select the file
2801 to be included, and the method of its inclusion.
2805 \begin_layout Standard
2806 The file selection box should by now be obvious.
2807 The three inclusion methods are
2808 \begin_inset Quotes eld
2812 \begin_inset Quotes erd
2816 \begin_inset Quotes eld
2820 \begin_inset Quotes erd
2824 \begin_inset Quotes eld
2828 \begin_inset Quotes erd
2832 The difference between
2833 \begin_inset Quotes eld
2837 \begin_inset Quotes erd
2841 \begin_inset Quotes eld
2845 \begin_inset Quotes erd
2848 is really only meaningful to LaTeXperts, but the practical difference is
2849 that files which are
2850 \begin_inset Quotes eld
2854 \begin_inset Quotes erd
2857 are typeset beginning on a new page, while files which are
2858 \begin_inset Quotes eld
2862 \begin_inset Quotes erd
2865 are typeset starting on the current page.
2866 Perhaps the labeling in LyX will be changed someday to reflect this.
2869 \begin_layout Standard
2870 Generally, the master file is converted into a full LaTeX file before typesettin
2871 g, while the included files are converted to LaTeX files which do not have
2872 all the preamble information.
2878 \begin_inset space ~
2885 button prevents this conversion.
2888 \begin_layout Standard
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2897 included file allows you to include a file typeset exactly as it appears
2899 \begin_inset space ~
2902 verbatim mode, with the characters set in a fixed-width typewriter font.
2903 Normally, spaces in this file are invisible, though two consecutive spaces
2904 are conserved, unlike LyX's normal treatment of spaces.
2905 However, setting the
2911 \begin_inset space ~
2915 \begin_inset space ~
2919 \begin_inset space ~
2924 checkbox typesets a mark to unambiguously define the presence of a space.
2928 \begin_layout Subsection
2929 Cross-References Between Files
2932 \begin_layout Standard
2933 It is possible to set up cross-references between the different files.
2934 First, open all the files in question: let's call them A and B in a two
2935 file example, where B is included in A.
2936 Let's say you insert a label in A, then want to reference it in B.
2937 Open the cross-reference dialog in whilst in document B, and you can select
2939 \begin_inset Quotes eld
2943 \begin_inset Quotes erd
2949 \begin_layout Section
2950 Fancy Headers and Footers
2953 \begin_layout Standard
2954 The default page layout is rather plain; for an article document class,
2955 all you get is a centered page number at the bottom of the page.
2956 This document is the book class, so it appears to be a bit fancier, but
2957 to really put on a show, you need to set the document page style to
2958 \begin_inset Quotes eld
2962 \begin_inset Quotes erd
2965 , as mentioned in the
2968 \begin_inset space ~
2974 This section describes the LaTeX codes you need to insert in your LaTeX
2975 preamble or the text in order to get the desired effects.
2978 \begin_layout Standard
2979 The page header is divided into three fields, not surprisingly labeled
2980 \begin_inset Quotes eld
2984 \begin_inset Quotes erd
2988 \begin_inset Quotes eld
2992 \begin_inset Quotes erd
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3004 The footer is also divided into these three fields.
3005 The LaTeX commands to set these fields in the simplest manner are
3030 Suppose you wish to put your name in the upper left hand corner of each
3032 Simply insert the following command in the preamble:
3035 \begin_layout Standard
3044 \begin_layout Standard
3045 You will now see your name in the upper left.
3046 If a field has a default entry that you would like to get rid of (often
3047 the page number appears in the central footer, simply include a command
3048 with a blank argument, e.
3049 \begin_inset space \thinspace{}
3055 \begin_layout Standard
3063 \begin_layout Standard
3064 Let's get really fancy: lets put the section number with the word
3065 \begin_inset Quotes eld
3069 \begin_inset Quotes erd
3073 \begin_inset space \thinspace{}
3077 \begin_inset space ~
3080 Section 3) in the upper left, the page number (e.
3081 \begin_inset space \thinspace{}
3085 \begin_inset space ~
3088 Page 4) in the upper right, your name in the lower left, and the date in
3090 The following commands should now appear in the preamble:
3093 \begin_layout Standard
3103 \begin_layout Standard
3111 \begin_layout Standard
3121 \begin_layout Standard
3130 \begin_layout Standard
3138 \begin_layout Standard
3148 \begin_layout Standard
3161 access LaTeX's section and page counters, and so print out the current
3162 section and page numbers.
3169 simply prints out today's date.
3172 \begin_layout Standard
3173 The thicknesses of the horizontal rules drawn beneath the header and above
3174 the footer can also be modified.
3175 If you don't want one of the headers, set its thickness to 0.
3176 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3177 Use the commands, e.
3178 \begin_inset space \thinspace{}
3188 headrulewidth}{0.4pt}
3196 footrulewidth}{0.4pt}
3198 to set the thicknesses.
3201 \begin_layout Standard
3202 You can switch the header/footer settings on and off for individual pages
3207 thispagestyle{empty}
3213 thispagestyle{plain}
3219 thispagestyle{fancy}
3222 Simply insert them in the text on the page you want changed and mark them
3224 In fact, title pages are marked as plain by default, while following pages
3225 are marked fancy when using the global fancy setting.
3228 \begin_layout Standard
3229 There are more complex commands which will let you insert things in the
3230 upper left on odd numbered pages, etc., but I will refer you to the
3234 package documentation for more descriptions.
3235 For example, if you have a teTeX installation, look for
3237 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3243 \begin_layout Standard
3244 As a final example, it is possible to include an Encapsulated PostScript
3245 file in the header or footer.
3246 Suppose you want to put a company logo in the upper lefthand corner.
3247 You might try something like
3250 \begin_layout Standard
3259 includegraphics{logo.eps}}}
3262 \begin_layout Standard
3264 (you may need to preface this with
3268 usepackage{graphics}
3270 if you don't include EPS files elsewhere in your document).
3273 \begin_layout Section
3274 Itemize Bullet Selection
3275 \begin_inset CommandInset label
3284 \begin_layout Standard
3290 \begin_layout Subsection
3294 \begin_layout Standard
3295 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3296 Using this dialog you can easily specify what bullet shape to use at each
3297 level of an itemized list.
3298 These settings are document-wide so you won't be able to specify different
3299 sets of bullets for different paragraphs
3303 \begin_layout Plain Layout
3304 Well, actually you can but you'll have to do it by hand.
3312 \begin_layout Subsection
3316 \begin_layout Standard
3317 Open the dialog by selecting the
3322 ocument\SpecialChar \menuseparator
3329 menu item and then select the
3339 \begin_layout Standard
3340 The dialog provides you with a table of bullet shapes.
3341 A column of buttons on the left of the table provides access to the six
3342 different panels of bullet shapes.
3343 The row of buttons across the top is used to select which bullet depth
3345 A text entry under the table shows the currently selected bullet shape's
3346 LaTeX equivalent and this can be edited if desired.
3347 If you do modify the text you will also need to specify any needed packages
3348 in the LaTeX preamble.
3351 \begin_layout Standard
3352 The six panels are divided up by the packages they require.
3353 The following table shows the mappings from button name to LaTeX packages.
3356 \begin_layout Standard
3358 \begin_inset Tabular
3359 <lyxtabular version="3" rows="7" columns="2">
3361 <column alignment="center" valignment="top" width="0pt">
3362 <column alignment="center" valignment="top" width="0pt">
3364 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3367 \begin_layout Plain Layout
3382 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3385 \begin_layout Plain Layout
3402 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3405 \begin_layout Plain Layout
3420 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3423 \begin_layout Plain Layout
3439 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3442 \begin_layout Plain Layout
3457 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3460 \begin_layout Plain Layout
3477 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3480 \begin_layout Plain Layout
3495 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3498 \begin_layout Plain Layout
3515 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3518 \begin_layout Plain Layout
3533 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3536 \begin_layout Plain Layout
3553 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3556 \begin_layout Plain Layout
3571 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3574 \begin_layout Plain Layout
3591 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3594 \begin_layout Plain Layout
3609 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3612 \begin_layout Plain Layout
3635 \begin_layout Standard
3636 LyX doesn't stop you using bullets from packages you don't have.
3637 If you get errors from LaTeX when you try to view or print the file then
3638 its likely you are missing a package.
3639 LyX doesn't restrict your use since you may be editing locally and exporting
3643 \begin_layout Subsection
3647 \begin_layout Standard
3648 Select which bullet depth you want to change then select the bullet shape
3650 Any changes will not be visible in LyX, but are visible when viewing the
3651 document using xdvi or ghostview.
3654 \begin_layout Standard
3655 You can reset a bullet shape to the default simply by clicking your right
3656 mouse button on the appropriate bullet depth button.
3659 \begin_layout Standard
3664 want to have multiple sets of paragraphs with different sets of bullets
3665 in each then you're going to have to get your hands dirty.
3666 The itemize bullet selection dialog can help though because it provides
3667 you with the LaTeX code for a wide range of bullet shapes.
3668 To make your own custom paragraphs you have the following options:
3671 \begin_layout Standard
3675 \begin_layout Plain Layout
3691 \begin_layout Standard
3695 \begin_layout Plain Layout
3717 \begin_layout Itemize
3718 Use the LaTeX command
3724 to specify a new bullet shape for a given depth.
3725 You'll also need to save the current bullet shape so you can restore it
3727 In this itemized list the following LaTeX code was used to change the bullet
3728 used for the first depth.
3729 \begin_inset Newline newline
3745 \begin_inset Newline newline
3761 \begin_inset Newline newline
3766 Note that the itemize depth is specified in Roman numerals as part of the
3776 \begin_layout Itemize
3780 \begin_layout Plain Layout
3793 Specify each individual entry by starting each item with the bullet shape
3794 enclosed in square brackets and set as TeX.
3795 For example, this item was started with
3808 \begin_layout Standard
3812 \begin_layout Plain Layout
3828 \begin_layout Standard
3829 You'll also need to revert the labelitem back to its previous setting for
3830 the global bullet shape settings to remain in effect.
3831 The way used here was:
3832 \begin_inset Newline newline
3846 \begin_layout Chapter
3847 Special Document Classes
3850 \begin_layout Section
3851 \begin_inset CommandInset label
3853 name "sec:AMS-LaTeX"
3860 \begin_layout Standard
3863 David Johnson; updated by Richard Heck
3866 \begin_layout Standard
3867 \begin_inset VSpace bigskip
3873 \begin_layout Standard
3875 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3876 papers to be submitted to American Mathematical Society publications.
3877 The layouts are not tailored to a specific journal, but easily can be.
3878 You should refer to the AMS documentation for specific instructions for
3879 each journal (usually it will entail only changing a single line in the
3881 That documentation is available on the Web at
3882 \begin_inset Flex URL
3885 \begin_layout Plain Layout
3893 \begin_inset Flex URL
3896 \begin_layout Plain Layout
3898 ftp://ftp.ams.org/pub/tex/amslatex/
3904 These layouts are appropriate, and useful, for any mathematical writing.
3908 \begin_layout Standard
3909 There are two basic AMS LaTeX layouts:
3912 \begin_layout Enumerate
3913 amsart: The standard AMS article format.
3916 \begin_layout Enumerate
3917 amsbook: the standard AMS book (really, monograph) format.
3921 \begin_layout Standard
3922 These layouts themselves contain only the minimum necessary to use the AMS
3924 They do not, in particular, contain any of the `theorem' environments used
3925 for setting theorems, lemmas, and the like.
3926 These are contained, instead, in the
3927 \begin_inset Flex CharStyle:Code
3930 \begin_layout Plain Layout
3936 module, which you will need to load separately when you selected one of
3938 Less commonly used environments are in the
3939 \begin_inset Flex CharStyle:Code
3942 \begin_layout Plain Layout
3943 Theorems (AMS-Extended)
3952 \begin_layout Standard
3953 By default, theorems and the like are numbered consecutively throughout
3954 the document, but this may be modified by loading the module
3955 \begin_inset Flex CharStyle:Code
3958 \begin_layout Plain Layout
3959 Theorems (Order by Section)
3964 or, if you are using
3965 \begin_inset Flex CharStyle:Code
3968 \begin_layout Plain Layout
3975 \begin_inset Flex CharStyle:Code
3978 \begin_layout Plain Layout
3979 Theorems (Order by Chapter)
3985 These will number the results as
3986 \begin_inset Formula $n.m$
3989 , where the first number refers to the section (or chapter) and the second
3990 refers to the total number of results so far in that section (or chapter).
3991 Many environments are also available unnumbered.
3992 These are indicated by an asterisk at the end.
3993 If you happen to want
3997 unnumbered results, the the module
3998 \begin_inset Flex CharStyle:Code
4001 \begin_layout Plain Layout
4007 provides that option.
4010 \begin_layout Standard
4011 Note that these modules do not
4015 to be used with the AMS classes.
4016 It is perfectly possible to use the
4017 \begin_inset Flex CharStyle:Code
4020 \begin_layout Plain Layout
4026 module, and the others mentioned, with other classes, such as
4027 \begin_inset Flex CharStyle:Code
4030 \begin_layout Plain Layout
4037 \begin_inset Flex CharStyle:Code
4040 \begin_layout Plain Layout
4047 \begin_inset Flex CharStyle:Code
4050 \begin_layout Plain Layout
4059 \begin_layout Subsection
4060 What these layouts provide
4063 \begin_layout Standard
4064 There is a long list of included environments provided by these layouts.
4065 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4066 variety of `theorem' environments.
4067 However, the AMS recommends the environments that are available in LyX.
4071 \begin_layout Standard
4072 The following environments---as well as the standard environments, such
4074 \begin_inset Flex CharStyle:Noun
4077 \begin_layout Plain Layout
4084 \begin_inset Flex CharStyle:Noun
4087 \begin_layout Plain Layout
4094 \begin_inset Flex CharStyle:Noun
4097 \begin_layout Plain Layout
4104 \begin_inset Flex CharStyle:Noun
4107 \begin_layout Plain Layout
4114 \begin_inset Flex CharStyle:Noun
4117 \begin_layout Plain Layout
4124 \begin_inset Flex CharStyle:Code
4127 \begin_layout Plain Layout
4134 \begin_inset Flex CharStyle:Code
4137 \begin_layout Plain Layout
4146 \begin_layout Description
4147 Address This should be the author's permanent address.
4150 \begin_layout Description
4152 \begin_inset space ~
4155 Address This should be the author's temporary address at the time of submission,
4156 if different from the Address.
4159 \begin_layout Description
4160 Email Author's e-mail address
4163 \begin_layout Description
4164 URL Author's Web address, if desired.
4167 \begin_layout Description
4168 Keywords Key words or phrases used to identify specific topics discussed
4172 \begin_layout Description
4173 Subjectclass These refer to the AMS Subject Classifications, published and
4176 Mathematical Reviews
4179 These are also available online at the AMS cites listed above.
4182 \begin_layout Description
4186 \begin_layout Description
4190 \begin_layout Description
4194 \begin_layout Standard
4195 The following environments are provided by both the
4196 \begin_inset Flex CharStyle:Code
4199 \begin_layout Plain Layout
4206 \begin_inset Flex CharStyle:Code
4209 \begin_layout Plain Layout
4215 modules, in the latter case in both starred (unnumbered) and unstarred
4216 (numbered) versions.
4217 These same environments are provided only in the starred versions by the
4219 \begin_inset Flex CharStyle:Code
4222 \begin_layout Plain Layout
4231 \begin_layout Theorem
4232 This is typically used for the statements of major results.
4236 \begin_layout Corollary*
4237 This is used for statements which follow fairly directly from previous statement
4239 Again, these can be major results.
4244 These are smaller results needed to prove other statements.
4247 \begin_layout Proposition
4248 These are less major results which (hopefully) add to the general theory
4252 \begin_layout Conjecture
4253 These are statements provided without justification, which the author does
4254 not know how to prove, but which seem to be true (to the author, at least).
4257 \begin_layout Definition*
4258 Guess what this is for.
4259 The font is different for this environment than for the previous ones.
4263 \begin_layout Example*
4264 Used for examples illustrating proven results.
4267 \begin_layout Problem
4268 It's not really known what this is for.
4269 You should figure it out.
4272 \begin_layout Exercise*
4273 Write a description for this one.
4276 \begin_layout Remark
4277 This environment is also a type of theorem, usually a lesser sort of observation.
4280 \begin_layout Claim*
4281 Often used in the course of giving a proof of a larger result.
4285 Generally, these are used to break up long arguments, using specific instances
4291 The numbering scheme for cases is on its own, not together with other numbered
4297 At the end of this environment , a QED symbol (usually a square, but it
4298 can vary with different styles) is placed.
4299 If you want to have other environments within this one---for example, Case
4300 environments---and have the QED symbol appear only after them, then the
4301 other environments need to be nested within the proof environment.
4303 \begin_inset CommandInset ref
4305 reference "sec:Nesting"
4313 for information on nesting.
4316 \begin_layout Standard
4317 And these are provided by
4318 \begin_inset Flex CharStyle:Code
4321 \begin_layout Plain Layout
4322 Theorems (AMS-Extended)
4330 \begin_layout Criterion*
4331 A required condition.
4334 \begin_layout Algorithm*
4335 A general procedure to be used.
4338 \begin_layout Axiom*
4339 This is a property or statement taken as true within the system being discussed.
4342 \begin_layout Condition*
4343 Sometimes used to state a condition assumed within the present context of
4348 Similar to a Remark.
4351 \begin_layout Notation*
4352 Used for the explanation of, yes, notation.
4355 \begin_layout Summary
4356 Do we really need to tell you?
4359 \begin_layout Acknowledgement*
4363 \begin_layout Conclusion*
4364 Sometimes used at the end of a long train of argument.
4368 Used in a way similar to Proposition, though perhaps lower on the scale.
4371 \begin_layout Standard
4372 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4374 They need to be available on your system in order to use these environments.
4377 \begin_layout Section
4381 \begin_layout Standard
4386 can be used to type letters according to German conventions.
4387 A template file is included in
4389 .../lyx/share/templates
4391 for you to use as a starting point.
4394 \begin_layout Section
4398 \begin_layout Standard
4403 provides an alternative to the standard
4408 It provides similar functionality, but you might prefer this layout with
4409 sans serif sections, headings, and more.
4412 \begin_layout Section
4416 \begin_layout Standard
4422 \begin_layout Subsection
4426 \begin_layout Standard
4427 This section describes how LyX can be used to write articles for submission
4428 to the scientific journal
4430 Astronomy and Astrophysics
4432 (www.edpsciences.fr/aa/
4433 \begin_inset Flex URL
4436 \begin_layout Plain Layout
4438 http://www.edpsciences.fr/aa/
4443 ) using Version 5.01 of the document class
4448 This package can be downloaded from the ftp site
4451 \begin_layout Standard
4452 \begin_inset VSpace medskip
4458 \begin_layout Standard
4460 \begin_inset Flex URL
4463 \begin_layout Plain Layout
4465 ftp://ftp.edpsciences.org/pub/aa/readme.html
4473 \begin_layout Standard
4474 \begin_inset VSpace medskip
4480 \begin_layout Standard
4481 A manual comes together with that package, and this text is not meant to
4482 replace the original manual but merely a short guide how to realize the
4483 correct form of your paper.
4487 \begin_layout Standard
4488 Please note that the publisher of the journal was changed from Springer
4489 to EDP Sciences starting January 1, 2001.
4490 That change implicated also some slight changes of the style files, namely
4491 the removal of the thesaurus command.
4492 The LyX class aa supports the newest version of these style files, V 5.01.
4493 If you have an older version installed, please upgrade.
4494 For compatibility, the old (version 4) layout has been kept as
4499 Please refer to the comments in
4501 LyXDir/layouts/aapaper.layout
4506 \begin_layout Subsection
4510 \begin_layout Standard
4511 It is recommended you start from the example template distributed with LyX.
4512 If you are not using a template, note the following settings:
4515 \begin_layout Itemize
4525 ocument\SpecialChar \menuseparator
4532 dialog (OK, that one was obvious).
4535 \begin_layout Itemize
4536 Don't change the option
4539 \begin_inset space ~
4549 The whole layout is done by the macros, you shouldn't change anything.
4552 \begin_layout Subsection
4556 \begin_layout Standard
4557 First thing to enter is the header information.
4558 It consists of seven entries, of which some are optional.
4562 \begin_layout Itemize
4570 \begin_layout Itemize
4578 \begin_layout Itemize
4586 \begin_layout Itemize
4594 \begin_layout Itemize
4599 : [optional] if more than one author: whom to contact for offprint requests.
4602 \begin_layout Itemize
4607 : [optional] mail address for contacts.
4610 \begin_layout Itemize
4618 Received: <date>; Accepted <date>
4621 \begin_layout Standard
4622 There is no need to issue the
4628 command, this is done automatically by LyX when the header is finished.
4629 Although the order of the single header entries doesn't matter it is advised
4630 to keep the above sequence, just to get the best optics and meets the layout
4631 of the real document.
4634 \begin_layout Standard
4635 If you want to place footnotes in the header block, e.
4636 \begin_inset space \thinspace{}
4640 \begin_inset space ~
4643 to state your present address, just use the standard footnote via
4648 nsert\SpecialChar \menuseparator
4656 LyX will automagically use the term
4665 \begin_layout Standard
4666 In addition to these topics, the macros use three additional LaTeX commands
4667 that have no counterpart in LyX:
4670 \begin_layout Itemize
4677 to separate different names for more than one author and institute, respectivel
4681 \begin_layout Itemize
4688 to mark corresponding author/institute pairs.
4689 The institutes are numbered sequentially as they appear in the
4693 field, so you have to put a marker to each author.
4696 \begin_layout Itemize
4703 to supply an email address for fast contact.
4706 \begin_layout Standard
4707 In all cases, the appropriate command has to be entered in LyX and marked
4713 \begin_layout Subsection
4717 \begin_layout Standard
4718 The abstract should immediately follow the header block.
4719 With version 5 the abstract environment was changed to a command, and there
4720 is now a resctriction to only one paragraph.
4721 In addition, it should contain an entry with the keywords.
4722 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4729 by hand and mark it as LaTeX code.
4730 Refer to the example paper.
4733 \begin_layout Subsection
4734 Supported environments
4737 \begin_layout Standard
4738 The A&A paper layout supports the following environments for structuring
4742 \begin_layout Itemize
4748 \begin_layout Itemize
4754 \begin_layout Itemize
4760 \begin_layout Itemize
4766 \begin_layout Itemize
4772 \begin_layout Itemize
4778 \begin_layout Itemize
4784 \begin_layout Itemize
4790 \begin_layout Itemize
4796 \begin_layout Itemize
4802 \begin_layout Itemize
4808 \begin_layout Itemize
4814 \begin_layout Subsection
4815 Commands not supported by LyX
4818 \begin_layout Standard
4819 Some commands are not yet supported by the
4824 Some have already been mentioned.
4825 For the sake of completeness, they are listed all together here:
4828 \begin_layout Itemize
4836 \begin_layout Itemize
4844 \begin_layout Itemize
4852 \begin_layout Itemize
4860 \begin_layout Itemize
4868 \begin_layout Itemize
4876 \begin_layout Itemize
4884 \begin_layout Itemize
4892 \begin_layout Standard
4893 If you want to use any of these commands, you have to enter them yourself.
4896 Do not forget to mark them as LaTeX code!
4899 \begin_layout Subsection
4900 Figure and Table Floats
4903 \begin_layout Standard
4904 LyX provides support for the necessary float environments
4906 figure, figure*, table
4912 , therefore we won't tell much about it here.
4916 \begin_inset space ~
4922 Just remember that tables should be left-aligned.
4923 For that, select the table and change the alignment in
4928 dit\SpecialChar \menuseparator
4934 \begin_inset space ~
4940 \begin_layout Standard
4941 There is only one special thing: the figures with caption besides the figure.
4942 To create such a figure, you have to do the following:
4945 \begin_layout Enumerate
4946 Create a wide figure float:
4951 nsert\SpecialChar \menuseparator
4956 t\SpecialChar \menuseparator
4959 , then right click in the figure and select
4965 \begin_inset space ~
4973 \begin_layout Enumerate
4974 Enter your caption text.
4977 \begin_layout Enumerate
4982 to move the cursor above the caption.
4985 \begin_layout Enumerate
4989 \begin_layout Enumerate
4990 Position the cursor behind the figure and insert a horizontal fill:
4995 nsert\SpecialChar \menuseparator
5001 \begin_inset space ~
5006 \SpecialChar \menuseparator
5010 \begin_inset space ~
5018 \begin_layout Enumerate
5019 Switch to LaTeX mode:
5022 \begin_inset space ~
5030 \begin_layout Enumerate
5040 Do not close the brace!
5043 \begin_layout Enumerate
5044 Position the cursor behind the caption text, switch to LaTeX mode and insert
5048 \begin_inset space ~
5060 \begin_layout Standard
5061 Also, refer to the figures in the example paper.
5064 \begin_layout Subsection
5068 \begin_layout Standard
5069 For submission, the paper has to be formated in a special double-spacing
5071 For this purpose, you have to give the option
5075 to the documentclass.
5076 This must be done using the extra class options field in the
5081 ocument\SpecialChar \menuseparator
5089 Just enter the string
5096 \begin_layout Subsection
5100 \begin_layout Standard
5105 directory contains an example paper written with LyX.
5106 It is the example paper from the original macro package, translated to
5108 Use it for inspiration, and compare the original LaTeX code with LyX way
5112 \begin_layout Section
5116 \begin_layout Standard
5122 \begin_layout Subsection
5126 \begin_layout Standard
5127 AASTeX is a set of macros produced by the American Astronomical Society
5128 to facilitate electronic manuscript submission to the three journals they
5129 publish: the Astrophysical Journal (including the Letters and Supplement),
5130 the Astronomical Journal, and the Publications of the Astronomical Society
5132 LyX has proven to be an excellent tool for generating these documents,
5133 especially given its equation, citation, and figure handling capabilities.
5134 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5135 is the version described here, or higher.
5136 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5137 incompatible with LyX.
5138 The AASTeX package may be downloaded from the AASTeX Web site
5141 \begin_layout Standard
5142 \begin_inset VSpace medskip
5148 \begin_layout Standard
5150 \begin_inset Flex URL
5153 \begin_layout Plain Layout
5155 http://www.journals.uchicago.edu/AAS/AASTeX
5163 \begin_layout Standard
5164 \begin_inset VSpace medskip
5170 \begin_layout Standard
5171 A complete user guide is contained in that package and you should familiarize
5172 yourself with it thoroughly before embarking on writing a paper in LyX.
5173 LyX will not reduce the need to figure out all the AASTeX commands, it
5174 will only reduce the drudgery of typing everything in.
5175 It is your responsibility to ensure that the final exported LaTeX document
5176 conforms completely to the requirements of the journal to which you are
5177 submitting your paper.
5180 \begin_layout Subsection
5181 Starting a New Paper
5184 \begin_layout Standard
5185 I strongly suggest that you start with the AASTeX template file.
5191 ile\SpecialChar \menuseparator
5201 , enter the new file name, then choose the
5206 This will show the most common fields found in a manuscript.
5207 Simply overwrite the existing text (including the brackets,
5211 ) with the correct information.
5212 Many of the AASTeX commands and environments can be implemented directly
5213 in LyX, but some cannot: most noticeably
5225 , which should stick out like a sore thumb if you actually just opened the
5227 For commands such as these, the LaTeX code must be entered directly and
5229 Such commands are referred to as ERT, or Evil Red Text.
5230 I tried to minimize the amount of ERT needed in an AASTeX document, but
5231 there is still a bit more required than any of us would like.
5234 \begin_layout Subsection
5235 Finishing Your Paper
5238 \begin_layout Standard
5239 When the paper is finished to your satisfaction and previews/prints correctly,
5241 \begin_inset Quotes eld
5245 \begin_inset Quotes erd
5248 actions which need to be done before you submit it to the journals.
5252 \begin_layout Enumerate
5253 Export your paper as a LaTeX file (
5258 ile\SpecialChar \menuseparator
5263 xport\SpecialChar \menuseparator
5274 \begin_layout Enumerate
5279 file with your favorite text editor
5283 \begin_layout Enumerate
5284 remove the comment lines before the
5293 \begin_layout Enumerate
5298 usepackage...{fontenc}
5300 line if it appears (usually just after
5315 \begin_layout Enumerate
5316 remove everything between (and including) the
5328 commands, except for any commands you specifically put into the LaTeX preamble
5329 (which should appear immediately after the
5330 \begin_inset Quotes eld
5333 User specified LaTeX commands
5334 \begin_inset Quotes erd
5345 \begin_layout Enumerate
5346 Run the resulting file through LaTeX to make sure it still processes correctly.
5349 \begin_layout Enumerate
5350 Reread the journal requirements to make sure your filenames and formats
5354 \begin_layout Enumerate
5358 \begin_layout Subsection
5359 Comments On Specific Commands
5362 \begin_layout Standard
5363 I will not describe the detailed usage of the individual AASTeX commands:
5364 the AASTeX User Guide (
5368 ) gives a good description of each.
5369 Thus it's probably easiest for me to go down the list as found in the guide
5370 and offer comments where necessary.
5371 So let's begin \SpecialChar \ldots{}
5375 \begin_layout Subsubsection
5376 Things that work as expected
5379 \begin_layout Standard
5383 \begin_layout Plain Layout
5395 \begin_layout Standard
5396 Because they work as you might expect, I simply list them and the section
5497 begin{thebibliography}
5505 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5506 graphicx figure commands (2.14.1),
5530 (2.15.4, amongst other places),
5557 \begin_layout Standard
5558 The following style options also work correctly:
5579 Simply put them in the
5585 Layout\SpecialChar \menuseparator
5591 \begin_layout Standard
5595 \begin_layout Plain Layout
5607 \begin_layout Subsubsection
5608 Things that work, but require more comment
5611 \begin_layout Standard
5612 The following items work, but require a little more discussion:
5615 \begin_layout Itemize
5616 These items are reserved for use by the journal editors, but you can put
5617 them into the LaTeX preamble if you feel compelled to do so:
5650 \begin_layout Itemize
5651 These items may be placed in the LaTeX preamble, and are included as blanks
5652 in the template file:
5673 \begin_layout Itemize
5680 (2.3) -- can only be used
5681 \begin_inset Quotes eld
5685 \begin_inset Quotes erd
5688 , not in the middle of a paragraph.
5689 Use ERT if you need to embed it.
5692 \begin_layout Itemize
5699 (2.3) -- will have extra {} after it.
5700 This should not cause an error.
5703 \begin_layout Itemize
5710 (2.6) -- can only be used
5711 \begin_inset Quotes eld
5715 \begin_inset Quotes erd
5718 , not in the middle of a paragraph.
5719 Use ERT if you need to embed it.
5722 \begin_layout Itemize
5729 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5733 \begin_layout Itemize
5740 (2.8) -- same as for
5747 \begin_layout Itemize
5754 (2.9) -- will have extra {} after it.
5755 This should not cause an error.
5758 \begin_layout Itemize
5765 (2.11) -- will have extra {} after it.
5766 This should not cause an error.
5769 \begin_layout Itemize
5776 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5777 at the beginning of the text and selecting
5779 Insert\SpecialChar \menuseparator
5784 \begin_inset Quotes eld
5788 \begin_inset Quotes erd
5791 inserts an optional argument of the type needed by
5798 Hopefully it will be renamed someday.
5801 \begin_layout Itemize
5814 for the catalog ID optional parameter
5817 \begin_layout Itemize
5830 for the catalog ID optional parameter
5833 \begin_layout Subsubsection
5834 Things not implemented, use ERT
5837 \begin_layout Standard
5841 \begin_layout Plain Layout
5853 \begin_layout Standard
5876 setcounter{equation}
5878 (2.12), Journal name abbreviations (2.13.4),
5914 (2.15.4, insert it as the first element in the lefthand cell after where
5916 Don't use any of LyX's rules in the table),
5928 (2.15.5), much of Misc (2.17, except
5979 \begin_layout Standard
5983 \begin_layout Plain Layout
5995 \begin_layout Subsubsection
5996 Things that cannot be implemented
5999 \begin_layout Standard
6000 \SpecialChar \ldots{}
6001 at least in any meaningful sort of way, so I suggest ignoring them.
6002 They are the references environment (2.13.3), and the deluxetable environment
6004 If you really, really need to use deluxetable, I suggest editing it in
6005 a separate file with a text editor, then using
6010 nsert\SpecialChar \menuseparator
6016 \begin_inset space ~
6021 to include it in your LyX document.
6026 file to see an example of this.
6029 \begin_layout Subsection
6030 FAQs, Tips, Tricks, and Other Ruminations
6033 \begin_layout Subsubsection
6034 Getting LyX and AASTeX to cooperate
6037 \begin_layout Standard
6038 It can be a bit tricky to get LyX to recognize a new layout and document
6040 When all else fails, do this:
6043 \begin_layout Enumerate
6044 Make certain that LaTeX can find AASTeX.
6045 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6046 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6053 \begin_layout Enumerate
6065 \begin_layout Enumerate
6071 ools\SpecialChar \menuseparator
6078 in LyX, then restart LyX.
6081 \begin_layout Enumerate
6082 Open a regular new file, not from a template.
6083 Does AASTeX appear in the class list in
6088 ocument\SpecialChar \menuseparator
6098 \begin_layout Standard
6099 If you get a warning from an existing AASTeX document about not being able
6100 to find the AASTeX layout or a message about
6101 \begin_inset Quotes eld
6104 You should not mix title layouts with normal ones
6105 \begin_inset Quotes erd
6108 , things haven't been installed correctly.
6111 \begin_layout Subsubsection
6112 LaTeX error processing a table
6115 \begin_layout Standard
6116 LyX, by default, attempts to center the table caption/title.
6117 This seems to produce a bad interaction in AASTeX so you should click somewhere
6118 in the caption/title, then select
6123 dit\SpecialChar \menuseparator
6129 \begin_inset space ~
6146 This took care of it for me.
6149 \begin_layout Subsubsection
6151 \begin_inset CommandInset label
6160 \begin_layout Standard
6161 A couple of things: 1) I have noticed some funny spacing in the reference
6162 entries in the text.
6163 When you enter the bibliography item data, make sure their is
6167 space between the last author and the parenthesis setting off the year;
6171 \begin_inset space \thinspace{}
6175 \begin_inset space ~
6189 2) Entering the references at all is not obvious.
6190 The easiest thing is to start typing your first reference at the end of
6191 the document, then mark it as type
6196 That will put a small gray box in front of what you just typed.
6197 Click on the box to fill in the rest of the information.
6198 For new references, go to the end of an existing reference and press return.
6199 That will create a new line with its own box, etc.
6202 \begin_layout Subsubsection
6206 \begin_layout Standard
6207 Even though AASTeX provides its own figure commands (
6213 , for example), I much prefer LaTeX's standard figure commands (with the
6222 \begin_inset space ~
6225 commands as ERT into a Figure Float box if you desire, but I never have
6226 much luck getting the layout right.
6227 With the standard graphics, LyX will insert a
6231 usepackage{graphicx}
6233 command into the LaTeX preamble and handle the figures in the standard
6234 LaTeX2e way, interspersing the figures in the text.
6235 I believe ApJ accepts figures exactly this way now; AJ might still use
6237 \begin_inset Quotes eld
6240 stack everything at the end
6241 \begin_inset Quotes erd
6247 \begin_layout Subsubsection
6248 Things I could have done, but didn't
6251 \begin_layout Standard
6253 \begin_inset Quotes eld
6257 \begin_inset Quotes erd
6260 things I could have implemented, but chose not to.
6261 For instance, I saw no point in double-spacing the text in the LyX window,
6262 even though it is double-spaced in the paper manuscript.
6263 Also, I chose not to make separate layouts for the preprint and preprint2
6265 Since I assume you will spend most of your time in the plain manuscript
6266 mode anyway, I decided not to chew up more disk space with this.
6270 \begin_layout Subsection
6274 \begin_layout Standard
6275 Your mileage may vary.
6276 I've now had papers published by both ApJ and AJ that have had 98% of the
6277 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6279 I have had no trouble with the submission process, and I'm sure the journals
6280 were never aware that there might be a difference.
6281 So, go forth and publish!
6284 \begin_layout Section
6288 \begin_layout Standard
6291 Panayotis Papasotiriou
6294 \begin_layout Subsection
6298 \begin_layout Standard
6299 The ijmpc package is a set of macros that facilitates electronic manuscript
6302 International Journal of Modern Physics C
6305 Similarly, the ijmpd package is for creating manuscripts to be submitted
6308 International Journal of Modern Physics D
6311 Both journals are published by World Scientific.
6312 The corresponding document classes are named
6321 These files, together with instructions for the authors, can be downloaded
6323 \begin_inset Flex URL
6326 \begin_layout Plain Layout
6328 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6334 \begin_inset Flex URL
6337 \begin_layout Plain Layout
6339 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6345 Both packages are modified versions of the standard
6346 \begin_inset Quotes eld
6350 \begin_inset Quotes erd
6353 package, and they are almost (but not exactly) identical.
6354 Most of their features are supported by LyX.
6355 I have used LyX successfully to write articles submitted to both journals
6356 without any problem.
6359 \begin_layout Subsection
6363 \begin_layout Standard
6364 As usual, the easiest way to write a paper is to start with a template.
6370 ile\SpecialChar \menuseparator
6389 This will give an (almost) empty document that includes the most common
6390 fields found in a manuscript.
6391 Simply overwrite the existing text (including the brackets,
6396 You should keep in mind the following remarks.
6399 \begin_layout Enumerate
6400 LyX won't let you change the font size and the page style of the document,
6401 because such modifications are not allowed by both packages.
6404 \begin_layout Enumerate
6405 The language of the document should not be changed.
6406 Before previewing your paper, be sure that the babel package is not used.
6407 To do this, click on
6412 ools\SpecialChar \menuseparator
6430 checkbox in the language settings, and click on
6441 , if you wish to make this change permanent).
6444 \begin_layout Enumerate
6446 \begin_inset Quotes eld
6450 \begin_inset Quotes erd
6453 style must be used to define keywords.
6456 \begin_layout Enumerate
6457 The ijmpc package provides a style named
6458 \begin_inset Quotes eld
6461 Classification Codes
6462 \begin_inset Quotes erd
6465 , which can be used to define classification codes, such as PACS numbers.
6466 Note that this facility is not supported by the ijmpd package.
6469 \begin_layout Enumerate
6470 Several new environments are available:
6471 \begin_inset Quotes eld
6475 \begin_inset Quotes erd
6479 \begin_inset Quotes eld
6483 \begin_inset Quotes erd
6487 \begin_inset Quotes eld
6491 \begin_inset Quotes erd
6495 \begin_inset Quotes eld
6499 \begin_inset Quotes erd
6503 \begin_inset Quotes eld
6507 \begin_inset Quotes erd
6511 \begin_inset Quotes eld
6515 \begin_inset Quotes erd
6519 \begin_inset Quotes eld
6523 \begin_inset Quotes erd
6527 \begin_inset Quotes eld
6531 \begin_inset Quotes erd
6535 \begin_inset Quotes eld
6539 \begin_inset Quotes erd
6543 \begin_inset Quotes eld
6547 \begin_inset Quotes erd
6551 \begin_inset Quotes eld
6555 \begin_inset Quotes erd
6559 \begin_inset Quotes eld
6563 \begin_inset Quotes erd
6567 \begin_inset Quotes eld
6571 \begin_inset Quotes erd
6575 \begin_inset Quotes eld
6579 \begin_inset Quotes erd
6583 Their use is more or less obvious.
6584 LyX supports all these environments; it will use the proper label, text
6585 style, and numbering scheme for each of them.
6588 \begin_layout Enumerate
6589 Both packages use basic citations; the natbib package should not be used.
6590 In LyX, citation references are shown as usual; in the output, citations
6591 are shown as superscripts.
6592 If you want to use a citation as normal text, you should use the
6597 \begin_inset space \thinspace{}
6601 \begin_inset Quotes eld
6605 \begin_inset space ~
6615 \begin_inset Quotes erd
6621 \begin_layout Enumerate
6623 \begin_inset Quotes eld
6627 \begin_inset Quotes erd
6630 section in both packages.
6631 To put acknowledgments, just use the
6632 \begin_inset Quotes eld
6636 \begin_inset Quotes erd
6642 \begin_layout Enumerate
6643 Appendices may be added to the paper,
6647 the Acknowledgments and
6652 LyX provides a special environment, called
6653 \begin_inset Quotes eld
6657 \begin_inset Quotes erd
6660 which marks the beginning of the appendices.
6661 This environment should be left blank; it just sends a LaTeX command, but
6662 nothing is really printed.
6664 \begin_inset Quotes eld
6668 \begin_inset Quotes erd
6671 is printed with blue letters, as a signal that all sections after that
6672 point are appendices.
6673 To write an appendix, use the
6674 \begin_inset Quotes eld
6678 \begin_inset Quotes erd
6682 LyX will number each appendix with capital letters, as required by both
6685 \begin_inset Quotes eld
6689 \begin_inset Quotes erd
6696 be present before the first appendix; if not, all appendices will be numbered
6697 as normal sections in the output.
6700 \begin_layout Enumerate
6701 The ijmpc and the ijmpd packages use the
6705 command to implement table captions.
6706 As a result, a table created by LyX is printed correctly, but its caption
6708 However, you can use some ERT to overpass this problem, so that captions
6709 are printed as expected.
6710 To do so, create a float table as usual, remove the caption, and replace
6721 (sic); you must also the ERT
6725 immediately after the tabular material.
6726 Study the example table included in the template files to see how this
6727 trick is implemented.
6728 Alternatively, If you need table captions, you should implement the whole
6733 file, then include this file to the LyX document (
6738 nsert\SpecialChar \menuseparator
6743 \SpecialChar \menuseparator
6749 \begin_inset space ~
6755 Details on how to create a table float can be found in the files
6763 , included in the corresponding packages.
6766 \begin_layout Subsection
6767 Preparing a paper for submission
6770 \begin_layout Standard
6771 Before you submit your paper you must export the LyX document as a LaTeX
6777 ile\SpecialChar \menuseparator
6782 xport\SpecialChar \menuseparator
6797 \begin_layout Plain Layout
6798 Actually you have the choice between LaTeX (plain) and pdflatex.
6799 If you intend to use pdflatex to prepare the paper, you should use the
6800 pdflatex option so that included graphics are converted to PDF format,
6801 ready for use by pdflatex.
6806 , then make the following changes to the resulting
6813 \begin_layout Enumerate
6814 Remove the comment lines before the
6823 \begin_layout Enumerate
6824 Remove everything between (and including) the
6836 commands, except for any commands you specifically put into the LaTeX preamble.
6839 \begin_layout Standard
6844 file should be saved and processed through LaTeX as many times as necessary.
6845 You may also want to check the resulting
6852 \begin_layout Subsection
6856 \begin_layout Standard
6857 The use of ERT is reduced to two commands, which must be placed at the top
6859 If you started writing your paper by using the
6867 template, the ERT needed is already in its place; you usually don't need
6869 You may only modify the first ERT to specify the information printed to
6870 the top of odd and even pages (authors' names and short paper's title,
6872 This ERT must have the form
6876 markboth{Authors' Names}{Short Paper's Title}
6881 \begin_layout Section
6885 \begin_layout Standard
6891 \begin_layout Subsection
6895 \begin_layout Standard
6896 The iopart package provides a document class to create electronic manuscript
6897 submission to the journals published by the Institute of Physics.
6898 Instructions for the authors how to create a paper using the iopart class
6899 can be downloaded together with the iopart package from the site
6900 \begin_inset Flex URL
6903 \begin_layout Plain Layout
6905 ftp://ftp.iop.org/pub/journals/latex2e
6913 \begin_layout Subsection
6917 \begin_layout Standard
6918 The easiest way to write a paper is to start with the file
6922 that is available in LyX's examples files folder.
6923 Open this file, save it under a new name, and start writing.
6924 The example file explains how to use the special text environments.
6925 Here are the most important advices:
6928 \begin_layout Itemize
6929 To be able to compile your document to a PDF, PS, or DVI, assure that the
6932 Use AMS math package
6934 in the document settings under
6941 \begin_layout Itemize
6944 The title environment defines the kind of your paper.
6945 So use one of the following environments for the title:
6949 \begin_layout Itemize
6958 \begin_layout Itemize
6967 \begin_layout Itemize
6973 for a Topical review
6976 \begin_layout Itemize
6985 \begin_layout Itemize
6994 \begin_layout Itemize
7000 for a Paper (same as Title)
7003 \begin_layout Itemize
7009 for a Preliminary communication
7012 \begin_layout Itemize
7018 for a Rapid communication
7021 \begin_layout Itemize
7027 for a Letter to the editor
7031 \begin_layout Itemize
7034 All title environments except of
7038 can have an optional short title.
7041 \begin_layout Itemize
7042 There is a general title environment
7046 which is not directly supported by the LyX.
7047 This can be used as ERT when your document doesn't fit into one of the
7051 \begin_layout Standard
7052 For more informations like hints for special table and formula formatting,
7053 look at the IOP author guidelines.
7056 \begin_layout Section
7060 \begin_layout Standard
7063 Panayotis Papasotiriou
7066 \begin_layout Subsection
7070 \begin_layout Standard
7071 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7072 that facilitates electronic manuscript submission to the journals they
7074 Most known of them (at least in my domain of interest) are
7076 Astrophysics and Space Science
7082 , but there are many others (see a complete list at
7083 \begin_inset Flex URL
7086 \begin_layout Plain Layout
7088 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7094 The Kluwer package may be downloaded from the site
7095 \begin_inset Flex URL
7098 \begin_layout Plain Layout
7100 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7106 A complete user guide is contained in that package (but it can also be
7107 downloaded separately).
7110 \begin_layout Standard
7111 LyX supports many features of the package but not everything.
7112 However, the ERT needed is reduced to some
7113 \begin_inset Quotes eld
7117 \begin_inset Quotes erd
7120 commands of the package (see
7121 \begin_inset space ~
7125 \begin_inset CommandInset ref
7127 reference "subsec:kluwer_peculiarities"
7132 I have recently used LyX to write an article submitted to the
7134 Astrophysics and Space Science
7136 without any problem.
7139 \begin_layout Subsection
7143 \begin_layout Standard
7144 The easiest way to write a paper is to start with the Kluwer template file.
7147 File\SpecialChar \menuseparator
7162 This will give an (almost) empty document that includes the most common
7163 fields found in a manuscript and a short description of their use.
7164 As in most templates, simply overwrite the existing text (including the
7169 ) with the correct information.
7172 \begin_layout Subsection
7173 Preparing a paper for submission
7176 \begin_layout Standard
7177 As in the AASTeX package, before you submit your paper to a journal you
7179 \begin_inset Quotes eld
7183 \begin_inset Quotes erd
7189 \begin_layout Enumerate
7190 Export your paper as a LaTeX file.
7191 To do this, click on
7196 ile\SpecialChar \menuseparator
7201 xport\SpecialChar \menuseparator
7212 \begin_layout Enumerate
7217 file with a text editor and make the following changes
7221 \begin_layout Enumerate
7222 remove the comment lines before the
7231 \begin_layout Enumerate
7232 remove everything between (and including) the
7244 commands, except for any commands you specifically put into the LaTeX preamble.
7247 \begin_layout Standard
7256 \begin_layout Enumerate
7261 file through LaTeX as many times as necessary (usually up to three).
7264 \begin_layout Enumerate
7270 \begin_inset space \thinspace{}
7277 , and check if everything is OK (it should, if you didn't make any mistake).
7280 \begin_layout Subsection
7281 \begin_inset Quotes eld
7285 \begin_inset Quotes erd
7288 of the Kluwer package
7289 \begin_inset CommandInset label
7291 name "subsec:kluwer_peculiarities"
7298 \begin_layout Standard
7299 The Kluwer package has the following
7300 \begin_inset Quotes eld
7304 \begin_inset Quotes erd
7310 \begin_layout Enumerate
7311 It is possible to write multiple articles in the same LaTeX file
7315 \begin_layout Plain Layout
7316 I can't imagine any good reason to do this.
7322 Each article must be included in the environment
7323 \begin_inset Quotes eld
7327 \begin_inset Quotes erd
7331 Unfortunately, this environment cannot be omitted, even if you write just
7333 Therefore, each article starts with the command
7339 and, obviously, ends with the command
7346 Although this can be implemented in LyX, I didn't included it, since it
7347 looks ugly and can confuse the novice user.
7348 Therefore, you need to enter them directly and mark them as LaTeX code
7350 \begin_inset Quotes eld
7354 \begin_inset Quotes erd
7360 \begin_layout Enumerate
7361 Information given at the beginning of the article (i.e., title, subtitle,
7362 author, institution, running title, running author, abstract and keywords)
7363 must be included in an environment called
7364 \begin_inset Quotes eld
7368 \begin_inset Quotes erd
7372 This is not implemented in LyX, so you must enter title, subtitle etc.
7373 \begin_inset space ~
7376 between two ERT lines (
7391 \begin_layout Enumerate
7392 According to the user manual, the label of each bibliography item must be
7416 \begin_layout Standard
7421 template takes care of all these
7422 \begin_inset Quotes eld
7426 \begin_inset Quotes erd
7430 If you start a new paper using this template you don't need to do anything
7435 \begin_layout Enumerate
7436 don't delete the ERT included in the template, and
7439 \begin_layout Enumerate
7440 copy the example bibliography item included in the template and modify it
7441 as necessary to enter new bibliography items.
7444 \begin_layout Section
7448 \begin_layout Standard
7454 \begin_layout Subsection
7458 \begin_layout Standard
7459 The LyX document classes
7461 article (koma-script)
7465 report (koma-script)
7483 correspond to the LaTeX document classes
7500 \begin_inset space ~
7503 of the Koma-Script family.
7504 They are replacements for the standard document classes
7520 , resp., and fit better to European typography conventions in a number of
7524 \begin_layout Itemize
7525 Standard character size is 11pt in
7527 article (koma-script)
7531 report (koma-script)
7539 letter (koma-script)
7544 \begin_layout Itemize
7545 Headings, labels of the description environment, and a number of elements
7548 letter (koma-script)
7550 document class are set in a bold sans serif font.
7554 \begin_layout Plain Layout
7555 There is a big difference between the bold sans serif old cm fonts and new
7556 ec fonts, especially in the appearance of headings.
7557 In comparison, the ec bold sans serif fonts look a bit thin.
7558 Here the LaTeX package
7566 helps to produce the
7567 \begin_inset Quotes eld
7571 \begin_inset Quotes erd
7574 appearance when using the ec fonts.
7579 The numbering of chapter headings is made in the same way as the numbering
7580 of section headings, that is without the extra line
7581 \begin_inset Quotes eld
7584 Chapter\SpecialChar \ldots{}
7586 \begin_inset Quotes erd
7590 In addition, the appearance of the headings can be modified by using a
7591 number of options (in LyX to be entered in the field
7598 \begin_inset space ~
7608 ayout\SpecialChar \menuseparator
7616 A detailed German description of these options can be found in the Koma-Script
7624 \begin_layout Itemize
7625 The main means in the Koma-Script document classes to design the type area
7634 (in LyX to be entered in the extra class options field in the dialog
7639 ocument\SpecialChar \menuseparator
7647 They make a clearer modification of page margins possible as do the options
7653 ocument\SpecialChar \menuseparator
7661 A detailed German description of these and other type area options can
7662 be found in the Koma-Script documentation
7669 \begin_layout Itemize
7670 The LaTeX document classes of the Koma-Script family define a number of
7671 additional commands.
7672 Those part of it which makes sense in LyX is implemented in corresponding
7676 \begin_layout Standard
7677 A detailed German description of the LaTeX document classes of the Koma-Script
7678 family can be found in the Koma-Script documentation
7686 \begin_layout Plain Layout
7687 There is an English translation
7691 , but it is not a complete one.
7696 The following sections describe only those aspects, which are relevant
7700 \begin_layout Subsection
7701 article (koma-script), report (koma-script), and book (koma-script)
7704 \begin_layout Standard
7705 The document classes
7707 article (koma-script)
7711 report (koma-script)
7721 are implemented in the layout files
7734 They contain all the paragraph types of the corresponding standard document
7747 , resp., partly modified, with the exception of the LyX specific
7751 -type, which is replaced by the new
7755 -type having the same functionality.
7760 -Type there is a number of new paragraph types added.
7767 letter (koma-script)
7772 \begin_layout Itemize
7781 : are equivalents to
7789 , resp., additionally inserting an entry in the table of contents.
7798 are not contained in
7800 article (koma-script)
7805 \begin_layout Itemize
7822 , resp., additionally clearing running heads.
7829 article (koma-script)
7835 \begin_layout Plain Layout
7848 report (koma-script)
7850 , but since this is identical to
7854 , is has not been implemented in LyX.
7862 \begin_layout Itemize
7867 : generates a heading directly above the following paragraph in the standard
7868 character size without affecting the structure of the document.
7871 \begin_layout Itemize
7880 are special captions which respect the different space settings needed
7881 for captions placed above or below an element (if you follow strict typographic
7882 rules, you might want to place table captions always above the table).
7883 You can also use the class option
7900 You need at least Koma-Script version 2.8q to use this.
7903 \begin_layout Itemize
7908 : can be used to set a bonmot, e.
7909 \begin_inset space \thinspace{}
7913 \begin_inset space ~
7916 at the beginning of a chapter.
7917 If you use the optional argument (
7922 nsert\SpecialChar \menuseparator
7924 \begin_inset space ~
7929 ), you can insert the dictum's author there.
7930 Dictum and author are separated by a line.
7931 You need at least Koma-Script version 2.8q to use this.
7938 article (koma-script)
7943 \begin_layout Standard
7944 The following types, together with the standard types
7956 , form the title area of the document.
7957 They must be entered ahead of the first
7958 \begin_inset Quotes eld
7962 \begin_inset Quotes erd
7969 \begin_layout Plain Layout
7970 The corresponding LaTeX commands must appear before the
7981 When such a type is used more than once, the latter usage overwrites the
7982 former one, that means, for every type only the latest usage is valid.
7983 The order of the different types however has, like
7995 , no effect on the appearance of the produced document.
7998 \begin_layout Itemize
8003 : produces a centered paragraph above the ordinary title (
8015 ) for the subject of the document.
8018 \begin_layout Itemize
8023 : produces a centered paragraph below the ordinary title (
8035 ) for the publishers' name.
8038 \begin_layout Itemize
8045 report (koma-script)
8051 produces a centered paragraph on its own page behind the title page, or
8054 article (koma-script)
8056 produces a centered paragraph below the ordinary title (
8075 \begin_layout Itemize
8080 : produces a left aligned paragraph above the ordinary title (
8096 ) for a document`s head.
8099 \begin_layout Itemize
8104 : produces in a double-sided print in
8106 report (koma-script)
8112 a left-aligned paragraph at the top of the title page`s back or has no
8113 effect in a single-sided print or in
8115 article (koma-script)
8120 \begin_layout Itemize
8125 : produces in a double-sided print in
8127 report (koma-script)
8133 a left-aligned paragraph at the bottom of the title page`s back or has
8134 no effect in a single-sided print or in
8136 article (koma-script)
8141 \begin_layout Itemize
8146 : produces a special
8147 \begin_inset Quotes eld
8151 \begin_inset Quotes erd
8154 page ahead of the actual document containing a paragraph without special
8158 \begin_layout Standard
8159 The layout files for the document classes
8161 article (koma-script)
8165 report (koma-script)
8176 This is thought of as a place to define your own types.
8181 in your personal layout directory and edit the file!
8184 \begin_layout Subsection
8185 letter (koma-script)
8188 \begin_layout Standard
8192 \begin_layout Plain Layout
8204 \begin_layout Standard
8208 letter (koma-script)
8210 is implemented in the layout file
8215 It contains all the paragraph types of the corresponding standard document
8220 , partly modified, with the exception of the LyX specific types
8232 type, which is replaced by the new
8237 In addition, it contains, in contrast to the standard document class, the
8255 Furthermore, there are a number of new letter specific types.
8258 \begin_layout Standard
8262 \begin_layout Plain Layout
8274 \begin_layout Standard
8275 The appearance of the letter produced by this document class can be controlled
8276 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8280 \begin_layout Plain Layout
8281 For example, the standard appearance of the letter`s heading, consisting
8282 of name and address, is quite self-willed.
8284 \begin_inset Quotes eld
8288 \begin_inset Quotes erd
8291 heading is produced by the following LaTeX commands in the preamble:
8294 \begin_layout LyX-Code
8304 \begin_layout LyX-Code
8320 \begin_layout LyX-Code
8330 \begin_layout LyX-Code
8350 A detailed German description of such LaTeX commands can be found in the
8351 Koma-Script documentation
8356 With it, the letter's author can produce his personal letter layout.
8359 \begin_layout Standard
8368 define the beginning of the letter and must be used in every letter.
8369 To emphasize them in the LyX document class, they are marked with the letter
8379 \begin_inset space ~
8383 It is possible to write any number of letters in one file.
8388 type produces a new letter using the same addressee and a
8392 type produces a new addressee.
8409 are ordinary paragraph types and can also be used several times in one
8410 and the same letter.
8413 \begin_layout Itemize
8418 : produces a paragraph for the addressee and implicitly defines the beginning
8422 \begin_layout Itemize
8427 : produces a paragraph for the form of address and implicitly produces a
8431 \begin_layout Itemize
8436 : produces a paragraph for a close.
8439 \begin_layout Itemize
8444 : produces a paragraph for a postscript.
8447 \begin_layout Itemize
8452 : produces a paragraph for a distribution list.
8455 \begin_layout Itemize
8460 : produces a paragraph for enclosures.
8463 \begin_layout Standard
8504 are input types provided with a label to enter information, which will
8505 be processed by the document class.
8509 \begin_layout Plain Layout
8510 It could be seen as a matter of inconsequence, that the types
8518 described above are not such input types as well.
8519 Because of the special meaning of those types, however, I have implemented
8520 them as ordinary paragraph types with a one letter mark in the left margin.
8521 Moreover, it would affect my feeling of symmetry, if the
8529 type had such a serious different appearance.
8534 The types must be used ahead of the corresponding
8541 \begin_layout Standard
8542 An implementation of these types in a WYSIWYG fashion does not seem to make
8543 sense, because the real appearance of the produced letter does not only
8544 depend on the usage of the particular type, but also on other factors.
8545 For example, a signature entered in the
8549 type will in the standard behavior appear in the produced letter only,
8550 when in the same letter also a
8555 The entered value of the
8559 type will in the standard behavior not appear in the produced letter at
8561 The possibility to design the letter`s heading freely is already indicated
8562 in a footnote above.
8565 \begin_layout Standard
8566 The input types can also be used as empty paragraphs.
8568 \begin_inset space \thinspace{}
8572 \begin_inset space ~
8584 type is not used at all, in the standard behavior the value of the
8588 type is used as signature, whereas if an empty
8592 type is used, no signature value is defined.
8595 \begin_layout Standard
8596 By using the input types it is possible to write a letter template, containing
8597 filled input types with your personal dates (name, address, etc.) and empty
8598 input types for other dates you want to enter.
8601 \begin_layout Itemize
8606 : sender's name, in the standard behavior appears as a centered paragraph
8607 in small caps in the letter`s heading.
8610 \begin_layout Itemize
8615 : sender's signature, in the standard behavior appears below the
8624 type is used, the value of the
8628 type appears instead.
8631 \begin_layout Itemize
8636 : sender's address, in the standard behavior appears in a centered paragraph
8637 in the letter`s heading below the sender's name.
8640 \begin_layout Itemize
8645 : sender's telephone number, in the standard behavior only sets the LaTeX
8655 \begin_layout Itemize
8660 : place of the letter`s making.
8663 \begin_layout Itemize
8668 : date of the letter`s making.
8677 , in the standard behavior, produce the place and the date in a right-aligned
8678 line below the addressee's field.
8683 type is used, neither place nor date appear, independent of the value of
8693 type is used, the date of the letter `s production is used.
8696 \begin_layout Itemize
8701 : sender`s back address, in the standard behavior appears above the addressee's
8702 field in a small sans serif font.
8705 \begin_layout Itemize
8710 : special mail information, in the standard behavior appears underlined
8711 above the addressee's field below the back address.
8714 \begin_layout Itemize
8719 : additional information, in the standard behavior appears on right side
8720 below the addressee`s field.
8723 \begin_layout Itemize
8728 : the letter's title, in the standard behavior appears in a big, bold, sans
8729 serif font above the subject.
8732 \begin_layout Itemize
8737 : the letter's subject, in the standard behavior appears in a bold font
8745 \begin_layout Standard
8766 produce a business letter like line above the
8770 line containing the fields
8771 \begin_inset Quotes eld
8775 \begin_inset Quotes erd
8779 \begin_inset Quotes eld
8783 \begin_inset Quotes erd
8787 \begin_inset Quotes eld
8791 \begin_inset Quotes erd
8795 \begin_inset Quotes eld
8799 \begin_inset Quotes erd
8803 \begin_inset Quotes eld
8807 \begin_inset Quotes erd
8811 \begin_inset Quotes eld
8815 \begin_inset Quotes erd
8819 For the date field, the value of the
8825 \begin_inset Quotes eld
8828 business letter types
8829 \begin_inset Quotes erd
8832 is used, the value of the
8836 type however does not appear, but only the LaTeX variable
8843 The ordinary output of place and date in a right-aligned line below the
8844 addressee`s field is suppressed.
8845 The types are implemented as input types provided with a label and must
8846 be used ahead of the corresponding
8853 \begin_layout Itemize
8861 \begin_layout Itemize
8869 \begin_layout Itemize
8877 \begin_layout Itemize
8885 \begin_layout Itemize
8893 \begin_layout Subsection
8894 The new letter class: letter (koma-script v.2)
8897 \begin_layout Standard
8900 Jürgen Spitzmüller
8903 \begin_layout Standard
8904 \begin_inset VSpace medskip
8910 \begin_layout Standard
8912 Koma-Script version 2.8 has introduced a new letter class
8916 which supersedes the now unsupported
8921 It has --- on the LaTeX side --- a completely new interface and is not
8922 compatible with the old class.
8923 Therefore, LyX supports both, though it is recommended to use the new class.
8926 \begin_layout Standard
8927 This class covers the same functionality as
8929 letter (koma-script),
8936 (receiver's address, same as
8953 will start a new letter (i.
8954 \begin_inset space \thinspace{}
8958 \begin_inset space ~
8961 you can write several letters per document).
8962 New elements are sender's
8978 and the possibility to use a
8987 nsert\SpecialChar \menuseparator
8997 \begin_layout Standard
8998 The biggest improvement is, though, that the letter's layout is configurable
8999 at almost any needs.
9000 This can be done via the preamble or with a special style file (Letter
9001 Class Option, extension
9005 ), that will be read in as a class option.
9009 \begin_layout Plain Layout
9010 The KOMA package comes with some default
9015 There is, for instance, a
9019 file that follows german typesetting rules, or a
9023 that provides the default layout of the old
9028 The latter can be loaded with the class option
9037 ayout\SpecialChar \menuseparator
9042 ocument\SpecialChar \menuseparator
9054 template that is included in LyX for examples.
9055 A detailed description is to be found in the Koma-Script documentation
9063 \begin_layout Subsection
9067 \begin_layout Standard
9068 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9072 \begin_layout Itemize
9073 The chapter number of a
9077 type appears on a line of its own above the chapter heading instead of
9078 appearing in the same line ahead of it.
9079 The cause for that is the LyX internal behavior for the labeltype
9086 \begin_layout Itemize
9087 The headings of the types
9096 \begin_inset Quotes eld
9100 \begin_inset Quotes erd
9103 LaTeX table of contents, but not in the LyX table of contents (
9108 ocument\SpecialChar \menuseparator
9114 \begin_inset space ~
9118 \begin_inset space ~
9126 \begin_layout Itemize
9131 document class appear in a skip separation mode, not indented.
9132 This is the standard behavior, no special LaTeX commands are needed for
9139 ocument\SpecialChar \menuseparator
9146 dialog the corresponding radio button indicates
9162 value always has the effect that extra LaTeX commands are inserted in the
9163 document to produce the gap, which is not what is wanted in this case.
9166 \begin_layout Section
9174 \begin_layout Standard
9180 \begin_layout Subsection
9184 \begin_layout Standard
9185 These are the layout files for some of the journal formats used by Springer
9186 Verlag and listed on
9187 \begin_inset Flex URL
9190 \begin_layout Plain Layout
9192 http://www.springer.de/author/tex/help-journals.html
9197 , where you should also go to fetch the class files (yes, these are LaTeX2e
9199 It is a modular system: the things common to all journals are implemented
9204 , which journal-specific layout files (such as, e.
9205 \begin_inset space \thinspace{}
9212 for Journal of Geodesy) can include.
9215 \begin_layout Standard
9216 This means that implementing support for any other Springer journal on this
9217 list is as simple as writing your own
9225 file following the outline given in
9233 \begin_layout Standard
9234 It is reasonably well tested only for the Journal of Geodesy.
9243 come with the standard LyX distribution.
9244 Install the relevant class file (downloaded from Springer) in a proper
9245 directory, reconfigure LaTeX (in the teTeX case by running
9249 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9250 LyX and it should work.
9253 \begin_layout Subsection
9257 \begin_layout Standard
9258 A large number of theorem-like styles ---
9264 \SpecialChar \ldots{}
9270 \begin_layout Standard
9273 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9274 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9277 See the Springer class file documentation for details.
9280 \begin_layout Subsection
9284 \begin_layout Itemize
9296 \begin_layout Itemize
9299 Probability Theory and Related Fields
9305 --- Jean-Marc Lasgouttes
9308 \begin_layout Standard
9309 Add your own, it isn't so hard!
9312 \begin_layout Subsection
9316 \begin_layout Standard
9317 These files are partly based on the older
9321 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9327 layout, are now defunct.
9328 Jean-Marc Lasgouttes helped out big in making me find my way around the
9329 LyX layout file mechanism.
9332 \begin_layout Subsection
9336 \begin_layout Standard
9338 But probably less than in the old hacked-LaTeX
9345 \begin_layout Standard
9347 \begin_inset space \thinspace{}
9350 g.: does not display the number for theorem-like layouts, just #.
9353 \begin_layout Section
9361 \begin_layout Standard
9367 \begin_layout Subsection
9371 \begin_layout Standard
9372 These are the layout files for some of the journals of the American Geophysical
9374 It is assumed that you have both the AGU's own class files and AGUplus
9375 installed (everything to be found at
9376 \begin_inset Flex URL
9379 \begin_layout Plain Layout
9381 ftp://ftp.agu.org/journals/latex/journals
9389 \begin_layout Subsection
9393 \begin_layout Standard
9403 They are still called this in the LyX GUI, though their LaTeX equivalents
9404 in the AGU classes are
9415 \begin_layout Standard
9416 Newly defined styles are
9453 These are mostly manuscript attributes and defined in the AGU class documentati
9457 \begin_layout Standard
9458 I suspect this is still badly incomplete.
9461 \begin_layout Subsection
9465 \begin_layout Standard
9482 \begin_layout Subsection
9486 \begin_layout Itemize
9489 Journal of Geophysical Research
9498 \begin_layout Standard
9499 Add your own, it isn't so hard! Look at the
9510 \begin_layout Subsection
9511 Bugs and things to remember
9514 \begin_layout Standard
9515 In order to use the new layouts, you must remember to do the following for
9519 \begin_layout Enumerate
9525 This can be done in the
9527 layout\SpecialChar \menuseparator
9532 document\SpecialChar \menuseparator
9536 (AGU articles are always in English, right? So
9543 \begin_layout Enumerate
9553 (Yes, this is a bug.)
9556 \begin_layout Enumerate
9557 Make sure you use the
9561 bibliography style, by entering
9565 into the second field of the BibTeX inset.
9566 None of the standard styles will do.
9569 \begin_layout Section
9577 \begin_layout Standard
9583 \begin_layout Subsection
9587 \begin_layout Standard
9588 This is the layout file for the European Geophysical Society journals.
9593 can be downloaded from the web site of the EGS under
9594 \begin_inset Flex URL
9597 \begin_layout Plain Layout
9607 \begin_layout Subsection
9611 \begin_layout Standard
9614 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9622 The current layout file is unfortunately very unmodular and would benefit
9623 from using the various
9630 \begin_layout Section
9636 \begin_inset CommandInset label
9645 \begin_layout Standard
9653 \begin_layout Subsection
9657 \begin_layout Standard
9658 This section describes how to use LyX to make slides for overhead projectors.
9659 There are two document classes that can do this: the default slides class
9665 This section documents the former.
9668 \begin_layout Standard
9669 I'm going to say this again, nice and clear, so that there's no misunderstanding
9673 \begin_layout Standard
9674 \begin_inset VSpace bigskip
9680 \begin_layout Standard
9684 This section documents the class
9685 \begin_inset Quotes eld
9693 \begin_inset Quotes erd
9701 \begin_layout Standard
9702 \begin_inset VSpace bigskip
9708 \begin_layout Standard
9709 If you're looking for the documentation for
9710 \begin_inset Quotes eld
9718 \begin_inset Quotes erd
9722 \begin_inset space ~
9726 \begin_inset CommandInset ref
9728 reference "sec:foiltex"
9738 \begin_inset Quotes eld
9746 \begin_inset Quotes erd
9749 ] is actually somewhat better than the default
9757 \begin_layout Plain Layout
9758 \SpecialChar \ldots{}
9759 or so I've been told repeatedly by its advocates.
9760 Having never used it, I have no idea if this claim is true or not.
9765 which this section documents.
9768 \begin_layout Standard
9769 This class is the LaTeX2e improvement of the old
9774 Every LaTeX2e distribution includes this class [which I'll just refer to
9776 \begin_inset Quotes eld
9784 \begin_inset Quotes erd
9787 from now on], so you're bound to have it.
9788 As I noted earlier, there are other classes, such as
9792 , which also produce slides for overhead projectors and do a better job
9794 However, there are some things which
9798 can do which the others can't, such as generate overlays.
9799 Read on to learn more!
9802 \begin_layout Subsection
9804 \begin_inset CommandInset label
9806 name "sec:slidesetup"
9813 \begin_layout Standard
9814 Obviously, to use this document class, you need to select
9815 \begin_inset Quotes eld
9823 \begin_inset Quotes erd
9826 from the class list in the
9831 ocument\SpecialChar \menuseparator
9839 There are some other special things you should know about this class:
9842 \begin_layout Itemize
9843 Don't bother changing the options
9848 They're not supported by the
9855 \begin_layout Itemize
9862 \begin_inset space ~
9867 behaves a bit differently for this class.
9868 The possible choices and what they do are as follows:
9872 \begin_layout Description
9877 The final output contains page numbers in the lower right corner.
9880 \begin_layout Description
9889 , but also prints out any time markers you've put in.
9890 This is the default.
9893 \begin_layout Description
9898 The final output contains no page numbers, time markers, or alignment markers.
9902 \begin_layout Itemize
9907 class has an extra option:
9913 \begin_inset Quotes eld
9921 \begin_inset Quotes erd
9924 in the extra class options.
9928 \begin_layout Standard
9929 Using this options allows you to add time markers to
9935 \begin_inset space ~
9939 \begin_inset CommandInset ref
9941 reference "sec:slideNote"
9949 \begin_layout Standard
9950 You can also use the template file
9951 \begin_inset Quotes eld
9959 \begin_inset Quotes erd
9962 to automatically set up a document to use the
9971 ile\SpecialChar \menuseparator
9973 \begin_inset space ~
9977 \begin_inset space ~
9986 to open your new document].
9987 The template file also contains some examples of the special paragraph
9988 environments used by this class.
9989 I'll describe those next.
9992 \begin_layout Subsection
9993 Paragraph Environments
9996 \begin_layout Subsubsection
9997 Supported Environments
10000 \begin_layout Standard
10001 The first thing you'll notice when you start up a new
10005 document is the font size and type: it's the equivalent of the size
10006 \begin_inset Quotes eld
10014 \begin_inset Quotes erd
10020 \begin_inset space ~
10026 This is also what's used in the output.
10028 \begin_inset Quotes eld
10032 \begin_inset Quotes erd
10035 to remind you that this is a slide.
10036 Your final slides will use a larger font; ergo, you'll have less space.
10037 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10040 \begin_layout Standard
10041 The next thing that becomes obvious is the changes to the paragraph environment
10042 pull-down box [at the far-left end of the toolbar].
10043 Most of the paragraph environments you're used to seeing are missing.
10044 There are also five new ones.
10049 class itself only supports certain paragraph environments:
10052 \begin_layout Itemize
10058 \begin_layout Itemize
10064 \begin_layout Itemize
10070 \begin_layout Itemize
10076 \begin_layout Itemize
10082 \begin_layout Itemize
10088 \begin_layout Itemize
10094 \begin_layout Itemize
10100 \begin_layout Itemize
10106 \begin_layout Itemize
10112 \begin_layout Itemize
10118 \begin_layout Standard
10119 All of the other standard environments, including the section-heading environmen
10120 ts, aren't used in the
10127 \begin_layout Standard
10128 On the other hand, you'll notice the following new environments:
10131 \begin_layout Itemize
10137 \begin_layout Itemize
10143 \begin_layout Itemize
10149 \begin_layout Itemize
10155 \begin_layout Itemize
10161 \begin_layout Standard
10162 These five are kind of quirky, due to a
10163 \begin_inset Quotes eld
10167 \begin_inset Quotes erd
10171 You see, LyX doesn't permit you to nest any other paragraph environment
10172 into an empty environment.
10173 Now, that's fine and dandy, but it means that you wouldn't be able to start
10174 a slide with anything except plain text.
10175 To deal with this, I've performed a little
10176 \begin_inset Quotes eld
10180 \begin_inset Quotes erd
10186 \begin_layout Subsubsection
10187 Quirks of the New Environments
10188 \begin_inset CommandInset label
10190 name "sec:slideQuirk"
10197 \begin_layout Standard
10198 All five of the new paragraph environments are somewhat quirky due to inherent
10199 limitiations in the current version of LyX.
10200 As I just mentioned, LyX forbids environments that begin with another environme
10202 To get around this, the
10206 environment isn't a paragraph environment as described in the
10214 \begin_layout Standard
10215 You should consider
10228 \begin_inset Quotes eld
10231 pseudo-environments.
10232 \begin_inset Quotes erd
10235 They look like a section heading or a
10236 \begin_inset Quotes eld
10244 \begin_inset Quotes erd
10247 but really begin a [and, if necessary, end the previous] paragraph environment.
10257 \begin_inset Quotes eld
10261 \begin_inset Quotes erd
10264 These two perform some action.
10267 \begin_layout Standard
10268 A common feature of all five environments,
10288 , is a rather long-ish label.
10289 The text following this label --- ordinarily the contents of the paragraph
10290 environment --- is utterly irrelevant for
10311 LyX completely ignores it.
10312 In fact, you can leave these five environments completely empty.
10316 \begin_layout Standard
10321 to put any text after the rather long-ish label, you might want to.
10322 This could be a short description of the contents of the
10327 In that case, enter in your descriptive comment and hit
10331 as you normally would.
10334 \begin_layout Standard
10335 If, on the other hand, you don't want to enter in any descriptive text,
10336 you'll hit another LyX quirk.
10337 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10338 environment until you put something in the old one.
10342 \begin_layout Itemize
10343 Start entering the text that will
10371 \begin_layout Itemize
10372 Now move to the beginning of that paragraph.
10376 \begin_layout Itemize
10385 \begin_layout Itemize
10386 Finally, change this new, empty paragraph to a
10410 \begin_layout Standard
10411 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10415 \begin_layout Subsection
10416 Making a Presentation with
10429 \begin_layout Subsubsection
10437 \begin_layout Standard
10438 If you're expecting this section to teach you how to actually make a presentatio
10439 n, you'll be sorely disappointed.
10440 Naturally, I'll describe all of the ways the
10444 class can assist you in preparing the materials for a presentation.
10445 Filling in the contents, however, is up to you.
10450 the LyX philosophy.]
10453 \begin_layout Standard
10458 environment [in the manner described in section
10459 \begin_inset space ~
10463 \begin_inset CommandInset ref
10465 reference "sec:slideQuirk"
10469 ] tells LyX to begin a new slide [duh].
10470 The label for this environment/
10471 \begin_inset Quotes erd
10475 \begin_inset Quotes erd
10479 \begin_inset Quotes eld
10483 \begin_inset Quotes erd
10486 in cool blue, followed by the label,
10487 \begin_inset Quotes eld
10491 \begin_inset Quotes erd
10495 Any text or paragraph environments that follow this one go on the new slide.
10499 \begin_layout Standard
10500 Slides are probably the only time you'll need to forcibly end pages in LyX
10501 (this can be specified in the
10506 In fact, you'll want to, once you finish entering the contents of one slide.
10507 If you've entered more text than can physically fit on a slide, the extra
10508 overflows onto a new slide.
10509 I don't recommend doing this, however, since the overflow slide won't have
10510 any page number on it.
10511 Furthermore, it may interfere with any
10515 you've made to accompany the oversized
10522 \begin_layout Standard
10531 environments work the same way as the
10536 They both create an
10537 \begin_inset Quotes eld
10541 \begin_inset Quotes erd
10544 followed by a label [
10545 \begin_inset Quotes eld
10549 \begin_inset Quotes erd
10553 \begin_inset Quotes eld
10557 \begin_inset Quotes erd
10561 The color is a stunning magenta instead of blue, and the
10562 \begin_inset Quotes eld
10566 \begin_inset Quotes erd
10569 will look different, in style and in length.
10570 The label fonts of all three also differ from one another.
10573 \begin_layout Standard
10578 , if the contents of a
10586 exceed the physical size of a slide or sheet of paper, the extra will overflow
10588 Again, you should avoid this.
10589 It defeats the whole purpose of
10600 \begin_layout Subsubsection
10610 \begin_layout Standard
10615 is a slide that sits atop another slide.
10616 Perhaps you wish to discuss a figure on the main
10620 before displaying the text associated with it.
10621 One way to accomplish this is tape a flap of dark paper over the part of
10626 you want to display later.
10627 This method fails, however, if you wish to overlap one graph with another,
10629 You would then have to fumble while speaking to align the two separate,
10634 s to align the two graphs.
10639 environment in both cases makes life much easier.
10642 \begin_layout Standard
10647 receives the page number of its
10648 \begin_inset Quotes eld
10652 \begin_inset Quotes erd
10660 \begin_inset Quotes eld
10668 \begin_inset Quotes erd
10675 \begin_layout Plain Layout
10676 Presumably, mutliple
10681 \begin_inset Quotes eld
10689 \begin_inset Quotes erd
10693 \begin_inset Quotes eld
10701 \begin_inset Quotes erd
10705 \begin_inset Quotes eld
10713 \begin_inset Quotes erd
10717 \begin_inset space ~
10720 appended to the page number of the parent
10730 Clearly, you want the contents of both the
10738 to each fit on a single physical slide! You should probably consider an
10744 \begin_inset Quotes eld
10748 \begin_inset Quotes erd
10760 class provides a visual cue for this: the label at the start of an
10764 is shorter than that at the start of a
10769 Lastly, when you generate printable output, you'll find alignment markers
10770 in all four corners of both the
10774 page and its parent
10779 These will assist you in lining up the two physical slides.
10782 \begin_layout Standard
10783 The major problem in overlaying two slides is aligning the contents of the
10784 two transparencies.
10785 How much space should you leave for that graph on the second slide? Worse
10786 still, what if you want a graph and a sentence on second slide, but there
10787 is text on the main transparency that goes in between them? You could try
10788 and insert vertical space of the right size.
10789 The better way is to use
10800 \begin_layout Standard
10801 As their names imply,
10809 are two command-like paragraph environments that make all subsequent text
10810 invisible and visible, respectively.
10812 \begin_inset space ~
10816 \begin_inset CommandInset ref
10818 reference "sec:slideQuirk"
10822 that you don't place anything
10826 these two environments, however.
10831 , it inserts a centered, sky-blue label into the page reading
10832 \begin_inset Quotes eld
10835 <Invisible Text Follows>
10836 \begin_inset Quotes erd
10840 For paragraphs following this label, the parts of the
10848 ; it doesn't matter which] where they would be contain instead blank space.
10852 \begin_layout Standard
10857 , the corresponding centered label is
10858 \begin_inset Quotes eld
10861 <Visible Text Follows>
10862 \begin_inset Quotes erd
10866 Paragraphs following this label behave normally.
10867 Note that the beginning of a new
10879 automatically shuts off an
10884 It's therefore not necessary to use
10895 \begin_layout Standard
10896 By now, it should be obvious how to create overlay transparencies using
10897 the proper combination of
10916 \begin_layout Enumerate
10921 , including everything that will appear on it, whether on the main slide
10929 \begin_layout Enumerate
10930 Before each figure or paragraph that will appear only on the
10939 If necessary, insert a
10943 environment after the
10950 \begin_layout Enumerate
10955 immediately following the
10962 \begin_layout Enumerate
10963 Copy the contents of this
10974 \begin_layout Enumerate
10979 , change all of the
10990 \begin_layout Standard
10992 You've just made an
10999 \begin_layout Standard
11000 There's one problem with the way I've designed the LyX
11004 class: you can't make text in the middle of a paragraph invisible, nor
11005 make text in the middle of an invisible paragraph visible again.
11006 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11010 \begin_layout Plain Layout
11011 The commands of interest are:
11014 \begin_layout Itemize
11019 invisible \SpecialChar \ldots{}
11023 \begin_layout Itemize
11028 visible \SpecialChar \ldots{}
11032 \begin_layout Plain Layout
11033 \SpecialChar \ldots{}
11034 and need to be marked as TeX.
11036 \begin_inset Quotes eld
11040 \begin_inset Quotes erd
11043 you wish to change goes in between the brackets [and after the
11056 If you don't know how to mark text as TeX, see the appropriate section
11069 \begin_layout Subsubsection
11079 \begin_inset CommandInset label
11081 name "sec:slideNote"
11088 \begin_layout Standard
11097 is associated with a
11098 \begin_inset Quotes eld
11102 \begin_inset Quotes erd
11114 class provides visual cues.
11119 is shorter than that of a
11123 [yet longer than that of an
11127 ] and, like the label of an
11131 is shockingly magenta.
11132 Additionally, the printed
11136 has the page number of its
11137 \begin_inset Quotes eld
11141 \begin_inset Quotes erd
11149 \begin_inset Quotes eld
11157 \begin_inset Quotes erd
11161 \begin_inset Quotes eld
11169 \begin_inset Quotes erd
11173 \begin_inset Quotes eld
11181 \begin_inset Quotes erd
11185 You can have multiple
11189 s associated with a single
11201 , you'll probably want to break up long
11205 s so that they fit on a single sheet of paper.
11208 \begin_layout Standard
11213 is obvious: it contains anything additional you might want to say about
11219 It could also be used as a sheet of reminders for a particular
11224 In the case of the latter, you might want to make use of time markers.
11230 \begin_inset Quotes eld
11234 \begin_inset Quotes erd
11237 support for time markers, a
11242 So, you'll have to resort to using the LaTeX codes.
11245 \begin_layout Standard
11246 To use time markers, you'll need to specify the extra class option
11247 \begin_inset Quotes eld
11255 \begin_inset Quotes erd
11259 \begin_inset space ~
11263 \begin_inset CommandInset ref
11265 reference "sec:slidesetup"
11270 This option turns on timing marks, which will appear in the lower-left-hand
11276 To set what appears in the time marker, you use the LaTeX commands
11277 \begin_inset Quotes eld
11287 \begin_inset Quotes erd
11291 \begin_inset Quotes eld
11301 \begin_inset Quotes erd
11305 The arguments of both commands are time measured in seconds.
11307 \begin_inset Quotes eld
11317 \begin_inset Quotes erd
11320 sets the time marker to a given time.
11322 \begin_inset Quotes eld
11332 \begin_inset Quotes erd
11335 increments the time marker by the specified amount.
11336 Using time markers and
11340 s in this fashion, you can remind yourself how much time to spend on a particula
11348 \begin_layout Standard
11349 There's one last feature to describe.
11350 Clearly, you'd like to print out all of your
11358 s on transparencies while printing all of your
11375 with which it is associated.
11376 What's a person to do?
11379 \begin_layout Standard
11380 Luckily, there are two LaTeX commands that allow you to select what to print
11382 Both must be placed into the preamble of your document.
11384 \begin_inset Quotes eld
11396 \begin_inset Quotes erd
11399 will cause the output to contain only the
11408 Correspondingly, the command
11409 \begin_inset Quotes eld
11421 \begin_inset Quotes erd
11424 prevents the output of anything but
11429 I'd advise placing both commands in the preamble and initially comment
11431 You can then preview your entire presentation as you write.
11432 When you're done writing, you can then uncomment one of the two to select
11433 what you want to print.
11434 I like to uncomment
11435 \begin_inset Quotes eld
11447 \begin_inset Quotes erd
11450 , print to a file with
11451 \begin_inset Quotes eld
11459 \begin_inset Quotes erd
11462 in its name, comment it back out, then uncomment
11463 \begin_inset Quotes eld
11475 \begin_inset Quotes erd
11479 \begin_inset Quotes eld
11487 \begin_inset Quotes erd
11491 I can then send either file to a printer, loading transparencies or plain
11492 paper as appropriate.
11495 \begin_layout Standard
11496 You can also provide other arguments to the
11497 \begin_inset Quotes eld
11507 \begin_inset Quotes erd
11511 \begin_inset Quotes eld
11521 \begin_inset Quotes erd
11525 See a good LaTeX book for details.
11528 \begin_layout Subsection
11533 Class Template File
11536 \begin_layout Standard
11537 I have also provided a template file,
11538 \begin_inset Quotes eld
11546 \begin_inset Quotes erd
11554 To use it, begin your new presentation with
11559 ile\SpecialChar \menuseparator
11561 \begin_inset space ~
11565 \begin_inset space ~
11575 Your new LyX presentation file will contain an example
11596 additionally contain an example of the use of
11605 Lastly, the preamble will contain:
11608 \begin_layout LyX-Code
11609 % Uncomment to print out only slides and overlays
11612 \begin_layout LyX-Code
11616 \begin_layout LyX-Code
11622 \begin_inset Newline newline
11628 \begin_layout LyX-Code
11629 % Uncomment to print out only notes
11632 \begin_layout LyX-Code
11636 \begin_layout LyX-Code
11644 \begin_layout Standard
11645 One final thing: I created this class to support the LaTeX2e
11646 \begin_inset Quotes eld
11654 \begin_inset Quotes erd
11657 class, one of the built-in LaTeX2e classes.
11658 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11659 built-in slide class.
11660 It's here if you want it or need it.
11661 There exist other LaTeX2e classes for creating presentations, such as the
11667 \begin_inset space ~
11671 \begin_inset CommandInset ref
11673 reference "sec:foiltex"
11678 \begin_inset Quotes eld
11686 \begin_inset Quotes erd
11689 package [present on some TeX distributions].
11690 The latter is not yet supported under LyX.
11694 \begin_layout Plain Layout
11695 Perhaps you can take on the task\SpecialChar \ldots{}
11701 I know nothing about these other classes.
11702 Try them out to see what sort of alternative they provide.
11705 \begin_layout Section
11714 \begin_inset CommandInset label
11723 \begin_layout Standard
11729 \begin_layout Subsection
11733 \begin_layout Standard
11734 This section describes how to use LyX to make slides for overhead projectors.
11735 There are two document classes that can do this: the default slides class
11741 This section documents the latter.
11744 \begin_layout Standard
11745 I'm going to say this again, nice and clear, so that there's no misunderstanding
11749 \begin_layout Standard
11750 \begin_inset VSpace bigskip
11756 \begin_layout Standard
11760 This section documents the class
11761 \begin_inset Quotes eld
11769 \begin_inset Quotes erd
11777 \begin_layout Standard
11778 \begin_inset VSpace bigskip
11784 \begin_layout Standard
11785 If you're looking for the documentation for
11786 \begin_inset Quotes eld
11794 \begin_inset Quotes erd
11797 , check out section
11798 \begin_inset space ~
11802 \begin_inset CommandInset ref
11804 reference "sec:slitex"
11809 If your machine doesn't have the
11814 \begin_inset Quotes eld
11822 \begin_inset Quotes erd
11825 ] installed, you'll probably have to use the default
11829 class, which isn't quite as good as
11834 \begin_layout Standard
11839 class is designed for use with version 2.1 of the
11843 LaTeX class file which is now an integral part of LaTeX2e.
11846 \begin_layout Subsection
11850 \begin_layout Standard
11851 Obviously, to use this document class, you need to select
11852 \begin_inset Quotes eld
11860 \begin_inset Quotes erd
11873 \begin_inset space ~
11879 There are some settings in the
11882 \begin_inset space ~
11887 dialog that you should know about that are specific to this class:
11890 \begin_layout Itemize
11891 Don't change the options
11902 \begin_inset space ~
11908 They're ignored by the
11915 \begin_layout Itemize
11916 The default font size is 20pt with the other options being 17pt, 25pt and
11920 \begin_layout Itemize
11921 The default font is
11929 but all math equations are still typeset in the usual roman font.
11932 \begin_layout Itemize
11937 TeX supports A4 and Letter paper sizes as well as a special size for working
11939 It doesn't support A5, B5, legal or executive paper sizes.
11942 \begin_layout Itemize
11943 Don't bother changing the
11947 settings because they are ignored anyway.
11948 All floats appear where they are defined in the text.
11951 \begin_layout Itemize
11959 setting behaves a bit differently for this class.
11964 TeX provides extensive footer and header capabilities including a user-defined
11967 \begin_inset space ~
11971 \begin_inset CommandInset ref
11973 reference "sec:foilfoot"
11978 The title page is treated differently to all other pages in the document
11987 has the logo centered at the bottom of the page (if one is defined).
11988 The possible page style choices and what they do are as follows:
11993 \labelwidthstring MMMMMMM
12000 The final output contains no page numbers, or other headers or footers
12001 (except footnotes of course).
12006 \labelwidthstring MMMMMMM
12013 The final output contains page numbers centered at the bottom of the page.
12014 No other headings or footers (other than footnotes).
12018 \labelwidthstring MMMMMMM
12023 Page numbers in lower right corner.
12024 Additional headers and footers are also shown.
12025 This is also the default.
12029 \labelwidthstring MMMMMMM
12034 Gives you access to the
12038 package although its use with
12042 TeX is discouraged by the writer of the
12046 TeX package because of some potential page layout clashes.
12050 \begin_layout Subsubsection
12054 \begin_layout Standard
12055 The following options may be used in the extra class options in the
12060 ocument\SpecialChar \menuseparator
12071 \labelwidthstring MMMMMMx
12076 This sets up the page layout for 7.33in by 11in paper, which is about the
12077 same aspect ratio as a 35mm slide, making it a bit easier to work with
12082 \labelwidthstring MMMMMMx
12087 Places a rule across the page below the header on every page except the
12092 \labelwidthstring MMMMMMx
12097 Places a rule across the page above the footer on every page except the
12102 \labelwidthstring MMMMMMx
12107 This is automatically set each time you create a new
12116 TeX to use the dvips driver to rotate those pages that are set as landscape
12121 \labelwidthstring MMMMMMx
12126 Simply changes the page dimensions to those of a landscape page but doesn't
12128 Thus if you use this option you need to use an external program to rotate
12129 each page or feed your paper through your printer as landscape.
12130 Note that this option effectively reverses the roles of the
12138 environments (don't worry these are described in the next section).
12142 \labelwidthstring MMMMMMx
12147 Equation numbers on the left.
12151 \labelwidthstring MMMMMMx
12156 Flush-left equations.
12159 \begin_layout Subsection
12160 Supported Environments
12163 \begin_layout Standard
12164 Most of the environments commonly supported in other classes are also supported
12170 There are several additional environments provided by
12174 TeX as well as a couple added by LyX.
12175 The following environments are shared with other classes:
12178 \begin_layout Standard
12182 \begin_layout Plain Layout
12186 begin{multicols}{2}
12194 \begin_layout Itemize
12200 \begin_layout Itemize
12206 \begin_layout Itemize
12212 \begin_layout Itemize
12218 \begin_layout Itemize
12224 \begin_layout Itemize
12230 \begin_layout Itemize
12236 \begin_layout Itemize
12242 \begin_layout Itemize
12248 \begin_layout Itemize
12254 \begin_layout Itemize
12260 \begin_layout Itemize
12266 \begin_layout Itemize
12272 \begin_layout Itemize
12278 \begin_layout Itemize
12284 \begin_layout Itemize
12290 \begin_layout Itemize
12296 \begin_layout Itemize
12302 \begin_layout Standard
12306 \begin_layout Plain Layout
12318 \begin_layout Standard
12319 That is, all the major environments apart from the sectioning environments.
12320 Since foils are essentially self-contained sections, with a title and body,
12325 TeX provides specific commands for starting new foils and these are:
12328 \begin_layout Itemize
12334 \begin_layout Itemize
12340 \begin_layout Standard
12341 LyX also provides slightly modified versions of these two environments called:
12344 \begin_layout Itemize
12350 \begin_layout Itemize
12353 ShortRotatefoilhead
12356 \begin_layout Standard
12357 and the differences will be explained in the next section.
12360 \begin_layout Standard
12361 Since foils are often used in presenting ideas or new theorems and such
12366 TeX also provides a comprehensive box of goodies for presenting them:
12369 \begin_layout Standard
12373 \begin_layout Plain Layout
12377 begin{multicols}{2}
12385 \begin_layout Itemize
12391 \begin_layout Itemize
12397 \begin_layout Itemize
12403 \begin_layout Itemize
12409 \begin_layout Itemize
12415 \begin_layout Itemize
12421 \begin_layout Itemize
12427 \begin_layout Itemize
12433 \begin_layout Itemize
12439 \begin_layout Itemize
12445 \begin_layout Itemize
12451 \begin_layout Standard
12455 \begin_layout Plain Layout
12467 \begin_layout Standard
12468 The starred versions are unnumbered while the unstarred versions are numbered.
12469 There are also two list environments added by LyX and these are:
12472 \begin_layout Itemize
12478 \begin_layout Itemize
12484 \begin_layout Standard
12489 TeX provides some powerful header and footer capabilities that are best
12490 set in the preamble although they may be set at any point in a document.
12491 If you want to change these settings in your document the best place to
12492 do so is at the very top of a foil,
12497 straight after the foilhead.
12500 \begin_layout Standard
12501 For this purpose, the following command styles are provided [
12508 \begin_layout Standard
12512 \begin_layout Plain Layout
12516 begin{multicols}{2}
12524 \begin_layout Itemize
12528 \begin_inset space ~
12534 \begin_layout Itemize
12540 \begin_layout Itemize
12544 \begin_inset space ~
12550 \begin_layout Itemize
12554 \begin_inset space ~
12560 \begin_layout Itemize
12564 \begin_inset space ~
12571 \begin_layout Standard
12572 \begin_inset space ~
12579 \begin_layout Standard
12583 \begin_layout Plain Layout
12595 \begin_layout Standard
12596 There are also a few commands provided by
12600 TeX that aren't directly supported by LyX but I'll tell you what they do
12601 and how to use them in section
12602 \begin_inset space ~
12606 \begin_inset CommandInset ref
12608 reference "sec:unsuppfoils"
12615 \begin_layout Subsection
12616 Building a Set of Foils
12619 \begin_layout Standard
12620 This section will give a simple introduction to using the different environments
12621 to build a set of foils.
12622 If you want to see an example set of foils take a look at the
12626 file accessible from the
12631 ile\SpecialChar \menuseparator
12636 pen\SpecialChar \ldots{}
12647 \begin_layout Subsubsection
12648 Give It a Title Page
12651 \begin_layout Standard
12652 Unlike other classes that provide
12672 creates the title on a page of its own.
12673 If you leave out the
12677 environment LaTeX will substitute the current date (every time you regenerate
12681 \begin_layout Subsubsection
12685 \begin_layout Standard
12686 As I mentioned earlier, there are four ways of starting a new foil.
12687 For portrait foils you should use
12696 The difference between these two environments is the amount of space between
12697 the title of the foil (the foilhead) and the body of the foil.
12700 \begin_layout Standard
12701 Landscape foils are generated using the
12707 ShortRotatefoilhead
12710 Again the only difference is the spacing between foilhead and body.
12711 Both of the short versions have 0.5 inches less separation between the foilhead
12716 \begin_layout Standard
12717 One problem with the support for landscape foils is the requirement that
12718 you have to use the
12722 driver to generate the PostScript output otherwise the foils won't be rotated.
12723 It is possible to get landscape foils even if you haven't got the
12727 driver provided you can feed your foils sideways through your printer ;-)
12730 \begin_layout Subsubsection
12731 Theorems, Lemmas, Proofs and more
12734 \begin_layout Standard
12735 Due to a small bug in LyX you can't have two of the same type of these environme
12736 nts directly following each other.
12737 They must be separated by something.
12738 If you try, you will just be extending the previous environment as if you
12739 had merged the two environments together.
12740 So, how do you get around this problem? The simplest option is to insert
12741 some text between the two environments or add a
12745 environment between the two with just a
12746 \begin_inset Quotes eld
12754 \begin_inset Quotes erd
12758 This will force LyX to produce two separate environments and hence the
12759 correct LaTeX output.
12760 An example is provided in the example file included with the LyX distribution.
12761 Remember, this problem only occurs if you are trying to place two of the
12762 same type of theorem-like environments one directly after the other.
12765 \begin_layout Subsubsection
12769 \begin_layout Standard
12770 You get all the commonly supported list styles found in other classes as
12771 well as two new ones.
12772 I'll only describe the new ones here.
12773 If you want to find out more about the other list environments check out
12779 If you intend to use itemized lists you might also want to read about the
12783 \begin_inset space ~
12787 \begin_inset space ~
12792 dialog described above in section
12793 \begin_inset space ~
12797 \begin_inset CommandInset ref
12799 reference "sec:bullet"
12806 \begin_layout Standard
12807 The two new list styles,
12815 , are designed to make it easier for you to create lists of do's and don'ts
12816 or right and wrong by providing dedicated environments that use a tick
12817 or a cross as the label of the list.
12818 These lists are in fact dedicated variants of the
12823 They do however require that you have the
12827 packages installed.
12830 \begin_layout Subsubsection
12834 \begin_layout Standard
12839 TeX redefines the floating tables and figures so that they appear exactly
12840 where they are in the text rather than pushing them to the top of the page
12841 or to some user specified location.
12842 In fact if you change the float placement settings they are simply ignored.
12845 \begin_layout Subsubsection
12846 Page Headers and Footers
12847 \begin_inset CommandInset label
12849 name "sec:foilfoot"
12856 \begin_layout Standard
12860 \begin_inset space ~
12869 are two commands used to control the left-footer text string.
12870 The first is meant to allow you to include a graphic logo on your foils
12872 \begin_inset Quotes eld
12880 \begin_inset Quotes erd
12884 While the second is meant to provide a classification for the audience,
12888 \begin_inset space \thinspace{}
12894 \begin_inset space ~
12898 It is empty by default.
12901 \begin_layout Standard
12902 The remaining page corners can be filled by
12905 \begin_inset space ~
12910 (which defaults to page numbers),
12913 \begin_inset space ~
12921 \begin_inset space ~
12929 \begin_layout Subsection
12935 \begin_inset CommandInset label
12937 name "sec:unsuppfoils"
12944 \begin_layout Standard
12945 All the commands mentioned below need to be set in a
12953 within another environment.
12956 \begin_layout Subsubsection
12960 \begin_layout Standard
12961 All lengths are adjusted using the
12984 should be replaced by the name given to the length you want to change and
12989 is the length value.
12990 All lengths should be specified in units of length such as inches (
13002 ) or relative to some document or font-based length such as
13012 \begin_layout Standard
13013 It's possible to change the spacing between a foilhead and the body of the
13014 foil by adjusting the length specified by
13021 For example, to make
13025 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13032 foilheadskip}{-0.5in}
13035 \begin_layout Standard
13036 The spacings around floats can be adjusted by setting these lengths:
13040 \labelwidthstring MMMMMMMMMMM
13047 Separation between the text and the top of the float
13051 \labelwidthstring MMMMMMMMMMM
13058 Separation between the float and the caption
13062 \labelwidthstring MMMMMMMMMMM
13069 Separation between the caption and the following text
13073 \labelwidthstring MMMMMMMMMMM
13080 You can make the captions narrower than the surrounding text by adjusting
13082 Best done relative to
13091 \begin_layout Standard
13092 There are also several title page related lengths that you may find useful
13093 if you have a long title or several authors:
13097 \labelwidthstring MMMMMMMMMMM
13104 Separation from headers to
13110 \labelwidthstring MMMMMMMMMMM
13129 \labelwidthstring MMMMMMMMMMM
13144 \labelwidthstring MMMMMMMMMMM
13161 \labelwidthstring MMMMMMMMMMM
13177 \begin_layout Standard
13178 The last length related command affects all the list environments.
13189 a list environment then all the vertical spacing between the list items
13191 Note that this is a command not a length so it doesn't require
13197 like the stuff mentioned above.
13200 \begin_layout Subsubsection
13201 Headers and Footers
13204 \begin_layout Standard
13217 commands control whether the logo in the
13221 definition appear on a given page.
13228 in the preamble then none of the foils will have the logo on them.
13229 If you don't want the logo on a particular page place the
13235 directly after the foilhead of that page and the
13241 directly after the next foilhead.
13244 \begin_layout Standard
13245 If you decide to use the
13249 page style setting in the
13252 \begin_inset space ~
13257 dialog you should probably add
13267 to your preamble so headers and footers on landscape pages are correctly
13268 placed when rotated.
13269 This is due to some clashes between the page layouts provided by the
13280 \begin_layout Section
13281 Latex8 (IEEE Conference Papers)
13284 \begin_layout Standard
13290 \begin_layout Subsection
13294 \begin_layout Standard
13295 Since this class is specifically for writing submissions to IEEE sponsored
13296 conferences I strongly recommend that you get a copy of their Authors Kit.
13301 package and associated bibliography style file is included in the kit.
13302 The Authors Kit is usually sent out by email once your initial submission
13304 There is a lot of useful information in the Authors Kit explaining formatting
13305 restrictions and so on and I will assume you have read this since that
13306 means I don't have to repeat it all here.
13309 \begin_layout Subsection
13313 \begin_layout Standard
13314 [AR\SpecialChar \@.
13318 \begin_layout Subsection
13319 Supported Environments
13322 \begin_layout Itemize
13328 \begin_layout Itemize
13334 \begin_layout Itemize
13340 \begin_layout Itemize
13346 \begin_layout Itemize
13352 \begin_layout Itemize
13358 \begin_layout Itemize
13364 \begin_layout Itemize
13370 \begin_layout Itemize
13376 \begin_layout Subsection
13377 Differences Between Screen and Paper
13380 \begin_layout Standard
13381 There are slight differences in appearance mainly with the presentation
13382 of section counters.
13383 On screen the trailing period of the section counter is missing but it
13384 will appear in the output so don't let this worry you.
13387 \begin_layout Section
13388 Hollywood (Hollywood spec scripts)
13391 \begin_layout Standard
13397 \begin_layout Subsection
13401 \begin_layout Standard
13402 Getting the format of a Hollywood script right is a
13403 \begin_inset Quotes eld
13407 \begin_inset Quotes erd
13410 It is designed to make the readers focus on content and to be easy and
13411 familiar for the actors to read.
13412 Each page of a script should be one minute of film.
13413 Nothing goes in a script that you cannot see or hear on screen.
13414 The courier 12 pt font should be used throughout.
13418 \begin_layout Subsection
13422 \begin_layout Standard
13423 Speakers' lines should NEVER break in mid-sentence.
13424 If a speaker's lines continue over a page break, repeat the
13428 title followed by (Cont'd).
13431 \begin_layout Subsection
13435 \begin_layout Standard
13440 names as labels then cross-reference the label to insert the name.
13441 The cross-reference dialog will show the current cast of characters.
13442 You can use this to insert the speaker name in narratives also.
13445 \begin_layout Subsection
13446 Paper size and Margins
13449 \begin_layout Standard
13450 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13453 \begin_layout Subsection
13457 \begin_layout Standard
13458 The following environments are available.
13459 You can use hollywood.bind to get the bind keys shown at the right.
13462 \begin_layout Itemize
13466 \begin_inset Newline newline
13471 Used where nothing else works.
13475 \begin_layout Itemize
13481 \begin_inset space \hfill{}
13489 \begin_inset Newline newline
13492 Usually followed by something like
13493 \begin_inset Quotes eld
13496 on Sally waking up.
13497 \begin_inset Quotes erd
13503 \begin_layout Itemize
13507 \begin_inset space \hfill{}
13511 \begin_inset Newline newline
13516 Introduces a new INTERIOR camera set-up.
13517 Always followed by DAY or NIGHT, or something similar to define the lighting
13519 Everthing on this line in CAPS.
13522 \begin_layout Itemize
13526 \begin_inset space \hfill{}
13530 \begin_inset Newline newline
13535 Introduces a new EXTERIOR camera set-up.
13536 Everthing on this line in CAPS.
13539 \begin_layout Itemize
13543 \begin_inset space \hfill{}
13547 \begin_inset Newline newline
13552 The character speaking.
13555 \begin_layout Itemize
13559 \begin_inset space \hfill{}
13563 \begin_inset Newline newline
13568 Instructions to the speaker.
13569 The () are automatically inserted, but only the ( will show in LyX.
13570 Both will be printed.
13573 \begin_layout Itemize
13577 \begin_inset space \hfill{}
13581 \begin_inset Newline newline
13593 \begin_layout Itemize
13597 \begin_inset space \hfill{}
13601 \begin_inset Newline newline
13606 Camera movement instruction.
13608 \begin_inset space \thinspace{}
13612 \begin_inset space ~
13618 \begin_layout Itemize
13622 \begin_inset space \hfill{}
13628 \begin_layout Itemize
13632 \begin_inset space \hfill{}
13638 \begin_layout Itemize
13642 \begin_inset space \hfill{}
13648 \begin_layout Itemize
13652 \begin_inset space \hfill{}
13658 \begin_layout Subsection
13662 \begin_layout Itemize
13663 (O.S) --- off screen
13666 \begin_layout Itemize
13667 (V.0) --- voice over
13670 \begin_layout Itemize
13675 \begin_layout Itemize
13680 \begin_layout Itemize
13681 PAN --- camera movement
13684 \begin_layout Itemize
13685 INSERT --- cut to close-up of
13688 \begin_layout Section
13692 \begin_layout Standard
13698 \begin_layout Subsection
13702 \begin_layout Standard
13703 Broadway is for writing plays.
13704 The format is more decorative than Hollywood, and much less standardized.
13705 This format should be suitable for workshops.
13708 \begin_layout Subsection
13712 \begin_layout Standard
13713 The same as in Hollywood.
13716 \begin_layout Subsection
13720 \begin_layout Standard
13725 names as labels then cross-reference the label to insert the name.
13726 The cross-reference dialog will show the current cast of characters.
13729 \begin_layout Subsection
13730 Paper size and Margins
13733 \begin_layout Standard
13734 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13737 \begin_layout Subsection
13741 \begin_layout Standard
13742 The following environments are available.
13743 You can use broadway.bind to get the bind keys shown at the right.
13746 \begin_layout Itemize
13750 \begin_inset Newline newline
13755 You should not have to use this, but it is here for anything that does not
13759 \begin_layout Itemize
13763 \begin_inset space \hfill{}
13767 \begin_inset Newline newline
13772 Used to describe stage setting and the action.
13773 First use of speaker names in all CAPs.
13776 \begin_layout Itemize
13780 \begin_inset space \hfill{}
13784 \begin_inset Newline newline
13789 Automatically numbered.
13790 On screen it will be arabic, but will print as Roman.
13793 \begin_layout Itemize
13797 \begin_inset space \hfill{}
13801 \begin_inset Newline newline
13811 It is just centered text.
13814 \begin_layout Itemize
13818 \begin_inset space \hfill{}
13822 \begin_inset Newline newline
13827 Not automatically numbered.
13828 You supply the number.
13829 This is because I couldn't figure out how.
13832 \begin_layout Itemize
13836 \begin_inset space \hfill{}
13840 \begin_inset Newline newline
13845 A special case of Narrative to describe the setting and action as the curtain
13849 \begin_layout Itemize
13853 \begin_inset space \hfill{}
13857 \begin_inset Newline newline
13862 The speaker's (actor's) title, centered in all CAPS.
13865 \begin_layout Itemize
13869 \begin_inset space \hfill{}
13873 \begin_inset Newline newline
13878 Instructions to the speaker.
13879 The parentheses are automatically inserted.
13880 The ( will appear on screen, but both will be in the printed play.
13881 This environment is only used within
13888 \begin_layout Itemize
13892 \begin_inset space \hfill{}
13896 \begin_inset Newline newline
13901 What the Speaker says.
13904 \begin_layout Itemize
13908 \begin_inset space \hfill{}
13912 \begin_inset Newline newline
13917 The curtain comes down.
13920 \begin_layout Itemize
13924 \begin_inset space \hfill{}
13930 \begin_layout Itemize
13934 \begin_inset space \hfill{}
13940 \begin_layout Itemize
13944 \begin_inset space \hfill{}
13950 \begin_layout Standard
13954 \begin_layout Section
13958 \begin_layout Standard
13964 \begin_layout Standard
13965 \begin_inset VSpace bigskip
13971 \begin_layout Standard
13976 \begin_inset space ~
13981 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13982 \begin_inset Formula $\beta$
13985 release of May, 1999) class.
13988 \begin_layout Standard
13993 textclass, which works with RevTeX 3.1.
13994 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13995 That means that it doesn't interact very well with LyX, which requires
13996 LaTeX2e, although it has been kludged to work.
13997 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14001 \begin_inset space ~
14006 textclass should also be pretty easy to use.
14009 \begin_layout Standard
14010 These documents are supposed to be used in
14014 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14015 macros, and assume you'll know what to put in the preamble if necessary.
14018 \begin_layout Subsection
14022 \begin_layout Standard
14023 All you need to do is install RevTeX 4, as described in the package's README
14025 The package can be found at The RevTeX 4 Web Site
14026 \begin_inset Flex URL
14029 \begin_layout Plain Layout
14031 http://publish.aps.org/revtex4/
14037 Install it somewhere that LaTeX can see it.
14038 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14039 (i.e., not the directory where you installed the class file.) Then, if you
14040 reconfigure LyX, it will find the class file and let you use the RevTeX4
14044 \begin_layout Standard
14045 Probably the easiest way to get started is either to import a RevTeX 4 document
14053 \begin_inset space ~
14058 template, found in the templates directory.
14061 \begin_layout Subsection
14065 \begin_layout Standard
14066 Optional arguments to
14073 \begin_inset Quotes eld
14077 \begin_inset Quotes erd
14081 \begin_inset Quotes eld
14085 \begin_inset Quotes erd
14095 \begin_inset space ~
14103 \begin_inset space ~
14109 Remember that in RevTeX, at least one optional argument is required!
14112 \begin_layout Standard
14113 Other preamble matter, like
14120 \begin_inset space ~
14130 \begin_inset space ~
14135 dialog, also as usual.
14138 \begin_layout Subsection
14142 \begin_layout Standard
14143 The layouts basically correspond to the commands in RevTeX4.0.
14144 For example, the Email layout corresponds to
14151 Note that (at least as of RevTeX 4.0 Beta), the
14159 layouts are exactly equivalent, so you shouldn't need to use both.
14163 \begin_layout Plain Layout
14164 In case you're curious, both were included so that
14168 would be able to translate both
14188 \begin_layout Subsection
14192 \begin_layout Standard
14193 There are a couple of important unique aspects of RevTeX 4 which might cause
14194 bugs that will be even more confusing in LyX.
14197 \begin_layout Standard
14215 The LyX equivalent is that there is a separate Thanks layout.
14220 write footnotes in the
14224 layout, or weird things may happen.
14225 See the RevTeX 4 documentation for more details.
14228 \begin_layout Standard
14232 \begin_inset space ~
14240 \begin_inset space ~
14249 layouts must be placed
14257 layout and the corresponding
14274 , the LaTeX won't compile.
14277 \begin_layout Subsection
14281 \begin_layout Standard
14282 The main problem with this layout is that you can't use the optional arguments
14283 to layouts like Email and Title.
14284 (The problem is not unique to this layout; you can't use optional arguments
14285 to the Section layouts either.) This means that after you export that file
14286 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14287 need to edit the LaTeX file with a text editor to add the optional arguments
14289 \begin_inset space \thinspace{}
14292 g., the running title for the page headers.
14293 Lacking these layouts makes the
14299 (and the equivalent
14305 ) useless, so the corresponding layouts don't exist, and will have to be
14310 \begin_layout Plain Layout
14315 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14316 has not been updated yet to take advantage of it.
14324 \begin_layout Section
14325 Article (mwart), book (mwbk) and report (mwrep)
14326 \begin_inset OptArg
14329 \begin_layout Plain Layout
14342 \begin_layout Standard
14348 \begin_layout Standard
14349 The LyX document classes
14365 correspond to the LaTeX document classes
14378 They are replacements for the standard document classes
14390 , resp., and fit better to Polish typography conventions in a number of points.
14394 \begin_layout Standard
14398 \begin_layout Itemize
14399 Unnumbered titles (with star, eg.
14404 ) are added into table of contents,
14407 \begin_layout Itemize
14408 Additional page styles:
14412 \begin_layout Description
14413 uheadings header with separated lines,
14416 \begin_layout Description
14417 myheadings custom header, contents headers via commands:
14432 \begin_layout Description
14433 myuheadings custom header with separated lines,
14436 \begin_layout Description
14437 outer page number is placed on outer side of page
14441 \begin_layout Itemize
14446 \begin_layout Description
14447 rmheadings serif titles --- default,
14450 \begin_layout Description
14451 sfheadings sansserif titles,
14454 \begin_layout Description
14455 authortitle on title page first placed is author next title --- default,
14458 \begin_layout Description
14459 titleauthor on title page first placed is title next author,
14462 \begin_layout Description
14463 withmarginpar reserve place on page for margins.
14467 \begin_layout Section
14471 \begin_layout Standard
14477 \begin_layout Standard
14478 Elsevier Science Publishers B.V.
14479 provides a standard LaTeX document class (
14483 ) for submitting articles to their various journals.
14484 The style file can be downloaded directly from their web site:
14485 \begin_inset Flex URL
14488 \begin_layout Plain Layout
14490 http://authors.elsevier.com/
14496 Instructions are supplied along with the class file, which details the
14497 requirements of the publishers.
14498 LyX includes package that allows for the use of this class, by a layout
14499 and a template file.
14500 Installation of the class file is the same as for any other LaTeX package;
14501 instructions are provided in the Elsevier documentation.
14504 \begin_layout Standard
14514 As the Elsevier class file is based mainly on the standard article class,
14515 most of the normal functionality is provided.
14516 The Elsevier class defines a number of mathematical environments, which
14517 are similar to the AMS environments.
14518 These commands are all described in the Elsevier documentation, and are
14522 \begin_layout Standard
14523 The easiest way to use the Elsevier style is to base documents on the included
14525 It is best not to use options such as fancy headings or the geometry package,
14526 as elements such as these are defined by Elsevier in their style file.
14527 Ideally, no extra packages except those mentioned in the Elsevier documentation
14529 Essentially, Elsevier require as
14530 \begin_inset Quotes eld
14534 \begin_inset Quotes erd
14537 a LaTeX file as possible, as their intention is to take the supplied file
14538 and replace the class file with one for the particular journal to which
14539 the paper has been submitted.
14540 This also means that not too much time should be spent on the formating
14542 When it comes to be published, this will change anyway.
14543 The rest of the usage for this layout is substantially the same as for
14544 the normal article class.
14545 For details of what Elsevier do and don't allow, refer to their documentation.
14548 \begin_layout Section
14552 \begin_layout Standard
14555 Jürgen Spitzmüller
14558 \begin_layout Subsection
14562 \begin_layout Standard
14563 Memoir is a very powerful and constantly evolving class.
14564 It has been designed with regard to fictional and non-fictional literature.
14565 Its aim is to let the user have maximum control over the typesetting of
14567 Memoir is based on the standard book class, but it can also emulate the
14568 article class (see below).
14571 \begin_layout Standard
14572 Peter Wilson, the developer of Memoir, is known as the author of lots of
14573 useful packages in the LaTeX world.
14574 Most of them have been merged with Memoir.
14575 Therefore, it is much easier to layout the table of contents, appendices,
14576 chapter designs and such.
14577 LyX, though, does not support all of these goodies natively.
14578 Some of them might be added to forthcoming releases
14582 \begin_layout Plain Layout
14583 You are invited to send suggestions to
14584 \begin_inset Flex URL
14587 \begin_layout Plain Layout
14589 lyx-devel@lists.lyx.org
14599 , lots will probably never, due to the limitations of LyX's framework.
14600 Of course you can still use all features with the help of some native LaTeX
14605 \begin_layout Plain Layout
14610 \begin_layout Plain Layout
14620 \begin_inset space ~
14624 \begin_inset CommandInset ref
14626 reference "sec:Inserting-LaTeX-Code"
14636 In this section, we can only list those features which are natively supported
14638 For detailed descriptions (and for the rest of features) we are recommending
14639 to have a look at the detailed manual of the Memoir class
14643 \begin_layout Plain Layout
14648 \begin_layout Plain Layout
14658 \begin_inset Flex URL
14661 \begin_layout Plain Layout
14663 CTAN:/macros/latex/memoir/memman.pdf
14673 , which is not only a user guide for the class, but also both a comprehensive
14674 description on good typesetting and a superb example for good typesetting
14678 \begin_layout Subsection
14679 Basic features and restrictions
14682 \begin_layout Standard
14683 Memoir supports basically all features of the standard book classes.
14684 There are, however, some differences, as follows:
14687 \begin_layout Description
14689 \begin_inset space ~
14692 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14695 \begin_layout Description
14697 \begin_inset space ~
14700 style: The fancy page style is not supported, due to a command clash between
14701 Memoir and the fancyhdr package (they are both defining a command with
14702 the same name, which confuses LaTeX).
14703 Instead, Memoir comes with a bunch of own page styles (see
14705 Layout\SpecialChar \menuseparator
14706 Document\SpecialChar \menuseparator
14708 \begin_inset space ~
14714 If you want to use these for the chapter pages, you have to use the command
14721 in the main text or in preamble (e.
14722 \begin_inset space \thinspace{}
14726 \begin_inset space ~
14733 chapterstyle{companion}
14738 \begin_layout Description
14739 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14740 an optional argument in the standard classes.
14741 With this, you can specify an alternative version of the title for the
14742 table of contents and the headers (for instance, if the title is too long).
14743 In LyX, you can do this via
14745 Insert\SpecialChar \menuseparator
14747 \begin_inset space ~
14752 at the beginning of a chapter/section.
14753 Memoir features a second optional argument and thus separates the table
14754 of contents from the header.
14755 You can define three variants of a title with this: one for the main text,
14756 one for the table of contents, and one for the headers.
14757 Simply insert two optional arguments if you need this feature, the first
14758 one containing the short title for the Table of Contents, the second one
14759 containing an alternative short title for the headers.
14762 \begin_layout Description
14763 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14764 of contents, the list of figures and the list of table start a new page
14766 Memoir does not follow this route.
14767 You have to insert a page break yourself, if you want to have one.
14770 \begin_layout Description
14771 Titlepage: For some unknown reason, Memoir uses pagination on the title
14772 page (in the standard classes, title pages are
14773 \begin_inset Quotes eld
14777 \begin_inset Quotes erd
14781 \begin_inset space \thinspace{}
14785 \begin_inset space ~
14789 If you want an empty title page, type
14793 aliaspagestyle{title}{empty}
14798 \begin_layout Description
14799 Article: With the class option
14805 Layout\SpecialChar \menuseparator
14806 Document\SpecialChar \menuseparator
14808 \begin_inset space ~
14813 ), you can emulate article style.
14814 That is, counters (footnotes, figures, tables etc.) will not be reset on
14815 new chapters, chapters don't start a new page (but are---in contrary to
14817 \begin_inset Quotes eld
14821 \begin_inset Quotes erd
14824 article classes---still allowed), parts, though, use their own page, as
14828 \begin_layout Description
14829 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14830 font commands, which have been used in the old LaTeX version 2.09 (e.
14831 \begin_inset space \thinspace{}
14835 \begin_inset space ~
14851 It produces an error and stops LaTeX whenever such a command appears.
14856 reallows the commands and spits out warnings instead (which does at least
14858 Since a lot of packages and particularly BibTeX style files are still using
14859 those commands, we have decided to use this option by default.
14862 \begin_layout Subsection
14866 \begin_layout Standard
14867 We will only describe the features supported by LyX (which is not much currently
14869 Please consult the Memoir manual
14873 \begin_layout Plain Layout
14878 \begin_layout Plain Layout
14888 \begin_inset Flex URL
14891 \begin_layout Plain Layout
14893 CTAN:/macros/latex/memoir/memman.pdf
14906 \begin_layout Description
14907 Abstract: You may wonder why an abstract is an extra feature.
14908 Well, it is in book class.
14909 Usually books don't have abstracts.
14910 Memoir, however, has.
14911 You can use it wherever and how often you like.
14914 \begin_layout Description
14915 Chapterprecis: You may know this from belletristic: The contents of a chapter
14916 is shortly described below the title and also in the table of contents
14918 \begin_inset space \thinspace{}
14922 \begin_inset space ~
14927 Our hero arrives in Troia; he loses some friends; he finds others
14930 Chapterprecis does exactly this.
14931 It is therefore only sensible below a chapter.
14934 \begin_layout Description
14935 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14936 The epigraph environment provides an elegant way of typesetting such a
14938 The motto itself (text) and its author (source) are divided by a short
14940 Unfortunately, we have to fool LyX a bit here again, since the environment
14941 needs two arguments (text and source).
14942 In this case, we have to use curly brackets (in TeX mode) between the two
14953 <author of the slogan>.
14956 \begin_layout Description
14957 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14958 complex figurative poems).
14959 LyX can only support a few of them.
14960 One is poemtitle, which is a centered title for poems, which will also
14961 be added to the table of contents (verse is the standard environment for
14963 Memoir has some enhanced versions of verse, but you need to use ERT, because
14964 they have to be nested inside regular verse environments, which is not
14965 possible with LyX).
14968 \begin_layout Description
14969 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14972 \begin_layout Chapter
14973 LyX Features needing Extra Software
14976 \begin_layout Section
14980 \begin_layout Standard
14986 \begin_layout Subsection
14990 \begin_layout Standard
14998 menu, you'll find a
15004 \begin_inset space ~
15010 This feature requires you to have the
15014 program installed, and is grayed out if you don't have it.
15015 You can get it from your nearest CTAN mirror, or over the Web from
15016 \begin_inset Flex URL
15019 \begin_layout Plain Layout
15021 http://www.ifi.uio.no/~jensthi/chktex/
15029 \begin_layout Standard
15034 package is a program that was written by
15039 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15040 and easy to forget.
15041 The program runs over your LaTeX file and checks the integrity of the file,
15042 and flags some common errors.
15043 In other technical words, it is
15050 \begin_layout Standard
15051 Well, what is a syntax checker doing in LyX which is supposed to produce
15052 correct LaTeX anyways? The answer is simple: Just as
15056 not only checks the
15060 of C programs, but also does
15064 checks for type-errors,
15068 catches some common
15072 errors, in addition to the syntactical ones.
15077 is capable of detecting several common errors, such as
15080 \begin_layout Itemize
15081 Ellipsis detection:
15082 \begin_inset Newline newline
15085 Use \SpecialChar \ldots{}
15089 \begin_layout Itemize
15090 No space in front of/after parenthesis:
15091 \begin_inset Newline newline
15097 \begin_layout Itemize
15098 Enforcement of normal space after common abbreviations:
15099 \begin_inset Newline newline
15104 is too wide spacing.
15107 \begin_layout Itemize
15108 Enforcement of end-of-sentence space when the last sentence ends with a
15110 \begin_inset Newline newline
15114 And this is wrong spacing.
15117 \begin_layout Itemize
15118 Space in front of labels and similar commands:
15119 \begin_inset Newline newline
15122 The label should stick right up to the text to avoid falling to a wrong
15125 \begin_inset CommandInset label
15135 \begin_layout Plain Layout
15136 This footnote is in danger of falling off to a wrong page
15141 The label is separated too much.
15144 \begin_layout Itemize
15145 Space in front of references, instead of hard spaces:
15146 \begin_inset Newline newline
15149 In you are in bad luck, the text will break right between the referenced
15150 text and reference number, and that's a pity.
15152 \begin_inset CommandInset ref
15154 reference "sec:chktex"
15161 \begin_layout Itemize
15163 \begin_inset Quotes eld
15167 \begin_inset Quotes erd
15171 \begin_inset Formula $\times$
15175 \begin_inset Newline newline
15178 2x2 looks cheap compared to
15179 \begin_inset Formula $2\times2$
15185 \begin_layout Standard
15186 and more \SpecialChar \ldots{}
15187 It is an invaluable tool when you are
15188 \begin_inset Quotes eld
15192 \begin_inset Quotes erd
15195 your document before printing, and you should run it right after the obligatory
15196 spelling check, and before you go fine tuning the typesetting.
15199 \begin_layout Subsection
15203 \begin_layout Standard
15204 If you have the program installed, usage is as simple as choosing
15209 ools\SpecialChar \menuseparator
15215 \begin_inset space ~
15221 This will make LyX generate a LaTeX file of your document, start
15225 to check it, and then make LyX insert
15226 \begin_inset Quotes eld
15230 \begin_inset Quotes erd
15233 with the warnings from
15237 , if there were any.
15238 The warnings will be placed close to the point of the mistake, and you
15239 can quickly find them by using the
15244 avigate\SpecialChar \menuseparator
15251 menu item, or the shortcut key
15260 Open the error boxes by clicking on them with the mouse, or use the shortcut
15269 bindings, or the corresponding
15278 Read the warning and correct the mistake, if it is a mistake.
15279 If you have trouble understanding what the warning is about, you can safely
15281 Remember that there is a hidden layer between the document on screen and
15282 the technical details in invoking
15286 , and this gap can make some warnings seem arcane or just right down plain
15290 \begin_layout Standard
15291 This document is an excellent testing bed for the feature, and it should
15292 provide quite a few warnings for you to fiddle with.
15293 Since computers are only so smart, expect most of the warnings to be false
15297 \begin_layout Subsection
15298 How to fine tune it
15301 \begin_layout Standard
15302 Sometimes, you'll find that
15306 makes more noise than suits your mood.
15307 Then you can choose not to use it, wait until your mood changes, or try
15312 to get better along with you.
15313 Another choice in the most desperate situations is to use
15318 iew\SpecialChar \menuseparator
15324 \begin_inset space ~
15328 \begin_inset space ~
15332 \begin_inset space ~
15337 , which will get rid of all warnings instantly.
15340 \begin_layout Standard
15349 very configurable and extensible, you shouldn't expect to solve all problems
15355 Since LyX has to generate a somewhat special LaTeX file to be able to match
15356 the line numbers from the
15364 \begin_layout Plain Layout
15365 You can inspect the specific output from
15371 Edit\SpecialChar \menuseparator
15373 \begin_inset space ~
15377 \begin_inset space ~
15391 to the internal document structure, some of the warnings will not seen
15392 to appear correctly.
15393 There are two things you can do about this:
15396 \begin_layout Itemize
15401 invocation command line in
15417 installation configuration file (usually with the file
15422 See below to learn what warnings can be enabled and disabled on the command
15427 \begin_layout Itemize
15428 Export your document as a raw LaTeX file using
15433 ile\SpecialChar \menuseparator
15438 xport\SpecialChar \menuseparator
15450 Invoked in this way, it can be a hassle to find the corresponding place
15451 in the document inside LyX, but with a little patience, you should be able
15455 \begin_layout Standard
15456 Here follows the warning messages that can be enabled and disabled in
15465 to disable a warning, and
15469 to enable a warning.
15470 The emphasized entries are disabled by default, because the default is
15473 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15478 \begin_layout Standard
15479 Notice that you should only use the options that enable and disable warnings,
15480 because LyX relies on some of the other command line parameters to be set
15481 in a specific way to have a chance to communicate with
15488 \begin_layout Enumerate
15492 Command terminated with space.
15495 \begin_layout Enumerate
15498 Non-breaking space (
15499 \begin_inset Quotes eld
15507 \begin_inset Quotes erd
15510 ) should have been used.
15513 \begin_layout Enumerate
15517 You should enclose the previous parenthesis with
15518 \begin_inset Quotes eld
15526 \begin_inset Quotes erd
15532 \begin_layout Enumerate
15535 Italic correction (
15536 \begin_inset Quotes eld
15546 \begin_inset Quotes erd
15549 ) found in non-italic buffer.
15552 \begin_layout Enumerate
15555 Italic correction (
15556 \begin_inset Quotes eld
15566 \begin_inset Quotes erd
15569 ) found more than once.
15572 \begin_layout Enumerate
15576 No italic correction (
15577 \begin_inset Quotes eld
15587 \begin_inset Quotes erd
15593 \begin_layout Enumerate
15597 \begin_inset Quotes eld
15605 \begin_inset Quotes erd
15609 \begin_inset Quotes eld
15617 \begin_inset Quotes erd
15623 \begin_layout Enumerate
15626 Wrong length of dash may have been used.
15629 \begin_layout Enumerate
15633 \begin_inset Quotes eld
15641 \begin_inset Quotes erd
15645 \begin_inset Quotes eld
15653 \begin_inset Quotes erd
15659 \begin_layout Enumerate
15663 \begin_inset Quotes eld
15671 \begin_inset Quotes erd
15677 \begin_layout Enumerate
15681 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15692 to achieve an ellipsis.
15695 \begin_layout Enumerate
15698 Inter-word spacing (
15699 \begin_inset Quotes eld
15709 \begin_inset Quotes eld
15712 ) should perhaps be used.
15715 \begin_layout Enumerate
15718 Inter-sentence spacing (
15719 \begin_inset Quotes eld
15729 \begin_inset Quotes erd
15732 ) should perhaps be used.
15735 \begin_layout Enumerate
15738 Could not find argument for command.
15741 \begin_layout Enumerate
15745 \begin_inset Quotes eld
15753 \begin_inset Quotes erd
15759 \begin_layout Enumerate
15762 Math mode still on at end of LaTeX file.
15765 \begin_layout Enumerate
15769 \begin_inset Quotes eld
15777 \begin_inset Quotes erd
15780 doesn't match the number of
15781 \begin_inset Quotes eld
15789 \begin_inset Quotes erd
15795 \begin_layout Enumerate
15798 You should use either
15801 \begin_inset Quotes eld
15809 \begin_inset Quotes erd
15814 as an alternative to
15815 \begin_inset Quotes eld
15823 \begin_inset Quotes erd
15829 \begin_layout Enumerate
15836 " (ASCII 39) instead of "
15843 \begin_layout Enumerate
15846 User-specified pattern found.
15849 \begin_layout Enumerate
15852 This command might not be intended.
15855 \begin_layout Enumerate
15862 \begin_layout Enumerate
15880 \begin_layout Enumerate
15883 Delete this space to maintain correct page references.
15886 \begin_layout Enumerate
15890 You might wish to put this between a pair of
15891 \begin_inset Quotes eld
15899 \begin_inset Quotes erd
15905 \begin_layout Enumerate
15908 You ought to remove spaces in front of punctuation.
15911 \begin_layout Enumerate
15914 Could not execute LaTeX command.
15917 \begin_layout Enumerate
15926 in front of small punctuation.
15929 \begin_layout Enumerate
15937 may look prettier here.
15940 \begin_layout Enumerate
15944 Multiple spaces detected in output.
15947 \begin_layout Enumerate
15950 This text may be ignored.
15953 \begin_layout Enumerate
15959 \begin_inset Quotes eld
15964 to begin quotation, not
15971 \begin_layout Enumerate
15978 to end quotation, not
15981 \begin_inset Quotes eld
15989 \begin_layout Enumerate
15995 \begin_layout Enumerate
15998 You should perhaps use
15999 \begin_inset Quotes eld
16007 \begin_inset Quotes erd
16013 \begin_layout Enumerate
16016 You should put a space in front of/after parenthesis.
16019 \begin_layout Enumerate
16022 You should avoid spaces in front of/after parenthesis.
16025 \begin_layout Enumerate
16029 You should not use punctuation in front of/after quotes.
16032 \begin_layout Enumerate
16035 Double space found.
16038 \begin_layout Enumerate
16041 You should put punctuation outside inner/inside display math mode.
16044 \begin_layout Enumerate
16047 You ought to not use primitive TeX in LaTeX code.
16050 \begin_layout Enumerate
16053 You should remove spaces in front of
16054 \begin_inset Quotes eld
16062 \begin_inset Quotes erd
16068 \begin_layout Enumerate
16071 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16082 is normally not followed by
16083 \begin_inset Quotes eld
16091 \begin_inset Quotes erd
16097 \begin_layout Standard
16098 In later versions of LyX, we hope to provide a more complete interface to
16099 this tool (and it's smaller cousin
16103 ) to exploit the full power of it.
16104 But it's not exactly useless as it is now: go try it on one of your existing
16105 documents of a certain length and be surprised.
16108 \begin_layout Section
16109 Version Control in LyX
16112 \begin_layout Standard
16115 Lars Gullik Bjønnes
16118 \begin_layout Subsection
16122 \begin_layout Standard
16123 A friend of mine wanted to try LyX for a group project.
16124 When he didn't find support for version control or file locking, he dropped
16126 This angered me a bit, so I thought that I should at least make support
16127 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16128 This has now been done.
16129 LyX now supports some of the most basic RCS commands.
16130 If you need to something a bit more sophisticated you will have to do that
16131 manually in an xterm.
16134 \begin_layout Standard
16135 Before you begin to use the version control features in LyX, you should
16137 \begin_inset Quotes eld
16141 \begin_inset Quotes erd
16144 (a man file, read it with
16149 This file describes all the basic features of RCS.
16150 You should especially notice the comment about a RCS directory, and the
16151 notion of a master RCS file (the file ending in
16158 \begin_layout Standard
16159 The implementation in LyX assumes a recent version of the GNU RCS package---no
16160 guarantees are made for older versions.
16163 \begin_layout Subsection
16164 RCS commands in LyX
16167 \begin_layout Standard
16168 The following sections describe the RCS commands supported by LyX.
16169 You can find them in the
16174 ile\SpecialChar \menuseparator
16180 \begin_inset space ~
16188 \begin_layout Subsubsection
16194 \begin_layout Standard
16195 If your document is not under revision control, this is the only item shown
16197 And if it is under revision control, the
16204 item is grayed out.
16208 \begin_layout Standard
16209 This command registers your document with RCS\SpecialChar \@.
16210 You are asked interactively
16211 to supply an initial description of the document.
16212 The document is now set in Read-Only mode and you have to
16215 \begin_inset space ~
16219 \begin_inset space ~
16223 \begin_inset space ~
16228 , before making any changes to it.
16229 A document under revision control has a
16230 \begin_inset Quotes eld
16233 [RCS:<version> <locker>]
16234 \begin_inset Quotes erd
16237 item tagged to the filename in the minibuffer.
16240 \begin_layout Standard
16241 RCS command that is run:
16243 ci -q -u -i -t-"<initial description>" <file-name>
16246 \begin_layout Standard
16251 to understand the switches.
16255 \begin_layout Subsubsection
16261 \begin_layout Standard
16262 When you are finished editing a file, you check in your changes.
16263 When you do this, you are asked for a description of the changes.
16264 This is stored in the history log.
16265 The version number is bumped, your changes are applied to the master RCS
16266 file, the document is unlocked and set to Read-Only mode.
16270 \begin_layout Standard
16273 ci -q -u -m"<description>" <file-name>
16276 \begin_layout Subsubsection
16282 \begin_layout Standard
16283 By doing this you lock the document so that only you can edit it.
16284 This will also make the document Read-Write only for you.
16285 You will usually continue editing for a while and when you are finished
16286 you check in your changes.
16287 The status line is changed to reflect that you have locked the file.
16291 \begin_layout Standard
16294 co -q -l <file-name>
16297 \begin_layout Subsubsection
16300 Revert To Last Version
16303 \begin_layout Standard
16304 This will discard all changes made to the document since the last check
16306 You get a warning before changes are discarded.
16309 \begin_layout Standard
16312 co -f -u<version> <file-name>
16315 \begin_layout Subsubsection
16321 \begin_layout Standard
16322 This makes as if the last check in never happened.
16323 No changes are made to the document loaded into LyX, but the last version
16324 is removed from the master RCS file.
16328 \begin_layout Standard
16331 rcs -o<version> <file-name>
16334 \begin_layout Subsubsection
16340 \begin_layout Standard
16341 This show the complete history of the RCS document.
16346 is shown in a browser.
16354 \begin_layout Section
16355 Literate Programming
16358 \begin_layout Standard
16363 (kayvan@sylvan.com)
16367 original documentation written by
16369 Edmar Wienskoski Jr.
16372 (edmar-w-jr@technologist.com)
16375 \begin_layout Subsection
16379 \begin_layout Standard
16380 The main purpose of this documentation is to show you how to use LyX for
16381 literate programming.
16382 Where it is assumed that you are familiar with this programming technique,
16384 \begin_inset Quotes eld
16388 \begin_inset Quotes erd
16392 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16400 If that is not the case, please follow the web links provided in the following
16402 There is a lot of good documentation out there covering old development
16403 history to the latest tools tips.
16406 \begin_layout Standard
16407 It is also assumed that you are familiar with LyX itself to a point that
16408 you are comfortable changing your LyX preferences, and X resources file.
16409 If that is not the case please refer to other LyX documentation to cover
16410 your specific needs.
16413 \begin_layout Subsection
16414 Literate Programming
16417 \begin_layout Standard
16418 From the Literate Programming FAQ:
16421 \begin_layout Quotation
16422 Literate programming is the combination of documentation and source together
16423 in a fashion suited for reading by human beings.
16424 In fact, literate programs should be enjoyable reading, even inviting!
16425 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16426 and documentation in a single file.
16427 Literate programming tools then parse the file to produce either readable
16428 documentation or compilable source.
16429 The WEB style of literate programming was created by D.E.
16430 Knuth during the development of his TeX typesetting software.
16434 \begin_layout Standard
16435 Another excerpt says:
16438 \begin_layout Quotation
16441 How is literate programming different from verbose commenting?
16444 \begin_layout Quotation
16445 There are three distinguishing characteristics.
16446 In order of importance, they are:
16450 \begin_layout Itemize
16451 flexible order of elaboration
16454 \begin_layout Itemize
16455 automatic support for browsing
16458 \begin_layout Itemize
16459 typeset documentation, especially diagrams and mathematics
16463 \begin_layout Standard
16464 Now that I sparked your curiosity, take a look in the references.
16467 \begin_layout Subsubsection
16471 \begin_layout Standard
16472 The complete Literate Programming FAQ can be found at:
16475 \begin_layout Quote
16476 Literate Programming FAQ
16477 \begin_inset Flex URL
16480 \begin_layout Plain Layout
16482 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16490 \begin_layout Standard
16491 The FAQ lists 23 (twenty three!) different literate programming tools.
16492 Where some are specialized or
16493 \begin_inset Quotes eld
16497 \begin_inset Quotes erd
16500 for particular programming languages, while other have general scope.
16505 for my own use for several reasons:
16508 \begin_layout Itemize
16509 It can generate the documentation either in LaTeX or HTML.
16512 \begin_layout Itemize
16513 It has a open architecture, i.e., it is easy to plug in new filters and to
16514 perform special processing that you may need.
16518 \begin_layout Itemize
16519 There is a good selection of filters available already (the HTML is one
16523 \begin_layout Itemize
16527 \begin_layout Standard
16528 The Noweb web page can be found at:
16531 \begin_layout Quote
16533 \begin_inset Flex URL
16536 \begin_layout Plain Layout
16538 http://www.cs.virginia.edu/~nr/noweb/
16546 \begin_layout Standard
16547 Starting from there you can reach many other interesting links and even
16548 some literate program examples.
16551 \begin_layout Subsection
16552 \begin_inset CommandInset label
16554 name "sub:LyX-and-Literate"
16558 LyX and Literate Programming
16561 \begin_layout Standard
16562 The LyX support for Literate Programming is provided by using the generic
16563 LyX convertors mechanism.
16564 This support is provided in a
16565 \begin_inset Quotes eld
16569 \begin_inset Quotes erd
16572 way, i.e., you will be able to use this new LyX feature with some other literate
16573 programming tool of your choice by just changing your LyX preferences.
16576 \begin_layout Subsubsection
16577 Generating documents and code (weaving and tangling)
16580 \begin_layout Paragraph
16581 Selecting the document class
16584 \begin_layout Standard
16585 If you have installed Noweb and LyX successfully, whenever you open a new
16586 document or try to change the document class of an existing one, you will
16587 find that there are three new document classes available:
16590 \begin_layout Itemize
16594 \begin_layout Itemize
16598 \begin_layout Itemize
16602 \begin_layout Standard
16603 You must select one of them to create your literate documents from.
16607 \begin_layout Standard
16608 Note that literate documents are not limited to these three classes.
16609 New classes can be generated from other styles like letter or in combination
16610 with other class variations like Article (AMS).
16611 If you have special needs that cannot be covered by one of the existing
16612 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16613 will arrange to insert a new entry, or teach you how to do it.
16617 \begin_layout Plain Layout
16618 It is very simple, it involves the creation of a file with four lines, and
16619 re-running of the auto configuration.
16624 Moreover, if you use a literate tool other than Noweb you may need to create
16625 a new set of document classes for it.
16628 \begin_layout Paragraph
16632 \begin_layout Standard
16633 LyX enables you to write code with a layout named
16641 \begin_layout Plain Layout
16642 The equivalent Noweb term is
16643 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16651 For historical reasons, I got used to the term
16652 \begin_inset Quotes eld
16656 \begin_inset Quotes erd
16659 introduced by other literate tool named Nuweb, which I used for many years
16660 before rendering myself to Noweb.
16665 Noweb delimits scraps like this:
16668 \begin_layout LyX-Code
16672 \begin_layout LyX-Code
16676 \begin_layout LyX-Code
16680 \begin_layout LyX-Code
16684 \begin_layout LyX-Code
16688 \begin_layout Standard
16689 The problem is that whatever is written in between the << and the
16693 must be taken literally, i.e., LyX should be prevented from making any special
16694 interpretation of what has been written.
16695 This is handled by a special layout named Scrap, that works like a normal
16696 paragraph but has a free spacing capability.
16699 \begin_layout Standard
16700 The down side of the Scrap paragraph layout is that consecutive paragraphs
16701 of code will be spaced with one empty line in the source code and also
16702 in the printed documentation.
16703 The work around is to enter each line of code within a single Scrap, with
16704 a newline (ctrl-return).
16705 The example above will look like this:
16709 \begin_layout Plain Layout
16710 If you have a printed version of this document you will not see any difference
16711 between the previous example and this one.
16719 \begin_layout LyX-Code
16721 \begin_inset Newline newline
16725 \begin_inset Newline newline
16729 \begin_inset Newline newline
16733 \begin_inset Newline newline
16739 \begin_layout Standard
16740 This layout works fine.
16741 The only real inconvenience is that you have to type ctrl-return instead
16746 \begin_layout Plain Layout
16747 It is in my list of
16748 \begin_inset Quotes eld
16752 \begin_inset Quotes erd
16763 \begin_layout Standard
16764 As a special note, you can also use the
16765 \begin_inset Quotes eld
16769 \begin_inset Quotes erd
16772 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16776 \begin_layout LyX-Code
16778 \begin_inset Newline newline
16781 def some_function(args):
16782 \begin_inset Newline newline
16785 "This is the doc string for this function."
16786 \begin_inset Newline newline
16789 print "My args: ", args
16792 \begin_layout LyX-Code
16793 @ %def some_function
16796 \begin_layout Standard
16797 For an example of this usage and the resulting cross-reference output, look
16798 at the Literate python program in
16800 LIBDIR/examples/listerrors.lyx
16802 which should make this all clear.
16805 \begin_layout Paragraph
16806 Generating the documentation
16809 \begin_layout Standard
16810 At this point you already have a new document file with a proper document
16811 class, and with some code and text on it.
16812 How do I print it? The answer is simple, you select
16817 iew\SpecialChar \menuseparator
16825 Just like you would do for a plain document.
16826 No special procedure is required.
16829 \begin_layout Standard
16830 To help orientate you, I will now explain what happens inside LyX:
16833 \begin_layout Enumerate
16839 pdate\SpecialChar \menuseparator
16846 menu option is chosen, a LaTeX file is generated.
16851 \begin_layout Standard
16852 If the document is of any literate class the generated file will be named
16853 with an extension name defined by the
16854 \begin_inset Quotes eld
16858 \begin_inset Quotes erd
16861 format (defined in the Preferences panel), otherwise the file will have
16870 \begin_layout Enumerate
16871 Note that the only difference so far is in the name of the file, no special
16872 processing is required by LyX.
16873 Given that you formatted the code using the Scrap layout that, by itself,
16874 takes care of the business.
16877 \begin_layout Enumerate
16878 If the document is of any literate class LyX will then use the internal
16879 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16883 \begin_layout Plain Layout
16884 The converters are defined in the
16889 ools\SpecialChar \menuseparator
16897 \begin_inset Quotes eld
16901 \begin_inset Quotes erd
16906 \begin_inset CommandInset ref
16908 reference "sub:converters"
16916 manual for general information about converters.
16921 to generate the LaTeX file.
16925 \begin_layout Standard
16926 Otherwise it will just skip this step.
16930 \begin_layout Enumerate
16931 Finally, LaTeX is invoked and the regular post processing continues as in
16935 \begin_layout Standard
16936 Independence from a particular
16937 \begin_inset Quotes eld
16941 \begin_inset Quotes erd
16944 is easily achieved by changing the commands that are run by the various
16948 \begin_layout Paragraph
16949 Generating the code
16952 \begin_layout Standard
16953 When the build menu option is chosen or the corresponding button in the
16954 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16955 Next, LyX invokes the
16960 This converter needs to be defined by the user and is not installed by
16961 default, though the Program format is.
16962 This converter (like any other converter) will have two parts:
16965 \begin_layout Enumerate
16966 The converter program itself.
16967 This program performs the conversion from the one format to the other (in
16968 this case, from the Noweb format to the Program pseudo-format).
16971 \begin_layout Enumerate
16972 The error log parser.
16973 This is a program whose sole purpose is to rewrite error messages in a
16974 format that LyX understands.
16975 This makes it possible for LyX to place error boxes in the right places
16976 in the file buffer.
16979 \begin_layout Standard
16980 The first part, the
16981 \begin_inset Quotes eld
16985 \begin_inset Quotes erd
16988 setting, should be set to
16989 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17001 This basically means that LyX will call
17002 \begin_inset Quotes eld
17006 \begin_inset Quotes erd
17009 (a program or script) with the name of the Noweb file (normally a file
17010 in the LyX temp directory).
17014 \begin_layout Standard
17015 This is an implementation of
17016 \begin_inset Quotes eld
17020 \begin_inset Quotes erd
17023 that you can place in a directory on your path:
17026 \begin_layout LyX-Code
17030 \begin_layout LyX-Code
17034 \begin_layout LyX-Code
17035 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17038 \begin_layout Standard
17039 The next part of the converter setting is the
17040 \begin_inset Quotes eld
17044 \begin_inset Quotes erd
17047 which is to be set to
17048 \begin_inset Quotes eld
17053 parselog=listerrors
17056 \begin_inset Quotes erd
17060 This will run any errors that are generated by the
17061 \begin_inset Quotes eld
17065 \begin_inset Quotes erd
17068 process through the
17069 \begin_inset Quotes eld
17073 \begin_inset Quotes erd
17079 \begin_layout Standard
17080 The converter code looks in
17088 then on the path for the
17089 \begin_inset Quotes eld
17093 \begin_inset Quotes erd
17099 \begin_layout Standard
17100 The build will normally take place in LyX's temporary directory, so the
17101 files produced by the conversion will be in that directory.
17102 LyX will copy out what it regards as the `main' file, but the
17106 conversion may produce several files, and so most of these would then be
17107 deleted when LyX was closed.
17108 The present solution is to use a `copier',
17112 \begin_layout Plain Layout
17114 \begin_inset CommandInset ref
17116 reference "sec:converters-etc"
17124 manual for information on these.
17133 script in its default mode, so that the entire contents of the temporary
17134 directory is copied.
17135 More will get copied than is needed, to be sure, but nothing will be lost.
17136 If, however, you know what extensions the generated files will have, this
17137 can be improved by using the
17146 This option takes a comma-separated list of extensions to copy.
17147 So, for example, if the conversion will generate only files with the extensions
17156 , then the correct definition would be:
17159 \begin_layout LyX-Code
17160 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17163 \begin_layout Standard
17164 The result will be that only files with these two extensions will be copied
17168 \begin_layout Paragraph
17169 Build instructions in the document
17172 \begin_layout Standard
17173 The last piece of the integration between LyX and noweb is the
17174 \begin_inset Quotes eld
17178 \begin_inset Quotes erd
17182 Generally, the instructions for building your program should be embedded
17183 in a scrap of its own.
17185 \begin_inset Quotes eld
17189 \begin_inset Quotes erd
17192 above uses the notangle command to look for this scrap (called
17193 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17200 ) and runs its contents through
17201 \begin_inset Quotes eld
17205 \begin_inset Quotes erd
17211 \begin_layout Standard
17212 Typically, such a scrap would look something like this:
17215 \begin_layout LyX-Code
17217 \begin_inset Newline newline
17221 \begin_inset Newline newline
17225 \begin_inset Newline newline
17228 if [ -z "${NOWEB_SOURCE}" ]
17229 \begin_inset Newline newline
17233 \begin_inset Newline newline
17236 NOWEB_SOURCE=myfile.nw
17237 \begin_inset Newline newline
17241 \begin_inset Newline newline
17245 code to extract files ...]
17246 \begin_inset Newline newline
17250 code to compile files ...]
17251 \begin_inset Newline newline
17257 \begin_layout Standard
17260 LIBDIR/examples/listerrors.lyx
17264 LIBDIR/examples/Literate.lyx
17266 which implement two versions of the
17267 \begin_inset Quotes eld
17271 \begin_inset Quotes erd
17274 program for some illustrations of how all of these pieces go together or
17277 LIBDIR/examples/noweb2lyx.lyx.
17280 Interestingly, these three files show off the language-indepence of the
17281 LyX literate programming support since they are written in Python, C and
17285 \begin_layout Subsubsection
17289 \begin_layout Standard
17290 All the Literate Programming support is configured by the
17295 ools\SpecialChar \menuseparator
17303 \begin_inset Quotes eld
17307 \begin_inset Quotes erd
17311 The important parts are:
17314 \begin_layout Description
17316 \begin_inset space ~
17320 \begin_inset Quotes eld
17324 \begin_inset Quotes erd
17328 \begin_inset space ~
17331 format Set up via the Formats tab, this is where the Noweb-specific pieces
17341 , the file extension is set to
17346 This tells LyX to create a file with a
17350 extension in the first step of the conversion process.
17353 \begin_layout Description
17355 \begin_inset space ~
17363 \begin_inset space ~
17366 format This is an empty format whose sole purpose is to be the endpoint
17367 of a conversion (which then allows us to set up a converter for it).
17370 \begin_layout Description
17379 This converter performs the
17380 \begin_inset Quotes eld
17384 \begin_inset Quotes erd
17387 of the literate document.
17388 For Noweb, it is set to
17389 \begin_inset Quotes eld
17394 noweave -delay -index $$i > $$o
17397 \begin_inset Quotes erd
17403 \begin_layout Description
17413 \begin_inset Quotes eld
17417 \begin_inset Quotes erd
17421 As stated above, the Converter is set to
17422 \begin_inset Quotes eld
17430 \begin_inset Quotes erd
17433 , with Flags set to
17434 \begin_inset Quotes eld
17439 originaldir,parselog=listerrors
17442 \begin_inset Quotes erd
17448 \begin_layout Subsubsection
17452 \begin_layout Standard
17453 There is also a new function implemented in the LyX server, the
17454 \begin_inset Quotes eld
17457 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17461 \begin_layout Standard
17462 When debugging code with ddd/gdb, it is possible to invoke a text editor
17463 at the current execution position with a single key stroke.
17464 The default ddd configuration for that is shift-ctrl-V.
17465 It happens that you can define the editor command line invocation in ddd
17471 dit\SpecialChar \menuseparator
17476 references\SpecialChar \menuseparator
17483 dialog and changing the "Edit Sources" entry.
17486 \begin_layout Standard
17487 I take advantage of the new created LyX server function and this ddd feature,
17489 \begin_inset Quotes eld
17493 \begin_inset Quotes erd
17499 \begin_layout LyX-Code
17500 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17503 \begin_layout Standard
17504 With this, whenever you are using ddd and find a point in the program that
17505 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17506 ddd you forward this information to LyX through the LyX server and then
17507 the LyX window will show the same file with the cursor at the same position
17508 ddd was pointing to.
17509 No more guessing or long scrolling to locate a point in the program back
17513 \begin_layout Standard
17514 Note however that you must enable the LyX server to get this feature working
17515 (it is disabled by default).
17516 You can enable it in
17528 ) by entering in the
17533 \begin_inset Quotes eld
17538 /home/<your-home-directory>/.lyx/lyxpipe
17541 \begin_inset Quotes erd
17547 \begin_layout Standard
17548 Read the LyX server documentation in the
17550 Customization Manual
17552 for further information.
17555 \begin_layout Subsubsection
17559 \begin_layout Standard
17560 There are six new buttons that can be added to your LyX toolbar.
17561 Five of these buttons are short cuts to layout styles:
17582 The last one is a short cut to the
17583 \begin_inset Quotes eld
17587 \begin_inset Quotes erd
17594 \begin_layout Standard
17595 LyX has a range of buttons that are available for tool bar customization.
17596 In my toolbar I like to combine the six short cuts above with two more:
17604 \SpecialChar \menuseparator
17612 \SpecialChar \menuseparator
17625 iew\SpecialChar \menuseparator
17633 Here is how it looks like:
17636 \begin_layout LyX-Code
17640 \begin_layout LyX-Code
17644 \begin_layout LyX-Code
17645 Icon "layout Standard"
17648 \begin_layout LyX-Code
17649 Icon "layout Section"
17652 \begin_layout LyX-Code
17653 Icon "layout LaTeX"
17656 \begin_layout LyX-Code
17657 Icon "layout LyX-Code"
17660 \begin_layout LyX-Code
17661 Icon "layout Scrap"
17664 \begin_layout LyX-Code
17668 \begin_layout LyX-Code
17672 \begin_layout LyX-Code
17673 Icon "buffer-typeset"
17676 \begin_layout LyX-Code
17677 Icon "build-program"
17680 \begin_layout LyX-Code
17684 \begin_layout LyX-Code
17688 \begin_layout LyX-Code
17692 \begin_layout LyX-Code
17696 \begin_layout LyX-Code
17700 \begin_layout Subsubsection
17701 Colors customization
17704 \begin_layout Standard
17705 There are a number of colors in LyX that can be customized in
17710 One of the things that bothers people is the LaTeX font color.
17711 The default color is red, since the scraps uses LaTeX font, and there is
17712 a lot of scraps in literate documents, you may get tired of seeing everything
17714 You can change it by going to the tabs
17723 \begin_layout Standard
17724 The next thing is the visible presence of the newline character in the screen.
17725 You can choose the color of this particular character and make it blend
17727 I recommend you choosing a color that is close to the background but not
17728 equal, that way you still can see it is there, but it is not bothering
17733 \begin_layout Chapter
17734 Secrets of the LaTeX Masters
17735 \begin_inset CommandInset label
17744 \begin_layout Standard
17745 Though LyX is a powerful tool, it cannot hope to support everything that
17746 can be done with pure TeX/LaTeX.
17747 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17748 as long as you are not afraid to use that
17749 \begin_inset Quotes eld
17753 \begin_inset Quotes erd
17756 button on the toolbar or add things to the LaTeX preamble.
17757 This section lists some tips, tricks, and otherwise cool ideas to give
17758 your document that extra little flair.
17761 Do try this at home
17763 , just start with something a little smaller and less important than your
17767 \begin_layout Standard
17768 Most ideas in this section require less common files in your LaTeX installation.
17769 If you have a system like teTeX, most will already be available.
17770 A few, however, will need to be downloaded from one of the CTAN archives.
17771 Often, there are several ways to do something, or several LaTeX style files
17772 which do the same thing.
17773 We do not endorse one choice over another, we simply claim that we have
17774 done a particular task with a particular file.
17775 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17778 \begin_layout Section
17782 \begin_layout Standard
17785 Lars Gullik Bjønnes
17788 \begin_layout Subsection
17792 \begin_layout Standard
17793 The aim for this chapter
17797 \begin_layout Plain Layout
17798 Editor's note: Lars' original chapter was a masterful description of how
17804 However, it was too long to flow smoothly in this document.
17805 I have therefore chosen to excerpt the most important sections here (sorry,
17806 Lars); you can read the original chapter (and more of the story!) in the
17809 examples/multicol.lyx
17817 is to show how the LaTeX package
17821 can be used in a LyX document.
17822 As LyX doesn't support the
17826 package natively yet, we have to use some small hacks.
17827 By reading this section it should be obvious how to do this.
17830 \begin_layout Subsection
17834 \begin_layout Standard
17839 package allows switching between one and multicolumn format on the same
17841 Footnotes are handled correctly (for the most part), but will be placed
17842 at the bottom of the page and not under each column.
17843 LaTeX's float mechanism, however, is partly disabled in the current implementat
17845 At the moment only page-wide floats can be used within the scope of the
17849 \begin_layout Subsection
17853 \begin_layout Subsubsection
17857 \begin_layout Standard
17858 If you want to have two columns in your text, you have use LaTeX mode to
17863 begin{multicols}{2}
17865 at the point where you want the two column layout to start, and then
17871 where you want it to end.
17875 \begin_layout Standard
17879 \begin_layout Plain Layout
17883 begin{multicols}{2}
17891 \begin_layout Standard
17896 The Adventure of the Empty House
17899 \begin_inset Newline newline
17904 Sir Arthur Conan Doyle
17907 \begin_layout Standard
17910 It was in the spring of the year 1894 that all London was interested, and
17911 the fashionable world dismayed, by the murder of the Honourable Ronald
17912 Adair under most unusual and inexplicable circumstances.
17913 The public has already learned those particulars of the crime which came
17914 out in the police investigation, but a good deal was suppressed upon that
17915 occasion, since the case for the prosecution was so overwhelmingly strong
17916 that it was not necessary to bring forward all the facts.
17917 Only now, at the end of nearly ten years, am I allowed to supply those
17918 missing links which make up the whole of that remarkable chain.
17919 The crime was of interest in itself, but that interest was as nothing to
17920 me compared to the inconceivable sequel, which afforded me the greatest
17921 shock and surprise of any event in my adventurous life.
17922 Even now, after this long interval, I find myself thrilling as I think
17923 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17924 ty which utterly submerged my mind.
17925 Let me say to that public, which has shown some interest in those glimpses
17926 which I have occasionally given them of the thoughts and actions of a very
17927 remarkable man, that they are not to blame me if I have not shared my knowledge
17928 with them, for I should have considered it my first duty to do so, had
17929 I not been barred by a positive prohibition from his own lips, which was
17930 only withdrawn upon the third of last month.
17933 \begin_layout Standard
17937 \begin_layout Plain Layout
17949 \begin_layout Subsubsection
17953 \begin_layout Standard
17954 The same pattern is used when you want more than two columns:
17957 \begin_layout Standard
17961 \begin_layout Plain Layout
17965 begin{multicols}{3}
17973 \begin_layout Standard
17976 It can be imagined that my close intimacy with Sherlock Holmes had interested
17977 me deeply in crime, and that after his disappearance I never failed to
17978 read with care the various problems which came before the public.
17979 And I even attempted, more than once, for my own private satisfaction,
17980 to employ his methods in their solution, though with indifferent success.
17981 There was none, however, which appealed to me like this tragedy of Ronald
17983 As I read the evidence at the inquest, which led up to a verdict of willful
17984 murder against some person or persons unknown, I realized more clearly
17985 than I had ever done the loss which the community had sustained by the
17986 death of Sherlock Holmes.
17987 There were points about this strange business which would, I was sure,
17988 have specially appealed to him, and the efforts of the police would have
17989 been supplemented, or more probably anticipated, by the trained observation
17990 and the alert mind of the first criminal agent in Europe.
17991 All day, as I drove upon my round, I turned over the case in my mind and
17992 found no explanation which appeared to me to be adequate.
17993 At the risk of telling a twice-told tale, I will recapitulate the facts
17994 as they were known to the public at the conclusion of the inquest.
17997 \begin_layout Standard
18001 \begin_layout Plain Layout
18013 \begin_layout Standard
18014 You can have more than 3 columns if you want to, but that might not be very
18015 pleasant for the eye.
18018 \begin_layout Subsubsection
18019 Columns inside columns
18022 \begin_layout Standard
18023 You can even have columns inside columns:
18026 \begin_layout Standard
18030 \begin_layout Plain Layout
18034 begin{multicols}{2}
18042 \begin_layout Standard
18045 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18046 at that time governor of one of the Australian colonies.
18047 Adair's mother had returned from Australia to undergo the operation for
18048 cataract, and she, her son Ronald, and her daughter Hilda were living together
18052 \begin_layout Standard
18056 \begin_layout Plain Layout
18060 begin{multicols}{2}
18068 \begin_layout Standard
18071 The youth moved in the best society--had, so far as was known, no enemies
18072 and no particular vices.
18073 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18074 had been broken off by mutual consent some months before, and there was
18075 no sign that it had left any very profound feeling behind it.
18076 For the rest {sic} the man's life moved in a narrow and conventional circle,
18077 for his habits were quiet and his nature unemotional.
18078 Yet it was upon this easy-going young aristocrat that death came, in most
18079 strange and unexpected form, between the hours of ten and eleven-twenty
18080 on the night of March 30, 1894.
18083 \begin_layout Standard
18087 \begin_layout Plain Layout
18099 \begin_layout Standard
18102 Ronald Adair was fond of cards--playing continually, but never for such
18103 stakes as would hurt him.
18104 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18105 It was shown that, after dinner on the day of his death, he had played
18106 a rubber of whist at the latter club.
18107 He had also played there in the afternoon.
18112 The evidence of those who had played with him-- Mr.
18113 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18114 and that there was a fairly equal fall of the cards.
18115 Adair might have lost five pounds, but not more.
18116 His fortune was a considerable one, and such a loss could not in any way
18118 He had played nearly every day at one club or other, but he was a cautious
18119 player, and usually rose a winner.
18120 It came out in evidence that, in partnership with Colonel Moran, he had
18121 actually won as much as four hundred and twenty pounds in a sitting, some
18122 weeks before, from Godfrey Milner and Lord Balmoral.
18123 So much for his recent history as it came out at the inquest.
18126 \begin_layout Standard
18130 \begin_layout Plain Layout
18142 \begin_layout Standard
18143 Please do read the file
18145 examples/multicol.lyx
18147 for more advanced examples including column and header spacing, vertical
18148 separator lines, and more.
18151 \begin_layout Section
18156 Paragraph Environment
18157 \begin_inset OptArg
18160 \begin_layout Plain Layout
18161 Numbering in Enumerate
18169 \begin_layout Standard
18175 \begin_layout Standard
18176 \begin_inset VSpace bigskip
18182 \begin_layout Standard
18184 The default numbering for the
18188 paragraph environment begins with Arabic numbers and ends with uppercase
18190 Suppose, however, you wanted a different type of numbering scheme.
18191 Here's a quickie example of how to change the numbering scheme:
18194 \begin_layout LyX-Code
18204 \begin_layout LyX-Code
18214 \begin_layout LyX-Code
18224 \begin_layout LyX-Code
18234 \begin_layout Standard
18235 \SpecialChar \ldots{}
18236 which changes the numbering scheme to uppercase Roman numerals, uppercase
18237 letters, Arabic numbers, and lowercase letter.
18240 \begin_layout Standard
18241 Additionally, the previous example also adds a little bit extra to the numbering
18243 For example, the first level label actually looks like:
18244 \begin_inset Quotes eld
18248 \begin_inset Quotes erd
18252 For ease of reading, we'll describe what the numbering schemes look like
18253 using a notation something like this: <
18254 \begin_inset Quotes eld
18258 \begin_inset Quotes erd
18262 \begin_inset space ~
18266 \begin_inset Quotes erd
18270 \begin_inset Quotes erd
18274 \begin_inset space ~
18278 \begin_inset Quotes erd
18282 \begin_inset Quotes erd
18286 \begin_inset space ~
18290 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18301 \begin_layout Standard
18302 As you can see in the example, there is a label command for each nesting
18309 \SpecialChar \ldots{}
18316 , as well as a counter,
18320 \SpecialChar \ldots{}
18326 There are also five
18327 \begin_inset Quotes eld
18331 \begin_inset Quotes erd
18364 , each of which take one counter as an argument.
18365 You can add characters before or after these, but there's no need to add
18369 \begin_layout Standard
18370 You can get really fancy with these.
18374 \begin_layout LyX-Code
18388 \begin_layout LyX-Code
18400 \begin_layout LyX-Code
18410 \begin_layout LyX-Code
18420 \begin_layout Standard
18421 produces the somewhat out of hand numbering scheme: <
18422 \begin_inset Quotes eld
18426 \begin_inset Quotes erd
18430 \begin_inset space ~
18434 \begin_inset Quotes erd
18438 \begin_inset Quotes erd
18442 \begin_inset space ~
18446 \begin_inset Quotes erd
18450 \begin_inset Quotes erd
18454 \begin_inset space ~
18458 \begin_inset Quotes eld
18462 \begin_inset Quotes erd
18469 \begin_layout Standard
18473 \begin_layout Section
18477 \begin_layout Standard
18483 \begin_layout Standard
18484 \begin_inset VSpace bigskip
18490 \begin_layout Standard
18495 \begin_layout Plain Layout
18501 tmpfont}{cmr17 scaled 2500}{
18513 \begin_layout Standard
18518 \begin_layout Plain Layout
18529 hose of you who like the style of old books probably also like
18530 \begin_inset Quotes eld
18534 \begin_inset Quotes erd
18537 ---those large capital letters which begin each new chapter or section.
18538 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18539 know some plain TeX!) but does require a lot of work and many iterations,
18540 as you can see by all the ugly TeX-mode stuff at the beginning of this
18544 \begin_layout Standard
18548 \begin_layout Plain Layout
18554 bigdrop{-1em}{3}{ptmri}{T}+
18559 here is a much easier way of doing this, of course.
18568 ) package from CTAN allows a simple way to add such letters to your documents.
18569 Since this package is not a standard part of teTeX, I can't demonstrate
18570 it within this document, but if you copy this paragraph to a new document,
18572 \begin_inset Quotes eld
18582 \begin_inset Quotes erd
18585 and the pluses from the TeX code at the beginning of the paragraph, and
18590 usepackage{dropcaps}
18592 to your LaTeX preamble, you will get a nice Times Roman Italic
18593 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18600 , whose height is three lines of text and which protrudes 1 em into the
18602 (Make certain you have copied
18603 \begin_inset Quotes eld
18611 \begin_inset Quotes erd
18614 into a directory where TeX can see it.) The first argument is the amount
18615 of indentation; in this case the negative sign moves it into the margin.
18616 The second argument is the height of the letter in number of lines of text.
18617 The third argument is the font name: virtually anything which has a tfm
18618 file should work (wade through the
18620 .../texmf/fonts/tfm
18622 directory for possibilities).
18623 My personal favorite is
18624 \begin_inset Quotes eld
18632 \begin_inset Quotes erd
18635 , a fancy German font specifically designed for dropped capitals.
18636 The fourth argument is the letter (or letters) to be dropped.
18641 package also offers the
18647 command, as well as a slightly simplified
18656 \begin_layout Section
18657 Non-standard Paragraph Shapes
18660 \begin_layout Standard
18666 \begin_layout Standard
18667 \begin_inset VSpace bigskip
18673 \begin_layout Standard
18677 \begin_layout Plain Layout
18689 \begin_layout Standard
18693 \begin_layout Plain Layout
18702 \begin_layout Plain Layout
18716 \begin_layout Standard
18721 \begin_layout Plain Layout
18732 \begin_layout Plain Layout
18741 \begin_layout Plain Layout
18750 \begin_layout Plain Layout
18759 \begin_layout Plain Layout
18768 \begin_layout Plain Layout
18777 \begin_layout Plain Layout
18786 \begin_layout Plain Layout
18795 \begin_layout Plain Layout
18804 \begin_layout Plain Layout
18813 \begin_layout Plain Layout
18822 \begin_layout Plain Layout
18831 \begin_layout Plain Layout
18840 \begin_layout Plain Layout
18849 \begin_layout Plain Layout
18858 \begin_layout Plain Layout
18867 \begin_layout Plain Layout
18876 \begin_layout Plain Layout
18885 \begin_layout Plain Layout
18894 \begin_layout Plain Layout
18900 There are times when the tyranny of rectangular paragraphs must be overthrown.
18901 In such situations, a call to the delightful plain TeX command
18908 As you can see, completely arbitrary shapes can be laid out with a suitable
18909 set of linelength definitions.
18910 While this parshape may look a bit silly and useless, one could conceive
18911 of situations such as finely tuned dropped capitals, word wrapping around
18912 non-rectangular graphics, etc.
18913 which will benefit from such handcrafting.
18916 \begin_layout Standard
18917 \begin_inset VSpace bigskip
18923 \begin_layout Standard
18928 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18935 is the number of lines of text which define the paragraph.
18936 If there turn out to be fewer lines, the shape is truncated; if there are
18937 more, the excess lines have the same dimensions as the last line of the
18947 entries specify the indentation of the line from the left margin, and the
18948 length of the line as measured from that point.
18949 The shape applies only to the current paragraph; everything is reset to
18950 normal for the next paragraph.
18953 \begin_layout Standard
18957 \begin_layout Plain Layout
18969 \begin_layout Section
18973 \begin_layout Standard
18974 As you can see, the examples in this section range from the useful to the
18976 While I don't expect that anyone will ever need the paragraph shape demonstrate
18977 d in the last section, the important point is that you can do almost anything
18978 you want in LyX if you are willing to figure out how to do it in TeX and
18980 TeX is a fantastically powerful typesetting system and all that power is
18981 available to you since LyX uses it as its backend.