1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the User's Guide prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the User's Guide may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
57 \font_typewriter default
58 \font_default_family default
68 \pdf_title "LyX's Extended manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX's extended documentation"
71 \pdf_keywords "LyX, Documentation, Extended"
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen false
75 \pdf_bookmarksopenlevel 1
80 \pdf_pagebackref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
89 \paperorientation portrait
92 \paragraph_separation indent
94 \quotes_language english
97 \paperpagestyle headings
98 \tracking_changes false
107 Extended LyX Features
115 \begin_layout Plain Layout
117 Principal maintainer of this file is
122 If you have comments or error corrections, please send them to the LyX
123 Documentation mailing list, <lyx-docs@lists.lyx.org>.
131 \begin_layout Standard
132 \begin_inset CommandInset toc
133 LatexCommand tableofcontents
140 \begin_layout Chapter
144 \begin_layout Standard
147 Extended LyX Features
149 manual, which you are now reading, is essentially Part II of the
151 User's Guide\SpecialChar \@.
154 The reason for splitting this document is simple: the
158 is already huge, and it contains all of the basic features one needs to
159 know in order to prepare most documents.
160 However, the LyX Team has a long-term goal of making LyX extensible through
161 various configuration files and external packages.
162 That means that if you want to support the Fizzwizzle LaTeX package, you
163 can create a layout file for it without having to alter LyX itself.
164 We've already had contributions of several new features this way.
165 This is the place where all of that gets documented.
168 \begin_layout Standard
169 This manual also documents some special features, like fax support, version
170 control, and SGML support, which require additional software to work properly.
171 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
172 spruce up your documents by directly using the powerful features of LaTeX.
177 only WYSIWYM, and will only ever interface to certain LaTeX features.
180 \begin_layout Standard
181 Of course, with all of this extra documentation,
183 Extended LyX Features
185 may itself grow too big for its britches.
186 In that case, you can just call it the
187 \begin_inset Quotes eld
191 \begin_inset Quotes erd
197 \begin_layout Standard
198 If you haven't read the
202 yet, you are definitely in the wrong manual.
207 is the first place to go, since it will direct you to the correct manual,
208 and it also describes the notation and format of all of the manuals.
209 You should also be thoroughly familiar with the
213 and all of the basic features of LyX.
217 \begin_layout Standard
218 In this document, many sections are independent articles contributed by
219 an individual and are noted as such.
220 This person is generally whoever wrote the layout file for the new document
221 class or LaTeX package, or implemented the feature.
222 If there is no mention of an author to a chapter [or chapter sections],
223 that means it was written by the LyX Documentation Team.
226 \begin_layout Standard
227 Since all the topics in this manual depend heavily on LyX's interaction
228 with LaTeX, this first chapter covers the inner workings of LyX and how
229 to direct LyX to generate exactly the LaTeX code you want.
230 It is obviously for more seasoned LyX users.
233 \begin_layout Chapter
237 \begin_layout Section
241 \begin_layout Standard
242 \begin_inset CommandInset label
244 name "sec:lyxandlatex"
248 This chapter is for both TeX-nicians and the LaTeX-curious.
249 In it, we'll explain how LyX and LaTeX work together to produce printable
251 This is the only place in any of the manuals where we assume you know something
255 \begin_layout Standard
256 At one time, we called LyX a
257 \begin_inset Quotes eld
260 WYSIWYM frontend to LaTeX,
261 \begin_inset Quotes erd
264 but that's no longer true.
265 There are frontends to LaTeX out there.
266 They are basically editors with the ability to run LaTeX and mark any errors
267 in the file you're editing.
276 run LaTeX, and it also marks errors in the file, it also does much, much
278 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
279 LyX has also added a few extensions to LaTeX.
280 Try the following sometime: select
282 Export\SpecialChar \menuseparator
292 menu, then look at the preamble of the resulting
297 You'll notice a variety of new macros defined specifically by LyX.
298 These macros are defined automatically, according to the features you use
302 \begin_layout Standard
303 There are several commands that automatically invoke LaTeX.
307 \begin_layout Itemize
313 iew\SpecialChar \menuseparator
323 \begin_layout Itemize
329 iew\SpecialChar \menuseparator
334 pdate\SpecialChar \menuseparator
340 \begin_layout Itemize
348 \SpecialChar \menuseparator
354 \begin_layout Itemize
362 \SpecialChar \menuseparator
368 \begin_layout Standard
369 They will only invoke LaTeX if the file has changed since the last time
374 \begin_layout Standard
375 When you run LaTeX on the file you're editing, LyX performs these steps:
378 \begin_layout Enumerate
379 Convert the document to LaTeX and save to a file with the extension
390 \begin_layout Enumerate
395 file (maybe several times).
398 \begin_layout Enumerate
399 If there are any errors, insert error boxes in the document to mark where
401 These boxes are transient and are not saved along with the document.
404 \begin_layout Standard
405 If you've run LaTeX using
433 , LyX performs two more steps:
436 \begin_layout Itemize
441 to convert the DVI file to PostScript:
445 \begin_layout Itemize
454 , the output file has the extension
459 \begin_layout Itemize
471 , the output file has the extension
479 \begin_layout Itemize
484 or send the PostScript file to the printer.
487 \begin_layout Section
488 \begin_inset Quotes eld
491 Help! LyX generated an unreadable
496 \begin_inset Quotes erd
502 \begin_layout Standard
503 Die-hard LaTeX users will scream and howl this into the night, then declare
504 LyX useless, simply because they didn't RTFM.
507 \begin_layout Standard
508 We're going to set the record straight.
509 LyX produces two kinds of LaTeX files.
510 One is human readable.
511 The other is LyX readable.
512 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
518 file is not human readable.
519 Don't even try to read it.
524 file that you can send to a colleague, select
529 xport\SpecialChar \menuseparator
546 \begin_layout Section
547 Translating LaTeX files into LyX
548 \begin_inset CommandInset label
550 name "sec:Translating-LaTeX-files"
557 \begin_layout Standard
558 You can import a LaTeX file into LyX by using the
563 ile\SpecialChar \menuseparator
568 mport\SpecialChar \menuseparator
576 This will call a program named
580 ---which will create a file
588 ---and then open that file.
591 \begin_layout Standard
596 will translate most legal LaTeX, but not everything.
597 It will leave things it doesn't understand in TeX mode, so after translating
602 , you can look for red text and hand-edit it to look right.
605 \begin_layout Standard
606 If you just want to put a piece of LaTeX code into a LyX file, see Section
611 \begin_inset CommandInset ref
613 reference "sec:latexcodes"
620 \begin_layout Section
621 Inserting LaTeX Code into LyX Documents
622 \begin_inset CommandInset label
624 name "sec:Inserting-LaTeX-Code"
631 \begin_layout Standard
632 \begin_inset CommandInset label
634 name "sec:latexcodes"
638 This is a rather important point: You can always insert LaTeX code into
640 LyX simply cannot, and will probably never be able to, display every possible
642 If ever you need to insert LaTeX commands into your LyX document, you can
643 use the ERT box, which you can insert into your document with
648 nsert\SpecialChar \menuseparator
656 The ERT box comes in three forms: collapsed, open, and inlined.
657 The first two are used just like any other collapsible (foldable) box (such
658 as footnotes), and are useful for significant amounts of LaTeX commands.
660 \begin_inset Quotes eld
664 \begin_inset Quotes erd
667 ERT box displays its content as part of the button, and is useful for very
668 short sections of LaTeX commands.
673 \begin_layout Plain Layout
683 \begin_layout Standard
684 You can switch between all three by right-clicking on the ERT.
685 Note that if you want more than one line of LaTeX commands, you cannot
686 use the inlined mode.
689 \begin_layout Standard
690 Here's an example of inserting LaTeX commands in a LyX document.
691 The code looks like this:
694 \begin_layout LyX-Code
698 \begin_inset Newline newline
704 \begin_inset Newline newline
707 This is an example for a minipage environment.
709 \begin_inset Newline newline
712 can put nearly everything in it, even (non-floating)
713 \begin_inset Newline newline
718 \begin_inset Newline newline
724 \begin_inset Newline newline
728 \begin_inset Newline newline
734 \begin_inset Newline newline
740 \begin_inset Newline newline
746 \begin_inset Newline newline
751 \begin_inset Newline newline
757 \begin_inset Newline newline
763 \begin_inset Newline newline
769 \begin_inset Newline newline
777 \begin_layout LyX-Code
781 \begin_layout Standard
782 The ERT box containing this text is directly after this paragraph.
783 Those of you reading the manual online will only see a bunch of funky text
785 Those reading a printed version of the manuals will see the actual results:
788 \begin_layout Standard
792 \begin_layout Plain Layout
799 \begin_layout Plain Layout
806 \begin_layout Plain Layout
808 This is an example for a minipage environment.
809 You can put nearly everything in it, even (non-floating) figures and tables.
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
825 \begin_layout Plain Layout
832 \begin_layout Plain Layout
839 \begin_layout Plain Layout
846 \begin_layout Plain Layout
852 \begin_layout Plain Layout
859 \begin_layout Plain Layout
866 \begin_layout Plain Layout
873 \begin_layout Plain Layout
885 \begin_layout Standard
886 In addition to these two methods, you can also create a separate file containing
887 some complex LaTeX structure.
893 nsert\SpecialChar \menuseparator
904 to include your file (you should select the type
909 We recommend that you only do this if you have a
918 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
922 \begin_layout Standard
923 There are a few last notes to emphasize:
926 \begin_layout Itemize
927 Inside of LyX, LaTeX code appears
932 \begin_layout Itemize
937 check if your LaTeX code is correct.
940 \begin_layout Itemize
941 Beware reinventing the wheel.
944 \begin_layout Standard
945 That last note refers to two things.
946 First, LyX does have quite a few features tucked into it, and more are
948 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
949 feature before you go off merrily coding LaTeX.
950 Second, there are numerous LaTeX packages out there to do all sorts of
951 things, from labels to envelopes to fancy multipage tables.
952 Check out a CTAN site for details (see Section
953 \begin_inset Quotes eld
957 \begin_inset Quotes erd
968 \begin_layout Plain Layout
973 : I seem to do this an awful lot.
974 Sat down and merrily began coding something to print out labels, only to
975 learn that there were already 2 different LaTeX packages to do this.
976 Worse yet --- I had them already!
984 \begin_layout Standard
985 If you do need to do some wild and fancy things within your document, be
986 sure to check out a good LaTeX book for assistance.
987 There are a number of them listed in the bibliography of the
994 \begin_layout Standard
995 There are a number of LaTeX commands which have to be placed before the
996 beginning of the actual text.
997 They go into the preamble, and this is explained in the next section.
1000 \begin_layout Section
1001 LyX and the LaTeX Preamble
1004 \begin_layout Subsection
1005 About the LaTeX Preamble
1008 \begin_layout Standard
1009 \begin_inset CommandInset label
1015 If you already know LaTeX, there is no need to explain here what the preamble
1017 If you don't, the following will give you some ideas --- we recommend again
1018 that you consult a LaTeX book for further information.
1019 In any case, you should read the points below, because they explain what
1020 you can do and what you don't need to do in the LaTeX preamble of a LyX
1024 \begin_layout Standard
1025 The LaTeX preamble comes at the very beginning of a document,
1033 \begin_layout Itemize
1034 declare the document class.
1035 LyX already does this for you.
1039 \begin_layout Standard
1040 If you're a seasoned LaTeX-nician, and you have some custom document class
1041 you want to use, check out the
1043 Customization Manual
1045 for information on how to make LyX interface to it.
1046 Be sure to submit your efforts to the LyX Team for inclusion in future
1051 \begin_layout Itemize
1052 declare the usage of packages.
1053 LaTeX packages provide special commands, which are only available within
1054 a document when the package has been declared in the preamble.
1055 For example, the package
1059 forces all paragraphs to be indented.
1060 There are other packages for labels, envelopes, margins, etc.
1064 \begin_layout Itemize
1065 set counters, variables, lengths and widths.
1066 There are several LaTeX counters and variables which
1070 be set globally from within the preamble in order to have the desired effect.
1071 [There are other variables which you can set and reset inside the document,
1072 too.] Margins are a good example of something which must be set in the preamble.
1073 Another example is the label format for lists.
1074 You can actually set these just about anywhere, but it's best to do it
1075 just once, inside the preamble.
1078 \begin_layout Itemize
1079 declare user defined commands [with
1091 ], mostly abbreviations for LaTeX commands which appear very often inside
1093 Although the preamble is a good place to declare such commands, they
1097 be declared anywhere else [but
1101 they are used for the first time, of course\SpecialChar \ldots{}
1103 This can be useful if there is a lot of raw LaTeX code in your document,
1104 which normally should not be the case.
1107 \begin_layout Standard
1108 LyX adds its own set of definitions to the preamble of the
1113 This makes LaTeX files generated by LyX portable.
1116 \begin_layout Subsection
1117 Changing the Preamble
1120 \begin_layout Standard
1121 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1122 can't change them without patching LyX itself.
1123 You can, however, add your own stuff to the preamble.
1124 There are two ways to do this:
1127 \begin_layout Enumerate
1134 \begin_inset space ~
1157 \SpecialChar \menuseparator
1165 dialog, depending on your frontend.
1166 Note that the LyX keybindings will not work in this dialog, alas.
1169 \begin_layout Enumerate
1170 Use the preamble contents you've added as your default template (see
1171 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1182 ), so that it will be the default preamble for any file you create.
1185 \begin_layout Standard
1186 LyX adds anything in the
1193 dialog to its own built-in preamble.
1194 Before adding your own declarations in the preamble, you should make sure
1195 that LyX doesn't already support what you want to do (remember what we
1196 said about reinventing the wheel?).
1199 make sure your preamble code is correct
1202 LyX doesn't check it.
1205 \begin_layout Subsection
1209 \begin_layout Standard
1210 Here are some examples of what you can add to a preamble, and what they
1214 \begin_layout Subsubsection
1218 \begin_layout Standard
1219 There are two variables under LaTeX that control page position:
1232 Their names should be self-explanatory.
1233 These variables are useful if you think for a moment about computer labels.
1234 Sometimes, the size of a print medium and the area of the medium that you
1235 can actually print on aren't the same.
1251 \begin_layout Standard
1252 The default values for
1265 \begin_inset space ~
1269 \begin_inset space ~
1273 \begin_inset space ~
1276 the page isn't shifted.
1279 \begin_layout Standard
1280 Unfortunately, some DVI drivers always seem to shift the page.
1281 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1282 If you're using LyX on a system that you don't personally maintain, and
1283 your sysadmin is a doofus,
1296 Suppose you're left and top margins are always 0.5 inches too big.
1297 You can add this to the preamble:
1300 \begin_layout LyX-Code
1308 \begin_layout LyX-Code
1316 \begin_layout Standard
1317 \SpecialChar \ldots{}
1318 and your margins should now be correct.
1321 \begin_layout Subsubsection
1325 \begin_layout Standard
1326 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1327 There's a rather nice package, available at your nearest CTAN archive,
1328 for printing sheets of labels, called
1333 Now, your system may not have this package installed by default.
1334 We leave that up to you to check.
1335 You'll also want to read the documentation for it; we're not going to do
1337 Since this is an example, however, we'll give you an example of how you
1341 \begin_layout Standard
1342 First, make sure you're using the
1347 Next, you need to put the following in your preamble:
1350 \begin_layout LyX-Code
1356 \begin_layout LyX-Code
1362 \begin_layout LyX-Code
1368 \begin_layout LyX-Code
1374 \begin_layout LyX-Code
1380 \begin_layout LyX-Code
1386 \begin_layout LyX-Code
1392 \begin_layout Standard
1393 This sets things up for Avery® label sheets, stock #5360.
1394 You're now ready to print labels, but you'll need to insert LaTeX code,
1395 placing the commands
1407 around each label text.
1408 This and other special features of
1412 are explained in its documentation.
1415 \begin_layout Standard
1416 Someday, someone may write a LyX layout file to support this package directly.
1417 Maybe that someone is you.
1420 \begin_layout Subsubsection
1421 Example #3: Paragraph Indentation
1424 \begin_layout Standard
1425 Americans are trained to indent the first line of
1430 As with all of their other weird quirks, most Americans will whine and
1431 moan until they can have their way and indent the first line of all paragraphs.
1435 \begin_layout Plain Layout
1440 : This was written by an American ---
1444 ! It's my perception of my fellow countrymen.
1445 Tough if you don't like it.
1454 \begin_layout Standard
1455 Of course, this behavior isn't standard typography.
1456 In books, you typically only indent the first line of a paragraph
1460 it follows another one.
1461 The idea behind indenting the first line of a paragraph is to distinguish
1462 neighboring paragraphs from one another.
1463 If there is no previous paragraph, for example, it follows a figure, or
1464 is the first paragraph in a section, then there is no special indentation.
1468 \begin_layout Standard
1469 If you're a typical American, though, you don't care about such esoteric
1470 things; you want your indentation! Add this to the preamble:
1473 \begin_layout LyX-Code
1476 usepackage{indentfirst}
1479 \begin_layout Standard
1480 If your TeX distribution isn't a braindead one, you'll have this package,
1481 and all of your paragraphs will get the indentation you think they deserve.
1484 \begin_layout Subsubsection
1485 Example #4: This Document
1488 \begin_layout Standard
1489 You can also check out the preamble of this document to get an idea of some
1490 of the advanced things you can do.
1491 You'll probably need to make the
1496 reamble\SpecialChar \ldots{}
1499 dialog full-screen to see most of it.
1500 Also, there are more examples and an assortment of LaTeX
1501 \begin_inset Quotes eld
1505 \begin_inset Quotes erd
1509 \begin_inset space ~
1513 \begin_inset CommandInset ref
1515 reference "cha:secrets"
1523 \begin_layout Section
1524 LyX and LaTeX Errors
1527 \begin_layout Standard
1528 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1530 It then uses the log-file from the LaTeX run to do a post-mortem.
1531 As we stated earlier in the chapter, LyX generates two kinds of
1535 files, one of which it uses to locate errors in the document.
1536 If there was an error someplace, LyX will put a box with the word
1537 \begin_inset Quotes eld
1541 \begin_inset Quotes erd
1544 at the appropriate place in the document.
1548 \begin_layout Plain Layout
1549 LyX will occasionally misguess where the error was.
1550 This will typically happen with tables, figures, math, and the preamble.
1555 It will also display a message alerting you to the fact that there were
1559 \begin_layout Standard
1560 You can navigate through the errors by using
1576 \begin_inset Quotes eld
1580 \begin_inset Quotes erd
1583 the error-boxes and view the error message LaTeX produced by clicking on
1587 \begin_layout Standard
1588 Some folks also like to look at the log file directly, accessible from
1593 ocument\SpecialChar \menuseparator
1599 \begin_inset space ~
1603 \begin_inset space ~
1609 There are some fairly common error messages and warnings.
1610 We'll cover those here.
1611 You should look at a good LaTeX book for a complete listing.
1614 \begin_layout Itemize
1615 \begin_inset Quotes eld
1623 \begin_inset Quotes eld
1630 \begin_layout Standard
1631 Anything beginning with these word is a warning message for the purpose
1633 \begin_inset Quotes eld
1637 \begin_inset Quotes erd
1640 the LaTeX code itself.
1641 You'll get messages like this if you added or changed cross-references
1642 or bibliography entries, in which case, LaTeX is trying to tell you that
1643 you need to make another run.
1646 \begin_layout Standard
1647 You can by-and-large ignore these.
1651 \begin_layout Itemize
1652 \begin_inset Quotes eld
1660 \begin_inset Quotes erd
1667 \begin_layout Standard
1668 Another warning message, this time about fonts which LaTeX couldn't find.
1669 The rest of the message will often say something about a replacement font
1673 \begin_layout Standard
1674 You can safely ignore these.
1678 \begin_layout Itemize
1679 \begin_inset Quotes eld
1689 \begin_inset Quotes erd
1696 \begin_layout Standard
1702 They are warning you about lines that were too long and run past the right
1704 Almost always, this is unnoticeable in the final output.
1705 Or, only one or two characters extend past the margin.
1706 LaTeX seems to generate at least one of these messages for just about any
1710 \begin_layout Standard
1711 You can ignore these stupid messages.
1712 Your eyes will tell you if there's a problem with something that's too
1713 wide; just look at the output.
1717 \begin_layout Itemize
1718 \begin_inset Quotes eld
1728 \begin_inset Quotes erd
1735 \begin_layout Standard
1736 Not quite as common as its cousin.
1737 LaTeX seems to like to print lines that are a bit too wide as opposed to
1738 ones that are a bit too narrow.
1739 We have no idea why.
1742 \begin_layout Standard
1743 You can ignore these, too.
1747 \begin_layout Itemize
1748 \begin_inset Quotes eld
1758 \begin_inset Quotes erd
1762 \begin_inset Quotes eld
1772 \begin_inset Quotes erd
1779 \begin_layout Standard
1780 Warnings about troubles breaking the page.
1781 Once again, just look at the output.
1782 Your eyes will tell you where something has gone wrong.
1786 \begin_layout Itemize
1787 \begin_inset Quotes eld
1793 \begin_inset Quotes els
1797 \begin_inset Quotes ers
1803 \begin_inset Quotes erd
1810 \begin_layout Standard
1812 \begin_inset Quotes eld
1816 \begin_inset Quotes erd
1819 isn't installed on this system.
1820 This usually appears because some package your document needs isn't installed.
1821 If you didn't touch the preamble or didn't use the
1827 command, then one of the packages LyX tried to load is missing.
1833 elp\SpecialChar \menuseparator
1840 , to get a list of packages that LyX knows about.
1841 This file is updated whenever you reconfigure LyX (using
1848 \SpecialChar \menuseparator
1853 ) and tells you which packages have been detected and what they do.
1856 \begin_layout Standard
1867 command, and the package in question isn't installed, you'll need to install
1872 \begin_layout Itemize
1873 \begin_inset Quotes eld
1878 LaTeX Error: Unknown option
1881 \begin_inset Quotes erd
1888 \begin_layout Standard
1889 Error messages beginning with this are trying to tell you that you specified
1890 a bad or undefined option to a package.
1891 Check the package's documentation.
1895 \begin_layout Itemize
1896 \begin_inset Quotes eld
1901 Undefined control sequence
1904 \begin_inset Quotes erd
1911 \begin_layout Standard
1912 If you've inserted LaTeX code into your document, but made a typo, you'll
1914 You may have forgotten to load a package.
1915 In any case, this error message usually means that you used an undefined
1920 \begin_layout Standard
1921 There are other error and warning messages.
1922 Some are self-explanatory.
1923 These are usually LaTeX messages.
1924 Others are downright cryptic.
1925 These are actually TeX error messages, and we really have
1929 what they mean or how to decipher them.
1932 \begin_layout Standard
1933 There's a general sequence you should follow if you get error messages:
1936 \begin_layout Enumerate
1937 Look at the LaTeX code you inserted for typos.
1940 \begin_layout Enumerate
1941 If there are no typos, check and see that you used the command(s) correctly.
1944 \begin_layout Enumerate
1945 If you get a bunch of error boxes piled up at the very top of the document,
1946 it means that there are errors in the preamble.
1947 Start debugging your preamble.
1950 \begin_layout Enumerate
1951 If you didn't add anything to the preamble and didn't add any LaTeX code
1952 to the document, the first suspect is your LaTeX distribution itself.
1953 Check for missing packages and install them.
1956 \begin_layout Enumerate
1957 Okay, so there are no missing packages.
1958 Did you use any of the fine-tuning options in LyX? Specifically, did you
1963 any of them, like trying to manually insert lots of
1966 \begin_inset space ~
1979 s? Did you try to kludge something together with these instead of using
1980 the appropriate paragraph environment?
1983 \begin_layout Enumerate
1984 All right, you didn't use any of the fine-tuning options, you played by
1986 Did you try to pull a fancy maneuver? Did you do something funky inside
1987 a table or an equation, like inserting a graphic into a table cell?
1990 \begin_layout Enumerate
1991 Do you have long sections of text where LaTeX cannot find a place to break
1992 a line? By default, LaTeX is rather strict about how much extra inter-word
1993 spacing it will add in order to break a line.
1994 Preferably, you should rework the paragraph to avoid the problem.
1995 If this isn't an option, you can wrap your text in
2001 to make LaTeX's line breaking more, well, sloppy.
2004 \begin_layout Enumerate
2005 Did you go overboard with the nesting? LyX (currently) doesn't check to
2006 make sure you're in the limits for nesting environments.
2007 If you nested a bunch of environments to the
2008 \begin_inset Formula $17^{\mathrm{th}}$
2011 level, that's the problem.
2014 \begin_layout Enumerate
2015 Okay, you didn't get any error messages, but your output looks whacked.
2016 If you have a table or figure that's too wide or long for the page, you
2021 \begin_layout Enumerate
2022 rescale the figure so it fits.
2025 \begin_layout Enumerate
2026 trim down the table so it fits.
2029 \begin_layout Standard
2030 If something else is wrong with the output, and you didn't try to pull anything
2031 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2035 \begin_layout Standard
2036 If all this doesn't help --- well, then
2040 you might have found a bug in LyX\SpecialChar \ldots{}
2044 \begin_layout Chapter
2048 \begin_layout Section
2049 Preparing a Bibliography with BibTeX
2050 \begin_inset CommandInset label
2052 name "sec:Preparing-a-Bibliography"
2059 \begin_layout Standard
2066 Jürgen Spitzmüller
2069 \begin_layout Standard
2070 \begin_inset VSpace bigskip
2076 \begin_layout Standard
2078 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
2082 \begin_inset space \thinspace{}
2088 \begin_inset space ~
2091 setting up your own bibliographic databases),
2095 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2097 LaTeX: A Document Preparation System
2099 , particularly Appendix B.
2100 The rest of this discussion assumes you have created a correct bibliography
2101 file, that you have all relevant environment variables set correctly (esp.
2114 ), and that if sufficiently desperate, you could create and
2115 \begin_inset Quotes eld
2119 \begin_inset Quotes erd
2122 a LaTeX file with a BibTeX database.
2126 \begin_layout Standard
2127 For those who don't know what BibTeX is, it is a system for creating a large
2128 database of your most used journal references.
2129 For all future articles you write, you only need to include this standard
2130 database and reference the appropriate key to each reference.
2131 Even if you write only a few papers with handful of references each, it
2132 is well worth your time to examine BibTeX and decide whether it will be
2136 \begin_layout Standard
2137 To use BibTeX with LyX, first read the
2141 where it describes how to insert citations.
2142 The basic mechanism for inserting BibTeX references is the same.
2143 Then, at the very end of your document, select
2145 Insert\SpecialChar \menuseparator
2150 TOC\SpecialChar \menuseparator
2154 In the resulting dialog, fill out the dialog boxes as follows:
2157 \begin_layout Description
2158 Database: enter the name of your
2171 For searching multiple
2175 files, just enter them in the desired order, separated by commas.
2179 \begin_layout Description
2180 Style: enter the name of your BibTeX style file *without* the
2185 The default style is
2189 (which should be included in your LaTeX distribution, so you don't have
2190 to worry about creating it).
2193 \begin_layout Standard
2194 For each citation, assuming that the source is in the
2203 nsert\SpecialChar \menuseparator
2210 at the correct location in the text, and enter the appropriate reference
2212 Nothing else is required; when invoking
2217 iew\SpecialChar \menuseparator
2224 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2225 including multiple invocations of LaTeX.
2229 \begin_layout Subsection
2230 Alternative Citation Styles
2233 \begin_layout Standard
2234 Standard BibTeX uses numbers (e.
2235 \begin_inset space \thinspace{}
2239 \begin_inset space \space{}
2243 \begin_inset Quotes eld
2247 \begin_inset Quotes erd
2250 ) to refer to a cited work.
2251 However, in many scientific disciplines, other citation styles are in use.
2252 The most common one is the author-year style (e.
2253 \begin_inset space \thinspace{}
2257 \begin_inset space \space{}
2261 \begin_inset Quotes eld
2265 \begin_inset Quotes erd
2269 LyX supports two packages that provide this style,
2278 Both packages have their own pros and cons, which cannot be listed in detail.
2279 If you only want to have simple author-year (or author-numerical) style
2280 or if you want to use one of the countless style files for natbib, than
2285 package is probably your choice.
2286 If you need special features like short title references, ibidem etc., you
2287 might consider the fairly new
2294 \begin_layout Standard
2295 The handling of both packages in LyX is basically the same.
2301 ocument\SpecialChar \menuseparator
2312 pane (with the xforms frontend: the
2326 With both packages, you will get some extra features in the citation dialog
2327 and you can select the style of the reference (
2328 \begin_inset Quotes eld
2332 \begin_inset Quotes erd
2336 \begin_inset Quotes eld
2340 \begin_inset Quotes erd
2344 \begin_inset Quotes eld
2348 \begin_inset Quotes erd
2352 \begin_inset Quotes eld
2356 \begin_inset Quotes erd
2360 Note that both packages need specifically designed style files (they both
2361 ship their own, while there are lots of additional style files and even
2362 an interactive style file builder
2366 \begin_layout Plain Layout
2368 \begin_inset Flex URL
2371 \begin_layout Plain Layout
2373 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2390 \begin_layout Subsection
2391 Sectionated Bibliographies
2392 \begin_inset CommandInset label
2394 name "sub:Sectionated-Bibliographies"
2401 \begin_layout Standard
2402 Sometimes you might need to divide your bibliography into several sections.
2403 If you are, for instance, a historian, the possibility to separate sources
2404 and scientific works is most likely a
2405 \begin_inset Quotes eld
2409 \begin_inset Quotes erd
2413 Unfortunately, BibTeX itself does not allow you to do this.
2414 The good news is, though: With the help of some LaTeX packages, BibTeX
2415 can be extended to fit your historical needs.
2418 \begin_layout Standard
2419 As of version 1.4, LyX provides native support for one of these packages,
2428 \begin_layout Plain Layout
2430 \begin_inset Flex URL
2433 \begin_layout Plain Layout
2435 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2445 The advantage of this package (compared to other packages like
2449 ) is that you don't need to define new citation commands.
2450 Instead, you need to prepare different bibliographic databases which include
2451 the entries for the different sections of the bibliography.
2452 For example: If you want to divide your bibliography into the sections
2454 \begin_inset Quotes eld
2458 \begin_inset Quotes erd
2462 \begin_inset Quotes eld
2466 \begin_inset Quotes erd
2469 , you first need to create two bibliographic databases, e.
2470 \begin_inset space \thinspace{}
2474 \begin_inset space \space{}
2489 \begin_layout Standard
2495 ocument\SpecialChar \menuseparator
2506 pane (with the xforms frontend: the
2514 \begin_inset space ~
2520 Now you can insert multiple BibTeX references (as described in section
2521 \begin_inset space ~
2525 \begin_inset CommandInset ref
2527 reference "sec:Preparing-a-Bibliography"
2531 ), one for each section of your bibliography.
2532 Returning to our example: Insert a BibTeX reference for the database
2536 and a second one for the database
2541 You are free to use the same or different styles for each section.
2542 Additionally, you can chose if the bibliography section should contain
2544 \begin_inset Quotes eld
2547 all cited references
2548 \begin_inset Quotes erd
2551 of the specified database(s) (which is the default),
2552 \begin_inset Quotes eld
2555 all uncited references
2556 \begin_inset Quotes erd
2560 \begin_inset Quotes eld
2564 \begin_inset Quotes erd
2568 This might be useful if you would like to separate your bibliography into
2570 \begin_inset Quotes eld
2574 \begin_inset Quotes erd
2578 \begin_inset Quotes eld
2582 \begin_inset Quotes erd
2586 \begin_inset Quotes eld
2590 \begin_inset Quotes erd
2594 The titles for the sections can be added as ordinary sections or subsections.
2599 removes the bibliography title, you have manually re-add that, too (as
2600 a chapter* or section*, for instance).
2603 \begin_layout Subsection
2604 Multiple Bibliographies
2607 \begin_layout Standard
2608 Multiple bibliographies, e.
2609 \begin_inset space \thinspace{}
2613 \begin_inset space \space{}
2616 a bibliography for each section or chapter of the document, are not supported
2622 package, which is used for the creation of sectionated bibliographies in
2624 \begin_inset space ~
2628 \begin_inset space ~
2632 \begin_inset CommandInset ref
2634 reference "sub:Sectionated-Bibliographies"
2638 ), provides an easy way to solve this task, if you are willing to use some
2639 LaTeX-Code (ERT, cf.
2640 \begin_inset space ~
2644 \begin_inset space ~
2648 \begin_inset CommandInset ref
2650 reference "sec:Inserting-LaTeX-Code"
2658 \begin_layout Plain Layout
2659 An alternative approach is to use the
2667 package, respectively.
2675 \begin_layout Standard
2681 ocument\SpecialChar \menuseparator
2692 pane (with the xforms frontend: the
2700 \begin_inset space ~
2706 In the document, you have to enclose the sections, which shall contain
2707 their own bibliography (including the BibTeX reference itself), between
2720 (those commands have to be inserted as ERT).
2721 The bibliography will contain all references which have been cited in the
2724 \begin_inset space \thinspace{}
2727 B.: If you are using this approach, then
2731 citation reference has to be inside some btUnit.
2732 Also, the btUnits cannot be nested.
2735 \begin_layout Standard
2739 \begin_layout Section
2743 \begin_layout Subsection
2747 \begin_layout Standard
2748 When you are working on a large file with many sections, it is often convenient
2749 to break up the document into several files, or perhaps you have something
2750 where a table may change from time to time, but the preceding text does
2752 In these cases, you should seriously consider using multipart documents.
2753 For example, scientific papers often have five major sections: the introduction
2754 , observations, results, discussion, and conclusion.
2755 Each of these could be its own separate LyX file, with one
2756 \begin_inset Quotes eld
2760 \begin_inset Quotes erd
2763 file which contains the title, authors, abstract, references, etc., plus
2764 the five included files.
2765 It is important to note that each of these files is a full LyX file which
2766 can be formatted and printed on its own, as well as included in a master
2768 Each of these files must have the same document class, however--- don't
2769 attempt to mix book classes with article classes.
2770 You may also include LaTeX files; however, these files must not have their
2776 everything up to and including the
2788 line must be deleted) or else errors will be generated when you try to
2792 \begin_layout Standard
2793 LyX allows you to include files quite easily with
2798 nsert\SpecialChar \menuseparator
2804 \begin_inset space ~
2810 When you click on this selection a small box is inserted into the file
2811 at the current cursor location.
2812 Clicking on the box raises a dialog which allows you to select the file
2813 to be included, and the method of its inclusion.
2817 \begin_layout Standard
2818 The file selection box should by now be obvious.
2819 The three inclusion methods are
2820 \begin_inset Quotes eld
2824 \begin_inset Quotes erd
2828 \begin_inset Quotes eld
2832 \begin_inset Quotes erd
2836 \begin_inset Quotes eld
2840 \begin_inset Quotes erd
2844 The difference between
2845 \begin_inset Quotes eld
2849 \begin_inset Quotes erd
2853 \begin_inset Quotes eld
2857 \begin_inset Quotes erd
2860 is really only meaningful to LaTeXperts, but the practical difference is
2861 that files which are
2862 \begin_inset Quotes eld
2866 \begin_inset Quotes erd
2869 are typeset beginning on a new page, while files which are
2870 \begin_inset Quotes eld
2874 \begin_inset Quotes erd
2877 are typeset starting on the current page.
2878 Perhaps the labeling in LyX will be changed someday to reflect this.
2881 \begin_layout Standard
2882 Generally, the master file is converted into a full LaTeX file before typesettin
2883 g, while the included files are converted to LaTeX files which do not have
2884 all the preamble information.
2890 \begin_inset space ~
2897 button prevents this conversion.
2900 \begin_layout Standard
2902 \begin_inset Quotes eld
2906 \begin_inset Quotes erd
2909 included file allows you to include a file typeset exactly as it appears
2911 \begin_inset space ~
2914 verbatim mode, with the characters set in a fixed-width typewriter font.
2915 Normally, spaces in this file are invisible, though two consecutive spaces
2916 are conserved, unlike LyX's normal treatment of spaces.
2917 However, setting the
2923 \begin_inset space ~
2927 \begin_inset space ~
2931 \begin_inset space ~
2936 checkbox typesets a mark to unambiguously define the presence of a space.
2940 \begin_layout Subsection
2941 Cross-References Between Files
2944 \begin_layout Standard
2945 It is possible to set up cross-references between the different files.
2946 First, open all the files in question: let's call them A and B in a two
2947 file example, where B is included in A.
2948 Let's say you insert a label in A, then want to reference it in B.
2949 Open the cross-reference dialog in whilst in document B, and you can select
2951 \begin_inset Quotes eld
2955 \begin_inset Quotes erd
2961 \begin_layout Section
2962 Fancy Headers and Footers
2965 \begin_layout Standard
2966 The default page layout is rather plain; for an article document class,
2967 all you get is a centered page number at the bottom of the page.
2968 This document is the book class, so it appears to be a bit fancier, but
2969 to really put on a show, you need to set the document page style to
2970 \begin_inset Quotes eld
2974 \begin_inset Quotes erd
2977 , as mentioned in the
2980 \begin_inset space ~
2986 This section describes the LaTeX codes you need to insert in your LaTeX
2987 preamble or the text in order to get the desired effects.
2990 \begin_layout Standard
2991 The page header is divided into three fields, not surprisingly labeled
2992 \begin_inset Quotes eld
2996 \begin_inset Quotes erd
3000 \begin_inset Quotes eld
3004 \begin_inset Quotes erd
3008 \begin_inset Quotes eld
3012 \begin_inset Quotes erd
3016 The footer is also divided into these three fields.
3017 The LaTeX commands to set these fields in the simplest manner are
3042 Suppose you wish to put your name in the upper left hand corner of each
3044 Simply insert the following command in the preamble:
3047 \begin_layout Standard
3056 \begin_layout Standard
3057 You will now see your name in the upper left.
3058 If a field has a default entry that you would like to get rid of (often
3059 the page number appears in the central footer, simply include a command
3060 with a blank argument, e.
3061 \begin_inset space \thinspace{}
3067 \begin_layout Standard
3075 \begin_layout Standard
3076 Let's get really fancy: lets put the section number with the word
3077 \begin_inset Quotes eld
3081 \begin_inset Quotes erd
3085 \begin_inset space \thinspace{}
3089 \begin_inset space ~
3092 Section 3) in the upper left, the page number (e.
3093 \begin_inset space \thinspace{}
3097 \begin_inset space ~
3100 Page 4) in the upper right, your name in the lower left, and the date in
3102 The following commands should now appear in the preamble:
3105 \begin_layout Standard
3115 \begin_layout Standard
3123 \begin_layout Standard
3133 \begin_layout Standard
3142 \begin_layout Standard
3150 \begin_layout Standard
3160 \begin_layout Standard
3173 access LaTeX's section and page counters, and so print out the current
3174 section and page numbers.
3181 simply prints out today's date.
3184 \begin_layout Standard
3185 The thicknesses of the horizontal rules drawn beneath the header and above
3186 the footer can also be modified.
3187 If you don't want one of the headers, set its thickness to 0.
3188 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3189 Use the commands, e.
3190 \begin_inset space \thinspace{}
3200 headrulewidth}{0.4pt}
3208 footrulewidth}{0.4pt}
3210 to set the thicknesses.
3213 \begin_layout Standard
3214 You can switch the header/footer settings on and off for individual pages
3219 thispagestyle{empty}
3225 thispagestyle{plain}
3231 thispagestyle{fancy}
3234 Simply insert them in the text on the page you want changed and mark them
3236 In fact, title pages are marked as plain by default, while following pages
3237 are marked fancy when using the global fancy setting.
3240 \begin_layout Standard
3241 There are more complex commands which will let you insert things in the
3242 upper left on odd numbered pages, etc., but I will refer you to the
3246 package documentation for more descriptions.
3247 For example, if you have a teTeX installation, look for
3249 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3255 \begin_layout Standard
3256 As a final example, it is possible to include an Encapsulated PostScript
3257 file in the header or footer.
3258 Suppose you want to put a company logo in the upper lefthand corner.
3259 You might try something like
3262 \begin_layout Standard
3271 includegraphics{logo.eps}}}
3274 \begin_layout Standard
3276 (you may need to preface this with
3280 usepackage{graphics}
3282 if you don't include EPS files elsewhere in your document).
3285 \begin_layout Section
3286 Itemize Bullet Selection
3287 \begin_inset CommandInset label
3296 \begin_layout Standard
3302 \begin_layout Subsection
3306 \begin_layout Standard
3307 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3308 Using this dialog you can easily specify what bullet shape to use at each
3309 level of an itemized list.
3310 These settings are document-wide so you won't be able to specify different
3311 sets of bullets for different paragraphs
3315 \begin_layout Plain Layout
3316 Well, actually you can but you'll have to do it by hand.
3324 \begin_layout Subsection
3328 \begin_layout Standard
3329 Open the dialog by selecting the
3334 ocument\SpecialChar \menuseparator
3341 menu item and then select the
3351 \begin_layout Standard
3352 The dialog provides you with a table of bullet shapes.
3353 A column of buttons on the left of the table provides access to the six
3354 different panels of bullet shapes.
3355 The row of buttons across the top is used to select which bullet depth
3357 A text entry under the table shows the currently selected bullet shape's
3358 LaTeX equivalent and this can be edited if desired.
3359 If you do modify the text you will also need to specify any needed packages
3360 in the LaTeX preamble.
3363 \begin_layout Standard
3364 The six panels are divided up by the packages they require.
3365 The following table shows the mappings from button name to LaTeX packages.
3368 \begin_layout Standard
3370 \begin_inset Tabular
3371 <lyxtabular version="3" rows="7" columns="2">
3373 <column alignment="center" valignment="top" width="0pt">
3374 <column alignment="center" valignment="top" width="0pt">
3376 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3379 \begin_layout Plain Layout
3394 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3397 \begin_layout Plain Layout
3414 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3417 \begin_layout Plain Layout
3432 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3435 \begin_layout Plain Layout
3451 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3454 \begin_layout Plain Layout
3469 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3472 \begin_layout Plain Layout
3489 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3492 \begin_layout Plain Layout
3507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3510 \begin_layout Plain Layout
3527 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3530 \begin_layout Plain Layout
3545 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3548 \begin_layout Plain Layout
3565 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3568 \begin_layout Plain Layout
3583 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3586 \begin_layout Plain Layout
3603 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3606 \begin_layout Plain Layout
3621 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3624 \begin_layout Plain Layout
3647 \begin_layout Standard
3648 LyX doesn't stop you using bullets from packages you don't have.
3649 If you get errors from LaTeX when you try to view or print the file then
3650 its likely you are missing a package.
3651 LyX doesn't restrict your use since you may be editing locally and exporting
3655 \begin_layout Subsection
3659 \begin_layout Standard
3660 Select which bullet depth you want to change then select the bullet shape
3662 Any changes will not be visible in LyX, but are visible when viewing the
3663 document using xdvi or ghostview.
3666 \begin_layout Standard
3667 You can reset a bullet shape to the default simply by clicking your right
3668 mouse button on the appropriate bullet depth button.
3671 \begin_layout Standard
3676 want to have multiple sets of paragraphs with different sets of bullets
3677 in each then you're going to have to get your hands dirty.
3678 The itemize bullet selection dialog can help though because it provides
3679 you with the LaTeX code for a wide range of bullet shapes.
3680 To make your own custom paragraphs you have the following options:
3683 \begin_layout Standard
3687 \begin_layout Plain Layout
3703 \begin_layout Standard
3707 \begin_layout Plain Layout
3729 \begin_layout Itemize
3730 Use the LaTeX command
3736 to specify a new bullet shape for a given depth.
3737 You'll also need to save the current bullet shape so you can restore it
3739 In this itemized list the following LaTeX code was used to change the bullet
3740 used for the first depth.
3741 \begin_inset Newline newline
3757 \begin_inset Newline newline
3773 \begin_inset Newline newline
3778 Note that the itemize depth is specified in Roman numerals as part of the
3788 \begin_layout Itemize
3792 \begin_layout Plain Layout
3805 Specify each individual entry by starting each item with the bullet shape
3806 enclosed in square brackets and set as TeX.
3807 For example, this item was started with
3820 \begin_layout Standard
3824 \begin_layout Plain Layout
3840 \begin_layout Standard
3841 You'll also need to revert the labelitem back to its previous setting for
3842 the global bullet shape settings to remain in effect.
3843 The way used here was:
3844 \begin_inset Newline newline
3858 \begin_layout Chapter
3859 Special Document Classes
3862 \begin_layout Section
3863 \begin_inset CommandInset label
3865 name "sec:AMS-LaTeX"
3872 \begin_layout Standard
3875 David Johnson; updated by Richard Heck
3878 \begin_layout Standard
3879 \begin_inset VSpace bigskip
3885 \begin_layout Standard
3887 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3888 papers to be submitted to American Mathematical Society publications.
3889 The layouts are not tailored to a specific journal, but easily can be.
3890 You should refer to the AMS documentation for specific instructions for
3891 each journal (usually it will entail only changing a single line in the
3893 That documentation is available on the Web at
3894 \begin_inset Flex URL
3897 \begin_layout Plain Layout
3905 \begin_inset Flex URL
3908 \begin_layout Plain Layout
3910 ftp://ftp.ams.org/pub/tex/amslatex/
3916 These layouts are appropriate, and useful, for any mathematical writing.
3920 \begin_layout Standard
3921 There are two basic AMS LaTeX layouts:
3924 \begin_layout Enumerate
3925 amsart: The standard AMS article format.
3928 \begin_layout Enumerate
3929 amsbook: the standard AMS book (really, monograph) format.
3933 \begin_layout Standard
3934 These layouts themselves contain only the minimum necessary to use the AMS
3936 They do not, in particular, contain any of the `theorem' environments used
3937 for setting theorems, lemmas, and the like.
3938 These are contained, instead, in the
3939 \begin_inset Flex CharStyle:Code
3942 \begin_layout Plain Layout
3948 module, which you will need to load separately when you selected one of
3950 Less commonly used environments are in the
3951 \begin_inset Flex CharStyle:Code
3954 \begin_layout Plain Layout
3955 Theorems (AMS-Extended)
3964 \begin_layout Standard
3965 By default, theorems and the like are numbered consecutively throughout
3966 the document, but this may be modified by loading the module
3967 \begin_inset Flex CharStyle:Code
3970 \begin_layout Plain Layout
3971 Theorems (Order by Section)
3976 or, if you are using
3977 \begin_inset Flex CharStyle:Code
3980 \begin_layout Plain Layout
3987 \begin_inset Flex CharStyle:Code
3990 \begin_layout Plain Layout
3991 Theorems (Order by Chapter)
3997 These will number the results as
3998 \begin_inset Formula $n.m$
4001 , where the first number refers to the section (or chapter) and the second
4002 refers to the total number of results so far in that section (or chapter).
4003 Many environments are also available unnumbered.
4004 These are indicated by an asterisk at the end.
4005 If you happen to want
4009 unnumbered results, the the module
4010 \begin_inset Flex CharStyle:Code
4013 \begin_layout Plain Layout
4019 provides that option.
4022 \begin_layout Standard
4023 Note that these modules do not
4027 to be used with the AMS classes.
4028 It is perfectly possible to use the
4029 \begin_inset Flex CharStyle:Code
4032 \begin_layout Plain Layout
4038 module, and the others mentioned, with other classes, such as
4039 \begin_inset Flex CharStyle:Code
4042 \begin_layout Plain Layout
4049 \begin_inset Flex CharStyle:Code
4052 \begin_layout Plain Layout
4059 \begin_inset Flex CharStyle:Code
4062 \begin_layout Plain Layout
4071 \begin_layout Subsection
4072 What these layouts provide
4075 \begin_layout Standard
4076 There is a long list of included environments provided by these layouts.
4077 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4078 variety of `theorem' environments.
4079 However, the AMS recommends the environments that are available in LyX.
4083 \begin_layout Standard
4084 The following environments---as well as the standard environments, such
4086 \begin_inset Flex CharStyle:Noun
4089 \begin_layout Plain Layout
4096 \begin_inset Flex CharStyle:Noun
4099 \begin_layout Plain Layout
4106 \begin_inset Flex CharStyle:Noun
4109 \begin_layout Plain Layout
4116 \begin_inset Flex CharStyle:Noun
4119 \begin_layout Plain Layout
4126 \begin_inset Flex CharStyle:Noun
4129 \begin_layout Plain Layout
4136 \begin_inset Flex CharStyle:Code
4139 \begin_layout Plain Layout
4146 \begin_inset Flex CharStyle:Code
4149 \begin_layout Plain Layout
4158 \begin_layout Description
4159 Address This should be the author's permanent address.
4162 \begin_layout Description
4164 \begin_inset space ~
4167 Address This should be the author's temporary address at the time of submission,
4168 if different from the Address.
4171 \begin_layout Description
4172 Email Author's e-mail address
4175 \begin_layout Description
4176 URL Author's Web address, if desired.
4179 \begin_layout Description
4180 Keywords Key words or phrases used to identify specific topics discussed
4184 \begin_layout Description
4185 Subjectclass These refer to the AMS Subject Classifications, published and
4188 Mathematical Reviews
4191 These are also available online at the AMS cites listed above.
4194 \begin_layout Description
4198 \begin_layout Description
4202 \begin_layout Description
4206 \begin_layout Standard
4207 The following environments are provided by both the
4208 \begin_inset Flex CharStyle:Code
4211 \begin_layout Plain Layout
4218 \begin_inset Flex CharStyle:Code
4221 \begin_layout Plain Layout
4227 modules, in the latter case in both starred (unnumbered) and unstarred
4228 (numbered) versions.
4229 These same environments are provided only in the starred versions by the
4231 \begin_inset Flex CharStyle:Code
4234 \begin_layout Plain Layout
4243 \begin_layout Theorem
4244 This is typically used for the statements of major results.
4248 \begin_layout Corollary*
4249 This is used for statements which follow fairly directly from previous statement
4251 Again, these can be major results.
4256 These are smaller results needed to prove other statements.
4259 \begin_layout Proposition
4260 These are less major results which (hopefully) add to the general theory
4264 \begin_layout Conjecture
4265 These are statements provided without justification, which the author does
4266 not know how to prove, but which seem to be true (to the author, at least).
4269 \begin_layout Definition*
4270 Guess what this is for.
4271 The font is different for this environment than for the previous ones.
4275 \begin_layout Example*
4276 Used for examples illustrating proven results.
4279 \begin_layout Problem
4280 It's not really known what this is for.
4281 You should figure it out.
4284 \begin_layout Exercise*
4285 Write a description for this one.
4288 \begin_layout Remark
4289 This environment is also a type of theorem, usually a lesser sort of observation.
4292 \begin_layout Claim*
4293 Often used in the course of giving a proof of a larger result.
4297 Generally, these are used to break up long arguments, using specific instances
4303 The numbering scheme for cases is on its own, not together with other numbered
4309 At the end of this environment , a QED symbol (usually a square, but it
4310 can vary with different styles) is placed.
4311 If you want to have other environments within this one---for example, Case
4312 environments---and have the QED symbol appear only after them, then the
4313 other environments need to be nested within the proof environment.
4315 \begin_inset CommandInset ref
4317 reference "sec:Nesting"
4325 for information on nesting.
4328 \begin_layout Standard
4329 And these are provided by
4330 \begin_inset Flex CharStyle:Code
4333 \begin_layout Plain Layout
4334 Theorems (AMS-Extended)
4342 \begin_layout Criterion*
4343 A required condition.
4346 \begin_layout Algorithm*
4347 A general procedure to be used.
4350 \begin_layout Axiom*
4351 This is a property or statement taken as true within the system being discussed.
4354 \begin_layout Condition*
4355 Sometimes used to state a condition assumed within the present context of
4360 Similar to a Remark.
4363 \begin_layout Notation*
4364 Used for the explanation of, yes, notation.
4367 \begin_layout Summary
4368 Do we really need to tell you?
4371 \begin_layout Acknowledgement*
4375 \begin_layout Conclusion*
4376 Sometimes used at the end of a long train of argument.
4380 Used in a way similar to Proposition, though perhaps lower on the scale.
4383 \begin_layout Standard
4384 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4386 They need to be available on your system in order to use these environments.
4389 \begin_layout Section
4393 \begin_layout Standard
4398 can be used to type letters according to German conventions.
4399 A template file is included in
4401 .../lyx/share/templates
4403 for you to use as a starting point.
4406 \begin_layout Section
4410 \begin_layout Standard
4415 provides an alternative to the standard
4420 It provides similar functionality, but you might prefer this layout with
4421 sans serif sections, headings, and more.
4424 \begin_layout Section
4428 \begin_layout Standard
4434 \begin_layout Subsection
4438 \begin_layout Standard
4439 This section describes how LyX can be used to write articles for submission
4440 to the scientific journal
4442 Astronomy and Astrophysics
4444 (www.edpsciences.fr/aa/
4445 \begin_inset Flex URL
4448 \begin_layout Plain Layout
4450 http://www.edpsciences.fr/aa/
4455 ) using Version 5.01 of the document class
4460 This package can be downloaded from the ftp site
4463 \begin_layout Standard
4464 \begin_inset VSpace medskip
4470 \begin_layout Standard
4472 \begin_inset Flex URL
4475 \begin_layout Plain Layout
4477 ftp://ftp.edpsciences.org/pub/aa/readme.html
4485 \begin_layout Standard
4486 \begin_inset VSpace medskip
4492 \begin_layout Standard
4493 A manual comes together with that package, and this text is not meant to
4494 replace the original manual but merely a short guide how to realize the
4495 correct form of your paper.
4499 \begin_layout Standard
4500 Please note that the publisher of the journal was changed from Springer
4501 to EDP Sciences starting January 1, 2001.
4502 That change implicated also some slight changes of the style files, namely
4503 the removal of the thesaurus command.
4504 The LyX class aa supports the newest version of these style files, V 5.01.
4505 If you have an older version installed, please upgrade.
4506 For compatibility, the old (version 4) layout has been kept as
4511 Please refer to the comments in
4513 LyXDir/layouts/aapaper.layout
4518 \begin_layout Subsection
4522 \begin_layout Standard
4523 It is recommended you start from the example template distributed with LyX.
4524 If you are not using a template, note the following settings:
4527 \begin_layout Itemize
4537 ocument\SpecialChar \menuseparator
4544 dialog (OK, that one was obvious).
4547 \begin_layout Itemize
4548 Don't change the option
4551 \begin_inset space ~
4561 The whole layout is done by the macros, you shouldn't change anything.
4564 \begin_layout Subsection
4568 \begin_layout Standard
4569 First thing to enter is the header information.
4570 It consists of seven entries, of which some are optional.
4574 \begin_layout Itemize
4582 \begin_layout Itemize
4590 \begin_layout Itemize
4598 \begin_layout Itemize
4606 \begin_layout Itemize
4611 : [optional] if more than one author: whom to contact for offprint requests.
4614 \begin_layout Itemize
4619 : [optional] mail address for contacts.
4622 \begin_layout Itemize
4630 Received: <date>; Accepted <date>
4633 \begin_layout Standard
4634 There is no need to issue the
4640 command, this is done automatically by LyX when the header is finished.
4641 Although the order of the single header entries doesn't matter it is advised
4642 to keep the above sequence, just to get the best optics and meets the layout
4643 of the real document.
4646 \begin_layout Standard
4647 If you want to place footnotes in the header block, e.
4648 \begin_inset space \thinspace{}
4652 \begin_inset space ~
4655 to state your present address, just use the standard footnote via
4660 nsert\SpecialChar \menuseparator
4668 LyX will automagically use the term
4677 \begin_layout Standard
4678 In addition to these topics, the macros use three additional LaTeX commands
4679 that have no counterpart in LyX:
4682 \begin_layout Itemize
4689 to separate different names for more than one author and institute, respectivel
4693 \begin_layout Itemize
4700 to mark corresponding author/institute pairs.
4701 The institutes are numbered sequentially as they appear in the
4705 field, so you have to put a marker to each author.
4708 \begin_layout Itemize
4715 to supply an email address for fast contact.
4718 \begin_layout Standard
4719 In all cases, the appropriate command has to be entered in LyX and marked
4725 \begin_layout Subsection
4729 \begin_layout Standard
4730 The abstract should immediately follow the header block.
4731 With version 5 the abstract environment was changed to a command, and there
4732 is now a resctriction to only one paragraph.
4733 In addition, it should contain an entry with the keywords.
4734 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4741 by hand and mark it as LaTeX code.
4742 Refer to the example paper.
4745 \begin_layout Subsection
4746 Supported environments
4749 \begin_layout Standard
4750 The A&A paper layout supports the following environments for structuring
4754 \begin_layout Itemize
4760 \begin_layout Itemize
4766 \begin_layout Itemize
4772 \begin_layout Itemize
4778 \begin_layout Itemize
4784 \begin_layout Itemize
4790 \begin_layout Itemize
4796 \begin_layout Itemize
4802 \begin_layout Itemize
4808 \begin_layout Itemize
4814 \begin_layout Itemize
4820 \begin_layout Itemize
4826 \begin_layout Subsection
4827 Commands not supported by LyX
4830 \begin_layout Standard
4831 Some commands are not yet supported by the
4836 Some have already been mentioned.
4837 For the sake of completeness, they are listed all together here:
4840 \begin_layout Itemize
4848 \begin_layout Itemize
4856 \begin_layout Itemize
4864 \begin_layout Itemize
4872 \begin_layout Itemize
4880 \begin_layout Itemize
4888 \begin_layout Itemize
4896 \begin_layout Itemize
4904 \begin_layout Standard
4905 If you want to use any of these commands, you have to enter them yourself.
4908 Do not forget to mark them as LaTeX code!
4911 \begin_layout Subsection
4912 Figure and Table Floats
4915 \begin_layout Standard
4916 LyX provides support for the necessary float environments
4918 figure, figure*, table
4924 , therefore we won't tell much about it here.
4928 \begin_inset space ~
4934 Just remember that tables should be left-aligned.
4935 For that, select the table and change the alignment in
4940 dit\SpecialChar \menuseparator
4946 \begin_inset space ~
4952 \begin_layout Standard
4953 There is only one special thing: the figures with caption besides the figure.
4954 To create such a figure, you have to do the following:
4957 \begin_layout Enumerate
4958 Create a wide figure float:
4963 nsert\SpecialChar \menuseparator
4968 t\SpecialChar \menuseparator
4971 , then right click in the figure and select
4977 \begin_inset space ~
4985 \begin_layout Enumerate
4986 Enter your caption text.
4989 \begin_layout Enumerate
4994 to move the cursor above the caption.
4997 \begin_layout Enumerate
5001 \begin_layout Enumerate
5002 Position the cursor behind the figure and insert a horizontal fill:
5007 nsert\SpecialChar \menuseparator
5013 \begin_inset space ~
5018 \SpecialChar \menuseparator
5022 \begin_inset space ~
5030 \begin_layout Enumerate
5031 Switch to LaTeX mode:
5034 \begin_inset space ~
5042 \begin_layout Enumerate
5052 Do not close the brace!
5055 \begin_layout Enumerate
5056 Position the cursor behind the caption text, switch to LaTeX mode and insert
5060 \begin_inset space ~
5072 \begin_layout Standard
5073 Also, refer to the figures in the example paper.
5076 \begin_layout Subsection
5080 \begin_layout Standard
5081 For submission, the paper has to be formated in a special double-spacing
5083 For this purpose, you have to give the option
5087 to the documentclass.
5088 This must be done using the extra class options field in the
5093 ocument\SpecialChar \menuseparator
5101 Just enter the string
5108 \begin_layout Subsection
5112 \begin_layout Standard
5117 directory contains an example paper written with LyX.
5118 It is the example paper from the original macro package, translated to
5120 Use it for inspiration, and compare the original LaTeX code with LyX way
5124 \begin_layout Section
5128 \begin_layout Standard
5134 \begin_layout Subsection
5138 \begin_layout Standard
5139 AASTeX is a set of macros produced by the American Astronomical Society
5140 to facilitate electronic manuscript submission to the three journals they
5141 publish: the Astrophysical Journal (including the Letters and Supplement),
5142 the Astronomical Journal, and the Publications of the Astronomical Society
5144 LyX has proven to be an excellent tool for generating these documents,
5145 especially given its equation, citation, and figure handling capabilities.
5146 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5147 is the version described here, or higher.
5148 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5149 incompatible with LyX.
5150 The AASTeX package may be downloaded from the AASTeX Web site
5153 \begin_layout Standard
5154 \begin_inset VSpace medskip
5160 \begin_layout Standard
5162 \begin_inset Flex URL
5165 \begin_layout Plain Layout
5167 http://www.journals.uchicago.edu/AAS/AASTeX
5175 \begin_layout Standard
5176 \begin_inset VSpace medskip
5182 \begin_layout Standard
5183 A complete user guide is contained in that package and you should familiarize
5184 yourself with it thoroughly before embarking on writing a paper in LyX.
5185 LyX will not reduce the need to figure out all the AASTeX commands, it
5186 will only reduce the drudgery of typing everything in.
5187 It is your responsibility to ensure that the final exported LaTeX document
5188 conforms completely to the requirements of the journal to which you are
5189 submitting your paper.
5192 \begin_layout Subsection
5193 Starting a New Paper
5196 \begin_layout Standard
5197 I strongly suggest that you start with the AASTeX template file.
5203 ile\SpecialChar \menuseparator
5213 , enter the new file name, then choose the
5218 This will show the most common fields found in a manuscript.
5219 Simply overwrite the existing text (including the brackets,
5223 ) with the correct information.
5224 Many of the AASTeX commands and environments can be implemented directly
5225 in LyX, but some cannot: most noticeably
5237 , which should stick out like a sore thumb if you actually just opened the
5239 For commands such as these, the LaTeX code must be entered directly and
5241 Such commands are referred to as ERT, or Evil Red Text.
5242 I tried to minimize the amount of ERT needed in an AASTeX document, but
5243 there is still a bit more required than any of us would like.
5246 \begin_layout Subsection
5247 Finishing Your Paper
5250 \begin_layout Standard
5251 When the paper is finished to your satisfaction and previews/prints correctly,
5253 \begin_inset Quotes eld
5257 \begin_inset Quotes erd
5260 actions which need to be done before you submit it to the journals.
5264 \begin_layout Enumerate
5265 Export your paper as a LaTeX file (
5270 ile\SpecialChar \menuseparator
5275 xport\SpecialChar \menuseparator
5286 \begin_layout Enumerate
5291 file with your favorite text editor
5295 \begin_layout Enumerate
5296 remove the comment lines before the
5305 \begin_layout Enumerate
5310 usepackage...{fontenc}
5312 line if it appears (usually just after
5327 \begin_layout Enumerate
5328 remove everything between (and including) the
5340 commands, except for any commands you specifically put into the LaTeX preamble
5341 (which should appear immediately after the
5342 \begin_inset Quotes eld
5345 User specified LaTeX commands
5346 \begin_inset Quotes erd
5357 \begin_layout Enumerate
5358 Run the resulting file through LaTeX to make sure it still processes correctly.
5361 \begin_layout Enumerate
5362 Reread the journal requirements to make sure your filenames and formats
5366 \begin_layout Enumerate
5370 \begin_layout Subsection
5371 Comments On Specific Commands
5374 \begin_layout Standard
5375 I will not describe the detailed usage of the individual AASTeX commands:
5376 the AASTeX User Guide (
5380 ) gives a good description of each.
5381 Thus it's probably easiest for me to go down the list as found in the guide
5382 and offer comments where necessary.
5383 So let's begin \SpecialChar \ldots{}
5387 \begin_layout Subsubsection
5388 Things that work as expected
5391 \begin_layout Standard
5395 \begin_layout Plain Layout
5407 \begin_layout Standard
5408 Because they work as you might expect, I simply list them and the section
5509 begin{thebibliography}
5517 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5518 graphicx figure commands (2.14.1),
5542 (2.15.4, amongst other places),
5569 \begin_layout Standard
5570 The following style options also work correctly:
5591 Simply put them in the
5597 Layout\SpecialChar \menuseparator
5603 \begin_layout Standard
5607 \begin_layout Plain Layout
5619 \begin_layout Subsubsection
5620 Things that work, but require more comment
5623 \begin_layout Standard
5624 The following items work, but require a little more discussion:
5627 \begin_layout Itemize
5628 These items are reserved for use by the journal editors, but you can put
5629 them into the LaTeX preamble if you feel compelled to do so:
5662 \begin_layout Itemize
5663 These items may be placed in the LaTeX preamble, and are included as blanks
5664 in the template file:
5685 \begin_layout Itemize
5692 (2.3) -- can only be used
5693 \begin_inset Quotes eld
5697 \begin_inset Quotes erd
5700 , not in the middle of a paragraph.
5701 Use ERT if you need to embed it.
5704 \begin_layout Itemize
5711 (2.3) -- will have extra {} after it.
5712 This should not cause an error.
5715 \begin_layout Itemize
5722 (2.6) -- can only be used
5723 \begin_inset Quotes eld
5727 \begin_inset Quotes erd
5730 , not in the middle of a paragraph.
5731 Use ERT if you need to embed it.
5734 \begin_layout Itemize
5741 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5745 \begin_layout Itemize
5752 (2.8) -- same as for
5759 \begin_layout Itemize
5766 (2.9) -- will have extra {} after it.
5767 This should not cause an error.
5770 \begin_layout Itemize
5777 (2.11) -- will have extra {} after it.
5778 This should not cause an error.
5781 \begin_layout Itemize
5788 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5789 at the beginning of the text and selecting
5791 Insert\SpecialChar \menuseparator
5796 \begin_inset Quotes eld
5800 \begin_inset Quotes erd
5803 inserts an optional argument of the type needed by
5810 Hopefully it will be renamed someday.
5813 \begin_layout Itemize
5826 for the catalog ID optional parameter
5829 \begin_layout Itemize
5842 for the catalog ID optional parameter
5845 \begin_layout Subsubsection
5846 Things not implemented, use ERT
5849 \begin_layout Standard
5853 \begin_layout Plain Layout
5865 \begin_layout Standard
5888 setcounter{equation}
5890 (2.12), Journal name abbreviations (2.13.4),
5926 (2.15.4, insert it as the first element in the lefthand cell after where
5928 Don't use any of LyX's rules in the table),
5940 (2.15.5), much of Misc (2.17, except
5991 \begin_layout Standard
5995 \begin_layout Plain Layout
6007 \begin_layout Subsubsection
6008 Things that cannot be implemented
6011 \begin_layout Standard
6012 \SpecialChar \ldots{}
6013 at least in any meaningful sort of way, so I suggest ignoring them.
6014 They are the references environment (2.13.3), and the deluxetable environment
6016 If you really, really need to use deluxetable, I suggest editing it in
6017 a separate file with a text editor, then using
6022 nsert\SpecialChar \menuseparator
6028 \begin_inset space ~
6033 to include it in your LyX document.
6038 file to see an example of this.
6041 \begin_layout Subsection
6042 FAQs, Tips, Tricks, and Other Ruminations
6045 \begin_layout Subsubsection
6046 Getting LyX and AASTeX to cooperate
6049 \begin_layout Standard
6050 It can be a bit tricky to get LyX to recognize a new layout and document
6052 When all else fails, do this:
6055 \begin_layout Enumerate
6056 Make certain that LaTeX can find AASTeX.
6057 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6058 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6065 \begin_layout Enumerate
6077 \begin_layout Enumerate
6083 ools\SpecialChar \menuseparator
6090 in LyX, then restart LyX.
6093 \begin_layout Enumerate
6094 Open a regular new file, not from a template.
6095 Does AASTeX appear in the class list in
6100 ocument\SpecialChar \menuseparator
6110 \begin_layout Standard
6111 If you get a warning from an existing AASTeX document about not being able
6112 to find the AASTeX layout or a message about
6113 \begin_inset Quotes eld
6116 You should not mix title layouts with normal ones
6117 \begin_inset Quotes erd
6120 , things haven't been installed correctly.
6123 \begin_layout Subsubsection
6124 LaTeX error processing a table
6127 \begin_layout Standard
6128 LyX, by default, attempts to center the table caption/title.
6129 This seems to produce a bad interaction in AASTeX so you should click somewhere
6130 in the caption/title, then select
6135 dit\SpecialChar \menuseparator
6141 \begin_inset space ~
6158 This took care of it for me.
6161 \begin_layout Subsubsection
6163 \begin_inset CommandInset label
6172 \begin_layout Standard
6173 A couple of things: 1) I have noticed some funny spacing in the reference
6174 entries in the text.
6175 When you enter the bibliography item data, make sure their is
6179 space between the last author and the parenthesis setting off the year;
6183 \begin_inset space \thinspace{}
6187 \begin_inset space ~
6201 2) Entering the references at all is not obvious.
6202 The easiest thing is to start typing your first reference at the end of
6203 the document, then mark it as type
6208 That will put a small gray box in front of what you just typed.
6209 Click on the box to fill in the rest of the information.
6210 For new references, go to the end of an existing reference and press return.
6211 That will create a new line with its own box, etc.
6214 \begin_layout Subsubsection
6218 \begin_layout Standard
6219 Even though AASTeX provides its own figure commands (
6225 , for example), I much prefer LaTeX's standard figure commands (with the
6234 \begin_inset space ~
6237 commands as ERT into a Figure Float box if you desire, but I never have
6238 much luck getting the layout right.
6239 With the standard graphics, LyX will insert a
6243 usepackage{graphicx}
6245 command into the LaTeX preamble and handle the figures in the standard
6246 LaTeX2e way, interspersing the figures in the text.
6247 I believe ApJ accepts figures exactly this way now; AJ might still use
6249 \begin_inset Quotes eld
6252 stack everything at the end
6253 \begin_inset Quotes erd
6259 \begin_layout Subsubsection
6260 Things I could have done, but didn't
6263 \begin_layout Standard
6265 \begin_inset Quotes eld
6269 \begin_inset Quotes erd
6272 things I could have implemented, but chose not to.
6273 For instance, I saw no point in double-spacing the text in the LyX window,
6274 even though it is double-spaced in the paper manuscript.
6275 Also, I chose not to make separate layouts for the preprint and preprint2
6277 Since I assume you will spend most of your time in the plain manuscript
6278 mode anyway, I decided not to chew up more disk space with this.
6282 \begin_layout Subsection
6286 \begin_layout Standard
6287 Your mileage may vary.
6288 I've now had papers published by both ApJ and AJ that have had 98% of the
6289 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6291 I have had no trouble with the submission process, and I'm sure the journals
6292 were never aware that there might be a difference.
6293 So, go forth and publish!
6296 \begin_layout Section
6300 \begin_layout Standard
6303 Panayotis Papasotiriou
6306 \begin_layout Subsection
6310 \begin_layout Standard
6311 The ijmpc package is a set of macros that facilitates electronic manuscript
6314 International Journal of Modern Physics C
6317 Similarly, the ijmpd package is for creating manuscripts to be submitted
6320 International Journal of Modern Physics D
6323 Both journals are published by World Scientific.
6324 The corresponding document classes are named
6333 These files, together with instructions for the authors, can be downloaded
6335 \begin_inset Flex URL
6338 \begin_layout Plain Layout
6340 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6346 \begin_inset Flex URL
6349 \begin_layout Plain Layout
6351 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6357 Both packages are modified versions of the standard
6358 \begin_inset Quotes eld
6362 \begin_inset Quotes erd
6365 package, and they are almost (but not exactly) identical.
6366 Most of their features are supported by LyX.
6367 I have used LyX successfully to write articles submitted to both journals
6368 without any problem.
6371 \begin_layout Subsection
6375 \begin_layout Standard
6376 As usual, the easiest way to write a paper is to start with a template.
6382 ile\SpecialChar \menuseparator
6401 This will give an (almost) empty document that includes the most common
6402 fields found in a manuscript.
6403 Simply overwrite the existing text (including the brackets,
6408 You should keep in mind the following remarks.
6411 \begin_layout Enumerate
6412 LyX won't let you change the font size and the page style of the document,
6413 because such modifications are not allowed by both packages.
6416 \begin_layout Enumerate
6417 The language of the document should not be changed.
6418 Before previewing your paper, be sure that the babel package is not used.
6419 To do this, click on
6424 ools\SpecialChar \menuseparator
6442 checkbox in the language settings, and click on
6453 , if you wish to make this change permanent).
6456 \begin_layout Enumerate
6458 \begin_inset Quotes eld
6462 \begin_inset Quotes erd
6465 style must be used to define keywords.
6468 \begin_layout Enumerate
6469 The ijmpc package provides a style named
6470 \begin_inset Quotes eld
6473 Classification Codes
6474 \begin_inset Quotes erd
6477 , which can be used to define classification codes, such as PACS numbers.
6478 Note that this facility is not supported by the ijmpd package.
6481 \begin_layout Enumerate
6482 Several new environments are available:
6483 \begin_inset Quotes eld
6487 \begin_inset Quotes erd
6491 \begin_inset Quotes eld
6495 \begin_inset Quotes erd
6499 \begin_inset Quotes eld
6503 \begin_inset Quotes erd
6507 \begin_inset Quotes eld
6511 \begin_inset Quotes erd
6515 \begin_inset Quotes eld
6519 \begin_inset Quotes erd
6523 \begin_inset Quotes eld
6527 \begin_inset Quotes erd
6531 \begin_inset Quotes eld
6535 \begin_inset Quotes erd
6539 \begin_inset Quotes eld
6543 \begin_inset Quotes erd
6547 \begin_inset Quotes eld
6551 \begin_inset Quotes erd
6555 \begin_inset Quotes eld
6559 \begin_inset Quotes erd
6563 \begin_inset Quotes eld
6567 \begin_inset Quotes erd
6571 \begin_inset Quotes eld
6575 \begin_inset Quotes erd
6579 \begin_inset Quotes eld
6583 \begin_inset Quotes erd
6587 \begin_inset Quotes eld
6591 \begin_inset Quotes erd
6595 Their use is more or less obvious.
6596 LyX supports all these environments; it will use the proper label, text
6597 style, and numbering scheme for each of them.
6600 \begin_layout Enumerate
6601 Both packages use basic citations; the natbib package should not be used.
6602 In LyX, citation references are shown as usual; in the output, citations
6603 are shown as superscripts.
6604 If you want to use a citation as normal text, you should use the
6609 \begin_inset space \thinspace{}
6613 \begin_inset Quotes eld
6617 \begin_inset space ~
6627 \begin_inset Quotes erd
6633 \begin_layout Enumerate
6635 \begin_inset Quotes eld
6639 \begin_inset Quotes erd
6642 section in both packages.
6643 To put acknowledgments, just use the
6644 \begin_inset Quotes eld
6648 \begin_inset Quotes erd
6654 \begin_layout Enumerate
6655 Appendices may be added to the paper,
6659 the Acknowledgments and
6664 LyX provides a special environment, called
6665 \begin_inset Quotes eld
6669 \begin_inset Quotes erd
6672 which marks the beginning of the appendices.
6673 This environment should be left blank; it just sends a LaTeX command, but
6674 nothing is really printed.
6676 \begin_inset Quotes eld
6680 \begin_inset Quotes erd
6683 is printed with blue letters, as a signal that all sections after that
6684 point are appendices.
6685 To write an appendix, use the
6686 \begin_inset Quotes eld
6690 \begin_inset Quotes erd
6694 LyX will number each appendix with capital letters, as required by both
6697 \begin_inset Quotes eld
6701 \begin_inset Quotes erd
6708 be present before the first appendix; if not, all appendices will be numbered
6709 as normal sections in the output.
6712 \begin_layout Enumerate
6713 The ijmpc and the ijmpd packages use the
6717 command to implement table captions.
6718 As a result, a table created by LyX is printed correctly, but its caption
6720 However, you can use some ERT to overpass this problem, so that captions
6721 are printed as expected.
6722 To do so, create a float table as usual, remove the caption, and replace
6733 (sic); you must also the ERT
6737 immediately after the tabular material.
6738 Study the example table included in the template files to see how this
6739 trick is implemented.
6740 Alternatively, If you need table captions, you should implement the whole
6745 file, then include this file to the LyX document (
6750 nsert\SpecialChar \menuseparator
6755 \SpecialChar \menuseparator
6761 \begin_inset space ~
6767 Details on how to create a table float can be found in the files
6775 , included in the corresponding packages.
6778 \begin_layout Subsection
6779 Preparing a paper for submission
6782 \begin_layout Standard
6783 Before you submit your paper you must export the LyX document as a LaTeX
6789 ile\SpecialChar \menuseparator
6794 xport\SpecialChar \menuseparator
6809 \begin_layout Plain Layout
6810 Actually you have the choice between LaTeX (plain) and pdflatex.
6811 If you intend to use pdflatex to prepare the paper, you should use the
6812 pdflatex option so that included graphics are converted to PDF format,
6813 ready for use by pdflatex.
6818 , then make the following changes to the resulting
6825 \begin_layout Enumerate
6826 Remove the comment lines before the
6835 \begin_layout Enumerate
6836 Remove everything between (and including) the
6848 commands, except for any commands you specifically put into the LaTeX preamble.
6851 \begin_layout Standard
6856 file should be saved and processed through LaTeX as many times as necessary.
6857 You may also want to check the resulting
6864 \begin_layout Subsection
6868 \begin_layout Standard
6869 The use of ERT is reduced to two commands, which must be placed at the top
6871 If you started writing your paper by using the
6879 template, the ERT needed is already in its place; you usually don't need
6881 You may only modify the first ERT to specify the information printed to
6882 the top of odd and even pages (authors' names and short paper's title,
6884 This ERT must have the form
6888 markboth{Authors' Names}{Short Paper's Title}
6893 \begin_layout Section
6897 \begin_layout Standard
6903 \begin_layout Subsection
6907 \begin_layout Standard
6908 The iopart package provides a document class to create electronic manuscript
6909 submission to the journals published by the Institute of Physics.
6910 Instructions for the authors how to create a paper using the iopart class
6911 can be downloaded together with the iopart package from the site
6912 \begin_inset Flex URL
6915 \begin_layout Plain Layout
6917 ftp://ftp.iop.org/pub/journals/latex2e
6925 \begin_layout Subsection
6929 \begin_layout Standard
6930 The easiest way to write a paper is to start with the file
6934 that is available in LyX's examples files folder.
6935 Open this file, save it under a new name, and start writing.
6936 The example file explains how to use the special text environments.
6937 Here are the most important advices:
6940 \begin_layout Itemize
6941 To be able to compile your document to a PDF, PS, or DVI, assure that the
6944 Use AMS math package
6946 in the document settings under
6953 \begin_layout Itemize
6956 The title environment defines the kind of your paper.
6957 So use one of the following environments for the title:
6961 \begin_layout Itemize
6970 \begin_layout Itemize
6979 \begin_layout Itemize
6985 for a Topical review
6988 \begin_layout Itemize
6997 \begin_layout Itemize
7006 \begin_layout Itemize
7012 for a Paper (same as Title)
7015 \begin_layout Itemize
7021 for a Preliminary communication
7024 \begin_layout Itemize
7030 for a Rapid communication
7033 \begin_layout Itemize
7039 for a Letter to the editor
7043 \begin_layout Itemize
7046 All title environments except of
7050 can have an optional short title.
7053 \begin_layout Itemize
7054 There is a general title environment
7058 which is not directly supported by the LyX.
7059 This can be used as ERT when your document doesn't fit into one of the
7063 \begin_layout Standard
7064 For more informations like hints for special table and formula formatting,
7065 look at the IOP author guidelines.
7068 \begin_layout Section
7072 \begin_layout Standard
7075 Panayotis Papasotiriou
7078 \begin_layout Subsection
7082 \begin_layout Standard
7083 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7084 that facilitates electronic manuscript submission to the journals they
7086 Most known of them (at least in my domain of interest) are
7088 Astrophysics and Space Science
7094 , but there are many others (see a complete list at
7095 \begin_inset Flex URL
7098 \begin_layout Plain Layout
7100 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7106 The Kluwer package may be downloaded from the site
7107 \begin_inset Flex URL
7110 \begin_layout Plain Layout
7112 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7118 A complete user guide is contained in that package (but it can also be
7119 downloaded separately).
7122 \begin_layout Standard
7123 LyX supports many features of the package but not everything.
7124 However, the ERT needed is reduced to some
7125 \begin_inset Quotes eld
7129 \begin_inset Quotes erd
7132 commands of the package (see
7133 \begin_inset space ~
7137 \begin_inset CommandInset ref
7139 reference "subsec:kluwer_peculiarities"
7144 I have recently used LyX to write an article submitted to the
7146 Astrophysics and Space Science
7148 without any problem.
7151 \begin_layout Subsection
7155 \begin_layout Standard
7156 The easiest way to write a paper is to start with the Kluwer template file.
7159 File\SpecialChar \menuseparator
7174 This will give an (almost) empty document that includes the most common
7175 fields found in a manuscript and a short description of their use.
7176 As in most templates, simply overwrite the existing text (including the
7181 ) with the correct information.
7184 \begin_layout Subsection
7185 Preparing a paper for submission
7188 \begin_layout Standard
7189 As in the AASTeX package, before you submit your paper to a journal you
7191 \begin_inset Quotes eld
7195 \begin_inset Quotes erd
7201 \begin_layout Enumerate
7202 Export your paper as a LaTeX file.
7203 To do this, click on
7208 ile\SpecialChar \menuseparator
7213 xport\SpecialChar \menuseparator
7224 \begin_layout Enumerate
7229 file with a text editor and make the following changes
7233 \begin_layout Enumerate
7234 remove the comment lines before the
7243 \begin_layout Enumerate
7244 remove everything between (and including) the
7256 commands, except for any commands you specifically put into the LaTeX preamble.
7259 \begin_layout Standard
7268 \begin_layout Enumerate
7273 file through LaTeX as many times as necessary (usually up to three).
7276 \begin_layout Enumerate
7282 \begin_inset space \thinspace{}
7289 , and check if everything is OK (it should, if you didn't make any mistake).
7292 \begin_layout Subsection
7293 \begin_inset Quotes eld
7297 \begin_inset Quotes erd
7300 of the Kluwer package
7301 \begin_inset CommandInset label
7303 name "subsec:kluwer_peculiarities"
7310 \begin_layout Standard
7311 The Kluwer package has the following
7312 \begin_inset Quotes eld
7316 \begin_inset Quotes erd
7322 \begin_layout Enumerate
7323 It is possible to write multiple articles in the same LaTeX file
7327 \begin_layout Plain Layout
7328 I can't imagine any good reason to do this.
7334 Each article must be included in the environment
7335 \begin_inset Quotes eld
7339 \begin_inset Quotes erd
7343 Unfortunately, this environment cannot be omitted, even if you write just
7345 Therefore, each article starts with the command
7351 and, obviously, ends with the command
7358 Although this can be implemented in LyX, I didn't included it, since it
7359 looks ugly and can confuse the novice user.
7360 Therefore, you need to enter them directly and mark them as LaTeX code
7362 \begin_inset Quotes eld
7366 \begin_inset Quotes erd
7372 \begin_layout Enumerate
7373 Information given at the beginning of the article (i.e., title, subtitle,
7374 author, institution, running title, running author, abstract and keywords)
7375 must be included in an environment called
7376 \begin_inset Quotes eld
7380 \begin_inset Quotes erd
7384 This is not implemented in LyX, so you must enter title, subtitle etc.
7385 \begin_inset space ~
7388 between two ERT lines (
7403 \begin_layout Enumerate
7404 According to the user manual, the label of each bibliography item must be
7428 \begin_layout Standard
7433 template takes care of all these
7434 \begin_inset Quotes eld
7438 \begin_inset Quotes erd
7442 If you start a new paper using this template you don't need to do anything
7447 \begin_layout Enumerate
7448 don't delete the ERT included in the template, and
7451 \begin_layout Enumerate
7452 copy the example bibliography item included in the template and modify it
7453 as necessary to enter new bibliography items.
7456 \begin_layout Section
7460 \begin_layout Standard
7466 \begin_layout Subsection
7470 \begin_layout Standard
7471 The LyX document classes
7473 article (koma-script)
7477 report (koma-script)
7495 correspond to the LaTeX document classes
7512 \begin_inset space ~
7515 of the Koma-Script family.
7516 They are replacements for the standard document classes
7532 , resp., and fit better to European typography conventions in a number of
7536 \begin_layout Itemize
7537 Standard character size is 11pt in
7539 article (koma-script)
7543 report (koma-script)
7551 letter (koma-script)
7556 \begin_layout Itemize
7557 Headings, labels of the description environment, and a number of elements
7560 letter (koma-script)
7562 document class are set in a bold sans serif font.
7566 \begin_layout Plain Layout
7567 There is a big difference between the bold sans serif old cm fonts and new
7568 ec fonts, especially in the appearance of headings.
7569 In comparison, the ec bold sans serif fonts look a bit thin.
7570 Here the LaTeX package
7578 helps to produce the
7579 \begin_inset Quotes eld
7583 \begin_inset Quotes erd
7586 appearance when using the ec fonts.
7591 The numbering of chapter headings is made in the same way as the numbering
7592 of section headings, that is without the extra line
7593 \begin_inset Quotes eld
7596 Chapter\SpecialChar \ldots{}
7598 \begin_inset Quotes erd
7602 In addition, the appearance of the headings can be modified by using a
7603 number of options (in LyX to be entered in the field
7610 \begin_inset space ~
7620 ayout\SpecialChar \menuseparator
7628 A detailed German description of these options can be found in the Koma-Script
7636 \begin_layout Itemize
7637 The main means in the Koma-Script document classes to design the type area
7646 (in LyX to be entered in the extra class options field in the dialog
7651 ocument\SpecialChar \menuseparator
7659 They make a clearer modification of page margins possible as do the options
7665 ocument\SpecialChar \menuseparator
7673 A detailed German description of these and other type area options can
7674 be found in the Koma-Script documentation
7681 \begin_layout Itemize
7682 The LaTeX document classes of the Koma-Script family define a number of
7683 additional commands.
7684 Those part of it which makes sense in LyX is implemented in corresponding
7688 \begin_layout Standard
7689 A detailed German description of the LaTeX document classes of the Koma-Script
7690 family can be found in the Koma-Script documentation
7698 \begin_layout Plain Layout
7699 There is an English translation
7703 , but it is not a complete one.
7708 The following sections describe only those aspects, which are relevant
7712 \begin_layout Subsection
7713 article (koma-script), report (koma-script), and book (koma-script)
7716 \begin_layout Standard
7717 The document classes
7719 article (koma-script)
7723 report (koma-script)
7733 are implemented in the layout files
7746 They contain all the paragraph types of the corresponding standard document
7759 , resp., partly modified, with the exception of the LyX specific
7763 -type, which is replaced by the new
7767 -type having the same functionality.
7772 -Type there is a number of new paragraph types added.
7779 letter (koma-script)
7784 \begin_layout Itemize
7793 : are equivalents to
7801 , resp., additionally inserting an entry in the table of contents.
7810 are not contained in
7812 article (koma-script)
7817 \begin_layout Itemize
7834 , resp., additionally clearing running heads.
7841 article (koma-script)
7847 \begin_layout Plain Layout
7860 report (koma-script)
7862 , but since this is identical to
7866 , is has not been implemented in LyX.
7874 \begin_layout Itemize
7879 : generates a heading directly above the following paragraph in the standard
7880 character size without affecting the structure of the document.
7883 \begin_layout Itemize
7892 are special captions which respect the different space settings needed
7893 for captions placed above or below an element (if you follow strict typographic
7894 rules, you might want to place table captions always above the table).
7895 You can also use the class option
7912 You need at least Koma-Script version 2.8q to use this.
7915 \begin_layout Itemize
7920 : can be used to set a bonmot, e.
7921 \begin_inset space \thinspace{}
7925 \begin_inset space ~
7928 at the beginning of a chapter.
7929 If you use the optional argument (
7934 nsert\SpecialChar \menuseparator
7936 \begin_inset space ~
7941 ), you can insert the dictum's author there.
7942 Dictum and author are separated by a line.
7943 You need at least Koma-Script version 2.8q to use this.
7950 article (koma-script)
7955 \begin_layout Standard
7956 The following types, together with the standard types
7968 , form the title area of the document.
7969 They must be entered ahead of the first
7970 \begin_inset Quotes eld
7974 \begin_inset Quotes erd
7981 \begin_layout Plain Layout
7982 The corresponding LaTeX commands must appear before the
7993 When such a type is used more than once, the latter usage overwrites the
7994 former one, that means, for every type only the latest usage is valid.
7995 The order of the different types however has, like
8007 , no effect on the appearance of the produced document.
8010 \begin_layout Itemize
8015 : produces a centered paragraph above the ordinary title (
8027 ) for the subject of the document.
8030 \begin_layout Itemize
8035 : produces a centered paragraph below the ordinary title (
8047 ) for the publishers' name.
8050 \begin_layout Itemize
8057 report (koma-script)
8063 produces a centered paragraph on its own page behind the title page, or
8066 article (koma-script)
8068 produces a centered paragraph below the ordinary title (
8087 \begin_layout Itemize
8092 : produces a left aligned paragraph above the ordinary title (
8108 ) for a document`s head.
8111 \begin_layout Itemize
8116 : produces in a double-sided print in
8118 report (koma-script)
8124 a left-aligned paragraph at the top of the title page`s back or has no
8125 effect in a single-sided print or in
8127 article (koma-script)
8132 \begin_layout Itemize
8137 : produces in a double-sided print in
8139 report (koma-script)
8145 a left-aligned paragraph at the bottom of the title page`s back or has
8146 no effect in a single-sided print or in
8148 article (koma-script)
8153 \begin_layout Itemize
8158 : produces a special
8159 \begin_inset Quotes eld
8163 \begin_inset Quotes erd
8166 page ahead of the actual document containing a paragraph without special
8170 \begin_layout Standard
8171 The layout files for the document classes
8173 article (koma-script)
8177 report (koma-script)
8188 This is thought of as a place to define your own types.
8193 in your personal layout directory and edit the file!
8196 \begin_layout Subsection
8197 letter (koma-script)
8200 \begin_layout Standard
8204 \begin_layout Plain Layout
8216 \begin_layout Standard
8220 letter (koma-script)
8222 is implemented in the layout file
8227 It contains all the paragraph types of the corresponding standard document
8232 , partly modified, with the exception of the LyX specific types
8244 type, which is replaced by the new
8249 In addition, it contains, in contrast to the standard document class, the
8267 Furthermore, there are a number of new letter specific types.
8270 \begin_layout Standard
8274 \begin_layout Plain Layout
8286 \begin_layout Standard
8287 The appearance of the letter produced by this document class can be controlled
8288 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8292 \begin_layout Plain Layout
8293 For example, the standard appearance of the letter`s heading, consisting
8294 of name and address, is quite self-willed.
8296 \begin_inset Quotes eld
8300 \begin_inset Quotes erd
8303 heading is produced by the following LaTeX commands in the preamble:
8306 \begin_layout LyX-Code
8316 \begin_layout LyX-Code
8332 \begin_layout LyX-Code
8342 \begin_layout LyX-Code
8362 A detailed German description of such LaTeX commands can be found in the
8363 Koma-Script documentation
8368 With it, the letter's author can produce his personal letter layout.
8371 \begin_layout Standard
8380 define the beginning of the letter and must be used in every letter.
8381 To emphasize them in the LyX document class, they are marked with the letter
8391 \begin_inset space ~
8395 It is possible to write any number of letters in one file.
8400 type produces a new letter using the same addressee and a
8404 type produces a new addressee.
8421 are ordinary paragraph types and can also be used several times in one
8422 and the same letter.
8425 \begin_layout Itemize
8430 : produces a paragraph for the addressee and implicitly defines the beginning
8434 \begin_layout Itemize
8439 : produces a paragraph for the form of address and implicitly produces a
8443 \begin_layout Itemize
8448 : produces a paragraph for a close.
8451 \begin_layout Itemize
8456 : produces a paragraph for a postscript.
8459 \begin_layout Itemize
8464 : produces a paragraph for a distribution list.
8467 \begin_layout Itemize
8472 : produces a paragraph for enclosures.
8475 \begin_layout Standard
8516 are input types provided with a label to enter information, which will
8517 be processed by the document class.
8521 \begin_layout Plain Layout
8522 It could be seen as a matter of inconsequence, that the types
8530 described above are not such input types as well.
8531 Because of the special meaning of those types, however, I have implemented
8532 them as ordinary paragraph types with a one letter mark in the left margin.
8533 Moreover, it would affect my feeling of symmetry, if the
8541 type had such a serious different appearance.
8546 The types must be used ahead of the corresponding
8553 \begin_layout Standard
8554 An implementation of these types in a WYSIWYG fashion does not seem to make
8555 sense, because the real appearance of the produced letter does not only
8556 depend on the usage of the particular type, but also on other factors.
8557 For example, a signature entered in the
8561 type will in the standard behavior appear in the produced letter only,
8562 when in the same letter also a
8567 The entered value of the
8571 type will in the standard behavior not appear in the produced letter at
8573 The possibility to design the letter`s heading freely is already indicated
8574 in a footnote above.
8577 \begin_layout Standard
8578 The input types can also be used as empty paragraphs.
8580 \begin_inset space \thinspace{}
8584 \begin_inset space ~
8596 type is not used at all, in the standard behavior the value of the
8600 type is used as signature, whereas if an empty
8604 type is used, no signature value is defined.
8607 \begin_layout Standard
8608 By using the input types it is possible to write a letter template, containing
8609 filled input types with your personal dates (name, address, etc.) and empty
8610 input types for other dates you want to enter.
8613 \begin_layout Itemize
8618 : sender's name, in the standard behavior appears as a centered paragraph
8619 in small caps in the letter`s heading.
8622 \begin_layout Itemize
8627 : sender's signature, in the standard behavior appears below the
8636 type is used, the value of the
8640 type appears instead.
8643 \begin_layout Itemize
8648 : sender's address, in the standard behavior appears in a centered paragraph
8649 in the letter`s heading below the sender's name.
8652 \begin_layout Itemize
8657 : sender's telephone number, in the standard behavior only sets the LaTeX
8667 \begin_layout Itemize
8672 : place of the letter`s making.
8675 \begin_layout Itemize
8680 : date of the letter`s making.
8689 , in the standard behavior, produce the place and the date in a right-aligned
8690 line below the addressee's field.
8695 type is used, neither place nor date appear, independent of the value of
8705 type is used, the date of the letter `s production is used.
8708 \begin_layout Itemize
8713 : sender`s back address, in the standard behavior appears above the addressee's
8714 field in a small sans serif font.
8717 \begin_layout Itemize
8722 : special mail information, in the standard behavior appears underlined
8723 above the addressee's field below the back address.
8726 \begin_layout Itemize
8731 : additional information, in the standard behavior appears on right side
8732 below the addressee`s field.
8735 \begin_layout Itemize
8740 : the letter's title, in the standard behavior appears in a big, bold, sans
8741 serif font above the subject.
8744 \begin_layout Itemize
8749 : the letter's subject, in the standard behavior appears in a bold font
8757 \begin_layout Standard
8778 produce a business letter like line above the
8782 line containing the fields
8783 \begin_inset Quotes eld
8787 \begin_inset Quotes erd
8791 \begin_inset Quotes eld
8795 \begin_inset Quotes erd
8799 \begin_inset Quotes eld
8803 \begin_inset Quotes erd
8807 \begin_inset Quotes eld
8811 \begin_inset Quotes erd
8815 \begin_inset Quotes eld
8819 \begin_inset Quotes erd
8823 \begin_inset Quotes eld
8827 \begin_inset Quotes erd
8831 For the date field, the value of the
8837 \begin_inset Quotes eld
8840 business letter types
8841 \begin_inset Quotes erd
8844 is used, the value of the
8848 type however does not appear, but only the LaTeX variable
8855 The ordinary output of place and date in a right-aligned line below the
8856 addressee`s field is suppressed.
8857 The types are implemented as input types provided with a label and must
8858 be used ahead of the corresponding
8865 \begin_layout Itemize
8873 \begin_layout Itemize
8881 \begin_layout Itemize
8889 \begin_layout Itemize
8897 \begin_layout Itemize
8905 \begin_layout Subsection
8906 The new letter class: letter (koma-script v.2)
8909 \begin_layout Standard
8912 Jürgen Spitzmüller
8915 \begin_layout Standard
8916 \begin_inset VSpace medskip
8922 \begin_layout Standard
8924 Koma-Script version 2.8 has introduced a new letter class
8928 which supersedes the now unsupported
8933 It has --- on the LaTeX side --- a completely new interface and is not
8934 compatible with the old class.
8935 Therefore, LyX supports both, though it is recommended to use the new class.
8938 \begin_layout Standard
8939 This class covers the same functionality as
8941 letter (koma-script),
8948 (receiver's address, same as
8965 will start a new letter (i.
8966 \begin_inset space \thinspace{}
8970 \begin_inset space ~
8973 you can write several letters per document).
8974 New elements are sender's
8990 and the possibility to use a
8999 nsert\SpecialChar \menuseparator
9009 \begin_layout Standard
9010 The biggest improvement is, though, that the letter's layout is configurable
9011 at almost any needs.
9012 This can be done via the preamble or with a special style file (Letter
9013 Class Option, extension
9017 ), that will be read in as a class option.
9021 \begin_layout Plain Layout
9022 The KOMA package comes with some default
9027 There is, for instance, a
9031 file that follows german typesetting rules, or a
9035 that provides the default layout of the old
9040 The latter can be loaded with the class option
9049 ayout\SpecialChar \menuseparator
9054 ocument\SpecialChar \menuseparator
9066 template that is included in LyX for examples.
9067 A detailed description is to be found in the Koma-Script documentation
9075 \begin_layout Subsection
9079 \begin_layout Standard
9080 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9084 \begin_layout Itemize
9085 The chapter number of a
9089 type appears on a line of its own above the chapter heading instead of
9090 appearing in the same line ahead of it.
9091 The cause for that is the LyX internal behavior for the labeltype
9098 \begin_layout Itemize
9099 The headings of the types
9108 \begin_inset Quotes eld
9112 \begin_inset Quotes erd
9115 LaTeX table of contents, but not in the LyX table of contents (
9120 ocument\SpecialChar \menuseparator
9126 \begin_inset space ~
9130 \begin_inset space ~
9138 \begin_layout Itemize
9143 document class appear in a skip separation mode, not indented.
9144 This is the standard behavior, no special LaTeX commands are needed for
9151 ocument\SpecialChar \menuseparator
9158 dialog the corresponding radio button indicates
9174 value always has the effect that extra LaTeX commands are inserted in the
9175 document to produce the gap, which is not what is wanted in this case.
9178 \begin_layout Section
9186 \begin_layout Standard
9192 \begin_layout Subsection
9196 \begin_layout Standard
9197 These are the layout files for some of the journal formats used by Springer
9198 Verlag and listed on
9199 \begin_inset Flex URL
9202 \begin_layout Plain Layout
9204 http://www.springer.de/author/tex/help-journals.html
9209 , where you should also go to fetch the class files (yes, these are LaTeX2e
9211 It is a modular system: the things common to all journals are implemented
9216 , which journal-specific layout files (such as, e.
9217 \begin_inset space \thinspace{}
9224 for Journal of Geodesy) can include.
9227 \begin_layout Standard
9228 This means that implementing support for any other Springer journal on this
9229 list is as simple as writing your own
9237 file following the outline given in
9245 \begin_layout Standard
9246 It is reasonably well tested only for the Journal of Geodesy.
9255 come with the standard LyX distribution.
9256 Install the relevant class file (downloaded from Springer) in a proper
9257 directory, reconfigure LaTeX (in the teTeX case by running
9261 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9262 LyX and it should work.
9265 \begin_layout Subsection
9269 \begin_layout Standard
9270 A large number of theorem-like styles ---
9276 \SpecialChar \ldots{}
9282 \begin_layout Standard
9285 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9286 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9289 See the Springer class file documentation for details.
9292 \begin_layout Subsection
9296 \begin_layout Itemize
9308 \begin_layout Itemize
9311 Probability Theory and Related Fields
9317 --- Jean-Marc Lasgouttes
9320 \begin_layout Standard
9321 Add your own, it isn't so hard!
9324 \begin_layout Subsection
9328 \begin_layout Standard
9329 These files are partly based on the older
9333 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9339 layout, are now defunct.
9340 Jean-Marc Lasgouttes helped out big in making me find my way around the
9341 LyX layout file mechanism.
9344 \begin_layout Subsection
9348 \begin_layout Standard
9350 But probably less than in the old hacked-LaTeX
9357 \begin_layout Standard
9359 \begin_inset space \thinspace{}
9362 g.: does not display the number for theorem-like layouts, just #.
9365 \begin_layout Section
9373 \begin_layout Standard
9379 \begin_layout Subsection
9383 \begin_layout Standard
9384 These are the layout files for some of the journals of the American Geophysical
9386 It is assumed that you have both the AGU's own class files and AGUplus
9387 installed (everything to be found at
9388 \begin_inset Flex URL
9391 \begin_layout Plain Layout
9393 ftp://ftp.agu.org/journals/latex/journals
9401 \begin_layout Subsection
9405 \begin_layout Standard
9415 They are still called this in the LyX GUI, though their LaTeX equivalents
9416 in the AGU classes are
9427 \begin_layout Standard
9428 Newly defined styles are
9465 These are mostly manuscript attributes and defined in the AGU class documentati
9469 \begin_layout Standard
9470 I suspect this is still badly incomplete.
9473 \begin_layout Subsection
9477 \begin_layout Standard
9494 \begin_layout Subsection
9498 \begin_layout Itemize
9501 Journal of Geophysical Research
9510 \begin_layout Standard
9511 Add your own, it isn't so hard! Look at the
9522 \begin_layout Subsection
9523 Bugs and things to remember
9526 \begin_layout Standard
9527 In order to use the new layouts, you must remember to do the following for
9531 \begin_layout Enumerate
9537 This can be done in the
9539 layout\SpecialChar \menuseparator
9544 document\SpecialChar \menuseparator
9548 (AGU articles are always in English, right? So
9555 \begin_layout Enumerate
9565 (Yes, this is a bug.)
9568 \begin_layout Enumerate
9569 Make sure you use the
9573 bibliography style, by entering
9577 into the second field of the BibTeX inset.
9578 None of the standard styles will do.
9581 \begin_layout Section
9589 \begin_layout Standard
9595 \begin_layout Subsection
9599 \begin_layout Standard
9600 This is the layout file for the European Geophysical Society journals.
9605 can be downloaded from the web site of the EGS under
9606 \begin_inset Flex URL
9609 \begin_layout Plain Layout
9619 \begin_layout Subsection
9623 \begin_layout Standard
9626 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9634 The current layout file is unfortunately very unmodular and would benefit
9635 from using the various
9642 \begin_layout Section
9648 \begin_inset CommandInset label
9657 \begin_layout Standard
9665 \begin_layout Subsection
9669 \begin_layout Standard
9670 This section describes how to use LyX to make slides for overhead projectors.
9671 There are two document classes that can do this: the default slides class
9677 This section documents the former.
9680 \begin_layout Standard
9681 I'm going to say this again, nice and clear, so that there's no misunderstanding
9685 \begin_layout Standard
9686 \begin_inset VSpace bigskip
9692 \begin_layout Standard
9696 This section documents the class
9697 \begin_inset Quotes eld
9705 \begin_inset Quotes erd
9713 \begin_layout Standard
9714 \begin_inset VSpace bigskip
9720 \begin_layout Standard
9721 If you're looking for the documentation for
9722 \begin_inset Quotes eld
9730 \begin_inset Quotes erd
9734 \begin_inset space ~
9738 \begin_inset CommandInset ref
9740 reference "sec:foiltex"
9750 \begin_inset Quotes eld
9758 \begin_inset Quotes erd
9761 ] is actually somewhat better than the default
9769 \begin_layout Plain Layout
9770 \SpecialChar \ldots{}
9771 or so I've been told repeatedly by its advocates.
9772 Having never used it, I have no idea if this claim is true or not.
9777 which this section documents.
9780 \begin_layout Standard
9781 This class is the LaTeX2e improvement of the old
9786 Every LaTeX2e distribution includes this class [which I'll just refer to
9788 \begin_inset Quotes eld
9796 \begin_inset Quotes erd
9799 from now on], so you're bound to have it.
9800 As I noted earlier, there are other classes, such as
9804 , which also produce slides for overhead projectors and do a better job
9806 However, there are some things which
9810 can do which the others can't, such as generate overlays.
9811 Read on to learn more!
9814 \begin_layout Subsection
9816 \begin_inset CommandInset label
9818 name "sec:slidesetup"
9825 \begin_layout Standard
9826 Obviously, to use this document class, you need to select
9827 \begin_inset Quotes eld
9835 \begin_inset Quotes erd
9838 from the class list in the
9843 ocument\SpecialChar \menuseparator
9851 There are some other special things you should know about this class:
9854 \begin_layout Itemize
9855 Don't bother changing the options
9860 They're not supported by the
9867 \begin_layout Itemize
9874 \begin_inset space ~
9879 behaves a bit differently for this class.
9880 The possible choices and what they do are as follows:
9884 \begin_layout Description
9889 The final output contains page numbers in the lower right corner.
9892 \begin_layout Description
9901 , but also prints out any time markers you've put in.
9902 This is the default.
9905 \begin_layout Description
9910 The final output contains no page numbers, time markers, or alignment markers.
9914 \begin_layout Itemize
9919 class has an extra option:
9925 \begin_inset Quotes eld
9933 \begin_inset Quotes erd
9936 in the extra class options.
9940 \begin_layout Standard
9941 Using this options allows you to add time markers to
9947 \begin_inset space ~
9951 \begin_inset CommandInset ref
9953 reference "sec:slideNote"
9961 \begin_layout Standard
9962 You can also use the template file
9963 \begin_inset Quotes eld
9971 \begin_inset Quotes erd
9974 to automatically set up a document to use the
9983 ile\SpecialChar \menuseparator
9985 \begin_inset space ~
9989 \begin_inset space ~
9998 to open your new document].
9999 The template file also contains some examples of the special paragraph
10000 environments used by this class.
10001 I'll describe those next.
10004 \begin_layout Subsection
10005 Paragraph Environments
10008 \begin_layout Subsubsection
10009 Supported Environments
10012 \begin_layout Standard
10013 The first thing you'll notice when you start up a new
10017 document is the font size and type: it's the equivalent of the size
10018 \begin_inset Quotes eld
10026 \begin_inset Quotes erd
10032 \begin_inset space ~
10038 This is also what's used in the output.
10040 \begin_inset Quotes eld
10044 \begin_inset Quotes erd
10047 to remind you that this is a slide.
10048 Your final slides will use a larger font; ergo, you'll have less space.
10049 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10052 \begin_layout Standard
10053 The next thing that becomes obvious is the changes to the paragraph environment
10054 pull-down box [at the far-left end of the toolbar].
10055 Most of the paragraph environments you're used to seeing are missing.
10056 There are also five new ones.
10061 class itself only supports certain paragraph environments:
10064 \begin_layout Itemize
10070 \begin_layout Itemize
10076 \begin_layout Itemize
10082 \begin_layout Itemize
10088 \begin_layout Itemize
10094 \begin_layout Itemize
10100 \begin_layout Itemize
10106 \begin_layout Itemize
10112 \begin_layout Itemize
10118 \begin_layout Itemize
10124 \begin_layout Itemize
10130 \begin_layout Standard
10131 All of the other standard environments, including the section-heading environmen
10132 ts, aren't used in the
10139 \begin_layout Standard
10140 On the other hand, you'll notice the following new environments:
10143 \begin_layout Itemize
10149 \begin_layout Itemize
10155 \begin_layout Itemize
10161 \begin_layout Itemize
10167 \begin_layout Itemize
10173 \begin_layout Standard
10174 These five are kind of quirky, due to a
10175 \begin_inset Quotes eld
10179 \begin_inset Quotes erd
10183 You see, LyX doesn't permit you to nest any other paragraph environment
10184 into an empty environment.
10185 Now, that's fine and dandy, but it means that you wouldn't be able to start
10186 a slide with anything except plain text.
10187 To deal with this, I've performed a little
10188 \begin_inset Quotes eld
10192 \begin_inset Quotes erd
10198 \begin_layout Subsubsection
10199 Quirks of the New Environments
10200 \begin_inset CommandInset label
10202 name "sec:slideQuirk"
10209 \begin_layout Standard
10210 All five of the new paragraph environments are somewhat quirky due to inherent
10211 limitiations in the current version of LyX.
10212 As I just mentioned, LyX forbids environments that begin with another environme
10214 To get around this, the
10218 environment isn't a paragraph environment as described in the
10226 \begin_layout Standard
10227 You should consider
10240 \begin_inset Quotes eld
10243 pseudo-environments.
10244 \begin_inset Quotes erd
10247 They look like a section heading or a
10248 \begin_inset Quotes eld
10256 \begin_inset Quotes erd
10259 but really begin a [and, if necessary, end the previous] paragraph environment.
10269 \begin_inset Quotes eld
10273 \begin_inset Quotes erd
10276 These two perform some action.
10279 \begin_layout Standard
10280 A common feature of all five environments,
10300 , is a rather long-ish label.
10301 The text following this label --- ordinarily the contents of the paragraph
10302 environment --- is utterly irrelevant for
10323 LyX completely ignores it.
10324 In fact, you can leave these five environments completely empty.
10328 \begin_layout Standard
10333 to put any text after the rather long-ish label, you might want to.
10334 This could be a short description of the contents of the
10339 In that case, enter in your descriptive comment and hit
10343 as you normally would.
10346 \begin_layout Standard
10347 If, on the other hand, you don't want to enter in any descriptive text,
10348 you'll hit another LyX quirk.
10349 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10350 environment until you put something in the old one.
10354 \begin_layout Itemize
10355 Start entering the text that will
10383 \begin_layout Itemize
10384 Now move to the beginning of that paragraph.
10388 \begin_layout Itemize
10397 \begin_layout Itemize
10398 Finally, change this new, empty paragraph to a
10422 \begin_layout Standard
10423 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10427 \begin_layout Subsection
10428 Making a Presentation with
10441 \begin_layout Subsubsection
10449 \begin_layout Standard
10450 If you're expecting this section to teach you how to actually make a presentatio
10451 n, you'll be sorely disappointed.
10452 Naturally, I'll describe all of the ways the
10456 class can assist you in preparing the materials for a presentation.
10457 Filling in the contents, however, is up to you.
10462 the LyX philosophy.]
10465 \begin_layout Standard
10470 environment [in the manner described in section
10471 \begin_inset space ~
10475 \begin_inset CommandInset ref
10477 reference "sec:slideQuirk"
10481 ] tells LyX to begin a new slide [duh].
10482 The label for this environment/
10483 \begin_inset Quotes erd
10487 \begin_inset Quotes erd
10491 \begin_inset Quotes eld
10495 \begin_inset Quotes erd
10498 in cool blue, followed by the label,
10499 \begin_inset Quotes eld
10503 \begin_inset Quotes erd
10507 Any text or paragraph environments that follow this one go on the new slide.
10511 \begin_layout Standard
10512 Slides are probably the only time you'll need to forcibly end pages in LyX
10513 (this can be specified in the
10518 In fact, you'll want to, once you finish entering the contents of one slide.
10519 If you've entered more text than can physically fit on a slide, the extra
10520 overflows onto a new slide.
10521 I don't recommend doing this, however, since the overflow slide won't have
10522 any page number on it.
10523 Furthermore, it may interfere with any
10527 you've made to accompany the oversized
10534 \begin_layout Standard
10543 environments work the same way as the
10548 They both create an
10549 \begin_inset Quotes eld
10553 \begin_inset Quotes erd
10556 followed by a label [
10557 \begin_inset Quotes eld
10561 \begin_inset Quotes erd
10565 \begin_inset Quotes eld
10569 \begin_inset Quotes erd
10573 The color is a stunning magenta instead of blue, and the
10574 \begin_inset Quotes eld
10578 \begin_inset Quotes erd
10581 will look different, in style and in length.
10582 The label fonts of all three also differ from one another.
10585 \begin_layout Standard
10590 , if the contents of a
10598 exceed the physical size of a slide or sheet of paper, the extra will overflow
10600 Again, you should avoid this.
10601 It defeats the whole purpose of
10612 \begin_layout Subsubsection
10622 \begin_layout Standard
10627 is a slide that sits atop another slide.
10628 Perhaps you wish to discuss a figure on the main
10632 before displaying the text associated with it.
10633 One way to accomplish this is tape a flap of dark paper over the part of
10638 you want to display later.
10639 This method fails, however, if you wish to overlap one graph with another,
10641 You would then have to fumble while speaking to align the two separate,
10646 s to align the two graphs.
10651 environment in both cases makes life much easier.
10654 \begin_layout Standard
10659 receives the page number of its
10660 \begin_inset Quotes eld
10664 \begin_inset Quotes erd
10672 \begin_inset Quotes eld
10680 \begin_inset Quotes erd
10687 \begin_layout Plain Layout
10688 Presumably, mutliple
10693 \begin_inset Quotes eld
10701 \begin_inset Quotes erd
10705 \begin_inset Quotes eld
10713 \begin_inset Quotes erd
10717 \begin_inset Quotes eld
10725 \begin_inset Quotes erd
10729 \begin_inset space ~
10732 appended to the page number of the parent
10742 Clearly, you want the contents of both the
10750 to each fit on a single physical slide! You should probably consider an
10756 \begin_inset Quotes eld
10760 \begin_inset Quotes erd
10772 class provides a visual cue for this: the label at the start of an
10776 is shorter than that at the start of a
10781 Lastly, when you generate printable output, you'll find alignment markers
10782 in all four corners of both the
10786 page and its parent
10791 These will assist you in lining up the two physical slides.
10794 \begin_layout Standard
10795 The major problem in overlaying two slides is aligning the contents of the
10796 two transparencies.
10797 How much space should you leave for that graph on the second slide? Worse
10798 still, what if you want a graph and a sentence on second slide, but there
10799 is text on the main transparency that goes in between them? You could try
10800 and insert vertical space of the right size.
10801 The better way is to use
10812 \begin_layout Standard
10813 As their names imply,
10821 are two command-like paragraph environments that make all subsequent text
10822 invisible and visible, respectively.
10824 \begin_inset space ~
10828 \begin_inset CommandInset ref
10830 reference "sec:slideQuirk"
10834 that you don't place anything
10838 these two environments, however.
10843 , it inserts a centered, sky-blue label into the page reading
10844 \begin_inset Quotes eld
10847 <Invisible Text Follows>
10848 \begin_inset Quotes erd
10852 For paragraphs following this label, the parts of the
10860 ; it doesn't matter which] where they would be contain instead blank space.
10864 \begin_layout Standard
10869 , the corresponding centered label is
10870 \begin_inset Quotes eld
10873 <Visible Text Follows>
10874 \begin_inset Quotes erd
10878 Paragraphs following this label behave normally.
10879 Note that the beginning of a new
10891 automatically shuts off an
10896 It's therefore not necessary to use
10907 \begin_layout Standard
10908 By now, it should be obvious how to create overlay transparencies using
10909 the proper combination of
10928 \begin_layout Enumerate
10933 , including everything that will appear on it, whether on the main slide
10941 \begin_layout Enumerate
10942 Before each figure or paragraph that will appear only on the
10951 If necessary, insert a
10955 environment after the
10962 \begin_layout Enumerate
10967 immediately following the
10974 \begin_layout Enumerate
10975 Copy the contents of this
10986 \begin_layout Enumerate
10991 , change all of the
11002 \begin_layout Standard
11004 You've just made an
11011 \begin_layout Standard
11012 There's one problem with the way I've designed the LyX
11016 class: you can't make text in the middle of a paragraph invisible, nor
11017 make text in the middle of an invisible paragraph visible again.
11018 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11022 \begin_layout Plain Layout
11023 The commands of interest are:
11026 \begin_layout Itemize
11031 invisible \SpecialChar \ldots{}
11035 \begin_layout Itemize
11040 visible \SpecialChar \ldots{}
11044 \begin_layout Plain Layout
11045 \SpecialChar \ldots{}
11046 and need to be marked as TeX.
11048 \begin_inset Quotes eld
11052 \begin_inset Quotes erd
11055 you wish to change goes in between the brackets [and after the
11068 If you don't know how to mark text as TeX, see the appropriate section
11081 \begin_layout Subsubsection
11091 \begin_inset CommandInset label
11093 name "sec:slideNote"
11100 \begin_layout Standard
11109 is associated with a
11110 \begin_inset Quotes eld
11114 \begin_inset Quotes erd
11126 class provides visual cues.
11131 is shorter than that of a
11135 [yet longer than that of an
11139 ] and, like the label of an
11143 is shockingly magenta.
11144 Additionally, the printed
11148 has the page number of its
11149 \begin_inset Quotes eld
11153 \begin_inset Quotes erd
11161 \begin_inset Quotes eld
11169 \begin_inset Quotes erd
11173 \begin_inset Quotes eld
11181 \begin_inset Quotes erd
11185 \begin_inset Quotes eld
11193 \begin_inset Quotes erd
11197 You can have multiple
11201 s associated with a single
11213 , you'll probably want to break up long
11217 s so that they fit on a single sheet of paper.
11220 \begin_layout Standard
11225 is obvious: it contains anything additional you might want to say about
11231 It could also be used as a sheet of reminders for a particular
11236 In the case of the latter, you might want to make use of time markers.
11242 \begin_inset Quotes eld
11246 \begin_inset Quotes erd
11249 support for time markers, a
11254 So, you'll have to resort to using the LaTeX codes.
11257 \begin_layout Standard
11258 To use time markers, you'll need to specify the extra class option
11259 \begin_inset Quotes eld
11267 \begin_inset Quotes erd
11271 \begin_inset space ~
11275 \begin_inset CommandInset ref
11277 reference "sec:slidesetup"
11282 This option turns on timing marks, which will appear in the lower-left-hand
11288 To set what appears in the time marker, you use the LaTeX commands
11289 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11303 \begin_inset Quotes eld
11313 \begin_inset Quotes erd
11317 The arguments of both commands are time measured in seconds.
11319 \begin_inset Quotes eld
11329 \begin_inset Quotes erd
11332 sets the time marker to a given time.
11334 \begin_inset Quotes eld
11344 \begin_inset Quotes erd
11347 increments the time marker by the specified amount.
11348 Using time markers and
11352 s in this fashion, you can remind yourself how much time to spend on a particula
11360 \begin_layout Standard
11361 There's one last feature to describe.
11362 Clearly, you'd like to print out all of your
11370 s on transparencies while printing all of your
11387 with which it is associated.
11388 What's a person to do?
11391 \begin_layout Standard
11392 Luckily, there are two LaTeX commands that allow you to select what to print
11394 Both must be placed into the preamble of your document.
11396 \begin_inset Quotes eld
11408 \begin_inset Quotes erd
11411 will cause the output to contain only the
11420 Correspondingly, the command
11421 \begin_inset Quotes eld
11433 \begin_inset Quotes erd
11436 prevents the output of anything but
11441 I'd advise placing both commands in the preamble and initially comment
11443 You can then preview your entire presentation as you write.
11444 When you're done writing, you can then uncomment one of the two to select
11445 what you want to print.
11446 I like to uncomment
11447 \begin_inset Quotes eld
11459 \begin_inset Quotes erd
11462 , print to a file with
11463 \begin_inset Quotes eld
11471 \begin_inset Quotes erd
11474 in its name, comment it back out, then uncomment
11475 \begin_inset Quotes eld
11487 \begin_inset Quotes erd
11491 \begin_inset Quotes eld
11499 \begin_inset Quotes erd
11503 I can then send either file to a printer, loading transparencies or plain
11504 paper as appropriate.
11507 \begin_layout Standard
11508 You can also provide other arguments to the
11509 \begin_inset Quotes eld
11519 \begin_inset Quotes erd
11523 \begin_inset Quotes eld
11533 \begin_inset Quotes erd
11537 See a good LaTeX book for details.
11540 \begin_layout Subsection
11545 Class Template File
11548 \begin_layout Standard
11549 I have also provided a template file,
11550 \begin_inset Quotes eld
11558 \begin_inset Quotes erd
11566 To use it, begin your new presentation with
11571 ile\SpecialChar \menuseparator
11573 \begin_inset space ~
11577 \begin_inset space ~
11587 Your new LyX presentation file will contain an example
11608 additionally contain an example of the use of
11617 Lastly, the preamble will contain:
11620 \begin_layout LyX-Code
11621 % Uncomment to print out only slides and overlays
11624 \begin_layout LyX-Code
11628 \begin_layout LyX-Code
11634 \begin_inset Newline newline
11640 \begin_layout LyX-Code
11641 % Uncomment to print out only notes
11644 \begin_layout LyX-Code
11648 \begin_layout LyX-Code
11656 \begin_layout Standard
11657 One final thing: I created this class to support the LaTeX2e
11658 \begin_inset Quotes eld
11666 \begin_inset Quotes erd
11669 class, one of the built-in LaTeX2e classes.
11670 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11671 built-in slide class.
11672 It's here if you want it or need it.
11673 There exist other LaTeX2e classes for creating presentations, such as the
11679 \begin_inset space ~
11683 \begin_inset CommandInset ref
11685 reference "sec:foiltex"
11690 \begin_inset Quotes eld
11698 \begin_inset Quotes erd
11701 package [present on some TeX distributions].
11702 The latter is not yet supported under LyX.
11706 \begin_layout Plain Layout
11707 Perhaps you can take on the task\SpecialChar \ldots{}
11713 I know nothing about these other classes.
11714 Try them out to see what sort of alternative they provide.
11717 \begin_layout Section
11726 \begin_inset CommandInset label
11735 \begin_layout Standard
11741 \begin_layout Subsection
11745 \begin_layout Standard
11746 This section describes how to use LyX to make slides for overhead projectors.
11747 There are two document classes that can do this: the default slides class
11753 This section documents the latter.
11756 \begin_layout Standard
11757 I'm going to say this again, nice and clear, so that there's no misunderstanding
11761 \begin_layout Standard
11762 \begin_inset VSpace bigskip
11768 \begin_layout Standard
11772 This section documents the class
11773 \begin_inset Quotes eld
11781 \begin_inset Quotes erd
11789 \begin_layout Standard
11790 \begin_inset VSpace bigskip
11796 \begin_layout Standard
11797 If you're looking for the documentation for
11798 \begin_inset Quotes eld
11806 \begin_inset Quotes erd
11809 , check out section
11810 \begin_inset space ~
11814 \begin_inset CommandInset ref
11816 reference "sec:slitex"
11821 If your machine doesn't have the
11826 \begin_inset Quotes eld
11834 \begin_inset Quotes erd
11837 ] installed, you'll probably have to use the default
11841 class, which isn't quite as good as
11846 \begin_layout Standard
11851 class is designed for use with version 2.1 of the
11855 LaTeX class file which is now an integral part of LaTeX2e.
11858 \begin_layout Subsection
11862 \begin_layout Standard
11863 Obviously, to use this document class, you need to select
11864 \begin_inset Quotes eld
11872 \begin_inset Quotes erd
11885 \begin_inset space ~
11891 There are some settings in the
11894 \begin_inset space ~
11899 dialog that you should know about that are specific to this class:
11902 \begin_layout Itemize
11903 Don't change the options
11914 \begin_inset space ~
11920 They're ignored by the
11927 \begin_layout Itemize
11928 The default font size is 20pt with the other options being 17pt, 25pt and
11932 \begin_layout Itemize
11933 The default font is
11941 but all math equations are still typeset in the usual roman font.
11944 \begin_layout Itemize
11949 TeX supports A4 and Letter paper sizes as well as a special size for working
11951 It doesn't support A5, B5, legal or executive paper sizes.
11954 \begin_layout Itemize
11955 Don't bother changing the
11959 settings because they are ignored anyway.
11960 All floats appear where they are defined in the text.
11963 \begin_layout Itemize
11971 setting behaves a bit differently for this class.
11976 TeX provides extensive footer and header capabilities including a user-defined
11979 \begin_inset space ~
11983 \begin_inset CommandInset ref
11985 reference "sec:foilfoot"
11990 The title page is treated differently to all other pages in the document
11999 has the logo centered at the bottom of the page (if one is defined).
12000 The possible page style choices and what they do are as follows:
12004 \begin_layout Labeling
12005 \labelwidthstring MMMMMMM
12012 The final output contains no page numbers, or other headers or footers
12013 (except footnotes of course).
12017 \begin_layout Labeling
12018 \labelwidthstring MMMMMMM
12025 The final output contains page numbers centered at the bottom of the page.
12026 No other headings or footers (other than footnotes).
12029 \begin_layout Labeling
12030 \labelwidthstring MMMMMMM
12035 Page numbers in lower right corner.
12036 Additional headers and footers are also shown.
12037 This is also the default.
12040 \begin_layout Labeling
12041 \labelwidthstring MMMMMMM
12046 Gives you access to the
12050 package although its use with
12054 TeX is discouraged by the writer of the
12058 TeX package because of some potential page layout clashes.
12062 \begin_layout Subsubsection
12066 \begin_layout Standard
12067 The following options may be used in the extra class options in the
12072 ocument\SpecialChar \menuseparator
12082 \begin_layout Labeling
12083 \labelwidthstring MMMMMMx
12088 This sets up the page layout for 7.33in by 11in paper, which is about the
12089 same aspect ratio as a 35mm slide, making it a bit easier to work with
12093 \begin_layout Labeling
12094 \labelwidthstring MMMMMMx
12099 Places a rule across the page below the header on every page except the
12103 \begin_layout Labeling
12104 \labelwidthstring MMMMMMx
12109 Places a rule across the page above the footer on every page except the
12113 \begin_layout Labeling
12114 \labelwidthstring MMMMMMx
12119 This is automatically set each time you create a new
12128 TeX to use the dvips driver to rotate those pages that are set as landscape
12132 \begin_layout Labeling
12133 \labelwidthstring MMMMMMx
12138 Simply changes the page dimensions to those of a landscape page but doesn't
12140 Thus if you use this option you need to use an external program to rotate
12141 each page or feed your paper through your printer as landscape.
12142 Note that this option effectively reverses the roles of the
12150 environments (don't worry these are described in the next section).
12153 \begin_layout Labeling
12154 \labelwidthstring MMMMMMx
12159 Equation numbers on the left.
12162 \begin_layout Labeling
12163 \labelwidthstring MMMMMMx
12168 Flush-left equations.
12171 \begin_layout Subsection
12172 Supported Environments
12175 \begin_layout Standard
12176 Most of the environments commonly supported in other classes are also supported
12182 There are several additional environments provided by
12186 TeX as well as a couple added by LyX.
12187 The following environments are shared with other classes:
12190 \begin_layout Standard
12194 \begin_layout Plain Layout
12198 begin{multicols}{2}
12206 \begin_layout Itemize
12212 \begin_layout Itemize
12218 \begin_layout Itemize
12224 \begin_layout Itemize
12230 \begin_layout Itemize
12236 \begin_layout Itemize
12242 \begin_layout Itemize
12248 \begin_layout Itemize
12254 \begin_layout Itemize
12260 \begin_layout Itemize
12266 \begin_layout Itemize
12272 \begin_layout Itemize
12278 \begin_layout Itemize
12284 \begin_layout Itemize
12290 \begin_layout Itemize
12296 \begin_layout Itemize
12302 \begin_layout Itemize
12308 \begin_layout Itemize
12314 \begin_layout Standard
12318 \begin_layout Plain Layout
12330 \begin_layout Standard
12331 That is, all the major environments apart from the sectioning environments.
12332 Since foils are essentially self-contained sections, with a title and body,
12337 TeX provides specific commands for starting new foils and these are:
12340 \begin_layout Itemize
12346 \begin_layout Itemize
12352 \begin_layout Standard
12353 LyX also provides slightly modified versions of these two environments called:
12356 \begin_layout Itemize
12362 \begin_layout Itemize
12365 ShortRotatefoilhead
12368 \begin_layout Standard
12369 and the differences will be explained in the next section.
12372 \begin_layout Standard
12373 Since foils are often used in presenting ideas or new theorems and such
12378 TeX also provides a comprehensive box of goodies for presenting them:
12381 \begin_layout Standard
12385 \begin_layout Plain Layout
12389 begin{multicols}{2}
12397 \begin_layout Itemize
12403 \begin_layout Itemize
12409 \begin_layout Itemize
12415 \begin_layout Itemize
12421 \begin_layout Itemize
12427 \begin_layout Itemize
12433 \begin_layout Itemize
12439 \begin_layout Itemize
12445 \begin_layout Itemize
12451 \begin_layout Itemize
12457 \begin_layout Itemize
12463 \begin_layout Standard
12467 \begin_layout Plain Layout
12479 \begin_layout Standard
12480 The starred versions are unnumbered while the unstarred versions are numbered.
12481 There are also two list environments added by LyX and these are:
12484 \begin_layout Itemize
12490 \begin_layout Itemize
12496 \begin_layout Standard
12501 TeX provides some powerful header and footer capabilities that are best
12502 set in the preamble although they may be set at any point in a document.
12503 If you want to change these settings in your document the best place to
12504 do so is at the very top of a foil,
12509 straight after the foilhead.
12512 \begin_layout Standard
12513 For this purpose, the following command styles are provided [
12520 \begin_layout Standard
12524 \begin_layout Plain Layout
12528 begin{multicols}{2}
12536 \begin_layout Itemize
12540 \begin_inset space ~
12546 \begin_layout Itemize
12552 \begin_layout Itemize
12556 \begin_inset space ~
12562 \begin_layout Itemize
12566 \begin_inset space ~
12572 \begin_layout Itemize
12576 \begin_inset space ~
12583 \begin_layout Standard
12584 \begin_inset space ~
12591 \begin_layout Standard
12595 \begin_layout Plain Layout
12607 \begin_layout Standard
12608 There are also a few commands provided by
12612 TeX that aren't directly supported by LyX but I'll tell you what they do
12613 and how to use them in section
12614 \begin_inset space ~
12618 \begin_inset CommandInset ref
12620 reference "sec:unsuppfoils"
12627 \begin_layout Subsection
12628 Building a Set of Foils
12631 \begin_layout Standard
12632 This section will give a simple introduction to using the different environments
12633 to build a set of foils.
12634 If you want to see an example set of foils take a look at the
12638 file accessible from the
12643 ile\SpecialChar \menuseparator
12648 pen\SpecialChar \ldots{}
12659 \begin_layout Subsubsection
12660 Give It a Title Page
12663 \begin_layout Standard
12664 Unlike other classes that provide
12684 creates the title on a page of its own.
12685 If you leave out the
12689 environment LaTeX will substitute the current date (every time you regenerate
12693 \begin_layout Subsubsection
12697 \begin_layout Standard
12698 As I mentioned earlier, there are four ways of starting a new foil.
12699 For portrait foils you should use
12708 The difference between these two environments is the amount of space between
12709 the title of the foil (the foilhead) and the body of the foil.
12712 \begin_layout Standard
12713 Landscape foils are generated using the
12719 ShortRotatefoilhead
12722 Again the only difference is the spacing between foilhead and body.
12723 Both of the short versions have 0.5 inches less separation between the foilhead
12728 \begin_layout Standard
12729 One problem with the support for landscape foils is the requirement that
12730 you have to use the
12734 driver to generate the PostScript output otherwise the foils won't be rotated.
12735 It is possible to get landscape foils even if you haven't got the
12739 driver provided you can feed your foils sideways through your printer ;-)
12742 \begin_layout Subsubsection
12743 Theorems, Lemmas, Proofs and more
12746 \begin_layout Standard
12747 Due to a small bug in LyX you can't have two of the same type of these environme
12748 nts directly following each other.
12749 They must be separated by something.
12750 If you try, you will just be extending the previous environment as if you
12751 had merged the two environments together.
12752 So, how do you get around this problem? The simplest option is to insert
12753 some text between the two environments or add a
12757 environment between the two with just a
12758 \begin_inset Quotes eld
12766 \begin_inset Quotes erd
12770 This will force LyX to produce two separate environments and hence the
12771 correct LaTeX output.
12772 An example is provided in the example file included with the LyX distribution.
12773 Remember, this problem only occurs if you are trying to place two of the
12774 same type of theorem-like environments one directly after the other.
12777 \begin_layout Subsubsection
12781 \begin_layout Standard
12782 You get all the commonly supported list styles found in other classes as
12783 well as two new ones.
12784 I'll only describe the new ones here.
12785 If you want to find out more about the other list environments check out
12791 If you intend to use itemized lists you might also want to read about the
12795 \begin_inset space ~
12799 \begin_inset space ~
12804 dialog described above in section
12805 \begin_inset space ~
12809 \begin_inset CommandInset ref
12811 reference "sec:bullet"
12818 \begin_layout Standard
12819 The two new list styles,
12827 , are designed to make it easier for you to create lists of do's and don'ts
12828 or right and wrong by providing dedicated environments that use a tick
12829 or a cross as the label of the list.
12830 These lists are in fact dedicated variants of the
12835 They do however require that you have the
12839 packages installed.
12842 \begin_layout Subsubsection
12846 \begin_layout Standard
12851 TeX redefines the floating tables and figures so that they appear exactly
12852 where they are in the text rather than pushing them to the top of the page
12853 or to some user specified location.
12854 In fact if you change the float placement settings they are simply ignored.
12857 \begin_layout Subsubsection
12858 Page Headers and Footers
12859 \begin_inset CommandInset label
12861 name "sec:foilfoot"
12868 \begin_layout Standard
12872 \begin_inset space ~
12881 are two commands used to control the left-footer text string.
12882 The first is meant to allow you to include a graphic logo on your foils
12884 \begin_inset Quotes eld
12892 \begin_inset Quotes erd
12896 While the second is meant to provide a classification for the audience,
12900 \begin_inset space \thinspace{}
12906 \begin_inset space ~
12910 It is empty by default.
12913 \begin_layout Standard
12914 The remaining page corners can be filled by
12917 \begin_inset space ~
12922 (which defaults to page numbers),
12925 \begin_inset space ~
12933 \begin_inset space ~
12941 \begin_layout Subsection
12947 \begin_inset CommandInset label
12949 name "sec:unsuppfoils"
12956 \begin_layout Standard
12957 All the commands mentioned below need to be set in a
12965 within another environment.
12968 \begin_layout Subsubsection
12972 \begin_layout Standard
12973 All lengths are adjusted using the
12996 should be replaced by the name given to the length you want to change and
13001 is the length value.
13002 All lengths should be specified in units of length such as inches (
13014 ) or relative to some document or font-based length such as
13024 \begin_layout Standard
13025 It's possible to change the spacing between a foilhead and the body of the
13026 foil by adjusting the length specified by
13033 For example, to make
13037 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13044 foilheadskip}{-0.5in}
13047 \begin_layout Standard
13048 The spacings around floats can be adjusted by setting these lengths:
13051 \begin_layout Labeling
13052 \labelwidthstring MMMMMMMMMMM
13059 Separation between the text and the top of the float
13062 \begin_layout Labeling
13063 \labelwidthstring MMMMMMMMMMM
13070 Separation between the float and the caption
13073 \begin_layout Labeling
13074 \labelwidthstring MMMMMMMMMMM
13081 Separation between the caption and the following text
13084 \begin_layout Labeling
13085 \labelwidthstring MMMMMMMMMMM
13092 You can make the captions narrower than the surrounding text by adjusting
13094 Best done relative to
13103 \begin_layout Standard
13104 There are also several title page related lengths that you may find useful
13105 if you have a long title or several authors:
13108 \begin_layout Labeling
13109 \labelwidthstring MMMMMMMMMMM
13116 Separation from headers to
13121 \begin_layout Labeling
13122 \labelwidthstring MMMMMMMMMMM
13140 \begin_layout Labeling
13141 \labelwidthstring MMMMMMMMMMM
13155 \begin_layout Labeling
13156 \labelwidthstring MMMMMMMMMMM
13172 \begin_layout Labeling
13173 \labelwidthstring MMMMMMMMMMM
13189 \begin_layout Standard
13190 The last length related command affects all the list environments.
13201 a list environment then all the vertical spacing between the list items
13203 Note that this is a command not a length so it doesn't require
13209 like the stuff mentioned above.
13212 \begin_layout Subsubsection
13213 Headers and Footers
13216 \begin_layout Standard
13229 commands control whether the logo in the
13233 definition appear on a given page.
13240 in the preamble then none of the foils will have the logo on them.
13241 If you don't want the logo on a particular page place the
13247 directly after the foilhead of that page and the
13253 directly after the next foilhead.
13256 \begin_layout Standard
13257 If you decide to use the
13261 page style setting in the
13264 \begin_inset space ~
13269 dialog you should probably add
13279 to your preamble so headers and footers on landscape pages are correctly
13280 placed when rotated.
13281 This is due to some clashes between the page layouts provided by the
13292 \begin_layout Section
13293 Latex8 (IEEE Conference Papers)
13296 \begin_layout Standard
13302 \begin_layout Subsection
13306 \begin_layout Standard
13307 Since this class is specifically for writing submissions to IEEE sponsored
13308 conferences I strongly recommend that you get a copy of their Authors Kit.
13313 package and associated bibliography style file is included in the kit.
13314 The Authors Kit is usually sent out by email once your initial submission
13316 There is a lot of useful information in the Authors Kit explaining formatting
13317 restrictions and so on and I will assume you have read this since that
13318 means I don't have to repeat it all here.
13321 \begin_layout Subsection
13325 \begin_layout Standard
13326 [AR\SpecialChar \@.
13330 \begin_layout Subsection
13331 Supported Environments
13334 \begin_layout Itemize
13340 \begin_layout Itemize
13346 \begin_layout Itemize
13352 \begin_layout Itemize
13358 \begin_layout Itemize
13364 \begin_layout Itemize
13370 \begin_layout Itemize
13376 \begin_layout Itemize
13382 \begin_layout Itemize
13388 \begin_layout Subsection
13389 Differences Between Screen and Paper
13392 \begin_layout Standard
13393 There are slight differences in appearance mainly with the presentation
13394 of section counters.
13395 On screen the trailing period of the section counter is missing but it
13396 will appear in the output so don't let this worry you.
13399 \begin_layout Section
13400 Hollywood (Hollywood spec scripts)
13403 \begin_layout Standard
13409 \begin_layout Subsection
13413 \begin_layout Standard
13414 Getting the format of a Hollywood script right is a
13415 \begin_inset Quotes eld
13419 \begin_inset Quotes erd
13422 It is designed to make the readers focus on content and to be easy and
13423 familiar for the actors to read.
13424 Each page of a script should be one minute of film.
13425 Nothing goes in a script that you cannot see or hear on screen.
13426 The courier 12 pt font should be used throughout.
13430 \begin_layout Subsection
13434 \begin_layout Standard
13435 Speakers' lines should NEVER break in mid-sentence.
13436 If a speaker's lines continue over a page break, repeat the
13440 title followed by (Cont'd).
13443 \begin_layout Subsection
13447 \begin_layout Standard
13452 names as labels then cross-reference the label to insert the name.
13453 The cross-reference dialog will show the current cast of characters.
13454 You can use this to insert the speaker name in narratives also.
13457 \begin_layout Subsection
13458 Paper size and Margins
13461 \begin_layout Standard
13462 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13465 \begin_layout Subsection
13469 \begin_layout Standard
13470 The following environments are available.
13471 You can use hollywood.bind to get the bind keys shown at the right.
13474 \begin_layout Itemize
13478 \begin_inset Newline newline
13483 Used where nothing else works.
13487 \begin_layout Itemize
13493 \begin_inset space \hfill{}
13501 \begin_inset Newline newline
13504 Usually followed by something like
13505 \begin_inset Quotes eld
13508 on Sally waking up.
13509 \begin_inset Quotes erd
13515 \begin_layout Itemize
13519 \begin_inset space \hfill{}
13523 \begin_inset Newline newline
13528 Introduces a new INTERIOR camera set-up.
13529 Always followed by DAY or NIGHT, or something similar to define the lighting
13531 Everthing on this line in CAPS.
13534 \begin_layout Itemize
13538 \begin_inset space \hfill{}
13542 \begin_inset Newline newline
13547 Introduces a new EXTERIOR camera set-up.
13548 Everthing on this line in CAPS.
13551 \begin_layout Itemize
13555 \begin_inset space \hfill{}
13559 \begin_inset Newline newline
13564 The character speaking.
13567 \begin_layout Itemize
13571 \begin_inset space \hfill{}
13575 \begin_inset Newline newline
13580 Instructions to the speaker.
13581 The () are automatically inserted, but only the ( will show in LyX.
13582 Both will be printed.
13585 \begin_layout Itemize
13589 \begin_inset space \hfill{}
13593 \begin_inset Newline newline
13605 \begin_layout Itemize
13609 \begin_inset space \hfill{}
13613 \begin_inset Newline newline
13618 Camera movement instruction.
13620 \begin_inset space \thinspace{}
13624 \begin_inset space ~
13630 \begin_layout Itemize
13634 \begin_inset space \hfill{}
13640 \begin_layout Itemize
13644 \begin_inset space \hfill{}
13650 \begin_layout Itemize
13654 \begin_inset space \hfill{}
13660 \begin_layout Itemize
13664 \begin_inset space \hfill{}
13670 \begin_layout Subsection
13674 \begin_layout Itemize
13675 (O.S) --- off screen
13678 \begin_layout Itemize
13679 (V.0) --- voice over
13682 \begin_layout Itemize
13687 \begin_layout Itemize
13692 \begin_layout Itemize
13693 PAN --- camera movement
13696 \begin_layout Itemize
13697 INSERT --- cut to close-up of
13700 \begin_layout Section
13704 \begin_layout Standard
13710 \begin_layout Subsection
13714 \begin_layout Standard
13715 Broadway is for writing plays.
13716 The format is more decorative than Hollywood, and much less standardized.
13717 This format should be suitable for workshops.
13720 \begin_layout Subsection
13724 \begin_layout Standard
13725 The same as in Hollywood.
13728 \begin_layout Subsection
13732 \begin_layout Standard
13737 names as labels then cross-reference the label to insert the name.
13738 The cross-reference dialog will show the current cast of characters.
13741 \begin_layout Subsection
13742 Paper size and Margins
13745 \begin_layout Standard
13746 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13749 \begin_layout Subsection
13753 \begin_layout Standard
13754 The following environments are available.
13755 You can use broadway.bind to get the bind keys shown at the right.
13758 \begin_layout Itemize
13762 \begin_inset Newline newline
13767 You should not have to use this, but it is here for anything that does not
13771 \begin_layout Itemize
13775 \begin_inset space \hfill{}
13779 \begin_inset Newline newline
13784 Used to describe stage setting and the action.
13785 First use of speaker names in all CAPs.
13788 \begin_layout Itemize
13792 \begin_inset space \hfill{}
13796 \begin_inset Newline newline
13801 Automatically numbered.
13802 On screen it will be arabic, but will print as Roman.
13805 \begin_layout Itemize
13809 \begin_inset space \hfill{}
13813 \begin_inset Newline newline
13823 It is just centered text.
13826 \begin_layout Itemize
13830 \begin_inset space \hfill{}
13834 \begin_inset Newline newline
13839 Not automatically numbered.
13840 You supply the number.
13841 This is because I couldn't figure out how.
13844 \begin_layout Itemize
13848 \begin_inset space \hfill{}
13852 \begin_inset Newline newline
13857 A special case of Narrative to describe the setting and action as the curtain
13861 \begin_layout Itemize
13865 \begin_inset space \hfill{}
13869 \begin_inset Newline newline
13874 The speaker's (actor's) title, centered in all CAPS.
13877 \begin_layout Itemize
13881 \begin_inset space \hfill{}
13885 \begin_inset Newline newline
13890 Instructions to the speaker.
13891 The parentheses are automatically inserted.
13892 The ( will appear on screen, but both will be in the printed play.
13893 This environment is only used within
13900 \begin_layout Itemize
13904 \begin_inset space \hfill{}
13908 \begin_inset Newline newline
13913 What the Speaker says.
13916 \begin_layout Itemize
13920 \begin_inset space \hfill{}
13924 \begin_inset Newline newline
13929 The curtain comes down.
13932 \begin_layout Itemize
13936 \begin_inset space \hfill{}
13942 \begin_layout Itemize
13946 \begin_inset space \hfill{}
13952 \begin_layout Itemize
13956 \begin_inset space \hfill{}
13962 \begin_layout Standard
13966 \begin_layout Section
13970 \begin_layout Standard
13976 \begin_layout Standard
13977 \begin_inset VSpace bigskip
13983 \begin_layout Standard
13988 \begin_inset space ~
13993 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13994 \begin_inset Formula $\beta$
13997 release of May, 1999) class.
14000 \begin_layout Standard
14005 textclass, which works with RevTeX 3.1.
14006 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14007 That means that it doesn't interact very well with LyX, which requires
14008 LaTeX2e, although it has been kludged to work.
14009 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14013 \begin_inset space ~
14018 textclass should also be pretty easy to use.
14021 \begin_layout Standard
14022 These documents are supposed to be used in
14026 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14027 macros, and assume you'll know what to put in the preamble if necessary.
14030 \begin_layout Subsection
14034 \begin_layout Standard
14035 All you need to do is install RevTeX 4, as described in the package's README
14037 The package can be found at The RevTeX 4 Web Site
14038 \begin_inset Flex URL
14041 \begin_layout Plain Layout
14043 http://publish.aps.org/revtex4/
14049 Install it somewhere that LaTeX can see it.
14050 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14051 (i.e., not the directory where you installed the class file.) Then, if you
14052 reconfigure LyX, it will find the class file and let you use the RevTeX4
14056 \begin_layout Standard
14057 Probably the easiest way to get started is either to import a RevTeX 4 document
14065 \begin_inset space ~
14070 template, found in the templates directory.
14073 \begin_layout Subsection
14077 \begin_layout Standard
14078 Optional arguments to
14085 \begin_inset Quotes eld
14089 \begin_inset Quotes erd
14093 \begin_inset Quotes eld
14097 \begin_inset Quotes erd
14107 \begin_inset space ~
14115 \begin_inset space ~
14121 Remember that in RevTeX, at least one optional argument is required!
14124 \begin_layout Standard
14125 Other preamble matter, like
14132 \begin_inset space ~
14142 \begin_inset space ~
14147 dialog, also as usual.
14150 \begin_layout Subsection
14154 \begin_layout Standard
14155 The layouts basically correspond to the commands in RevTeX4.0.
14156 For example, the Email layout corresponds to
14163 Note that (at least as of RevTeX 4.0 Beta), the
14171 layouts are exactly equivalent, so you shouldn't need to use both.
14175 \begin_layout Plain Layout
14176 In case you're curious, both were included so that
14180 would be able to translate both
14200 \begin_layout Subsection
14204 \begin_layout Standard
14205 There are a couple of important unique aspects of RevTeX 4 which might cause
14206 bugs that will be even more confusing in LyX.
14209 \begin_layout Standard
14227 The LyX equivalent is that there is a separate Thanks layout.
14232 write footnotes in the
14236 layout, or weird things may happen.
14237 See the RevTeX 4 documentation for more details.
14240 \begin_layout Standard
14244 \begin_inset space ~
14252 \begin_inset space ~
14261 layouts must be placed
14269 layout and the corresponding
14286 , the LaTeX won't compile.
14289 \begin_layout Subsection
14293 \begin_layout Standard
14294 The main problem with this layout is that you can't use the optional arguments
14295 to layouts like Email and Title.
14296 (The problem is not unique to this layout; you can't use optional arguments
14297 to the Section layouts either.) This means that after you export that file
14298 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14299 need to edit the LaTeX file with a text editor to add the optional arguments
14301 \begin_inset space \thinspace{}
14304 g., the running title for the page headers.
14305 Lacking these layouts makes the
14311 (and the equivalent
14317 ) useless, so the corresponding layouts don't exist, and will have to be
14322 \begin_layout Plain Layout
14327 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14328 has not been updated yet to take advantage of it.
14336 \begin_layout Section
14337 Article (mwart), book (mwbk) and report (mwrep)
14338 \begin_inset OptArg
14341 \begin_layout Plain Layout
14354 \begin_layout Standard
14360 \begin_layout Standard
14361 The LyX document classes
14377 correspond to the LaTeX document classes
14390 They are replacements for the standard document classes
14402 , resp., and fit better to Polish typography conventions in a number of points.
14406 \begin_layout Standard
14410 \begin_layout Itemize
14411 Unnumbered titles (with star, eg.
14416 ) are added into table of contents,
14419 \begin_layout Itemize
14420 Additional page styles:
14424 \begin_layout Description
14425 uheadings header with separated lines,
14428 \begin_layout Description
14429 myheadings custom header, contents headers via commands:
14444 \begin_layout Description
14445 myuheadings custom header with separated lines,
14448 \begin_layout Description
14449 outer page number is placed on outer side of page
14453 \begin_layout Itemize
14458 \begin_layout Description
14459 rmheadings serif titles --- default,
14462 \begin_layout Description
14463 sfheadings sansserif titles,
14466 \begin_layout Description
14467 authortitle on title page first placed is author next title --- default,
14470 \begin_layout Description
14471 titleauthor on title page first placed is title next author,
14474 \begin_layout Description
14475 withmarginpar reserve place on page for margins.
14479 \begin_layout Section
14483 \begin_layout Standard
14489 \begin_layout Standard
14490 Elsevier Science Publishers B.V.
14491 provides a standard LaTeX document class (
14495 ) for submitting articles to their various journals.
14496 The style file can be downloaded directly from their web site:
14497 \begin_inset Flex URL
14500 \begin_layout Plain Layout
14502 http://authors.elsevier.com/
14508 Instructions are supplied along with the class file, which details the
14509 requirements of the publishers.
14510 LyX includes package that allows for the use of this class, by a layout
14511 and a template file.
14512 Installation of the class file is the same as for any other LaTeX package;
14513 instructions are provided in the Elsevier documentation.
14516 \begin_layout Standard
14526 As the Elsevier class file is based mainly on the standard article class,
14527 most of the normal functionality is provided.
14528 The Elsevier class defines a number of mathematical environments, which
14529 are similar to the AMS environments.
14530 These commands are all described in the Elsevier documentation, and are
14534 \begin_layout Standard
14535 The easiest way to use the Elsevier style is to base documents on the included
14537 It is best not to use options such as fancy headings or the geometry package,
14538 as elements such as these are defined by Elsevier in their style file.
14539 Ideally, no extra packages except those mentioned in the Elsevier documentation
14541 Essentially, Elsevier require as
14542 \begin_inset Quotes eld
14546 \begin_inset Quotes erd
14549 a LaTeX file as possible, as their intention is to take the supplied file
14550 and replace the class file with one for the particular journal to which
14551 the paper has been submitted.
14552 This also means that not too much time should be spent on the formating
14554 When it comes to be published, this will change anyway.
14555 The rest of the usage for this layout is substantially the same as for
14556 the normal article class.
14557 For details of what Elsevier do and don't allow, refer to their documentation.
14560 \begin_layout Section
14564 \begin_layout Standard
14567 Jürgen Spitzmüller
14570 \begin_layout Subsection
14574 \begin_layout Standard
14575 Memoir is a very powerful and constantly evolving class.
14576 It has been designed with regard to fictional and non-fictional literature.
14577 Its aim is to let the user have maximum control over the typesetting of
14579 Memoir is based on the standard book class, but it can also emulate the
14580 article class (see below).
14583 \begin_layout Standard
14584 Peter Wilson, the developer of Memoir, is known as the author of lots of
14585 useful packages in the LaTeX world.
14586 Most of them have been merged with Memoir.
14587 Therefore, it is much easier to layout the table of contents, appendices,
14588 chapter designs and such.
14589 LyX, though, does not support all of these goodies natively.
14590 Some of them might be added to forthcoming releases
14594 \begin_layout Plain Layout
14595 You are invited to send suggestions to
14596 \begin_inset Flex URL
14599 \begin_layout Plain Layout
14601 lyx-devel@lists.lyx.org
14611 , lots will probably never, due to the limitations of LyX's framework.
14612 Of course you can still use all features with the help of some native LaTeX
14617 \begin_layout Plain Layout
14622 \begin_layout Plain Layout
14632 \begin_inset space ~
14636 \begin_inset CommandInset ref
14638 reference "sec:Inserting-LaTeX-Code"
14648 In this section, we can only list those features which are natively supported
14650 For detailed descriptions (and for the rest of features) we are recommending
14651 to have a look at the detailed manual of the Memoir class
14655 \begin_layout Plain Layout
14660 \begin_layout Plain Layout
14670 \begin_inset Flex URL
14673 \begin_layout Plain Layout
14675 CTAN:/macros/latex/memoir/memman.pdf
14685 , which is not only a user guide for the class, but also both a comprehensive
14686 description on good typesetting and a superb example for good typesetting
14690 \begin_layout Subsection
14691 Basic features and restrictions
14694 \begin_layout Standard
14695 Memoir supports basically all features of the standard book classes.
14696 There are, however, some differences, as follows:
14699 \begin_layout Description
14701 \begin_inset space ~
14704 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14707 \begin_layout Description
14709 \begin_inset space ~
14712 style: The fancy page style is not supported, due to a command clash between
14713 Memoir and the fancyhdr package (they are both defining a command with
14714 the same name, which confuses LaTeX).
14715 Instead, Memoir comes with a bunch of own page styles (see
14717 Layout\SpecialChar \menuseparator
14718 Document\SpecialChar \menuseparator
14720 \begin_inset space ~
14726 If you want to use these for the chapter pages, you have to use the command
14733 in the main text or in preamble (e.
14734 \begin_inset space \thinspace{}
14738 \begin_inset space ~
14745 chapterstyle{companion}
14750 \begin_layout Description
14751 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14752 an optional argument in the standard classes.
14753 With this, you can specify an alternative version of the title for the
14754 table of contents and the headers (for instance, if the title is too long).
14755 In LyX, you can do this via
14757 Insert\SpecialChar \menuseparator
14759 \begin_inset space ~
14764 at the beginning of a chapter/section.
14765 Memoir features a second optional argument and thus separates the table
14766 of contents from the header.
14767 You can define three variants of a title with this: one for the main text,
14768 one for the table of contents, and one for the headers.
14769 Simply insert two optional arguments if you need this feature, the first
14770 one containing the short title for the Table of Contents, the second one
14771 containing an alternative short title for the headers.
14774 \begin_layout Description
14775 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14776 of contents, the list of figures and the list of table start a new page
14778 Memoir does not follow this route.
14779 You have to insert a page break yourself, if you want to have one.
14782 \begin_layout Description
14783 Titlepage: For some unknown reason, Memoir uses pagination on the title
14784 page (in the standard classes, title pages are
14785 \begin_inset Quotes eld
14789 \begin_inset Quotes erd
14793 \begin_inset space \thinspace{}
14797 \begin_inset space ~
14801 If you want an empty title page, type
14805 aliaspagestyle{title}{empty}
14810 \begin_layout Description
14811 Article: With the class option
14817 Layout\SpecialChar \menuseparator
14818 Document\SpecialChar \menuseparator
14820 \begin_inset space ~
14825 ), you can emulate article style.
14826 That is, counters (footnotes, figures, tables etc.) will not be reset on
14827 new chapters, chapters don't start a new page (but are---in contrary to
14829 \begin_inset Quotes eld
14833 \begin_inset Quotes erd
14836 article classes---still allowed), parts, though, use their own page, as
14840 \begin_layout Description
14841 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14842 font commands, which have been used in the old LaTeX version 2.09 (e.
14843 \begin_inset space \thinspace{}
14847 \begin_inset space ~
14863 It produces an error and stops LaTeX whenever such a command appears.
14868 reallows the commands and spits out warnings instead (which does at least
14870 Since a lot of packages and particularly BibTeX style files are still using
14871 those commands, we have decided to use this option by default.
14874 \begin_layout Subsection
14878 \begin_layout Standard
14879 We will only describe the features supported by LyX (which is not much currently
14881 Please consult the Memoir manual
14885 \begin_layout Plain Layout
14890 \begin_layout Plain Layout
14900 \begin_inset Flex URL
14903 \begin_layout Plain Layout
14905 CTAN:/macros/latex/memoir/memman.pdf
14918 \begin_layout Description
14919 Abstract: You may wonder why an abstract is an extra feature.
14920 Well, it is in book class.
14921 Usually books don't have abstracts.
14922 Memoir, however, has.
14923 You can use it wherever and how often you like.
14926 \begin_layout Description
14927 Chapterprecis: You may know this from belletristic: The contents of a chapter
14928 is shortly described below the title and also in the table of contents
14930 \begin_inset space \thinspace{}
14934 \begin_inset space ~
14939 Our hero arrives in Troia; he loses some friends; he finds others
14942 Chapterprecis does exactly this.
14943 It is therefore only sensible below a chapter.
14946 \begin_layout Description
14947 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14948 The epigraph environment provides an elegant way of typesetting such a
14950 The motto itself (text) and its author (source) are divided by a short
14952 Unfortunately, we have to fool LyX a bit here again, since the environment
14953 needs two arguments (text and source).
14954 In this case, we have to use curly brackets (in TeX mode) between the two
14965 <author of the slogan>.
14968 \begin_layout Description
14969 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14970 complex figurative poems).
14971 LyX can only support a few of them.
14972 One is poemtitle, which is a centered title for poems, which will also
14973 be added to the table of contents (verse is the standard environment for
14975 Memoir has some enhanced versions of verse, but you need to use ERT, because
14976 they have to be nested inside regular verse environments, which is not
14977 possible with LyX).
14980 \begin_layout Description
14981 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14984 \begin_layout Chapter
14985 LyX Features needing Extra Software
14988 \begin_layout Section
14992 \begin_layout Standard
14998 \begin_layout Subsection
15002 \begin_layout Standard
15003 When you to have the
15007 program installed, you'll find in the
15014 \begin_inset space ~
15025 \begin_inset CommandInset href
15027 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15034 \begin_layout Standard
15039 package is a program that was written by
15044 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15045 and easy to forget.
15046 The program runs over your LaTeX file and checks the integrity of the file,
15047 and flags some common errors.
15048 In other technical words, it is
15055 \begin_layout Standard
15056 Well, what is a syntax checker doing in LyX which is supposed to produce
15057 correct LaTeX anyways? The answer is simple: Just as
15061 not only checks the
15065 of C programs, but also does
15069 checks for type-errors,
15073 catches some common
15077 errors, in addition to the syntactical ones.
15082 is capable of detecting several common errors, such as
15085 \begin_layout Itemize
15086 Ellipsis detection:
15087 \begin_inset Newline newline
15090 Use \SpecialChar \ldots{}
15094 \begin_layout Itemize
15095 No space in front of/after parenthesis:
15096 \begin_inset Newline newline
15102 \begin_layout Itemize
15103 Enforcement of normal space after common abbreviations:
15104 \begin_inset Newline newline
15109 is too wide spacing.
15112 \begin_layout Itemize
15113 Enforcement of end-of-sentence space when the last sentence ends with a
15115 \begin_inset Newline newline
15119 And this is wrong spacing.
15122 \begin_layout Itemize
15123 Space in front of labels and similar commands:
15124 \begin_inset Newline newline
15127 The label should stick right up to the text to avoid falling to a wrong
15130 \begin_inset CommandInset label
15140 \begin_layout Plain Layout
15141 This footnote is in danger of falling off to a wrong page
15146 The label is separated too much.
15149 \begin_layout Itemize
15150 Space in front of references, instead of hard spaces:
15151 \begin_inset Newline newline
15154 In you are in bad luck, the text will break right between the referenced
15155 text and reference number, and that's a pity.
15157 \begin_inset CommandInset ref
15159 reference "sec:chktex"
15166 \begin_layout Itemize
15168 \begin_inset Quotes eld
15172 \begin_inset Quotes erd
15176 \begin_inset Formula $\times$
15180 \begin_inset Newline newline
15183 2x2 looks cheap compared to
15184 \begin_inset Formula $2\times2$
15190 \begin_layout Standard
15191 and more \SpecialChar \ldots{}
15192 It is an invaluable tool when you are
15193 \begin_inset Quotes eld
15197 \begin_inset Quotes erd
15200 your document before printing, and you should run it right after the obligatory
15201 spelling check, and before you go fine tuning the typesetting.
15204 \begin_layout Subsection
15208 \begin_layout Standard
15209 If you have the program installed, usage is as simple as choosing
15214 ools\SpecialChar \menuseparator
15220 \begin_inset space ~
15226 This will make LyX generate a LaTeX file of your document, start
15230 to check it, and then make LyX insert
15231 \begin_inset Quotes eld
15235 \begin_inset Quotes erd
15238 with the warnings from
15242 , if there were any.
15243 The warnings will be placed close to the point of the mistake, and you
15244 can quickly find them by using the
15249 avigate\SpecialChar \menuseparator
15256 menu item, or the shortcut key
15265 Open the error boxes by clicking on them with the mouse, or use the shortcut
15274 bindings, or the corresponding
15283 Read the warning and correct the mistake, if it is a mistake.
15284 If you have trouble understanding what the warning is about, you can safely
15286 Remember that there is a hidden layer between the document on screen and
15287 the technical details in invoking
15291 , and this gap can make some warnings seem arcane or just right down plain
15295 \begin_layout Standard
15296 This document is an excellent testing bed for the feature, and it should
15297 provide quite a few warnings for you to fiddle with.
15298 Since computers are only so smart, expect most of the warnings to be false
15302 \begin_layout Subsection
15303 How to fine tune it
15306 \begin_layout Standard
15307 Sometimes, you'll find that
15311 makes more noise than suits your mood.
15312 Then you can choose not to use it, wait until your mood changes, or try
15317 to get better along with you.
15318 Another choice in the most desperate situations is to use
15323 iew\SpecialChar \menuseparator
15329 \begin_inset space ~
15333 \begin_inset space ~
15337 \begin_inset space ~
15342 , which will get rid of all warnings instantly.
15345 \begin_layout Standard
15354 very configurable and extensible, you shouldn't expect to solve all problems
15360 Since LyX has to generate a somewhat special LaTeX file to be able to match
15361 the line numbers from the
15369 \begin_layout Plain Layout
15370 You can inspect the specific output from
15376 Edit\SpecialChar \menuseparator
15378 \begin_inset space ~
15382 \begin_inset space ~
15396 to the internal document structure, some of the warnings will not seen
15397 to appear correctly.
15398 There are two things you can do about this:
15401 \begin_layout Itemize
15406 invocation command line in
15422 installation configuration file (usually with the file
15427 See below to learn what warnings can be enabled and disabled on the command
15432 \begin_layout Itemize
15433 Export your document as a raw LaTeX file using
15438 ile\SpecialChar \menuseparator
15443 xport\SpecialChar \menuseparator
15455 Invoked in this way, it can be a hassle to find the corresponding place
15456 in the document inside LyX, but with a little patience, you should be able
15460 \begin_layout Standard
15461 Here follows the warning messages that can be enabled and disabled in
15470 to disable a warning, and
15474 to enable a warning.
15475 The emphasized entries are disabled by default, because the default is
15478 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15483 \begin_layout Standard
15484 Notice that you should only use the options that enable and disable warnings,
15485 because LyX relies on some of the other command line parameters to be set
15486 in a specific way to have a chance to communicate with
15493 \begin_layout Enumerate
15497 Command terminated with space.
15500 \begin_layout Enumerate
15503 Non-breaking space (
15504 \begin_inset Quotes eld
15512 \begin_inset Quotes erd
15515 ) should have been used.
15518 \begin_layout Enumerate
15522 You should enclose the previous parenthesis with
15523 \begin_inset Quotes eld
15531 \begin_inset Quotes erd
15537 \begin_layout Enumerate
15540 Italic correction (
15541 \begin_inset Quotes eld
15551 \begin_inset Quotes erd
15554 ) found in non-italic buffer.
15557 \begin_layout Enumerate
15560 Italic correction (
15561 \begin_inset Quotes eld
15571 \begin_inset Quotes erd
15574 ) found more than once.
15577 \begin_layout Enumerate
15581 No italic correction (
15582 \begin_inset Quotes eld
15592 \begin_inset Quotes erd
15598 \begin_layout Enumerate
15602 \begin_inset Quotes eld
15610 \begin_inset Quotes erd
15614 \begin_inset Quotes eld
15622 \begin_inset Quotes erd
15628 \begin_layout Enumerate
15631 Wrong length of dash may have been used.
15634 \begin_layout Enumerate
15638 \begin_inset Quotes eld
15646 \begin_inset Quotes erd
15650 \begin_inset Quotes eld
15658 \begin_inset Quotes erd
15664 \begin_layout Enumerate
15668 \begin_inset Quotes eld
15676 \begin_inset Quotes erd
15682 \begin_layout Enumerate
15686 \begin_inset Quotes eld
15694 \begin_inset Quotes erd
15697 to achieve an ellipsis.
15700 \begin_layout Enumerate
15703 Inter-word spacing (
15704 \begin_inset Quotes eld
15714 \begin_inset Quotes eld
15717 ) should perhaps be used.
15720 \begin_layout Enumerate
15723 Inter-sentence spacing (
15724 \begin_inset Quotes eld
15734 \begin_inset Quotes erd
15737 ) should perhaps be used.
15740 \begin_layout Enumerate
15743 Could not find argument for command.
15746 \begin_layout Enumerate
15750 \begin_inset Quotes eld
15758 \begin_inset Quotes erd
15764 \begin_layout Enumerate
15767 Math mode still on at end of LaTeX file.
15770 \begin_layout Enumerate
15774 \begin_inset Quotes eld
15782 \begin_inset Quotes erd
15785 doesn't match the number of
15786 \begin_inset Quotes eld
15794 \begin_inset Quotes erd
15800 \begin_layout Enumerate
15803 You should use either
15806 \begin_inset Quotes eld
15814 \begin_inset Quotes erd
15819 as an alternative to
15820 \begin_inset Quotes eld
15828 \begin_inset Quotes erd
15834 \begin_layout Enumerate
15841 " (ASCII 39) instead of "
15848 \begin_layout Enumerate
15851 User-specified pattern found.
15854 \begin_layout Enumerate
15857 This command might not be intended.
15860 \begin_layout Enumerate
15867 \begin_layout Enumerate
15885 \begin_layout Enumerate
15888 Delete this space to maintain correct page references.
15891 \begin_layout Enumerate
15895 You might wish to put this between a pair of
15896 \begin_inset Quotes eld
15904 \begin_inset Quotes erd
15910 \begin_layout Enumerate
15913 You ought to remove spaces in front of punctuation.
15916 \begin_layout Enumerate
15919 Could not execute LaTeX command.
15922 \begin_layout Enumerate
15931 in front of small punctuation.
15934 \begin_layout Enumerate
15942 may look prettier here.
15945 \begin_layout Enumerate
15949 Multiple spaces detected in output.
15952 \begin_layout Enumerate
15955 This text may be ignored.
15958 \begin_layout Enumerate
15964 \begin_inset Quotes eld
15969 to begin quotation, not
15976 \begin_layout Enumerate
15983 to end quotation, not
15986 \begin_inset Quotes eld
15994 \begin_layout Enumerate
16000 \begin_layout Enumerate
16003 You should perhaps use
16004 \begin_inset Quotes eld
16012 \begin_inset Quotes erd
16018 \begin_layout Enumerate
16021 You should put a space in front of/after parenthesis.
16024 \begin_layout Enumerate
16027 You should avoid spaces in front of/after parenthesis.
16030 \begin_layout Enumerate
16034 You should not use punctuation in front of/after quotes.
16037 \begin_layout Enumerate
16040 Double space found.
16043 \begin_layout Enumerate
16046 You should put punctuation outside inner/inside display math mode.
16049 \begin_layout Enumerate
16052 You ought to not use primitive TeX in LaTeX code.
16055 \begin_layout Enumerate
16058 You should remove spaces in front of
16059 \begin_inset Quotes eld
16067 \begin_inset Quotes erd
16073 \begin_layout Enumerate
16076 \begin_inset Quotes eld
16084 \begin_inset Quotes erd
16087 is normally not followed by
16088 \begin_inset Quotes eld
16096 \begin_inset Quotes erd
16102 \begin_layout Standard
16103 In later versions of LyX, we hope to provide a more complete interface to
16104 this tool (and it's smaller cousin
16108 ) to exploit the full power of it.
16109 But it's not exactly useless as it is now: go try it on one of your existing
16110 documents of a certain length and be surprised.
16113 \begin_layout Section
16114 Version Control in LyX
16117 \begin_layout Standard
16120 Lars Gullik Bjønnes
16123 \begin_layout Subsection
16127 \begin_layout Standard
16128 A friend of mine wanted to try LyX for a group project.
16129 When he didn't find support for version control or file locking, he dropped
16131 This angered me a bit, so I thought that I should at least make support
16132 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16133 This has now been done.
16134 LyX now supports some of the most basic RCS commands.
16135 If you need to something a bit more sophisticated you will have to do that
16136 manually in an xterm.
16139 \begin_layout Standard
16140 Before you begin to use the version control features in LyX, you should
16142 \begin_inset Quotes eld
16146 \begin_inset Quotes erd
16149 (a man file, read it with
16154 This file describes all the basic features of RCS.
16155 You should especially notice the comment about a RCS directory, and the
16156 notion of a master RCS file (the file ending in
16163 \begin_layout Standard
16164 Also, as there is only basic CVS/SVN implementation you should be familiar
16165 with CVS/SVN usage before start using it under LyX.
16168 \begin_layout Standard
16169 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16170 package---no guarantees are made for older versions.
16173 \begin_layout Subsection
16174 RCS commands in LyX
16177 \begin_layout Standard
16178 The following sections describe the RCS commands supported by LyX.
16179 You can find them in the
16184 ile\SpecialChar \menuseparator
16190 \begin_inset space ~
16198 \begin_layout Subsubsection
16204 \begin_layout Standard
16205 If your document is not under revision control, this is the only item shown
16207 And if it is under revision control, the
16214 item is not visible.
16218 \begin_layout Standard
16219 This command registers your document with RCS (unless you are under the
16220 directory managed by CVS)\SpecialChar \@.
16221 You are asked interactively to supply an initial
16222 description of the document.
16223 The document is now set in Read-Only mode and you have to
16226 \begin_inset space ~
16230 \begin_inset space ~
16234 \begin_inset space ~
16239 , before making any changes to it.
16240 A document under revision control has a
16241 \begin_inset Quotes eld
16244 [RCS:<version> <locker>]
16245 \begin_inset Quotes erd
16248 item tagged to the filename in the minibuffer.
16251 \begin_layout Standard
16252 RCS command that is run:
16254 ci -q -u -i -t-"<initial description>" <file-name>
16257 \begin_layout Standard
16262 to understand the switches.
16266 \begin_layout Subsubsection
16272 \begin_layout Standard
16273 When you are finished editing a file, you check in your changes.
16274 When you do this, you are asked for a description of the changes.
16275 This is stored in the history log.
16276 The version number is bumped, your changes are applied to the master RCS
16277 file, the document is unlocked and set to Read-Only mode.
16281 \begin_layout Standard
16284 ci -q -u -m"<description>" <file-name>
16287 \begin_layout Subsubsection
16293 \begin_layout Standard
16294 By doing this you lock the document so that only you can edit it.
16295 This will also make the document Read-Write only for you.
16296 You will usually continue editing for a while and when you are finished
16297 you check in your changes.
16298 The status line is changed to reflect that you have locked the file.
16302 \begin_layout Standard
16305 co -q -l <file-name>
16308 \begin_layout Subsubsection
16311 Revert To Repository Version
16314 \begin_layout Standard
16315 This will discard all changes made to the document since the last check
16317 You get a warning before changes are discarded.
16320 \begin_layout Standard
16323 co -f -u<version> <file-name>
16326 \begin_layout Subsubsection
16332 \begin_layout Standard
16333 This makes as if the last check in never happened.
16334 No changes are made to the document loaded into LyX, but the last version
16335 is removed from the master RCS file.
16339 \begin_layout Standard
16342 rcs -o<version> <file-name>
16345 \begin_layout Subsubsection
16351 \begin_layout Standard
16352 This show the complete history of the RCS document.
16357 is shown in a browser.
16365 \begin_layout Subsection
16366 CVS commands in LyX
16369 \begin_layout Standard
16370 CVS is now partially supported by LyX.
16371 You can find the commands in the
16376 ile\SpecialChar \menuseparator
16382 \begin_inset space ~
16390 \begin_layout Subsubsection
16396 \begin_layout Standard
16397 If your document is not under revision control, this is the only item shown
16399 And if it is under revision control, the
16406 item is not visible.
16410 \begin_layout Standard
16411 This command registers in CVS your document ONLY in case you have already
16412 the documents directory under CVS control (in particular
16417 This means you have to checkout the archive by yourself.
16421 \begin_layout Standard
16422 Then you are asked interactively to supply an initial description of the
16424 Don't forget that registered file is not yet commited.
16427 \begin_layout Standard
16428 CVS command that is run:
16431 \begin_inset Quotes erd
16435 \begin_inset Quotes eld
16439 \begin_inset Quotes erd
16445 \begin_layout Standard
16450 to understand the switches.
16454 \begin_layout Subsubsection
16460 \begin_layout Standard
16461 When you are finished editing a file, you commit your changes.
16462 When you do this, you are asked for a description of the changes.
16463 After that changes are commited.
16466 \begin_layout Standard
16469 cvs -q commit -m"<description>" <file-name>
16472 \begin_layout Subsubsection
16475 Revert To Repository Version
16478 \begin_layout Standard
16479 This will discard all changes made to the document since the last check
16481 You get a warning before changes are discarded.
16482 Firstly the file is deleted, secondly CVS update command is run.
16485 \begin_layout Standard
16489 \begin_inset Quotes eld
16493 \begin_inset Quotes erd
16499 \begin_layout Subsubsection
16505 \begin_layout Standard
16506 This show the complete history of the CVS document.
16510 \begin_inset Quotes eld
16514 \begin_inset Quotes erd
16519 is shown in a browser.
16522 \begin_layout Subsection
16523 SVN commands in LyX
16526 \begin_layout Standard
16527 SVN is now partially supported by LyX.
16528 You can find the commands in the
16533 ile\SpecialChar \menuseparator
16539 \begin_inset space ~
16545 Please note that if you use password protected access to repository via
16546 ssh, you will be asked on termial window.
16549 \begin_layout Subsubsection
16555 \begin_layout Standard
16556 If your document is not under revision control, this is the only item shown
16558 And if it is under revision control, the
16565 item is not visible.
16569 \begin_layout Standard
16570 This command registers in SVN your document ONLY in case you have already
16571 the documents directory under SVN control (in particular
16576 This means you have to checkout the archive by yourself.
16580 \begin_layout Standard
16581 Then you are asked interactively to supply an initial description of the
16583 Don't forget that registered file is not yet commited.
16586 \begin_layout Standard
16587 SVN command that is run:
16590 \begin_inset Quotes eld
16594 \begin_inset Quotes erd
16600 \begin_layout Standard
16605 to understand the switches.
16609 \begin_layout Subsubsection
16615 \begin_layout Standard
16616 When you are finished editing a file, you commit your changes.
16617 When you do this, you are asked for a description of the changes.
16618 After that changes are commited.
16621 \begin_layout Standard
16624 svn commit -q -m"<description>" <file-name>
16627 \begin_layout Subsubsection
16633 \begin_layout Standard
16634 Updates the changes of this file from the repository.
16635 Be sure you understand SVN merging and conflicts resolving before using
16636 this function, because all conflicts has to be done manually by you!
16639 \begin_layout Standard
16643 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16653 \begin_layout Subsubsection
16656 Revert To Repository Version
16659 \begin_layout Standard
16660 This will discard all changes made to the document since the last check
16662 You get a warning before changes are discarded.
16666 \begin_layout Standard
16670 \begin_inset Quotes eld
16674 \begin_inset Quotes erd
16680 \begin_layout Subsubsection
16686 \begin_layout Standard
16687 This show the complete history of the SVN document.
16691 \begin_inset Quotes eld
16695 \begin_inset Quotes erd
16700 is shown in a browser.
16703 \begin_layout Section
16704 Literate Programming
16707 \begin_layout Standard
16712 (kayvan@sylvan.com)
16716 original documentation written by
16718 Edmar Wienskoski Jr.
16721 (edmar-w-jr@technologist.com)
16724 \begin_layout Subsection
16728 \begin_layout Standard
16729 The main purpose of this documentation is to show you how to use LyX for
16730 literate programming.
16731 Where it is assumed that you are familiar with this programming technique,
16733 \begin_inset Quotes eld
16737 \begin_inset Quotes erd
16741 \begin_inset Quotes eld
16745 \begin_inset Quotes erd
16749 If that is not the case, please follow the web links provided in the following
16751 There is a lot of good documentation out there covering old development
16752 history to the latest tools tips.
16755 \begin_layout Standard
16756 It is also assumed that you are familiar with LyX itself to a point that
16757 you are comfortable changing your LyX preferences, and X resources file.
16758 If that is not the case please refer to other LyX documentation to cover
16759 your specific needs.
16762 \begin_layout Subsection
16763 Literate Programming
16766 \begin_layout Standard
16767 From the Literate Programming FAQ:
16770 \begin_layout Quotation
16771 Literate programming is the combination of documentation and source together
16772 in a fashion suited for reading by human beings.
16773 In fact, literate programs should be enjoyable reading, even inviting!
16774 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16775 and documentation in a single file.
16776 Literate programming tools then parse the file to produce either readable
16777 documentation or compilable source.
16778 The WEB style of literate programming was created by D.E.
16779 Knuth during the development of his TeX typesetting software.
16783 \begin_layout Standard
16784 Another excerpt says:
16787 \begin_layout Quotation
16790 How is literate programming different from verbose commenting?
16793 \begin_layout Quotation
16794 There are three distinguishing characteristics.
16795 In order of importance, they are:
16799 \begin_layout Itemize
16800 flexible order of elaboration
16803 \begin_layout Itemize
16804 automatic support for browsing
16807 \begin_layout Itemize
16808 typeset documentation, especially diagrams and mathematics
16812 \begin_layout Standard
16813 Now that I sparked your curiosity, take a look in the references.
16816 \begin_layout Subsubsection
16820 \begin_layout Standard
16821 The complete Literate Programming FAQ can be found at:
16824 \begin_layout Quote
16825 Literate Programming FAQ
16826 \begin_inset Flex URL
16829 \begin_layout Plain Layout
16831 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16839 \begin_layout Standard
16840 The FAQ lists 23 (twenty three!) different literate programming tools.
16841 Where some are specialized or
16842 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16849 for particular programming languages, while other have general scope.
16854 for my own use for several reasons:
16857 \begin_layout Itemize
16858 It can generate the documentation either in LaTeX or HTML.
16861 \begin_layout Itemize
16862 It has a open architecture, i.e., it is easy to plug in new filters and to
16863 perform special processing that you may need.
16867 \begin_layout Itemize
16868 There is a good selection of filters available already (the HTML is one
16872 \begin_layout Itemize
16876 \begin_layout Standard
16877 The Noweb web page can be found at:
16880 \begin_layout Quote
16882 \begin_inset Flex URL
16885 \begin_layout Plain Layout
16887 http://www.cs.virginia.edu/~nr/noweb/
16895 \begin_layout Standard
16896 Starting from there you can reach many other interesting links and even
16897 some literate program examples.
16900 \begin_layout Subsection
16901 \begin_inset CommandInset label
16903 name "sub:LyX-and-Literate"
16907 LyX and Literate Programming
16910 \begin_layout Standard
16911 The LyX support for Literate Programming is provided by using the generic
16912 LyX convertors mechanism.
16913 This support is provided in a
16914 \begin_inset Quotes eld
16918 \begin_inset Quotes erd
16921 way, i.e., you will be able to use this new LyX feature with some other literate
16922 programming tool of your choice by just changing your LyX preferences.
16925 \begin_layout Subsubsection
16926 Generating documents and code (weaving and tangling)
16929 \begin_layout Paragraph
16930 Selecting the document class
16933 \begin_layout Standard
16934 If you have installed Noweb and LyX successfully, whenever you open a new
16935 document or try to change the document class of an existing one, you will
16936 find that there are three new document classes available:
16939 \begin_layout Itemize
16943 \begin_layout Itemize
16947 \begin_layout Itemize
16951 \begin_layout Standard
16952 You must select one of them to create your literate documents from.
16956 \begin_layout Standard
16957 Note that literate documents are not limited to these three classes.
16958 New classes can be generated from other styles like letter or in combination
16959 with other class variations like Article (AMS).
16960 If you have special needs that cannot be covered by one of the existing
16961 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16962 will arrange to insert a new entry, or teach you how to do it.
16966 \begin_layout Plain Layout
16967 It is very simple, it involves the creation of a file with four lines, and
16968 re-running of the auto configuration.
16973 Moreover, if you use a literate tool other than Noweb you may need to create
16974 a new set of document classes for it.
16977 \begin_layout Paragraph
16981 \begin_layout Standard
16982 LyX enables you to write code with a layout named
16990 \begin_layout Plain Layout
16991 The equivalent Noweb term is
16992 \begin_inset Quotes eld
16996 \begin_inset Quotes erd
17000 For historical reasons, I got used to the term
17001 \begin_inset Quotes eld
17005 \begin_inset Quotes erd
17008 introduced by other literate tool named Nuweb, which I used for many years
17009 before rendering myself to Noweb.
17014 Noweb delimits scraps like this:
17017 \begin_layout LyX-Code
17021 \begin_layout LyX-Code
17025 \begin_layout LyX-Code
17029 \begin_layout LyX-Code
17033 \begin_layout LyX-Code
17037 \begin_layout Standard
17038 The problem is that whatever is written in between the << and the
17042 must be taken literally, i.e., LyX should be prevented from making any special
17043 interpretation of what has been written.
17044 This is handled by a special layout named Scrap, that works like a normal
17045 paragraph but has a free spacing capability.
17048 \begin_layout Standard
17049 The down side of the Scrap paragraph layout is that consecutive paragraphs
17050 of code will be spaced with one empty line in the source code and also
17051 in the printed documentation.
17052 The work around is to enter each line of code within a single Scrap, with
17053 a newline (ctrl-return).
17054 The example above will look like this:
17058 \begin_layout Plain Layout
17059 If you have a printed version of this document you will not see any difference
17060 between the previous example and this one.
17068 \begin_layout LyX-Code
17070 \begin_inset Newline newline
17074 \begin_inset Newline newline
17078 \begin_inset Newline newline
17082 \begin_inset Newline newline
17088 \begin_layout Standard
17089 This layout works fine.
17090 The only real inconvenience is that you have to type ctrl-return instead
17095 \begin_layout Plain Layout
17096 It is in my list of
17097 \begin_inset Quotes eld
17101 \begin_inset Quotes erd
17112 \begin_layout Standard
17113 As a special note, you can also use the
17114 \begin_inset Quotes eld
17118 \begin_inset Quotes erd
17121 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17125 \begin_layout LyX-Code
17127 \begin_inset Newline newline
17130 def some_function(args):
17131 \begin_inset Newline newline
17134 "This is the doc string for this function."
17135 \begin_inset Newline newline
17138 print "My args: ", args
17141 \begin_layout LyX-Code
17142 @ %def some_function
17145 \begin_layout Standard
17146 For an example of this usage and the resulting cross-reference output, look
17147 at the Literate python program in
17149 LIBDIR/examples/listerrors.lyx
17151 which should make this all clear.
17154 \begin_layout Paragraph
17155 Generating the documentation
17158 \begin_layout Standard
17159 At this point you already have a new document file with a proper document
17160 class, and with some code and text on it.
17161 How do I print it? The answer is simple, you select
17166 iew\SpecialChar \menuseparator
17174 Just like you would do for a plain document.
17175 No special procedure is required.
17178 \begin_layout Standard
17179 To help orientate you, I will now explain what happens inside LyX:
17182 \begin_layout Enumerate
17188 pdate\SpecialChar \menuseparator
17195 menu option is chosen, a LaTeX file is generated.
17200 \begin_layout Standard
17201 If the document is of any literate class the generated file will be named
17202 with an extension name defined by the
17203 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17210 format (defined in the Preferences panel), otherwise the file will have
17219 \begin_layout Enumerate
17220 Note that the only difference so far is in the name of the file, no special
17221 processing is required by LyX.
17222 Given that you formatted the code using the Scrap layout that, by itself,
17223 takes care of the business.
17226 \begin_layout Enumerate
17227 If the document is of any literate class LyX will then use the internal
17228 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17232 \begin_layout Plain Layout
17233 The converters are defined in the
17238 ools\SpecialChar \menuseparator
17246 \begin_inset Quotes eld
17250 \begin_inset Quotes erd
17255 \begin_inset CommandInset ref
17257 reference "sub:converters"
17265 manual for general information about converters.
17270 to generate the LaTeX file.
17274 \begin_layout Standard
17275 Otherwise it will just skip this step.
17279 \begin_layout Enumerate
17280 Finally, LaTeX is invoked and the regular post processing continues as in
17284 \begin_layout Standard
17285 Independence from a particular
17286 \begin_inset Quotes eld
17290 \begin_inset Quotes erd
17293 is easily achieved by changing the commands that are run by the various
17297 \begin_layout Paragraph
17298 Generating the code
17301 \begin_layout Standard
17302 When the build menu option is chosen or the corresponding button in the
17303 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17304 Next, LyX invokes the
17309 This converter needs to be defined by the user and is not installed by
17310 default, though the Program format is.
17311 This converter (like any other converter) will have two parts:
17314 \begin_layout Enumerate
17315 The converter program itself.
17316 This program performs the conversion from the one format to the other (in
17317 this case, from the Noweb format to the Program pseudo-format).
17320 \begin_layout Enumerate
17321 The error log parser.
17322 This is a program whose sole purpose is to rewrite error messages in a
17323 format that LyX understands.
17324 This makes it possible for LyX to place error boxes in the right places
17325 in the file buffer.
17328 \begin_layout Standard
17329 The first part, the
17330 \begin_inset Quotes eld
17334 \begin_inset Quotes erd
17337 setting, should be set to
17338 \begin_inset Quotes eld
17346 \begin_inset Quotes erd
17350 This basically means that LyX will call
17351 \begin_inset Quotes eld
17355 \begin_inset Quotes erd
17358 (a program or script) with the name of the Noweb file (normally a file
17359 in the LyX temp directory).
17363 \begin_layout Standard
17364 This is an implementation of
17365 \begin_inset Quotes eld
17369 \begin_inset Quotes erd
17372 that you can place in a directory on your path:
17375 \begin_layout LyX-Code
17379 \begin_layout LyX-Code
17383 \begin_layout LyX-Code
17384 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17387 \begin_layout Standard
17388 The next part of the converter setting is the
17389 \begin_inset Quotes eld
17393 \begin_inset Quotes erd
17396 which is to be set to
17397 \begin_inset Quotes eld
17402 parselog=listerrors
17405 \begin_inset Quotes erd
17409 This will run any errors that are generated by the
17410 \begin_inset Quotes eld
17414 \begin_inset Quotes erd
17417 process through the
17418 \begin_inset Quotes eld
17422 \begin_inset Quotes erd
17428 \begin_layout Standard
17429 The converter code looks in
17437 then on the path for the
17438 \begin_inset Quotes eld
17442 \begin_inset Quotes erd
17448 \begin_layout Standard
17449 The build will normally take place in LyX's temporary directory, so the
17450 files produced by the conversion will be in that directory.
17451 LyX will copy out what it regards as the `main' file, but the
17455 conversion may produce several files, and so most of these would then be
17456 deleted when LyX was closed.
17457 The present solution is to use a `copier',
17461 \begin_layout Plain Layout
17463 \begin_inset CommandInset ref
17465 reference "sec:converters-etc"
17473 manual for information on these.
17482 script in its default mode, so that the entire contents of the temporary
17483 directory is copied.
17484 More will get copied than is needed, to be sure, but nothing will be lost.
17485 If, however, you know what extensions the generated files will have, this
17486 can be improved by using the
17495 This option takes a comma-separated list of extensions to copy.
17496 So, for example, if the conversion will generate only files with the extensions
17505 , then the correct definition would be:
17508 \begin_layout LyX-Code
17509 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17512 \begin_layout Standard
17513 The result will be that only files with these two extensions will be copied
17517 \begin_layout Paragraph
17518 Build instructions in the document
17521 \begin_layout Standard
17522 The last piece of the integration between LyX and noweb is the
17523 \begin_inset Quotes eld
17527 \begin_inset Quotes erd
17531 Generally, the instructions for building your program should be embedded
17532 in a scrap of its own.
17534 \begin_inset Quotes eld
17538 \begin_inset Quotes erd
17541 above uses the notangle command to look for this scrap (called
17542 \begin_inset Quotes eld
17546 \begin_inset Quotes erd
17549 ) and runs its contents through
17550 \begin_inset Quotes eld
17554 \begin_inset Quotes erd
17560 \begin_layout Standard
17561 Typically, such a scrap would look something like this:
17564 \begin_layout LyX-Code
17566 \begin_inset Newline newline
17570 \begin_inset Newline newline
17574 \begin_inset Newline newline
17577 if [ -z "${NOWEB_SOURCE}" ]
17578 \begin_inset Newline newline
17582 \begin_inset Newline newline
17585 NOWEB_SOURCE=myfile.nw
17586 \begin_inset Newline newline
17590 \begin_inset Newline newline
17594 code to extract files ...]
17595 \begin_inset Newline newline
17599 code to compile files ...]
17600 \begin_inset Newline newline
17606 \begin_layout Standard
17609 LIBDIR/examples/listerrors.lyx
17613 LIBDIR/examples/Literate.lyx
17615 which implement two versions of the
17616 \begin_inset Quotes eld
17620 \begin_inset Quotes erd
17623 program for some illustrations of how all of these pieces go together or
17626 LIBDIR/examples/noweb2lyx.lyx.
17629 Interestingly, these three files show off the language-indepence of the
17630 LyX literate programming support since they are written in Python, C and
17634 \begin_layout Subsubsection
17638 \begin_layout Standard
17639 All the Literate Programming support is configured by the
17644 ools\SpecialChar \menuseparator
17652 \begin_inset Quotes eld
17656 \begin_inset Quotes erd
17660 The important parts are:
17663 \begin_layout Description
17665 \begin_inset space ~
17669 \begin_inset Quotes eld
17673 \begin_inset Quotes erd
17677 \begin_inset space ~
17680 format Set up via the Formats tab, this is where the Noweb-specific pieces
17690 , the file extension is set to
17695 This tells LyX to create a file with a
17699 extension in the first step of the conversion process.
17702 \begin_layout Description
17704 \begin_inset space ~
17712 \begin_inset space ~
17715 format This is an empty format whose sole purpose is to be the endpoint
17716 of a conversion (which then allows us to set up a converter for it).
17719 \begin_layout Description
17728 This converter performs the
17729 \begin_inset Quotes eld
17733 \begin_inset Quotes erd
17736 of the literate document.
17737 For Noweb, it is set to
17738 \begin_inset Quotes eld
17743 noweave -delay -index $$i > $$o
17746 \begin_inset Quotes erd
17752 \begin_layout Description
17762 \begin_inset Quotes eld
17766 \begin_inset Quotes erd
17770 As stated above, the Converter is set to
17771 \begin_inset Quotes eld
17779 \begin_inset Quotes erd
17782 , with Flags set to
17783 \begin_inset Quotes eld
17788 originaldir,parselog=listerrors
17791 \begin_inset Quotes erd
17797 \begin_layout Subsubsection
17801 \begin_layout Standard
17802 There is also a new function implemented in the LyX server, the
17803 \begin_inset Quotes eld
17806 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17810 \begin_layout Standard
17811 When debugging code with ddd/gdb, it is possible to invoke a text editor
17812 at the current execution position with a single key stroke.
17813 The default ddd configuration for that is shift-ctrl-V.
17814 It happens that you can define the editor command line invocation in ddd
17820 dit\SpecialChar \menuseparator
17825 references\SpecialChar \menuseparator
17832 dialog and changing the "Edit Sources" entry.
17835 \begin_layout Standard
17836 I take advantage of the new created LyX server function and this ddd feature,
17838 \begin_inset Quotes eld
17842 \begin_inset Quotes erd
17848 \begin_layout LyX-Code
17849 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17852 \begin_layout Standard
17853 With this, whenever you are using ddd and find a point in the program that
17854 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17855 ddd you forward this information to LyX through the LyX server and then
17856 the LyX window will show the same file with the cursor at the same position
17857 ddd was pointing to.
17858 No more guessing or long scrolling to locate a point in the program back
17862 \begin_layout Standard
17863 Note however that you must enable the LyX server to get this feature working
17864 (it is disabled by default).
17865 You can enable it in
17877 ) by entering in the
17882 \begin_inset Quotes eld
17887 /home/<your-home-directory>/.lyx/lyxpipe
17890 \begin_inset Quotes erd
17896 \begin_layout Standard
17897 Read the LyX server documentation in the
17899 Customization Manual
17901 for further information.
17904 \begin_layout Subsubsection
17908 \begin_layout Standard
17909 There are six new buttons that can be added to your LyX toolbar.
17910 Five of these buttons are short cuts to layout styles:
17931 The last one is a short cut to the
17932 \begin_inset Quotes eld
17936 \begin_inset Quotes erd
17943 \begin_layout Standard
17944 LyX has a range of buttons that are available for tool bar customization.
17945 In my toolbar I like to combine the six short cuts above with two more:
17953 \SpecialChar \menuseparator
17961 \SpecialChar \menuseparator
17974 iew\SpecialChar \menuseparator
17982 Here is how it looks like:
17985 \begin_layout LyX-Code
17989 \begin_layout LyX-Code
17993 \begin_layout LyX-Code
17994 Icon "layout Standard"
17997 \begin_layout LyX-Code
17998 Icon "layout Section"
18001 \begin_layout LyX-Code
18002 Icon "layout LaTeX"
18005 \begin_layout LyX-Code
18006 Icon "layout LyX-Code"
18009 \begin_layout LyX-Code
18010 Icon "layout Scrap"
18013 \begin_layout LyX-Code
18017 \begin_layout LyX-Code
18021 \begin_layout LyX-Code
18022 Icon "buffer-typeset"
18025 \begin_layout LyX-Code
18026 Icon "build-program"
18029 \begin_layout LyX-Code
18033 \begin_layout LyX-Code
18037 \begin_layout LyX-Code
18041 \begin_layout LyX-Code
18045 \begin_layout LyX-Code
18049 \begin_layout Subsubsection
18050 Colors customization
18053 \begin_layout Standard
18054 There are a number of colors in LyX that can be customized in
18059 One of the things that bothers people is the LaTeX font color.
18060 The default color is red, since the scraps uses LaTeX font, and there is
18061 a lot of scraps in literate documents, you may get tired of seeing everything
18063 You can change it by going to the tabs
18072 \begin_layout Standard
18073 The next thing is the visible presence of the newline character in the screen.
18074 You can choose the color of this particular character and make it blend
18076 I recommend you choosing a color that is close to the background but not
18077 equal, that way you still can see it is there, but it is not bothering
18082 \begin_layout Chapter
18083 Secrets of the LaTeX Masters
18084 \begin_inset CommandInset label
18093 \begin_layout Standard
18094 Though LyX is a powerful tool, it cannot hope to support everything that
18095 can be done with pure TeX/LaTeX.
18096 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18097 as long as you are not afraid to use that
18098 \begin_inset Quotes eld
18102 \begin_inset Quotes erd
18105 button on the toolbar or add things to the LaTeX preamble.
18106 This section lists some tips, tricks, and otherwise cool ideas to give
18107 your document that extra little flair.
18110 Do try this at home
18112 , just start with something a little smaller and less important than your
18116 \begin_layout Standard
18117 Most ideas in this section require less common files in your LaTeX installation.
18118 If you have a system like teTeX, most will already be available.
18119 A few, however, will need to be downloaded from one of the CTAN archives.
18120 Often, there are several ways to do something, or several LaTeX style files
18121 which do the same thing.
18122 We do not endorse one choice over another, we simply claim that we have
18123 done a particular task with a particular file.
18124 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18127 \begin_layout Section
18131 \begin_layout Standard
18134 Lars Gullik Bjønnes
18137 \begin_layout Subsection
18141 \begin_layout Standard
18142 The aim for this chapter
18146 \begin_layout Plain Layout
18147 Editor's note: Lars' original chapter was a masterful description of how
18153 However, it was too long to flow smoothly in this document.
18154 I have therefore chosen to excerpt the most important sections here (sorry,
18155 Lars); you can read the original chapter (and more of the story!) in the
18158 examples/multicol.lyx
18166 is to show how the LaTeX package
18170 can be used in a LyX document.
18171 As LyX doesn't support the
18175 package natively yet, we have to use some small hacks.
18176 By reading this section it should be obvious how to do this.
18179 \begin_layout Subsection
18183 \begin_layout Standard
18188 package allows switching between one and multicolumn format on the same
18190 Footnotes are handled correctly (for the most part), but will be placed
18191 at the bottom of the page and not under each column.
18192 LaTeX's float mechanism, however, is partly disabled in the current implementat
18194 At the moment only page-wide floats can be used within the scope of the
18198 \begin_layout Subsection
18202 \begin_layout Subsubsection
18206 \begin_layout Standard
18207 If you want to have two columns in your text, you have use LaTeX mode to
18212 begin{multicols}{2}
18214 at the point where you want the two column layout to start, and then
18220 where you want it to end.
18224 \begin_layout Standard
18228 \begin_layout Plain Layout
18232 begin{multicols}{2}
18240 \begin_layout Standard
18245 The Adventure of the Empty House
18248 \begin_inset Newline newline
18253 Sir Arthur Conan Doyle
18256 \begin_layout Standard
18259 It was in the spring of the year 1894 that all London was interested, and
18260 the fashionable world dismayed, by the murder of the Honourable Ronald
18261 Adair under most unusual and inexplicable circumstances.
18262 The public has already learned those particulars of the crime which came
18263 out in the police investigation, but a good deal was suppressed upon that
18264 occasion, since the case for the prosecution was so overwhelmingly strong
18265 that it was not necessary to bring forward all the facts.
18266 Only now, at the end of nearly ten years, am I allowed to supply those
18267 missing links which make up the whole of that remarkable chain.
18268 The crime was of interest in itself, but that interest was as nothing to
18269 me compared to the inconceivable sequel, which afforded me the greatest
18270 shock and surprise of any event in my adventurous life.
18271 Even now, after this long interval, I find myself thrilling as I think
18272 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18273 ty which utterly submerged my mind.
18274 Let me say to that public, which has shown some interest in those glimpses
18275 which I have occasionally given them of the thoughts and actions of a very
18276 remarkable man, that they are not to blame me if I have not shared my knowledge
18277 with them, for I should have considered it my first duty to do so, had
18278 I not been barred by a positive prohibition from his own lips, which was
18279 only withdrawn upon the third of last month.
18282 \begin_layout Standard
18286 \begin_layout Plain Layout
18298 \begin_layout Subsubsection
18302 \begin_layout Standard
18303 The same pattern is used when you want more than two columns:
18306 \begin_layout Standard
18310 \begin_layout Plain Layout
18314 begin{multicols}{3}
18322 \begin_layout Standard
18325 It can be imagined that my close intimacy with Sherlock Holmes had interested
18326 me deeply in crime, and that after his disappearance I never failed to
18327 read with care the various problems which came before the public.
18328 And I even attempted, more than once, for my own private satisfaction,
18329 to employ his methods in their solution, though with indifferent success.
18330 There was none, however, which appealed to me like this tragedy of Ronald
18332 As I read the evidence at the inquest, which led up to a verdict of willful
18333 murder against some person or persons unknown, I realized more clearly
18334 than I had ever done the loss which the community had sustained by the
18335 death of Sherlock Holmes.
18336 There were points about this strange business which would, I was sure,
18337 have specially appealed to him, and the efforts of the police would have
18338 been supplemented, or more probably anticipated, by the trained observation
18339 and the alert mind of the first criminal agent in Europe.
18340 All day, as I drove upon my round, I turned over the case in my mind and
18341 found no explanation which appeared to me to be adequate.
18342 At the risk of telling a twice-told tale, I will recapitulate the facts
18343 as they were known to the public at the conclusion of the inquest.
18346 \begin_layout Standard
18350 \begin_layout Plain Layout
18362 \begin_layout Standard
18363 You can have more than 3 columns if you want to, but that might not be very
18364 pleasant for the eye.
18367 \begin_layout Subsubsection
18368 Columns inside columns
18371 \begin_layout Standard
18372 You can even have columns inside columns:
18375 \begin_layout Standard
18379 \begin_layout Plain Layout
18383 begin{multicols}{2}
18391 \begin_layout Standard
18394 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18395 at that time governor of one of the Australian colonies.
18396 Adair's mother had returned from Australia to undergo the operation for
18397 cataract, and she, her son Ronald, and her daughter Hilda were living together
18401 \begin_layout Standard
18405 \begin_layout Plain Layout
18409 begin{multicols}{2}
18417 \begin_layout Standard
18420 The youth moved in the best society--had, so far as was known, no enemies
18421 and no particular vices.
18422 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18423 had been broken off by mutual consent some months before, and there was
18424 no sign that it had left any very profound feeling behind it.
18425 For the rest {sic} the man's life moved in a narrow and conventional circle,
18426 for his habits were quiet and his nature unemotional.
18427 Yet it was upon this easy-going young aristocrat that death came, in most
18428 strange and unexpected form, between the hours of ten and eleven-twenty
18429 on the night of March 30, 1894.
18432 \begin_layout Standard
18436 \begin_layout Plain Layout
18448 \begin_layout Standard
18451 Ronald Adair was fond of cards--playing continually, but never for such
18452 stakes as would hurt him.
18453 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18454 It was shown that, after dinner on the day of his death, he had played
18455 a rubber of whist at the latter club.
18456 He had also played there in the afternoon.
18461 The evidence of those who had played with him-- Mr.
18462 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18463 and that there was a fairly equal fall of the cards.
18464 Adair might have lost five pounds, but not more.
18465 His fortune was a considerable one, and such a loss could not in any way
18467 He had played nearly every day at one club or other, but he was a cautious
18468 player, and usually rose a winner.
18469 It came out in evidence that, in partnership with Colonel Moran, he had
18470 actually won as much as four hundred and twenty pounds in a sitting, some
18471 weeks before, from Godfrey Milner and Lord Balmoral.
18472 So much for his recent history as it came out at the inquest.
18475 \begin_layout Standard
18479 \begin_layout Plain Layout
18491 \begin_layout Standard
18492 Please do read the file
18494 examples/multicol.lyx
18496 for more advanced examples including column and header spacing, vertical
18497 separator lines, and more.
18500 \begin_layout Section
18505 Paragraph Environment
18506 \begin_inset OptArg
18509 \begin_layout Plain Layout
18510 Numbering in Enumerate
18518 \begin_layout Standard
18524 \begin_layout Standard
18525 \begin_inset VSpace bigskip
18531 \begin_layout Standard
18533 The default numbering for the
18537 paragraph environment begins with Arabic numbers and ends with uppercase
18539 Suppose, however, you wanted a different type of numbering scheme.
18540 Here's a quickie example of how to change the numbering scheme:
18543 \begin_layout LyX-Code
18553 \begin_layout LyX-Code
18563 \begin_layout LyX-Code
18573 \begin_layout LyX-Code
18583 \begin_layout Standard
18584 \SpecialChar \ldots{}
18585 which changes the numbering scheme to uppercase Roman numerals, uppercase
18586 letters, Arabic numbers, and lowercase letter.
18589 \begin_layout Standard
18590 Additionally, the previous example also adds a little bit extra to the numbering
18592 For example, the first level label actually looks like:
18593 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18601 For ease of reading, we'll describe what the numbering schemes look like
18602 using a notation something like this: <
18603 \begin_inset Quotes eld
18607 \begin_inset Quotes erd
18611 \begin_inset space ~
18615 \begin_inset Quotes erd
18619 \begin_inset Quotes erd
18623 \begin_inset space ~
18627 \begin_inset Quotes erd
18631 \begin_inset Quotes erd
18635 \begin_inset space ~
18639 \begin_inset Quotes eld
18643 \begin_inset Quotes erd
18650 \begin_layout Standard
18651 As you can see in the example, there is a label command for each nesting
18658 \SpecialChar \ldots{}
18665 , as well as a counter,
18669 \SpecialChar \ldots{}
18675 There are also five
18676 \begin_inset Quotes eld
18680 \begin_inset Quotes erd
18713 , each of which take one counter as an argument.
18714 You can add characters before or after these, but there's no need to add
18718 \begin_layout Standard
18719 You can get really fancy with these.
18723 \begin_layout LyX-Code
18737 \begin_layout LyX-Code
18749 \begin_layout LyX-Code
18759 \begin_layout LyX-Code
18769 \begin_layout Standard
18770 produces the somewhat out of hand numbering scheme: <
18771 \begin_inset Quotes eld
18775 \begin_inset Quotes erd
18779 \begin_inset space ~
18783 \begin_inset Quotes erd
18787 \begin_inset Quotes erd
18791 \begin_inset space ~
18795 \begin_inset Quotes erd
18799 \begin_inset Quotes erd
18803 \begin_inset space ~
18807 \begin_inset Quotes eld
18811 \begin_inset Quotes erd
18818 \begin_layout Standard
18822 \begin_layout Section
18826 \begin_layout Standard
18832 \begin_layout Standard
18833 \begin_inset VSpace bigskip
18839 \begin_layout Standard
18844 \begin_layout Plain Layout
18850 tmpfont}{cmr17 scaled 2500}{
18862 \begin_layout Standard
18867 \begin_layout Plain Layout
18878 hose of you who like the style of old books probably also like
18879 \begin_inset Quotes eld
18883 \begin_inset Quotes erd
18886 ---those large capital letters which begin each new chapter or section.
18887 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18888 know some plain TeX!) but does require a lot of work and many iterations,
18889 as you can see by all the ugly TeX-mode stuff at the beginning of this
18893 \begin_layout Standard
18897 \begin_layout Plain Layout
18903 bigdrop{-1em}{3}{ptmri}{T}+
18908 here is a much easier way of doing this, of course.
18917 ) package from CTAN allows a simple way to add such letters to your documents.
18918 Since this package is not a standard part of teTeX, I can't demonstrate
18919 it within this document, but if you copy this paragraph to a new document,
18921 \begin_inset Quotes eld
18931 \begin_inset Quotes erd
18934 and the pluses from the TeX code at the beginning of the paragraph, and
18939 usepackage{dropcaps}
18941 to your LaTeX preamble, you will get a nice Times Roman Italic
18942 \begin_inset Quotes eld
18946 \begin_inset Quotes erd
18949 , whose height is three lines of text and which protrudes 1 em into the
18951 (Make certain you have copied
18952 \begin_inset Quotes eld
18960 \begin_inset Quotes erd
18963 into a directory where TeX can see it.) The first argument is the amount
18964 of indentation; in this case the negative sign moves it into the margin.
18965 The second argument is the height of the letter in number of lines of text.
18966 The third argument is the font name: virtually anything which has a tfm
18967 file should work (wade through the
18969 .../texmf/fonts/tfm
18971 directory for possibilities).
18972 My personal favorite is
18973 \begin_inset Quotes eld
18981 \begin_inset Quotes erd
18984 , a fancy German font specifically designed for dropped capitals.
18985 The fourth argument is the letter (or letters) to be dropped.
18990 package also offers the
18996 command, as well as a slightly simplified
19005 \begin_layout Section
19006 Non-standard Paragraph Shapes
19009 \begin_layout Standard
19015 \begin_layout Standard
19016 \begin_inset VSpace bigskip
19022 \begin_layout Standard
19026 \begin_layout Plain Layout
19038 \begin_layout Standard
19042 \begin_layout Plain Layout
19051 \begin_layout Plain Layout
19065 \begin_layout Standard
19070 \begin_layout Plain Layout
19081 \begin_layout Plain Layout
19090 \begin_layout Plain Layout
19099 \begin_layout Plain Layout
19108 \begin_layout Plain Layout
19117 \begin_layout Plain Layout
19126 \begin_layout Plain Layout
19135 \begin_layout Plain Layout
19144 \begin_layout Plain Layout
19153 \begin_layout Plain Layout
19162 \begin_layout Plain Layout
19171 \begin_layout Plain Layout
19180 \begin_layout Plain Layout
19189 \begin_layout Plain Layout
19198 \begin_layout Plain Layout
19207 \begin_layout Plain Layout
19216 \begin_layout Plain Layout
19225 \begin_layout Plain Layout
19234 \begin_layout Plain Layout
19243 \begin_layout Plain Layout
19249 There are times when the tyranny of rectangular paragraphs must be overthrown.
19250 In such situations, a call to the delightful plain TeX command
19257 As you can see, completely arbitrary shapes can be laid out with a suitable
19258 set of linelength definitions.
19259 While this parshape may look a bit silly and useless, one could conceive
19260 of situations such as finely tuned dropped capitals, word wrapping around
19261 non-rectangular graphics, etc.
19262 which will benefit from such handcrafting.
19265 \begin_layout Standard
19266 \begin_inset VSpace bigskip
19272 \begin_layout Standard
19277 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19284 is the number of lines of text which define the paragraph.
19285 If there turn out to be fewer lines, the shape is truncated; if there are
19286 more, the excess lines have the same dimensions as the last line of the
19296 entries specify the indentation of the line from the left margin, and the
19297 length of the line as measured from that point.
19298 The shape applies only to the current paragraph; everything is reset to
19299 normal for the next paragraph.
19302 \begin_layout Standard
19306 \begin_layout Plain Layout
19318 \begin_layout Section
19322 \begin_layout Standard
19323 As you can see, the examples in this section range from the useful to the
19325 While I don't expect that anyone will ever need the paragraph shape demonstrate
19326 d in the last section, the important point is that you can do almost anything
19327 you want in LyX if you are willing to figure out how to do it in TeX and
19329 TeX is a fantastically powerful typesetting system and all that power is
19330 available to you since LyX uses it as its backend.