1 #LyX 1.6.0beta3 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 % redefine the \LyX macro for PDF bookmarks
21 \def\LyX{\texorpdfstring{%
22 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
34 \font_typewriter default
35 \font_default_family default
41 \paperfontsize default
44 \pdf_title "LyX's Extended manual"
45 \pdf_author "LyX Team"
46 \pdf_subject "LyX's extended documentation"
47 \pdf_keywords "LyX, Documentation, Extended"
49 \pdf_bookmarksnumbered true
50 \pdf_bookmarksopen true
51 \pdf_bookmarksopenlevel 1
56 \pdf_pagebackref false
57 \pdf_pdfusetitle false
58 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
65 \paperorientation portrait
68 \paragraph_separation indent
70 \quotes_language english
73 \paperpagestyle headings
74 \tracking_changes false
91 \begin_layout Plain Layout
93 Principal maintainer of this file is
98 If you have comments or error corrections, please send them to the LyX
99 Documentation mailing list, <lyx-docs@lists.lyx.org>.
107 \begin_layout Standard
108 \begin_inset CommandInset toc
109 LatexCommand tableofcontents
116 \begin_layout Chapter
120 \begin_layout Standard
123 Extended LyX Features
125 manual, which you are now reading, is essentially Part II of the
127 User's Guide\SpecialChar \@.
130 The reason for splitting this document is simple: the
134 is already huge, and it contains all of the basic features one needs to
135 know in order to prepare most documents.
136 However, the LyX Team has a long-term goal of making LyX extensible through
137 various configuration files and external packages.
138 That means that if you want to support the Fizzwizzle LaTeX package, you
139 can create a layout file for it without having to alter LyX itself.
140 We've already had contributions of several new features this way.
141 This is the place where all of that gets documented.
144 \begin_layout Standard
145 This manual also documents some special features, like fax support, version
146 control, and SGML support, which require additional software to work properly.
147 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
148 spruce up your documents by directly using the powerful features of LaTeX.
153 only WYSIWYM, and will only ever interface to certain LaTeX features.
156 \begin_layout Standard
157 Of course, with all of this extra documentation,
159 Extended LyX Features
161 may itself grow too big for its britches.
162 In that case, you can just call it the
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
173 \begin_layout Standard
174 If you haven't read the
178 yet, you are definitely in the wrong manual.
183 is the first place to go, since it will direct you to the correct manual,
184 and it also describes the notation and format of all of the manuals.
185 You should also be thoroughly familiar with the
189 and all of the basic features of LyX.
193 \begin_layout Standard
194 In this document, many sections are independent articles contributed by
195 an individual and are noted as such.
196 This person is generally whoever wrote the layout file for the new document
197 class or LaTeX package, or implemented the feature.
198 If there is no mention of an author to a chapter [or chapter sections],
199 that means it was written by the LyX Documentation Team.
202 \begin_layout Standard
203 Since all the topics in this manual depend heavily on LyX's interaction
204 with LaTeX, this first chapter covers the inner workings of LyX and how
205 to direct LyX to generate exactly the LaTeX code you want.
206 It is obviously for more seasoned LyX users.
209 \begin_layout Chapter
213 \begin_layout Section
217 \begin_layout Standard
218 \begin_inset CommandInset label
220 name "sec:lyxandlatex"
224 This chapter is for both TeX-nicians and the LaTeX-curious.
225 In it, we'll explain how LyX and LaTeX work together to produce printable
227 This is the only place in any of the manuals where we assume you know something
231 \begin_layout Standard
232 At one time, we called LyX a
233 \begin_inset Quotes eld
236 WYSIWYM frontend to LaTeX,
237 \begin_inset Quotes erd
240 but that's no longer true.
241 There are frontends to LaTeX out there.
242 They are basically editors with the ability to run LaTeX and mark any errors
243 in the file you're editing.
252 run LaTeX, and it also marks errors in the file, it also does much, much
254 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
255 LyX has also added a few extensions to LaTeX.
256 Try the following sometime: select
258 Export\SpecialChar \menuseparator
268 menu, then look at the preamble of the resulting
273 You'll notice a variety of new macros defined specifically by LyX.
274 These macros are defined automatically, according to the features you use
278 \begin_layout Standard
279 There are several commands that automatically invoke LaTeX.
283 \begin_layout Itemize
289 iew\SpecialChar \menuseparator
299 \begin_layout Itemize
305 iew\SpecialChar \menuseparator
310 pdate\SpecialChar \menuseparator
316 \begin_layout Itemize
324 \SpecialChar \menuseparator
330 \begin_layout Itemize
338 \SpecialChar \menuseparator
344 \begin_layout Standard
345 They will only invoke LaTeX if the file has changed since the last time
350 \begin_layout Standard
351 When you run LaTeX on the file you're editing, LyX performs these steps:
354 \begin_layout Enumerate
355 Convert the document to LaTeX and save to a file with the extension
366 \begin_layout Enumerate
371 file (maybe several times).
374 \begin_layout Enumerate
375 If there are any errors, insert error boxes in the document to mark where
377 These boxes are transient and are not saved along with the document.
380 \begin_layout Standard
381 If you've run LaTeX using
409 , LyX performs two more steps:
412 \begin_layout Itemize
417 to convert the DVI file to PostScript:
421 \begin_layout Itemize
430 , the output file has the extension
435 \begin_layout Itemize
447 , the output file has the extension
455 \begin_layout Itemize
460 or send the PostScript file to the printer.
463 \begin_layout Section
464 \begin_inset Quotes eld
467 Help! LyX generated an unreadable
472 \begin_inset Quotes erd
478 \begin_layout Standard
479 Die-hard LaTeX users will scream and howl this into the night, then declare
480 LyX useless, simply because they didn't RTFM.
483 \begin_layout Standard
484 We're going to set the record straight.
485 LyX produces two kinds of LaTeX files.
486 One is human readable.
487 The other is LyX readable.
488 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
494 file is not human readable.
495 Don't even try to read it.
500 file that you can send to a colleague, select
505 xport\SpecialChar \menuseparator
522 \begin_layout Section
523 Translating LaTeX files into LyX
524 \begin_inset CommandInset label
526 name "sec:Translating-LaTeX-files"
533 \begin_layout Standard
534 You can import a LaTeX file into LyX by using the
539 ile\SpecialChar \menuseparator
544 mport\SpecialChar \menuseparator
552 This will call a program named
556 ---which will create a file
564 ---and then open that file.
567 \begin_layout Standard
572 will translate most legal LaTeX, but not everything.
573 It will leave things it doesn't understand in TeX mode, so after translating
578 , you can look for red text and hand-edit it to look right.
581 \begin_layout Standard
582 If you just want to put a piece of LaTeX code into a LyX file, see Section
587 \begin_inset CommandInset ref
589 reference "sec:latexcodes"
596 \begin_layout Section
597 Inserting LaTeX Code into LyX Documents
598 \begin_inset CommandInset label
600 name "sec:Inserting-LaTeX-Code"
607 \begin_layout Standard
608 \begin_inset CommandInset label
610 name "sec:latexcodes"
614 This is a rather important point: You can always insert LaTeX code into
616 LyX simply cannot, and will probably never be able to, display every possible
618 If ever you need to insert LaTeX commands into your LyX document, you can
619 use the ERT box, which you can insert into your document with
624 nsert\SpecialChar \menuseparator
632 The ERT box comes in three forms: collapsed, open, and inlined.
633 The first two are used just like any other collapsible (foldable) box (such
634 as footnotes), and are useful for significant amounts of LaTeX commands.
636 \begin_inset Quotes eld
640 \begin_inset Quotes erd
643 ERT box displays its content as part of the button, and is useful for very
644 short sections of LaTeX commands.
649 \begin_layout Plain Layout
659 \begin_layout Standard
660 You can switch between all three by right-clicking on the ERT.
661 Note that if you want more than one line of LaTeX commands, you cannot
662 use the inlined mode.
665 \begin_layout Standard
666 Here's an example of inserting LaTeX commands in a LyX document.
667 The code looks like this:
670 \begin_layout LyX-Code
674 \begin_inset Newline newline
680 \begin_inset Newline newline
683 This is an example for a minipage environment.
685 \begin_inset Newline newline
688 can put nearly everything in it, even (non-floating)
689 \begin_inset Newline newline
694 \begin_inset Newline newline
700 \begin_inset Newline newline
704 \begin_inset Newline newline
710 \begin_inset Newline newline
716 \begin_inset Newline newline
722 \begin_inset Newline newline
727 \begin_inset Newline newline
733 \begin_inset Newline newline
739 \begin_inset Newline newline
745 \begin_inset Newline newline
753 \begin_layout LyX-Code
757 \begin_layout Standard
758 The ERT box containing this text is directly after this paragraph.
759 Those of you reading the manual online will only see a bunch of funky text
761 Those reading a printed version of the manuals will see the actual results:
764 \begin_layout Standard
768 \begin_layout Plain Layout
775 \begin_layout Plain Layout
782 \begin_layout Plain Layout
784 This is an example for a minipage environment.
785 You can put nearly everything in it, even (non-floating) figures and tables.
789 \begin_layout Plain Layout
796 \begin_layout Plain Layout
801 \begin_layout Plain Layout
808 \begin_layout Plain Layout
815 \begin_layout Plain Layout
822 \begin_layout Plain Layout
828 \begin_layout Plain Layout
835 \begin_layout Plain Layout
842 \begin_layout Plain Layout
849 \begin_layout Plain Layout
861 \begin_layout Standard
862 In addition to these two methods, you can also create a separate file containing
863 some complex LaTeX structure.
869 nsert\SpecialChar \menuseparator
880 to include your file (you should select the type
885 We recommend that you only do this if you have a
894 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
898 \begin_layout Standard
899 There are a few last notes to emphasize:
902 \begin_layout Itemize
903 Inside of LyX, LaTeX code appears
908 \begin_layout Itemize
913 check if your LaTeX code is correct.
916 \begin_layout Itemize
917 Beware reinventing the wheel.
920 \begin_layout Standard
921 That last note refers to two things.
922 First, LyX does have quite a few features tucked into it, and more are
924 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
925 feature before you go off merrily coding LaTeX.
926 Second, there are numerous LaTeX packages out there to do all sorts of
927 things, from labels to envelopes to fancy multipage tables.
928 Check out a CTAN site for details (see Section
929 \begin_inset Quotes eld
933 \begin_inset Quotes erd
944 \begin_layout Plain Layout
949 : I seem to do this an awful lot.
950 Sat down and merrily began coding something to print out labels, only to
951 learn that there were already 2 different LaTeX packages to do this.
952 Worse yet --- I had them already!
960 \begin_layout Standard
961 If you do need to do some wild and fancy things within your document, be
962 sure to check out a good LaTeX book for assistance.
963 There are a number of them listed in the bibliography of the
970 \begin_layout Standard
971 There are a number of LaTeX commands which have to be placed before the
972 beginning of the actual text.
973 They go into the preamble, and this is explained in the next section.
976 \begin_layout Section
977 LyX and the LaTeX Preamble
980 \begin_layout Subsection
981 About the LaTeX Preamble
984 \begin_layout Standard
985 \begin_inset CommandInset label
991 If you already know LaTeX, there is no need to explain here what the preamble
993 If you don't, the following will give you some ideas --- we recommend again
994 that you consult a LaTeX book for further information.
995 In any case, you should read the points below, because they explain what
996 you can do and what you don't need to do in the LaTeX preamble of a LyX
1000 \begin_layout Standard
1001 The LaTeX preamble comes at the very beginning of a document,
1009 \begin_layout Itemize
1010 declare the document class.
1011 LyX already does this for you.
1015 \begin_layout Standard
1016 If you're a seasoned LaTeX-nician, and you have some custom document class
1017 you want to use, check out the
1019 Customization Manual
1021 for information on how to make LyX interface to it.
1022 Be sure to submit your efforts to the LyX Team for inclusion in future
1027 \begin_layout Itemize
1028 declare the usage of packages.
1029 LaTeX packages provide special commands, which are only available within
1030 a document when the package has been declared in the preamble.
1031 For example, the package
1035 forces all paragraphs to be indented.
1036 There are other packages for labels, envelopes, margins, etc.
1040 \begin_layout Itemize
1041 set counters, variables, lengths and widths.
1042 There are several LaTeX counters and variables which
1046 be set globally from within the preamble in order to have the desired effect.
1047 [There are other variables which you can set and reset inside the document,
1048 too.] Margins are a good example of something which must be set in the preamble.
1049 Another example is the label format for lists.
1050 You can actually set these just about anywhere, but it's best to do it
1051 just once, inside the preamble.
1054 \begin_layout Itemize
1055 declare user defined commands [with
1067 ], mostly abbreviations for LaTeX commands which appear very often inside
1069 Although the preamble is a good place to declare such commands, they
1073 be declared anywhere else [but
1077 they are used for the first time, of course\SpecialChar \ldots{}
1079 This can be useful if there is a lot of raw LaTeX code in your document,
1080 which normally should not be the case.
1083 \begin_layout Standard
1084 LyX adds its own set of definitions to the preamble of the
1089 This makes LaTeX files generated by LyX portable.
1092 \begin_layout Subsection
1093 Changing the Preamble
1096 \begin_layout Standard
1097 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1098 can't change them without patching LyX itself.
1099 You can, however, add your own stuff to the preamble.
1100 There are two ways to do this:
1103 \begin_layout Enumerate
1110 \begin_inset space ~
1133 \SpecialChar \menuseparator
1141 dialog, depending on your frontend.
1142 Note that the LyX keybindings will not work in this dialog, alas.
1145 \begin_layout Enumerate
1146 Use the preamble contents you've added as your default template (see
1147 \begin_inset Quotes eld
1151 \begin_inset Quotes erd
1158 ), so that it will be the default preamble for any file you create.
1161 \begin_layout Standard
1162 LyX adds anything in the
1169 dialog to its own built-in preamble.
1170 Before adding your own declarations in the preamble, you should make sure
1171 that LyX doesn't already support what you want to do (remember what we
1172 said about reinventing the wheel?).
1175 make sure your preamble code is correct
1178 LyX doesn't check it.
1181 \begin_layout Subsection
1185 \begin_layout Standard
1186 Here are some examples of what you can add to a preamble, and what they
1190 \begin_layout Subsubsection
1194 \begin_layout Standard
1195 There are two variables under LaTeX that control page position:
1208 Their names should be self-explanatory.
1209 These variables are useful if you think for a moment about computer labels.
1210 Sometimes, the size of a print medium and the area of the medium that you
1211 can actually print on aren't the same.
1227 \begin_layout Standard
1228 The default values for
1241 \begin_inset space ~
1245 \begin_inset space ~
1249 \begin_inset space ~
1252 the page isn't shifted.
1255 \begin_layout Standard
1256 Unfortunately, some DVI drivers always seem to shift the page.
1257 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1258 If you're using LyX on a system that you don't personally maintain, and
1259 your sysadmin is a doofus,
1272 Suppose you're left and top margins are always 0.5 inches too big.
1273 You can add this to the preamble:
1276 \begin_layout LyX-Code
1284 \begin_layout LyX-Code
1292 \begin_layout Standard
1293 \SpecialChar \ldots{}
1294 and your margins should now be correct.
1297 \begin_layout Subsubsection
1301 \begin_layout Standard
1302 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1303 There's a rather nice package, available at your nearest CTAN archive,
1304 for printing sheets of labels, called
1309 Now, your system may not have this package installed by default.
1310 We leave that up to you to check.
1311 You'll also want to read the documentation for it; we're not going to do
1313 Since this is an example, however, we'll give you an example of how you
1317 \begin_layout Standard
1318 First, make sure you're using the
1323 Next, you need to put the following in your preamble:
1326 \begin_layout LyX-Code
1332 \begin_layout LyX-Code
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 Standard
1369 This sets things up for Avery® label sheets, stock #5360.
1370 You're now ready to print labels, but you'll need to insert LaTeX code,
1371 placing the commands
1383 around each label text.
1384 This and other special features of
1388 are explained in its documentation.
1391 \begin_layout Standard
1392 Someday, someone may write a LyX layout file to support this package directly.
1393 Maybe that someone is you.
1396 \begin_layout Subsubsection
1397 Example #3: Paragraph Indentation
1400 \begin_layout Standard
1401 Americans are trained to indent the first line of
1406 As with all of their other weird quirks, most Americans will whine and
1407 moan until they can have their way and indent the first line of all paragraphs.
1411 \begin_layout Plain Layout
1416 : This was written by an American ---
1420 ! It's my perception of my fellow countrymen.
1421 Tough if you don't like it.
1430 \begin_layout Standard
1431 Of course, this behavior isn't standard typography.
1432 In books, you typically only indent the first line of a paragraph
1436 it follows another one.
1437 The idea behind indenting the first line of a paragraph is to distinguish
1438 neighboring paragraphs from one another.
1439 If there is no previous paragraph, for example, it follows a figure, or
1440 is the first paragraph in a section, then there is no special indentation.
1444 \begin_layout Standard
1445 If you're a typical American, though, you don't care about such esoteric
1446 things; you want your indentation! Add this to the preamble:
1449 \begin_layout LyX-Code
1452 usepackage{indentfirst}
1455 \begin_layout Standard
1456 If your TeX distribution isn't a braindead one, you'll have this package,
1457 and all of your paragraphs will get the indentation you think they deserve.
1460 \begin_layout Subsubsection
1461 Example #4: This Document
1464 \begin_layout Standard
1465 You can also check out the preamble of this document to get an idea of some
1466 of the advanced things you can do.
1467 You'll probably need to make the
1472 reamble\SpecialChar \ldots{}
1475 dialog full-screen to see most of it.
1476 Also, there are more examples and an assortment of LaTeX
1477 \begin_inset Quotes eld
1481 \begin_inset Quotes erd
1485 \begin_inset space ~
1489 \begin_inset CommandInset ref
1491 reference "cha:secrets"
1499 \begin_layout Section
1500 LyX and LaTeX Errors
1503 \begin_layout Standard
1504 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1506 It then uses the log-file from the LaTeX run to do a post-mortem.
1507 As we stated earlier in the chapter, LyX generates two kinds of
1511 files, one of which it uses to locate errors in the document.
1512 If there was an error someplace, LyX will put a box with the word
1513 \begin_inset Quotes eld
1517 \begin_inset Quotes erd
1520 at the appropriate place in the document.
1524 \begin_layout Plain Layout
1525 LyX will occasionally misguess where the error was.
1526 This will typically happen with tables, figures, math, and the preamble.
1531 It will also display a message alerting you to the fact that there were
1535 \begin_layout Standard
1536 You can navigate through the errors by using
1552 \begin_inset Quotes eld
1556 \begin_inset Quotes erd
1559 the error-boxes and view the error message LaTeX produced by clicking on
1563 \begin_layout Standard
1564 Some folks also like to look at the log file directly, accessible from
1569 ocument\SpecialChar \menuseparator
1575 \begin_inset space ~
1579 \begin_inset space ~
1585 There are some fairly common error messages and warnings.
1586 We'll cover those here.
1587 You should look at a good LaTeX book for a complete listing.
1590 \begin_layout Itemize
1591 \begin_inset Quotes eld
1599 \begin_inset Quotes eld
1606 \begin_layout Standard
1607 Anything beginning with these word is a warning message for the purpose
1609 \begin_inset Quotes eld
1613 \begin_inset Quotes erd
1616 the LaTeX code itself.
1617 You'll get messages like this if you added or changed cross-references
1618 or bibliography entries, in which case, LaTeX is trying to tell you that
1619 you need to make another run.
1622 \begin_layout Standard
1623 You can by-and-large ignore these.
1627 \begin_layout Itemize
1628 \begin_inset Quotes eld
1636 \begin_inset Quotes erd
1643 \begin_layout Standard
1644 Another warning message, this time about fonts which LaTeX couldn't find.
1645 The rest of the message will often say something about a replacement font
1649 \begin_layout Standard
1650 You can safely ignore these.
1654 \begin_layout Itemize
1655 \begin_inset Quotes eld
1665 \begin_inset Quotes erd
1672 \begin_layout Standard
1678 They are warning you about lines that were too long and run past the right
1680 Almost always, this is unnoticeable in the final output.
1681 Or, only one or two characters extend past the margin.
1682 LaTeX seems to generate at least one of these messages for just about any
1686 \begin_layout Standard
1687 You can ignore these stupid messages.
1688 Your eyes will tell you if there's a problem with something that's too
1689 wide; just look at the output.
1693 \begin_layout Itemize
1694 \begin_inset Quotes eld
1704 \begin_inset Quotes erd
1711 \begin_layout Standard
1712 Not quite as common as its cousin.
1713 LaTeX seems to like to print lines that are a bit too wide as opposed to
1714 ones that are a bit too narrow.
1715 We have no idea why.
1718 \begin_layout Standard
1719 You can ignore these, too.
1723 \begin_layout Itemize
1724 \begin_inset Quotes eld
1734 \begin_inset Quotes erd
1738 \begin_inset Quotes eld
1748 \begin_inset Quotes erd
1755 \begin_layout Standard
1756 Warnings about troubles breaking the page.
1757 Once again, just look at the output.
1758 Your eyes will tell you where something has gone wrong.
1762 \begin_layout Itemize
1763 \begin_inset Quotes eld
1769 \begin_inset Quotes els
1773 \begin_inset Quotes ers
1779 \begin_inset Quotes erd
1786 \begin_layout Standard
1788 \begin_inset Quotes eld
1792 \begin_inset Quotes erd
1795 isn't installed on this system.
1796 This usually appears because some package your document needs isn't installed.
1797 If you didn't touch the preamble or didn't use the
1803 command, then one of the packages LyX tried to load is missing.
1809 elp\SpecialChar \menuseparator
1816 , to get a list of packages that LyX knows about.
1817 This file is updated whenever you reconfigure LyX (using
1824 \SpecialChar \menuseparator
1829 ) and tells you which packages have been detected and what they do.
1832 \begin_layout Standard
1843 command, and the package in question isn't installed, you'll need to install
1848 \begin_layout Itemize
1849 \begin_inset Quotes eld
1854 LaTeX Error: Unknown option
1857 \begin_inset Quotes erd
1864 \begin_layout Standard
1865 Error messages beginning with this are trying to tell you that you specified
1866 a bad or undefined option to a package.
1867 Check the package's documentation.
1871 \begin_layout Itemize
1872 \begin_inset Quotes eld
1877 Undefined control sequence
1880 \begin_inset Quotes erd
1887 \begin_layout Standard
1888 If you've inserted LaTeX code into your document, but made a typo, you'll
1890 You may have forgotten to load a package.
1891 In any case, this error message usually means that you used an undefined
1896 \begin_layout Standard
1897 There are other error and warning messages.
1898 Some are self-explanatory.
1899 These are usually LaTeX messages.
1900 Others are downright cryptic.
1901 These are actually TeX error messages, and we really have
1905 what they mean or how to decipher them.
1908 \begin_layout Standard
1909 There's a general sequence you should follow if you get error messages:
1912 \begin_layout Enumerate
1913 Look at the LaTeX code you inserted for typos.
1916 \begin_layout Enumerate
1917 If there are no typos, check and see that you used the command(s) correctly.
1920 \begin_layout Enumerate
1921 If you get a bunch of error boxes piled up at the very top of the document,
1922 it means that there are errors in the preamble.
1923 Start debugging your preamble.
1926 \begin_layout Enumerate
1927 If you didn't add anything to the preamble and didn't add any LaTeX code
1928 to the document, the first suspect is your LaTeX distribution itself.
1929 Check for missing packages and install them.
1932 \begin_layout Enumerate
1933 Okay, so there are no missing packages.
1934 Did you use any of the fine-tuning options in LyX? Specifically, did you
1939 any of them, like trying to manually insert lots of
1942 \begin_inset space ~
1955 s? Did you try to kludge something together with these instead of using
1956 the appropriate paragraph environment?
1959 \begin_layout Enumerate
1960 All right, you didn't use any of the fine-tuning options, you played by
1962 Did you try to pull a fancy maneuver? Did you do something funky inside
1963 a table or an equation, like inserting a graphic into a table cell?
1966 \begin_layout Enumerate
1967 Do you have long sections of text where LaTeX cannot find a place to break
1968 a line? By default, LaTeX is rather strict about how much extra inter-word
1969 spacing it will add in order to break a line.
1970 Preferably, you should rework the paragraph to avoid the problem.
1971 If this isn't an option, you can wrap your text in
1977 to make LaTeX's line breaking more, well, sloppy.
1980 \begin_layout Enumerate
1981 Did you go overboard with the nesting? LyX (currently) doesn't check to
1982 make sure you're in the limits for nesting environments.
1983 If you nested a bunch of environments to the
1984 \begin_inset Formula $17^{\mathrm{th}}$
1987 level, that's the problem.
1990 \begin_layout Enumerate
1991 Okay, you didn't get any error messages, but your output looks whacked.
1992 If you have a table or figure that's too wide or long for the page, you
1997 \begin_layout Enumerate
1998 rescale the figure so it fits.
2001 \begin_layout Enumerate
2002 trim down the table so it fits.
2005 \begin_layout Standard
2006 If something else is wrong with the output, and you didn't try to pull anything
2007 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2011 \begin_layout Standard
2012 If all this doesn't help --- well, then
2016 you might have found a bug in LyX\SpecialChar \ldots{}
2020 \begin_layout Chapter
2024 \begin_layout Section
2025 Preparing a Bibliography with BibTeX
2026 \begin_inset CommandInset label
2028 name "sec:Preparing-a-Bibliography"
2035 \begin_layout Standard
2042 Jürgen Spitzmüller
2045 \begin_layout Standard
2046 \begin_inset VSpace bigskip
2052 \begin_layout Standard
2054 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
2058 \begin_inset space \thinspace{}
2064 \begin_inset space ~
2067 setting up your own bibliographic databases),
2071 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2073 LaTeX: A Document Preparation System
2075 , particularly Appendix B.
2076 The rest of this discussion assumes you have created a correct bibliography
2077 file, that you have all relevant environment variables set correctly (esp.
2090 ), and that if sufficiently desperate, you could create and
2091 \begin_inset Quotes eld
2095 \begin_inset Quotes erd
2098 a LaTeX file with a BibTeX database.
2102 \begin_layout Standard
2103 For those who don't know what BibTeX is, it is a system for creating a large
2104 database of your most used journal references.
2105 For all future articles you write, you only need to include this standard
2106 database and reference the appropriate key to each reference.
2107 Even if you write only a few papers with handful of references each, it
2108 is well worth your time to examine BibTeX and decide whether it will be
2112 \begin_layout Standard
2113 To use BibTeX with LyX, first read the
2117 where it describes how to insert citations.
2118 The basic mechanism for inserting BibTeX references is the same.
2119 Then, at the very end of your document, select
2121 Insert\SpecialChar \menuseparator
2126 TOC\SpecialChar \menuseparator
2130 In the resulting dialog, fill out the dialog boxes as follows:
2133 \begin_layout Description
2134 Database: enter the name of your
2147 For searching multiple
2151 files, just enter them in the desired order, separated by commas.
2155 \begin_layout Description
2156 Style: enter the name of your BibTeX style file *without* the
2161 The default style is
2165 (which should be included in your LaTeX distribution, so you don't have
2166 to worry about creating it).
2169 \begin_layout Standard
2170 For each citation, assuming that the source is in the
2179 nsert\SpecialChar \menuseparator
2186 at the correct location in the text, and enter the appropriate reference
2188 Nothing else is required; when invoking
2193 iew\SpecialChar \menuseparator
2200 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2201 including multiple invocations of LaTeX.
2205 \begin_layout Subsection
2206 Alternative Citation Styles
2209 \begin_layout Standard
2210 Standard BibTeX uses numbers (e.
2211 \begin_inset space \thinspace{}
2215 \begin_inset space \space{}
2219 \begin_inset Quotes eld
2223 \begin_inset Quotes erd
2226 ) to refer to a cited work.
2227 However, in many scientific disciplines, other citation styles are in use.
2228 The most common one is the author-year style (e.
2229 \begin_inset space \thinspace{}
2233 \begin_inset space \space{}
2237 \begin_inset Quotes eld
2241 \begin_inset Quotes erd
2245 LyX supports two packages that provide this style,
2254 Both packages have their own pros and cons, which cannot be listed in detail.
2255 If you only want to have simple author-year (or author-numerical) style
2256 or if you want to use one of the countless style files for natbib, than
2261 package is probably your choice.
2262 If you need special features like short title references, ibidem etc., you
2263 might consider the fairly new
2270 \begin_layout Standard
2271 The handling of both packages in LyX is basically the same.
2277 ocument\SpecialChar \menuseparator
2288 pane (with the xforms frontend: the
2302 With both packages, you will get some extra features in the citation dialog
2303 and you can select the style of the reference (
2304 \begin_inset Quotes eld
2308 \begin_inset Quotes erd
2312 \begin_inset Quotes eld
2316 \begin_inset Quotes erd
2320 \begin_inset Quotes eld
2324 \begin_inset Quotes erd
2328 \begin_inset Quotes eld
2332 \begin_inset Quotes erd
2336 Note that both packages need specifically designed style files (they both
2337 ship their own, while there are lots of additional style files and even
2338 an interactive style file builder
2342 \begin_layout Plain Layout
2344 \begin_inset Flex URL
2347 \begin_layout Plain Layout
2349 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2366 \begin_layout Subsection
2367 Sectionated Bibliographies
2368 \begin_inset CommandInset label
2370 name "sub:Sectionated-Bibliographies"
2377 \begin_layout Standard
2378 Sometimes you might need to divide your bibliography into several sections.
2379 If you are, for instance, a historian, the possibility to separate sources
2380 and scientific works is most likely a
2381 \begin_inset Quotes eld
2385 \begin_inset Quotes erd
2389 Unfortunately, BibTeX itself does not allow you to do this.
2390 The good news is, though: With the help of some LaTeX packages, BibTeX
2391 can be extended to fit your historical needs.
2394 \begin_layout Standard
2395 As of version 1.4, LyX provides native support for one of these packages,
2404 \begin_layout Plain Layout
2406 \begin_inset Flex URL
2409 \begin_layout Plain Layout
2411 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2421 The advantage of this package (compared to other packages like
2425 ) is that you don't need to define new citation commands.
2426 Instead, you need to prepare different bibliographic databases which include
2427 the entries for the different sections of the bibliography.
2428 For example: If you want to divide your bibliography into the sections
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2438 \begin_inset Quotes eld
2442 \begin_inset Quotes erd
2445 , you first need to create two bibliographic databases, e.
2446 \begin_inset space \thinspace{}
2450 \begin_inset space \space{}
2465 \begin_layout Standard
2471 ocument\SpecialChar \menuseparator
2482 pane (with the xforms frontend: the
2490 \begin_inset space ~
2496 Now you can insert multiple BibTeX references (as described in section
2497 \begin_inset space ~
2501 \begin_inset CommandInset ref
2503 reference "sec:Preparing-a-Bibliography"
2507 ), one for each section of your bibliography.
2508 Returning to our example: Insert a BibTeX reference for the database
2512 and a second one for the database
2517 You are free to use the same or different styles for each section.
2518 Additionally, you can chose if the bibliography section should contain
2520 \begin_inset Quotes eld
2523 all cited references
2524 \begin_inset Quotes erd
2527 of the specified database(s) (which is the default),
2528 \begin_inset Quotes eld
2531 all uncited references
2532 \begin_inset Quotes erd
2536 \begin_inset Quotes eld
2540 \begin_inset Quotes erd
2544 This might be useful if you would like to separate your bibliography into
2546 \begin_inset Quotes eld
2550 \begin_inset Quotes erd
2554 \begin_inset Quotes eld
2558 \begin_inset Quotes erd
2562 \begin_inset Quotes eld
2566 \begin_inset Quotes erd
2570 The titles for the sections can be added as ordinary sections or subsections.
2575 removes the bibliography title, you have manually re-add that, too (as
2576 a chapter* or section*, for instance).
2579 \begin_layout Subsection
2580 Multiple Bibliographies
2583 \begin_layout Standard
2584 Multiple bibliographies, e.
2585 \begin_inset space \thinspace{}
2589 \begin_inset space \space{}
2592 a bibliography for each section or chapter of the document, are not supported
2598 package, which is used for the creation of sectionated bibliographies in
2600 \begin_inset space ~
2604 \begin_inset space ~
2608 \begin_inset CommandInset ref
2610 reference "sub:Sectionated-Bibliographies"
2614 ), provides an easy way to solve this task, if you are willing to use some
2615 LaTeX-Code (ERT, cf.
2616 \begin_inset space ~
2620 \begin_inset space ~
2624 \begin_inset CommandInset ref
2626 reference "sec:Inserting-LaTeX-Code"
2634 \begin_layout Plain Layout
2635 An alternative approach is to use the
2643 package, respectively.
2651 \begin_layout Standard
2657 ocument\SpecialChar \menuseparator
2668 pane (with the xforms frontend: the
2676 \begin_inset space ~
2682 In the document, you have to enclose the sections, which shall contain
2683 their own bibliography (including the BibTeX reference itself), between
2696 (those commands have to be inserted as ERT).
2697 The bibliography will contain all references which have been cited in the
2700 \begin_inset space \thinspace{}
2703 B.: If you are using this approach, then
2707 citation reference has to be inside some btUnit.
2708 Also, the btUnits cannot be nested.
2711 \begin_layout Standard
2715 \begin_layout Section
2719 \begin_layout Subsection
2723 \begin_layout Standard
2724 When you are working on a large file with many sections, it is often convenient
2725 to break up the document into several files, or perhaps you have something
2726 where a table may change from time to time, but the preceding text does
2728 In these cases, you should seriously consider using multipart documents.
2729 For example, scientific papers often have five major sections: the introduction
2730 , observations, results, discussion, and conclusion.
2731 Each of these could be its own separate LyX file, with one
2732 \begin_inset Quotes eld
2736 \begin_inset Quotes erd
2739 file which contains the title, authors, abstract, references, etc., plus
2740 the five included files.
2741 It is important to note that each of these files is a full LyX file which
2742 can be formatted and printed on its own, as well as included in a master
2744 Each of these files must have the same document class, however--- don't
2745 attempt to mix book classes with article classes.
2746 You may also include LaTeX files; however, these files must not have their
2752 everything up to and including the
2764 line must be deleted) or else errors will be generated when you try to
2768 \begin_layout Standard
2769 LyX allows you to include files quite easily with
2774 nsert\SpecialChar \menuseparator
2780 \begin_inset space ~
2786 When you click on this selection a small box is inserted into the file
2787 at the current cursor location.
2788 Clicking on the box raises a dialog which allows you to select the file
2789 to be included, and the method of its inclusion.
2793 \begin_layout Standard
2794 The file selection box should by now be obvious.
2795 The three inclusion methods are
2796 \begin_inset Quotes eld
2800 \begin_inset Quotes erd
2804 \begin_inset Quotes eld
2808 \begin_inset Quotes erd
2812 \begin_inset Quotes eld
2816 \begin_inset Quotes erd
2820 The difference between
2821 \begin_inset Quotes eld
2825 \begin_inset Quotes erd
2829 \begin_inset Quotes eld
2833 \begin_inset Quotes erd
2836 is really only meaningful to LaTeXperts, but the practical difference is
2837 that files which are
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2845 are typeset beginning on a new page, while files which are
2846 \begin_inset Quotes eld
2850 \begin_inset Quotes erd
2853 are typeset starting on the current page.
2854 Perhaps the labeling in LyX will be changed someday to reflect this.
2857 \begin_layout Standard
2858 Generally, the master file is converted into a full LaTeX file before typesettin
2859 g, while the included files are converted to LaTeX files which do not have
2860 all the preamble information.
2866 \begin_inset space ~
2873 button prevents this conversion.
2876 \begin_layout Standard
2878 \begin_inset Quotes eld
2882 \begin_inset Quotes erd
2885 included file allows you to include a file typeset exactly as it appears
2887 \begin_inset space ~
2890 verbatim mode, with the characters set in a fixed-width typewriter font.
2891 Normally, spaces in this file are invisible, though two consecutive spaces
2892 are conserved, unlike LyX's normal treatment of spaces.
2893 However, setting the
2899 \begin_inset space ~
2903 \begin_inset space ~
2907 \begin_inset space ~
2912 checkbox typesets a mark to unambiguously define the presence of a space.
2916 \begin_layout Subsection
2917 Cross-References Between Files
2920 \begin_layout Standard
2921 It is possible to set up cross-references between the different files.
2922 First, open all the files in question: let's call them A and B in a two
2923 file example, where B is included in A.
2924 Let's say you insert a label in A, then want to reference it in B.
2925 Open the cross-reference dialog in whilst in document B, and you can select
2927 \begin_inset Quotes eld
2931 \begin_inset Quotes erd
2937 \begin_layout Section
2938 Fancy Headers and Footers
2941 \begin_layout Standard
2942 The default page layout is rather plain; for an article document class,
2943 all you get is a centered page number at the bottom of the page.
2944 This document is the book class, so it appears to be a bit fancier, but
2945 to really put on a show, you need to set the document page style to
2946 \begin_inset Quotes eld
2950 \begin_inset Quotes erd
2953 , as mentioned in the
2956 \begin_inset space ~
2962 This section describes the LaTeX codes you need to insert in your LaTeX
2963 preamble or the text in order to get the desired effects.
2966 \begin_layout Standard
2967 The page header is divided into three fields, not surprisingly labeled
2968 \begin_inset Quotes eld
2972 \begin_inset Quotes erd
2976 \begin_inset Quotes eld
2980 \begin_inset Quotes erd
2984 \begin_inset Quotes eld
2988 \begin_inset Quotes erd
2992 The footer is also divided into these three fields.
2993 The LaTeX commands to set these fields in the simplest manner are
3018 Suppose you wish to put your name in the upper left hand corner of each
3020 Simply insert the following command in the preamble:
3023 \begin_layout Standard
3032 \begin_layout Standard
3033 You will now see your name in the upper left.
3034 If a field has a default entry that you would like to get rid of (often
3035 the page number appears in the central footer, simply include a command
3036 with a blank argument, e.
3037 \begin_inset space \thinspace{}
3043 \begin_layout Standard
3051 \begin_layout Standard
3052 Let's get really fancy: lets put the section number with the word
3053 \begin_inset Quotes eld
3057 \begin_inset Quotes erd
3061 \begin_inset space \thinspace{}
3065 \begin_inset space ~
3068 Section 3) in the upper left, the page number (e.
3069 \begin_inset space \thinspace{}
3073 \begin_inset space ~
3076 Page 4) in the upper right, your name in the lower left, and the date in
3078 The following commands should now appear in the preamble:
3081 \begin_layout Standard
3091 \begin_layout Standard
3099 \begin_layout Standard
3109 \begin_layout Standard
3118 \begin_layout Standard
3126 \begin_layout Standard
3136 \begin_layout Standard
3149 access LaTeX's section and page counters, and so print out the current
3150 section and page numbers.
3157 simply prints out today's date.
3160 \begin_layout Standard
3161 The thicknesses of the horizontal rules drawn beneath the header and above
3162 the footer can also be modified.
3163 If you don't want one of the headers, set its thickness to 0.
3164 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3165 Use the commands, e.
3166 \begin_inset space \thinspace{}
3176 headrulewidth}{0.4pt}
3184 footrulewidth}{0.4pt}
3186 to set the thicknesses.
3189 \begin_layout Standard
3190 You can switch the header/footer settings on and off for individual pages
3195 thispagestyle{empty}
3201 thispagestyle{plain}
3207 thispagestyle{fancy}
3210 Simply insert them in the text on the page you want changed and mark them
3212 In fact, title pages are marked as plain by default, while following pages
3213 are marked fancy when using the global fancy setting.
3216 \begin_layout Standard
3217 There are more complex commands which will let you insert things in the
3218 upper left on odd numbered pages, etc., but I will refer you to the
3222 package documentation for more descriptions.
3223 For example, if you have a teTeX installation, look for
3225 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3231 \begin_layout Standard
3232 As a final example, it is possible to include an Encapsulated PostScript
3233 file in the header or footer.
3234 Suppose you want to put a company logo in the upper lefthand corner.
3235 You might try something like
3238 \begin_layout Standard
3247 includegraphics{logo.eps}}}
3250 \begin_layout Standard
3252 (you may need to preface this with
3256 usepackage{graphics}
3258 if you don't include EPS files elsewhere in your document).
3261 \begin_layout Section
3262 Itemize Bullet Selection
3263 \begin_inset CommandInset label
3272 \begin_layout Standard
3278 \begin_layout Subsection
3282 \begin_layout Standard
3283 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3284 Using this dialog you can easily specify what bullet shape to use at each
3285 level of an itemized list.
3286 These settings are document-wide so you won't be able to specify different
3287 sets of bullets for different paragraphs
3291 \begin_layout Plain Layout
3292 Well, actually you can but you'll have to do it by hand.
3300 \begin_layout Subsection
3304 \begin_layout Standard
3305 Open the dialog by selecting the
3310 ocument\SpecialChar \menuseparator
3317 menu item and then select the
3327 \begin_layout Standard
3328 The dialog provides you with a table of bullet shapes.
3329 A column of buttons on the left of the table provides access to the six
3330 different panels of bullet shapes.
3331 The row of buttons across the top is used to select which bullet depth
3333 A text entry under the table shows the currently selected bullet shape's
3334 LaTeX equivalent and this can be edited if desired.
3335 If you do modify the text you will also need to specify any needed packages
3336 in the LaTeX preamble.
3339 \begin_layout Standard
3340 The six panels are divided up by the packages they require.
3341 The following table shows the mappings from button name to LaTeX packages.
3344 \begin_layout Standard
3346 \begin_inset Tabular
3347 <lyxtabular version="3" rows="7" columns="2">
3349 <column alignment="center" valignment="top" width="0pt">
3350 <column alignment="center" valignment="top" width="0pt">
3352 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3355 \begin_layout Plain Layout
3370 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3373 \begin_layout Plain Layout
3390 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3393 \begin_layout Plain Layout
3408 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3411 \begin_layout Plain Layout
3427 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3430 \begin_layout Plain Layout
3445 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3448 \begin_layout Plain Layout
3465 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3468 \begin_layout Plain Layout
3483 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3486 \begin_layout Plain Layout
3503 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3506 \begin_layout Plain Layout
3521 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3524 \begin_layout Plain Layout
3541 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3544 \begin_layout Plain Layout
3559 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3562 \begin_layout Plain Layout
3579 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3582 \begin_layout Plain Layout
3597 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3600 \begin_layout Plain Layout
3623 \begin_layout Standard
3624 LyX doesn't stop you using bullets from packages you don't have.
3625 If you get errors from LaTeX when you try to view or print the file then
3626 its likely you are missing a package.
3627 LyX doesn't restrict your use since you may be editing locally and exporting
3631 \begin_layout Subsection
3635 \begin_layout Standard
3636 Select which bullet depth you want to change then select the bullet shape
3638 Any changes will not be visible in LyX, but are visible when viewing the
3639 document using xdvi or ghostview.
3642 \begin_layout Standard
3643 You can reset a bullet shape to the default simply by clicking your right
3644 mouse button on the appropriate bullet depth button.
3647 \begin_layout Standard
3652 want to have multiple sets of paragraphs with different sets of bullets
3653 in each then you're going to have to get your hands dirty.
3654 The itemize bullet selection dialog can help though because it provides
3655 you with the LaTeX code for a wide range of bullet shapes.
3656 To make your own custom paragraphs you have the following options:
3659 \begin_layout Standard
3663 \begin_layout Plain Layout
3679 \begin_layout Standard
3683 \begin_layout Plain Layout
3705 \begin_layout Itemize
3706 Use the LaTeX command
3712 to specify a new bullet shape for a given depth.
3713 You'll also need to save the current bullet shape so you can restore it
3715 In this itemized list the following LaTeX code was used to change the bullet
3716 used for the first depth.
3717 \begin_inset Newline newline
3733 \begin_inset Newline newline
3749 \begin_inset Newline newline
3754 Note that the itemize depth is specified in Roman numerals as part of the
3764 \begin_layout Itemize
3768 \begin_layout Plain Layout
3781 Specify each individual entry by starting each item with the bullet shape
3782 enclosed in square brackets and set as TeX.
3783 For example, this item was started with
3796 \begin_layout Standard
3800 \begin_layout Plain Layout
3816 \begin_layout Standard
3817 You'll also need to revert the labelitem back to its previous setting for
3818 the global bullet shape settings to remain in effect.
3819 The way used here was:
3820 \begin_inset Newline newline
3834 \begin_layout Chapter
3835 Special Document Classes
3838 \begin_layout Section
3839 \begin_inset CommandInset label
3841 name "sec:AMS-LaTeX"
3848 \begin_layout Standard
3851 David Johnson; updated by Richard Heck
3854 \begin_layout Standard
3855 \begin_inset VSpace bigskip
3861 \begin_layout Standard
3863 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3864 papers to be submitted to American Mathematical Society publications.
3865 The layouts are not tailored to a specific journal, but easily can be.
3866 You should refer to the AMS documentation for specific instructions for
3867 each journal (usually it will entail only changing a single line in the
3869 That documentation is available on the Web at
3870 \begin_inset Flex URL
3873 \begin_layout Plain Layout
3881 \begin_inset Flex URL
3884 \begin_layout Plain Layout
3886 ftp://ftp.ams.org/pub/tex/amslatex/
3892 These layouts are appropriate, and useful, for any mathematical writing.
3896 \begin_layout Standard
3897 There are two basic AMS LaTeX layouts:
3900 \begin_layout Enumerate
3901 amsart: The standard AMS article format.
3904 \begin_layout Enumerate
3905 amsbook: the standard AMS book (really, monograph) format.
3909 \begin_layout Standard
3910 These layouts themselves contain only the minimum necessary to use the AMS
3912 They do not, in particular, contain any of the `theorem' environments used
3913 for setting theorems, lemmas, and the like.
3914 These are contained, instead, in the
3915 \begin_inset Flex CharStyle:Code
3918 \begin_layout Plain Layout
3924 module, which you will need to load separately when you selected one of
3926 Less commonly used environments are in the
3927 \begin_inset Flex CharStyle:Code
3930 \begin_layout Plain Layout
3931 Theorems (AMS-Extended)
3940 \begin_layout Standard
3941 By default, theorems and the like are numbered consecutively throughout
3942 the document, but this may be modified by loading the module
3943 \begin_inset Flex CharStyle:Code
3946 \begin_layout Plain Layout
3947 Theorems (Order by Section)
3952 or, if you are using
3953 \begin_inset Flex CharStyle:Code
3956 \begin_layout Plain Layout
3963 \begin_inset Flex CharStyle:Code
3966 \begin_layout Plain Layout
3967 Theorems (Order by Chapter)
3973 These will number the results as
3974 \begin_inset Formula $n.m$
3977 , where the first number refers to the section (or chapter) and the second
3978 refers to the total number of results so far in that section (or chapter).
3979 Many environments are also available unnumbered.
3980 These are indicated by an asterisk at the end.
3981 If you happen to want
3985 unnumbered results, the the module
3986 \begin_inset Flex CharStyle:Code
3989 \begin_layout Plain Layout
3995 provides that option.
3998 \begin_layout Standard
3999 Note that these modules do not
4003 to be used with the AMS classes.
4004 It is perfectly possible to use the
4005 \begin_inset Flex CharStyle:Code
4008 \begin_layout Plain Layout
4014 module, and the others mentioned, with other classes, such as
4015 \begin_inset Flex CharStyle:Code
4018 \begin_layout Plain Layout
4025 \begin_inset Flex CharStyle:Code
4028 \begin_layout Plain Layout
4035 \begin_inset Flex CharStyle:Code
4038 \begin_layout Plain Layout
4047 \begin_layout Subsection
4048 What these layouts provide
4051 \begin_layout Standard
4052 There is a long list of included environments provided by these layouts.
4053 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4054 variety of `theorem' environments.
4055 However, the AMS recommends the environments that are available in LyX.
4059 \begin_layout Standard
4060 The following environments---as well as the standard environments, such
4062 \begin_inset Flex CharStyle:Noun
4065 \begin_layout Plain Layout
4072 \begin_inset Flex CharStyle:Noun
4075 \begin_layout Plain Layout
4082 \begin_inset Flex CharStyle:Noun
4085 \begin_layout Plain Layout
4092 \begin_inset Flex CharStyle:Noun
4095 \begin_layout Plain Layout
4102 \begin_inset Flex CharStyle:Noun
4105 \begin_layout Plain Layout
4112 \begin_inset Flex CharStyle:Code
4115 \begin_layout Plain Layout
4122 \begin_inset Flex CharStyle:Code
4125 \begin_layout Plain Layout
4134 \begin_layout Description
4135 Address This should be the author's permanent address.
4138 \begin_layout Description
4140 \begin_inset space ~
4143 Address This should be the author's temporary address at the time of submission,
4144 if different from the Address.
4147 \begin_layout Description
4148 Email Author's e-mail address
4151 \begin_layout Description
4152 URL Author's Web address, if desired.
4155 \begin_layout Description
4156 Keywords Key words or phrases used to identify specific topics discussed
4160 \begin_layout Description
4161 Subjectclass These refer to the AMS Subject Classifications, published and
4164 Mathematical Reviews
4167 These are also available online at the AMS cites listed above.
4170 \begin_layout Description
4174 \begin_layout Description
4178 \begin_layout Description
4182 \begin_layout Standard
4183 The following environments are provided by both the
4184 \begin_inset Flex CharStyle:Code
4187 \begin_layout Plain Layout
4194 \begin_inset Flex CharStyle:Code
4197 \begin_layout Plain Layout
4203 modules, in the latter case in both starred (unnumbered) and unstarred
4204 (numbered) versions.
4205 These same environments are provided only in the starred versions by the
4207 \begin_inset Flex CharStyle:Code
4210 \begin_layout Plain Layout
4219 \begin_layout Theorem
4220 This is typically used for the statements of major results.
4224 \begin_layout Corollary*
4225 This is used for statements which follow fairly directly from previous statement
4227 Again, these can be major results.
4232 These are smaller results needed to prove other statements.
4235 \begin_layout Proposition
4236 These are less major results which (hopefully) add to the general theory
4240 \begin_layout Conjecture
4241 These are statements provided without justification, which the author does
4242 not know how to prove, but which seem to be true (to the author, at least).
4245 \begin_layout Definition*
4246 Guess what this is for.
4247 The font is different for this environment than for the previous ones.
4251 \begin_layout Example*
4252 Used for examples illustrating proven results.
4255 \begin_layout Problem
4256 It's not really known what this is for.
4257 You should figure it out.
4260 \begin_layout Exercise*
4261 Write a description for this one.
4264 \begin_layout Remark
4265 This environment is also a type of theorem, usually a lesser sort of observation.
4268 \begin_layout Claim*
4269 Often used in the course of giving a proof of a larger result.
4273 Generally, these are used to break up long arguments, using specific instances
4279 The numbering scheme for cases is on its own, not together with other numbered
4285 At the end of this environment , a QED symbol (usually a square, but it
4286 can vary with different styles) is placed.
4287 If you want to have other environments within this one---for example, Case
4288 environments---and have the QED symbol appear only after them, then the
4289 other environments need to be nested within the proof environment.
4291 \begin_inset CommandInset ref
4293 reference "sec:Nesting"
4301 for information on nesting.
4304 \begin_layout Standard
4305 And these are provided by
4306 \begin_inset Flex CharStyle:Code
4309 \begin_layout Plain Layout
4310 Theorems (AMS-Extended)
4318 \begin_layout Criterion*
4319 A required condition.
4322 \begin_layout Algorithm*
4323 A general procedure to be used.
4326 \begin_layout Axiom*
4327 This is a property or statement taken as true within the system being discussed.
4330 \begin_layout Condition*
4331 Sometimes used to state a condition assumed within the present context of
4336 Similar to a Remark.
4339 \begin_layout Notation*
4340 Used for the explanation of, yes, notation.
4343 \begin_layout Summary
4344 Do we really need to tell you?
4347 \begin_layout Acknowledgement*
4351 \begin_layout Conclusion*
4352 Sometimes used at the end of a long train of argument.
4356 Used in a way similar to Proposition, though perhaps lower on the scale.
4359 \begin_layout Standard
4360 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4362 They need to be available on your system in order to use these environments.
4365 \begin_layout Section
4369 \begin_layout Standard
4374 can be used to type letters according to German conventions.
4375 A template file is included in
4377 .../lyx/share/templates
4379 for you to use as a starting point.
4382 \begin_layout Section
4386 \begin_layout Standard
4391 provides an alternative to the standard
4396 It provides similar functionality, but you might prefer this layout with
4397 sans serif sections, headings, and more.
4400 \begin_layout Section
4404 \begin_layout Standard
4410 \begin_layout Subsection
4414 \begin_layout Standard
4415 This section describes how LyX can be used to write articles for submission
4416 to the scientific journal
4418 Astronomy and Astrophysics
4420 (www.edpsciences.fr/aa/
4421 \begin_inset Flex URL
4424 \begin_layout Plain Layout
4426 http://www.edpsciences.fr/aa/
4431 ) using Version 5.01 of the document class
4436 This package can be downloaded from the ftp site
4439 \begin_layout Standard
4440 \begin_inset VSpace medskip
4446 \begin_layout Standard
4448 \begin_inset Flex URL
4451 \begin_layout Plain Layout
4453 ftp://ftp.edpsciences.org/pub/aa/readme.html
4461 \begin_layout Standard
4462 \begin_inset VSpace medskip
4468 \begin_layout Standard
4469 A manual comes together with that package, and this text is not meant to
4470 replace the original manual but merely a short guide how to realize the
4471 correct form of your paper.
4475 \begin_layout Standard
4476 Please note that the publisher of the journal was changed from Springer
4477 to EDP Sciences starting January 1, 2001.
4478 That change implicated also some slight changes of the style files, namely
4479 the removal of the thesaurus command.
4480 The LyX class aa supports the newest version of these style files, V 5.01.
4481 If you have an older version installed, please upgrade.
4482 For compatibility, the old (version 4) layout has been kept as
4487 Please refer to the comments in
4489 LyXDir/layouts/aapaper.layout
4494 \begin_layout Subsection
4498 \begin_layout Standard
4499 It is recommended you start from the example template distributed with LyX.
4500 If you are not using a template, note the following settings:
4503 \begin_layout Itemize
4513 ocument\SpecialChar \menuseparator
4520 dialog (OK, that one was obvious).
4523 \begin_layout Itemize
4524 Don't change the option
4527 \begin_inset space ~
4537 The whole layout is done by the macros, you shouldn't change anything.
4540 \begin_layout Subsection
4544 \begin_layout Standard
4545 First thing to enter is the header information.
4546 It consists of seven entries, of which some are optional.
4550 \begin_layout Itemize
4558 \begin_layout Itemize
4566 \begin_layout Itemize
4574 \begin_layout Itemize
4582 \begin_layout Itemize
4587 : [optional] if more than one author: whom to contact for offprint requests.
4590 \begin_layout Itemize
4595 : [optional] mail address for contacts.
4598 \begin_layout Itemize
4606 Received: <date>; Accepted <date>
4609 \begin_layout Standard
4610 There is no need to issue the
4616 command, this is done automatically by LyX when the header is finished.
4617 Although the order of the single header entries doesn't matter it is advised
4618 to keep the above sequence, just to get the best optics and meets the layout
4619 of the real document.
4622 \begin_layout Standard
4623 If you want to place footnotes in the header block, e.
4624 \begin_inset space \thinspace{}
4628 \begin_inset space ~
4631 to state your present address, just use the standard footnote via
4636 nsert\SpecialChar \menuseparator
4644 LyX will automagically use the term
4653 \begin_layout Standard
4654 In addition to these topics, the macros use three additional LaTeX commands
4655 that have no counterpart in LyX:
4658 \begin_layout Itemize
4665 to separate different names for more than one author and institute, respectivel
4669 \begin_layout Itemize
4676 to mark corresponding author/institute pairs.
4677 The institutes are numbered sequentially as they appear in the
4681 field, so you have to put a marker to each author.
4684 \begin_layout Itemize
4691 to supply an email address for fast contact.
4694 \begin_layout Standard
4695 In all cases, the appropriate command has to be entered in LyX and marked
4701 \begin_layout Subsection
4705 \begin_layout Standard
4706 The abstract should immediately follow the header block.
4707 With version 5 the abstract environment was changed to a command, and there
4708 is now a resctriction to only one paragraph.
4709 In addition, it should contain an entry with the keywords.
4710 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4717 by hand and mark it as LaTeX code.
4718 Refer to the example paper.
4721 \begin_layout Subsection
4722 Supported environments
4725 \begin_layout Standard
4726 The A&A paper layout supports the following environments for structuring
4730 \begin_layout Itemize
4736 \begin_layout Itemize
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 Subsection
4803 Commands not supported by LyX
4806 \begin_layout Standard
4807 Some commands are not yet supported by the
4812 Some have already been mentioned.
4813 For the sake of completeness, they are listed all together here:
4816 \begin_layout Itemize
4824 \begin_layout Itemize
4832 \begin_layout Itemize
4840 \begin_layout Itemize
4848 \begin_layout Itemize
4856 \begin_layout Itemize
4864 \begin_layout Itemize
4872 \begin_layout Itemize
4880 \begin_layout Standard
4881 If you want to use any of these commands, you have to enter them yourself.
4884 Do not forget to mark them as LaTeX code!
4887 \begin_layout Subsection
4888 Figure and Table Floats
4891 \begin_layout Standard
4892 LyX provides support for the necessary float environments
4894 figure, figure*, table
4900 , therefore we won't tell much about it here.
4904 \begin_inset space ~
4910 Just remember that tables should be left-aligned.
4911 For that, select the table and change the alignment in
4916 dit\SpecialChar \menuseparator
4922 \begin_inset space ~
4928 \begin_layout Standard
4929 There is only one special thing: the figures with caption besides the figure.
4930 To create such a figure, you have to do the following:
4933 \begin_layout Enumerate
4934 Create a wide figure float:
4939 nsert\SpecialChar \menuseparator
4944 t\SpecialChar \menuseparator
4947 , then right click in the figure and select
4953 \begin_inset space ~
4961 \begin_layout Enumerate
4962 Enter your caption text.
4965 \begin_layout Enumerate
4970 to move the cursor above the caption.
4973 \begin_layout Enumerate
4977 \begin_layout Enumerate
4978 Position the cursor behind the figure and insert a horizontal fill:
4983 nsert\SpecialChar \menuseparator
4989 \begin_inset space ~
4994 \SpecialChar \menuseparator
4998 \begin_inset space ~
5006 \begin_layout Enumerate
5007 Switch to LaTeX mode:
5010 \begin_inset space ~
5018 \begin_layout Enumerate
5028 Do not close the brace!
5031 \begin_layout Enumerate
5032 Position the cursor behind the caption text, switch to LaTeX mode and insert
5036 \begin_inset space ~
5048 \begin_layout Standard
5049 Also, refer to the figures in the example paper.
5052 \begin_layout Subsection
5056 \begin_layout Standard
5057 For submission, the paper has to be formated in a special double-spacing
5059 For this purpose, you have to give the option
5063 to the documentclass.
5064 This must be done using the extra class options field in the
5069 ocument\SpecialChar \menuseparator
5077 Just enter the string
5084 \begin_layout Subsection
5088 \begin_layout Standard
5093 directory contains an example paper written with LyX.
5094 It is the example paper from the original macro package, translated to
5096 Use it for inspiration, and compare the original LaTeX code with LyX way
5100 \begin_layout Section
5104 \begin_layout Standard
5110 \begin_layout Subsection
5114 \begin_layout Standard
5115 AASTeX is a set of macros produced by the American Astronomical Society
5116 to facilitate electronic manuscript submission to the three journals they
5117 publish: the Astrophysical Journal (including the Letters and Supplement),
5118 the Astronomical Journal, and the Publications of the Astronomical Society
5120 LyX has proven to be an excellent tool for generating these documents,
5121 especially given its equation, citation, and figure handling capabilities.
5122 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5123 is the version described here, or higher.
5124 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5125 incompatible with LyX.
5126 The AASTeX package may be downloaded from the AASTeX Web site
5129 \begin_layout Standard
5130 \begin_inset VSpace medskip
5136 \begin_layout Standard
5138 \begin_inset Flex URL
5141 \begin_layout Plain Layout
5143 http://www.journals.uchicago.edu/AAS/AASTeX
5151 \begin_layout Standard
5152 \begin_inset VSpace medskip
5158 \begin_layout Standard
5159 A complete user guide is contained in that package and you should familiarize
5160 yourself with it thoroughly before embarking on writing a paper in LyX.
5161 LyX will not reduce the need to figure out all the AASTeX commands, it
5162 will only reduce the drudgery of typing everything in.
5163 It is your responsibility to ensure that the final exported LaTeX document
5164 conforms completely to the requirements of the journal to which you are
5165 submitting your paper.
5168 \begin_layout Subsection
5169 Starting a New Paper
5172 \begin_layout Standard
5173 I strongly suggest that you start with the AASTeX template file.
5179 ile\SpecialChar \menuseparator
5189 , enter the new file name, then choose the
5194 This will show the most common fields found in a manuscript.
5195 Simply overwrite the existing text (including the brackets,
5199 ) with the correct information.
5200 Many of the AASTeX commands and environments can be implemented directly
5201 in LyX, but some cannot: most noticeably
5213 , which should stick out like a sore thumb if you actually just opened the
5215 For commands such as these, the LaTeX code must be entered directly and
5217 Such commands are referred to as ERT, or Evil Red Text.
5218 I tried to minimize the amount of ERT needed in an AASTeX document, but
5219 there is still a bit more required than any of us would like.
5222 \begin_layout Subsection
5223 Finishing Your Paper
5226 \begin_layout Standard
5227 When the paper is finished to your satisfaction and previews/prints correctly,
5229 \begin_inset Quotes eld
5233 \begin_inset Quotes erd
5236 actions which need to be done before you submit it to the journals.
5240 \begin_layout Enumerate
5241 Export your paper as a LaTeX file (
5246 ile\SpecialChar \menuseparator
5251 xport\SpecialChar \menuseparator
5262 \begin_layout Enumerate
5267 file with your favorite text editor
5271 \begin_layout Enumerate
5272 remove the comment lines before the
5281 \begin_layout Enumerate
5286 usepackage...{fontenc}
5288 line if it appears (usually just after
5303 \begin_layout Enumerate
5304 remove everything between (and including) the
5316 commands, except for any commands you specifically put into the LaTeX preamble
5317 (which should appear immediately after the
5318 \begin_inset Quotes eld
5321 User specified LaTeX commands
5322 \begin_inset Quotes erd
5333 \begin_layout Enumerate
5334 Run the resulting file through LaTeX to make sure it still processes correctly.
5337 \begin_layout Enumerate
5338 Reread the journal requirements to make sure your filenames and formats
5342 \begin_layout Enumerate
5346 \begin_layout Subsection
5347 Comments On Specific Commands
5350 \begin_layout Standard
5351 I will not describe the detailed usage of the individual AASTeX commands:
5352 the AASTeX User Guide (
5356 ) gives a good description of each.
5357 Thus it's probably easiest for me to go down the list as found in the guide
5358 and offer comments where necessary.
5359 So let's begin \SpecialChar \ldots{}
5363 \begin_layout Subsubsection
5364 Things that work as expected
5367 \begin_layout Standard
5371 \begin_layout Plain Layout
5383 \begin_layout Standard
5384 Because they work as you might expect, I simply list them and the section
5485 begin{thebibliography}
5493 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5494 graphicx figure commands (2.14.1),
5518 (2.15.4, amongst other places),
5545 \begin_layout Standard
5546 The following style options also work correctly:
5567 Simply put them in the
5573 Layout\SpecialChar \menuseparator
5579 \begin_layout Standard
5583 \begin_layout Plain Layout
5595 \begin_layout Subsubsection
5596 Things that work, but require more comment
5599 \begin_layout Standard
5600 The following items work, but require a little more discussion:
5603 \begin_layout Itemize
5604 These items are reserved for use by the journal editors, but you can put
5605 them into the LaTeX preamble if you feel compelled to do so:
5638 \begin_layout Itemize
5639 These items may be placed in the LaTeX preamble, and are included as blanks
5640 in the template file:
5661 \begin_layout Itemize
5668 (2.3) -- can only be used
5669 \begin_inset Quotes eld
5673 \begin_inset Quotes erd
5676 , not in the middle of a paragraph.
5677 Use ERT if you need to embed it.
5680 \begin_layout Itemize
5687 (2.3) -- will have extra {} after it.
5688 This should not cause an error.
5691 \begin_layout Itemize
5698 (2.6) -- can only be used
5699 \begin_inset Quotes eld
5703 \begin_inset Quotes erd
5706 , not in the middle of a paragraph.
5707 Use ERT if you need to embed it.
5710 \begin_layout Itemize
5717 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5721 \begin_layout Itemize
5728 (2.8) -- same as for
5735 \begin_layout Itemize
5742 (2.9) -- will have extra {} after it.
5743 This should not cause an error.
5746 \begin_layout Itemize
5753 (2.11) -- will have extra {} after it.
5754 This should not cause an error.
5757 \begin_layout Itemize
5764 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5765 at the beginning of the text and selecting
5767 Insert\SpecialChar \menuseparator
5772 \begin_inset Quotes eld
5776 \begin_inset Quotes erd
5779 inserts an optional argument of the type needed by
5786 Hopefully it will be renamed someday.
5789 \begin_layout Itemize
5802 for the catalog ID optional parameter
5805 \begin_layout Itemize
5818 for the catalog ID optional parameter
5821 \begin_layout Subsubsection
5822 Things not implemented, use ERT
5825 \begin_layout Standard
5829 \begin_layout Plain Layout
5841 \begin_layout Standard
5864 setcounter{equation}
5866 (2.12), Journal name abbreviations (2.13.4),
5902 (2.15.4, insert it as the first element in the lefthand cell after where
5904 Don't use any of LyX's rules in the table),
5916 (2.15.5), much of Misc (2.17, except
5967 \begin_layout Standard
5971 \begin_layout Plain Layout
5983 \begin_layout Subsubsection
5984 Things that cannot be implemented
5987 \begin_layout Standard
5988 \SpecialChar \ldots{}
5989 at least in any meaningful sort of way, so I suggest ignoring them.
5990 They are the references environment (2.13.3), and the deluxetable environment
5992 If you really, really need to use deluxetable, I suggest editing it in
5993 a separate file with a text editor, then using
5998 nsert\SpecialChar \menuseparator
6004 \begin_inset space ~
6009 to include it in your LyX document.
6014 file to see an example of this.
6017 \begin_layout Subsection
6018 FAQs, Tips, Tricks, and Other Ruminations
6021 \begin_layout Subsubsection
6022 Getting LyX and AASTeX to cooperate
6025 \begin_layout Standard
6026 It can be a bit tricky to get LyX to recognize a new layout and document
6028 When all else fails, do this:
6031 \begin_layout Enumerate
6032 Make certain that LaTeX can find AASTeX.
6033 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6034 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6041 \begin_layout Enumerate
6053 \begin_layout Enumerate
6059 ools\SpecialChar \menuseparator
6066 in LyX, then restart LyX.
6069 \begin_layout Enumerate
6070 Open a regular new file, not from a template.
6071 Does AASTeX appear in the class list in
6076 ocument\SpecialChar \menuseparator
6086 \begin_layout Standard
6087 If you get a warning from an existing AASTeX document about not being able
6088 to find the AASTeX layout or a message about
6089 \begin_inset Quotes eld
6092 You should not mix title layouts with normal ones
6093 \begin_inset Quotes erd
6096 , things haven't been installed correctly.
6099 \begin_layout Subsubsection
6100 LaTeX error processing a table
6103 \begin_layout Standard
6104 LyX, by default, attempts to center the table caption/title.
6105 This seems to produce a bad interaction in AASTeX so you should click somewhere
6106 in the caption/title, then select
6111 dit\SpecialChar \menuseparator
6117 \begin_inset space ~
6134 This took care of it for me.
6137 \begin_layout Subsubsection
6139 \begin_inset CommandInset label
6148 \begin_layout Standard
6149 A couple of things: 1) I have noticed some funny spacing in the reference
6150 entries in the text.
6151 When you enter the bibliography item data, make sure their is
6155 space between the last author and the parenthesis setting off the year;
6159 \begin_inset space \thinspace{}
6163 \begin_inset space ~
6177 2) Entering the references at all is not obvious.
6178 The easiest thing is to start typing your first reference at the end of
6179 the document, then mark it as type
6184 That will put a small gray box in front of what you just typed.
6185 Click on the box to fill in the rest of the information.
6186 For new references, go to the end of an existing reference and press return.
6187 That will create a new line with its own box, etc.
6190 \begin_layout Subsubsection
6194 \begin_layout Standard
6195 Even though AASTeX provides its own figure commands (
6201 , for example), I much prefer LaTeX's standard figure commands (with the
6210 \begin_inset space ~
6213 commands as ERT into a Figure Float box if you desire, but I never have
6214 much luck getting the layout right.
6215 With the standard graphics, LyX will insert a
6219 usepackage{graphicx}
6221 command into the LaTeX preamble and handle the figures in the standard
6222 LaTeX2e way, interspersing the figures in the text.
6223 I believe ApJ accepts figures exactly this way now; AJ might still use
6225 \begin_inset Quotes eld
6228 stack everything at the end
6229 \begin_inset Quotes erd
6235 \begin_layout Subsubsection
6236 Things I could have done, but didn't
6239 \begin_layout Standard
6241 \begin_inset Quotes eld
6245 \begin_inset Quotes erd
6248 things I could have implemented, but chose not to.
6249 For instance, I saw no point in double-spacing the text in the LyX window,
6250 even though it is double-spaced in the paper manuscript.
6251 Also, I chose not to make separate layouts for the preprint and preprint2
6253 Since I assume you will spend most of your time in the plain manuscript
6254 mode anyway, I decided not to chew up more disk space with this.
6258 \begin_layout Subsection
6262 \begin_layout Standard
6263 Your mileage may vary.
6264 I've now had papers published by both ApJ and AJ that have had 98% of the
6265 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6267 I have had no trouble with the submission process, and I'm sure the journals
6268 were never aware that there might be a difference.
6269 So, go forth and publish!
6272 \begin_layout Section
6276 \begin_layout Standard
6279 Panayotis Papasotiriou
6282 \begin_layout Subsection
6286 \begin_layout Standard
6287 The ijmpc package is a set of macros that facilitates electronic manuscript
6290 International Journal of Modern Physics C
6293 Similarly, the ijmpd package is for creating manuscripts to be submitted
6296 International Journal of Modern Physics D
6299 Both journals are published by World Scientific.
6300 The corresponding document classes are named
6309 These files, together with instructions for the authors, can be downloaded
6311 \begin_inset Flex URL
6314 \begin_layout Plain Layout
6316 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6322 \begin_inset Flex URL
6325 \begin_layout Plain Layout
6327 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6333 Both packages are modified versions of the standard
6334 \begin_inset Quotes eld
6338 \begin_inset Quotes erd
6341 package, and they are almost (but not exactly) identical.
6342 Most of their features are supported by LyX.
6343 I have used LyX successfully to write articles submitted to both journals
6344 without any problem.
6347 \begin_layout Subsection
6351 \begin_layout Standard
6352 As usual, the easiest way to write a paper is to start with a template.
6358 ile\SpecialChar \menuseparator
6377 This will give an (almost) empty document that includes the most common
6378 fields found in a manuscript.
6379 Simply overwrite the existing text (including the brackets,
6384 You should keep in mind the following remarks.
6387 \begin_layout Enumerate
6388 LyX won't let you change the font size and the page style of the document,
6389 because such modifications are not allowed by both packages.
6392 \begin_layout Enumerate
6393 The language of the document should not be changed.
6394 Before previewing your paper, be sure that the babel package is not used.
6395 To do this, click on
6400 ools\SpecialChar \menuseparator
6418 checkbox in the language settings, and click on
6429 , if you wish to make this change permanent).
6432 \begin_layout Enumerate
6434 \begin_inset Quotes eld
6438 \begin_inset Quotes erd
6441 style must be used to define keywords.
6444 \begin_layout Enumerate
6445 The ijmpc package provides a style named
6446 \begin_inset Quotes eld
6449 Classification Codes
6450 \begin_inset Quotes erd
6453 , which can be used to define classification codes, such as PACS numbers.
6454 Note that this facility is not supported by the ijmpd package.
6457 \begin_layout Enumerate
6458 Several new environments are available:
6459 \begin_inset Quotes eld
6463 \begin_inset Quotes erd
6467 \begin_inset Quotes eld
6471 \begin_inset Quotes erd
6475 \begin_inset Quotes eld
6479 \begin_inset Quotes erd
6483 \begin_inset Quotes eld
6487 \begin_inset Quotes erd
6491 \begin_inset Quotes eld
6495 \begin_inset Quotes erd
6499 \begin_inset Quotes eld
6503 \begin_inset Quotes erd
6507 \begin_inset Quotes eld
6511 \begin_inset Quotes erd
6515 \begin_inset Quotes eld
6519 \begin_inset Quotes erd
6523 \begin_inset Quotes eld
6527 \begin_inset Quotes erd
6531 \begin_inset Quotes eld
6535 \begin_inset Quotes erd
6539 \begin_inset Quotes eld
6543 \begin_inset Quotes erd
6547 \begin_inset Quotes eld
6551 \begin_inset Quotes erd
6555 \begin_inset Quotes eld
6559 \begin_inset Quotes erd
6563 \begin_inset Quotes eld
6567 \begin_inset Quotes erd
6571 Their use is more or less obvious.
6572 LyX supports all these environments; it will use the proper label, text
6573 style, and numbering scheme for each of them.
6576 \begin_layout Enumerate
6577 Both packages use basic citations; the natbib package should not be used.
6578 In LyX, citation references are shown as usual; in the output, citations
6579 are shown as superscripts.
6580 If you want to use a citation as normal text, you should use the
6585 \begin_inset space \thinspace{}
6589 \begin_inset Quotes eld
6593 \begin_inset space ~
6603 \begin_inset Quotes erd
6609 \begin_layout Enumerate
6611 \begin_inset Quotes eld
6615 \begin_inset Quotes erd
6618 section in both packages.
6619 To put acknowledgments, just use the
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6630 \begin_layout Enumerate
6631 Appendices may be added to the paper,
6635 the Acknowledgments and
6640 LyX provides a special environment, called
6641 \begin_inset Quotes eld
6645 \begin_inset Quotes erd
6648 which marks the beginning of the appendices.
6649 This environment should be left blank; it just sends a LaTeX command, but
6650 nothing is really printed.
6652 \begin_inset Quotes eld
6656 \begin_inset Quotes erd
6659 is printed with blue letters, as a signal that all sections after that
6660 point are appendices.
6661 To write an appendix, use the
6662 \begin_inset Quotes eld
6666 \begin_inset Quotes erd
6670 LyX will number each appendix with capital letters, as required by both
6673 \begin_inset Quotes eld
6677 \begin_inset Quotes erd
6684 be present before the first appendix; if not, all appendices will be numbered
6685 as normal sections in the output.
6688 \begin_layout Enumerate
6689 The ijmpc and the ijmpd packages use the
6693 command to implement table captions.
6694 As a result, a table created by LyX is printed correctly, but its caption
6696 However, you can use some ERT to overpass this problem, so that captions
6697 are printed as expected.
6698 To do so, create a float table as usual, remove the caption, and replace
6709 (sic); you must also the ERT
6713 immediately after the tabular material.
6714 Study the example table included in the template files to see how this
6715 trick is implemented.
6716 Alternatively, If you need table captions, you should implement the whole
6721 file, then include this file to the LyX document (
6726 nsert\SpecialChar \menuseparator
6731 \SpecialChar \menuseparator
6737 \begin_inset space ~
6743 Details on how to create a table float can be found in the files
6751 , included in the corresponding packages.
6754 \begin_layout Subsection
6755 Preparing a paper for submission
6758 \begin_layout Standard
6759 Before you submit your paper you must export the LyX document as a LaTeX
6765 ile\SpecialChar \menuseparator
6770 xport\SpecialChar \menuseparator
6785 \begin_layout Plain Layout
6786 Actually you have the choice between LaTeX (plain) and pdflatex.
6787 If you intend to use pdflatex to prepare the paper, you should use the
6788 pdflatex option so that included graphics are converted to PDF format,
6789 ready for use by pdflatex.
6794 , then make the following changes to the resulting
6801 \begin_layout Enumerate
6802 Remove the comment lines before the
6811 \begin_layout Enumerate
6812 Remove everything between (and including) the
6824 commands, except for any commands you specifically put into the LaTeX preamble.
6827 \begin_layout Standard
6832 file should be saved and processed through LaTeX as many times as necessary.
6833 You may also want to check the resulting
6840 \begin_layout Subsection
6844 \begin_layout Standard
6845 The use of ERT is reduced to two commands, which must be placed at the top
6847 If you started writing your paper by using the
6855 template, the ERT needed is already in its place; you usually don't need
6857 You may only modify the first ERT to specify the information printed to
6858 the top of odd and even pages (authors' names and short paper's title,
6860 This ERT must have the form
6864 markboth{Authors' Names}{Short Paper's Title}
6869 \begin_layout Section
6873 \begin_layout Standard
6879 \begin_layout Subsection
6883 \begin_layout Standard
6884 The iopart package provides a document class to create electronic manuscript
6885 submission to the journals published by the Institute of Physics.
6886 Instructions for the authors how to create a paper using the iopart class
6887 can be downloaded together with the iopart package from the site
6888 \begin_inset Flex URL
6891 \begin_layout Plain Layout
6893 ftp://ftp.iop.org/pub/journals/latex2e
6901 \begin_layout Subsection
6905 \begin_layout Standard
6906 The easiest way to write a paper is to start with the file
6910 that is available in LyX's examples files folder.
6911 Open this file, save it under a new name, and start writing.
6912 The example file explains how to use the special text environments.
6913 Here are the most important advices:
6916 \begin_layout Itemize
6917 To be able to compile your document to a PDF, PS, or DVI, assure that the
6920 Use AMS math package
6922 in the document settings under
6929 \begin_layout Itemize
6932 The title environment defines the kind of your paper.
6933 So use one of the following environments for the title:
6937 \begin_layout Itemize
6946 \begin_layout Itemize
6955 \begin_layout Itemize
6961 for a Topical review
6964 \begin_layout Itemize
6973 \begin_layout Itemize
6982 \begin_layout Itemize
6988 for a Paper (same as Title)
6991 \begin_layout Itemize
6997 for a Preliminary communication
7000 \begin_layout Itemize
7006 for a Rapid communication
7009 \begin_layout Itemize
7015 for a Letter to the editor
7019 \begin_layout Itemize
7022 All title environments except of
7026 can have an optional short title.
7029 \begin_layout Itemize
7030 There is a general title environment
7034 which is not directly supported by the LyX.
7035 This can be used as ERT when your document doesn't fit into one of the
7039 \begin_layout Standard
7040 For more informations like hints for special table and formula formatting,
7041 look at the IOP author guidelines.
7044 \begin_layout Section
7048 \begin_layout Standard
7051 Panayotis Papasotiriou
7054 \begin_layout Subsection
7058 \begin_layout Standard
7059 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7060 that facilitates electronic manuscript submission to the journals they
7062 Most known of them (at least in my domain of interest) are
7064 Astrophysics and Space Science
7070 , but there are many others (see a complete list at
7071 \begin_inset Flex URL
7074 \begin_layout Plain Layout
7076 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7082 The Kluwer package may be downloaded from the site
7083 \begin_inset Flex URL
7086 \begin_layout Plain Layout
7088 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7094 A complete user guide is contained in that package (but it can also be
7095 downloaded separately).
7098 \begin_layout Standard
7099 LyX supports many features of the package but not everything.
7100 However, the ERT needed is reduced to some
7101 \begin_inset Quotes eld
7105 \begin_inset Quotes erd
7108 commands of the package (see
7109 \begin_inset space ~
7113 \begin_inset CommandInset ref
7115 reference "subsec:kluwer_peculiarities"
7120 I have recently used LyX to write an article submitted to the
7122 Astrophysics and Space Science
7124 without any problem.
7127 \begin_layout Subsection
7131 \begin_layout Standard
7132 The easiest way to write a paper is to start with the Kluwer template file.
7135 File\SpecialChar \menuseparator
7150 This will give an (almost) empty document that includes the most common
7151 fields found in a manuscript and a short description of their use.
7152 As in most templates, simply overwrite the existing text (including the
7157 ) with the correct information.
7160 \begin_layout Subsection
7161 Preparing a paper for submission
7164 \begin_layout Standard
7165 As in the AASTeX package, before you submit your paper to a journal you
7167 \begin_inset Quotes eld
7171 \begin_inset Quotes erd
7177 \begin_layout Enumerate
7178 Export your paper as a LaTeX file.
7179 To do this, click on
7184 ile\SpecialChar \menuseparator
7189 xport\SpecialChar \menuseparator
7200 \begin_layout Enumerate
7205 file with a text editor and make the following changes
7209 \begin_layout Enumerate
7210 remove the comment lines before the
7219 \begin_layout Enumerate
7220 remove everything between (and including) the
7232 commands, except for any commands you specifically put into the LaTeX preamble.
7235 \begin_layout Standard
7244 \begin_layout Enumerate
7249 file through LaTeX as many times as necessary (usually up to three).
7252 \begin_layout Enumerate
7258 \begin_inset space \thinspace{}
7265 , and check if everything is OK (it should, if you didn't make any mistake).
7268 \begin_layout Subsection
7269 \begin_inset Quotes eld
7273 \begin_inset Quotes erd
7276 of the Kluwer package
7277 \begin_inset CommandInset label
7279 name "subsec:kluwer_peculiarities"
7286 \begin_layout Standard
7287 The Kluwer package has the following
7288 \begin_inset Quotes eld
7292 \begin_inset Quotes erd
7298 \begin_layout Enumerate
7299 It is possible to write multiple articles in the same LaTeX file
7303 \begin_layout Plain Layout
7304 I can't imagine any good reason to do this.
7310 Each article must be included in the environment
7311 \begin_inset Quotes eld
7315 \begin_inset Quotes erd
7319 Unfortunately, this environment cannot be omitted, even if you write just
7321 Therefore, each article starts with the command
7327 and, obviously, ends with the command
7334 Although this can be implemented in LyX, I didn't included it, since it
7335 looks ugly and can confuse the novice user.
7336 Therefore, you need to enter them directly and mark them as LaTeX code
7338 \begin_inset Quotes eld
7342 \begin_inset Quotes erd
7348 \begin_layout Enumerate
7349 Information given at the beginning of the article (i.e., title, subtitle,
7350 author, institution, running title, running author, abstract and keywords)
7351 must be included in an environment called
7352 \begin_inset Quotes eld
7356 \begin_inset Quotes erd
7360 This is not implemented in LyX, so you must enter title, subtitle etc.
7361 \begin_inset space ~
7364 between two ERT lines (
7379 \begin_layout Enumerate
7380 According to the user manual, the label of each bibliography item must be
7404 \begin_layout Standard
7409 template takes care of all these
7410 \begin_inset Quotes eld
7414 \begin_inset Quotes erd
7418 If you start a new paper using this template you don't need to do anything
7423 \begin_layout Enumerate
7424 don't delete the ERT included in the template, and
7427 \begin_layout Enumerate
7428 copy the example bibliography item included in the template and modify it
7429 as necessary to enter new bibliography items.
7432 \begin_layout Section
7436 \begin_layout Standard
7442 \begin_layout Subsection
7446 \begin_layout Standard
7447 The LyX document classes
7449 article (koma-script)
7453 report (koma-script)
7471 correspond to the LaTeX document classes
7488 \begin_inset space ~
7491 of the Koma-Script family.
7492 They are replacements for the standard document classes
7508 , resp., and fit better to European typography conventions in a number of
7512 \begin_layout Itemize
7513 Standard character size is 11pt in
7515 article (koma-script)
7519 report (koma-script)
7527 letter (koma-script)
7532 \begin_layout Itemize
7533 Headings, labels of the description environment, and a number of elements
7536 letter (koma-script)
7538 document class are set in a bold sans serif font.
7542 \begin_layout Plain Layout
7543 There is a big difference between the bold sans serif old cm fonts and new
7544 ec fonts, especially in the appearance of headings.
7545 In comparison, the ec bold sans serif fonts look a bit thin.
7546 Here the LaTeX package
7554 helps to produce the
7555 \begin_inset Quotes eld
7559 \begin_inset Quotes erd
7562 appearance when using the ec fonts.
7567 The numbering of chapter headings is made in the same way as the numbering
7568 of section headings, that is without the extra line
7569 \begin_inset Quotes eld
7572 Chapter\SpecialChar \ldots{}
7574 \begin_inset Quotes erd
7578 In addition, the appearance of the headings can be modified by using a
7579 number of options (in LyX to be entered in the field
7586 \begin_inset space ~
7596 ayout\SpecialChar \menuseparator
7604 A detailed German description of these options can be found in the Koma-Script
7612 \begin_layout Itemize
7613 The main means in the Koma-Script document classes to design the type area
7622 (in LyX to be entered in the extra class options field in the dialog
7627 ocument\SpecialChar \menuseparator
7635 They make a clearer modification of page margins possible as do the options
7641 ocument\SpecialChar \menuseparator
7649 A detailed German description of these and other type area options can
7650 be found in the Koma-Script documentation
7657 \begin_layout Itemize
7658 The LaTeX document classes of the Koma-Script family define a number of
7659 additional commands.
7660 Those part of it which makes sense in LyX is implemented in corresponding
7664 \begin_layout Standard
7665 A detailed German description of the LaTeX document classes of the Koma-Script
7666 family can be found in the Koma-Script documentation
7674 \begin_layout Plain Layout
7675 There is an English translation
7679 , but it is not a complete one.
7684 The following sections describe only those aspects, which are relevant
7688 \begin_layout Subsection
7689 article (koma-script), report (koma-script), and book (koma-script)
7692 \begin_layout Standard
7693 The document classes
7695 article (koma-script)
7699 report (koma-script)
7709 are implemented in the layout files
7722 They contain all the paragraph types of the corresponding standard document
7735 , resp., partly modified, with the exception of the LyX specific
7739 -type, which is replaced by the new
7743 -type having the same functionality.
7748 -Type there is a number of new paragraph types added.
7755 letter (koma-script)
7760 \begin_layout Itemize
7769 : are equivalents to
7777 , resp., additionally inserting an entry in the table of contents.
7786 are not contained in
7788 article (koma-script)
7793 \begin_layout Itemize
7810 , resp., additionally clearing running heads.
7817 article (koma-script)
7823 \begin_layout Plain Layout
7836 report (koma-script)
7838 , but since this is identical to
7842 , is has not been implemented in LyX.
7850 \begin_layout Itemize
7855 : generates a heading directly above the following paragraph in the standard
7856 character size without affecting the structure of the document.
7859 \begin_layout Itemize
7868 are special captions which respect the different space settings needed
7869 for captions placed above or below an element (if you follow strict typographic
7870 rules, you might want to place table captions always above the table).
7871 You can also use the class option
7888 You need at least Koma-Script version 2.8q to use this.
7891 \begin_layout Itemize
7896 : can be used to set a bonmot, e.
7897 \begin_inset space \thinspace{}
7901 \begin_inset space ~
7904 at the beginning of a chapter.
7905 If you use the optional argument (
7910 nsert\SpecialChar \menuseparator
7912 \begin_inset space ~
7917 ), you can insert the dictum's author there.
7918 Dictum and author are separated by a line.
7919 You need at least Koma-Script version 2.8q to use this.
7926 article (koma-script)
7931 \begin_layout Standard
7932 The following types, together with the standard types
7944 , form the title area of the document.
7945 They must be entered ahead of the first
7946 \begin_inset Quotes eld
7950 \begin_inset Quotes erd
7957 \begin_layout Plain Layout
7958 The corresponding LaTeX commands must appear before the
7969 When such a type is used more than once, the latter usage overwrites the
7970 former one, that means, for every type only the latest usage is valid.
7971 The order of the different types however has, like
7983 , no effect on the appearance of the produced document.
7986 \begin_layout Itemize
7991 : produces a centered paragraph above the ordinary title (
8003 ) for the subject of the document.
8006 \begin_layout Itemize
8011 : produces a centered paragraph below the ordinary title (
8023 ) for the publishers' name.
8026 \begin_layout Itemize
8033 report (koma-script)
8039 produces a centered paragraph on its own page behind the title page, or
8042 article (koma-script)
8044 produces a centered paragraph below the ordinary title (
8063 \begin_layout Itemize
8068 : produces a left aligned paragraph above the ordinary title (
8084 ) for a document`s head.
8087 \begin_layout Itemize
8092 : produces in a double-sided print in
8094 report (koma-script)
8100 a left-aligned paragraph at the top of the title page`s back or has no
8101 effect in a single-sided print or in
8103 article (koma-script)
8108 \begin_layout Itemize
8113 : produces in a double-sided print in
8115 report (koma-script)
8121 a left-aligned paragraph at the bottom of the title page`s back or has
8122 no effect in a single-sided print or in
8124 article (koma-script)
8129 \begin_layout Itemize
8134 : produces a special
8135 \begin_inset Quotes eld
8139 \begin_inset Quotes erd
8142 page ahead of the actual document containing a paragraph without special
8146 \begin_layout Standard
8147 The layout files for the document classes
8149 article (koma-script)
8153 report (koma-script)
8164 This is thought of as a place to define your own types.
8169 in your personal layout directory and edit the file!
8172 \begin_layout Subsection
8173 letter (koma-script)
8176 \begin_layout Standard
8180 \begin_layout Plain Layout
8192 \begin_layout Standard
8196 letter (koma-script)
8198 is implemented in the layout file
8203 It contains all the paragraph types of the corresponding standard document
8208 , partly modified, with the exception of the LyX specific types
8220 type, which is replaced by the new
8225 In addition, it contains, in contrast to the standard document class, the
8243 Furthermore, there are a number of new letter specific types.
8246 \begin_layout Standard
8250 \begin_layout Plain Layout
8262 \begin_layout Standard
8263 The appearance of the letter produced by this document class can be controlled
8264 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8268 \begin_layout Plain Layout
8269 For example, the standard appearance of the letter`s heading, consisting
8270 of name and address, is quite self-willed.
8272 \begin_inset Quotes eld
8276 \begin_inset Quotes erd
8279 heading is produced by the following LaTeX commands in the preamble:
8282 \begin_layout LyX-Code
8292 \begin_layout LyX-Code
8308 \begin_layout LyX-Code
8318 \begin_layout LyX-Code
8338 A detailed German description of such LaTeX commands can be found in the
8339 Koma-Script documentation
8344 With it, the letter's author can produce his personal letter layout.
8347 \begin_layout Standard
8356 define the beginning of the letter and must be used in every letter.
8357 To emphasize them in the LyX document class, they are marked with the letter
8367 \begin_inset space ~
8371 It is possible to write any number of letters in one file.
8376 type produces a new letter using the same addressee and a
8380 type produces a new addressee.
8397 are ordinary paragraph types and can also be used several times in one
8398 and the same letter.
8401 \begin_layout Itemize
8406 : produces a paragraph for the addressee and implicitly defines the beginning
8410 \begin_layout Itemize
8415 : produces a paragraph for the form of address and implicitly produces a
8419 \begin_layout Itemize
8424 : produces a paragraph for a close.
8427 \begin_layout Itemize
8432 : produces a paragraph for a postscript.
8435 \begin_layout Itemize
8440 : produces a paragraph for a distribution list.
8443 \begin_layout Itemize
8448 : produces a paragraph for enclosures.
8451 \begin_layout Standard
8492 are input types provided with a label to enter information, which will
8493 be processed by the document class.
8497 \begin_layout Plain Layout
8498 It could be seen as a matter of inconsequence, that the types
8506 described above are not such input types as well.
8507 Because of the special meaning of those types, however, I have implemented
8508 them as ordinary paragraph types with a one letter mark in the left margin.
8509 Moreover, it would affect my feeling of symmetry, if the
8517 type had such a serious different appearance.
8522 The types must be used ahead of the corresponding
8529 \begin_layout Standard
8530 An implementation of these types in a WYSIWYG fashion does not seem to make
8531 sense, because the real appearance of the produced letter does not only
8532 depend on the usage of the particular type, but also on other factors.
8533 For example, a signature entered in the
8537 type will in the standard behavior appear in the produced letter only,
8538 when in the same letter also a
8543 The entered value of the
8547 type will in the standard behavior not appear in the produced letter at
8549 The possibility to design the letter`s heading freely is already indicated
8550 in a footnote above.
8553 \begin_layout Standard
8554 The input types can also be used as empty paragraphs.
8556 \begin_inset space \thinspace{}
8560 \begin_inset space ~
8572 type is not used at all, in the standard behavior the value of the
8576 type is used as signature, whereas if an empty
8580 type is used, no signature value is defined.
8583 \begin_layout Standard
8584 By using the input types it is possible to write a letter template, containing
8585 filled input types with your personal dates (name, address, etc.) and empty
8586 input types for other dates you want to enter.
8589 \begin_layout Itemize
8594 : sender's name, in the standard behavior appears as a centered paragraph
8595 in small caps in the letter`s heading.
8598 \begin_layout Itemize
8603 : sender's signature, in the standard behavior appears below the
8612 type is used, the value of the
8616 type appears instead.
8619 \begin_layout Itemize
8624 : sender's address, in the standard behavior appears in a centered paragraph
8625 in the letter`s heading below the sender's name.
8628 \begin_layout Itemize
8633 : sender's telephone number, in the standard behavior only sets the LaTeX
8643 \begin_layout Itemize
8648 : place of the letter`s making.
8651 \begin_layout Itemize
8656 : date of the letter`s making.
8665 , in the standard behavior, produce the place and the date in a right-aligned
8666 line below the addressee's field.
8671 type is used, neither place nor date appear, independent of the value of
8681 type is used, the date of the letter `s production is used.
8684 \begin_layout Itemize
8689 : sender`s back address, in the standard behavior appears above the addressee's
8690 field in a small sans serif font.
8693 \begin_layout Itemize
8698 : special mail information, in the standard behavior appears underlined
8699 above the addressee's field below the back address.
8702 \begin_layout Itemize
8707 : additional information, in the standard behavior appears on right side
8708 below the addressee`s field.
8711 \begin_layout Itemize
8716 : the letter's title, in the standard behavior appears in a big, bold, sans
8717 serif font above the subject.
8720 \begin_layout Itemize
8725 : the letter's subject, in the standard behavior appears in a bold font
8733 \begin_layout Standard
8754 produce a business letter like line above the
8758 line containing the fields
8759 \begin_inset Quotes eld
8763 \begin_inset Quotes erd
8767 \begin_inset Quotes eld
8771 \begin_inset Quotes erd
8775 \begin_inset Quotes eld
8779 \begin_inset Quotes erd
8783 \begin_inset Quotes eld
8787 \begin_inset Quotes erd
8791 \begin_inset Quotes eld
8795 \begin_inset Quotes erd
8799 \begin_inset Quotes eld
8803 \begin_inset Quotes erd
8807 For the date field, the value of the
8813 \begin_inset Quotes eld
8816 business letter types
8817 \begin_inset Quotes erd
8820 is used, the value of the
8824 type however does not appear, but only the LaTeX variable
8831 The ordinary output of place and date in a right-aligned line below the
8832 addressee`s field is suppressed.
8833 The types are implemented as input types provided with a label and must
8834 be used ahead of the corresponding
8841 \begin_layout Itemize
8849 \begin_layout Itemize
8857 \begin_layout Itemize
8865 \begin_layout Itemize
8873 \begin_layout Itemize
8881 \begin_layout Subsection
8882 The new letter class: letter (koma-script v.2)
8885 \begin_layout Standard
8888 Jürgen Spitzmüller
8891 \begin_layout Standard
8892 \begin_inset VSpace medskip
8898 \begin_layout Standard
8900 Koma-Script version 2.8 has introduced a new letter class
8904 which supersedes the now unsupported
8909 It has --- on the LaTeX side --- a completely new interface and is not
8910 compatible with the old class.
8911 Therefore, LyX supports both, though it is recommended to use the new class.
8914 \begin_layout Standard
8915 This class covers the same functionality as
8917 letter (koma-script),
8924 (receiver's address, same as
8941 will start a new letter (i.
8942 \begin_inset space \thinspace{}
8946 \begin_inset space ~
8949 you can write several letters per document).
8950 New elements are sender's
8966 and the possibility to use a
8975 nsert\SpecialChar \menuseparator
8985 \begin_layout Standard
8986 The biggest improvement is, though, that the letter's layout is configurable
8987 at almost any needs.
8988 This can be done via the preamble or with a special style file (Letter
8989 Class Option, extension
8993 ), that will be read in as a class option.
8997 \begin_layout Plain Layout
8998 The KOMA package comes with some default
9003 There is, for instance, a
9007 file that follows german typesetting rules, or a
9011 that provides the default layout of the old
9016 The latter can be loaded with the class option
9025 ayout\SpecialChar \menuseparator
9030 ocument\SpecialChar \menuseparator
9042 template that is included in LyX for examples.
9043 A detailed description is to be found in the Koma-Script documentation
9051 \begin_layout Subsection
9055 \begin_layout Standard
9056 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9060 \begin_layout Itemize
9061 The chapter number of a
9065 type appears on a line of its own above the chapter heading instead of
9066 appearing in the same line ahead of it.
9067 The cause for that is the LyX internal behavior for the labeltype
9074 \begin_layout Itemize
9075 The headings of the types
9084 \begin_inset Quotes eld
9088 \begin_inset Quotes erd
9091 LaTeX table of contents, but not in the LyX table of contents (
9096 ocument\SpecialChar \menuseparator
9102 \begin_inset space ~
9106 \begin_inset space ~
9114 \begin_layout Itemize
9119 document class appear in a skip separation mode, not indented.
9120 This is the standard behavior, no special LaTeX commands are needed for
9127 ocument\SpecialChar \menuseparator
9134 dialog the corresponding radio button indicates
9150 value always has the effect that extra LaTeX commands are inserted in the
9151 document to produce the gap, which is not what is wanted in this case.
9154 \begin_layout Section
9162 \begin_layout Standard
9168 \begin_layout Subsection
9172 \begin_layout Standard
9173 These are the layout files for some of the journal formats used by Springer
9174 Verlag and listed on
9175 \begin_inset Flex URL
9178 \begin_layout Plain Layout
9180 http://www.springer.de/author/tex/help-journals.html
9185 , where you should also go to fetch the class files (yes, these are LaTeX2e
9187 It is a modular system: the things common to all journals are implemented
9192 , which journal-specific layout files (such as, e.
9193 \begin_inset space \thinspace{}
9200 for Journal of Geodesy) can include.
9203 \begin_layout Standard
9204 This means that implementing support for any other Springer journal on this
9205 list is as simple as writing your own
9213 file following the outline given in
9221 \begin_layout Standard
9222 It is reasonably well tested only for the Journal of Geodesy.
9231 come with the standard LyX distribution.
9232 Install the relevant class file (downloaded from Springer) in a proper
9233 directory, reconfigure LaTeX (in the teTeX case by running
9237 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9238 LyX and it should work.
9241 \begin_layout Subsection
9245 \begin_layout Standard
9246 A large number of theorem-like styles ---
9252 \SpecialChar \ldots{}
9258 \begin_layout Standard
9261 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9262 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9265 See the Springer class file documentation for details.
9268 \begin_layout Subsection
9272 \begin_layout Itemize
9284 \begin_layout Itemize
9287 Probability Theory and Related Fields
9293 --- Jean-Marc Lasgouttes
9296 \begin_layout Standard
9297 Add your own, it isn't so hard!
9300 \begin_layout Subsection
9304 \begin_layout Standard
9305 These files are partly based on the older
9309 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9315 layout, are now defunct.
9316 Jean-Marc Lasgouttes helped out big in making me find my way around the
9317 LyX layout file mechanism.
9320 \begin_layout Subsection
9324 \begin_layout Standard
9326 But probably less than in the old hacked-LaTeX
9333 \begin_layout Standard
9335 \begin_inset space \thinspace{}
9338 g.: does not display the number for theorem-like layouts, just #.
9341 \begin_layout Section
9349 \begin_layout Standard
9355 \begin_layout Subsection
9359 \begin_layout Standard
9360 These are the layout files for some of the journals of the American Geophysical
9362 It is assumed that you have both the AGU's own class files and AGUplus
9363 installed (everything to be found at
9364 \begin_inset Flex URL
9367 \begin_layout Plain Layout
9369 ftp://ftp.agu.org/journals/latex/journals
9377 \begin_layout Subsection
9381 \begin_layout Standard
9391 They are still called this in the LyX GUI, though their LaTeX equivalents
9392 in the AGU classes are
9403 \begin_layout Standard
9404 Newly defined styles are
9441 These are mostly manuscript attributes and defined in the AGU class documentati
9445 \begin_layout Standard
9446 I suspect this is still badly incomplete.
9449 \begin_layout Subsection
9453 \begin_layout Standard
9470 \begin_layout Subsection
9474 \begin_layout Itemize
9477 Journal of Geophysical Research
9486 \begin_layout Standard
9487 Add your own, it isn't so hard! Look at the
9498 \begin_layout Subsection
9499 Bugs and things to remember
9502 \begin_layout Standard
9503 In order to use the new layouts, you must remember to do the following for
9507 \begin_layout Enumerate
9513 This can be done in the
9515 layout\SpecialChar \menuseparator
9520 document\SpecialChar \menuseparator
9524 (AGU articles are always in English, right? So
9531 \begin_layout Enumerate
9541 (Yes, this is a bug.)
9544 \begin_layout Enumerate
9545 Make sure you use the
9549 bibliography style, by entering
9553 into the second field of the BibTeX inset.
9554 None of the standard styles will do.
9557 \begin_layout Section
9565 \begin_layout Standard
9571 \begin_layout Subsection
9575 \begin_layout Standard
9576 This is the layout file for the European Geophysical Society journals.
9581 can be downloaded from the web site of the EGS under
9582 \begin_inset Flex URL
9585 \begin_layout Plain Layout
9595 \begin_layout Subsection
9599 \begin_layout Standard
9602 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9610 The current layout file is unfortunately very unmodular and would benefit
9611 from using the various
9618 \begin_layout Section
9624 \begin_inset CommandInset label
9633 \begin_layout Standard
9641 \begin_layout Subsection
9645 \begin_layout Standard
9646 This section describes how to use LyX to make slides for overhead projectors.
9647 There are two document classes that can do this: the default slides class
9653 This section documents the former.
9656 \begin_layout Standard
9657 I'm going to say this again, nice and clear, so that there's no misunderstanding
9661 \begin_layout Standard
9662 \begin_inset VSpace bigskip
9668 \begin_layout Standard
9672 This section documents the class
9673 \begin_inset Quotes eld
9681 \begin_inset Quotes erd
9689 \begin_layout Standard
9690 \begin_inset VSpace bigskip
9696 \begin_layout Standard
9697 If you're looking for the documentation for
9698 \begin_inset Quotes eld
9706 \begin_inset Quotes erd
9710 \begin_inset space ~
9714 \begin_inset CommandInset ref
9716 reference "sec:foiltex"
9726 \begin_inset Quotes eld
9734 \begin_inset Quotes erd
9737 ] is actually somewhat better than the default
9745 \begin_layout Plain Layout
9746 \SpecialChar \ldots{}
9747 or so I've been told repeatedly by its advocates.
9748 Having never used it, I have no idea if this claim is true or not.
9753 which this section documents.
9756 \begin_layout Standard
9757 This class is the LaTeX2e improvement of the old
9762 Every LaTeX2e distribution includes this class [which I'll just refer to
9764 \begin_inset Quotes eld
9772 \begin_inset Quotes erd
9775 from now on], so you're bound to have it.
9776 As I noted earlier, there are other classes, such as
9780 , which also produce slides for overhead projectors and do a better job
9782 However, there are some things which
9786 can do which the others can't, such as generate overlays.
9787 Read on to learn more!
9790 \begin_layout Subsection
9792 \begin_inset CommandInset label
9794 name "sec:slidesetup"
9801 \begin_layout Standard
9802 Obviously, to use this document class, you need to select
9803 \begin_inset Quotes eld
9811 \begin_inset Quotes erd
9814 from the class list in the
9819 ocument\SpecialChar \menuseparator
9827 There are some other special things you should know about this class:
9830 \begin_layout Itemize
9831 Don't bother changing the options
9836 They're not supported by the
9843 \begin_layout Itemize
9850 \begin_inset space ~
9855 behaves a bit differently for this class.
9856 The possible choices and what they do are as follows:
9860 \begin_layout Description
9865 The final output contains page numbers in the lower right corner.
9868 \begin_layout Description
9877 , but also prints out any time markers you've put in.
9878 This is the default.
9881 \begin_layout Description
9886 The final output contains no page numbers, time markers, or alignment markers.
9890 \begin_layout Itemize
9895 class has an extra option:
9901 \begin_inset Quotes eld
9909 \begin_inset Quotes erd
9912 in the extra class options.
9916 \begin_layout Standard
9917 Using this options allows you to add time markers to
9923 \begin_inset space ~
9927 \begin_inset CommandInset ref
9929 reference "sec:slideNote"
9937 \begin_layout Standard
9938 You can also use the template file
9939 \begin_inset Quotes eld
9947 \begin_inset Quotes erd
9950 to automatically set up a document to use the
9959 ile\SpecialChar \menuseparator
9961 \begin_inset space ~
9965 \begin_inset space ~
9974 to open your new document].
9975 The template file also contains some examples of the special paragraph
9976 environments used by this class.
9977 I'll describe those next.
9980 \begin_layout Subsection
9981 Paragraph Environments
9984 \begin_layout Subsubsection
9985 Supported Environments
9988 \begin_layout Standard
9989 The first thing you'll notice when you start up a new
9993 document is the font size and type: it's the equivalent of the size
9994 \begin_inset Quotes eld
10002 \begin_inset Quotes erd
10008 \begin_inset space ~
10014 This is also what's used in the output.
10016 \begin_inset Quotes eld
10020 \begin_inset Quotes erd
10023 to remind you that this is a slide.
10024 Your final slides will use a larger font; ergo, you'll have less space.
10025 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10028 \begin_layout Standard
10029 The next thing that becomes obvious is the changes to the paragraph environment
10030 pull-down box [at the far-left end of the toolbar].
10031 Most of the paragraph environments you're used to seeing are missing.
10032 There are also five new ones.
10037 class itself only supports certain paragraph environments:
10040 \begin_layout Itemize
10046 \begin_layout Itemize
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 Standard
10107 All of the other standard environments, including the section-heading environmen
10108 ts, aren't used in the
10115 \begin_layout Standard
10116 On the other hand, you'll notice the following new environments:
10119 \begin_layout Itemize
10125 \begin_layout Itemize
10131 \begin_layout Itemize
10137 \begin_layout Itemize
10143 \begin_layout Itemize
10149 \begin_layout Standard
10150 These five are kind of quirky, due to a
10151 \begin_inset Quotes eld
10155 \begin_inset Quotes erd
10159 You see, LyX doesn't permit you to nest any other paragraph environment
10160 into an empty environment.
10161 Now, that's fine and dandy, but it means that you wouldn't be able to start
10162 a slide with anything except plain text.
10163 To deal with this, I've performed a little
10164 \begin_inset Quotes eld
10168 \begin_inset Quotes erd
10174 \begin_layout Subsubsection
10175 Quirks of the New Environments
10176 \begin_inset CommandInset label
10178 name "sec:slideQuirk"
10185 \begin_layout Standard
10186 All five of the new paragraph environments are somewhat quirky due to inherent
10187 limitiations in the current version of LyX.
10188 As I just mentioned, LyX forbids environments that begin with another environme
10190 To get around this, the
10194 environment isn't a paragraph environment as described in the
10202 \begin_layout Standard
10203 You should consider
10216 \begin_inset Quotes eld
10219 pseudo-environments.
10220 \begin_inset Quotes erd
10223 They look like a section heading or a
10224 \begin_inset Quotes eld
10232 \begin_inset Quotes erd
10235 but really begin a [and, if necessary, end the previous] paragraph environment.
10245 \begin_inset Quotes eld
10249 \begin_inset Quotes erd
10252 These two perform some action.
10255 \begin_layout Standard
10256 A common feature of all five environments,
10276 , is a rather long-ish label.
10277 The text following this label --- ordinarily the contents of the paragraph
10278 environment --- is utterly irrelevant for
10299 LyX completely ignores it.
10300 In fact, you can leave these five environments completely empty.
10304 \begin_layout Standard
10309 to put any text after the rather long-ish label, you might want to.
10310 This could be a short description of the contents of the
10315 In that case, enter in your descriptive comment and hit
10319 as you normally would.
10322 \begin_layout Standard
10323 If, on the other hand, you don't want to enter in any descriptive text,
10324 you'll hit another LyX quirk.
10325 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10326 environment until you put something in the old one.
10330 \begin_layout Itemize
10331 Start entering the text that will
10359 \begin_layout Itemize
10360 Now move to the beginning of that paragraph.
10364 \begin_layout Itemize
10373 \begin_layout Itemize
10374 Finally, change this new, empty paragraph to a
10398 \begin_layout Standard
10399 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10403 \begin_layout Subsection
10404 Making a Presentation with
10417 \begin_layout Subsubsection
10425 \begin_layout Standard
10426 If you're expecting this section to teach you how to actually make a presentatio
10427 n, you'll be sorely disappointed.
10428 Naturally, I'll describe all of the ways the
10432 class can assist you in preparing the materials for a presentation.
10433 Filling in the contents, however, is up to you.
10438 the LyX philosophy.]
10441 \begin_layout Standard
10446 environment [in the manner described in section
10447 \begin_inset space ~
10451 \begin_inset CommandInset ref
10453 reference "sec:slideQuirk"
10457 ] tells LyX to begin a new slide [duh].
10458 The label for this environment/
10459 \begin_inset Quotes erd
10463 \begin_inset Quotes erd
10467 \begin_inset Quotes eld
10471 \begin_inset Quotes erd
10474 in cool blue, followed by the label,
10475 \begin_inset Quotes eld
10479 \begin_inset Quotes erd
10483 Any text or paragraph environments that follow this one go on the new slide.
10487 \begin_layout Standard
10488 Slides are probably the only time you'll need to forcibly end pages in LyX
10489 (this can be specified in the
10494 In fact, you'll want to, once you finish entering the contents of one slide.
10495 If you've entered more text than can physically fit on a slide, the extra
10496 overflows onto a new slide.
10497 I don't recommend doing this, however, since the overflow slide won't have
10498 any page number on it.
10499 Furthermore, it may interfere with any
10503 you've made to accompany the oversized
10510 \begin_layout Standard
10519 environments work the same way as the
10524 They both create an
10525 \begin_inset Quotes eld
10529 \begin_inset Quotes erd
10532 followed by a label [
10533 \begin_inset Quotes eld
10537 \begin_inset Quotes erd
10541 \begin_inset Quotes eld
10545 \begin_inset Quotes erd
10549 The color is a stunning magenta instead of blue, and the
10550 \begin_inset Quotes eld
10554 \begin_inset Quotes erd
10557 will look different, in style and in length.
10558 The label fonts of all three also differ from one another.
10561 \begin_layout Standard
10566 , if the contents of a
10574 exceed the physical size of a slide or sheet of paper, the extra will overflow
10576 Again, you should avoid this.
10577 It defeats the whole purpose of
10588 \begin_layout Subsubsection
10598 \begin_layout Standard
10603 is a slide that sits atop another slide.
10604 Perhaps you wish to discuss a figure on the main
10608 before displaying the text associated with it.
10609 One way to accomplish this is tape a flap of dark paper over the part of
10614 you want to display later.
10615 This method fails, however, if you wish to overlap one graph with another,
10617 You would then have to fumble while speaking to align the two separate,
10622 s to align the two graphs.
10627 environment in both cases makes life much easier.
10630 \begin_layout Standard
10635 receives the page number of its
10636 \begin_inset Quotes eld
10640 \begin_inset Quotes erd
10648 \begin_inset Quotes eld
10656 \begin_inset Quotes erd
10663 \begin_layout Plain Layout
10664 Presumably, mutliple
10669 \begin_inset Quotes eld
10677 \begin_inset Quotes erd
10681 \begin_inset Quotes eld
10689 \begin_inset Quotes erd
10693 \begin_inset Quotes eld
10701 \begin_inset Quotes erd
10705 \begin_inset space ~
10708 appended to the page number of the parent
10718 Clearly, you want the contents of both the
10726 to each fit on a single physical slide! You should probably consider an
10732 \begin_inset Quotes eld
10736 \begin_inset Quotes erd
10748 class provides a visual cue for this: the label at the start of an
10752 is shorter than that at the start of a
10757 Lastly, when you generate printable output, you'll find alignment markers
10758 in all four corners of both the
10762 page and its parent
10767 These will assist you in lining up the two physical slides.
10770 \begin_layout Standard
10771 The major problem in overlaying two slides is aligning the contents of the
10772 two transparencies.
10773 How much space should you leave for that graph on the second slide? Worse
10774 still, what if you want a graph and a sentence on second slide, but there
10775 is text on the main transparency that goes in between them? You could try
10776 and insert vertical space of the right size.
10777 The better way is to use
10788 \begin_layout Standard
10789 As their names imply,
10797 are two command-like paragraph environments that make all subsequent text
10798 invisible and visible, respectively.
10800 \begin_inset space ~
10804 \begin_inset CommandInset ref
10806 reference "sec:slideQuirk"
10810 that you don't place anything
10814 these two environments, however.
10819 , it inserts a centered, sky-blue label into the page reading
10820 \begin_inset Quotes eld
10823 <Invisible Text Follows>
10824 \begin_inset Quotes erd
10828 For paragraphs following this label, the parts of the
10836 ; it doesn't matter which] where they would be contain instead blank space.
10840 \begin_layout Standard
10845 , the corresponding centered label is
10846 \begin_inset Quotes eld
10849 <Visible Text Follows>
10850 \begin_inset Quotes erd
10854 Paragraphs following this label behave normally.
10855 Note that the beginning of a new
10867 automatically shuts off an
10872 It's therefore not necessary to use
10883 \begin_layout Standard
10884 By now, it should be obvious how to create overlay transparencies using
10885 the proper combination of
10904 \begin_layout Enumerate
10909 , including everything that will appear on it, whether on the main slide
10917 \begin_layout Enumerate
10918 Before each figure or paragraph that will appear only on the
10927 If necessary, insert a
10931 environment after the
10938 \begin_layout Enumerate
10943 immediately following the
10950 \begin_layout Enumerate
10951 Copy the contents of this
10962 \begin_layout Enumerate
10967 , change all of the
10978 \begin_layout Standard
10980 You've just made an
10987 \begin_layout Standard
10988 There's one problem with the way I've designed the LyX
10992 class: you can't make text in the middle of a paragraph invisible, nor
10993 make text in the middle of an invisible paragraph visible again.
10994 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10998 \begin_layout Plain Layout
10999 The commands of interest are:
11002 \begin_layout Itemize
11007 invisible \SpecialChar \ldots{}
11011 \begin_layout Itemize
11016 visible \SpecialChar \ldots{}
11020 \begin_layout Plain Layout
11021 \SpecialChar \ldots{}
11022 and need to be marked as TeX.
11024 \begin_inset Quotes eld
11028 \begin_inset Quotes erd
11031 you wish to change goes in between the brackets [and after the
11044 If you don't know how to mark text as TeX, see the appropriate section
11057 \begin_layout Subsubsection
11067 \begin_inset CommandInset label
11069 name "sec:slideNote"
11076 \begin_layout Standard
11085 is associated with a
11086 \begin_inset Quotes eld
11090 \begin_inset Quotes erd
11102 class provides visual cues.
11107 is shorter than that of a
11111 [yet longer than that of an
11115 ] and, like the label of an
11119 is shockingly magenta.
11120 Additionally, the printed
11124 has the page number of its
11125 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11137 \begin_inset Quotes eld
11145 \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 You can have multiple
11177 s associated with a single
11189 , you'll probably want to break up long
11193 s so that they fit on a single sheet of paper.
11196 \begin_layout Standard
11201 is obvious: it contains anything additional you might want to say about
11207 It could also be used as a sheet of reminders for a particular
11212 In the case of the latter, you might want to make use of time markers.
11218 \begin_inset Quotes eld
11222 \begin_inset Quotes erd
11225 support for time markers, a
11230 So, you'll have to resort to using the LaTeX codes.
11233 \begin_layout Standard
11234 To use time markers, you'll need to specify the extra class option
11235 \begin_inset Quotes eld
11243 \begin_inset Quotes erd
11247 \begin_inset space ~
11251 \begin_inset CommandInset ref
11253 reference "sec:slidesetup"
11258 This option turns on timing marks, which will appear in the lower-left-hand
11264 To set what appears in the time marker, you use the LaTeX commands
11265 \begin_inset Quotes eld
11275 \begin_inset Quotes erd
11279 \begin_inset Quotes eld
11289 \begin_inset Quotes erd
11293 The arguments of both commands are time measured in seconds.
11295 \begin_inset Quotes eld
11305 \begin_inset Quotes erd
11308 sets the time marker to a given time.
11310 \begin_inset Quotes eld
11320 \begin_inset Quotes erd
11323 increments the time marker by the specified amount.
11324 Using time markers and
11328 s in this fashion, you can remind yourself how much time to spend on a particula
11336 \begin_layout Standard
11337 There's one last feature to describe.
11338 Clearly, you'd like to print out all of your
11346 s on transparencies while printing all of your
11363 with which it is associated.
11364 What's a person to do?
11367 \begin_layout Standard
11368 Luckily, there are two LaTeX commands that allow you to select what to print
11370 Both must be placed into the preamble of your document.
11372 \begin_inset Quotes eld
11384 \begin_inset Quotes erd
11387 will cause the output to contain only the
11396 Correspondingly, the command
11397 \begin_inset Quotes eld
11409 \begin_inset Quotes erd
11412 prevents the output of anything but
11417 I'd advise placing both commands in the preamble and initially comment
11419 You can then preview your entire presentation as you write.
11420 When you're done writing, you can then uncomment one of the two to select
11421 what you want to print.
11422 I like to uncomment
11423 \begin_inset Quotes eld
11435 \begin_inset Quotes erd
11438 , print to a file with
11439 \begin_inset Quotes eld
11447 \begin_inset Quotes erd
11450 in its name, comment it back out, then uncomment
11451 \begin_inset Quotes eld
11463 \begin_inset Quotes erd
11467 \begin_inset Quotes eld
11475 \begin_inset Quotes erd
11479 I can then send either file to a printer, loading transparencies or plain
11480 paper as appropriate.
11483 \begin_layout Standard
11484 You can also provide other arguments to the
11485 \begin_inset Quotes eld
11495 \begin_inset Quotes erd
11499 \begin_inset Quotes eld
11509 \begin_inset Quotes erd
11513 See a good LaTeX book for details.
11516 \begin_layout Subsection
11521 Class Template File
11524 \begin_layout Standard
11525 I have also provided a template file,
11526 \begin_inset Quotes eld
11534 \begin_inset Quotes erd
11542 To use it, begin your new presentation with
11547 ile\SpecialChar \menuseparator
11549 \begin_inset space ~
11553 \begin_inset space ~
11563 Your new LyX presentation file will contain an example
11584 additionally contain an example of the use of
11593 Lastly, the preamble will contain:
11596 \begin_layout LyX-Code
11597 % Uncomment to print out only slides and overlays
11600 \begin_layout LyX-Code
11604 \begin_layout LyX-Code
11610 \begin_inset Newline newline
11616 \begin_layout LyX-Code
11617 % Uncomment to print out only notes
11620 \begin_layout LyX-Code
11624 \begin_layout LyX-Code
11632 \begin_layout Standard
11633 One final thing: I created this class to support the LaTeX2e
11634 \begin_inset Quotes eld
11642 \begin_inset Quotes erd
11645 class, one of the built-in LaTeX2e classes.
11646 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11647 built-in slide class.
11648 It's here if you want it or need it.
11649 There exist other LaTeX2e classes for creating presentations, such as the
11655 \begin_inset space ~
11659 \begin_inset CommandInset ref
11661 reference "sec:foiltex"
11666 \begin_inset Quotes eld
11674 \begin_inset Quotes erd
11677 package [present on some TeX distributions].
11678 The latter is not yet supported under LyX.
11682 \begin_layout Plain Layout
11683 Perhaps you can take on the task\SpecialChar \ldots{}
11689 I know nothing about these other classes.
11690 Try them out to see what sort of alternative they provide.
11693 \begin_layout Section
11702 \begin_inset CommandInset label
11711 \begin_layout Standard
11717 \begin_layout Subsection
11721 \begin_layout Standard
11722 This section describes how to use LyX to make slides for overhead projectors.
11723 There are two document classes that can do this: the default slides class
11729 This section documents the latter.
11732 \begin_layout Standard
11733 I'm going to say this again, nice and clear, so that there's no misunderstanding
11737 \begin_layout Standard
11738 \begin_inset VSpace bigskip
11744 \begin_layout Standard
11748 This section documents the class
11749 \begin_inset Quotes eld
11757 \begin_inset Quotes erd
11765 \begin_layout Standard
11766 \begin_inset VSpace bigskip
11772 \begin_layout Standard
11773 If you're looking for the documentation for
11774 \begin_inset Quotes eld
11782 \begin_inset Quotes erd
11785 , check out section
11786 \begin_inset space ~
11790 \begin_inset CommandInset ref
11792 reference "sec:slitex"
11797 If your machine doesn't have the
11802 \begin_inset Quotes eld
11810 \begin_inset Quotes erd
11813 ] installed, you'll probably have to use the default
11817 class, which isn't quite as good as
11822 \begin_layout Standard
11827 class is designed for use with version 2.1 of the
11831 LaTeX class file which is now an integral part of LaTeX2e.
11834 \begin_layout Subsection
11838 \begin_layout Standard
11839 Obviously, to use this document class, you need to select
11840 \begin_inset Quotes eld
11848 \begin_inset Quotes erd
11861 \begin_inset space ~
11867 There are some settings in the
11870 \begin_inset space ~
11875 dialog that you should know about that are specific to this class:
11878 \begin_layout Itemize
11879 Don't change the options
11890 \begin_inset space ~
11896 They're ignored by the
11903 \begin_layout Itemize
11904 The default font size is 20pt with the other options being 17pt, 25pt and
11908 \begin_layout Itemize
11909 The default font is
11917 but all math equations are still typeset in the usual roman font.
11920 \begin_layout Itemize
11925 TeX supports A4 and Letter paper sizes as well as a special size for working
11927 It doesn't support A5, B5, legal or executive paper sizes.
11930 \begin_layout Itemize
11931 Don't bother changing the
11935 settings because they are ignored anyway.
11936 All floats appear where they are defined in the text.
11939 \begin_layout Itemize
11947 setting behaves a bit differently for this class.
11952 TeX provides extensive footer and header capabilities including a user-defined
11955 \begin_inset space ~
11959 \begin_inset CommandInset ref
11961 reference "sec:foilfoot"
11966 The title page is treated differently to all other pages in the document
11975 has the logo centered at the bottom of the page (if one is defined).
11976 The possible page style choices and what they do are as follows:
11981 \labelwidthstring MMMMMMM
11988 The final output contains no page numbers, or other headers or footers
11989 (except footnotes of course).
11994 \labelwidthstring MMMMMMM
12001 The final output contains page numbers centered at the bottom of the page.
12002 No other headings or footers (other than footnotes).
12006 \labelwidthstring MMMMMMM
12011 Page numbers in lower right corner.
12012 Additional headers and footers are also shown.
12013 This is also the default.
12017 \labelwidthstring MMMMMMM
12022 Gives you access to the
12026 package although its use with
12030 TeX is discouraged by the writer of the
12034 TeX package because of some potential page layout clashes.
12038 \begin_layout Subsubsection
12042 \begin_layout Standard
12043 The following options may be used in the extra class options in the
12048 ocument\SpecialChar \menuseparator
12059 \labelwidthstring MMMMMMx
12064 This sets up the page layout for 7.33in by 11in paper, which is about the
12065 same aspect ratio as a 35mm slide, making it a bit easier to work with
12070 \labelwidthstring MMMMMMx
12075 Places a rule across the page below the header on every page except the
12080 \labelwidthstring MMMMMMx
12085 Places a rule across the page above the footer on every page except the
12090 \labelwidthstring MMMMMMx
12095 This is automatically set each time you create a new
12104 TeX to use the dvips driver to rotate those pages that are set as landscape
12109 \labelwidthstring MMMMMMx
12114 Simply changes the page dimensions to those of a landscape page but doesn't
12116 Thus if you use this option you need to use an external program to rotate
12117 each page or feed your paper through your printer as landscape.
12118 Note that this option effectively reverses the roles of the
12126 environments (don't worry these are described in the next section).
12130 \labelwidthstring MMMMMMx
12135 Equation numbers on the left.
12139 \labelwidthstring MMMMMMx
12144 Flush-left equations.
12147 \begin_layout Subsection
12148 Supported Environments
12151 \begin_layout Standard
12152 Most of the environments commonly supported in other classes are also supported
12158 There are several additional environments provided by
12162 TeX as well as a couple added by LyX.
12163 The following environments are shared with other classes:
12166 \begin_layout Standard
12170 \begin_layout Plain Layout
12174 begin{multicols}{2}
12182 \begin_layout Itemize
12188 \begin_layout Itemize
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 Standard
12294 \begin_layout Plain Layout
12306 \begin_layout Standard
12307 That is, all the major environments apart from the sectioning environments.
12308 Since foils are essentially self-contained sections, with a title and body,
12313 TeX provides specific commands for starting new foils and these are:
12316 \begin_layout Itemize
12322 \begin_layout Itemize
12328 \begin_layout Standard
12329 LyX also provides slightly modified versions of these two environments called:
12332 \begin_layout Itemize
12338 \begin_layout Itemize
12341 ShortRotatefoilhead
12344 \begin_layout Standard
12345 and the differences will be explained in the next section.
12348 \begin_layout Standard
12349 Since foils are often used in presenting ideas or new theorems and such
12354 TeX also provides a comprehensive box of goodies for presenting them:
12357 \begin_layout Standard
12361 \begin_layout Plain Layout
12365 begin{multicols}{2}
12373 \begin_layout Itemize
12379 \begin_layout Itemize
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 Standard
12443 \begin_layout Plain Layout
12455 \begin_layout Standard
12456 The starred versions are unnumbered while the unstarred versions are numbered.
12457 There are also two list environments added by LyX and these are:
12460 \begin_layout Itemize
12466 \begin_layout Itemize
12472 \begin_layout Standard
12477 TeX provides some powerful header and footer capabilities that are best
12478 set in the preamble although they may be set at any point in a document.
12479 If you want to change these settings in your document the best place to
12480 do so is at the very top of a foil,
12485 straight after the foilhead.
12488 \begin_layout Standard
12489 For this purpose, the following command styles are provided [
12496 \begin_layout Standard
12500 \begin_layout Plain Layout
12504 begin{multicols}{2}
12512 \begin_layout Itemize
12516 \begin_inset space ~
12522 \begin_layout Itemize
12528 \begin_layout Itemize
12532 \begin_inset space ~
12538 \begin_layout Itemize
12542 \begin_inset space ~
12548 \begin_layout Itemize
12552 \begin_inset space ~
12559 \begin_layout Standard
12560 \begin_inset space ~
12567 \begin_layout Standard
12571 \begin_layout Plain Layout
12583 \begin_layout Standard
12584 There are also a few commands provided by
12588 TeX that aren't directly supported by LyX but I'll tell you what they do
12589 and how to use them in section
12590 \begin_inset space ~
12594 \begin_inset CommandInset ref
12596 reference "sec:unsuppfoils"
12603 \begin_layout Subsection
12604 Building a Set of Foils
12607 \begin_layout Standard
12608 This section will give a simple introduction to using the different environments
12609 to build a set of foils.
12610 If you want to see an example set of foils take a look at the
12614 file accessible from the
12619 ile\SpecialChar \menuseparator
12624 pen\SpecialChar \ldots{}
12635 \begin_layout Subsubsection
12636 Give It a Title Page
12639 \begin_layout Standard
12640 Unlike other classes that provide
12660 creates the title on a page of its own.
12661 If you leave out the
12665 environment LaTeX will substitute the current date (every time you regenerate
12669 \begin_layout Subsubsection
12673 \begin_layout Standard
12674 As I mentioned earlier, there are four ways of starting a new foil.
12675 For portrait foils you should use
12684 The difference between these two environments is the amount of space between
12685 the title of the foil (the foilhead) and the body of the foil.
12688 \begin_layout Standard
12689 Landscape foils are generated using the
12695 ShortRotatefoilhead
12698 Again the only difference is the spacing between foilhead and body.
12699 Both of the short versions have 0.5 inches less separation between the foilhead
12704 \begin_layout Standard
12705 One problem with the support for landscape foils is the requirement that
12706 you have to use the
12710 driver to generate the PostScript output otherwise the foils won't be rotated.
12711 It is possible to get landscape foils even if you haven't got the
12715 driver provided you can feed your foils sideways through your printer ;-)
12718 \begin_layout Subsubsection
12719 Theorems, Lemmas, Proofs and more
12722 \begin_layout Standard
12723 Due to a small bug in LyX you can't have two of the same type of these environme
12724 nts directly following each other.
12725 They must be separated by something.
12726 If you try, you will just be extending the previous environment as if you
12727 had merged the two environments together.
12728 So, how do you get around this problem? The simplest option is to insert
12729 some text between the two environments or add a
12733 environment between the two with just a
12734 \begin_inset Quotes eld
12742 \begin_inset Quotes erd
12746 This will force LyX to produce two separate environments and hence the
12747 correct LaTeX output.
12748 An example is provided in the example file included with the LyX distribution.
12749 Remember, this problem only occurs if you are trying to place two of the
12750 same type of theorem-like environments one directly after the other.
12753 \begin_layout Subsubsection
12757 \begin_layout Standard
12758 You get all the commonly supported list styles found in other classes as
12759 well as two new ones.
12760 I'll only describe the new ones here.
12761 If you want to find out more about the other list environments check out
12767 If you intend to use itemized lists you might also want to read about the
12771 \begin_inset space ~
12775 \begin_inset space ~
12780 dialog described above in section
12781 \begin_inset space ~
12785 \begin_inset CommandInset ref
12787 reference "sec:bullet"
12794 \begin_layout Standard
12795 The two new list styles,
12803 , are designed to make it easier for you to create lists of do's and don'ts
12804 or right and wrong by providing dedicated environments that use a tick
12805 or a cross as the label of the list.
12806 These lists are in fact dedicated variants of the
12811 They do however require that you have the
12815 packages installed.
12818 \begin_layout Subsubsection
12822 \begin_layout Standard
12827 TeX redefines the floating tables and figures so that they appear exactly
12828 where they are in the text rather than pushing them to the top of the page
12829 or to some user specified location.
12830 In fact if you change the float placement settings they are simply ignored.
12833 \begin_layout Subsubsection
12834 Page Headers and Footers
12835 \begin_inset CommandInset label
12837 name "sec:foilfoot"
12844 \begin_layout Standard
12848 \begin_inset space ~
12857 are two commands used to control the left-footer text string.
12858 The first is meant to allow you to include a graphic logo on your foils
12860 \begin_inset Quotes eld
12868 \begin_inset Quotes erd
12872 While the second is meant to provide a classification for the audience,
12876 \begin_inset space \thinspace{}
12882 \begin_inset space ~
12886 It is empty by default.
12889 \begin_layout Standard
12890 The remaining page corners can be filled by
12893 \begin_inset space ~
12898 (which defaults to page numbers),
12901 \begin_inset space ~
12909 \begin_inset space ~
12917 \begin_layout Subsection
12923 \begin_inset CommandInset label
12925 name "sec:unsuppfoils"
12932 \begin_layout Standard
12933 All the commands mentioned below need to be set in a
12941 within another environment.
12944 \begin_layout Subsubsection
12948 \begin_layout Standard
12949 All lengths are adjusted using the
12972 should be replaced by the name given to the length you want to change and
12977 is the length value.
12978 All lengths should be specified in units of length such as inches (
12990 ) or relative to some document or font-based length such as
13000 \begin_layout Standard
13001 It's possible to change the spacing between a foilhead and the body of the
13002 foil by adjusting the length specified by
13009 For example, to make
13013 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13020 foilheadskip}{-0.5in}
13023 \begin_layout Standard
13024 The spacings around floats can be adjusted by setting these lengths:
13028 \labelwidthstring MMMMMMMMMMM
13035 Separation between the text and the top of the float
13039 \labelwidthstring MMMMMMMMMMM
13046 Separation between the float and the caption
13050 \labelwidthstring MMMMMMMMMMM
13057 Separation between the caption and the following text
13061 \labelwidthstring MMMMMMMMMMM
13068 You can make the captions narrower than the surrounding text by adjusting
13070 Best done relative to
13079 \begin_layout Standard
13080 There are also several title page related lengths that you may find useful
13081 if you have a long title or several authors:
13085 \labelwidthstring MMMMMMMMMMM
13092 Separation from headers to
13098 \labelwidthstring MMMMMMMMMMM
13117 \labelwidthstring MMMMMMMMMMM
13132 \labelwidthstring MMMMMMMMMMM
13149 \labelwidthstring MMMMMMMMMMM
13165 \begin_layout Standard
13166 The last length related command affects all the list environments.
13177 a list environment then all the vertical spacing between the list items
13179 Note that this is a command not a length so it doesn't require
13185 like the stuff mentioned above.
13188 \begin_layout Subsubsection
13189 Headers and Footers
13192 \begin_layout Standard
13205 commands control whether the logo in the
13209 definition appear on a given page.
13216 in the preamble then none of the foils will have the logo on them.
13217 If you don't want the logo on a particular page place the
13223 directly after the foilhead of that page and the
13229 directly after the next foilhead.
13232 \begin_layout Standard
13233 If you decide to use the
13237 page style setting in the
13240 \begin_inset space ~
13245 dialog you should probably add
13255 to your preamble so headers and footers on landscape pages are correctly
13256 placed when rotated.
13257 This is due to some clashes between the page layouts provided by the
13268 \begin_layout Section
13269 Latex8 (IEEE Conference Papers)
13272 \begin_layout Standard
13278 \begin_layout Subsection
13282 \begin_layout Standard
13283 Since this class is specifically for writing submissions to IEEE sponsored
13284 conferences I strongly recommend that you get a copy of their Authors Kit.
13289 package and associated bibliography style file is included in the kit.
13290 The Authors Kit is usually sent out by email once your initial submission
13292 There is a lot of useful information in the Authors Kit explaining formatting
13293 restrictions and so on and I will assume you have read this since that
13294 means I don't have to repeat it all here.
13297 \begin_layout Subsection
13301 \begin_layout Standard
13302 [AR\SpecialChar \@.
13306 \begin_layout Subsection
13307 Supported Environments
13310 \begin_layout Itemize
13316 \begin_layout Itemize
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 Subsection
13365 Differences Between Screen and Paper
13368 \begin_layout Standard
13369 There are slight differences in appearance mainly with the presentation
13370 of section counters.
13371 On screen the trailing period of the section counter is missing but it
13372 will appear in the output so don't let this worry you.
13375 \begin_layout Section
13376 Hollywood (Hollywood spec scripts)
13379 \begin_layout Standard
13385 \begin_layout Subsection
13389 \begin_layout Standard
13390 Getting the format of a Hollywood script right is a
13391 \begin_inset Quotes eld
13395 \begin_inset Quotes erd
13398 It is designed to make the readers focus on content and to be easy and
13399 familiar for the actors to read.
13400 Each page of a script should be one minute of film.
13401 Nothing goes in a script that you cannot see or hear on screen.
13402 The courier 12 pt font should be used throughout.
13406 \begin_layout Subsection
13410 \begin_layout Standard
13411 Speakers' lines should NEVER break in mid-sentence.
13412 If a speaker's lines continue over a page break, repeat the
13416 title followed by (Cont'd).
13419 \begin_layout Subsection
13423 \begin_layout Standard
13428 names as labels then cross-reference the label to insert the name.
13429 The cross-reference dialog will show the current cast of characters.
13430 You can use this to insert the speaker name in narratives also.
13433 \begin_layout Subsection
13434 Paper size and Margins
13437 \begin_layout Standard
13438 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13441 \begin_layout Subsection
13445 \begin_layout Standard
13446 The following environments are available.
13447 You can use hollywood.bind to get the bind keys shown at the right.
13450 \begin_layout Itemize
13454 \begin_inset Newline newline
13459 Used where nothing else works.
13463 \begin_layout Itemize
13469 \begin_inset space \hfill{}
13477 \begin_inset Newline newline
13480 Usually followed by something like
13481 \begin_inset Quotes eld
13484 on Sally waking up.
13485 \begin_inset Quotes erd
13491 \begin_layout Itemize
13495 \begin_inset space \hfill{}
13499 \begin_inset Newline newline
13504 Introduces a new INTERIOR camera set-up.
13505 Always followed by DAY or NIGHT, or something similar to define the lighting
13507 Everthing on this line in CAPS.
13510 \begin_layout Itemize
13514 \begin_inset space \hfill{}
13518 \begin_inset Newline newline
13523 Introduces a new EXTERIOR camera set-up.
13524 Everthing on this line in CAPS.
13527 \begin_layout Itemize
13531 \begin_inset space \hfill{}
13535 \begin_inset Newline newline
13540 The character speaking.
13543 \begin_layout Itemize
13547 \begin_inset space \hfill{}
13551 \begin_inset Newline newline
13556 Instructions to the speaker.
13557 The () are automatically inserted, but only the ( will show in LyX.
13558 Both will be printed.
13561 \begin_layout Itemize
13565 \begin_inset space \hfill{}
13569 \begin_inset Newline newline
13581 \begin_layout Itemize
13585 \begin_inset space \hfill{}
13589 \begin_inset Newline newline
13594 Camera movement instruction.
13596 \begin_inset space \thinspace{}
13600 \begin_inset space ~
13606 \begin_layout Itemize
13610 \begin_inset space \hfill{}
13616 \begin_layout Itemize
13620 \begin_inset space \hfill{}
13626 \begin_layout Itemize
13630 \begin_inset space \hfill{}
13636 \begin_layout Itemize
13640 \begin_inset space \hfill{}
13646 \begin_layout Subsection
13650 \begin_layout Itemize
13651 (O.S) --- off screen
13654 \begin_layout Itemize
13655 (V.0) --- voice over
13658 \begin_layout Itemize
13663 \begin_layout Itemize
13668 \begin_layout Itemize
13669 PAN --- camera movement
13672 \begin_layout Itemize
13673 INSERT --- cut to close-up of
13676 \begin_layout Section
13680 \begin_layout Standard
13686 \begin_layout Subsection
13690 \begin_layout Standard
13691 Broadway is for writing plays.
13692 The format is more decorative than Hollywood, and much less standardized.
13693 This format should be suitable for workshops.
13696 \begin_layout Subsection
13700 \begin_layout Standard
13701 The same as in Hollywood.
13704 \begin_layout Subsection
13708 \begin_layout Standard
13713 names as labels then cross-reference the label to insert the name.
13714 The cross-reference dialog will show the current cast of characters.
13717 \begin_layout Subsection
13718 Paper size and Margins
13721 \begin_layout Standard
13722 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13725 \begin_layout Subsection
13729 \begin_layout Standard
13730 The following environments are available.
13731 You can use broadway.bind to get the bind keys shown at the right.
13734 \begin_layout Itemize
13738 \begin_inset Newline newline
13743 You should not have to use this, but it is here for anything that does not
13747 \begin_layout Itemize
13751 \begin_inset space \hfill{}
13755 \begin_inset Newline newline
13760 Used to describe stage setting and the action.
13761 First use of speaker names in all CAPs.
13764 \begin_layout Itemize
13768 \begin_inset space \hfill{}
13772 \begin_inset Newline newline
13777 Automatically numbered.
13778 On screen it will be arabic, but will print as Roman.
13781 \begin_layout Itemize
13785 \begin_inset space \hfill{}
13789 \begin_inset Newline newline
13799 It is just centered text.
13802 \begin_layout Itemize
13806 \begin_inset space \hfill{}
13810 \begin_inset Newline newline
13815 Not automatically numbered.
13816 You supply the number.
13817 This is because I couldn't figure out how.
13820 \begin_layout Itemize
13824 \begin_inset space \hfill{}
13828 \begin_inset Newline newline
13833 A special case of Narrative to describe the setting and action as the curtain
13837 \begin_layout Itemize
13841 \begin_inset space \hfill{}
13845 \begin_inset Newline newline
13850 The speaker's (actor's) title, centered in all CAPS.
13853 \begin_layout Itemize
13857 \begin_inset space \hfill{}
13861 \begin_inset Newline newline
13866 Instructions to the speaker.
13867 The parentheses are automatically inserted.
13868 The ( will appear on screen, but both will be in the printed play.
13869 This environment is only used within
13876 \begin_layout Itemize
13880 \begin_inset space \hfill{}
13884 \begin_inset Newline newline
13889 What the Speaker says.
13892 \begin_layout Itemize
13896 \begin_inset space \hfill{}
13900 \begin_inset Newline newline
13905 The curtain comes down.
13908 \begin_layout Itemize
13912 \begin_inset space \hfill{}
13918 \begin_layout Itemize
13922 \begin_inset space \hfill{}
13928 \begin_layout Itemize
13932 \begin_inset space \hfill{}
13938 \begin_layout Standard
13942 \begin_layout Section
13946 \begin_layout Standard
13952 \begin_layout Standard
13953 \begin_inset VSpace bigskip
13959 \begin_layout Standard
13964 \begin_inset space ~
13969 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13970 \begin_inset Formula $\beta$
13973 release of May, 1999) class.
13976 \begin_layout Standard
13981 textclass, which works with RevTeX 3.1.
13982 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13983 That means that it doesn't interact very well with LyX, which requires
13984 LaTeX2e, although it has been kludged to work.
13985 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13989 \begin_inset space ~
13994 textclass should also be pretty easy to use.
13997 \begin_layout Standard
13998 These documents are supposed to be used in
14002 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14003 macros, and assume you'll know what to put in the preamble if necessary.
14006 \begin_layout Subsection
14010 \begin_layout Standard
14011 All you need to do is install RevTeX 4, as described in the package's README
14013 The package can be found at The RevTeX 4 Web Site
14014 \begin_inset Flex URL
14017 \begin_layout Plain Layout
14019 http://publish.aps.org/revtex4/
14025 Install it somewhere that LaTeX can see it.
14026 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14027 (i.e., not the directory where you installed the class file.) Then, if you
14028 reconfigure LyX, it will find the class file and let you use the RevTeX4
14032 \begin_layout Standard
14033 Probably the easiest way to get started is either to import a RevTeX 4 document
14041 \begin_inset space ~
14046 template, found in the templates directory.
14049 \begin_layout Subsection
14053 \begin_layout Standard
14054 Optional arguments to
14061 \begin_inset Quotes eld
14065 \begin_inset Quotes erd
14069 \begin_inset Quotes eld
14073 \begin_inset Quotes erd
14083 \begin_inset space ~
14091 \begin_inset space ~
14097 Remember that in RevTeX, at least one optional argument is required!
14100 \begin_layout Standard
14101 Other preamble matter, like
14108 \begin_inset space ~
14118 \begin_inset space ~
14123 dialog, also as usual.
14126 \begin_layout Subsection
14130 \begin_layout Standard
14131 The layouts basically correspond to the commands in RevTeX4.0.
14132 For example, the Email layout corresponds to
14139 Note that (at least as of RevTeX 4.0 Beta), the
14147 layouts are exactly equivalent, so you shouldn't need to use both.
14151 \begin_layout Plain Layout
14152 In case you're curious, both were included so that
14156 would be able to translate both
14176 \begin_layout Subsection
14180 \begin_layout Standard
14181 There are a couple of important unique aspects of RevTeX 4 which might cause
14182 bugs that will be even more confusing in LyX.
14185 \begin_layout Standard
14203 The LyX equivalent is that there is a separate Thanks layout.
14208 write footnotes in the
14212 layout, or weird things may happen.
14213 See the RevTeX 4 documentation for more details.
14216 \begin_layout Standard
14220 \begin_inset space ~
14228 \begin_inset space ~
14237 layouts must be placed
14245 layout and the corresponding
14262 , the LaTeX won't compile.
14265 \begin_layout Subsection
14269 \begin_layout Standard
14270 The main problem with this layout is that you can't use the optional arguments
14271 to layouts like Email and Title.
14272 (The problem is not unique to this layout; you can't use optional arguments
14273 to the Section layouts either.) This means that after you export that file
14274 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14275 need to edit the LaTeX file with a text editor to add the optional arguments
14277 \begin_inset space \thinspace{}
14280 g., the running title for the page headers.
14281 Lacking these layouts makes the
14287 (and the equivalent
14293 ) useless, so the corresponding layouts don't exist, and will have to be
14298 \begin_layout Plain Layout
14303 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14304 has not been updated yet to take advantage of it.
14312 \begin_layout Section
14313 Article (mwart), book (mwbk) and report (mwrep)
14314 \begin_inset OptArg
14317 \begin_layout Plain Layout
14330 \begin_layout Standard
14336 \begin_layout Standard
14337 The LyX document classes
14353 correspond to the LaTeX document classes
14366 They are replacements for the standard document classes
14378 , resp., and fit better to Polish typography conventions in a number of points.
14382 \begin_layout Standard
14386 \begin_layout Itemize
14387 Unnumbered titles (with star, eg.
14392 ) are added into table of contents,
14395 \begin_layout Itemize
14396 Additional page styles:
14400 \begin_layout Description
14401 uheadings header with separated lines,
14404 \begin_layout Description
14405 myheadings custom header, contents headers via commands:
14420 \begin_layout Description
14421 myuheadings custom header with separated lines,
14424 \begin_layout Description
14425 outer page number is placed on outer side of page
14429 \begin_layout Itemize
14434 \begin_layout Description
14435 rmheadings serif titles --- default,
14438 \begin_layout Description
14439 sfheadings sansserif titles,
14442 \begin_layout Description
14443 authortitle on title page first placed is author next title --- default,
14446 \begin_layout Description
14447 titleauthor on title page first placed is title next author,
14450 \begin_layout Description
14451 withmarginpar reserve place on page for margins.
14455 \begin_layout Section
14459 \begin_layout Standard
14465 \begin_layout Standard
14466 Elsevier Science Publishers B.V.
14467 provides a standard LaTeX document class (
14471 ) for submitting articles to their various journals.
14472 The style file can be downloaded directly from their web site:
14473 \begin_inset Flex URL
14476 \begin_layout Plain Layout
14478 http://authors.elsevier.com/
14484 Instructions are supplied along with the class file, which details the
14485 requirements of the publishers.
14486 LyX includes package that allows for the use of this class, by a layout
14487 and a template file.
14488 Installation of the class file is the same as for any other LaTeX package;
14489 instructions are provided in the Elsevier documentation.
14492 \begin_layout Standard
14502 As the Elsevier class file is based mainly on the standard article class,
14503 most of the normal functionality is provided.
14504 The Elsevier class defines a number of mathematical environments, which
14505 are similar to the AMS environments.
14506 These commands are all described in the Elsevier documentation, and are
14510 \begin_layout Standard
14511 The easiest way to use the Elsevier style is to base documents on the included
14513 It is best not to use options such as fancy headings or the geometry package,
14514 as elements such as these are defined by Elsevier in their style file.
14515 Ideally, no extra packages except those mentioned in the Elsevier documentation
14517 Essentially, Elsevier require as
14518 \begin_inset Quotes eld
14522 \begin_inset Quotes erd
14525 a LaTeX file as possible, as their intention is to take the supplied file
14526 and replace the class file with one for the particular journal to which
14527 the paper has been submitted.
14528 This also means that not too much time should be spent on the formating
14530 When it comes to be published, this will change anyway.
14531 The rest of the usage for this layout is substantially the same as for
14532 the normal article class.
14533 For details of what Elsevier do and don't allow, refer to their documentation.
14536 \begin_layout Section
14540 \begin_layout Standard
14543 Jürgen Spitzmüller
14546 \begin_layout Subsection
14550 \begin_layout Standard
14551 Memoir is a very powerful and constantly evolving class.
14552 It has been designed with regard to fictional and non-fictional literature.
14553 Its aim is to let the user have maximum control over the typesetting of
14555 Memoir is based on the standard book class, but it can also emulate the
14556 article class (see below).
14559 \begin_layout Standard
14560 Peter Wilson, the developer of Memoir, is known as the author of lots of
14561 useful packages in the LaTeX world.
14562 Most of them have been merged with Memoir.
14563 Therefore, it is much easier to layout the table of contents, appendices,
14564 chapter designs and such.
14565 LyX, though, does not support all of these goodies natively.
14566 Some of them might be added to forthcoming releases
14570 \begin_layout Plain Layout
14571 You are invited to send suggestions to
14572 \begin_inset Flex URL
14575 \begin_layout Plain Layout
14577 lyx-devel@lists.lyx.org
14587 , lots will probably never, due to the limitations of LyX's framework.
14588 Of course you can still use all features with the help of some native LaTeX
14593 \begin_layout Plain Layout
14598 \begin_layout Plain Layout
14608 \begin_inset space ~
14612 \begin_inset CommandInset ref
14614 reference "sec:Inserting-LaTeX-Code"
14624 In this section, we can only list those features which are natively supported
14626 For detailed descriptions (and for the rest of features) we are recommending
14627 to have a look at the detailed manual of the Memoir class
14631 \begin_layout Plain Layout
14636 \begin_layout Plain Layout
14646 \begin_inset Flex URL
14649 \begin_layout Plain Layout
14651 CTAN:/macros/latex/memoir/memman.pdf
14661 , which is not only a user guide for the class, but also both a comprehensive
14662 description on good typesetting and a superb example for good typesetting
14666 \begin_layout Subsection
14667 Basic features and restrictions
14670 \begin_layout Standard
14671 Memoir supports basically all features of the standard book classes.
14672 There are, however, some differences, as follows:
14675 \begin_layout Description
14677 \begin_inset space ~
14680 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14683 \begin_layout Description
14685 \begin_inset space ~
14688 style: The fancy page style is not supported, due to a command clash between
14689 Memoir and the fancyhdr package (they are both defining a command with
14690 the same name, which confuses LaTeX).
14691 Instead, Memoir comes with a bunch of own page styles (see
14693 Layout\SpecialChar \menuseparator
14694 Document\SpecialChar \menuseparator
14696 \begin_inset space ~
14702 If you want to use these for the chapter pages, you have to use the command
14709 in the main text or in preamble (e.
14710 \begin_inset space \thinspace{}
14714 \begin_inset space ~
14721 chapterstyle{companion}
14726 \begin_layout Description
14727 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14728 an optional argument in the standard classes.
14729 With this, you can specify an alternative version of the title for the
14730 table of contents and the headers (for instance, if the title is too long).
14731 In LyX, you can do this via
14733 Insert\SpecialChar \menuseparator
14735 \begin_inset space ~
14740 at the beginning of a chapter/section.
14741 Memoir features a second optional argument and thus separates the table
14742 of contents from the header.
14743 You can define three variants of a title with this: one for the main text,
14744 one for the table of contents, and one for the headers.
14745 Simply insert two optional arguments if you need this feature, the first
14746 one containing the short title for the Table of Contents, the second one
14747 containing an alternative short title for the headers.
14750 \begin_layout Description
14751 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14752 of contents, the list of figures and the list of table start a new page
14754 Memoir does not follow this route.
14755 You have to insert a page break yourself, if you want to have one.
14758 \begin_layout Description
14759 Titlepage: For some unknown reason, Memoir uses pagination on the title
14760 page (in the standard classes, title pages are
14761 \begin_inset Quotes eld
14765 \begin_inset Quotes erd
14769 \begin_inset space \thinspace{}
14773 \begin_inset space ~
14777 If you want an empty title page, type
14781 aliaspagestyle{title}{empty}
14786 \begin_layout Description
14787 Article: With the class option
14793 Layout\SpecialChar \menuseparator
14794 Document\SpecialChar \menuseparator
14796 \begin_inset space ~
14801 ), you can emulate article style.
14802 That is, counters (footnotes, figures, tables etc.) will not be reset on
14803 new chapters, chapters don't start a new page (but are---in contrary to
14805 \begin_inset Quotes eld
14809 \begin_inset Quotes erd
14812 article classes---still allowed), parts, though, use their own page, as
14816 \begin_layout Description
14817 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14818 font commands, which have been used in the old LaTeX version 2.09 (e.
14819 \begin_inset space \thinspace{}
14823 \begin_inset space ~
14839 It produces an error and stops LaTeX whenever such a command appears.
14844 reallows the commands and spits out warnings instead (which does at least
14846 Since a lot of packages and particularly BibTeX style files are still using
14847 those commands, we have decided to use this option by default.
14850 \begin_layout Subsection
14854 \begin_layout Standard
14855 We will only describe the features supported by LyX (which is not much currently
14857 Please consult the Memoir manual
14861 \begin_layout Plain Layout
14866 \begin_layout Plain Layout
14876 \begin_inset Flex URL
14879 \begin_layout Plain Layout
14881 CTAN:/macros/latex/memoir/memman.pdf
14894 \begin_layout Description
14895 Abstract: You may wonder why an abstract is an extra feature.
14896 Well, it is in book class.
14897 Usually books don't have abstracts.
14898 Memoir, however, has.
14899 You can use it wherever and how often you like.
14902 \begin_layout Description
14903 Chapterprecis: You may know this from belletristic: The contents of a chapter
14904 is shortly described below the title and also in the table of contents
14906 \begin_inset space \thinspace{}
14910 \begin_inset space ~
14915 Our hero arrives in Troia; he loses some friends; he finds others
14918 Chapterprecis does exactly this.
14919 It is therefore only sensible below a chapter.
14922 \begin_layout Description
14923 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14924 The epigraph environment provides an elegant way of typesetting such a
14926 The motto itself (text) and its author (source) are divided by a short
14928 Unfortunately, we have to fool LyX a bit here again, since the environment
14929 needs two arguments (text and source).
14930 In this case, we have to use curly brackets (in TeX mode) between the two
14941 <author of the slogan>.
14944 \begin_layout Description
14945 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14946 complex figurative poems).
14947 LyX can only support a few of them.
14948 One is poemtitle, which is a centered title for poems, which will also
14949 be added to the table of contents (verse is the standard environment for
14951 Memoir has some enhanced versions of verse, but you need to use ERT, because
14952 they have to be nested inside regular verse environments, which is not
14953 possible with LyX).
14956 \begin_layout Description
14957 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14960 \begin_layout Chapter
14961 LyX Features needing Extra Software
14964 \begin_layout Section
14968 \begin_layout Standard
14974 \begin_layout Subsection
14978 \begin_layout Standard
14986 menu, you'll find a
14992 \begin_inset space ~
14998 This feature requires you to have the
15002 program installed, and is grayed out if you don't have it.
15003 You can get it from your nearest CTAN mirror, or over the Web from
15004 \begin_inset Flex URL
15007 \begin_layout Plain Layout
15009 http://www.ifi.uio.no/~jensthi/chktex/
15017 \begin_layout Standard
15022 package is a program that was written by
15027 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15028 and easy to forget.
15029 The program runs over your LaTeX file and checks the integrity of the file,
15030 and flags some common errors.
15031 In other technical words, it is
15038 \begin_layout Standard
15039 Well, what is a syntax checker doing in LyX which is supposed to produce
15040 correct LaTeX anyways? The answer is simple: Just as
15044 not only checks the
15048 of C programs, but also does
15052 checks for type-errors,
15056 catches some common
15060 errors, in addition to the syntactical ones.
15065 is capable of detecting several common errors, such as
15068 \begin_layout Itemize
15069 Ellipsis detection:
15070 \begin_inset Newline newline
15073 Use \SpecialChar \ldots{}
15077 \begin_layout Itemize
15078 No space in front of/after parenthesis:
15079 \begin_inset Newline newline
15085 \begin_layout Itemize
15086 Enforcement of normal space after common abbreviations:
15087 \begin_inset Newline newline
15092 is too wide spacing.
15095 \begin_layout Itemize
15096 Enforcement of end-of-sentence space when the last sentence ends with a
15098 \begin_inset Newline newline
15102 And this is wrong spacing.
15105 \begin_layout Itemize
15106 Space in front of labels and similar commands:
15107 \begin_inset Newline newline
15110 The label should stick right up to the text to avoid falling to a wrong
15113 \begin_inset CommandInset label
15123 \begin_layout Plain Layout
15124 This footnote is in danger of falling off to a wrong page
15129 The label is separated too much.
15132 \begin_layout Itemize
15133 Space in front of references, instead of hard spaces:
15134 \begin_inset Newline newline
15137 In you are in bad luck, the text will break right between the referenced
15138 text and reference number, and that's a pity.
15140 \begin_inset CommandInset ref
15142 reference "sec:chktex"
15149 \begin_layout Itemize
15151 \begin_inset Quotes eld
15155 \begin_inset Quotes erd
15159 \begin_inset Formula $\times$
15163 \begin_inset Newline newline
15166 2x2 looks cheap compared to
15167 \begin_inset Formula $2\times2$
15173 \begin_layout Standard
15174 and more \SpecialChar \ldots{}
15175 It is an invaluable tool when you are
15176 \begin_inset Quotes eld
15180 \begin_inset Quotes erd
15183 your document before printing, and you should run it right after the obligatory
15184 spelling check, and before you go fine tuning the typesetting.
15187 \begin_layout Subsection
15191 \begin_layout Standard
15192 If you have the program installed, usage is as simple as choosing
15197 ools\SpecialChar \menuseparator
15203 \begin_inset space ~
15209 This will make LyX generate a LaTeX file of your document, start
15213 to check it, and then make LyX insert
15214 \begin_inset Quotes eld
15218 \begin_inset Quotes erd
15221 with the warnings from
15225 , if there were any.
15226 The warnings will be placed close to the point of the mistake, and you
15227 can quickly find them by using the
15232 avigate\SpecialChar \menuseparator
15239 menu item, or the shortcut key
15248 Open the error boxes by clicking on them with the mouse, or use the shortcut
15257 bindings, or the corresponding
15266 Read the warning and correct the mistake, if it is a mistake.
15267 If you have trouble understanding what the warning is about, you can safely
15269 Remember that there is a hidden layer between the document on screen and
15270 the technical details in invoking
15274 , and this gap can make some warnings seem arcane or just right down plain
15278 \begin_layout Standard
15279 This document is an excellent testing bed for the feature, and it should
15280 provide quite a few warnings for you to fiddle with.
15281 Since computers are only so smart, expect most of the warnings to be false
15285 \begin_layout Subsection
15286 How to fine tune it
15289 \begin_layout Standard
15290 Sometimes, you'll find that
15294 makes more noise than suits your mood.
15295 Then you can choose not to use it, wait until your mood changes, or try
15300 to get better along with you.
15301 Another choice in the most desperate situations is to use
15306 iew\SpecialChar \menuseparator
15312 \begin_inset space ~
15316 \begin_inset space ~
15320 \begin_inset space ~
15325 , which will get rid of all warnings instantly.
15328 \begin_layout Standard
15337 very configurable and extensible, you shouldn't expect to solve all problems
15343 Since LyX has to generate a somewhat special LaTeX file to be able to match
15344 the line numbers from the
15352 \begin_layout Plain Layout
15353 You can inspect the specific output from
15359 Edit\SpecialChar \menuseparator
15361 \begin_inset space ~
15365 \begin_inset space ~
15379 to the internal document structure, some of the warnings will not seen
15380 to appear correctly.
15381 There are two things you can do about this:
15384 \begin_layout Itemize
15389 invocation command line in
15405 installation configuration file (usually with the file
15410 See below to learn what warnings can be enabled and disabled on the command
15415 \begin_layout Itemize
15416 Export your document as a raw LaTeX file using
15421 ile\SpecialChar \menuseparator
15426 xport\SpecialChar \menuseparator
15438 Invoked in this way, it can be a hassle to find the corresponding place
15439 in the document inside LyX, but with a little patience, you should be able
15443 \begin_layout Standard
15444 Here follows the warning messages that can be enabled and disabled in
15453 to disable a warning, and
15457 to enable a warning.
15458 The emphasized entries are disabled by default, because the default is
15461 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15466 \begin_layout Standard
15467 Notice that you should only use the options that enable and disable warnings,
15468 because LyX relies on some of the other command line parameters to be set
15469 in a specific way to have a chance to communicate with
15476 \begin_layout Enumerate
15480 Command terminated with space.
15483 \begin_layout Enumerate
15486 Non-breaking space (
15487 \begin_inset Quotes eld
15495 \begin_inset Quotes erd
15498 ) should have been used.
15501 \begin_layout Enumerate
15505 You should enclose the previous parenthesis with
15506 \begin_inset Quotes eld
15514 \begin_inset Quotes erd
15520 \begin_layout Enumerate
15523 Italic correction (
15524 \begin_inset Quotes eld
15534 \begin_inset Quotes erd
15537 ) found in non-italic buffer.
15540 \begin_layout Enumerate
15543 Italic correction (
15544 \begin_inset Quotes eld
15554 \begin_inset Quotes erd
15557 ) found more than once.
15560 \begin_layout Enumerate
15564 No italic correction (
15565 \begin_inset Quotes eld
15575 \begin_inset Quotes erd
15581 \begin_layout Enumerate
15585 \begin_inset Quotes eld
15593 \begin_inset Quotes erd
15597 \begin_inset Quotes eld
15605 \begin_inset Quotes erd
15611 \begin_layout Enumerate
15614 Wrong length of dash may have been used.
15617 \begin_layout Enumerate
15621 \begin_inset Quotes eld
15629 \begin_inset Quotes erd
15633 \begin_inset Quotes eld
15641 \begin_inset Quotes erd
15647 \begin_layout Enumerate
15651 \begin_inset Quotes eld
15659 \begin_inset Quotes erd
15665 \begin_layout Enumerate
15669 \begin_inset Quotes eld
15677 \begin_inset Quotes erd
15680 to achieve an ellipsis.
15683 \begin_layout Enumerate
15686 Inter-word spacing (
15687 \begin_inset Quotes eld
15697 \begin_inset Quotes eld
15700 ) should perhaps be used.
15703 \begin_layout Enumerate
15706 Inter-sentence spacing (
15707 \begin_inset Quotes eld
15717 \begin_inset Quotes erd
15720 ) should perhaps be used.
15723 \begin_layout Enumerate
15726 Could not find argument for command.
15729 \begin_layout Enumerate
15733 \begin_inset Quotes eld
15741 \begin_inset Quotes erd
15747 \begin_layout Enumerate
15750 Math mode still on at end of LaTeX file.
15753 \begin_layout Enumerate
15757 \begin_inset Quotes eld
15765 \begin_inset Quotes erd
15768 doesn't match the number of
15769 \begin_inset Quotes eld
15777 \begin_inset Quotes erd
15783 \begin_layout Enumerate
15786 You should use either
15789 \begin_inset Quotes eld
15797 \begin_inset Quotes erd
15802 as an alternative to
15803 \begin_inset Quotes eld
15811 \begin_inset Quotes erd
15817 \begin_layout Enumerate
15824 " (ASCII 39) instead of "
15831 \begin_layout Enumerate
15834 User-specified pattern found.
15837 \begin_layout Enumerate
15840 This command might not be intended.
15843 \begin_layout Enumerate
15850 \begin_layout Enumerate
15868 \begin_layout Enumerate
15871 Delete this space to maintain correct page references.
15874 \begin_layout Enumerate
15878 You might wish to put this between a pair of
15879 \begin_inset Quotes eld
15887 \begin_inset Quotes erd
15893 \begin_layout Enumerate
15896 You ought to remove spaces in front of punctuation.
15899 \begin_layout Enumerate
15902 Could not execute LaTeX command.
15905 \begin_layout Enumerate
15914 in front of small punctuation.
15917 \begin_layout Enumerate
15925 may look prettier here.
15928 \begin_layout Enumerate
15932 Multiple spaces detected in output.
15935 \begin_layout Enumerate
15938 This text may be ignored.
15941 \begin_layout Enumerate
15947 \begin_inset Quotes eld
15952 to begin quotation, not
15959 \begin_layout Enumerate
15966 to end quotation, not
15969 \begin_inset Quotes eld
15977 \begin_layout Enumerate
15983 \begin_layout Enumerate
15986 You should perhaps use
15987 \begin_inset Quotes eld
15995 \begin_inset Quotes erd
16001 \begin_layout Enumerate
16004 You should put a space in front of/after parenthesis.
16007 \begin_layout Enumerate
16010 You should avoid spaces in front of/after parenthesis.
16013 \begin_layout Enumerate
16017 You should not use punctuation in front of/after quotes.
16020 \begin_layout Enumerate
16023 Double space found.
16026 \begin_layout Enumerate
16029 You should put punctuation outside inner/inside display math mode.
16032 \begin_layout Enumerate
16035 You ought to not use primitive TeX in LaTeX code.
16038 \begin_layout Enumerate
16041 You should remove spaces in front of
16042 \begin_inset Quotes eld
16050 \begin_inset Quotes erd
16056 \begin_layout Enumerate
16059 \begin_inset Quotes eld
16067 \begin_inset Quotes erd
16070 is normally not followed by
16071 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16085 \begin_layout Standard
16086 In later versions of LyX, we hope to provide a more complete interface to
16087 this tool (and it's smaller cousin
16091 ) to exploit the full power of it.
16092 But it's not exactly useless as it is now: go try it on one of your existing
16093 documents of a certain length and be surprised.
16096 \begin_layout Section
16097 Version Control in LyX
16100 \begin_layout Standard
16103 Lars Gullik Bjønnes
16106 \begin_layout Subsection
16110 \begin_layout Standard
16111 A friend of mine wanted to try LyX for a group project.
16112 When he didn't find support for version control or file locking, he dropped
16114 This angered me a bit, so I thought that I should at least make support
16115 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16116 This has now been done.
16117 LyX now supports some of the most basic RCS commands.
16118 If you need to something a bit more sophisticated you will have to do that
16119 manually in an xterm.
16122 \begin_layout Standard
16123 Before you begin to use the version control features in LyX, you should
16125 \begin_inset Quotes eld
16129 \begin_inset Quotes erd
16132 (a man file, read it with
16137 This file describes all the basic features of RCS.
16138 You should especially notice the comment about a RCS directory, and the
16139 notion of a master RCS file (the file ending in
16146 \begin_layout Standard
16147 The implementation in LyX assumes a recent version of the GNU RCS package---no
16148 guarantees are made for older versions.
16151 \begin_layout Subsection
16152 RCS commands in LyX
16155 \begin_layout Standard
16156 The following sections describe the RCS commands supported by LyX.
16157 You can find them in the
16162 ile\SpecialChar \menuseparator
16168 \begin_inset space ~
16176 \begin_layout Subsubsection
16182 \begin_layout Standard
16183 If your document is not under revision control, this is the only item shown
16185 And if it is under revision control, the
16192 item is grayed out.
16196 \begin_layout Standard
16197 This command registers your document with RCS\SpecialChar \@.
16198 You are asked interactively
16199 to supply an initial description of the document.
16200 The document is now set in Read-Only mode and you have to
16203 \begin_inset space ~
16207 \begin_inset space ~
16211 \begin_inset space ~
16216 , before making any changes to it.
16217 A document under revision control has a
16218 \begin_inset Quotes eld
16221 [RCS:<version> <locker>]
16222 \begin_inset Quotes erd
16225 item tagged to the filename in the minibuffer.
16228 \begin_layout Standard
16229 RCS command that is run:
16231 ci -q -u -i -t-"<initial description>" <file-name>
16234 \begin_layout Standard
16239 to understand the switches.
16243 \begin_layout Subsubsection
16249 \begin_layout Standard
16250 When you are finished editing a file, you check in your changes.
16251 When you do this, you are asked for a description of the changes.
16252 This is stored in the history log.
16253 The version number is bumped, your changes are applied to the master RCS
16254 file, the document is unlocked and set to Read-Only mode.
16258 \begin_layout Standard
16261 ci -q -u -m"<description>" <file-name>
16264 \begin_layout Subsubsection
16270 \begin_layout Standard
16271 By doing this you lock the document so that only you can edit it.
16272 This will also make the document Read-Write only for you.
16273 You will usually continue editing for a while and when you are finished
16274 you check in your changes.
16275 The status line is changed to reflect that you have locked the file.
16279 \begin_layout Standard
16282 co -q -l <file-name>
16285 \begin_layout Subsubsection
16288 Revert To Last Version
16291 \begin_layout Standard
16292 This will discard all changes made to the document since the last check
16294 You get a warning before changes are discarded.
16297 \begin_layout Standard
16300 co -f -u<version> <file-name>
16303 \begin_layout Subsubsection
16309 \begin_layout Standard
16310 This makes as if the last check in never happened.
16311 No changes are made to the document loaded into LyX, but the last version
16312 is removed from the master RCS file.
16316 \begin_layout Standard
16319 rcs -o<version> <file-name>
16322 \begin_layout Subsubsection
16328 \begin_layout Standard
16329 This show the complete history of the RCS document.
16334 is shown in a browser.
16342 \begin_layout Section
16343 Literate Programming
16346 \begin_layout Standard
16351 (kayvan@sylvan.com)
16355 original documentation written by
16357 Edmar Wienskoski Jr.
16360 (edmar-w-jr@technologist.com)
16363 \begin_layout Subsection
16367 \begin_layout Standard
16368 The main purpose of this documentation is to show you how to use LyX for
16369 literate programming.
16370 Where it is assumed that you are familiar with this programming technique,
16372 \begin_inset Quotes eld
16376 \begin_inset Quotes erd
16380 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16388 If that is not the case, please follow the web links provided in the following
16390 There is a lot of good documentation out there covering old development
16391 history to the latest tools tips.
16394 \begin_layout Standard
16395 It is also assumed that you are familiar with LyX itself to a point that
16396 you are comfortable changing your LyX preferences, and X resources file.
16397 If that is not the case please refer to other LyX documentation to cover
16398 your specific needs.
16401 \begin_layout Subsection
16402 Literate Programming
16405 \begin_layout Standard
16406 From the Literate Programming FAQ:
16409 \begin_layout Quotation
16410 Literate programming is the combination of documentation and source together
16411 in a fashion suited for reading by human beings.
16412 In fact, literate programs should be enjoyable reading, even inviting!
16413 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16414 and documentation in a single file.
16415 Literate programming tools then parse the file to produce either readable
16416 documentation or compilable source.
16417 The WEB style of literate programming was created by D.E.
16418 Knuth during the development of his TeX typesetting software.
16422 \begin_layout Standard
16423 Another excerpt says:
16426 \begin_layout Quotation
16429 How is literate programming different from verbose commenting?
16432 \begin_layout Quotation
16433 There are three distinguishing characteristics.
16434 In order of importance, they are:
16438 \begin_layout Itemize
16439 flexible order of elaboration
16442 \begin_layout Itemize
16443 automatic support for browsing
16446 \begin_layout Itemize
16447 typeset documentation, especially diagrams and mathematics
16451 \begin_layout Standard
16452 Now that I sparked your curiosity, take a look in the references.
16455 \begin_layout Subsubsection
16459 \begin_layout Standard
16460 The complete Literate Programming FAQ can be found at:
16463 \begin_layout Quote
16464 Literate Programming FAQ
16465 \begin_inset Flex URL
16468 \begin_layout Plain Layout
16470 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16478 \begin_layout Standard
16479 The FAQ lists 23 (twenty three!) different literate programming tools.
16480 Where some are specialized or
16481 \begin_inset Quotes eld
16485 \begin_inset Quotes erd
16488 for particular programming languages, while other have general scope.
16493 for my own use for several reasons:
16496 \begin_layout Itemize
16497 It can generate the documentation either in LaTeX or HTML.
16500 \begin_layout Itemize
16501 It has a open architecture, i.e., it is easy to plug in new filters and to
16502 perform special processing that you may need.
16506 \begin_layout Itemize
16507 There is a good selection of filters available already (the HTML is one
16511 \begin_layout Itemize
16515 \begin_layout Standard
16516 The Noweb web page can be found at:
16519 \begin_layout Quote
16521 \begin_inset Flex URL
16524 \begin_layout Plain Layout
16526 http://www.cs.virginia.edu/~nr/noweb/
16534 \begin_layout Standard
16535 Starting from there you can reach many other interesting links and even
16536 some literate program examples.
16539 \begin_layout Subsection
16540 \begin_inset CommandInset label
16542 name "sub:LyX-and-Literate"
16546 LyX and Literate Programming
16549 \begin_layout Standard
16550 The LyX support for Literate Programming is provided by using the generic
16551 LyX convertors mechanism.
16552 This support is provided in a
16553 \begin_inset Quotes eld
16557 \begin_inset Quotes erd
16560 way, i.e., you will be able to use this new LyX feature with some other literate
16561 programming tool of your choice by just changing your LyX preferences.
16564 \begin_layout Subsubsection
16565 Generating documents and code (weaving and tangling)
16568 \begin_layout Paragraph
16569 Selecting the document class
16572 \begin_layout Standard
16573 If you have installed Noweb and LyX successfully, whenever you open a new
16574 document or try to change the document class of an existing one, you will
16575 find that there are three new document classes available:
16578 \begin_layout Itemize
16582 \begin_layout Itemize
16586 \begin_layout Itemize
16590 \begin_layout Standard
16591 You must select one of them to create your literate documents from.
16595 \begin_layout Standard
16596 Note that literate documents are not limited to these three classes.
16597 New classes can be generated from other styles like letter or in combination
16598 with other class variations like Article (AMS).
16599 If you have special needs that cannot be covered by one of the existing
16600 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16601 will arrange to insert a new entry, or teach you how to do it.
16605 \begin_layout Plain Layout
16606 It is very simple, it involves the creation of a file with four lines, and
16607 re-running of the auto configuration.
16612 Moreover, if you use a literate tool other than Noweb you may need to create
16613 a new set of document classes for it.
16616 \begin_layout Paragraph
16620 \begin_layout Standard
16621 LyX enables you to write code with a layout named
16629 \begin_layout Plain Layout
16630 The equivalent Noweb term is
16631 \begin_inset Quotes eld
16635 \begin_inset Quotes erd
16639 For historical reasons, I got used to the term
16640 \begin_inset Quotes eld
16644 \begin_inset Quotes erd
16647 introduced by other literate tool named Nuweb, which I used for many years
16648 before rendering myself to Noweb.
16653 Noweb delimits scraps like this:
16656 \begin_layout LyX-Code
16660 \begin_layout LyX-Code
16664 \begin_layout LyX-Code
16668 \begin_layout LyX-Code
16672 \begin_layout LyX-Code
16676 \begin_layout Standard
16677 The problem is that whatever is written in between the << and the
16681 must be taken literally, i.e., LyX should be prevented from making any special
16682 interpretation of what has been written.
16683 This is handled by a special layout named Scrap, that works like a normal
16684 paragraph but has a free spacing capability.
16687 \begin_layout Standard
16688 The down side of the Scrap paragraph layout is that consecutive paragraphs
16689 of code will be spaced with one empty line in the source code and also
16690 in the printed documentation.
16691 The work around is to enter each line of code within a single Scrap, with
16692 a newline (ctrl-return).
16693 The example above will look like this:
16697 \begin_layout Plain Layout
16698 If you have a printed version of this document you will not see any difference
16699 between the previous example and this one.
16707 \begin_layout LyX-Code
16709 \begin_inset Newline newline
16713 \begin_inset Newline newline
16717 \begin_inset Newline newline
16721 \begin_inset Newline newline
16727 \begin_layout Standard
16728 This layout works fine.
16729 The only real inconvenience is that you have to type ctrl-return instead
16734 \begin_layout Plain Layout
16735 It is in my list of
16736 \begin_inset Quotes eld
16740 \begin_inset Quotes erd
16751 \begin_layout Standard
16752 As a special note, you can also use the
16753 \begin_inset Quotes eld
16757 \begin_inset Quotes erd
16760 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16764 \begin_layout LyX-Code
16766 \begin_inset Newline newline
16769 def some_function(args):
16770 \begin_inset Newline newline
16773 "This is the doc string for this function."
16774 \begin_inset Newline newline
16777 print "My args: ", args
16780 \begin_layout LyX-Code
16781 @ %def some_function
16784 \begin_layout Standard
16785 For an example of this usage and the resulting cross-reference output, look
16786 at the Literate python program in
16788 LIBDIR/examples/listerrors.lyx
16790 which should make this all clear.
16793 \begin_layout Paragraph
16794 Generating the documentation
16797 \begin_layout Standard
16798 At this point you already have a new document file with a proper document
16799 class, and with some code and text on it.
16800 How do I print it? The answer is simple, you select
16805 iew\SpecialChar \menuseparator
16813 Just like you would do for a plain document.
16814 No special procedure is required.
16817 \begin_layout Standard
16818 To help orientate you, I will now explain what happens inside LyX:
16821 \begin_layout Enumerate
16827 pdate\SpecialChar \menuseparator
16834 menu option is chosen, a LaTeX file is generated.
16839 \begin_layout Standard
16840 If the document is of any literate class the generated file will be named
16841 with an extension name defined by the
16842 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16849 format (defined in the Preferences panel), otherwise the file will have
16858 \begin_layout Enumerate
16859 Note that the only difference so far is in the name of the file, no special
16860 processing is required by LyX.
16861 Given that you formatted the code using the Scrap layout that, by itself,
16862 takes care of the business.
16865 \begin_layout Enumerate
16866 If the document is of any literate class LyX will then use the internal
16867 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16871 \begin_layout Plain Layout
16872 The converters are defined in the
16877 ools\SpecialChar \menuseparator
16885 \begin_inset Quotes eld
16889 \begin_inset Quotes erd
16894 \begin_inset CommandInset ref
16896 reference "sub:converters"
16904 manual for general information about converters.
16909 to generate the LaTeX file.
16913 \begin_layout Standard
16914 Otherwise it will just skip this step.
16918 \begin_layout Enumerate
16919 Finally, LaTeX is invoked and the regular post processing continues as in
16923 \begin_layout Standard
16924 Independence from a particular
16925 \begin_inset Quotes eld
16929 \begin_inset Quotes erd
16932 is easily achieved by changing the commands that are run by the various
16936 \begin_layout Paragraph
16937 Generating the code
16940 \begin_layout Standard
16941 When the build menu option is chosen or the corresponding button in the
16942 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16943 Next, LyX invokes the
16948 This converter needs to be defined by the user and is not installed by
16949 default, though the Program format is.
16950 This converter (like any other converter) will have two parts:
16953 \begin_layout Enumerate
16954 The converter program itself.
16955 This program performs the conversion from the one format to the other (in
16956 this case, from the Noweb format to the Program pseudo-format).
16959 \begin_layout Enumerate
16960 The error log parser.
16961 This is a program whose sole purpose is to rewrite error messages in a
16962 format that LyX understands.
16963 This makes it possible for LyX to place error boxes in the right places
16964 in the file buffer.
16967 \begin_layout Standard
16968 The first part, the
16969 \begin_inset Quotes eld
16973 \begin_inset Quotes erd
16976 setting, should be set to
16977 \begin_inset Quotes eld
16985 \begin_inset Quotes erd
16989 This basically means that LyX will call
16990 \begin_inset Quotes eld
16994 \begin_inset Quotes erd
16997 (a program or script) with the name of the Noweb file (normally a file
16998 in the LyX temp directory).
17002 \begin_layout Standard
17003 This is an implementation of
17004 \begin_inset Quotes eld
17008 \begin_inset Quotes erd
17011 that you can place in a directory on your path:
17014 \begin_layout LyX-Code
17018 \begin_layout LyX-Code
17022 \begin_layout LyX-Code
17023 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17026 \begin_layout Standard
17027 The next part of the converter setting is the
17028 \begin_inset Quotes eld
17032 \begin_inset Quotes erd
17035 which is to be set to
17036 \begin_inset Quotes eld
17041 parselog=listerrors
17044 \begin_inset Quotes erd
17048 This will run any errors that are generated by the
17049 \begin_inset Quotes eld
17053 \begin_inset Quotes erd
17056 process through the
17057 \begin_inset Quotes eld
17061 \begin_inset Quotes erd
17067 \begin_layout Standard
17068 The converter code looks in
17076 then on the path for the
17077 \begin_inset Quotes eld
17081 \begin_inset Quotes erd
17087 \begin_layout Standard
17088 The build will normally take place in LyX's temporary directory, so the
17089 files produced by the conversion will be in that directory.
17090 LyX will copy out what it regards as the `main' file, but the
17094 conversion may produce several files, and so most of these would then be
17095 deleted when LyX was closed.
17096 The present solution is to use a `copier',
17100 \begin_layout Plain Layout
17102 \begin_inset CommandInset ref
17104 reference "sec:converters-etc"
17112 manual for information on these.
17121 script in its default mode, so that the entire contents of the temporary
17122 directory is copied.
17123 More will get copied than is needed, to be sure, but nothing will be lost.
17124 If, however, you know what extensions the generated files will have, this
17125 can be improved by using the
17134 This option takes a comma-separated list of extensions to copy.
17135 So, for example, if the conversion will generate only files with the extensions
17144 , then the correct definition would be:
17147 \begin_layout LyX-Code
17148 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17151 \begin_layout Standard
17152 The result will be that only files with these two extensions will be copied
17156 \begin_layout Paragraph
17157 Build instructions in the document
17160 \begin_layout Standard
17161 The last piece of the integration between LyX and noweb is the
17162 \begin_inset Quotes eld
17166 \begin_inset Quotes erd
17170 Generally, the instructions for building your program should be embedded
17171 in a scrap of its own.
17173 \begin_inset Quotes eld
17177 \begin_inset Quotes erd
17180 above uses the notangle command to look for this scrap (called
17181 \begin_inset Quotes eld
17185 \begin_inset Quotes erd
17188 ) and runs its contents through
17189 \begin_inset Quotes eld
17193 \begin_inset Quotes erd
17199 \begin_layout Standard
17200 Typically, such a scrap would look something like this:
17203 \begin_layout LyX-Code
17205 \begin_inset Newline newline
17209 \begin_inset Newline newline
17213 \begin_inset Newline newline
17216 if [ -z "${NOWEB_SOURCE}" ]
17217 \begin_inset Newline newline
17221 \begin_inset Newline newline
17224 NOWEB_SOURCE=myfile.nw
17225 \begin_inset Newline newline
17229 \begin_inset Newline newline
17233 code to extract files ...]
17234 \begin_inset Newline newline
17238 code to compile files ...]
17239 \begin_inset Newline newline
17245 \begin_layout Standard
17248 LIBDIR/examples/listerrors.lyx
17252 LIBDIR/examples/Literate.lyx
17254 which implement two versions of the
17255 \begin_inset Quotes eld
17259 \begin_inset Quotes erd
17262 program for some illustrations of how all of these pieces go together or
17265 LIBDIR/examples/noweb2lyx.lyx.
17268 Interestingly, these three files show off the language-indepence of the
17269 LyX literate programming support since they are written in Python, C and
17273 \begin_layout Subsubsection
17277 \begin_layout Standard
17278 All the Literate Programming support is configured by the
17283 ools\SpecialChar \menuseparator
17291 \begin_inset Quotes eld
17295 \begin_inset Quotes erd
17299 The important parts are:
17302 \begin_layout Description
17304 \begin_inset space ~
17308 \begin_inset Quotes eld
17312 \begin_inset Quotes erd
17316 \begin_inset space ~
17319 format Set up via the Formats tab, this is where the Noweb-specific pieces
17329 , the file extension is set to
17334 This tells LyX to create a file with a
17338 extension in the first step of the conversion process.
17341 \begin_layout Description
17343 \begin_inset space ~
17351 \begin_inset space ~
17354 format This is an empty format whose sole purpose is to be the endpoint
17355 of a conversion (which then allows us to set up a converter for it).
17358 \begin_layout Description
17367 This converter performs the
17368 \begin_inset Quotes eld
17372 \begin_inset Quotes erd
17375 of the literate document.
17376 For Noweb, it is set to
17377 \begin_inset Quotes eld
17382 noweave -delay -index $$i > $$o
17385 \begin_inset Quotes erd
17391 \begin_layout Description
17401 \begin_inset Quotes eld
17405 \begin_inset Quotes erd
17409 As stated above, the Converter is set to
17410 \begin_inset Quotes eld
17418 \begin_inset Quotes erd
17421 , with Flags set to
17422 \begin_inset Quotes eld
17427 originaldir,parselog=listerrors
17430 \begin_inset Quotes erd
17436 \begin_layout Subsubsection
17440 \begin_layout Standard
17441 There is also a new function implemented in the LyX server, the
17442 \begin_inset Quotes eld
17445 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17449 \begin_layout Standard
17450 When debugging code with ddd/gdb, it is possible to invoke a text editor
17451 at the current execution position with a single key stroke.
17452 The default ddd configuration for that is shift-ctrl-V.
17453 It happens that you can define the editor command line invocation in ddd
17459 dit\SpecialChar \menuseparator
17464 references\SpecialChar \menuseparator
17471 dialog and changing the "Edit Sources" entry.
17474 \begin_layout Standard
17475 I take advantage of the new created LyX server function and this ddd feature,
17477 \begin_inset Quotes eld
17481 \begin_inset Quotes erd
17487 \begin_layout LyX-Code
17488 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17491 \begin_layout Standard
17492 With this, whenever you are using ddd and find a point in the program that
17493 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17494 ddd you forward this information to LyX through the LyX server and then
17495 the LyX window will show the same file with the cursor at the same position
17496 ddd was pointing to.
17497 No more guessing or long scrolling to locate a point in the program back
17501 \begin_layout Standard
17502 Note however that you must enable the LyX server to get this feature working
17503 (it is disabled by default).
17504 You can enable it in
17516 ) by entering in the
17521 \begin_inset Quotes eld
17526 /home/<your-home-directory>/.lyx/lyxpipe
17529 \begin_inset Quotes erd
17535 \begin_layout Standard
17536 Read the LyX server documentation in the
17538 Customization Manual
17540 for further information.
17543 \begin_layout Subsubsection
17547 \begin_layout Standard
17548 There are six new buttons that can be added to your LyX toolbar.
17549 Five of these buttons are short cuts to layout styles:
17570 The last one is a short cut to the
17571 \begin_inset Quotes eld
17575 \begin_inset Quotes erd
17582 \begin_layout Standard
17583 LyX has a range of buttons that are available for tool bar customization.
17584 In my toolbar I like to combine the six short cuts above with two more:
17592 \SpecialChar \menuseparator
17600 \SpecialChar \menuseparator
17613 iew\SpecialChar \menuseparator
17621 Here is how it looks like:
17624 \begin_layout LyX-Code
17628 \begin_layout LyX-Code
17632 \begin_layout LyX-Code
17633 Icon "layout Standard"
17636 \begin_layout LyX-Code
17637 Icon "layout Section"
17640 \begin_layout LyX-Code
17641 Icon "layout LaTeX"
17644 \begin_layout LyX-Code
17645 Icon "layout LyX-Code"
17648 \begin_layout LyX-Code
17649 Icon "layout Scrap"
17652 \begin_layout LyX-Code
17656 \begin_layout LyX-Code
17660 \begin_layout LyX-Code
17661 Icon "buffer-typeset"
17664 \begin_layout LyX-Code
17665 Icon "build-program"
17668 \begin_layout LyX-Code
17672 \begin_layout LyX-Code
17676 \begin_layout LyX-Code
17680 \begin_layout LyX-Code
17684 \begin_layout LyX-Code
17688 \begin_layout Subsubsection
17689 Colors customization
17692 \begin_layout Standard
17693 There are a number of colors in LyX that can be customized in
17698 One of the things that bothers people is the LaTeX font color.
17699 The default color is red, since the scraps uses LaTeX font, and there is
17700 a lot of scraps in literate documents, you may get tired of seeing everything
17702 You can change it by going to the tabs
17711 \begin_layout Standard
17712 The next thing is the visible presence of the newline character in the screen.
17713 You can choose the color of this particular character and make it blend
17715 I recommend you choosing a color that is close to the background but not
17716 equal, that way you still can see it is there, but it is not bothering
17721 \begin_layout Chapter
17722 Secrets of the LaTeX Masters
17723 \begin_inset CommandInset label
17732 \begin_layout Standard
17733 Though LyX is a powerful tool, it cannot hope to support everything that
17734 can be done with pure TeX/LaTeX.
17735 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17736 as long as you are not afraid to use that
17737 \begin_inset Quotes eld
17741 \begin_inset Quotes erd
17744 button on the toolbar or add things to the LaTeX preamble.
17745 This section lists some tips, tricks, and otherwise cool ideas to give
17746 your document that extra little flair.
17749 Do try this at home
17751 , just start with something a little smaller and less important than your
17755 \begin_layout Standard
17756 Most ideas in this section require less common files in your LaTeX installation.
17757 If you have a system like teTeX, most will already be available.
17758 A few, however, will need to be downloaded from one of the CTAN archives.
17759 Often, there are several ways to do something, or several LaTeX style files
17760 which do the same thing.
17761 We do not endorse one choice over another, we simply claim that we have
17762 done a particular task with a particular file.
17763 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17766 \begin_layout Section
17770 \begin_layout Standard
17773 Lars Gullik Bjønnes
17776 \begin_layout Subsection
17780 \begin_layout Standard
17781 The aim for this chapter
17785 \begin_layout Plain Layout
17786 Editor's note: Lars' original chapter was a masterful description of how
17792 However, it was too long to flow smoothly in this document.
17793 I have therefore chosen to excerpt the most important sections here (sorry,
17794 Lars); you can read the original chapter (and more of the story!) in the
17797 examples/multicol.lyx
17805 is to show how the LaTeX package
17809 can be used in a LyX document.
17810 As LyX doesn't support the
17814 package natively yet, we have to use some small hacks.
17815 By reading this section it should be obvious how to do this.
17818 \begin_layout Subsection
17822 \begin_layout Standard
17827 package allows switching between one and multicolumn format on the same
17829 Footnotes are handled correctly (for the most part), but will be placed
17830 at the bottom of the page and not under each column.
17831 LaTeX's float mechanism, however, is partly disabled in the current implementat
17833 At the moment only page-wide floats can be used within the scope of the
17837 \begin_layout Subsection
17841 \begin_layout Subsubsection
17845 \begin_layout Standard
17846 If you want to have two columns in your text, you have use LaTeX mode to
17851 begin{multicols}{2}
17853 at the point where you want the two column layout to start, and then
17859 where you want it to end.
17863 \begin_layout Standard
17867 \begin_layout Plain Layout
17871 begin{multicols}{2}
17879 \begin_layout Standard
17884 The Adventure of the Empty House
17887 \begin_inset Newline newline
17892 Sir Arthur Conan Doyle
17895 \begin_layout Standard
17898 It was in the spring of the year 1894 that all London was interested, and
17899 the fashionable world dismayed, by the murder of the Honourable Ronald
17900 Adair under most unusual and inexplicable circumstances.
17901 The public has already learned those particulars of the crime which came
17902 out in the police investigation, but a good deal was suppressed upon that
17903 occasion, since the case for the prosecution was so overwhelmingly strong
17904 that it was not necessary to bring forward all the facts.
17905 Only now, at the end of nearly ten years, am I allowed to supply those
17906 missing links which make up the whole of that remarkable chain.
17907 The crime was of interest in itself, but that interest was as nothing to
17908 me compared to the inconceivable sequel, which afforded me the greatest
17909 shock and surprise of any event in my adventurous life.
17910 Even now, after this long interval, I find myself thrilling as I think
17911 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17912 ty which utterly submerged my mind.
17913 Let me say to that public, which has shown some interest in those glimpses
17914 which I have occasionally given them of the thoughts and actions of a very
17915 remarkable man, that they are not to blame me if I have not shared my knowledge
17916 with them, for I should have considered it my first duty to do so, had
17917 I not been barred by a positive prohibition from his own lips, which was
17918 only withdrawn upon the third of last month.
17921 \begin_layout Standard
17925 \begin_layout Plain Layout
17937 \begin_layout Subsubsection
17941 \begin_layout Standard
17942 The same pattern is used when you want more than two columns:
17945 \begin_layout Standard
17949 \begin_layout Plain Layout
17953 begin{multicols}{3}
17961 \begin_layout Standard
17964 It can be imagined that my close intimacy with Sherlock Holmes had interested
17965 me deeply in crime, and that after his disappearance I never failed to
17966 read with care the various problems which came before the public.
17967 And I even attempted, more than once, for my own private satisfaction,
17968 to employ his methods in their solution, though with indifferent success.
17969 There was none, however, which appealed to me like this tragedy of Ronald
17971 As I read the evidence at the inquest, which led up to a verdict of willful
17972 murder against some person or persons unknown, I realized more clearly
17973 than I had ever done the loss which the community had sustained by the
17974 death of Sherlock Holmes.
17975 There were points about this strange business which would, I was sure,
17976 have specially appealed to him, and the efforts of the police would have
17977 been supplemented, or more probably anticipated, by the trained observation
17978 and the alert mind of the first criminal agent in Europe.
17979 All day, as I drove upon my round, I turned over the case in my mind and
17980 found no explanation which appeared to me to be adequate.
17981 At the risk of telling a twice-told tale, I will recapitulate the facts
17982 as they were known to the public at the conclusion of the inquest.
17985 \begin_layout Standard
17989 \begin_layout Plain Layout
18001 \begin_layout Standard
18002 You can have more than 3 columns if you want to, but that might not be very
18003 pleasant for the eye.
18006 \begin_layout Subsubsection
18007 Columns inside columns
18010 \begin_layout Standard
18011 You can even have columns inside columns:
18014 \begin_layout Standard
18018 \begin_layout Plain Layout
18022 begin{multicols}{2}
18030 \begin_layout Standard
18033 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18034 at that time governor of one of the Australian colonies.
18035 Adair's mother had returned from Australia to undergo the operation for
18036 cataract, and she, her son Ronald, and her daughter Hilda were living together
18040 \begin_layout Standard
18044 \begin_layout Plain Layout
18048 begin{multicols}{2}
18056 \begin_layout Standard
18059 The youth moved in the best society--had, so far as was known, no enemies
18060 and no particular vices.
18061 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18062 had been broken off by mutual consent some months before, and there was
18063 no sign that it had left any very profound feeling behind it.
18064 For the rest {sic} the man's life moved in a narrow and conventional circle,
18065 for his habits were quiet and his nature unemotional.
18066 Yet it was upon this easy-going young aristocrat that death came, in most
18067 strange and unexpected form, between the hours of ten and eleven-twenty
18068 on the night of March 30, 1894.
18071 \begin_layout Standard
18075 \begin_layout Plain Layout
18087 \begin_layout Standard
18090 Ronald Adair was fond of cards--playing continually, but never for such
18091 stakes as would hurt him.
18092 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18093 It was shown that, after dinner on the day of his death, he had played
18094 a rubber of whist at the latter club.
18095 He had also played there in the afternoon.
18100 The evidence of those who had played with him-- Mr.
18101 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18102 and that there was a fairly equal fall of the cards.
18103 Adair might have lost five pounds, but not more.
18104 His fortune was a considerable one, and such a loss could not in any way
18106 He had played nearly every day at one club or other, but he was a cautious
18107 player, and usually rose a winner.
18108 It came out in evidence that, in partnership with Colonel Moran, he had
18109 actually won as much as four hundred and twenty pounds in a sitting, some
18110 weeks before, from Godfrey Milner and Lord Balmoral.
18111 So much for his recent history as it came out at the inquest.
18114 \begin_layout Standard
18118 \begin_layout Plain Layout
18130 \begin_layout Standard
18131 Please do read the file
18133 examples/multicol.lyx
18135 for more advanced examples including column and header spacing, vertical
18136 separator lines, and more.
18139 \begin_layout Section
18144 Paragraph Environment
18145 \begin_inset OptArg
18148 \begin_layout Plain Layout
18149 Numbering in Enumerate
18157 \begin_layout Standard
18163 \begin_layout Standard
18164 \begin_inset VSpace bigskip
18170 \begin_layout Standard
18172 The default numbering for the
18176 paragraph environment begins with Arabic numbers and ends with uppercase
18178 Suppose, however, you wanted a different type of numbering scheme.
18179 Here's a quickie example of how to change the numbering scheme:
18182 \begin_layout LyX-Code
18192 \begin_layout LyX-Code
18202 \begin_layout LyX-Code
18212 \begin_layout LyX-Code
18222 \begin_layout Standard
18223 \SpecialChar \ldots{}
18224 which changes the numbering scheme to uppercase Roman numerals, uppercase
18225 letters, Arabic numbers, and lowercase letter.
18228 \begin_layout Standard
18229 Additionally, the previous example also adds a little bit extra to the numbering
18231 For example, the first level label actually looks like:
18232 \begin_inset Quotes eld
18236 \begin_inset Quotes erd
18240 For ease of reading, we'll describe what the numbering schemes look like
18241 using a notation something like this: <
18242 \begin_inset Quotes eld
18246 \begin_inset Quotes erd
18250 \begin_inset space ~
18254 \begin_inset Quotes erd
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 eld
18282 \begin_inset Quotes erd
18289 \begin_layout Standard
18290 As you can see in the example, there is a label command for each nesting
18297 \SpecialChar \ldots{}
18304 , as well as a counter,
18308 \SpecialChar \ldots{}
18314 There are also five
18315 \begin_inset Quotes eld
18319 \begin_inset Quotes erd
18352 , each of which take one counter as an argument.
18353 You can add characters before or after these, but there's no need to add
18357 \begin_layout Standard
18358 You can get really fancy with these.
18362 \begin_layout LyX-Code
18376 \begin_layout LyX-Code
18388 \begin_layout LyX-Code
18398 \begin_layout LyX-Code
18408 \begin_layout Standard
18409 produces the somewhat out of hand numbering scheme: <
18410 \begin_inset Quotes eld
18414 \begin_inset Quotes erd
18418 \begin_inset space ~
18422 \begin_inset Quotes erd
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 eld
18450 \begin_inset Quotes erd
18457 \begin_layout Standard
18461 \begin_layout Section
18465 \begin_layout Standard
18471 \begin_layout Standard
18472 \begin_inset VSpace bigskip
18478 \begin_layout Standard
18483 \begin_layout Plain Layout
18489 tmpfont}{cmr17 scaled 2500}{
18501 \begin_layout Standard
18506 \begin_layout Plain Layout
18517 hose of you who like the style of old books probably also like
18518 \begin_inset Quotes eld
18522 \begin_inset Quotes erd
18525 ---those large capital letters which begin each new chapter or section.
18526 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18527 know some plain TeX!) but does require a lot of work and many iterations,
18528 as you can see by all the ugly TeX-mode stuff at the beginning of this
18532 \begin_layout Standard
18536 \begin_layout Plain Layout
18542 bigdrop{-1em}{3}{ptmri}{T}+
18547 here is a much easier way of doing this, of course.
18556 ) package from CTAN allows a simple way to add such letters to your documents.
18557 Since this package is not a standard part of teTeX, I can't demonstrate
18558 it within this document, but if you copy this paragraph to a new document,
18560 \begin_inset Quotes eld
18570 \begin_inset Quotes erd
18573 and the pluses from the TeX code at the beginning of the paragraph, and
18578 usepackage{dropcaps}
18580 to your LaTeX preamble, you will get a nice Times Roman Italic
18581 \begin_inset Quotes eld
18585 \begin_inset Quotes erd
18588 , whose height is three lines of text and which protrudes 1 em into the
18590 (Make certain you have copied
18591 \begin_inset Quotes eld
18599 \begin_inset Quotes erd
18602 into a directory where TeX can see it.) The first argument is the amount
18603 of indentation; in this case the negative sign moves it into the margin.
18604 The second argument is the height of the letter in number of lines of text.
18605 The third argument is the font name: virtually anything which has a tfm
18606 file should work (wade through the
18608 .../texmf/fonts/tfm
18610 directory for possibilities).
18611 My personal favorite is
18612 \begin_inset Quotes eld
18620 \begin_inset Quotes erd
18623 , a fancy German font specifically designed for dropped capitals.
18624 The fourth argument is the letter (or letters) to be dropped.
18629 package also offers the
18635 command, as well as a slightly simplified
18644 \begin_layout Section
18645 Non-standard Paragraph Shapes
18648 \begin_layout Standard
18654 \begin_layout Standard
18655 \begin_inset VSpace bigskip
18661 \begin_layout Standard
18665 \begin_layout Plain Layout
18677 \begin_layout Standard
18681 \begin_layout Plain Layout
18690 \begin_layout Plain Layout
18704 \begin_layout Standard
18709 \begin_layout Plain Layout
18720 \begin_layout Plain Layout
18729 \begin_layout Plain Layout
18738 \begin_layout Plain Layout
18747 \begin_layout Plain Layout
18756 \begin_layout Plain Layout
18765 \begin_layout Plain Layout
18774 \begin_layout Plain Layout
18783 \begin_layout Plain Layout
18792 \begin_layout Plain Layout
18801 \begin_layout Plain Layout
18810 \begin_layout Plain Layout
18819 \begin_layout Plain Layout
18828 \begin_layout Plain Layout
18837 \begin_layout Plain Layout
18846 \begin_layout Plain Layout
18855 \begin_layout Plain Layout
18864 \begin_layout Plain Layout
18873 \begin_layout Plain Layout
18882 \begin_layout Plain Layout
18888 There are times when the tyranny of rectangular paragraphs must be overthrown.
18889 In such situations, a call to the delightful plain TeX command
18896 As you can see, completely arbitrary shapes can be laid out with a suitable
18897 set of linelength definitions.
18898 While this parshape may look a bit silly and useless, one could conceive
18899 of situations such as finely tuned dropped capitals, word wrapping around
18900 non-rectangular graphics, etc.
18901 which will benefit from such handcrafting.
18904 \begin_layout Standard
18905 \begin_inset VSpace bigskip
18911 \begin_layout Standard
18916 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18923 is the number of lines of text which define the paragraph.
18924 If there turn out to be fewer lines, the shape is truncated; if there are
18925 more, the excess lines have the same dimensions as the last line of the
18935 entries specify the indentation of the line from the left margin, and the
18936 length of the line as measured from that point.
18937 The shape applies only to the current paragraph; everything is reset to
18938 normal for the next paragraph.
18941 \begin_layout Standard
18945 \begin_layout Plain Layout
18957 \begin_layout Section
18961 \begin_layout Standard
18962 As you can see, the examples in this section range from the useful to the
18964 While I don't expect that anyone will ever need the paragraph shape demonstrate
18965 d in the last section, the important point is that you can do almost anything
18966 you want in LyX if you are willing to figure out how to do it in TeX and
18968 TeX is a fantastically powerful typesetting system and all that power is
18969 available to you since LyX uses it as its backend.