1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16 {\usepackage{lmodern}}{}
18 % link all cross references and URLs
20 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, bookmarksopen, bookmarksopenlevel=1,
21 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
22 pdfpagelayout=OneColumn, pdfnewwindow=true,
23 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
24 pdfauthor={LyX Team}, pdftex,
25 pdftitle={LyX's Extended manual},
26 pdfsubject={LyX's extended documentation},
27 pdfkeywords={LyX, Documentation, Extended}]{hyperref}
29 \else % if dvi or ps is produced
31 % link all cross references and URLs in DVI output
32 \usepackage[ps2pdf, colorlinks=true,
33 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue]{hyperref}
35 \fi % end if pdflatex is used
37 % redefine the \LyX macro for PDF bookmarks
38 \def\LyX{\texorpdfstring{%
39 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
51 \font_typewriter default
52 \font_default_family default
58 \paperfontsize default
67 \paperorientation portrait
70 \paragraph_separation indent
72 \quotes_language english
75 \paperpagestyle headings
76 \tracking_changes false
80 \extra_embedded_files ""
94 \begin_layout Plain Layout
96 Principal maintainer of this file is
101 If you have comments or error corrections, please send them to the LyX
102 Documentation mailing list, <lyx-docs@lists.lyx.org>.
110 \begin_layout Standard
111 \begin_inset CommandInset toc
112 LatexCommand tableofcontents
119 \begin_layout Chapter
123 \begin_layout Standard
126 Extended LyX Features
128 manual, which you are now reading, is essentially Part II of the
130 User's Guide\SpecialChar \@.
133 The reason for splitting this document is simple: the
137 is already huge, and it contains all of the basic features one needs to
138 know in order to prepare most documents.
139 However, the LyX Team has a long-term goal of making LyX extensible through
140 various configuration files and external packages.
141 That means that if you want to support the Fizzwizzle LaTeX package, you
142 can create a layout file for it without having to alter LyX itself.
143 We've already had contributions of several new features this way.
144 This is the place where all of that gets documented.
147 \begin_layout Standard
148 This manual also documents some special features, like fax support, version
149 control, and SGML support, which require additional software to work properly.
150 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
151 spruce up your documents by directly using the powerful features of LaTeX.
156 only WYSIWYM, and will only ever interface to certain LaTeX features.
159 \begin_layout Standard
160 Of course, with all of this extra documentation,
162 Extended LyX Features
164 may itself grow too big for its britches.
165 In that case, you can just call it the
166 \begin_inset Quotes eld
170 \begin_inset Quotes erd
176 \begin_layout Standard
177 If you haven't read the
181 yet, you are definitely in the wrong manual.
186 is the first place to go, since it will direct you to the correct manual,
187 and it also describes the notation and format of all of the manuals.
188 You should also be thoroughly familiar with the
192 and all of the basic features of LyX.
196 \begin_layout Standard
197 In this document, many sections are independent articles contributed by
198 an individual and are noted as such.
199 This person is generally whoever wrote the layout file for the new document
200 class or LaTeX package, or implemented the feature.
201 If there is no mention of an author to a chapter [or chapter sections],
202 that means it was written by the LyX Documentation Team.
205 \begin_layout Standard
206 Since all the topics in this manual depend heavily on LyX's interaction
207 with LaTeX, this first chapter covers the inner workings of LyX and how
208 to direct LyX to generate exactly the LaTeX code you want.
209 It is obviously for more seasoned LyX users.
212 \begin_layout Chapter
216 \begin_layout Section
220 \begin_layout Standard
221 \begin_inset CommandInset label
223 name "sec:lyxandlatex"
227 This chapter is for both TeX-nicians and the LaTeX-curious.
228 In it, we'll explain how LyX and LaTeX work together to produce printable
230 This is the only place in any of the manuals where we assume you know something
234 \begin_layout Standard
235 At one time, we called LyX a
236 \begin_inset Quotes eld
239 WYSIWYM frontend to LaTeX,
240 \begin_inset Quotes erd
243 but that's no longer true.
244 There are frontends to LaTeX out there.
245 They are basically editors with the ability to run LaTeX and mark any errors
246 in the file you're editing.
255 run LaTeX, and it also marks errors in the file, it also does much, much
257 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
258 LyX has also added a few extensions to LaTeX.
259 Try the following sometime: select
261 Export\SpecialChar \menuseparator
271 menu, then look at the preamble of the resulting
276 You'll notice a variety of new macros defined specifically by LyX.
277 These macros are defined automatically, according to the features you use
281 \begin_layout Standard
282 There are several commands that automatically invoke LaTeX.
286 \begin_layout Itemize
292 iew\SpecialChar \menuseparator
302 \begin_layout Itemize
308 iew\SpecialChar \menuseparator
313 pdate\SpecialChar \menuseparator
319 \begin_layout Itemize
327 \SpecialChar \menuseparator
333 \begin_layout Itemize
341 \SpecialChar \menuseparator
347 \begin_layout Standard
348 They will only invoke LaTeX if the file has changed since the last time
353 \begin_layout Standard
354 When you run LaTeX on the file you're editing, LyX performs these steps:
357 \begin_layout Enumerate
358 Convert the document to LaTeX and save to a file with the extension
369 \begin_layout Enumerate
374 file (maybe several times).
377 \begin_layout Enumerate
378 If there are any errors, insert error boxes in the document to mark where
380 These boxes are transient and are not saved along with the document.
383 \begin_layout Standard
384 If you've run LaTeX using
412 , LyX performs two more steps:
415 \begin_layout Itemize
420 to convert the DVI file to PostScript:
424 \begin_layout Itemize
433 , the output file has the extension
438 \begin_layout Itemize
450 , the output file has the extension
458 \begin_layout Itemize
463 or send the PostScript file to the printer.
466 \begin_layout Section
467 \begin_inset Quotes eld
470 Help! LyX generated an unreadable
475 \begin_inset Quotes erd
481 \begin_layout Standard
482 Die-hard LaTeX users will scream and howl this into the night, then declare
483 LyX useless, simply because they didn't RTFM.
486 \begin_layout Standard
487 We're going to set the record straight.
488 LyX produces two kinds of LaTeX files.
489 One is human readable.
490 The other is LyX readable.
491 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
497 file is not human readable.
498 Don't even try to read it.
503 file that you can send to a colleague, select
508 xport\SpecialChar \menuseparator
525 \begin_layout Section
526 Translating LaTeX files into LyX
527 \begin_inset CommandInset label
529 name "sec:Translating-LaTeX-files"
536 \begin_layout Standard
537 You can import a LaTeX file into LyX by using the
542 ile\SpecialChar \menuseparator
547 mport\SpecialChar \menuseparator
555 This will call a program named
559 ---which will create a file
567 ---and then open that file.
570 \begin_layout Standard
575 will translate most legal LaTeX, but not everything.
576 It will leave things it doesn't understand in TeX mode, so after translating
581 , you can look for red text and hand-edit it to look right.
584 \begin_layout Standard
585 If you just want to put a piece of LaTeX code into a LyX file, see Section
590 \begin_inset CommandInset ref
592 reference "sec:latexcodes"
599 \begin_layout Section
600 Inserting LaTeX Code into LyX Documents
601 \begin_inset CommandInset label
603 name "sec:Inserting-LaTeX-Code"
610 \begin_layout Standard
611 \begin_inset CommandInset label
613 name "sec:latexcodes"
617 This is a rather important point: You can always insert LaTeX code into
619 LyX simply cannot, and will probably never be able to, display every possible
621 If ever you need to insert LaTeX commands into your LyX document, you can
622 use the ERT box, which you can insert into your document with
627 nsert\SpecialChar \menuseparator
635 The ERT box comes in three forms: collapsed, open, and inlined.
636 The first two are used just like any other collapsible (foldable) box (such
637 as footnotes), and are useful for significant amounts of LaTeX commands.
639 \begin_inset Quotes eld
643 \begin_inset Quotes erd
646 ERT box displays its content as part of the button, and is useful for very
647 short sections of LaTeX commands.
652 \begin_layout Plain Layout
662 \begin_layout Standard
663 You can switch between all three by right-clicking on the ERT.
664 Note that if you want more than one line of LaTeX commands, you cannot
665 use the inlined mode.
668 \begin_layout Standard
669 Here's an example of inserting LaTeX commands in a LyX document.
670 The code looks like this:
673 \begin_layout LyX-Code
677 \begin_inset Newline newline
683 \begin_inset Newline newline
686 This is an example for a minipage environment.
688 \begin_inset Newline newline
691 can put nearly everything in it, even (non-floating)
692 \begin_inset Newline newline
697 \begin_inset Newline newline
703 \begin_inset Newline newline
707 \begin_inset Newline newline
713 \begin_inset Newline newline
719 \begin_inset Newline newline
725 \begin_inset Newline newline
730 \begin_inset Newline newline
736 \begin_inset Newline newline
742 \begin_inset Newline newline
748 \begin_inset Newline newline
756 \begin_layout LyX-Code
760 \begin_layout Standard
761 The ERT box containing this text is directly after this paragraph.
762 Those of you reading the manual online will only see a bunch of funky text
764 Those reading a printed version of the manuals will see the actual results:
767 \begin_layout Standard
771 \begin_layout Plain Layout
778 \begin_layout Plain Layout
785 \begin_layout Plain Layout
787 This is an example for a minipage environment.
788 You can put nearly everything in it, even (non-floating) figures and tables.
792 \begin_layout Plain Layout
799 \begin_layout Plain Layout
804 \begin_layout Plain Layout
811 \begin_layout Plain Layout
818 \begin_layout Plain Layout
825 \begin_layout Plain Layout
831 \begin_layout Plain Layout
838 \begin_layout Plain Layout
845 \begin_layout Plain Layout
852 \begin_layout Plain Layout
864 \begin_layout Standard
865 In addition to these two methods, you can also create a separate file containing
866 some complex LaTeX structure.
872 nsert\SpecialChar \menuseparator
883 to include your file (you should select the type
888 We recommend that you only do this if you have a
897 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
901 \begin_layout Standard
902 There are a few last notes to emphasize:
905 \begin_layout Itemize
906 Inside of LyX, LaTeX code appears
911 \begin_layout Itemize
916 check if your LaTeX code is correct.
919 \begin_layout Itemize
920 Beware reinventing the wheel.
923 \begin_layout Standard
924 That last note refers to two things.
925 First, LyX does have quite a few features tucked into it, and more are
927 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
928 feature before you go off merrily coding LaTeX.
929 Second, there are numerous LaTeX packages out there to do all sorts of
930 things, from labels to envelopes to fancy multipage tables.
931 Check out a CTAN site for details (see Section
932 \begin_inset Quotes eld
936 \begin_inset Quotes erd
947 \begin_layout Plain Layout
952 : I seem to do this an awful lot.
953 Sat down and merrily began coding something to print out labels, only to
954 learn that there were already 2 different LaTeX packages to do this.
955 Worse yet --- I had them already!
963 \begin_layout Standard
964 If you do need to do some wild and fancy things within your document, be
965 sure to check out a good LaTeX book for assistance.
966 There are a number of them listed in the bibliography of the
973 \begin_layout Standard
974 There are a number of LaTeX commands which have to be placed before the
975 beginning of the actual text.
976 They go into the preamble, and this is explained in the next section.
979 \begin_layout Section
980 LyX and the LaTeX Preamble
983 \begin_layout Subsection
984 About the LaTeX Preamble
987 \begin_layout Standard
988 \begin_inset CommandInset label
994 If you already know LaTeX, there is no need to explain here what the preamble
996 If you don't, the following will give you some ideas --- we recommend again
997 that you consult a LaTeX book for further information.
998 In any case, you should read the points below, because they explain what
999 you can do and what you don't need to do in the LaTeX preamble of a LyX
1003 \begin_layout Standard
1004 The LaTeX preamble comes at the very beginning of a document,
1012 \begin_layout Itemize
1013 declare the document class.
1014 LyX already does this for you.
1018 \begin_layout Standard
1019 If you're a seasoned LaTeX-nician, and you have some custom document class
1020 you want to use, check out the
1022 Customization Manual
1024 for information on how to make LyX interface to it.
1025 Be sure to submit your efforts to the LyX Team for inclusion in future
1030 \begin_layout Itemize
1031 declare the usage of packages.
1032 LaTeX packages provide special commands, which are only available within
1033 a document when the package has been declared in the preamble.
1034 For example, the package
1038 forces all paragraphs to be indented.
1039 There are other packages for labels, envelopes, margins, etc.
1043 \begin_layout Itemize
1044 set counters, variables, lengths and widths.
1045 There are several LaTeX counters and variables which
1049 be set globally from within the preamble in order to have the desired effect.
1050 [There are other variables which you can set and reset inside the document,
1051 too.] Margins are a good example of something which must be set in the preamble.
1052 Another example is the label format for lists.
1053 You can actually set these just about anywhere, but it's best to do it
1054 just once, inside the preamble.
1057 \begin_layout Itemize
1058 declare user defined commands [with
1070 ], mostly abbreviations for LaTeX commands which appear very often inside
1072 Although the preamble is a good place to declare such commands, they
1076 be declared anywhere else [but
1080 they are used for the first time, of course\SpecialChar \ldots{}
1082 This can be useful if there is a lot of raw LaTeX code in your document,
1083 which normally should not be the case.
1086 \begin_layout Standard
1087 LyX adds its own set of definitions to the preamble of the
1092 This makes LaTeX files generated by LyX portable.
1095 \begin_layout Subsection
1096 Changing the Preamble
1099 \begin_layout Standard
1100 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1101 can't change them without patching LyX itself.
1102 You can, however, add your own stuff to the preamble.
1103 There are two ways to do this:
1106 \begin_layout Enumerate
1113 \begin_inset Space ~
1136 \SpecialChar \menuseparator
1144 dialog, depending on your frontend.
1145 Note that the LyX keybindings will not work in this dialog, alas.
1148 \begin_layout Enumerate
1149 Use the preamble contents you've added as your default template (see
1150 \begin_inset Quotes eld
1154 \begin_inset Quotes erd
1161 ), so that it will be the default preamble for any file you create.
1164 \begin_layout Standard
1165 LyX adds anything in the
1172 dialog to its own built-in preamble.
1173 Before adding your own declarations in the preamble, you should make sure
1174 that LyX doesn't already support what you want to do (remember what we
1175 said about reinventing the wheel?).
1178 make sure your preamble code is correct
1181 LyX doesn't check it.
1184 \begin_layout Subsection
1188 \begin_layout Standard
1189 Here are some examples of what you can add to a preamble, and what they
1193 \begin_layout Subsubsection
1197 \begin_layout Standard
1198 There are two variables under LaTeX that control page position:
1211 Their names should be self-explanatory.
1212 These variables are useful if you think for a moment about computer labels.
1213 Sometimes, the size of a print medium and the area of the medium that you
1214 can actually print on aren't the same.
1230 \begin_layout Standard
1231 The default values for
1244 \begin_inset Space ~
1248 \begin_inset Space ~
1252 \begin_inset Space ~
1255 the page isn't shifted.
1258 \begin_layout Standard
1259 Unfortunately, some DVI drivers always seem to shift the page.
1260 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1261 If you're using LyX on a system that you don't personally maintain, and
1262 your sysadmin is a doofus,
1275 Suppose you're left and top margins are always 0.5 inches too big.
1276 You can add this to the preamble:
1279 \begin_layout LyX-Code
1287 \begin_layout LyX-Code
1295 \begin_layout Standard
1296 \SpecialChar \ldots{}
1297 and your margins should now be correct.
1300 \begin_layout Subsubsection
1304 \begin_layout Standard
1305 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1306 There's a rather nice package, available at your nearest CTAN archive,
1307 for printing sheets of labels, called
1312 Now, your system may not have this package installed by default.
1313 We leave that up to you to check.
1314 You'll also want to read the documentation for it; we're not going to do
1316 Since this is an example, however, we'll give you an example of how you
1320 \begin_layout Standard
1321 First, make sure you're using the
1326 Next, you need to put the following in your preamble:
1329 \begin_layout LyX-Code
1335 \begin_layout LyX-Code
1341 \begin_layout LyX-Code
1347 \begin_layout LyX-Code
1353 \begin_layout LyX-Code
1359 \begin_layout LyX-Code
1365 \begin_layout LyX-Code
1371 \begin_layout Standard
1372 This sets things up for Avery® label sheets, stock #5360.
1373 You're now ready to print labels, but you'll need to insert LaTeX code,
1374 placing the commands
1386 around each label text.
1387 This and other special features of
1391 are explained in its documentation.
1394 \begin_layout Standard
1395 Someday, someone may write a LyX layout file to support this package directly.
1396 Maybe that someone is you.
1399 \begin_layout Subsubsection
1400 Example #3: Paragraph Indentation
1403 \begin_layout Standard
1404 Americans are trained to indent the first line of
1409 As with all of their other weird quirks, most Americans will whine and
1410 moan until they can have their way and indent the first line of all paragraphs.
1414 \begin_layout Plain Layout
1419 : This was written by an American ---
1423 ! It's my perception of my fellow countrymen.
1424 Tough if you don't like it.
1433 \begin_layout Standard
1434 Of course, this behavior isn't standard typography.
1435 In books, you typically only indent the first line of a paragraph
1439 it follows another one.
1440 The idea behind indenting the first line of a paragraph is to distinguish
1441 neighboring paragraphs from one another.
1442 If there is no previous paragraph, for example, it follows a figure, or
1443 is the first paragraph in a section, then there is no special indentation.
1447 \begin_layout Standard
1448 If you're a typical American, though, you don't care about such esoteric
1449 things; you want your indentation! Add this to the preamble:
1452 \begin_layout LyX-Code
1455 usepackage{indentfirst}
1458 \begin_layout Standard
1459 If your TeX distribution isn't a braindead one, you'll have this package,
1460 and all of your paragraphs will get the indentation you think they deserve.
1463 \begin_layout Subsubsection
1464 Example #4: This Document
1467 \begin_layout Standard
1468 You can also check out the preamble of this document to get an idea of some
1469 of the advanced things you can do.
1470 You'll probably need to make the
1475 reamble\SpecialChar \ldots{}
1478 dialog full-screen to see most of it.
1479 Also, there are more examples and an assortment of LaTeX
1480 \begin_inset Quotes eld
1484 \begin_inset Quotes erd
1488 \begin_inset Space ~
1492 \begin_inset CommandInset ref
1494 reference "cha:secrets"
1502 \begin_layout Section
1503 LyX and LaTeX Errors
1506 \begin_layout Standard
1507 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1509 It then uses the log-file from the LaTeX run to do a post-mortem.
1510 As we stated earlier in the chapter, LyX generates two kinds of
1514 files, one of which it uses to locate errors in the document.
1515 If there was an error someplace, LyX will put a box with the word
1516 \begin_inset Quotes eld
1520 \begin_inset Quotes erd
1523 at the appropriate place in the document.
1527 \begin_layout Plain Layout
1528 LyX will occasionally misguess where the error was.
1529 This will typically happen with tables, figures, math, and the preamble.
1534 It will also display a message alerting you to the fact that there were
1538 \begin_layout Standard
1539 You can navigate through the errors by using
1555 \begin_inset Quotes eld
1559 \begin_inset Quotes erd
1562 the error-boxes and view the error message LaTeX produced by clicking on
1566 \begin_layout Standard
1567 Some folks also like to look at the log file directly, accessible from
1572 ocument\SpecialChar \menuseparator
1578 \begin_inset Space ~
1582 \begin_inset Space ~
1588 There are some fairly common error messages and warnings.
1589 We'll cover those here.
1590 You should look at a good LaTeX book for a complete listing.
1593 \begin_layout Itemize
1594 \begin_inset Quotes eld
1602 \begin_inset Quotes eld
1609 \begin_layout Standard
1610 Anything beginning with these word is a warning message for the purpose
1612 \begin_inset Quotes eld
1616 \begin_inset Quotes erd
1619 the LaTeX code itself.
1620 You'll get messages like this if you added or changed cross-references
1621 or bibliography entries, in which case, LaTeX is trying to tell you that
1622 you need to make another run.
1625 \begin_layout Standard
1626 You can by-and-large ignore these.
1630 \begin_layout Itemize
1631 \begin_inset Quotes eld
1639 \begin_inset Quotes erd
1646 \begin_layout Standard
1647 Another warning message, this time about fonts which LaTeX couldn't find.
1648 The rest of the message will often say something about a replacement font
1652 \begin_layout Standard
1653 You can safely ignore these.
1657 \begin_layout Itemize
1658 \begin_inset Quotes eld
1668 \begin_inset Quotes erd
1675 \begin_layout Standard
1681 They are warning you about lines that were too long and run past the right
1683 Almost always, this is unnoticeable in the final output.
1684 Or, only one or two characters extend past the margin.
1685 LaTeX seems to generate at least one of these messages for just about any
1689 \begin_layout Standard
1690 You can ignore these stupid messages.
1691 Your eyes will tell you if there's a problem with something that's too
1692 wide; just look at the output.
1696 \begin_layout Itemize
1697 \begin_inset Quotes eld
1707 \begin_inset Quotes erd
1714 \begin_layout Standard
1715 Not quite as common as its cousin.
1716 LaTeX seems to like to print lines that are a bit too wide as opposed to
1717 ones that are a bit too narrow.
1718 We have no idea why.
1721 \begin_layout Standard
1722 You can ignore these, too.
1726 \begin_layout Itemize
1727 \begin_inset Quotes eld
1737 \begin_inset Quotes erd
1741 \begin_inset Quotes eld
1751 \begin_inset Quotes erd
1758 \begin_layout Standard
1759 Warnings about troubles breaking the page.
1760 Once again, just look at the output.
1761 Your eyes will tell you where something has gone wrong.
1765 \begin_layout Itemize
1766 \begin_inset Quotes eld
1772 \begin_inset Quotes els
1776 \begin_inset Quotes ers
1782 \begin_inset Quotes erd
1789 \begin_layout Standard
1791 \begin_inset Quotes eld
1795 \begin_inset Quotes erd
1798 isn't installed on this system.
1799 This usually appears because some package your document needs isn't installed.
1800 If you didn't touch the preamble or didn't use the
1806 command, then one of the packages LyX tried to load is missing.
1812 elp\SpecialChar \menuseparator
1819 , to get a list of packages that LyX knows about.
1820 This file is updated whenever you reconfigure LyX (using
1827 \SpecialChar \menuseparator
1832 ) and tells you which packages have been detected and what they do.
1835 \begin_layout Standard
1846 command, and the package in question isn't installed, you'll need to install
1851 \begin_layout Itemize
1852 \begin_inset Quotes eld
1857 LaTeX Error: Unknown option
1860 \begin_inset Quotes erd
1867 \begin_layout Standard
1868 Error messages beginning with this are trying to tell you that you specified
1869 a bad or undefined option to a package.
1870 Check the package's documentation.
1874 \begin_layout Itemize
1875 \begin_inset Quotes eld
1880 Undefined control sequence
1883 \begin_inset Quotes erd
1890 \begin_layout Standard
1891 If you've inserted LaTeX code into your document, but made a typo, you'll
1893 You may have forgotten to load a package.
1894 In any case, this error message usually means that you used an undefined
1899 \begin_layout Standard
1900 There are other error and warning messages.
1901 Some are self-explanatory.
1902 These are usually LaTeX messages.
1903 Others are downright cryptic.
1904 These are actually TeX error messages, and we really have
1908 what they mean or how to decipher them.
1911 \begin_layout Standard
1912 There's a general sequence you should follow if you get error messages:
1915 \begin_layout Enumerate
1916 Look at the LaTeX code you inserted for typos.
1919 \begin_layout Enumerate
1920 If there are no typos, check and see that you used the command(s) correctly.
1923 \begin_layout Enumerate
1924 If you get a bunch of error boxes piled up at the very top of the document,
1925 it means that there are errors in the preamble.
1926 Start debugging your preamble.
1929 \begin_layout Enumerate
1930 If you didn't add anything to the preamble and didn't add any LaTeX code
1931 to the document, the first suspect is your LaTeX distribution itself.
1932 Check for missing packages and install them.
1935 \begin_layout Enumerate
1936 Okay, so there are no missing packages.
1937 Did you use any of the fine-tuning options in LyX? Specifically, did you
1942 any of them, like trying to manually insert lots of
1945 \begin_inset Space ~
1958 s? Did you try to kludge something together with these instead of using
1959 the appropriate paragraph environment?
1962 \begin_layout Enumerate
1963 All right, you didn't use any of the fine-tuning options, you played by
1965 Did you try to pull a fancy maneuver? Did you do something funky inside
1966 a table or an equation, like inserting a graphic into a table cell?
1969 \begin_layout Enumerate
1970 Do you have long sections of text where LaTeX cannot find a place to break
1971 a line? By default, LaTeX is rather strict about how much extra inter-word
1972 spacing it will add in order to break a line.
1973 Preferably, you should rework the paragraph to avoid the problem.
1974 If this isn't an option, you can wrap your text in
1980 to make LaTeX's line breaking more, well, sloppy.
1983 \begin_layout Enumerate
1984 Did you go overboard with the nesting? LyX (currently) doesn't check to
1985 make sure you're in the limits for nesting environments.
1986 If you nested a bunch of environments to the
1987 \begin_inset Formula $17^{\mathrm{th}}$
1990 level, that's the problem.
1993 \begin_layout Enumerate
1994 Okay, you didn't get any error messages, but your output looks whacked.
1995 If you have a table or figure that's too wide or long for the page, you
2000 \begin_layout Enumerate
2001 rescale the figure so it fits.
2004 \begin_layout Enumerate
2005 trim down the table so it fits.
2008 \begin_layout Standard
2009 If something else is wrong with the output, and you didn't try to pull anything
2010 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2014 \begin_layout Standard
2015 If all this doesn't help --- well, then
2019 you might have found a bug in LyX\SpecialChar \ldots{}
2023 \begin_layout Chapter
2027 \begin_layout Section
2028 Preparing a Bibliography with BibTeX
2029 \begin_inset CommandInset label
2031 name "sec:Preparing-a-Bibliography"
2038 \begin_layout Standard
2045 Jürgen Spitzmüller
2048 \begin_layout Standard
2049 \begin_inset VSpace bigskip
2055 \begin_layout Standard
2057 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
2061 \begin_inset Space \thinspace{}
2067 \begin_inset Space ~
2070 setting up your own bibliographic databases),
2074 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2076 LaTeX: A Document Preparation System
2078 , particularly Appendix B.
2079 The rest of this discussion assumes you have created a correct bibliography
2080 file, that you have all relevant environment variables set correctly (esp.
2093 ), and that if sufficiently desperate, you could create and
2094 \begin_inset Quotes eld
2098 \begin_inset Quotes erd
2101 a LaTeX file with a BibTeX database.
2105 \begin_layout Standard
2106 For those who don't know what BibTeX is, it is a system for creating a large
2107 database of your most used journal references.
2108 For all future articles you write, you only need to include this standard
2109 database and reference the appropriate key to each reference.
2110 Even if you write only a few papers with handful of references each, it
2111 is well worth your time to examine BibTeX and decide whether it will be
2115 \begin_layout Standard
2116 To use BibTeX with LyX, first read the
2120 where it describes how to insert citations.
2121 The basic mechanism for inserting BibTeX references is the same.
2122 Then, at the very end of your document, select
2124 Insert\SpecialChar \menuseparator
2129 TOC\SpecialChar \menuseparator
2133 In the resulting dialog, fill out the dialog boxes as follows:
2136 \begin_layout Description
2137 Database: enter the name of your
2150 For searching multiple
2154 files, just enter them in the desired order, separated by commas.
2158 \begin_layout Description
2159 Style: enter the name of your BibTeX style file *without* the
2164 The default style is
2168 (which should be included in your LaTeX distribution, so you don't have
2169 to worry about creating it).
2172 \begin_layout Standard
2173 For each citation, assuming that the source is in the
2182 nsert\SpecialChar \menuseparator
2189 at the correct location in the text, and enter the appropriate reference
2191 Nothing else is required; when invoking
2196 iew\SpecialChar \menuseparator
2203 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2204 including multiple invocations of LaTeX.
2208 \begin_layout Subsection
2209 Alternative Citation Styles
2212 \begin_layout Standard
2213 Standard BibTeX uses numbers (e.
2214 \begin_inset Space \thinspace{}
2218 \begin_inset Space \space{}
2222 \begin_inset Quotes eld
2226 \begin_inset Quotes erd
2229 ) to refer to a cited work.
2230 However, in many scientific disciplines, other citation styles are in use.
2231 The most common one is the author-year style (e.
2232 \begin_inset Space \thinspace{}
2236 \begin_inset Space \space{}
2240 \begin_inset Quotes eld
2244 \begin_inset Quotes erd
2248 LyX supports two packages that provide this style,
2257 Both packages have their own pros and cons, which cannot be listed in detail.
2258 If you only want to have simple author-year (or author-numerical) style
2259 or if you want to use one of the countless style files for natbib, than
2264 package is probably your choice.
2265 If you need special features like short title references, ibidem etc., you
2266 might consider the fairly new
2273 \begin_layout Standard
2274 The handling of both packages in LyX is basically the same.
2280 ocument\SpecialChar \menuseparator
2291 pane (with the xforms frontend: the
2305 With both packages, you will get some extra features in the citation dialog
2306 and you can select the style of the reference (
2307 \begin_inset Quotes eld
2311 \begin_inset Quotes erd
2315 \begin_inset Quotes eld
2319 \begin_inset Quotes erd
2323 \begin_inset Quotes eld
2327 \begin_inset Quotes erd
2331 \begin_inset Quotes eld
2335 \begin_inset Quotes erd
2339 Note that both packages need specifically designed style files (they both
2340 ship their own, while there are lots of additional style files and even
2341 an interactive style file builder
2345 \begin_layout Plain Layout
2347 \begin_inset Flex URL
2350 \begin_layout Plain Layout
2352 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2369 \begin_layout Subsection
2370 Sectionated Bibliographies
2371 \begin_inset CommandInset label
2373 name "sub:Sectionated-Bibliographies"
2380 \begin_layout Standard
2381 Sometimes you might need to divide your bibliography into several sections.
2382 If you are, for instance, a historian, the possibility to separate sources
2383 and scientific works is most likely a
2384 \begin_inset Quotes eld
2388 \begin_inset Quotes erd
2392 Unfortunately, BibTeX itself does not allow you to do this.
2393 The good news is, though: With the help of some LaTeX packages, BibTeX
2394 can be extended to fit your historical needs.
2397 \begin_layout Standard
2398 As of version 1.4, LyX provides native support for one of these packages,
2407 \begin_layout Plain Layout
2409 \begin_inset Flex URL
2412 \begin_layout Plain Layout
2414 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2424 The advantage of this package (compared to other packages like
2428 ) is that you don't need to define new citation commands.
2429 Instead, you need to prepare different bibliographic databases which include
2430 the entries for the different sections of the bibliography.
2431 For example: If you want to divide your bibliography into the sections
2433 \begin_inset Quotes eld
2437 \begin_inset Quotes erd
2441 \begin_inset Quotes eld
2445 \begin_inset Quotes erd
2448 , you first need to create two bibliographic databases, e.
2449 \begin_inset Space \thinspace{}
2453 \begin_inset Space \space{}
2468 \begin_layout Standard
2474 ocument\SpecialChar \menuseparator
2485 pane (with the xforms frontend: the
2493 \begin_inset Space ~
2499 Now you can insert multiple BibTeX references (as described in section
2500 \begin_inset Space ~
2504 \begin_inset CommandInset ref
2506 reference "sec:Preparing-a-Bibliography"
2510 ), one for each section of your bibliography.
2511 Returning to our example: Insert a BibTeX reference for the database
2515 and a second one for the database
2520 You are free to use the same or different styles for each section.
2521 Additionally, you can chose if the bibliography section should contain
2523 \begin_inset Quotes eld
2526 all cited references
2527 \begin_inset Quotes erd
2530 of the specified database(s) (which is the default),
2531 \begin_inset Quotes eld
2534 all uncited references
2535 \begin_inset Quotes erd
2539 \begin_inset Quotes eld
2543 \begin_inset Quotes erd
2547 This might be useful if you would like to separate your bibliography into
2549 \begin_inset Quotes eld
2553 \begin_inset Quotes erd
2557 \begin_inset Quotes eld
2561 \begin_inset Quotes erd
2565 \begin_inset Quotes eld
2569 \begin_inset Quotes erd
2573 The titles for the sections can be added as ordinary sections or subsections.
2578 removes the bibliography title, you have manually re-add that, too (as
2579 a chapter* or section*, for instance).
2582 \begin_layout Subsection
2583 Multiple Bibliographies
2586 \begin_layout Standard
2587 Multiple bibliographies, e.
2588 \begin_inset Space \thinspace{}
2592 \begin_inset Space \space{}
2595 a bibliography for each section or chapter of the document, are not supported
2601 package, which is used for the creation of sectionated bibliographies in
2603 \begin_inset Space ~
2607 \begin_inset Space ~
2611 \begin_inset CommandInset ref
2613 reference "sub:Sectionated-Bibliographies"
2617 ), provides an easy way to solve this task, if you are willing to use some
2618 LaTeX-Code (ERT, cf.
2619 \begin_inset Space ~
2623 \begin_inset Space ~
2627 \begin_inset CommandInset ref
2629 reference "sec:Inserting-LaTeX-Code"
2637 \begin_layout Plain Layout
2638 An alternative approach is to use the
2646 package, respectively.
2654 \begin_layout Standard
2660 ocument\SpecialChar \menuseparator
2671 pane (with the xforms frontend: the
2679 \begin_inset Space ~
2685 In the document, you have to enclose the sections, which shall contain
2686 their own bibliography (including the BibTeX reference itself), between
2699 (those commands have to be inserted as ERT).
2700 The bibliography will contain all references which have been cited in the
2703 \begin_inset Space \thinspace{}
2706 B.: If you are using this approach, then
2710 citation reference has to be inside some btUnit.
2711 Also, the btUnits cannot be nested.
2714 \begin_layout Standard
2718 \begin_layout Section
2722 \begin_layout Subsection
2726 \begin_layout Standard
2727 When you are working on a large file with many sections, it is often convenient
2728 to break up the document into several files, or perhaps you have something
2729 where a table may change from time to time, but the preceding text does
2731 In these cases, you should seriously consider using multipart documents.
2732 For example, scientific papers often have five major sections: the introduction
2733 , observations, results, discussion, and conclusion.
2734 Each of these could be its own separate LyX file, with one
2735 \begin_inset Quotes eld
2739 \begin_inset Quotes erd
2742 file which contains the title, authors, abstract, references, etc., plus
2743 the five included files.
2744 It is important to note that each of these files is a full LyX file which
2745 can be formatted and printed on its own, as well as included in a master
2747 Each of these files must have the same document class, however--- don't
2748 attempt to mix book classes with article classes.
2749 You may also include LaTeX files; however, these files must not have their
2755 everything up to and including the
2767 line must be deleted) or else errors will be generated when you try to
2771 \begin_layout Standard
2772 LyX allows you to include files quite easily with
2777 nsert\SpecialChar \menuseparator
2783 \begin_inset Space ~
2789 When you click on this selection a small box is inserted into the file
2790 at the current cursor location.
2791 Clicking on the box raises a dialog which allows you to select the file
2792 to be included, and the method of its inclusion.
2796 \begin_layout Standard
2797 The file selection box should by now be obvious.
2798 The three inclusion methods are
2799 \begin_inset Quotes eld
2803 \begin_inset Quotes erd
2807 \begin_inset Quotes eld
2811 \begin_inset Quotes erd
2815 \begin_inset Quotes eld
2819 \begin_inset Quotes erd
2823 The difference between
2824 \begin_inset Quotes eld
2828 \begin_inset Quotes erd
2832 \begin_inset Quotes eld
2836 \begin_inset Quotes erd
2839 is really only meaningful to LaTeXperts, but the practical difference is
2840 that files which are
2841 \begin_inset Quotes eld
2845 \begin_inset Quotes erd
2848 are typeset beginning on a new page, while files which are
2849 \begin_inset Quotes eld
2853 \begin_inset Quotes erd
2856 are typeset starting on the current page.
2857 Perhaps the labeling in LyX will be changed someday to reflect this.
2860 \begin_layout Standard
2861 Generally, the master file is converted into a full LaTeX file before typesettin
2862 g, while the included files are converted to LaTeX files which do not have
2863 all the preamble information.
2869 \begin_inset Space ~
2876 button prevents this conversion.
2879 \begin_layout Standard
2881 \begin_inset Quotes eld
2885 \begin_inset Quotes erd
2888 included file allows you to include a file typeset exactly as it appears
2890 \begin_inset Space ~
2893 verbatim mode, with the characters set in a fixed-width typewriter font.
2894 Normally, spaces in this file are invisible, though two consecutive spaces
2895 are conserved, unlike LyX's normal treatment of spaces.
2896 However, setting the
2902 \begin_inset Space ~
2906 \begin_inset Space ~
2910 \begin_inset Space ~
2915 checkbox typesets a mark to unambiguously define the presence of a space.
2919 \begin_layout Subsection
2920 Cross-References Between Files
2923 \begin_layout Standard
2924 It is possible to set up cross-references between the different files.
2925 First, open all the files in question: let's call them A and B in a two
2926 file example, where B is included in A.
2927 Let's say you insert a label in A, then want to reference it in B.
2928 Open the cross-reference dialog in whilst in document B, and you can select
2930 \begin_inset Quotes eld
2934 \begin_inset Quotes erd
2940 \begin_layout Section
2941 Fancy Headers and Footers
2944 \begin_layout Standard
2945 The default page layout is rather plain; for an article document class,
2946 all you get is a centered page number at the bottom of the page.
2947 This document is the book class, so it appears to be a bit fancier, but
2948 to really put on a show, you need to set the document page style to
2949 \begin_inset Quotes eld
2953 \begin_inset Quotes erd
2956 , as mentioned in the
2959 \begin_inset Space ~
2965 This section describes the LaTeX codes you need to insert in your LaTeX
2966 preamble or the text in order to get the desired effects.
2969 \begin_layout Standard
2970 The page header is divided into three fields, not surprisingly labeled
2971 \begin_inset Quotes eld
2975 \begin_inset Quotes erd
2979 \begin_inset Quotes eld
2983 \begin_inset Quotes erd
2987 \begin_inset Quotes eld
2991 \begin_inset Quotes erd
2995 The footer is also divided into these three fields.
2996 The LaTeX commands to set these fields in the simplest manner are
3021 Suppose you wish to put your name in the upper left hand corner of each
3023 Simply insert the following command in the preamble:
3026 \begin_layout Standard
3035 \begin_layout Standard
3036 You will now see your name in the upper left.
3037 If a field has a default entry that you would like to get rid of (often
3038 the page number appears in the central footer, simply include a command
3039 with a blank argument, e.
3040 \begin_inset Space \thinspace{}
3046 \begin_layout Standard
3054 \begin_layout Standard
3055 Let's get really fancy: lets put the section number with the word
3056 \begin_inset Quotes eld
3060 \begin_inset Quotes erd
3064 \begin_inset Space \thinspace{}
3068 \begin_inset Space ~
3071 Section 3) in the upper left, the page number (e.
3072 \begin_inset Space \thinspace{}
3076 \begin_inset Space ~
3079 Page 4) in the upper right, your name in the lower left, and the date in
3081 The following commands should now appear in the preamble:
3084 \begin_layout Standard
3094 \begin_layout Standard
3102 \begin_layout Standard
3112 \begin_layout Standard
3121 \begin_layout Standard
3129 \begin_layout Standard
3139 \begin_layout Standard
3152 access LaTeX's section and page counters, and so print out the current
3153 section and page numbers.
3160 simply prints out today's date.
3163 \begin_layout Standard
3164 The thicknesses of the horizontal rules drawn beneath the header and above
3165 the footer can also be modified.
3166 If you don't want one of the headers, set its thickness to 0.
3167 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3168 Use the commands, e.
3169 \begin_inset Space \thinspace{}
3179 headrulewidth}{0.4pt}
3187 footrulewidth}{0.4pt}
3189 to set the thicknesses.
3192 \begin_layout Standard
3193 You can switch the header/footer settings on and off for individual pages
3198 thispagestyle{empty}
3204 thispagestyle{plain}
3210 thispagestyle{fancy}
3213 Simply insert them in the text on the page you want changed and mark them
3215 In fact, title pages are marked as plain by default, while following pages
3216 are marked fancy when using the global fancy setting.
3219 \begin_layout Standard
3220 There are more complex commands which will let you insert things in the
3221 upper left on odd numbered pages, etc., but I will refer you to the
3225 package documentation for more descriptions.
3226 For example, if you have a teTeX installation, look for
3228 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3234 \begin_layout Standard
3235 As a final example, it is possible to include an Encapsulated PostScript
3236 file in the header or footer.
3237 Suppose you want to put a company logo in the upper lefthand corner.
3238 You might try something like
3241 \begin_layout Standard
3250 includegraphics{logo.eps}}}
3253 \begin_layout Standard
3255 (you may need to preface this with
3259 usepackage{graphics}
3261 if you don't include EPS files elsewhere in your document).
3264 \begin_layout Section
3265 Itemize Bullet Selection
3266 \begin_inset CommandInset label
3275 \begin_layout Standard
3281 \begin_layout Subsection
3285 \begin_layout Standard
3286 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3287 Using this dialog you can easily specify what bullet shape to use at each
3288 level of an itemized list.
3289 These settings are document-wide so you won't be able to specify different
3290 sets of bullets for different paragraphs
3294 \begin_layout Plain Layout
3295 Well, actually you can but you'll have to do it by hand.
3303 \begin_layout Subsection
3307 \begin_layout Standard
3308 Open the dialog by selecting the
3313 ocument\SpecialChar \menuseparator
3320 menu item and then select the
3330 \begin_layout Standard
3331 The dialog provides you with a table of bullet shapes.
3332 A column of buttons on the left of the table provides access to the six
3333 different panels of bullet shapes.
3334 The row of buttons across the top is used to select which bullet depth
3336 A text entry under the table shows the currently selected bullet shape's
3337 LaTeX equivalent and this can be edited if desired.
3338 If you do modify the text you will also need to specify any needed packages
3339 in the LaTeX preamble.
3342 \begin_layout Standard
3343 The six panels are divided up by the packages they require.
3344 The following table shows the mappings from button name to LaTeX packages.
3347 \begin_layout Standard
3349 \begin_inset Tabular
3350 <lyxtabular version="3" rows="7" columns="2">
3352 <column alignment="center" valignment="top" width="0pt">
3353 <column alignment="center" valignment="top" width="0pt">
3355 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3358 \begin_layout Plain Layout
3373 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3376 \begin_layout Plain Layout
3393 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3396 \begin_layout Plain Layout
3411 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3414 \begin_layout Plain Layout
3430 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3433 \begin_layout Plain Layout
3448 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3451 \begin_layout Plain Layout
3468 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3471 \begin_layout Plain Layout
3486 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3489 \begin_layout Plain Layout
3506 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3509 \begin_layout Plain Layout
3524 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3527 \begin_layout Plain Layout
3544 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3547 \begin_layout Plain Layout
3562 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3565 \begin_layout Plain Layout
3582 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3585 \begin_layout Plain Layout
3600 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3603 \begin_layout Plain Layout
3626 \begin_layout Standard
3627 LyX doesn't stop you using bullets from packages you don't have.
3628 If you get errors from LaTeX when you try to view or print the file then
3629 its likely you are missing a package.
3630 LyX doesn't restrict your use since you may be editing locally and exporting
3634 \begin_layout Subsection
3638 \begin_layout Standard
3639 Select which bullet depth you want to change then select the bullet shape
3641 Any changes will not be visible in LyX, but are visible when viewing the
3642 document using xdvi or ghostview.
3645 \begin_layout Standard
3646 You can reset a bullet shape to the default simply by clicking your right
3647 mouse button on the appropriate bullet depth button.
3650 \begin_layout Standard
3655 want to have multiple sets of paragraphs with different sets of bullets
3656 in each then you're going to have to get your hands dirty.
3657 The itemize bullet selection dialog can help though because it provides
3658 you with the LaTeX code for a wide range of bullet shapes.
3659 To make your own custom paragraphs you have the following options:
3662 \begin_layout Standard
3666 \begin_layout Plain Layout
3682 \begin_layout Standard
3686 \begin_layout Plain Layout
3708 \begin_layout Itemize
3709 Use the LaTeX command
3715 to specify a new bullet shape for a given depth.
3716 You'll also need to save the current bullet shape so you can restore it
3718 In this itemized list the following LaTeX code was used to change the bullet
3719 used for the first depth.
3720 \begin_inset Newline newline
3736 \begin_inset Newline newline
3752 \begin_inset Newline newline
3757 Note that the itemize depth is specified in Roman numerals as part of the
3767 \begin_layout Itemize
3771 \begin_layout Plain Layout
3784 Specify each individual entry by starting each item with the bullet shape
3785 enclosed in square brackets and set as TeX.
3786 For example, this item was started with
3799 \begin_layout Standard
3803 \begin_layout Plain Layout
3819 \begin_layout Standard
3820 You'll also need to revert the labelitem back to its previous setting for
3821 the global bullet shape settings to remain in effect.
3822 The way used here was:
3823 \begin_inset Newline newline
3837 \begin_layout Chapter
3838 Special Document Classes
3841 \begin_layout Section
3842 \begin_inset CommandInset label
3844 name "sec:AMS-LaTeX"
3851 \begin_layout Standard
3854 David Johnson; updated by Richard Heck
3857 \begin_layout Standard
3858 \begin_inset VSpace bigskip
3864 \begin_layout Standard
3866 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3867 papers to be submitted to American Mathematical Society publications.
3868 The layouts are not tailored to a specific journal, but easily can be.
3869 You should refer to the AMS documentation for specific instructions for
3870 each journal (usually it will entail only changing a single line in the
3872 That documentation is available on the Web at
3873 \begin_inset Flex URL
3876 \begin_layout Plain Layout
3884 \begin_inset Flex URL
3887 \begin_layout Plain Layout
3889 ftp://ftp.ams.org/pub/tex/amslatex/
3895 These layouts are appropriate, and useful, for any mathematical writing.
3899 \begin_layout Standard
3900 There are two basic AMS LaTeX layouts:
3903 \begin_layout Enumerate
3904 amsart: The standard AMS article format.
3907 \begin_layout Enumerate
3908 amsbook: the standard AMS book (really, monograph) format.
3912 \begin_layout Standard
3913 These layouts themselves contain only the minimum necessary to use the AMS
3915 They do not, in particular, contain any of the `theorem' environments used
3916 for setting theorems, lemmas, and the like.
3917 These are contained, instead, in the
3918 \begin_inset Flex CharStyle:Code
3921 \begin_layout Plain Layout
3927 module, which you will need to load separately when you selected one of
3929 Less commonly used environments are in the
3930 \begin_inset Flex CharStyle:Code
3933 \begin_layout Plain Layout
3934 Theorems (AMS-Extended)
3943 \begin_layout Standard
3944 By default, theorems and the like are numbered consecutively throughout
3945 the document, but this may be modified by loading the module
3946 \begin_inset Flex CharStyle:Code
3949 \begin_layout Plain Layout
3950 Theorems (Order by Section)
3955 or, if you are using
3956 \begin_inset Flex CharStyle:Code
3959 \begin_layout Plain Layout
3966 \begin_inset Flex CharStyle:Code
3969 \begin_layout Plain Layout
3970 Theorems (Order by Chapter)
3976 These will number the results as
3977 \begin_inset Formula $n.m$
3980 , where the first number refers to the section (or chapter) and the second
3981 refers to the total number of results so far in that section (or chapter).
3982 Many environments are also available unnumbered.
3983 These are indicated by an asterisk at the end.
3984 If you happen to want
3988 unnumbered results, the the module
3989 \begin_inset Flex CharStyle:Code
3992 \begin_layout Plain Layout
3998 provides that option.
4001 \begin_layout Standard
4002 Note that these modules do not
4006 to be used with the AMS classes.
4007 It is perfectly possible to use the
4008 \begin_inset Flex CharStyle:Code
4011 \begin_layout Plain Layout
4017 module, and the others mentioned, with other classes, such as
4018 \begin_inset Flex CharStyle:Code
4021 \begin_layout Plain Layout
4028 \begin_inset Flex CharStyle:Code
4031 \begin_layout Plain Layout
4038 \begin_inset Flex CharStyle:Code
4041 \begin_layout Plain Layout
4050 \begin_layout Subsection
4051 What these layouts provide
4054 \begin_layout Standard
4055 There is a long list of included environments provided by these layouts.
4056 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4057 variety of `theorem' environments.
4058 However, the AMS recommends the environments that are available in LyX.
4062 \begin_layout Standard
4063 The following environments---as well as the standard environments, such
4065 \begin_inset Flex CharStyle:Noun
4068 \begin_layout Plain Layout
4075 \begin_inset Flex CharStyle:Noun
4078 \begin_layout Plain Layout
4085 \begin_inset Flex CharStyle:Noun
4088 \begin_layout Plain Layout
4095 \begin_inset Flex CharStyle:Noun
4098 \begin_layout Plain Layout
4105 \begin_inset Flex CharStyle:Noun
4108 \begin_layout Plain Layout
4115 \begin_inset Flex CharStyle:Code
4118 \begin_layout Plain Layout
4125 \begin_inset Flex CharStyle:Code
4128 \begin_layout Plain Layout
4137 \begin_layout Description
4138 Address This should be the author's permanent address.
4141 \begin_layout Description
4143 \begin_inset Space ~
4146 Address This should be the author's temporary address at the time of submission,
4147 if different from the Address.
4150 \begin_layout Description
4151 Email Author's e-mail address
4154 \begin_layout Description
4155 URL Author's Web address, if desired.
4158 \begin_layout Description
4159 Keywords Key words or phrases used to identify specific topics discussed
4163 \begin_layout Description
4164 Subjectclass These refer to the AMS Subject Classifications, published and
4167 Mathematical Reviews
4170 These are also available online at the AMS cites listed above.
4173 \begin_layout Description
4177 \begin_layout Description
4181 \begin_layout Description
4185 \begin_layout Standard
4186 The following environments are provided by both the
4187 \begin_inset Flex CharStyle:Code
4190 \begin_layout Plain Layout
4197 \begin_inset Flex CharStyle:Code
4200 \begin_layout Plain Layout
4206 modules, in the latter case in both starred (unnumbered) and unstarred
4207 (numbered) versions.
4208 These same environments are provided only in the starred versions by the
4210 \begin_inset Flex CharStyle:Code
4213 \begin_layout Plain Layout
4222 \begin_layout Theorem
4223 This is typically used for the statements of major results.
4227 \begin_layout Corollary*
4228 This is used for statements which follow fairly directly from previous statement
4230 Again, these can be major results.
4235 These are smaller results needed to prove other statements.
4238 \begin_layout Proposition
4239 These are less major results which (hopefully) add to the general theory
4243 \begin_layout Conjecture
4244 These are statements provided without justification, which the author does
4245 not know how to prove, but which seem to be true (to the author, at least).
4248 \begin_layout Definition*
4249 Guess what this is for.
4250 The font is different for this environment than for the previous ones.
4254 \begin_layout Example*
4255 Used for examples illustrating proven results.
4258 \begin_layout Problem
4259 It's not really known what this is for.
4260 You should figure it out.
4263 \begin_layout Exercise*
4264 Write a description for this one.
4267 \begin_layout Remark
4268 This environment is also a type of theorem, usually a lesser sort of observation.
4271 \begin_layout Claim*
4272 Often used in the course of giving a proof of a larger result.
4276 Generally, these are used to break up long arguments, using specific instances
4282 The numbering scheme for cases is on its own, not together with other numbered
4288 At the end of this environment , a QED symbol (usually a square, but it
4289 can vary with different styles) is placed.
4290 If you want to have other environments within this one---for example, Case
4291 environments---and have the QED symbol appear only after them, then the
4292 other environments need to be nested within the proof environment.
4294 \begin_inset CommandInset ref
4296 reference "sec:Nesting"
4304 for information on nesting.
4307 \begin_layout Standard
4308 And these are provided by
4309 \begin_inset Flex CharStyle:Code
4312 \begin_layout Plain Layout
4313 Theorems (AMS-Extended)
4321 \begin_layout Criterion*
4322 A required condition.
4325 \begin_layout Algorithm*
4326 A general procedure to be used.
4329 \begin_layout Axiom*
4330 This is a property or statement taken as true within the system being discussed.
4333 \begin_layout Condition*
4334 Sometimes used to state a condition assumed within the present context of
4339 Similar to a Remark.
4342 \begin_layout Notation*
4343 Used for the explanation of, yes, notation.
4346 \begin_layout Summary
4347 Do we really need to tell you?
4350 \begin_layout Acknowledgement*
4354 \begin_layout Conclusion*
4355 Sometimes used at the end of a long train of argument.
4359 Used in a way similar to Proposition, though perhaps lower on the scale.
4362 \begin_layout Standard
4363 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4365 They need to be available on your system in order to use these environments.
4368 \begin_layout Section
4372 \begin_layout Standard
4377 can be used to type letters according to German conventions.
4378 A template file is included in
4380 .../lyx/share/templates
4382 for you to use as a starting point.
4385 \begin_layout Section
4389 \begin_layout Standard
4394 provides an alternative to the standard
4399 It provides similar functionality, but you might prefer this layout with
4400 sans serif sections, headings, and more.
4403 \begin_layout Section
4407 \begin_layout Standard
4413 \begin_layout Subsection
4417 \begin_layout Standard
4418 This section describes how LyX can be used to write articles for submission
4419 to the scientific journal
4421 Astronomy and Astrophysics
4423 (www.edpsciences.fr/aa/
4424 \begin_inset Flex URL
4427 \begin_layout Plain Layout
4429 http://www.edpsciences.fr/aa/
4434 ) using Version 5.01 of the document class
4439 This package can be downloaded from the ftp site
4442 \begin_layout Standard
4443 \begin_inset VSpace medskip
4449 \begin_layout Standard
4451 \begin_inset Flex URL
4454 \begin_layout Plain Layout
4456 ftp://ftp.edpsciences.org/pub/aa/readme.html
4464 \begin_layout Standard
4465 \begin_inset VSpace medskip
4471 \begin_layout Standard
4472 A manual comes together with that package, and this text is not meant to
4473 replace the original manual but merely a short guide how to realize the
4474 correct form of your paper.
4478 \begin_layout Standard
4479 Please note that the publisher of the journal was changed from Springer
4480 to EDP Sciences starting January 1, 2001.
4481 That change implicated also some slight changes of the style files, namely
4482 the removal of the thesaurus command.
4483 The LyX class aa supports the newest version of these style files, V 5.01.
4484 If you have an older version installed, please upgrade.
4485 For compatibility, the old (version 4) layout has been kept as
4490 Please refer to the comments in
4492 LyXDir/layouts/aapaper.layout
4497 \begin_layout Subsection
4501 \begin_layout Standard
4502 It is recommended you start from the example template distributed with LyX.
4503 If you are not using a template, note the following settings:
4506 \begin_layout Itemize
4516 ocument\SpecialChar \menuseparator
4523 dialog (OK, that one was obvious).
4526 \begin_layout Itemize
4527 Don't change the option
4530 \begin_inset Space ~
4540 The whole layout is done by the macros, you shouldn't change anything.
4543 \begin_layout Subsection
4547 \begin_layout Standard
4548 First thing to enter is the header information.
4549 It consists of seven entries, of which some are optional.
4553 \begin_layout Itemize
4561 \begin_layout Itemize
4569 \begin_layout Itemize
4577 \begin_layout Itemize
4585 \begin_layout Itemize
4590 : [optional] if more than one author: whom to contact for offprint requests.
4593 \begin_layout Itemize
4598 : [optional] mail address for contacts.
4601 \begin_layout Itemize
4609 Received: <date>; Accepted <date>
4612 \begin_layout Standard
4613 There is no need to issue the
4619 command, this is done automatically by LyX when the header is finished.
4620 Although the order of the single header entries doesn't matter it is advised
4621 to keep the above sequence, just to get the best optics and meets the layout
4622 of the real document.
4625 \begin_layout Standard
4626 If you want to place footnotes in the header block, e.
4627 \begin_inset Space \thinspace{}
4631 \begin_inset Space ~
4634 to state your present address, just use the standard footnote via
4639 nsert\SpecialChar \menuseparator
4647 LyX will automagically use the term
4656 \begin_layout Standard
4657 In addition to these topics, the macros use three additional LaTeX commands
4658 that have no counterpart in LyX:
4661 \begin_layout Itemize
4668 to separate different names for more than one author and institute, respectivel
4672 \begin_layout Itemize
4679 to mark corresponding author/institute pairs.
4680 The institutes are numbered sequentially as they appear in the
4684 field, so you have to put a marker to each author.
4687 \begin_layout Itemize
4694 to supply an email address for fast contact.
4697 \begin_layout Standard
4698 In all cases, the appropriate command has to be entered in LyX and marked
4704 \begin_layout Subsection
4708 \begin_layout Standard
4709 The abstract should immediately follow the header block.
4710 With version 5 the abstract environment was changed to a command, and there
4711 is now a resctriction to only one paragraph.
4712 In addition, it should contain an entry with the keywords.
4713 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4720 by hand and mark it as LaTeX code.
4721 Refer to the example paper.
4724 \begin_layout Subsection
4725 Supported environments
4728 \begin_layout Standard
4729 The A&A paper layout supports the following environments for structuring
4733 \begin_layout Itemize
4739 \begin_layout Itemize
4745 \begin_layout Itemize
4751 \begin_layout Itemize
4757 \begin_layout Itemize
4763 \begin_layout Itemize
4769 \begin_layout Itemize
4775 \begin_layout Itemize
4781 \begin_layout Itemize
4787 \begin_layout Itemize
4793 \begin_layout Itemize
4799 \begin_layout Itemize
4805 \begin_layout Subsection
4806 Commands not supported by LyX
4809 \begin_layout Standard
4810 Some commands are not yet supported by the
4815 Some have already been mentioned.
4816 For the sake of completeness, they are listed all together here:
4819 \begin_layout Itemize
4827 \begin_layout Itemize
4835 \begin_layout Itemize
4843 \begin_layout Itemize
4851 \begin_layout Itemize
4859 \begin_layout Itemize
4867 \begin_layout Itemize
4875 \begin_layout Itemize
4883 \begin_layout Standard
4884 If you want to use any of these commands, you have to enter them yourself.
4887 Do not forget to mark them as LaTeX code!
4890 \begin_layout Subsection
4891 Figure and Table Floats
4894 \begin_layout Standard
4895 LyX provides support for the necessary float environments
4897 figure, figure*, table
4903 , therefore we won't tell much about it here.
4907 \begin_inset Space ~
4913 Just remember that tables should be left-aligned.
4914 For that, select the table and change the alignment in
4919 dit\SpecialChar \menuseparator
4925 \begin_inset Space ~
4931 \begin_layout Standard
4932 There is only one special thing: the figures with caption besides the figure.
4933 To create such a figure, you have to do the following:
4936 \begin_layout Enumerate
4937 Create a wide figure float:
4942 nsert\SpecialChar \menuseparator
4947 t\SpecialChar \menuseparator
4950 , then right click in the figure and select
4956 \begin_inset Space ~
4964 \begin_layout Enumerate
4965 Enter your caption text.
4968 \begin_layout Enumerate
4973 to move the cursor above the caption.
4976 \begin_layout Enumerate
4980 \begin_layout Enumerate
4981 Position the cursor behind the figure and insert a horizontal fill:
4986 nsert\SpecialChar \menuseparator
4992 \begin_inset Space ~
4997 \SpecialChar \menuseparator
5001 \begin_inset Space ~
5009 \begin_layout Enumerate
5010 Switch to LaTeX mode:
5013 \begin_inset Space ~
5021 \begin_layout Enumerate
5031 Do not close the brace!
5034 \begin_layout Enumerate
5035 Position the cursor behind the caption text, switch to LaTeX mode and insert
5039 \begin_inset Space ~
5051 \begin_layout Standard
5052 Also, refer to the figures in the example paper.
5055 \begin_layout Subsection
5059 \begin_layout Standard
5060 For submission, the paper has to be formated in a special double-spacing
5062 For this purpose, you have to give the option
5066 to the documentclass.
5067 This must be done using the extra class options field in the
5072 ocument\SpecialChar \menuseparator
5080 Just enter the string
5087 \begin_layout Subsection
5091 \begin_layout Standard
5096 directory contains an example paper written with LyX.
5097 It is the example paper from the original macro package, translated to
5099 Use it for inspiration, and compare the original LaTeX code with LyX way
5103 \begin_layout Section
5107 \begin_layout Standard
5113 \begin_layout Subsection
5117 \begin_layout Standard
5118 AASTeX is a set of macros produced by the American Astronomical Society
5119 to facilitate electronic manuscript submission to the three journals they
5120 publish: the Astrophysical Journal (including the Letters and Supplement),
5121 the Astronomical Journal, and the Publications of the Astronomical Society
5123 LyX has proven to be an excellent tool for generating these documents,
5124 especially given its equation, citation, and figure handling capabilities.
5125 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5126 is the version described here, or higher.
5127 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5128 incompatible with LyX.
5129 The AASTeX package may be downloaded from the AASTeX Web site
5132 \begin_layout Standard
5133 \begin_inset VSpace medskip
5139 \begin_layout Standard
5141 \begin_inset Flex URL
5144 \begin_layout Plain Layout
5146 http://www.journals.uchicago.edu/AAS/AASTeX
5154 \begin_layout Standard
5155 \begin_inset VSpace medskip
5161 \begin_layout Standard
5162 A complete user guide is contained in that package and you should familiarize
5163 yourself with it thoroughly before embarking on writing a paper in LyX.
5164 LyX will not reduce the need to figure out all the AASTeX commands, it
5165 will only reduce the drudgery of typing everything in.
5166 It is your responsibility to ensure that the final exported LaTeX document
5167 conforms completely to the requirements of the journal to which you are
5168 submitting your paper.
5171 \begin_layout Subsection
5172 Starting a New Paper
5175 \begin_layout Standard
5176 I strongly suggest that you start with the AASTeX template file.
5182 ile\SpecialChar \menuseparator
5192 , enter the new file name, then choose the
5197 This will show the most common fields found in a manuscript.
5198 Simply overwrite the existing text (including the brackets,
5202 ) with the correct information.
5203 Many of the AASTeX commands and environments can be implemented directly
5204 in LyX, but some cannot: most noticeably
5216 , which should stick out like a sore thumb if you actually just opened the
5218 For commands such as these, the LaTeX code must be entered directly and
5220 Such commands are referred to as ERT, or Evil Red Text.
5221 I tried to minimize the amount of ERT needed in an AASTeX document, but
5222 there is still a bit more required than any of us would like.
5225 \begin_layout Subsection
5226 Finishing Your Paper
5229 \begin_layout Standard
5230 When the paper is finished to your satisfaction and previews/prints correctly,
5232 \begin_inset Quotes eld
5236 \begin_inset Quotes erd
5239 actions which need to be done before you submit it to the journals.
5243 \begin_layout Enumerate
5244 Export your paper as a LaTeX file (
5249 ile\SpecialChar \menuseparator
5254 xport\SpecialChar \menuseparator
5265 \begin_layout Enumerate
5270 file with your favorite text editor
5274 \begin_layout Enumerate
5275 remove the comment lines before the
5284 \begin_layout Enumerate
5289 usepackage...{fontenc}
5291 line if it appears (usually just after
5306 \begin_layout Enumerate
5307 remove everything between (and including) the
5319 commands, except for any commands you specifically put into the LaTeX preamble
5320 (which should appear immediately after the
5321 \begin_inset Quotes eld
5324 User specified LaTeX commands
5325 \begin_inset Quotes erd
5336 \begin_layout Enumerate
5337 Run the resulting file through LaTeX to make sure it still processes correctly.
5340 \begin_layout Enumerate
5341 Reread the journal requirements to make sure your filenames and formats
5345 \begin_layout Enumerate
5349 \begin_layout Subsection
5350 Comments On Specific Commands
5353 \begin_layout Standard
5354 I will not describe the detailed usage of the individual AASTeX commands:
5355 the AASTeX User Guide (
5359 ) gives a good description of each.
5360 Thus it's probably easiest for me to go down the list as found in the guide
5361 and offer comments where necessary.
5362 So let's begin \SpecialChar \ldots{}
5366 \begin_layout Subsubsection
5367 Things that work as expected
5370 \begin_layout Standard
5374 \begin_layout Plain Layout
5386 \begin_layout Standard
5387 Because they work as you might expect, I simply list them and the section
5488 begin{thebibliography}
5496 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5497 graphicx figure commands (2.14.1),
5521 (2.15.4, amongst other places),
5548 \begin_layout Standard
5549 The following style options also work correctly:
5570 Simply put them in the
5576 Layout\SpecialChar \menuseparator
5582 \begin_layout Standard
5586 \begin_layout Plain Layout
5598 \begin_layout Subsubsection
5599 Things that work, but require more comment
5602 \begin_layout Standard
5603 The following items work, but require a little more discussion:
5606 \begin_layout Itemize
5607 These items are reserved for use by the journal editors, but you can put
5608 them into the LaTeX preamble if you feel compelled to do so:
5641 \begin_layout Itemize
5642 These items may be placed in the LaTeX preamble, and are included as blanks
5643 in the template file:
5664 \begin_layout Itemize
5671 (2.3) -- can only be used
5672 \begin_inset Quotes eld
5676 \begin_inset Quotes erd
5679 , not in the middle of a paragraph.
5680 Use ERT if you need to embed it.
5683 \begin_layout Itemize
5690 (2.3) -- will have extra {} after it.
5691 This should not cause an error.
5694 \begin_layout Itemize
5701 (2.6) -- can only be used
5702 \begin_inset Quotes eld
5706 \begin_inset Quotes erd
5709 , not in the middle of a paragraph.
5710 Use ERT if you need to embed it.
5713 \begin_layout Itemize
5720 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5724 \begin_layout Itemize
5731 (2.8) -- same as for
5738 \begin_layout Itemize
5745 (2.9) -- will have extra {} after it.
5746 This should not cause an error.
5749 \begin_layout Itemize
5756 (2.11) -- will have extra {} after it.
5757 This should not cause an error.
5760 \begin_layout Itemize
5767 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5768 at the beginning of the text and selecting
5770 Insert\SpecialChar \menuseparator
5775 \begin_inset Quotes eld
5779 \begin_inset Quotes erd
5782 inserts an optional argument of the type needed by
5789 Hopefully it will be renamed someday.
5792 \begin_layout Itemize
5805 for the catalog ID optional parameter
5808 \begin_layout Itemize
5821 for the catalog ID optional parameter
5824 \begin_layout Subsubsection
5825 Things not implemented, use ERT
5828 \begin_layout Standard
5832 \begin_layout Plain Layout
5844 \begin_layout Standard
5867 setcounter{equation}
5869 (2.12), Journal name abbreviations (2.13.4),
5905 (2.15.4, insert it as the first element in the lefthand cell after where
5907 Don't use any of LyX's rules in the table),
5919 (2.15.5), much of Misc (2.17, except
5970 \begin_layout Standard
5974 \begin_layout Plain Layout
5986 \begin_layout Subsubsection
5987 Things that cannot be implemented
5990 \begin_layout Standard
5991 \SpecialChar \ldots{}
5992 at least in any meaningful sort of way, so I suggest ignoring them.
5993 They are the references environment (2.13.3), and the deluxetable environment
5995 If you really, really need to use deluxetable, I suggest editing it in
5996 a separate file with a text editor, then using
6001 nsert\SpecialChar \menuseparator
6007 \begin_inset Space ~
6012 to include it in your LyX document.
6017 file to see an example of this.
6020 \begin_layout Subsection
6021 FAQs, Tips, Tricks, and Other Ruminations
6024 \begin_layout Subsubsection
6025 Getting LyX and AASTeX to cooperate
6028 \begin_layout Standard
6029 It can be a bit tricky to get LyX to recognize a new layout and document
6031 When all else fails, do this:
6034 \begin_layout Enumerate
6035 Make certain that LaTeX can find AASTeX.
6036 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6037 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6044 \begin_layout Enumerate
6056 \begin_layout Enumerate
6062 ools\SpecialChar \menuseparator
6069 in LyX, then restart LyX.
6072 \begin_layout Enumerate
6073 Open a regular new file, not from a template.
6074 Does AASTeX appear in the class list in
6079 ocument\SpecialChar \menuseparator
6089 \begin_layout Standard
6090 If you get a warning from an existing AASTeX document about not being able
6091 to find the AASTeX layout or a message about
6092 \begin_inset Quotes eld
6095 You should not mix title layouts with normal ones
6096 \begin_inset Quotes erd
6099 , things haven't been installed correctly.
6102 \begin_layout Subsubsection
6103 LaTeX error processing a table
6106 \begin_layout Standard
6107 LyX, by default, attempts to center the table caption/title.
6108 This seems to produce a bad interaction in AASTeX so you should click somewhere
6109 in the caption/title, then select
6114 dit\SpecialChar \menuseparator
6120 \begin_inset Space ~
6137 This took care of it for me.
6140 \begin_layout Subsubsection
6142 \begin_inset CommandInset label
6151 \begin_layout Standard
6152 A couple of things: 1) I have noticed some funny spacing in the reference
6153 entries in the text.
6154 When you enter the bibliography item data, make sure their is
6158 space between the last author and the parenthesis setting off the year;
6162 \begin_inset Space \thinspace{}
6166 \begin_inset Space ~
6180 2) Entering the references at all is not obvious.
6181 The easiest thing is to start typing your first reference at the end of
6182 the document, then mark it as type
6187 That will put a small gray box in front of what you just typed.
6188 Click on the box to fill in the rest of the information.
6189 For new references, go to the end of an existing reference and press return.
6190 That will create a new line with its own box, etc.
6193 \begin_layout Subsubsection
6197 \begin_layout Standard
6198 Even though AASTeX provides its own figure commands (
6204 , for example), I much prefer LaTeX's standard figure commands (with the
6213 \begin_inset Space ~
6216 commands as ERT into a Figure Float box if you desire, but I never have
6217 much luck getting the layout right.
6218 With the standard graphics, LyX will insert a
6222 usepackage{graphicx}
6224 command into the LaTeX preamble and handle the figures in the standard
6225 LaTeX2e way, interspersing the figures in the text.
6226 I believe ApJ accepts figures exactly this way now; AJ might still use
6228 \begin_inset Quotes eld
6231 stack everything at the end
6232 \begin_inset Quotes erd
6238 \begin_layout Subsubsection
6239 Things I could have done, but didn't
6242 \begin_layout Standard
6244 \begin_inset Quotes eld
6248 \begin_inset Quotes erd
6251 things I could have implemented, but chose not to.
6252 For instance, I saw no point in double-spacing the text in the LyX window,
6253 even though it is double-spaced in the paper manuscript.
6254 Also, I chose not to make separate layouts for the preprint and preprint2
6256 Since I assume you will spend most of your time in the plain manuscript
6257 mode anyway, I decided not to chew up more disk space with this.
6261 \begin_layout Subsection
6265 \begin_layout Standard
6266 Your mileage may vary.
6267 I've now had papers published by both ApJ and AJ that have had 98% of the
6268 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6270 I have had no trouble with the submission process, and I'm sure the journals
6271 were never aware that there might be a difference.
6272 So, go forth and publish!
6275 \begin_layout Section
6279 \begin_layout Standard
6282 Panayotis Papasotiriou
6285 \begin_layout Subsection
6289 \begin_layout Standard
6290 The ijmpc package is a set of macros that facilitates electronic manuscript
6293 International Journal of Modern Physics C
6296 Similarly, the ijmpd package is for creating manuscripts to be submitted
6299 International Journal of Modern Physics D
6302 Both journals are published by World Scientific.
6303 The corresponding document classes are named
6312 These files, together with instructions for the authors, can be downloaded
6314 \begin_inset Flex URL
6317 \begin_layout Plain Layout
6319 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6325 \begin_inset Flex URL
6328 \begin_layout Plain Layout
6330 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6336 Both packages are modified versions of the standard
6337 \begin_inset Quotes eld
6341 \begin_inset Quotes erd
6344 package, and they are almost (but not exactly) identical.
6345 Most of their features are supported by LyX.
6346 I have used LyX successfully to write articles submitted to both journals
6347 without any problem.
6350 \begin_layout Subsection
6354 \begin_layout Standard
6355 As usual, the easiest way to write a paper is to start with a template.
6361 ile\SpecialChar \menuseparator
6380 This will give an (almost) empty document that includes the most common
6381 fields found in a manuscript.
6382 Simply overwrite the existing text (including the brackets,
6387 You should keep in mind the following remarks.
6390 \begin_layout Enumerate
6391 LyX won't let you change the font size and the page style of the document,
6392 because such modifications are not allowed by both packages.
6395 \begin_layout Enumerate
6396 The language of the document should not be changed.
6397 Before previewing your paper, be sure that the babel package is not used.
6398 To do this, click on
6403 ools\SpecialChar \menuseparator
6421 checkbox in the language settings, and click on
6432 , if you wish to make this change permanent).
6435 \begin_layout Enumerate
6437 \begin_inset Quotes eld
6441 \begin_inset Quotes erd
6444 style must be used to define keywords.
6447 \begin_layout Enumerate
6448 The ijmpc package provides a style named
6449 \begin_inset Quotes eld
6452 Classification Codes
6453 \begin_inset Quotes erd
6456 , which can be used to define classification codes, such as PACS numbers.
6457 Note that this facility is not supported by the ijmpd package.
6460 \begin_layout Enumerate
6461 Several new environments are available:
6462 \begin_inset Quotes eld
6466 \begin_inset Quotes erd
6470 \begin_inset Quotes eld
6474 \begin_inset Quotes erd
6478 \begin_inset Quotes eld
6482 \begin_inset Quotes erd
6486 \begin_inset Quotes eld
6490 \begin_inset Quotes erd
6494 \begin_inset Quotes eld
6498 \begin_inset Quotes erd
6502 \begin_inset Quotes eld
6506 \begin_inset Quotes erd
6510 \begin_inset Quotes eld
6514 \begin_inset Quotes erd
6518 \begin_inset Quotes eld
6522 \begin_inset Quotes erd
6526 \begin_inset Quotes eld
6530 \begin_inset Quotes erd
6534 \begin_inset Quotes eld
6538 \begin_inset Quotes erd
6542 \begin_inset Quotes eld
6546 \begin_inset Quotes erd
6550 \begin_inset Quotes eld
6554 \begin_inset Quotes erd
6558 \begin_inset Quotes eld
6562 \begin_inset Quotes erd
6566 \begin_inset Quotes eld
6570 \begin_inset Quotes erd
6574 Their use is more or less obvious.
6575 LyX supports all these environments; it will use the proper label, text
6576 style, and numbering scheme for each of them.
6579 \begin_layout Enumerate
6580 Both packages use basic citations; the natbib package should not be used.
6581 In LyX, citation references are shown as usual; in the output, citations
6582 are shown as superscripts.
6583 If you want to use a citation as normal text, you should use the
6588 \begin_inset Space \thinspace{}
6592 \begin_inset Quotes eld
6596 \begin_inset Space ~
6606 \begin_inset Quotes erd
6612 \begin_layout Enumerate
6614 \begin_inset Quotes eld
6618 \begin_inset Quotes erd
6621 section in both packages.
6622 To put acknowledgments, just use the
6623 \begin_inset Quotes eld
6627 \begin_inset Quotes erd
6633 \begin_layout Enumerate
6634 Appendices may be added to the paper,
6638 the Acknowledgments and
6643 LyX provides a special environment, called
6644 \begin_inset Quotes eld
6648 \begin_inset Quotes erd
6651 which marks the beginning of the appendices.
6652 This environment should be left blank; it just sends a LaTeX command, but
6653 nothing is really printed.
6655 \begin_inset Quotes eld
6659 \begin_inset Quotes erd
6662 is printed with blue letters, as a signal that all sections after that
6663 point are appendices.
6664 To write an appendix, use the
6665 \begin_inset Quotes eld
6669 \begin_inset Quotes erd
6673 LyX will number each appendix with capital letters, as required by both
6676 \begin_inset Quotes eld
6680 \begin_inset Quotes erd
6687 be present before the first appendix; if not, all appendices will be numbered
6688 as normal sections in the output.
6691 \begin_layout Enumerate
6692 The ijmpc and the ijmpd packages use the
6696 command to implement table captions.
6697 As a result, a table created by LyX is printed correctly, but its caption
6699 However, you can use some ERT to overpass this problem, so that captions
6700 are printed as expected.
6701 To do so, create a float table as usual, remove the caption, and replace
6712 (sic); you must also the ERT
6716 immediately after the tabular material.
6717 Study the example table included in the template files to see how this
6718 trick is implemented.
6719 Alternatively, If you need table captions, you should implement the whole
6724 file, then include this file to the LyX document (
6729 nsert\SpecialChar \menuseparator
6734 \SpecialChar \menuseparator
6740 \begin_inset Space ~
6746 Details on how to create a table float can be found in the files
6754 , included in the corresponding packages.
6757 \begin_layout Subsection
6758 Preparing a paper for submission
6761 \begin_layout Standard
6762 Before you submit your paper you must export the LyX document as a LaTeX
6768 ile\SpecialChar \menuseparator
6773 xport\SpecialChar \menuseparator
6788 \begin_layout Plain Layout
6789 Actually you have the choice between LaTeX (plain) and pdflatex.
6790 If you intend to use pdflatex to prepare the paper, you should use the
6791 pdflatex option so that included graphics are converted to PDF format,
6792 ready for use by pdflatex.
6797 , then make the following changes to the resulting
6804 \begin_layout Enumerate
6805 Remove the comment lines before the
6814 \begin_layout Enumerate
6815 Remove everything between (and including) the
6827 commands, except for any commands you specifically put into the LaTeX preamble.
6830 \begin_layout Standard
6835 file should be saved and processed through LaTeX as many times as necessary.
6836 You may also want to check the resulting
6843 \begin_layout Subsection
6847 \begin_layout Standard
6848 The use of ERT is reduced to two commands, which must be placed at the top
6850 If you started writing your paper by using the
6858 template, the ERT needed is already in its place; you usually don't need
6860 You may only modify the first ERT to specify the information printed to
6861 the top of odd and even pages (authors' names and short paper's title,
6863 This ERT must have the form
6867 markboth{Authors' Names}{Short Paper's Title}
6872 \begin_layout Section
6876 \begin_layout Standard
6882 \begin_layout Subsection
6886 \begin_layout Standard
6887 The iopart package provides a document class to create electronic manuscript
6888 submission to the journals published by the Institute of Physics.
6889 Instructions for the authors how to create a paper using the iopart class
6890 can be downloaded together with the iopart package from the site
6891 \begin_inset Flex URL
6894 \begin_layout Plain Layout
6896 ftp://ftp.iop.org/pub/journals/latex2e
6904 \begin_layout Subsection
6908 \begin_layout Standard
6909 The easiest way to write a paper is to start with the file
6913 that is available in LyX's examples files folder.
6914 Open this file, save it under a new name, and start writing.
6915 The example file explains how to use the special text environments.
6916 Here are the most important advices:
6919 \begin_layout Itemize
6920 To be able to compile your document to a PDF, PS, or DVI, assure that the
6923 Use AMS math package
6925 in the document settings under
6932 \begin_layout Itemize
6935 The title environment defines the kind of your paper.
6936 So use one of the following environments for the title:
6940 \begin_layout Itemize
6949 \begin_layout Itemize
6958 \begin_layout Itemize
6964 for a Topical review
6967 \begin_layout Itemize
6976 \begin_layout Itemize
6985 \begin_layout Itemize
6991 for a Paper (same as Title)
6994 \begin_layout Itemize
7000 for a Preliminary communication
7003 \begin_layout Itemize
7009 for a Rapid communication
7012 \begin_layout Itemize
7018 for a Letter to the editor
7022 \begin_layout Itemize
7025 All title environments except of
7029 can have an optional short title.
7032 \begin_layout Itemize
7033 There is a general title environment
7037 which is not directly supported by the LyX.
7038 This can be used as ERT when your document doesn't fit into one of the
7042 \begin_layout Standard
7043 For more informations like hints for special table and formula formatting,
7044 look at the IOP author guidelines.
7047 \begin_layout Section
7051 \begin_layout Standard
7054 Panayotis Papasotiriou
7057 \begin_layout Subsection
7061 \begin_layout Standard
7062 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7063 that facilitates electronic manuscript submission to the journals they
7065 Most known of them (at least in my domain of interest) are
7067 Astrophysics and Space Science
7073 , but there are many others (see a complete list at
7074 \begin_inset Flex URL
7077 \begin_layout Plain Layout
7079 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7085 The Kluwer package may be downloaded from the site
7086 \begin_inset Flex URL
7089 \begin_layout Plain Layout
7091 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7097 A complete user guide is contained in that package (but it can also be
7098 downloaded separately).
7101 \begin_layout Standard
7102 LyX supports many features of the package but not everything.
7103 However, the ERT needed is reduced to some
7104 \begin_inset Quotes eld
7108 \begin_inset Quotes erd
7111 commands of the package (see
7112 \begin_inset Space ~
7116 \begin_inset CommandInset ref
7118 reference "subsec:kluwer_peculiarities"
7123 I have recently used LyX to write an article submitted to the
7125 Astrophysics and Space Science
7127 without any problem.
7130 \begin_layout Subsection
7134 \begin_layout Standard
7135 The easiest way to write a paper is to start with the Kluwer template file.
7138 File\SpecialChar \menuseparator
7153 This will give an (almost) empty document that includes the most common
7154 fields found in a manuscript and a short description of their use.
7155 As in most templates, simply overwrite the existing text (including the
7160 ) with the correct information.
7163 \begin_layout Subsection
7164 Preparing a paper for submission
7167 \begin_layout Standard
7168 As in the AASTeX package, before you submit your paper to a journal you
7170 \begin_inset Quotes eld
7174 \begin_inset Quotes erd
7180 \begin_layout Enumerate
7181 Export your paper as a LaTeX file.
7182 To do this, click on
7187 ile\SpecialChar \menuseparator
7192 xport\SpecialChar \menuseparator
7203 \begin_layout Enumerate
7208 file with a text editor and make the following changes
7212 \begin_layout Enumerate
7213 remove the comment lines before the
7222 \begin_layout Enumerate
7223 remove everything between (and including) the
7235 commands, except for any commands you specifically put into the LaTeX preamble.
7238 \begin_layout Standard
7247 \begin_layout Enumerate
7252 file through LaTeX as many times as necessary (usually up to three).
7255 \begin_layout Enumerate
7261 \begin_inset Space \thinspace{}
7268 , and check if everything is OK (it should, if you didn't make any mistake).
7271 \begin_layout Subsection
7272 \begin_inset Quotes eld
7276 \begin_inset Quotes erd
7279 of the Kluwer package
7280 \begin_inset CommandInset label
7282 name "subsec:kluwer_peculiarities"
7289 \begin_layout Standard
7290 The Kluwer package has the following
7291 \begin_inset Quotes eld
7295 \begin_inset Quotes erd
7301 \begin_layout Enumerate
7302 It is possible to write multiple articles in the same LaTeX file
7306 \begin_layout Plain Layout
7307 I can't imagine any good reason to do this.
7313 Each article must be included in the environment
7314 \begin_inset Quotes eld
7318 \begin_inset Quotes erd
7322 Unfortunately, this environment cannot be omitted, even if you write just
7324 Therefore, each article starts with the command
7330 and, obviously, ends with the command
7337 Although this can be implemented in LyX, I didn't included it, since it
7338 looks ugly and can confuse the novice user.
7339 Therefore, you need to enter them directly and mark them as LaTeX code
7341 \begin_inset Quotes eld
7345 \begin_inset Quotes erd
7351 \begin_layout Enumerate
7352 Information given at the beginning of the article (i.e., title, subtitle,
7353 author, institution, running title, running author, abstract and keywords)
7354 must be included in an environment called
7355 \begin_inset Quotes eld
7359 \begin_inset Quotes erd
7363 This is not implemented in LyX, so you must enter title, subtitle etc.
7364 \begin_inset Space ~
7367 between two ERT lines (
7382 \begin_layout Enumerate
7383 According to the user manual, the label of each bibliography item must be
7407 \begin_layout Standard
7412 template takes care of all these
7413 \begin_inset Quotes eld
7417 \begin_inset Quotes erd
7421 If you start a new paper using this template you don't need to do anything
7426 \begin_layout Enumerate
7427 don't delete the ERT included in the template, and
7430 \begin_layout Enumerate
7431 copy the example bibliography item included in the template and modify it
7432 as necessary to enter new bibliography items.
7435 \begin_layout Section
7439 \begin_layout Standard
7445 \begin_layout Subsection
7449 \begin_layout Standard
7450 The LyX document classes
7452 article (koma-script)
7456 report (koma-script)
7474 correspond to the LaTeX document classes
7491 \begin_inset Space ~
7494 of the Koma-Script family.
7495 They are replacements for the standard document classes
7511 , resp., and fit better to European typography conventions in a number of
7515 \begin_layout Itemize
7516 Standard character size is 11pt in
7518 article (koma-script)
7522 report (koma-script)
7530 letter (koma-script)
7535 \begin_layout Itemize
7536 Headings, labels of the description environment, and a number of elements
7539 letter (koma-script)
7541 document class are set in a bold sans serif font.
7545 \begin_layout Plain Layout
7546 There is a big difference between the bold sans serif old cm fonts and new
7547 ec fonts, especially in the appearance of headings.
7548 In comparison, the ec bold sans serif fonts look a bit thin.
7549 Here the LaTeX package
7557 helps to produce the
7558 \begin_inset Quotes eld
7562 \begin_inset Quotes erd
7565 appearance when using the ec fonts.
7570 The numbering of chapter headings is made in the same way as the numbering
7571 of section headings, that is without the extra line
7572 \begin_inset Quotes eld
7575 Chapter\SpecialChar \ldots{}
7577 \begin_inset Quotes erd
7581 In addition, the appearance of the headings can be modified by using a
7582 number of options (in LyX to be entered in the field
7589 \begin_inset Space ~
7599 ayout\SpecialChar \menuseparator
7607 A detailed German description of these options can be found in the Koma-Script
7615 \begin_layout Itemize
7616 The main means in the Koma-Script document classes to design the type area
7625 (in LyX to be entered in the extra class options field in the dialog
7630 ocument\SpecialChar \menuseparator
7638 They make a clearer modification of page margins possible as do the options
7644 ocument\SpecialChar \menuseparator
7652 A detailed German description of these and other type area options can
7653 be found in the Koma-Script documentation
7660 \begin_layout Itemize
7661 The LaTeX document classes of the Koma-Script family define a number of
7662 additional commands.
7663 Those part of it which makes sense in LyX is implemented in corresponding
7667 \begin_layout Standard
7668 A detailed German description of the LaTeX document classes of the Koma-Script
7669 family can be found in the Koma-Script documentation
7677 \begin_layout Plain Layout
7678 There is an English translation
7682 , but it is not a complete one.
7687 The following sections describe only those aspects, which are relevant
7691 \begin_layout Subsection
7692 article (koma-script), report (koma-script), and book (koma-script)
7695 \begin_layout Standard
7696 The document classes
7698 article (koma-script)
7702 report (koma-script)
7712 are implemented in the layout files
7725 They contain all the paragraph types of the corresponding standard document
7738 , resp., partly modified, with the exception of the LyX specific
7742 -type, which is replaced by the new
7746 -type having the same functionality.
7751 -Type there is a number of new paragraph types added.
7758 letter (koma-script)
7763 \begin_layout Itemize
7772 : are equivalents to
7780 , resp., additionally inserting an entry in the table of contents.
7789 are not contained in
7791 article (koma-script)
7796 \begin_layout Itemize
7813 , resp., additionally clearing running heads.
7820 article (koma-script)
7826 \begin_layout Plain Layout
7839 report (koma-script)
7841 , but since this is identical to
7845 , is has not been implemented in LyX.
7853 \begin_layout Itemize
7858 : generates a heading directly above the following paragraph in the standard
7859 character size without affecting the structure of the document.
7862 \begin_layout Itemize
7871 are special captions which respect the different space settings needed
7872 for captions placed above or below an element (if you follow strict typographic
7873 rules, you might want to place table captions always above the table).
7874 You can also use the class option
7891 You need at least Koma-Script version 2.8q to use this.
7894 \begin_layout Itemize
7899 : can be used to set a bonmot, e.
7900 \begin_inset Space \thinspace{}
7904 \begin_inset Space ~
7907 at the beginning of a chapter.
7908 If you use the optional argument (
7913 nsert\SpecialChar \menuseparator
7915 \begin_inset Space ~
7920 ), you can insert the dictum's author there.
7921 Dictum and author are separated by a line.
7922 You need at least Koma-Script version 2.8q to use this.
7929 article (koma-script)
7934 \begin_layout Standard
7935 The following types, together with the standard types
7947 , form the title area of the document.
7948 They must be entered ahead of the first
7949 \begin_inset Quotes eld
7953 \begin_inset Quotes erd
7960 \begin_layout Plain Layout
7961 The corresponding LaTeX commands must appear before the
7972 When such a type is used more than once, the latter usage overwrites the
7973 former one, that means, for every type only the latest usage is valid.
7974 The order of the different types however has, like
7986 , no effect on the appearance of the produced document.
7989 \begin_layout Itemize
7994 : produces a centered paragraph above the ordinary title (
8006 ) for the subject of the document.
8009 \begin_layout Itemize
8014 : produces a centered paragraph below the ordinary title (
8026 ) for the publishers' name.
8029 \begin_layout Itemize
8036 report (koma-script)
8042 produces a centered paragraph on its own page behind the title page, or
8045 article (koma-script)
8047 produces a centered paragraph below the ordinary title (
8066 \begin_layout Itemize
8071 : produces a left aligned paragraph above the ordinary title (
8087 ) for a document`s head.
8090 \begin_layout Itemize
8095 : produces in a double-sided print in
8097 report (koma-script)
8103 a left-aligned paragraph at the top of the title page`s back or has no
8104 effect in a single-sided print or in
8106 article (koma-script)
8111 \begin_layout Itemize
8116 : produces in a double-sided print in
8118 report (koma-script)
8124 a left-aligned paragraph at the bottom of the title page`s back or has
8125 no effect in a single-sided print or in
8127 article (koma-script)
8132 \begin_layout Itemize
8137 : produces a special
8138 \begin_inset Quotes eld
8142 \begin_inset Quotes erd
8145 page ahead of the actual document containing a paragraph without special
8149 \begin_layout Standard
8150 The layout files for the document classes
8152 article (koma-script)
8156 report (koma-script)
8167 This is thought of as a place to define your own types.
8172 in your personal layout directory and edit the file!
8175 \begin_layout Subsection
8176 letter (koma-script)
8179 \begin_layout Standard
8183 \begin_layout Plain Layout
8195 \begin_layout Standard
8199 letter (koma-script)
8201 is implemented in the layout file
8206 It contains all the paragraph types of the corresponding standard document
8211 , partly modified, with the exception of the LyX specific types
8223 type, which is replaced by the new
8228 In addition, it contains, in contrast to the standard document class, the
8246 Furthermore, there are a number of new letter specific types.
8249 \begin_layout Standard
8253 \begin_layout Plain Layout
8265 \begin_layout Standard
8266 The appearance of the letter produced by this document class can be controlled
8267 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8271 \begin_layout Plain Layout
8272 For example, the standard appearance of the letter`s heading, consisting
8273 of name and address, is quite self-willed.
8275 \begin_inset Quotes eld
8279 \begin_inset Quotes erd
8282 heading is produced by the following LaTeX commands in the preamble:
8285 \begin_layout LyX-Code
8295 \begin_layout LyX-Code
8311 \begin_layout LyX-Code
8321 \begin_layout LyX-Code
8341 A detailed German description of such LaTeX commands can be found in the
8342 Koma-Script documentation
8347 With it, the letter's author can produce his personal letter layout.
8350 \begin_layout Standard
8359 define the beginning of the letter and must be used in every letter.
8360 To emphasize them in the LyX document class, they are marked with the letter
8370 \begin_inset Space ~
8374 It is possible to write any number of letters in one file.
8379 type produces a new letter using the same addressee and a
8383 type produces a new addressee.
8400 are ordinary paragraph types and can also be used several times in one
8401 and the same letter.
8404 \begin_layout Itemize
8409 : produces a paragraph for the addressee and implicitly defines the beginning
8413 \begin_layout Itemize
8418 : produces a paragraph for the form of address and implicitly produces a
8422 \begin_layout Itemize
8427 : produces a paragraph for a close.
8430 \begin_layout Itemize
8435 : produces a paragraph for a postscript.
8438 \begin_layout Itemize
8443 : produces a paragraph for a distribution list.
8446 \begin_layout Itemize
8451 : produces a paragraph for enclosures.
8454 \begin_layout Standard
8495 are input types provided with a label to enter information, which will
8496 be processed by the document class.
8500 \begin_layout Plain Layout
8501 It could be seen as a matter of inconsequence, that the types
8509 described above are not such input types as well.
8510 Because of the special meaning of those types, however, I have implemented
8511 them as ordinary paragraph types with a one letter mark in the left margin.
8512 Moreover, it would affect my feeling of symmetry, if the
8520 type had such a serious different appearance.
8525 The types must be used ahead of the corresponding
8532 \begin_layout Standard
8533 An implementation of these types in a WYSIWYG fashion does not seem to make
8534 sense, because the real appearance of the produced letter does not only
8535 depend on the usage of the particular type, but also on other factors.
8536 For example, a signature entered in the
8540 type will in the standard behavior appear in the produced letter only,
8541 when in the same letter also a
8546 The entered value of the
8550 type will in the standard behavior not appear in the produced letter at
8552 The possibility to design the letter`s heading freely is already indicated
8553 in a footnote above.
8556 \begin_layout Standard
8557 The input types can also be used as empty paragraphs.
8559 \begin_inset Space \thinspace{}
8563 \begin_inset Space ~
8575 type is not used at all, in the standard behavior the value of the
8579 type is used as signature, whereas if an empty
8583 type is used, no signature value is defined.
8586 \begin_layout Standard
8587 By using the input types it is possible to write a letter template, containing
8588 filled input types with your personal dates (name, address, etc.) and empty
8589 input types for other dates you want to enter.
8592 \begin_layout Itemize
8597 : sender's name, in the standard behavior appears as a centered paragraph
8598 in small caps in the letter`s heading.
8601 \begin_layout Itemize
8606 : sender's signature, in the standard behavior appears below the
8615 type is used, the value of the
8619 type appears instead.
8622 \begin_layout Itemize
8627 : sender's address, in the standard behavior appears in a centered paragraph
8628 in the letter`s heading below the sender's name.
8631 \begin_layout Itemize
8636 : sender's telephone number, in the standard behavior only sets the LaTeX
8646 \begin_layout Itemize
8651 : place of the letter`s making.
8654 \begin_layout Itemize
8659 : date of the letter`s making.
8668 , in the standard behavior, produce the place and the date in a right-aligned
8669 line below the addressee's field.
8674 type is used, neither place nor date appear, independent of the value of
8684 type is used, the date of the letter `s production is used.
8687 \begin_layout Itemize
8692 : sender`s back address, in the standard behavior appears above the addressee's
8693 field in a small sans serif font.
8696 \begin_layout Itemize
8701 : special mail information, in the standard behavior appears underlined
8702 above the addressee's field below the back address.
8705 \begin_layout Itemize
8710 : additional information, in the standard behavior appears on right side
8711 below the addressee`s field.
8714 \begin_layout Itemize
8719 : the letter's title, in the standard behavior appears in a big, bold, sans
8720 serif font above the subject.
8723 \begin_layout Itemize
8728 : the letter's subject, in the standard behavior appears in a bold font
8736 \begin_layout Standard
8757 produce a business letter like line above the
8761 line containing the fields
8762 \begin_inset Quotes eld
8766 \begin_inset Quotes erd
8770 \begin_inset Quotes eld
8774 \begin_inset Quotes erd
8778 \begin_inset Quotes eld
8782 \begin_inset Quotes erd
8786 \begin_inset Quotes eld
8790 \begin_inset Quotes erd
8794 \begin_inset Quotes eld
8798 \begin_inset Quotes erd
8802 \begin_inset Quotes eld
8806 \begin_inset Quotes erd
8810 For the date field, the value of the
8816 \begin_inset Quotes eld
8819 business letter types
8820 \begin_inset Quotes erd
8823 is used, the value of the
8827 type however does not appear, but only the LaTeX variable
8834 The ordinary output of place and date in a right-aligned line below the
8835 addressee`s field is suppressed.
8836 The types are implemented as input types provided with a label and must
8837 be used ahead of the corresponding
8844 \begin_layout Itemize
8852 \begin_layout Itemize
8860 \begin_layout Itemize
8868 \begin_layout Itemize
8876 \begin_layout Itemize
8884 \begin_layout Subsection
8885 The new letter class: letter (koma-script v.2)
8888 \begin_layout Standard
8891 Jürgen Spitzmüller
8894 \begin_layout Standard
8895 \begin_inset VSpace medskip
8901 \begin_layout Standard
8903 Koma-Script version 2.8 has introduced a new letter class
8907 which supersedes the now unsupported
8912 It has --- on the LaTeX side --- a completely new interface and is not
8913 compatible with the old class.
8914 Therefore, LyX supports both, though it is recommended to use the new class.
8917 \begin_layout Standard
8918 This class covers the same functionality as
8920 letter (koma-script),
8927 (receiver's address, same as
8944 will start a new letter (i.
8945 \begin_inset Space \thinspace{}
8949 \begin_inset Space ~
8952 you can write several letters per document).
8953 New elements are sender's
8969 and the possibility to use a
8978 nsert\SpecialChar \menuseparator
8988 \begin_layout Standard
8989 The biggest improvement is, though, that the letter's layout is configurable
8990 at almost any needs.
8991 This can be done via the preamble or with a special style file (Letter
8992 Class Option, extension
8996 ), that will be read in as a class option.
9000 \begin_layout Plain Layout
9001 The KOMA package comes with some default
9006 There is, for instance, a
9010 file that follows german typesetting rules, or a
9014 that provides the default layout of the old
9019 The latter can be loaded with the class option
9028 ayout\SpecialChar \menuseparator
9033 ocument\SpecialChar \menuseparator
9045 template that is included in LyX for examples.
9046 A detailed description is to be found in the Koma-Script documentation
9054 \begin_layout Subsection
9058 \begin_layout Standard
9059 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9063 \begin_layout Itemize
9064 The chapter number of a
9068 type appears on a line of its own above the chapter heading instead of
9069 appearing in the same line ahead of it.
9070 The cause for that is the LyX internal behavior for the labeltype
9077 \begin_layout Itemize
9078 The headings of the types
9087 \begin_inset Quotes eld
9091 \begin_inset Quotes erd
9094 LaTeX table of contents, but not in the LyX table of contents (
9099 ocument\SpecialChar \menuseparator
9105 \begin_inset Space ~
9109 \begin_inset Space ~
9117 \begin_layout Itemize
9122 document class appear in a skip separation mode, not indented.
9123 This is the standard behavior, no special LaTeX commands are needed for
9130 ocument\SpecialChar \menuseparator
9137 dialog the corresponding radio button indicates
9153 value always has the effect that extra LaTeX commands are inserted in the
9154 document to produce the gap, which is not what is wanted in this case.
9157 \begin_layout Section
9165 \begin_layout Standard
9171 \begin_layout Subsection
9175 \begin_layout Standard
9176 These are the layout files for some of the journal formats used by Springer
9177 Verlag and listed on
9178 \begin_inset Flex URL
9181 \begin_layout Plain Layout
9183 http://www.springer.de/author/tex/help-journals.html
9188 , where you should also go to fetch the class files (yes, these are LaTeX2e
9190 It is a modular system: the things common to all journals are implemented
9195 , which journal-specific layout files (such as, e.
9196 \begin_inset Space \thinspace{}
9203 for Journal of Geodesy) can include.
9206 \begin_layout Standard
9207 This means that implementing support for any other Springer journal on this
9208 list is as simple as writing your own
9216 file following the outline given in
9224 \begin_layout Standard
9225 It is reasonably well tested only for the Journal of Geodesy.
9234 come with the standard LyX distribution.
9235 Install the relevant class file (downloaded from Springer) in a proper
9236 directory, reconfigure LaTeX (in the teTeX case by running
9240 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9241 LyX and it should work.
9244 \begin_layout Subsection
9248 \begin_layout Standard
9249 A large number of theorem-like styles ---
9255 \SpecialChar \ldots{}
9261 \begin_layout Standard
9264 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9265 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9268 See the Springer class file documentation for details.
9271 \begin_layout Subsection
9275 \begin_layout Itemize
9287 \begin_layout Itemize
9290 Probability Theory and Related Fields
9296 --- Jean-Marc Lasgouttes
9299 \begin_layout Standard
9300 Add your own, it isn't so hard!
9303 \begin_layout Subsection
9307 \begin_layout Standard
9308 These files are partly based on the older
9312 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9318 layout, are now defunct.
9319 Jean-Marc Lasgouttes helped out big in making me find my way around the
9320 LyX layout file mechanism.
9323 \begin_layout Subsection
9327 \begin_layout Standard
9329 But probably less than in the old hacked-LaTeX
9336 \begin_layout Standard
9338 \begin_inset Space \thinspace{}
9341 g.: does not display the number for theorem-like layouts, just #.
9344 \begin_layout Section
9352 \begin_layout Standard
9358 \begin_layout Subsection
9362 \begin_layout Standard
9363 These are the layout files for some of the journals of the American Geophysical
9365 It is assumed that you have both the AGU's own class files and AGUplus
9366 installed (everything to be found at
9367 \begin_inset Flex URL
9370 \begin_layout Plain Layout
9372 ftp://ftp.agu.org/journals/latex/journals
9380 \begin_layout Subsection
9384 \begin_layout Standard
9394 They are still called this in the LyX GUI, though their LaTeX equivalents
9395 in the AGU classes are
9406 \begin_layout Standard
9407 Newly defined styles are
9444 These are mostly manuscript attributes and defined in the AGU class documentati
9448 \begin_layout Standard
9449 I suspect this is still badly incomplete.
9452 \begin_layout Subsection
9456 \begin_layout Standard
9473 \begin_layout Subsection
9477 \begin_layout Itemize
9480 Journal of Geophysical Research
9489 \begin_layout Standard
9490 Add your own, it isn't so hard! Look at the
9501 \begin_layout Subsection
9502 Bugs and things to remember
9505 \begin_layout Standard
9506 In order to use the new layouts, you must remember to do the following for
9510 \begin_layout Enumerate
9516 This can be done in the
9518 layout\SpecialChar \menuseparator
9523 document\SpecialChar \menuseparator
9527 (AGU articles are always in English, right? So
9534 \begin_layout Enumerate
9544 (Yes, this is a bug.)
9547 \begin_layout Enumerate
9548 Make sure you use the
9552 bibliography style, by entering
9556 into the second field of the BibTeX inset.
9557 None of the standard styles will do.
9560 \begin_layout Section
9568 \begin_layout Standard
9574 \begin_layout Subsection
9578 \begin_layout Standard
9579 This is the layout file for the European Geophysical Society journals.
9584 can be downloaded from the web site of the EGS under
9585 \begin_inset Flex URL
9588 \begin_layout Plain Layout
9598 \begin_layout Subsection
9602 \begin_layout Standard
9605 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9613 The current layout file is unfortunately very unmodular and would benefit
9614 from using the various
9621 \begin_layout Section
9627 \begin_inset CommandInset label
9636 \begin_layout Standard
9644 \begin_layout Subsection
9648 \begin_layout Standard
9649 This section describes how to use LyX to make slides for overhead projectors.
9650 There are two document classes that can do this: the default slides class
9656 This section documents the former.
9659 \begin_layout Standard
9660 I'm going to say this again, nice and clear, so that there's no misunderstanding
9664 \begin_layout Standard
9665 \begin_inset VSpace bigskip
9671 \begin_layout Standard
9675 This section documents the class
9676 \begin_inset Quotes eld
9684 \begin_inset Quotes erd
9692 \begin_layout Standard
9693 \begin_inset VSpace bigskip
9699 \begin_layout Standard
9700 If you're looking for the documentation for
9701 \begin_inset Quotes eld
9709 \begin_inset Quotes erd
9713 \begin_inset Space ~
9717 \begin_inset CommandInset ref
9719 reference "sec:foiltex"
9729 \begin_inset Quotes eld
9737 \begin_inset Quotes erd
9740 ] is actually somewhat better than the default
9748 \begin_layout Plain Layout
9749 \SpecialChar \ldots{}
9750 or so I've been told repeatedly by its advocates.
9751 Having never used it, I have no idea if this claim is true or not.
9756 which this section documents.
9759 \begin_layout Standard
9760 This class is the LaTeX2e improvement of the old
9765 Every LaTeX2e distribution includes this class [which I'll just refer to
9767 \begin_inset Quotes eld
9775 \begin_inset Quotes erd
9778 from now on], so you're bound to have it.
9779 As I noted earlier, there are other classes, such as
9783 , which also produce slides for overhead projectors and do a better job
9785 However, there are some things which
9789 can do which the others can't, such as generate overlays.
9790 Read on to learn more!
9793 \begin_layout Subsection
9795 \begin_inset CommandInset label
9797 name "sec:slidesetup"
9804 \begin_layout Standard
9805 Obviously, to use this document class, you need to select
9806 \begin_inset Quotes eld
9814 \begin_inset Quotes erd
9817 from the class list in the
9822 ocument\SpecialChar \menuseparator
9830 There are some other special things you should know about this class:
9833 \begin_layout Itemize
9834 Don't bother changing the options
9839 They're not supported by the
9846 \begin_layout Itemize
9853 \begin_inset Space ~
9858 behaves a bit differently for this class.
9859 The possible choices and what they do are as follows:
9863 \begin_layout Description
9868 The final output contains page numbers in the lower right corner.
9871 \begin_layout Description
9880 , but also prints out any time markers you've put in.
9881 This is the default.
9884 \begin_layout Description
9889 The final output contains no page numbers, time markers, or alignment markers.
9893 \begin_layout Itemize
9898 class has an extra option:
9904 \begin_inset Quotes eld
9912 \begin_inset Quotes erd
9915 in the extra class options.
9919 \begin_layout Standard
9920 Using this options allows you to add time markers to
9926 \begin_inset Space ~
9930 \begin_inset CommandInset ref
9932 reference "sec:slideNote"
9940 \begin_layout Standard
9941 You can also use the template file
9942 \begin_inset Quotes eld
9950 \begin_inset Quotes erd
9953 to automatically set up a document to use the
9962 ile\SpecialChar \menuseparator
9964 \begin_inset Space ~
9968 \begin_inset Space ~
9977 to open your new document].
9978 The template file also contains some examples of the special paragraph
9979 environments used by this class.
9980 I'll describe those next.
9983 \begin_layout Subsection
9984 Paragraph Environments
9987 \begin_layout Subsubsection
9988 Supported Environments
9991 \begin_layout Standard
9992 The first thing you'll notice when you start up a new
9996 document is the font size and type: it's the equivalent of the size
9997 \begin_inset Quotes eld
10005 \begin_inset Quotes erd
10011 \begin_inset Space ~
10017 This is also what's used in the output.
10019 \begin_inset Quotes eld
10023 \begin_inset Quotes erd
10026 to remind you that this is a slide.
10027 Your final slides will use a larger font; ergo, you'll have less space.
10028 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10031 \begin_layout Standard
10032 The next thing that becomes obvious is the changes to the paragraph environment
10033 pull-down box [at the far-left end of the toolbar].
10034 Most of the paragraph environments you're used to seeing are missing.
10035 There are also five new ones.
10040 class itself only supports certain paragraph environments:
10043 \begin_layout Itemize
10049 \begin_layout Itemize
10055 \begin_layout Itemize
10061 \begin_layout Itemize
10067 \begin_layout Itemize
10073 \begin_layout Itemize
10079 \begin_layout Itemize
10085 \begin_layout Itemize
10091 \begin_layout Itemize
10097 \begin_layout Itemize
10103 \begin_layout Itemize
10109 \begin_layout Standard
10110 All of the other standard environments, including the section-heading environmen
10111 ts, aren't used in the
10118 \begin_layout Standard
10119 On the other hand, you'll notice the following new environments:
10122 \begin_layout Itemize
10128 \begin_layout Itemize
10134 \begin_layout Itemize
10140 \begin_layout Itemize
10146 \begin_layout Itemize
10152 \begin_layout Standard
10153 These five are kind of quirky, due to a
10154 \begin_inset Quotes eld
10158 \begin_inset Quotes erd
10162 You see, LyX doesn't permit you to nest any other paragraph environment
10163 into an empty environment.
10164 Now, that's fine and dandy, but it means that you wouldn't be able to start
10165 a slide with anything except plain text.
10166 To deal with this, I've performed a little
10167 \begin_inset Quotes eld
10171 \begin_inset Quotes erd
10177 \begin_layout Subsubsection
10178 Quirks of the New Environments
10179 \begin_inset CommandInset label
10181 name "sec:slideQuirk"
10188 \begin_layout Standard
10189 All five of the new paragraph environments are somewhat quirky due to inherent
10190 limitiations in the current version of LyX.
10191 As I just mentioned, LyX forbids environments that begin with another environme
10193 To get around this, the
10197 environment isn't a paragraph environment as described in the
10205 \begin_layout Standard
10206 You should consider
10219 \begin_inset Quotes eld
10222 pseudo-environments.
10223 \begin_inset Quotes erd
10226 They look like a section heading or a
10227 \begin_inset Quotes eld
10235 \begin_inset Quotes erd
10238 but really begin a [and, if necessary, end the previous] paragraph environment.
10248 \begin_inset Quotes eld
10252 \begin_inset Quotes erd
10255 These two perform some action.
10258 \begin_layout Standard
10259 A common feature of all five environments,
10279 , is a rather long-ish label.
10280 The text following this label --- ordinarily the contents of the paragraph
10281 environment --- is utterly irrelevant for
10302 LyX completely ignores it.
10303 In fact, you can leave these five environments completely empty.
10307 \begin_layout Standard
10312 to put any text after the rather long-ish label, you might want to.
10313 This could be a short description of the contents of the
10318 In that case, enter in your descriptive comment and hit
10322 as you normally would.
10325 \begin_layout Standard
10326 If, on the other hand, you don't want to enter in any descriptive text,
10327 you'll hit another LyX quirk.
10328 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10329 environment until you put something in the old one.
10333 \begin_layout Itemize
10334 Start entering the text that will
10362 \begin_layout Itemize
10363 Now move to the beginning of that paragraph.
10367 \begin_layout Itemize
10376 \begin_layout Itemize
10377 Finally, change this new, empty paragraph to a
10401 \begin_layout Standard
10402 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10406 \begin_layout Subsection
10407 Making a Presentation with
10420 \begin_layout Subsubsection
10428 \begin_layout Standard
10429 If you're expecting this section to teach you how to actually make a presentatio
10430 n, you'll be sorely disappointed.
10431 Naturally, I'll describe all of the ways the
10435 class can assist you in preparing the materials for a presentation.
10436 Filling in the contents, however, is up to you.
10441 the LyX philosophy.]
10444 \begin_layout Standard
10449 environment [in the manner described in section
10450 \begin_inset Space ~
10454 \begin_inset CommandInset ref
10456 reference "sec:slideQuirk"
10460 ] tells LyX to begin a new slide [duh].
10461 The label for this environment/
10462 \begin_inset Quotes erd
10466 \begin_inset Quotes erd
10470 \begin_inset Quotes eld
10474 \begin_inset Quotes erd
10477 in cool blue, followed by the label,
10478 \begin_inset Quotes eld
10482 \begin_inset Quotes erd
10486 Any text or paragraph environments that follow this one go on the new slide.
10490 \begin_layout Standard
10491 Slides are probably the only time you'll need to forcibly end pages in LyX
10492 (this can be specified in the
10497 In fact, you'll want to, once you finish entering the contents of one slide.
10498 If you've entered more text than can physically fit on a slide, the extra
10499 overflows onto a new slide.
10500 I don't recommend doing this, however, since the overflow slide won't have
10501 any page number on it.
10502 Furthermore, it may interfere with any
10506 you've made to accompany the oversized
10513 \begin_layout Standard
10522 environments work the same way as the
10527 They both create an
10528 \begin_inset Quotes eld
10532 \begin_inset Quotes erd
10535 followed by a label [
10536 \begin_inset Quotes eld
10540 \begin_inset Quotes erd
10544 \begin_inset Quotes eld
10548 \begin_inset Quotes erd
10552 The color is a stunning magenta instead of blue, and the
10553 \begin_inset Quotes eld
10557 \begin_inset Quotes erd
10560 will look different, in style and in length.
10561 The label fonts of all three also differ from one another.
10564 \begin_layout Standard
10569 , if the contents of a
10577 exceed the physical size of a slide or sheet of paper, the extra will overflow
10579 Again, you should avoid this.
10580 It defeats the whole purpose of
10591 \begin_layout Subsubsection
10601 \begin_layout Standard
10606 is a slide that sits atop another slide.
10607 Perhaps you wish to discuss a figure on the main
10611 before displaying the text associated with it.
10612 One way to accomplish this is tape a flap of dark paper over the part of
10617 you want to display later.
10618 This method fails, however, if you wish to overlap one graph with another,
10620 You would then have to fumble while speaking to align the two separate,
10625 s to align the two graphs.
10630 environment in both cases makes life much easier.
10633 \begin_layout Standard
10638 receives the page number of its
10639 \begin_inset Quotes eld
10643 \begin_inset Quotes erd
10651 \begin_inset Quotes eld
10659 \begin_inset Quotes erd
10666 \begin_layout Plain Layout
10667 Presumably, mutliple
10672 \begin_inset Quotes eld
10680 \begin_inset Quotes erd
10684 \begin_inset Quotes eld
10692 \begin_inset Quotes erd
10696 \begin_inset Quotes eld
10704 \begin_inset Quotes erd
10708 \begin_inset Space ~
10711 appended to the page number of the parent
10721 Clearly, you want the contents of both the
10729 to each fit on a single physical slide! You should probably consider an
10735 \begin_inset Quotes eld
10739 \begin_inset Quotes erd
10751 class provides a visual cue for this: the label at the start of an
10755 is shorter than that at the start of a
10760 Lastly, when you generate printable output, you'll find alignment markers
10761 in all four corners of both the
10765 page and its parent
10770 These will assist you in lining up the two physical slides.
10773 \begin_layout Standard
10774 The major problem in overlaying two slides is aligning the contents of the
10775 two transparencies.
10776 How much space should you leave for that graph on the second slide? Worse
10777 still, what if you want a graph and a sentence on second slide, but there
10778 is text on the main transparency that goes in between them? You could try
10779 and insert vertical space of the right size.
10780 The better way is to use
10791 \begin_layout Standard
10792 As their names imply,
10800 are two command-like paragraph environments that make all subsequent text
10801 invisible and visible, respectively.
10803 \begin_inset Space ~
10807 \begin_inset CommandInset ref
10809 reference "sec:slideQuirk"
10813 that you don't place anything
10817 these two environments, however.
10822 , it inserts a centered, sky-blue label into the page reading
10823 \begin_inset Quotes eld
10826 <Invisible Text Follows>
10827 \begin_inset Quotes erd
10831 For paragraphs following this label, the parts of the
10839 ; it doesn't matter which] where they would be contain instead blank space.
10843 \begin_layout Standard
10848 , the corresponding centered label is
10849 \begin_inset Quotes eld
10852 <Visible Text Follows>
10853 \begin_inset Quotes erd
10857 Paragraphs following this label behave normally.
10858 Note that the beginning of a new
10870 automatically shuts off an
10875 It's therefore not necessary to use
10886 \begin_layout Standard
10887 By now, it should be obvious how to create overlay transparencies using
10888 the proper combination of
10907 \begin_layout Enumerate
10912 , including everything that will appear on it, whether on the main slide
10920 \begin_layout Enumerate
10921 Before each figure or paragraph that will appear only on the
10930 If necessary, insert a
10934 environment after the
10941 \begin_layout Enumerate
10946 immediately following the
10953 \begin_layout Enumerate
10954 Copy the contents of this
10965 \begin_layout Enumerate
10970 , change all of the
10981 \begin_layout Standard
10983 You've just made an
10990 \begin_layout Standard
10991 There's one problem with the way I've designed the LyX
10995 class: you can't make text in the middle of a paragraph invisible, nor
10996 make text in the middle of an invisible paragraph visible again.
10997 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11001 \begin_layout Plain Layout
11002 The commands of interest are:
11005 \begin_layout Itemize
11010 invisible \SpecialChar \ldots{}
11014 \begin_layout Itemize
11019 visible \SpecialChar \ldots{}
11023 \begin_layout Plain Layout
11024 \SpecialChar \ldots{}
11025 and need to be marked as TeX.
11027 \begin_inset Quotes eld
11031 \begin_inset Quotes erd
11034 you wish to change goes in between the brackets [and after the
11047 If you don't know how to mark text as TeX, see the appropriate section
11060 \begin_layout Subsubsection
11070 \begin_inset CommandInset label
11072 name "sec:slideNote"
11079 \begin_layout Standard
11088 is associated with a
11089 \begin_inset Quotes eld
11093 \begin_inset Quotes erd
11105 class provides visual cues.
11110 is shorter than that of a
11114 [yet longer than that of an
11118 ] and, like the label of an
11122 is shockingly magenta.
11123 Additionally, the printed
11127 has the page number of its
11128 \begin_inset Quotes eld
11132 \begin_inset Quotes erd
11140 \begin_inset Quotes eld
11148 \begin_inset Quotes erd
11152 \begin_inset Quotes eld
11160 \begin_inset Quotes erd
11164 \begin_inset Quotes eld
11172 \begin_inset Quotes erd
11176 You can have multiple
11180 s associated with a single
11192 , you'll probably want to break up long
11196 s so that they fit on a single sheet of paper.
11199 \begin_layout Standard
11204 is obvious: it contains anything additional you might want to say about
11210 It could also be used as a sheet of reminders for a particular
11215 In the case of the latter, you might want to make use of time markers.
11221 \begin_inset Quotes eld
11225 \begin_inset Quotes erd
11228 support for time markers, a
11233 So, you'll have to resort to using the LaTeX codes.
11236 \begin_layout Standard
11237 To use time markers, you'll need to specify the extra class option
11238 \begin_inset Quotes eld
11246 \begin_inset Quotes erd
11250 \begin_inset Space ~
11254 \begin_inset CommandInset ref
11256 reference "sec:slidesetup"
11261 This option turns on timing marks, which will appear in the lower-left-hand
11267 To set what appears in the time marker, you use the LaTeX commands
11268 \begin_inset Quotes eld
11278 \begin_inset Quotes erd
11282 \begin_inset Quotes eld
11292 \begin_inset Quotes erd
11296 The arguments of both commands are time measured in seconds.
11298 \begin_inset Quotes eld
11308 \begin_inset Quotes erd
11311 sets the time marker to a given time.
11313 \begin_inset Quotes eld
11323 \begin_inset Quotes erd
11326 increments the time marker by the specified amount.
11327 Using time markers and
11331 s in this fashion, you can remind yourself how much time to spend on a particula
11339 \begin_layout Standard
11340 There's one last feature to describe.
11341 Clearly, you'd like to print out all of your
11349 s on transparencies while printing all of your
11366 with which it is associated.
11367 What's a person to do?
11370 \begin_layout Standard
11371 Luckily, there are two LaTeX commands that allow you to select what to print
11373 Both must be placed into the preamble of your document.
11375 \begin_inset Quotes eld
11387 \begin_inset Quotes erd
11390 will cause the output to contain only the
11399 Correspondingly, the command
11400 \begin_inset Quotes eld
11412 \begin_inset Quotes erd
11415 prevents the output of anything but
11420 I'd advise placing both commands in the preamble and initially comment
11422 You can then preview your entire presentation as you write.
11423 When you're done writing, you can then uncomment one of the two to select
11424 what you want to print.
11425 I like to uncomment
11426 \begin_inset Quotes eld
11438 \begin_inset Quotes erd
11441 , print to a file with
11442 \begin_inset Quotes eld
11450 \begin_inset Quotes erd
11453 in its name, comment it back out, then uncomment
11454 \begin_inset Quotes eld
11466 \begin_inset Quotes erd
11470 \begin_inset Quotes eld
11478 \begin_inset Quotes erd
11482 I can then send either file to a printer, loading transparencies or plain
11483 paper as appropriate.
11486 \begin_layout Standard
11487 You can also provide other arguments to the
11488 \begin_inset Quotes eld
11498 \begin_inset Quotes erd
11502 \begin_inset Quotes eld
11512 \begin_inset Quotes erd
11516 See a good LaTeX book for details.
11519 \begin_layout Subsection
11524 Class Template File
11527 \begin_layout Standard
11528 I have also provided a template file,
11529 \begin_inset Quotes eld
11537 \begin_inset Quotes erd
11545 To use it, begin your new presentation with
11550 ile\SpecialChar \menuseparator
11552 \begin_inset Space ~
11556 \begin_inset Space ~
11566 Your new LyX presentation file will contain an example
11587 additionally contain an example of the use of
11596 Lastly, the preamble will contain:
11599 \begin_layout LyX-Code
11600 % Uncomment to print out only slides and overlays
11603 \begin_layout LyX-Code
11607 \begin_layout LyX-Code
11613 \begin_inset Newline newline
11619 \begin_layout LyX-Code
11620 % Uncomment to print out only notes
11623 \begin_layout LyX-Code
11627 \begin_layout LyX-Code
11635 \begin_layout Standard
11636 One final thing: I created this class to support the LaTeX2e
11637 \begin_inset Quotes eld
11645 \begin_inset Quotes erd
11648 class, one of the built-in LaTeX2e classes.
11649 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11650 built-in slide class.
11651 It's here if you want it or need it.
11652 There exist other LaTeX2e classes for creating presentations, such as the
11658 \begin_inset Space ~
11662 \begin_inset CommandInset ref
11664 reference "sec:foiltex"
11669 \begin_inset Quotes eld
11677 \begin_inset Quotes erd
11680 package [present on some TeX distributions].
11681 The latter is not yet supported under LyX.
11685 \begin_layout Plain Layout
11686 Perhaps you can take on the task\SpecialChar \ldots{}
11692 I know nothing about these other classes.
11693 Try them out to see what sort of alternative they provide.
11696 \begin_layout Section
11705 \begin_inset CommandInset label
11714 \begin_layout Standard
11720 \begin_layout Subsection
11724 \begin_layout Standard
11725 This section describes how to use LyX to make slides for overhead projectors.
11726 There are two document classes that can do this: the default slides class
11732 This section documents the latter.
11735 \begin_layout Standard
11736 I'm going to say this again, nice and clear, so that there's no misunderstanding
11740 \begin_layout Standard
11741 \begin_inset VSpace bigskip
11747 \begin_layout Standard
11751 This section documents the class
11752 \begin_inset Quotes eld
11760 \begin_inset Quotes erd
11768 \begin_layout Standard
11769 \begin_inset VSpace bigskip
11775 \begin_layout Standard
11776 If you're looking for the documentation for
11777 \begin_inset Quotes eld
11785 \begin_inset Quotes erd
11788 , check out section
11789 \begin_inset Space ~
11793 \begin_inset CommandInset ref
11795 reference "sec:slitex"
11800 If your machine doesn't have the
11805 \begin_inset Quotes eld
11813 \begin_inset Quotes erd
11816 ] installed, you'll probably have to use the default
11820 class, which isn't quite as good as
11825 \begin_layout Standard
11830 class is designed for use with version 2.1 of the
11834 LaTeX class file which is now an integral part of LaTeX2e.
11837 \begin_layout Subsection
11841 \begin_layout Standard
11842 Obviously, to use this document class, you need to select
11843 \begin_inset Quotes eld
11851 \begin_inset Quotes erd
11864 \begin_inset Space ~
11870 There are some settings in the
11873 \begin_inset Space ~
11878 dialog that you should know about that are specific to this class:
11881 \begin_layout Itemize
11882 Don't change the options
11893 \begin_inset Space ~
11899 They're ignored by the
11906 \begin_layout Itemize
11907 The default font size is 20pt with the other options being 17pt, 25pt and
11911 \begin_layout Itemize
11912 The default font is
11920 but all math equations are still typeset in the usual roman font.
11923 \begin_layout Itemize
11928 TeX supports A4 and Letter paper sizes as well as a special size for working
11930 It doesn't support A5, B5, legal or executive paper sizes.
11933 \begin_layout Itemize
11934 Don't bother changing the
11938 settings because they are ignored anyway.
11939 All floats appear where they are defined in the text.
11942 \begin_layout Itemize
11950 setting behaves a bit differently for this class.
11955 TeX provides extensive footer and header capabilities including a user-defined
11958 \begin_inset Space ~
11962 \begin_inset CommandInset ref
11964 reference "sec:foilfoot"
11969 The title page is treated differently to all other pages in the document
11978 has the logo centered at the bottom of the page (if one is defined).
11979 The possible page style choices and what they do are as follows:
11984 \labelwidthstring MMMMMMM
11991 The final output contains no page numbers, or other headers or footers
11992 (except footnotes of course).
11997 \labelwidthstring MMMMMMM
12004 The final output contains page numbers centered at the bottom of the page.
12005 No other headings or footers (other than footnotes).
12009 \labelwidthstring MMMMMMM
12014 Page numbers in lower right corner.
12015 Additional headers and footers are also shown.
12016 This is also the default.
12020 \labelwidthstring MMMMMMM
12025 Gives you access to the
12029 package although its use with
12033 TeX is discouraged by the writer of the
12037 TeX package because of some potential page layout clashes.
12041 \begin_layout Subsubsection
12045 \begin_layout Standard
12046 The following options may be used in the extra class options in the
12051 ocument\SpecialChar \menuseparator
12062 \labelwidthstring MMMMMMx
12067 This sets up the page layout for 7.33in by 11in paper, which is about the
12068 same aspect ratio as a 35mm slide, making it a bit easier to work with
12073 \labelwidthstring MMMMMMx
12078 Places a rule across the page below the header on every page except the
12083 \labelwidthstring MMMMMMx
12088 Places a rule across the page above the footer on every page except the
12093 \labelwidthstring MMMMMMx
12098 This is automatically set each time you create a new
12107 TeX to use the dvips driver to rotate those pages that are set as landscape
12112 \labelwidthstring MMMMMMx
12117 Simply changes the page dimensions to those of a landscape page but doesn't
12119 Thus if you use this option you need to use an external program to rotate
12120 each page or feed your paper through your printer as landscape.
12121 Note that this option effectively reverses the roles of the
12129 environments (don't worry these are described in the next section).
12133 \labelwidthstring MMMMMMx
12138 Equation numbers on the left.
12142 \labelwidthstring MMMMMMx
12147 Flush-left equations.
12150 \begin_layout Subsection
12151 Supported Environments
12154 \begin_layout Standard
12155 Most of the environments commonly supported in other classes are also supported
12161 There are several additional environments provided by
12165 TeX as well as a couple added by LyX.
12166 The following environments are shared with other classes:
12169 \begin_layout Standard
12173 \begin_layout Plain Layout
12177 begin{multicols}{2}
12185 \begin_layout Itemize
12191 \begin_layout Itemize
12197 \begin_layout Itemize
12203 \begin_layout Itemize
12209 \begin_layout Itemize
12215 \begin_layout Itemize
12221 \begin_layout Itemize
12227 \begin_layout Itemize
12233 \begin_layout Itemize
12239 \begin_layout Itemize
12245 \begin_layout Itemize
12251 \begin_layout Itemize
12257 \begin_layout Itemize
12263 \begin_layout Itemize
12269 \begin_layout Itemize
12275 \begin_layout Itemize
12281 \begin_layout Itemize
12287 \begin_layout Itemize
12293 \begin_layout Standard
12297 \begin_layout Plain Layout
12309 \begin_layout Standard
12310 That is, all the major environments apart from the sectioning environments.
12311 Since foils are essentially self-contained sections, with a title and body,
12316 TeX provides specific commands for starting new foils and these are:
12319 \begin_layout Itemize
12325 \begin_layout Itemize
12331 \begin_layout Standard
12332 LyX also provides slightly modified versions of these two environments called:
12335 \begin_layout Itemize
12341 \begin_layout Itemize
12344 ShortRotatefoilhead
12347 \begin_layout Standard
12348 and the differences will be explained in the next section.
12351 \begin_layout Standard
12352 Since foils are often used in presenting ideas or new theorems and such
12357 TeX also provides a comprehensive box of goodies for presenting them:
12360 \begin_layout Standard
12364 \begin_layout Plain Layout
12368 begin{multicols}{2}
12376 \begin_layout Itemize
12382 \begin_layout Itemize
12388 \begin_layout Itemize
12394 \begin_layout Itemize
12400 \begin_layout Itemize
12406 \begin_layout Itemize
12412 \begin_layout Itemize
12418 \begin_layout Itemize
12424 \begin_layout Itemize
12430 \begin_layout Itemize
12436 \begin_layout Itemize
12442 \begin_layout Standard
12446 \begin_layout Plain Layout
12458 \begin_layout Standard
12459 The starred versions are unnumbered while the unstarred versions are numbered.
12460 There are also two list environments added by LyX and these are:
12463 \begin_layout Itemize
12469 \begin_layout Itemize
12475 \begin_layout Standard
12480 TeX provides some powerful header and footer capabilities that are best
12481 set in the preamble although they may be set at any point in a document.
12482 If you want to change these settings in your document the best place to
12483 do so is at the very top of a foil,
12488 straight after the foilhead.
12491 \begin_layout Standard
12492 For this purpose, the following command styles are provided [
12499 \begin_layout Standard
12503 \begin_layout Plain Layout
12507 begin{multicols}{2}
12515 \begin_layout Itemize
12519 \begin_inset Space ~
12525 \begin_layout Itemize
12531 \begin_layout Itemize
12535 \begin_inset Space ~
12541 \begin_layout Itemize
12545 \begin_inset Space ~
12551 \begin_layout Itemize
12555 \begin_inset Space ~
12562 \begin_layout Standard
12563 \begin_inset Space ~
12570 \begin_layout Standard
12574 \begin_layout Plain Layout
12586 \begin_layout Standard
12587 There are also a few commands provided by
12591 TeX that aren't directly supported by LyX but I'll tell you what they do
12592 and how to use them in section
12593 \begin_inset Space ~
12597 \begin_inset CommandInset ref
12599 reference "sec:unsuppfoils"
12606 \begin_layout Subsection
12607 Building a Set of Foils
12610 \begin_layout Standard
12611 This section will give a simple introduction to using the different environments
12612 to build a set of foils.
12613 If you want to see an example set of foils take a look at the
12617 file accessible from the
12622 ile\SpecialChar \menuseparator
12627 pen\SpecialChar \ldots{}
12638 \begin_layout Subsubsection
12639 Give It a Title Page
12642 \begin_layout Standard
12643 Unlike other classes that provide
12663 creates the title on a page of its own.
12664 If you leave out the
12668 environment LaTeX will substitute the current date (every time you regenerate
12672 \begin_layout Subsubsection
12676 \begin_layout Standard
12677 As I mentioned earlier, there are four ways of starting a new foil.
12678 For portrait foils you should use
12687 The difference between these two environments is the amount of space between
12688 the title of the foil (the foilhead) and the body of the foil.
12691 \begin_layout Standard
12692 Landscape foils are generated using the
12698 ShortRotatefoilhead
12701 Again the only difference is the spacing between foilhead and body.
12702 Both of the short versions have 0.5 inches less separation between the foilhead
12707 \begin_layout Standard
12708 One problem with the support for landscape foils is the requirement that
12709 you have to use the
12713 driver to generate the PostScript output otherwise the foils won't be rotated.
12714 It is possible to get landscape foils even if you haven't got the
12718 driver provided you can feed your foils sideways through your printer ;-)
12721 \begin_layout Subsubsection
12722 Theorems, Lemmas, Proofs and more
12725 \begin_layout Standard
12726 Due to a small bug in LyX you can't have two of the same type of these environme
12727 nts directly following each other.
12728 They must be separated by something.
12729 If you try, you will just be extending the previous environment as if you
12730 had merged the two environments together.
12731 So, how do you get around this problem? The simplest option is to insert
12732 some text between the two environments or add a
12736 environment between the two with just a
12737 \begin_inset Quotes eld
12745 \begin_inset Quotes erd
12749 This will force LyX to produce two separate environments and hence the
12750 correct LaTeX output.
12751 An example is provided in the example file included with the LyX distribution.
12752 Remember, this problem only occurs if you are trying to place two of the
12753 same type of theorem-like environments one directly after the other.
12756 \begin_layout Subsubsection
12760 \begin_layout Standard
12761 You get all the commonly supported list styles found in other classes as
12762 well as two new ones.
12763 I'll only describe the new ones here.
12764 If you want to find out more about the other list environments check out
12770 If you intend to use itemized lists you might also want to read about the
12774 \begin_inset Space ~
12778 \begin_inset Space ~
12783 dialog described above in section
12784 \begin_inset Space ~
12788 \begin_inset CommandInset ref
12790 reference "sec:bullet"
12797 \begin_layout Standard
12798 The two new list styles,
12806 , are designed to make it easier for you to create lists of do's and don'ts
12807 or right and wrong by providing dedicated environments that use a tick
12808 or a cross as the label of the list.
12809 These lists are in fact dedicated variants of the
12814 They do however require that you have the
12818 packages installed.
12821 \begin_layout Subsubsection
12825 \begin_layout Standard
12830 TeX redefines the floating tables and figures so that they appear exactly
12831 where they are in the text rather than pushing them to the top of the page
12832 or to some user specified location.
12833 In fact if you change the float placement settings they are simply ignored.
12836 \begin_layout Subsubsection
12837 Page Headers and Footers
12838 \begin_inset CommandInset label
12840 name "sec:foilfoot"
12847 \begin_layout Standard
12851 \begin_inset Space ~
12860 are two commands used to control the left-footer text string.
12861 The first is meant to allow you to include a graphic logo on your foils
12863 \begin_inset Quotes eld
12871 \begin_inset Quotes erd
12875 While the second is meant to provide a classification for the audience,
12879 \begin_inset Space \thinspace{}
12885 \begin_inset Space ~
12889 It is empty by default.
12892 \begin_layout Standard
12893 The remaining page corners can be filled by
12896 \begin_inset Space ~
12901 (which defaults to page numbers),
12904 \begin_inset Space ~
12912 \begin_inset Space ~
12920 \begin_layout Subsection
12926 \begin_inset CommandInset label
12928 name "sec:unsuppfoils"
12935 \begin_layout Standard
12936 All the commands mentioned below need to be set in a
12944 within another environment.
12947 \begin_layout Subsubsection
12951 \begin_layout Standard
12952 All lengths are adjusted using the
12975 should be replaced by the name given to the length you want to change and
12980 is the length value.
12981 All lengths should be specified in units of length such as inches (
12993 ) or relative to some document or font-based length such as
13003 \begin_layout Standard
13004 It's possible to change the spacing between a foilhead and the body of the
13005 foil by adjusting the length specified by
13012 For example, to make
13016 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13023 foilheadskip}{-0.5in}
13026 \begin_layout Standard
13027 The spacings around floats can be adjusted by setting these lengths:
13031 \labelwidthstring MMMMMMMMMMM
13038 Separation between the text and the top of the float
13042 \labelwidthstring MMMMMMMMMMM
13049 Separation between the float and the caption
13053 \labelwidthstring MMMMMMMMMMM
13060 Separation between the caption and the following text
13064 \labelwidthstring MMMMMMMMMMM
13071 You can make the captions narrower than the surrounding text by adjusting
13073 Best done relative to
13082 \begin_layout Standard
13083 There are also several title page related lengths that you may find useful
13084 if you have a long title or several authors:
13088 \labelwidthstring MMMMMMMMMMM
13095 Separation from headers to
13101 \labelwidthstring MMMMMMMMMMM
13120 \labelwidthstring MMMMMMMMMMM
13135 \labelwidthstring MMMMMMMMMMM
13152 \labelwidthstring MMMMMMMMMMM
13168 \begin_layout Standard
13169 The last length related command affects all the list environments.
13180 a list environment then all the vertical spacing between the list items
13182 Note that this is a command not a length so it doesn't require
13188 like the stuff mentioned above.
13191 \begin_layout Subsubsection
13192 Headers and Footers
13195 \begin_layout Standard
13208 commands control whether the logo in the
13212 definition appear on a given page.
13219 in the preamble then none of the foils will have the logo on them.
13220 If you don't want the logo on a particular page place the
13226 directly after the foilhead of that page and the
13232 directly after the next foilhead.
13235 \begin_layout Standard
13236 If you decide to use the
13240 page style setting in the
13243 \begin_inset Space ~
13248 dialog you should probably add
13258 to your preamble so headers and footers on landscape pages are correctly
13259 placed when rotated.
13260 This is due to some clashes between the page layouts provided by the
13271 \begin_layout Section
13272 Latex8 (IEEE Conference Papers)
13275 \begin_layout Standard
13281 \begin_layout Subsection
13285 \begin_layout Standard
13286 Since this class is specifically for writing submissions to IEEE sponsored
13287 conferences I strongly recommend that you get a copy of their Authors Kit.
13292 package and associated bibliography style file is included in the kit.
13293 The Authors Kit is usually sent out by email once your initial submission
13295 There is a lot of useful information in the Authors Kit explaining formatting
13296 restrictions and so on and I will assume you have read this since that
13297 means I don't have to repeat it all here.
13300 \begin_layout Subsection
13304 \begin_layout Standard
13305 [AR\SpecialChar \@.
13309 \begin_layout Subsection
13310 Supported Environments
13313 \begin_layout Itemize
13319 \begin_layout Itemize
13325 \begin_layout Itemize
13331 \begin_layout Itemize
13337 \begin_layout Itemize
13343 \begin_layout Itemize
13349 \begin_layout Itemize
13355 \begin_layout Itemize
13361 \begin_layout Itemize
13367 \begin_layout Subsection
13368 Differences Between Screen and Paper
13371 \begin_layout Standard
13372 There are slight differences in appearance mainly with the presentation
13373 of section counters.
13374 On screen the trailing period of the section counter is missing but it
13375 will appear in the output so don't let this worry you.
13378 \begin_layout Section
13379 Hollywood (Hollywood spec scripts)
13382 \begin_layout Standard
13388 \begin_layout Subsection
13392 \begin_layout Standard
13393 Getting the format of a Hollywood script right is a
13394 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13401 It is designed to make the readers focus on content and to be easy and
13402 familiar for the actors to read.
13403 Each page of a script should be one minute of film.
13404 Nothing goes in a script that you cannot see or hear on screen.
13405 The courier 12 pt font should be used throughout.
13409 \begin_layout Subsection
13413 \begin_layout Standard
13414 Speakers' lines should NEVER break in mid-sentence.
13415 If a speaker's lines continue over a page break, repeat the
13419 title followed by (Cont'd).
13422 \begin_layout Subsection
13426 \begin_layout Standard
13431 names as labels then cross-reference the label to insert the name.
13432 The cross-reference dialog will show the current cast of characters.
13433 You can use this to insert the speaker name in narratives also.
13436 \begin_layout Subsection
13437 Paper size and Margins
13440 \begin_layout Standard
13441 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13444 \begin_layout Subsection
13448 \begin_layout Standard
13449 The following environments are available.
13450 You can use hollywood.bind to get the bind keys shown at the right.
13453 \begin_layout Itemize
13457 \begin_inset Newline newline
13462 Used where nothing else works.
13466 \begin_layout Itemize
13472 \begin_inset Space \hfill{}
13480 \begin_inset Newline newline
13483 Usually followed by something like
13484 \begin_inset Quotes eld
13487 on Sally waking up.
13488 \begin_inset Quotes erd
13494 \begin_layout Itemize
13498 \begin_inset Space \hfill{}
13502 \begin_inset Newline newline
13507 Introduces a new INTERIOR camera set-up.
13508 Always followed by DAY or NIGHT, or something similar to define the lighting
13510 Everthing on this line in CAPS.
13513 \begin_layout Itemize
13517 \begin_inset Space \hfill{}
13521 \begin_inset Newline newline
13526 Introduces a new EXTERIOR camera set-up.
13527 Everthing on this line in CAPS.
13530 \begin_layout Itemize
13534 \begin_inset Space \hfill{}
13538 \begin_inset Newline newline
13543 The character speaking.
13546 \begin_layout Itemize
13550 \begin_inset Space \hfill{}
13554 \begin_inset Newline newline
13559 Instructions to the speaker.
13560 The () are automatically inserted, but only the ( will show in LyX.
13561 Both will be printed.
13564 \begin_layout Itemize
13568 \begin_inset Space \hfill{}
13572 \begin_inset Newline newline
13584 \begin_layout Itemize
13588 \begin_inset Space \hfill{}
13592 \begin_inset Newline newline
13597 Camera movement instruction.
13599 \begin_inset Space \thinspace{}
13603 \begin_inset Space ~
13609 \begin_layout Itemize
13613 \begin_inset Space \hfill{}
13619 \begin_layout Itemize
13623 \begin_inset Space \hfill{}
13629 \begin_layout Itemize
13633 \begin_inset Space \hfill{}
13639 \begin_layout Itemize
13643 \begin_inset Space \hfill{}
13649 \begin_layout Subsection
13653 \begin_layout Itemize
13654 (O.S) --- off screen
13657 \begin_layout Itemize
13658 (V.0) --- voice over
13661 \begin_layout Itemize
13666 \begin_layout Itemize
13671 \begin_layout Itemize
13672 PAN --- camera movement
13675 \begin_layout Itemize
13676 INSERT --- cut to close-up of
13679 \begin_layout Section
13683 \begin_layout Standard
13689 \begin_layout Subsection
13693 \begin_layout Standard
13694 Broadway is for writing plays.
13695 The format is more decorative than Hollywood, and much less standardized.
13696 This format should be suitable for workshops.
13699 \begin_layout Subsection
13703 \begin_layout Standard
13704 The same as in Hollywood.
13707 \begin_layout Subsection
13711 \begin_layout Standard
13716 names as labels then cross-reference the label to insert the name.
13717 The cross-reference dialog will show the current cast of characters.
13720 \begin_layout Subsection
13721 Paper size and Margins
13724 \begin_layout Standard
13725 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13728 \begin_layout Subsection
13732 \begin_layout Standard
13733 The following environments are available.
13734 You can use broadway.bind to get the bind keys shown at the right.
13737 \begin_layout Itemize
13741 \begin_inset Newline newline
13746 You should not have to use this, but it is here for anything that does not
13750 \begin_layout Itemize
13754 \begin_inset Space \hfill{}
13758 \begin_inset Newline newline
13763 Used to describe stage setting and the action.
13764 First use of speaker names in all CAPs.
13767 \begin_layout Itemize
13771 \begin_inset Space \hfill{}
13775 \begin_inset Newline newline
13780 Automatically numbered.
13781 On screen it will be arabic, but will print as Roman.
13784 \begin_layout Itemize
13788 \begin_inset Space \hfill{}
13792 \begin_inset Newline newline
13802 It is just centered text.
13805 \begin_layout Itemize
13809 \begin_inset Space \hfill{}
13813 \begin_inset Newline newline
13818 Not automatically numbered.
13819 You supply the number.
13820 This is because I couldn't figure out how.
13823 \begin_layout Itemize
13827 \begin_inset Space \hfill{}
13831 \begin_inset Newline newline
13836 A special case of Narrative to describe the setting and action as the curtain
13840 \begin_layout Itemize
13844 \begin_inset Space \hfill{}
13848 \begin_inset Newline newline
13853 The speaker's (actor's) title, centered in all CAPS.
13856 \begin_layout Itemize
13860 \begin_inset Space \hfill{}
13864 \begin_inset Newline newline
13869 Instructions to the speaker.
13870 The parentheses are automatically inserted.
13871 The ( will appear on screen, but both will be in the printed play.
13872 This environment is only used within
13879 \begin_layout Itemize
13883 \begin_inset Space \hfill{}
13887 \begin_inset Newline newline
13892 What the Speaker says.
13895 \begin_layout Itemize
13899 \begin_inset Space \hfill{}
13903 \begin_inset Newline newline
13908 The curtain comes down.
13911 \begin_layout Itemize
13915 \begin_inset Space \hfill{}
13921 \begin_layout Itemize
13925 \begin_inset Space \hfill{}
13931 \begin_layout Itemize
13935 \begin_inset Space \hfill{}
13941 \begin_layout Standard
13945 \begin_layout Section
13949 \begin_layout Standard
13955 \begin_layout Standard
13956 \begin_inset VSpace bigskip
13962 \begin_layout Standard
13967 \begin_inset Space ~
13972 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13973 \begin_inset Formula $\beta$
13976 release of May, 1999) class.
13979 \begin_layout Standard
13984 textclass, which works with RevTeX 3.1.
13985 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13986 That means that it doesn't interact very well with LyX, which requires
13987 LaTeX2e, although it has been kludged to work.
13988 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13992 \begin_inset Space ~
13997 textclass should also be pretty easy to use.
14000 \begin_layout Standard
14001 These documents are supposed to be used in
14005 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14006 macros, and assume you'll know what to put in the preamble if necessary.
14009 \begin_layout Subsection
14013 \begin_layout Standard
14014 All you need to do is install RevTeX 4, as described in the package's README
14016 The package can be found at The RevTeX 4 Web Site
14017 \begin_inset Flex URL
14020 \begin_layout Plain Layout
14022 http://publish.aps.org/revtex4/
14028 Install it somewhere that LaTeX can see it.
14029 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14030 (i.e., not the directory where you installed the class file.) Then, if you
14031 reconfigure LyX, it will find the class file and let you use the RevTeX4
14035 \begin_layout Standard
14036 Probably the easiest way to get started is either to import a RevTeX 4 document
14044 \begin_inset Space ~
14049 template, found in the templates directory.
14052 \begin_layout Subsection
14056 \begin_layout Standard
14057 Optional arguments to
14064 \begin_inset Quotes eld
14068 \begin_inset Quotes erd
14072 \begin_inset Quotes eld
14076 \begin_inset Quotes erd
14086 \begin_inset Space ~
14094 \begin_inset Space ~
14100 Remember that in RevTeX, at least one optional argument is required!
14103 \begin_layout Standard
14104 Other preamble matter, like
14111 \begin_inset Space ~
14121 \begin_inset Space ~
14126 dialog, also as usual.
14129 \begin_layout Subsection
14133 \begin_layout Standard
14134 The layouts basically correspond to the commands in RevTeX4.0.
14135 For example, the Email layout corresponds to
14142 Note that (at least as of RevTeX 4.0 Beta), the
14150 layouts are exactly equivalent, so you shouldn't need to use both.
14154 \begin_layout Plain Layout
14155 In case you're curious, both were included so that
14159 would be able to translate both
14179 \begin_layout Subsection
14183 \begin_layout Standard
14184 There are a couple of important unique aspects of RevTeX 4 which might cause
14185 bugs that will be even more confusing in LyX.
14188 \begin_layout Standard
14206 The LyX equivalent is that there is a separate Thanks layout.
14211 write footnotes in the
14215 layout, or weird things may happen.
14216 See the RevTeX 4 documentation for more details.
14219 \begin_layout Standard
14223 \begin_inset Space ~
14231 \begin_inset Space ~
14240 layouts must be placed
14248 layout and the corresponding
14265 , the LaTeX won't compile.
14268 \begin_layout Subsection
14272 \begin_layout Standard
14273 The main problem with this layout is that you can't use the optional arguments
14274 to layouts like Email and Title.
14275 (The problem is not unique to this layout; you can't use optional arguments
14276 to the Section layouts either.) This means that after you export that file
14277 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14278 need to edit the LaTeX file with a text editor to add the optional arguments
14280 \begin_inset Space \thinspace{}
14283 g., the running title for the page headers.
14284 Lacking these layouts makes the
14290 (and the equivalent
14296 ) useless, so the corresponding layouts don't exist, and will have to be
14301 \begin_layout Plain Layout
14306 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14307 has not been updated yet to take advantage of it.
14315 \begin_layout Section
14316 Article (mwart), book (mwbk) and report (mwrep)
14317 \begin_inset OptArg
14320 \begin_layout Plain Layout
14333 \begin_layout Standard
14339 \begin_layout Standard
14340 The LyX document classes
14356 correspond to the LaTeX document classes
14369 They are replacements for the standard document classes
14381 , resp., and fit better to Polish typography conventions in a number of points.
14385 \begin_layout Standard
14389 \begin_layout Itemize
14390 Unnumbered titles (with star, eg.
14395 ) are added into table of contents,
14398 \begin_layout Itemize
14399 Additional page styles:
14403 \begin_layout Description
14404 uheadings header with separated lines,
14407 \begin_layout Description
14408 myheadings custom header, contents headers via commands:
14423 \begin_layout Description
14424 myuheadings custom header with separated lines,
14427 \begin_layout Description
14428 outer page number is placed on outer side of page
14432 \begin_layout Itemize
14437 \begin_layout Description
14438 rmheadings serif titles --- default,
14441 \begin_layout Description
14442 sfheadings sansserif titles,
14445 \begin_layout Description
14446 authortitle on title page first placed is author next title --- default,
14449 \begin_layout Description
14450 titleauthor on title page first placed is title next author,
14453 \begin_layout Description
14454 withmarginpar reserve place on page for margins.
14458 \begin_layout Section
14462 \begin_layout Standard
14468 \begin_layout Standard
14469 Elsevier Science Publishers B.V.
14470 provides a standard LaTeX document class (
14474 ) for submitting articles to their various journals.
14475 The style file can be downloaded directly from their web site:
14476 \begin_inset Flex URL
14479 \begin_layout Plain Layout
14481 http://authors.elsevier.com/
14487 Instructions are supplied along with the class file, which details the
14488 requirements of the publishers.
14489 LyX includes package that allows for the use of this class, by a layout
14490 and a template file.
14491 Installation of the class file is the same as for any other LaTeX package;
14492 instructions are provided in the Elsevier documentation.
14495 \begin_layout Standard
14505 As the Elsevier class file is based mainly on the standard article class,
14506 most of the normal functionality is provided.
14507 The Elsevier class defines a number of mathematical environments, which
14508 are similar to the AMS environments.
14509 These commands are all described in the Elsevier documentation, and are
14513 \begin_layout Standard
14514 The easiest way to use the Elsevier style is to base documents on the included
14516 It is best not to use options such as fancy headings or the geometry package,
14517 as elements such as these are defined by Elsevier in their style file.
14518 Ideally, no extra packages except those mentioned in the Elsevier documentation
14520 Essentially, Elsevier require as
14521 \begin_inset Quotes eld
14525 \begin_inset Quotes erd
14528 a LaTeX file as possible, as their intention is to take the supplied file
14529 and replace the class file with one for the particular journal to which
14530 the paper has been submitted.
14531 This also means that not too much time should be spent on the formating
14533 When it comes to be published, this will change anyway.
14534 The rest of the usage for this layout is substantially the same as for
14535 the normal article class.
14536 For details of what Elsevier do and don't allow, refer to their documentation.
14539 \begin_layout Section
14543 \begin_layout Standard
14546 Jürgen Spitzmüller
14549 \begin_layout Subsection
14553 \begin_layout Standard
14554 Memoir is a very powerful and constantly evolving class.
14555 It has been designed with regard to fictional and non-fictional literature.
14556 Its aim is to let the user have maximum control over the typesetting of
14558 Memoir is based on the standard book class, but it can also emulate the
14559 article class (see below).
14562 \begin_layout Standard
14563 Peter Wilson, the developer of Memoir, is known as the author of lots of
14564 useful packages in the LaTeX world.
14565 Most of them have been merged with Memoir.
14566 Therefore, it is much easier to layout the table of contents, appendices,
14567 chapter designs and such.
14568 LyX, though, does not support all of these goodies natively.
14569 Some of them might be added to forthcoming releases
14573 \begin_layout Plain Layout
14574 You are invited to send suggestions to
14575 \begin_inset Flex URL
14578 \begin_layout Plain Layout
14580 lyx-devel@lists.lyx.org
14590 , lots will probably never, due to the limitations of LyX's framework.
14591 Of course you can still use all features with the help of some native LaTeX
14596 \begin_layout Plain Layout
14601 \begin_layout Plain Layout
14611 \begin_inset Space ~
14615 \begin_inset CommandInset ref
14617 reference "sec:Inserting-LaTeX-Code"
14627 In this section, we can only list those features which are natively supported
14629 For detailed descriptions (and for the rest of features) we are recommending
14630 to have a look at the detailed manual of the Memoir class
14634 \begin_layout Plain Layout
14639 \begin_layout Plain Layout
14649 \begin_inset Flex URL
14652 \begin_layout Plain Layout
14654 CTAN:/macros/latex/memoir/memman.pdf
14664 , which is not only a user guide for the class, but also both a comprehensive
14665 description on good typesetting and a superb example for good typesetting
14669 \begin_layout Subsection
14670 Basic features and restrictions
14673 \begin_layout Standard
14674 Memoir supports basically all features of the standard book classes.
14675 There are, however, some differences, as follows:
14678 \begin_layout Description
14680 \begin_inset Space ~
14683 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14686 \begin_layout Description
14688 \begin_inset Space ~
14691 style: The fancy page style is not supported, due to a command clash between
14692 Memoir and the fancyhdr package (they are both defining a command with
14693 the same name, which confuses LaTeX).
14694 Instead, Memoir comes with a bunch of own page styles (see
14696 Layout\SpecialChar \menuseparator
14697 Document\SpecialChar \menuseparator
14699 \begin_inset Space ~
14705 If you want to use these for the chapter pages, you have to use the command
14712 in the main text or in preamble (e.
14713 \begin_inset Space \thinspace{}
14717 \begin_inset Space ~
14724 chapterstyle{companion}
14729 \begin_layout Description
14730 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14731 an optional argument in the standard classes.
14732 With this, you can specify an alternative version of the title for the
14733 table of contents and the headers (for instance, if the title is too long).
14734 In LyX, you can do this via
14736 Insert\SpecialChar \menuseparator
14738 \begin_inset Space ~
14743 at the beginning of a chapter/section.
14744 Memoir features a second optional argument and thus separates the table
14745 of contents from the header.
14746 You can define three variants of a title with this: one for the main text,
14747 one for the table of contents, and one for the headers.
14748 Simply insert two optional arguments if you need this feature, the first
14749 one containing the short title for the Table of Contents, the second one
14750 containing an alternative short title for the headers.
14753 \begin_layout Description
14754 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14755 of contents, the list of figures and the list of table start a new page
14757 Memoir does not follow this route.
14758 You have to insert a page break yourself, if you want to have one.
14761 \begin_layout Description
14762 Titlepage: For some unknown reason, Memoir uses pagination on the title
14763 page (in the standard classes, title pages are
14764 \begin_inset Quotes eld
14768 \begin_inset Quotes erd
14772 \begin_inset Space \thinspace{}
14776 \begin_inset Space ~
14780 If you want an empty title page, type
14784 aliaspagestyle{title}{empty}
14789 \begin_layout Description
14790 Article: With the class option
14796 Layout\SpecialChar \menuseparator
14797 Document\SpecialChar \menuseparator
14799 \begin_inset Space ~
14804 ), you can emulate article style.
14805 That is, counters (footnotes, figures, tables etc.) will not be reset on
14806 new chapters, chapters don't start a new page (but are---in contrary to
14808 \begin_inset Quotes eld
14812 \begin_inset Quotes erd
14815 article classes---still allowed), parts, though, use their own page, as
14819 \begin_layout Description
14820 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14821 font commands, which have been used in the old LaTeX version 2.09 (e.
14822 \begin_inset Space \thinspace{}
14826 \begin_inset Space ~
14842 It produces an error and stops LaTeX whenever such a command appears.
14847 reallows the commands and spits out warnings instead (which does at least
14849 Since a lot of packages and particularly BibTeX style files are still using
14850 those commands, we have decided to use this option by default.
14853 \begin_layout Subsection
14857 \begin_layout Standard
14858 We will only describe the features supported by LyX (which is not much currently
14860 Please consult the Memoir manual
14864 \begin_layout Plain Layout
14869 \begin_layout Plain Layout
14879 \begin_inset Flex URL
14882 \begin_layout Plain Layout
14884 CTAN:/macros/latex/memoir/memman.pdf
14897 \begin_layout Description
14898 Abstract: You may wonder why an abstract is an extra feature.
14899 Well, it is in book class.
14900 Usually books don't have abstracts.
14901 Memoir, however, has.
14902 You can use it wherever and how often you like.
14905 \begin_layout Description
14906 Chapterprecis: You may know this from belletristic: The contents of a chapter
14907 is shortly described below the title and also in the table of contents
14909 \begin_inset Space \thinspace{}
14913 \begin_inset Space ~
14918 Our hero arrives in Troia; he loses some friends; he finds others
14921 Chapterprecis does exactly this.
14922 It is therefore only sensible below a chapter.
14925 \begin_layout Description
14926 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14927 The epigraph environment provides an elegant way of typesetting such a
14929 The motto itself (text) and its author (source) are divided by a short
14931 Unfortunately, we have to fool LyX a bit here again, since the environment
14932 needs two arguments (text and source).
14933 In this case, we have to use curly brackets (in TeX mode) between the two
14944 <author of the slogan>.
14947 \begin_layout Description
14948 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14949 complex figurative poems).
14950 LyX can only support a few of them.
14951 One is poemtitle, which is a centered title for poems, which will also
14952 be added to the table of contents (verse is the standard environment for
14954 Memoir has some enhanced versions of verse, but you need to use ERT, because
14955 they have to be nested inside regular verse environments, which is not
14956 possible with LyX).
14959 \begin_layout Description
14960 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14963 \begin_layout Chapter
14964 LyX Features needing Extra Software
14967 \begin_layout Section
14971 \begin_layout Standard
14977 \begin_layout Subsection
14981 \begin_layout Standard
14989 menu, you'll find a
14995 \begin_inset Space ~
15001 This feature requires you to have the
15005 program installed, and is grayed out if you don't have it.
15006 You can get it from your nearest CTAN mirror, or over the Web from
15007 \begin_inset Flex URL
15010 \begin_layout Plain Layout
15012 http://www.ifi.uio.no/~jensthi/chktex/
15020 \begin_layout Standard
15025 package is a program that was written by
15030 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15031 and easy to forget.
15032 The program runs over your LaTeX file and checks the integrity of the file,
15033 and flags some common errors.
15034 In other technical words, it is
15041 \begin_layout Standard
15042 Well, what is a syntax checker doing in LyX which is supposed to produce
15043 correct LaTeX anyways? The answer is simple: Just as
15047 not only checks the
15051 of C programs, but also does
15055 checks for type-errors,
15059 catches some common
15063 errors, in addition to the syntactical ones.
15068 is capable of detecting several common errors, such as
15071 \begin_layout Itemize
15072 Ellipsis detection:
15073 \begin_inset Newline newline
15076 Use \SpecialChar \ldots{}
15080 \begin_layout Itemize
15081 No space in front of/after parenthesis:
15082 \begin_inset Newline newline
15088 \begin_layout Itemize
15089 Enforcement of normal space after common abbreviations:
15090 \begin_inset Newline newline
15095 is too wide spacing.
15098 \begin_layout Itemize
15099 Enforcement of end-of-sentence space when the last sentence ends with a
15101 \begin_inset Newline newline
15105 And this is wrong spacing.
15108 \begin_layout Itemize
15109 Space in front of labels and similar commands:
15110 \begin_inset Newline newline
15113 The label should stick right up to the text to avoid falling to a wrong
15116 \begin_inset CommandInset label
15126 \begin_layout Plain Layout
15127 This footnote is in danger of falling off to a wrong page
15132 The label is separated too much.
15135 \begin_layout Itemize
15136 Space in front of references, instead of hard spaces:
15137 \begin_inset Newline newline
15140 In you are in bad luck, the text will break right between the referenced
15141 text and reference number, and that's a pity.
15143 \begin_inset CommandInset ref
15145 reference "sec:chktex"
15152 \begin_layout Itemize
15154 \begin_inset Quotes eld
15158 \begin_inset Quotes erd
15162 \begin_inset Formula $\times$
15166 \begin_inset Newline newline
15169 2x2 looks cheap compared to
15170 \begin_inset Formula $2\times2$
15176 \begin_layout Standard
15177 and more \SpecialChar \ldots{}
15178 It is an invaluable tool when you are
15179 \begin_inset Quotes eld
15183 \begin_inset Quotes erd
15186 your document before printing, and you should run it right after the obligatory
15187 spelling check, and before you go fine tuning the typesetting.
15190 \begin_layout Subsection
15194 \begin_layout Standard
15195 If you have the program installed, usage is as simple as choosing
15200 ools\SpecialChar \menuseparator
15206 \begin_inset Space ~
15212 This will make LyX generate a LaTeX file of your document, start
15216 to check it, and then make LyX insert
15217 \begin_inset Quotes eld
15221 \begin_inset Quotes erd
15224 with the warnings from
15228 , if there were any.
15229 The warnings will be placed close to the point of the mistake, and you
15230 can quickly find them by using the
15235 avigate\SpecialChar \menuseparator
15242 menu item, or the shortcut key
15251 Open the error boxes by clicking on them with the mouse, or use the shortcut
15260 bindings, or the corresponding
15269 Read the warning and correct the mistake, if it is a mistake.
15270 If you have trouble understanding what the warning is about, you can safely
15272 Remember that there is a hidden layer between the document on screen and
15273 the technical details in invoking
15277 , and this gap can make some warnings seem arcane or just right down plain
15281 \begin_layout Standard
15282 This document is an excellent testing bed for the feature, and it should
15283 provide quite a few warnings for you to fiddle with.
15284 Since computers are only so smart, expect most of the warnings to be false
15288 \begin_layout Subsection
15289 How to fine tune it
15292 \begin_layout Standard
15293 Sometimes, you'll find that
15297 makes more noise than suits your mood.
15298 Then you can choose not to use it, wait until your mood changes, or try
15303 to get better along with you.
15304 Another choice in the most desperate situations is to use
15309 iew\SpecialChar \menuseparator
15315 \begin_inset Space ~
15319 \begin_inset Space ~
15323 \begin_inset Space ~
15328 , which will get rid of all warnings instantly.
15331 \begin_layout Standard
15340 very configurable and extensible, you shouldn't expect to solve all problems
15346 Since LyX has to generate a somewhat special LaTeX file to be able to match
15347 the line numbers from the
15355 \begin_layout Plain Layout
15356 You can inspect the specific output from
15362 Edit\SpecialChar \menuseparator
15364 \begin_inset Space ~
15368 \begin_inset Space ~
15382 to the internal document structure, some of the warnings will not seen
15383 to appear correctly.
15384 There are two things you can do about this:
15387 \begin_layout Itemize
15392 invocation command line in
15408 installation configuration file (usually with the file
15413 See below to learn what warnings can be enabled and disabled on the command
15418 \begin_layout Itemize
15419 Export your document as a raw LaTeX file using
15424 ile\SpecialChar \menuseparator
15429 xport\SpecialChar \menuseparator
15441 Invoked in this way, it can be a hassle to find the corresponding place
15442 in the document inside LyX, but with a little patience, you should be able
15446 \begin_layout Standard
15447 Here follows the warning messages that can be enabled and disabled in
15456 to disable a warning, and
15460 to enable a warning.
15461 The emphasized entries are disabled by default, because the default is
15464 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15469 \begin_layout Standard
15470 Notice that you should only use the options that enable and disable warnings,
15471 because LyX relies on some of the other command line parameters to be set
15472 in a specific way to have a chance to communicate with
15479 \begin_layout Enumerate
15483 Command terminated with space.
15486 \begin_layout Enumerate
15489 Non-breaking space (
15490 \begin_inset Quotes eld
15498 \begin_inset Quotes erd
15501 ) should have been used.
15504 \begin_layout Enumerate
15508 You should enclose the previous parenthesis with
15509 \begin_inset Quotes eld
15517 \begin_inset Quotes erd
15523 \begin_layout Enumerate
15526 Italic correction (
15527 \begin_inset Quotes eld
15537 \begin_inset Quotes erd
15540 ) found in non-italic buffer.
15543 \begin_layout Enumerate
15546 Italic correction (
15547 \begin_inset Quotes eld
15557 \begin_inset Quotes erd
15560 ) found more than once.
15563 \begin_layout Enumerate
15567 No italic correction (
15568 \begin_inset Quotes eld
15578 \begin_inset Quotes erd
15584 \begin_layout Enumerate
15588 \begin_inset Quotes eld
15596 \begin_inset Quotes erd
15600 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15614 \begin_layout Enumerate
15617 Wrong length of dash may have been used.
15620 \begin_layout Enumerate
15624 \begin_inset Quotes eld
15632 \begin_inset Quotes erd
15636 \begin_inset Quotes eld
15644 \begin_inset Quotes erd
15650 \begin_layout Enumerate
15654 \begin_inset Quotes eld
15662 \begin_inset Quotes erd
15668 \begin_layout Enumerate
15672 \begin_inset Quotes eld
15680 \begin_inset Quotes erd
15683 to achieve an ellipsis.
15686 \begin_layout Enumerate
15689 Inter-word spacing (
15690 \begin_inset Quotes eld
15700 \begin_inset Quotes eld
15703 ) should perhaps be used.
15706 \begin_layout Enumerate
15709 Inter-sentence spacing (
15710 \begin_inset Quotes eld
15720 \begin_inset Quotes erd
15723 ) should perhaps be used.
15726 \begin_layout Enumerate
15729 Could not find argument for command.
15732 \begin_layout Enumerate
15736 \begin_inset Quotes eld
15744 \begin_inset Quotes erd
15750 \begin_layout Enumerate
15753 Math mode still on at end of LaTeX file.
15756 \begin_layout Enumerate
15760 \begin_inset Quotes eld
15768 \begin_inset Quotes erd
15771 doesn't match the number of
15772 \begin_inset Quotes eld
15780 \begin_inset Quotes erd
15786 \begin_layout Enumerate
15789 You should use either
15792 \begin_inset Quotes eld
15800 \begin_inset Quotes erd
15805 as an alternative to
15806 \begin_inset Quotes eld
15814 \begin_inset Quotes erd
15820 \begin_layout Enumerate
15827 " (ASCII 39) instead of "
15834 \begin_layout Enumerate
15837 User-specified pattern found.
15840 \begin_layout Enumerate
15843 This command might not be intended.
15846 \begin_layout Enumerate
15853 \begin_layout Enumerate
15871 \begin_layout Enumerate
15874 Delete this space to maintain correct page references.
15877 \begin_layout Enumerate
15881 You might wish to put this between a pair of
15882 \begin_inset Quotes eld
15890 \begin_inset Quotes erd
15896 \begin_layout Enumerate
15899 You ought to remove spaces in front of punctuation.
15902 \begin_layout Enumerate
15905 Could not execute LaTeX command.
15908 \begin_layout Enumerate
15917 in front of small punctuation.
15920 \begin_layout Enumerate
15928 may look prettier here.
15931 \begin_layout Enumerate
15935 Multiple spaces detected in output.
15938 \begin_layout Enumerate
15941 This text may be ignored.
15944 \begin_layout Enumerate
15950 \begin_inset Quotes eld
15955 to begin quotation, not
15962 \begin_layout Enumerate
15969 to end quotation, not
15972 \begin_inset Quotes eld
15980 \begin_layout Enumerate
15986 \begin_layout Enumerate
15989 You should perhaps use
15990 \begin_inset Quotes eld
15998 \begin_inset Quotes erd
16004 \begin_layout Enumerate
16007 You should put a space in front of/after parenthesis.
16010 \begin_layout Enumerate
16013 You should avoid spaces in front of/after parenthesis.
16016 \begin_layout Enumerate
16020 You should not use punctuation in front of/after quotes.
16023 \begin_layout Enumerate
16026 Double space found.
16029 \begin_layout Enumerate
16032 You should put punctuation outside inner/inside display math mode.
16035 \begin_layout Enumerate
16038 You ought to not use primitive TeX in LaTeX code.
16041 \begin_layout Enumerate
16044 You should remove spaces in front of
16045 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16059 \begin_layout Enumerate
16062 \begin_inset Quotes eld
16070 \begin_inset Quotes erd
16073 is normally not followed by
16074 \begin_inset Quotes eld
16082 \begin_inset Quotes erd
16088 \begin_layout Standard
16089 In later versions of LyX, we hope to provide a more complete interface to
16090 this tool (and it's smaller cousin
16094 ) to exploit the full power of it.
16095 But it's not exactly useless as it is now: go try it on one of your existing
16096 documents of a certain length and be surprised.
16099 \begin_layout Section
16100 Version Control in LyX
16103 \begin_layout Standard
16106 Lars Gullik Bjønnes
16109 \begin_layout Subsection
16113 \begin_layout Standard
16114 A friend of mine wanted to try LyX for a group project.
16115 When he didn't find support for version control or file locking, he dropped
16117 This angered me a bit, so I thought that I should at least make support
16118 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16119 This has now been done.
16120 LyX now supports some of the most basic RCS commands.
16121 If you need to something a bit more sophisticated you will have to do that
16122 manually in an xterm.
16125 \begin_layout Standard
16126 Before you begin to use the version control features in LyX, you should
16128 \begin_inset Quotes eld
16132 \begin_inset Quotes erd
16135 (a man file, read it with
16140 This file describes all the basic features of RCS.
16141 You should especially notice the comment about a RCS directory, and the
16142 notion of a master RCS file (the file ending in
16149 \begin_layout Standard
16150 The implementation in LyX assumes a recent version of the GNU RCS package---no
16151 guarantees are made for older versions.
16154 \begin_layout Subsection
16155 RCS commands in LyX
16158 \begin_layout Standard
16159 The following sections describe the RCS commands supported by LyX.
16160 You can find them in the
16165 ile\SpecialChar \menuseparator
16171 \begin_inset Space ~
16179 \begin_layout Subsubsection
16185 \begin_layout Standard
16186 If your document is not under revision control, this is the only item shown
16188 And if it is under revision control, the
16195 item is grayed out.
16199 \begin_layout Standard
16200 This command registers your document with RCS\SpecialChar \@.
16201 You are asked interactively
16202 to supply an initial description of the document.
16203 The document is now set in Read-Only mode and you have to
16206 \begin_inset Space ~
16210 \begin_inset Space ~
16214 \begin_inset Space ~
16219 , before making any changes to it.
16220 A document under revision control has a
16221 \begin_inset Quotes eld
16224 [RCS:<version> <locker>]
16225 \begin_inset Quotes erd
16228 item tagged to the filename in the minibuffer.
16231 \begin_layout Standard
16232 RCS command that is run:
16234 ci -q -u -i -t-"<initial description>" <file-name>
16237 \begin_layout Standard
16242 to understand the switches.
16246 \begin_layout Subsubsection
16252 \begin_layout Standard
16253 When you are finished editing a file, you check in your changes.
16254 When you do this, you are asked for a description of the changes.
16255 This is stored in the history log.
16256 The version number is bumped, your changes are applied to the master RCS
16257 file, the document is unlocked and set to Read-Only mode.
16261 \begin_layout Standard
16264 ci -q -u -m"<description>" <file-name>
16267 \begin_layout Subsubsection
16273 \begin_layout Standard
16274 By doing this you lock the document so that only you can edit it.
16275 This will also make the document Read-Write only for you.
16276 You will usually continue editing for a while and when you are finished
16277 you check in your changes.
16278 The status line is changed to reflect that you have locked the file.
16282 \begin_layout Standard
16285 co -q -l <file-name>
16288 \begin_layout Subsubsection
16291 Revert To Last Version
16294 \begin_layout Standard
16295 This will discard all changes made to the document since the last check
16297 You get a warning before changes are discarded.
16300 \begin_layout Standard
16303 co -f -u<version> <file-name>
16306 \begin_layout Subsubsection
16312 \begin_layout Standard
16313 This makes as if the last check in never happened.
16314 No changes are made to the document loaded into LyX, but the last version
16315 is removed from the master RCS file.
16319 \begin_layout Standard
16322 rcs -o<version> <file-name>
16325 \begin_layout Subsubsection
16331 \begin_layout Standard
16332 This show the complete history of the RCS document.
16337 is shown in a browser.
16345 \begin_layout Section
16346 Literate Programming
16349 \begin_layout Standard
16354 (kayvan@sylvan.com)
16358 original documentation written by
16360 Edmar Wienskoski Jr.
16363 (edmar-w-jr@technologist.com)
16366 \begin_layout Subsection
16370 \begin_layout Standard
16371 The main purpose of this documentation is to show you how to use LyX for
16372 literate programming.
16373 Where it is assumed that you are familiar with this programming technique,
16375 \begin_inset Quotes eld
16379 \begin_inset Quotes erd
16383 \begin_inset Quotes eld
16387 \begin_inset Quotes erd
16391 If that is not the case, please follow the web links provided in the following
16393 There is a lot of good documentation out there covering old development
16394 history to the latest tools tips.
16397 \begin_layout Standard
16398 It is also assumed that you are familiar with LyX itself to a point that
16399 you are comfortable changing your LyX preferences, and X resources file.
16400 If that is not the case please refer to other LyX documentation to cover
16401 your specific needs.
16404 \begin_layout Subsection
16405 Literate Programming
16408 \begin_layout Standard
16409 From the Literate Programming FAQ:
16412 \begin_layout Quotation
16413 Literate programming is the combination of documentation and source together
16414 in a fashion suited for reading by human beings.
16415 In fact, literate programs should be enjoyable reading, even inviting!
16416 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16417 and documentation in a single file.
16418 Literate programming tools then parse the file to produce either readable
16419 documentation or compilable source.
16420 The WEB style of literate programming was created by D.E.
16421 Knuth during the development of his TeX typesetting software.
16425 \begin_layout Standard
16426 Another excerpt says:
16429 \begin_layout Quotation
16432 How is literate programming different from verbose commenting?
16435 \begin_layout Quotation
16436 There are three distinguishing characteristics.
16437 In order of importance, they are:
16441 \begin_layout Itemize
16442 flexible order of elaboration
16445 \begin_layout Itemize
16446 automatic support for browsing
16449 \begin_layout Itemize
16450 typeset documentation, especially diagrams and mathematics
16454 \begin_layout Standard
16455 Now that I sparked your curiosity, take a look in the references.
16458 \begin_layout Subsubsection
16462 \begin_layout Standard
16463 The complete Literate Programming FAQ can be found at:
16466 \begin_layout Quote
16467 Literate Programming FAQ
16468 \begin_inset Flex URL
16471 \begin_layout Plain Layout
16473 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16481 \begin_layout Standard
16482 The FAQ lists 23 (twenty three!) different literate programming tools.
16483 Where some are specialized or
16484 \begin_inset Quotes eld
16488 \begin_inset Quotes erd
16491 for particular programming languages, while other have general scope.
16496 for my own use for several reasons:
16499 \begin_layout Itemize
16500 It can generate the documentation either in LaTeX or HTML.
16503 \begin_layout Itemize
16504 It has a open architecture, i.e., it is easy to plug in new filters and to
16505 perform special processing that you may need.
16509 \begin_layout Itemize
16510 There is a good selection of filters available already (the HTML is one
16514 \begin_layout Itemize
16518 \begin_layout Standard
16519 The Noweb web page can be found at:
16522 \begin_layout Quote
16524 \begin_inset Flex URL
16527 \begin_layout Plain Layout
16529 http://www.cs.virginia.edu/~nr/noweb/
16537 \begin_layout Standard
16538 Starting from there you can reach many other interesting links and even
16539 some literate program examples.
16542 \begin_layout Subsection
16543 \begin_inset CommandInset label
16545 name "sub:LyX-and-Literate"
16549 LyX and Literate Programming
16552 \begin_layout Standard
16553 The LyX support for Literate Programming is provided by using the generic
16554 LyX convertors mechanism.
16555 This support is provided in a
16556 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16563 way, i.e., you will be able to use this new LyX feature with some other literate
16564 programming tool of your choice by just changing your LyX preferences.
16567 \begin_layout Subsubsection
16568 Generating documents and code (weaving and tangling)
16571 \begin_layout Paragraph
16572 Selecting the document class
16575 \begin_layout Standard
16576 If you have installed Noweb and LyX successfully, whenever you open a new
16577 document or try to change the document class of an existing one, you will
16578 find that there are three new document classes available:
16581 \begin_layout Itemize
16585 \begin_layout Itemize
16589 \begin_layout Itemize
16593 \begin_layout Standard
16594 You must select one of them to create your literate documents from.
16598 \begin_layout Standard
16599 Note that literate documents are not limited to these three classes.
16600 New classes can be generated from other styles like letter or in combination
16601 with other class variations like Article (AMS).
16602 If you have special needs that cannot be covered by one of the existing
16603 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16604 will arrange to insert a new entry, or teach you how to do it.
16608 \begin_layout Plain Layout
16609 It is very simple, it involves the creation of a file with four lines, and
16610 re-running of the auto configuration.
16615 Moreover, if you use a literate tool other than Noweb you may need to create
16616 a new set of document classes for it.
16619 \begin_layout Paragraph
16623 \begin_layout Standard
16624 LyX enables you to write code with a layout named
16632 \begin_layout Plain Layout
16633 The equivalent Noweb term is
16634 \begin_inset Quotes eld
16638 \begin_inset Quotes erd
16642 For historical reasons, I got used to the term
16643 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16650 introduced by other literate tool named Nuweb, which I used for many years
16651 before rendering myself to Noweb.
16656 Noweb delimits scraps like this:
16659 \begin_layout LyX-Code
16663 \begin_layout LyX-Code
16667 \begin_layout LyX-Code
16671 \begin_layout LyX-Code
16675 \begin_layout LyX-Code
16679 \begin_layout Standard
16680 The problem is that whatever is written in between the << and the
16684 must be taken literally, i.e., LyX should be prevented from making any special
16685 interpretation of what has been written.
16686 This is handled by a special layout named Scrap, that works like a normal
16687 paragraph but has a free spacing capability.
16690 \begin_layout Standard
16691 The down side of the Scrap paragraph layout is that consecutive paragraphs
16692 of code will be spaced with one empty line in the source code and also
16693 in the printed documentation.
16694 The work around is to enter each line of code within a single Scrap, with
16695 a newline (ctrl-return).
16696 The example above will look like this:
16700 \begin_layout Plain Layout
16701 If you have a printed version of this document you will not see any difference
16702 between the previous example and this one.
16710 \begin_layout LyX-Code
16712 \begin_inset Newline newline
16716 \begin_inset Newline newline
16720 \begin_inset Newline newline
16724 \begin_inset Newline newline
16730 \begin_layout Standard
16731 This layout works fine.
16732 The only real inconvenience is that you have to type ctrl-return instead
16737 \begin_layout Plain Layout
16738 It is in my list of
16739 \begin_inset Quotes eld
16743 \begin_inset Quotes erd
16754 \begin_layout Standard
16755 As a special note, you can also use the
16756 \begin_inset Quotes eld
16760 \begin_inset Quotes erd
16763 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16767 \begin_layout LyX-Code
16769 \begin_inset Newline newline
16772 def some_function(args):
16773 \begin_inset Newline newline
16776 "This is the doc string for this function."
16777 \begin_inset Newline newline
16780 print "My args: ", args
16783 \begin_layout LyX-Code
16784 @ %def some_function
16787 \begin_layout Standard
16788 For an example of this usage and the resulting cross-reference output, look
16789 at the Literate python program in
16791 LIBDIR/examples/listerrors.lyx
16793 which should make this all clear.
16796 \begin_layout Paragraph
16797 Generating the documentation
16800 \begin_layout Standard
16801 At this point you already have a new document file with a proper document
16802 class, and with some code and text on it.
16803 How do I print it? The answer is simple, you select
16808 iew\SpecialChar \menuseparator
16816 Just like you would do for a plain document.
16817 No special procedure is required.
16820 \begin_layout Standard
16821 To help orientate you, I will now explain what happens inside LyX:
16824 \begin_layout Enumerate
16830 pdate\SpecialChar \menuseparator
16837 menu option is chosen, a LaTeX file is generated.
16842 \begin_layout Standard
16843 If the document is of any literate class the generated file will be named
16844 with an extension name defined by the
16845 \begin_inset Quotes eld
16849 \begin_inset Quotes erd
16852 format (defined in the Preferences panel), otherwise the file will have
16861 \begin_layout Enumerate
16862 Note that the only difference so far is in the name of the file, no special
16863 processing is required by LyX.
16864 Given that you formatted the code using the Scrap layout that, by itself,
16865 takes care of the business.
16868 \begin_layout Enumerate
16869 If the document is of any literate class LyX will then use the internal
16870 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16874 \begin_layout Plain Layout
16875 The converters are defined in the
16880 ools\SpecialChar \menuseparator
16888 \begin_inset Quotes eld
16892 \begin_inset Quotes erd
16897 \begin_inset CommandInset ref
16899 reference "sub:converters"
16907 manual for general information about converters.
16912 to generate the LaTeX file.
16916 \begin_layout Standard
16917 Otherwise it will just skip this step.
16921 \begin_layout Enumerate
16922 Finally, LaTeX is invoked and the regular post processing continues as in
16926 \begin_layout Standard
16927 Independence from a particular
16928 \begin_inset Quotes eld
16932 \begin_inset Quotes erd
16935 is easily achieved by changing the commands that are run by the various
16939 \begin_layout Paragraph
16940 Generating the code
16943 \begin_layout Standard
16944 When the build menu option is chosen or the corresponding button in the
16945 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16946 Next, LyX invokes the
16951 This converter needs to be defined by the user and is not installed by
16952 default, though the Program format is.
16953 This converter (like any other converter) will have two parts:
16956 \begin_layout Enumerate
16957 The converter program itself.
16958 This program performs the conversion from the one format to the other (in
16959 this case, from the Noweb format to the Program pseudo-format).
16962 \begin_layout Enumerate
16963 The error log parser.
16964 This is a program whose sole purpose is to rewrite error messages in a
16965 format that LyX understands.
16966 This makes it possible for LyX to place error boxes in the right places
16967 in the file buffer.
16970 \begin_layout Standard
16971 The first part, the
16972 \begin_inset Quotes eld
16976 \begin_inset Quotes erd
16979 setting, should be set to
16980 \begin_inset Quotes eld
16988 \begin_inset Quotes erd
16992 This basically means that LyX will call
16993 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17000 (a program or script) with the name of the Noweb file (normally a file
17001 in the LyX temp directory).
17005 \begin_layout Standard
17006 This is an implementation of
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17014 that you can place in a directory on your path:
17017 \begin_layout LyX-Code
17021 \begin_layout LyX-Code
17025 \begin_layout LyX-Code
17026 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17029 \begin_layout Standard
17030 The next part of the converter setting is the
17031 \begin_inset Quotes eld
17035 \begin_inset Quotes erd
17038 which is to be set to
17039 \begin_inset Quotes eld
17044 parselog=listerrors
17047 \begin_inset Quotes erd
17051 This will run any errors that are generated by the
17052 \begin_inset Quotes eld
17056 \begin_inset Quotes erd
17059 process through the
17060 \begin_inset Quotes eld
17064 \begin_inset Quotes erd
17070 \begin_layout Standard
17071 The converter code looks in
17079 then on the path for the
17080 \begin_inset Quotes eld
17084 \begin_inset Quotes erd
17090 \begin_layout Standard
17091 The build will normally take place in LyX's temporary directory, so the
17092 files produced by the conversion will be in that directory.
17093 LyX will copy out what it regards as the `main' file, but the
17097 conversion may produce several files, and so most of these would then be
17098 deleted when LyX was closed.
17099 The present solution is to use a `copier',
17103 \begin_layout Plain Layout
17105 \begin_inset CommandInset ref
17107 reference "sec:converters-etc"
17115 manual for information on these.
17124 script in its default mode, so that the entire contents of the temporary
17125 directory is copied.
17126 More will get copied than is needed, to be sure, but nothing will be lost.
17127 If, however, you know what extensions the generated files will have, this
17128 can be improved by using the
17137 This option takes a comma-separated list of extensions to copy.
17138 So, for example, if the conversion will generate only files with the extensions
17147 , then the correct definition would be:
17150 \begin_layout LyX-Code
17151 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17154 \begin_layout Standard
17155 The result will be that only files with these two extensions will be copied
17159 \begin_layout Paragraph
17160 Build instructions in the document
17163 \begin_layout Standard
17164 The last piece of the integration between LyX and noweb is the
17165 \begin_inset Quotes eld
17169 \begin_inset Quotes erd
17173 Generally, the instructions for building your program should be embedded
17174 in a scrap of its own.
17176 \begin_inset Quotes eld
17180 \begin_inset Quotes erd
17183 above uses the notangle command to look for this scrap (called
17184 \begin_inset Quotes eld
17188 \begin_inset Quotes erd
17191 ) and runs its contents through
17192 \begin_inset Quotes eld
17196 \begin_inset Quotes erd
17202 \begin_layout Standard
17203 Typically, such a scrap would look something like this:
17206 \begin_layout LyX-Code
17208 \begin_inset Newline newline
17212 \begin_inset Newline newline
17216 \begin_inset Newline newline
17219 if [ -z "${NOWEB_SOURCE}" ]
17220 \begin_inset Newline newline
17224 \begin_inset Newline newline
17227 NOWEB_SOURCE=myfile.nw
17228 \begin_inset Newline newline
17232 \begin_inset Newline newline
17236 code to extract files ...]
17237 \begin_inset Newline newline
17241 code to compile files ...]
17242 \begin_inset Newline newline
17248 \begin_layout Standard
17251 LIBDIR/examples/listerrors.lyx
17255 LIBDIR/examples/Literate.lyx
17257 which implement two versions of the
17258 \begin_inset Quotes eld
17262 \begin_inset Quotes erd
17265 program for some illustrations of how all of these pieces go together or
17268 LIBDIR/examples/noweb2lyx.lyx.
17271 Interestingly, these three files show off the language-indepence of the
17272 LyX literate programming support since they are written in Python, C and
17276 \begin_layout Subsubsection
17280 \begin_layout Standard
17281 All the Literate Programming support is configured by the
17286 ools\SpecialChar \menuseparator
17294 \begin_inset Quotes eld
17298 \begin_inset Quotes erd
17302 The important parts are:
17305 \begin_layout Description
17307 \begin_inset Space ~
17311 \begin_inset Quotes eld
17315 \begin_inset Quotes erd
17319 \begin_inset Space ~
17322 format Set up via the Formats tab, this is where the Noweb-specific pieces
17332 , the file extension is set to
17337 This tells LyX to create a file with a
17341 extension in the first step of the conversion process.
17344 \begin_layout Description
17346 \begin_inset Space ~
17354 \begin_inset Space ~
17357 format This is an empty format whose sole purpose is to be the endpoint
17358 of a conversion (which then allows us to set up a converter for it).
17361 \begin_layout Description
17370 This converter performs the
17371 \begin_inset Quotes eld
17375 \begin_inset Quotes erd
17378 of the literate document.
17379 For Noweb, it is set to
17380 \begin_inset Quotes eld
17385 noweave -delay -index $$i > $$o
17388 \begin_inset Quotes erd
17394 \begin_layout Description
17404 \begin_inset Quotes eld
17408 \begin_inset Quotes erd
17412 As stated above, the Converter is set to
17413 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17424 , with Flags set to
17425 \begin_inset Quotes eld
17430 originaldir,parselog=listerrors
17433 \begin_inset Quotes erd
17439 \begin_layout Subsubsection
17443 \begin_layout Standard
17444 There is also a new function implemented in the LyX server, the
17445 \begin_inset Quotes eld
17448 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17452 \begin_layout Standard
17453 When debugging code with ddd/gdb, it is possible to invoke a text editor
17454 at the current execution position with a single key stroke.
17455 The default ddd configuration for that is shift-ctrl-V.
17456 It happens that you can define the editor command line invocation in ddd
17462 dit\SpecialChar \menuseparator
17467 references\SpecialChar \menuseparator
17474 dialog and changing the "Edit Sources" entry.
17477 \begin_layout Standard
17478 I take advantage of the new created LyX server function and this ddd feature,
17480 \begin_inset Quotes eld
17484 \begin_inset Quotes erd
17490 \begin_layout LyX-Code
17491 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17494 \begin_layout Standard
17495 With this, whenever you are using ddd and find a point in the program that
17496 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17497 ddd you forward this information to LyX through the LyX server and then
17498 the LyX window will show the same file with the cursor at the same position
17499 ddd was pointing to.
17500 No more guessing or long scrolling to locate a point in the program back
17504 \begin_layout Standard
17505 Note however that you must enable the LyX server to get this feature working
17506 (it is disabled by default).
17507 You can enable it in
17519 ) by entering in the
17524 \begin_inset Quotes eld
17529 /home/<your-home-directory>/.lyx/lyxpipe
17532 \begin_inset Quotes erd
17538 \begin_layout Standard
17539 Read the LyX server documentation in the
17541 Customization Manual
17543 for further information.
17546 \begin_layout Subsubsection
17550 \begin_layout Standard
17551 There are six new buttons that can be added to your LyX toolbar.
17552 Five of these buttons are short cuts to layout styles:
17573 The last one is a short cut to the
17574 \begin_inset Quotes eld
17578 \begin_inset Quotes erd
17585 \begin_layout Standard
17586 LyX has a range of buttons that are available for tool bar customization.
17587 In my toolbar I like to combine the six short cuts above with two more:
17595 \SpecialChar \menuseparator
17603 \SpecialChar \menuseparator
17616 iew\SpecialChar \menuseparator
17624 Here is how it looks like:
17627 \begin_layout LyX-Code
17631 \begin_layout LyX-Code
17635 \begin_layout LyX-Code
17636 Icon "layout Standard"
17639 \begin_layout LyX-Code
17640 Icon "layout Section"
17643 \begin_layout LyX-Code
17644 Icon "layout LaTeX"
17647 \begin_layout LyX-Code
17648 Icon "layout LyX-Code"
17651 \begin_layout LyX-Code
17652 Icon "layout Scrap"
17655 \begin_layout LyX-Code
17659 \begin_layout LyX-Code
17663 \begin_layout LyX-Code
17664 Icon "buffer-typeset"
17667 \begin_layout LyX-Code
17668 Icon "build-program"
17671 \begin_layout LyX-Code
17675 \begin_layout LyX-Code
17679 \begin_layout LyX-Code
17683 \begin_layout LyX-Code
17687 \begin_layout LyX-Code
17691 \begin_layout Subsubsection
17692 Colors customization
17695 \begin_layout Standard
17696 There are a number of colors in LyX that can be customized in
17701 One of the things that bothers people is the LaTeX font color.
17702 The default color is red, since the scraps uses LaTeX font, and there is
17703 a lot of scraps in literate documents, you may get tired of seeing everything
17705 You can change it by going to the tabs
17714 \begin_layout Standard
17715 The next thing is the visible presence of the newline character in the screen.
17716 You can choose the color of this particular character and make it blend
17718 I recommend you choosing a color that is close to the background but not
17719 equal, that way you still can see it is there, but it is not bothering
17724 \begin_layout Chapter
17725 Secrets of the LaTeX Masters
17726 \begin_inset CommandInset label
17735 \begin_layout Standard
17736 Though LyX is a powerful tool, it cannot hope to support everything that
17737 can be done with pure TeX/LaTeX.
17738 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17739 as long as you are not afraid to use that
17740 \begin_inset Quotes eld
17744 \begin_inset Quotes erd
17747 button on the toolbar or add things to the LaTeX preamble.
17748 This section lists some tips, tricks, and otherwise cool ideas to give
17749 your document that extra little flair.
17752 Do try this at home
17754 , just start with something a little smaller and less important than your
17758 \begin_layout Standard
17759 Most ideas in this section require less common files in your LaTeX installation.
17760 If you have a system like teTeX, most will already be available.
17761 A few, however, will need to be downloaded from one of the CTAN archives.
17762 Often, there are several ways to do something, or several LaTeX style files
17763 which do the same thing.
17764 We do not endorse one choice over another, we simply claim that we have
17765 done a particular task with a particular file.
17766 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17769 \begin_layout Section
17773 \begin_layout Standard
17776 Lars Gullik Bjønnes
17779 \begin_layout Subsection
17783 \begin_layout Standard
17784 The aim for this chapter
17788 \begin_layout Plain Layout
17789 Editor's note: Lars' original chapter was a masterful description of how
17795 However, it was too long to flow smoothly in this document.
17796 I have therefore chosen to excerpt the most important sections here (sorry,
17797 Lars); you can read the original chapter (and more of the story!) in the
17800 examples/multicol.lyx
17808 is to show how the LaTeX package
17812 can be used in a LyX document.
17813 As LyX doesn't support the
17817 package natively yet, we have to use some small hacks.
17818 By reading this section it should be obvious how to do this.
17821 \begin_layout Subsection
17825 \begin_layout Standard
17830 package allows switching between one and multicolumn format on the same
17832 Footnotes are handled correctly (for the most part), but will be placed
17833 at the bottom of the page and not under each column.
17834 LaTeX's float mechanism, however, is partly disabled in the current implementat
17836 At the moment only page-wide floats can be used within the scope of the
17840 \begin_layout Subsection
17844 \begin_layout Subsubsection
17848 \begin_layout Standard
17849 If you want to have two columns in your text, you have use LaTeX mode to
17854 begin{multicols}{2}
17856 at the point where you want the two column layout to start, and then
17862 where you want it to end.
17866 \begin_layout Standard
17870 \begin_layout Plain Layout
17874 begin{multicols}{2}
17882 \begin_layout Standard
17887 The Adventure of the Empty House
17890 \begin_inset Newline newline
17895 Sir Arthur Conan Doyle
17898 \begin_layout Standard
17901 It was in the spring of the year 1894 that all London was interested, and
17902 the fashionable world dismayed, by the murder of the Honourable Ronald
17903 Adair under most unusual and inexplicable circumstances.
17904 The public has already learned those particulars of the crime which came
17905 out in the police investigation, but a good deal was suppressed upon that
17906 occasion, since the case for the prosecution was so overwhelmingly strong
17907 that it was not necessary to bring forward all the facts.
17908 Only now, at the end of nearly ten years, am I allowed to supply those
17909 missing links which make up the whole of that remarkable chain.
17910 The crime was of interest in itself, but that interest was as nothing to
17911 me compared to the inconceivable sequel, which afforded me the greatest
17912 shock and surprise of any event in my adventurous life.
17913 Even now, after this long interval, I find myself thrilling as I think
17914 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17915 ty which utterly submerged my mind.
17916 Let me say to that public, which has shown some interest in those glimpses
17917 which I have occasionally given them of the thoughts and actions of a very
17918 remarkable man, that they are not to blame me if I have not shared my knowledge
17919 with them, for I should have considered it my first duty to do so, had
17920 I not been barred by a positive prohibition from his own lips, which was
17921 only withdrawn upon the third of last month.
17924 \begin_layout Standard
17928 \begin_layout Plain Layout
17940 \begin_layout Subsubsection
17944 \begin_layout Standard
17945 The same pattern is used when you want more than two columns:
17948 \begin_layout Standard
17952 \begin_layout Plain Layout
17956 begin{multicols}{3}
17964 \begin_layout Standard
17967 It can be imagined that my close intimacy with Sherlock Holmes had interested
17968 me deeply in crime, and that after his disappearance I never failed to
17969 read with care the various problems which came before the public.
17970 And I even attempted, more than once, for my own private satisfaction,
17971 to employ his methods in their solution, though with indifferent success.
17972 There was none, however, which appealed to me like this tragedy of Ronald
17974 As I read the evidence at the inquest, which led up to a verdict of willful
17975 murder against some person or persons unknown, I realized more clearly
17976 than I had ever done the loss which the community had sustained by the
17977 death of Sherlock Holmes.
17978 There were points about this strange business which would, I was sure,
17979 have specially appealed to him, and the efforts of the police would have
17980 been supplemented, or more probably anticipated, by the trained observation
17981 and the alert mind of the first criminal agent in Europe.
17982 All day, as I drove upon my round, I turned over the case in my mind and
17983 found no explanation which appeared to me to be adequate.
17984 At the risk of telling a twice-told tale, I will recapitulate the facts
17985 as they were known to the public at the conclusion of the inquest.
17988 \begin_layout Standard
17992 \begin_layout Plain Layout
18004 \begin_layout Standard
18005 You can have more than 3 columns if you want to, but that might not be very
18006 pleasant for the eye.
18009 \begin_layout Subsubsection
18010 Columns inside columns
18013 \begin_layout Standard
18014 You can even have columns inside columns:
18017 \begin_layout Standard
18021 \begin_layout Plain Layout
18025 begin{multicols}{2}
18033 \begin_layout Standard
18036 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18037 at that time governor of one of the Australian colonies.
18038 Adair's mother had returned from Australia to undergo the operation for
18039 cataract, and she, her son Ronald, and her daughter Hilda were living together
18043 \begin_layout Standard
18047 \begin_layout Plain Layout
18051 begin{multicols}{2}
18059 \begin_layout Standard
18062 The youth moved in the best society--had, so far as was known, no enemies
18063 and no particular vices.
18064 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18065 had been broken off by mutual consent some months before, and there was
18066 no sign that it had left any very profound feeling behind it.
18067 For the rest {sic} the man's life moved in a narrow and conventional circle,
18068 for his habits were quiet and his nature unemotional.
18069 Yet it was upon this easy-going young aristocrat that death came, in most
18070 strange and unexpected form, between the hours of ten and eleven-twenty
18071 on the night of March 30, 1894.
18074 \begin_layout Standard
18078 \begin_layout Plain Layout
18090 \begin_layout Standard
18093 Ronald Adair was fond of cards--playing continually, but never for such
18094 stakes as would hurt him.
18095 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18096 It was shown that, after dinner on the day of his death, he had played
18097 a rubber of whist at the latter club.
18098 He had also played there in the afternoon.
18103 The evidence of those who had played with him-- Mr.
18104 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18105 and that there was a fairly equal fall of the cards.
18106 Adair might have lost five pounds, but not more.
18107 His fortune was a considerable one, and such a loss could not in any way
18109 He had played nearly every day at one club or other, but he was a cautious
18110 player, and usually rose a winner.
18111 It came out in evidence that, in partnership with Colonel Moran, he had
18112 actually won as much as four hundred and twenty pounds in a sitting, some
18113 weeks before, from Godfrey Milner and Lord Balmoral.
18114 So much for his recent history as it came out at the inquest.
18117 \begin_layout Standard
18121 \begin_layout Plain Layout
18133 \begin_layout Standard
18134 Please do read the file
18136 examples/multicol.lyx
18138 for more advanced examples including column and header spacing, vertical
18139 separator lines, and more.
18142 \begin_layout Section
18147 Paragraph Environment
18148 \begin_inset OptArg
18151 \begin_layout Plain Layout
18152 Numbering in Enumerate
18160 \begin_layout Standard
18166 \begin_layout Standard
18167 \begin_inset VSpace bigskip
18173 \begin_layout Standard
18175 The default numbering for the
18179 paragraph environment begins with Arabic numbers and ends with uppercase
18181 Suppose, however, you wanted a different type of numbering scheme.
18182 Here's a quickie example of how to change the numbering scheme:
18185 \begin_layout LyX-Code
18195 \begin_layout LyX-Code
18205 \begin_layout LyX-Code
18215 \begin_layout LyX-Code
18225 \begin_layout Standard
18226 \SpecialChar \ldots{}
18227 which changes the numbering scheme to uppercase Roman numerals, uppercase
18228 letters, Arabic numbers, and lowercase letter.
18231 \begin_layout Standard
18232 Additionally, the previous example also adds a little bit extra to the numbering
18234 For example, the first level label actually looks like:
18235 \begin_inset Quotes eld
18239 \begin_inset Quotes erd
18243 For ease of reading, we'll describe what the numbering schemes look like
18244 using a notation something like this: <
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18253 \begin_inset Space ~
18257 \begin_inset Quotes erd
18261 \begin_inset Quotes erd
18265 \begin_inset Space ~
18269 \begin_inset Quotes erd
18273 \begin_inset Quotes erd
18277 \begin_inset Space ~
18281 \begin_inset Quotes eld
18285 \begin_inset Quotes erd
18292 \begin_layout Standard
18293 As you can see in the example, there is a label command for each nesting
18300 \SpecialChar \ldots{}
18307 , as well as a counter,
18311 \SpecialChar \ldots{}
18317 There are also five
18318 \begin_inset Quotes eld
18322 \begin_inset Quotes erd
18355 , each of which take one counter as an argument.
18356 You can add characters before or after these, but there's no need to add
18360 \begin_layout Standard
18361 You can get really fancy with these.
18365 \begin_layout LyX-Code
18379 \begin_layout LyX-Code
18391 \begin_layout LyX-Code
18401 \begin_layout LyX-Code
18411 \begin_layout Standard
18412 produces the somewhat out of hand numbering scheme: <
18413 \begin_inset Quotes eld
18417 \begin_inset Quotes erd
18421 \begin_inset Space ~
18425 \begin_inset Quotes erd
18429 \begin_inset Quotes erd
18433 \begin_inset Space ~
18437 \begin_inset Quotes erd
18441 \begin_inset Quotes erd
18445 \begin_inset Space ~
18449 \begin_inset Quotes eld
18453 \begin_inset Quotes erd
18460 \begin_layout Standard
18464 \begin_layout Section
18468 \begin_layout Standard
18474 \begin_layout Standard
18475 \begin_inset VSpace bigskip
18481 \begin_layout Standard
18486 \begin_layout Plain Layout
18492 tmpfont}{cmr17 scaled 2500}{
18504 \begin_layout Standard
18509 \begin_layout Plain Layout
18520 hose of you who like the style of old books probably also like
18521 \begin_inset Quotes eld
18525 \begin_inset Quotes erd
18528 ---those large capital letters which begin each new chapter or section.
18529 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18530 know some plain TeX!) but does require a lot of work and many iterations,
18531 as you can see by all the ugly TeX-mode stuff at the beginning of this
18535 \begin_layout Standard
18539 \begin_layout Plain Layout
18545 bigdrop{-1em}{3}{ptmri}{T}+
18550 here is a much easier way of doing this, of course.
18559 ) package from CTAN allows a simple way to add such letters to your documents.
18560 Since this package is not a standard part of teTeX, I can't demonstrate
18561 it within this document, but if you copy this paragraph to a new document,
18563 \begin_inset Quotes eld
18573 \begin_inset Quotes erd
18576 and the pluses from the TeX code at the beginning of the paragraph, and
18581 usepackage{dropcaps}
18583 to your LaTeX preamble, you will get a nice Times Roman Italic
18584 \begin_inset Quotes eld
18588 \begin_inset Quotes erd
18591 , whose height is three lines of text and which protrudes 1 em into the
18593 (Make certain you have copied
18594 \begin_inset Quotes eld
18602 \begin_inset Quotes erd
18605 into a directory where TeX can see it.) The first argument is the amount
18606 of indentation; in this case the negative sign moves it into the margin.
18607 The second argument is the height of the letter in number of lines of text.
18608 The third argument is the font name: virtually anything which has a tfm
18609 file should work (wade through the
18611 .../texmf/fonts/tfm
18613 directory for possibilities).
18614 My personal favorite is
18615 \begin_inset Quotes eld
18623 \begin_inset Quotes erd
18626 , a fancy German font specifically designed for dropped capitals.
18627 The fourth argument is the letter (or letters) to be dropped.
18632 package also offers the
18638 command, as well as a slightly simplified
18647 \begin_layout Section
18648 Non-standard Paragraph Shapes
18651 \begin_layout Standard
18657 \begin_layout Standard
18658 \begin_inset VSpace bigskip
18664 \begin_layout Standard
18668 \begin_layout Plain Layout
18680 \begin_layout Standard
18684 \begin_layout Plain Layout
18693 \begin_layout Plain Layout
18707 \begin_layout Standard
18712 \begin_layout Plain Layout
18723 \begin_layout Plain Layout
18732 \begin_layout Plain Layout
18741 \begin_layout Plain Layout
18750 \begin_layout Plain Layout
18759 \begin_layout Plain Layout
18768 \begin_layout Plain Layout
18777 \begin_layout Plain Layout
18786 \begin_layout Plain Layout
18795 \begin_layout Plain Layout
18804 \begin_layout Plain Layout
18813 \begin_layout Plain Layout
18822 \begin_layout Plain Layout
18831 \begin_layout Plain Layout
18840 \begin_layout Plain Layout
18849 \begin_layout Plain Layout
18858 \begin_layout Plain Layout
18867 \begin_layout Plain Layout
18876 \begin_layout Plain Layout
18885 \begin_layout Plain Layout
18891 There are times when the tyranny of rectangular paragraphs must be overthrown.
18892 In such situations, a call to the delightful plain TeX command
18899 As you can see, completely arbitrary shapes can be laid out with a suitable
18900 set of linelength definitions.
18901 While this parshape may look a bit silly and useless, one could conceive
18902 of situations such as finely tuned dropped capitals, word wrapping around
18903 non-rectangular graphics, etc.
18904 which will benefit from such handcrafting.
18907 \begin_layout Standard
18908 \begin_inset VSpace bigskip
18914 \begin_layout Standard
18919 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18926 is the number of lines of text which define the paragraph.
18927 If there turn out to be fewer lines, the shape is truncated; if there are
18928 more, the excess lines have the same dimensions as the last line of the
18938 entries specify the indentation of the line from the left margin, and the
18939 length of the line as measured from that point.
18940 The shape applies only to the current paragraph; everything is reset to
18941 normal for the next paragraph.
18944 \begin_layout Standard
18948 \begin_layout Plain Layout
18960 \begin_layout Section
18964 \begin_layout Standard
18965 As you can see, the examples in this section range from the useful to the
18967 While I don't expect that anyone will ever need the paragraph shape demonstrate
18968 d in the last section, the important point is that you can do almost anything
18969 you want in LyX if you are willing to figure out how to do it in TeX and
18971 TeX is a fantastically powerful typesetting system and all that power is
18972 available to you since LyX uses it as its backend.