1 #LyX 1.6.0rc1 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 Subsection
2962 Bibliography Lists in all Subdocuments
2965 \begin_layout Standard
2966 Copy the bibliography list with all entries to all subdocuments and transform
2968 This way LyX will find the
2972 -files and you can easily insert references without making the bibliography
2976 \begin_layout Standard
2977 As the bibliography list is in a comment, LaTeX won't use use it and the
2978 references will look like this [?] instead of [1].
2979 A solution is to use the LaTeX-package
2983 that will only include comments by processing the files separately.
2984 To do this, add in the LaTeX preamble of every subdocument the following:
2987 \begin_layout LyX-Code
2993 \begin_layout LyX-Code
2996 includecomment{comment}
2999 \begin_layout Standard
3001 \begin_inset Flex URL
3004 \begin_layout Plain Layout
3006 http://wiki.lyx.org/FAQ/Unsorted#toc31
3014 \begin_layout Section
3015 Fancy Headers and Footers
3018 \begin_layout Standard
3019 The default page layout is rather plain; for an article document class,
3020 all you get is a centered page number at the bottom of the page.
3021 This document is the book class, so it appears to be a bit fancier, but
3022 to really put on a show, you need to set the document page style to
3023 \begin_inset Quotes eld
3027 \begin_inset Quotes erd
3030 , as mentioned in the
3033 \begin_inset space ~
3039 This section describes the LaTeX codes you need to insert in your LaTeX
3040 preamble or the text in order to get the desired effects.
3043 \begin_layout Standard
3044 The page header is divided into three fields, not surprisingly labeled
3045 \begin_inset Quotes eld
3049 \begin_inset Quotes erd
3053 \begin_inset Quotes eld
3057 \begin_inset Quotes erd
3061 \begin_inset Quotes eld
3065 \begin_inset Quotes erd
3069 The footer is also divided into these three fields.
3070 The LaTeX commands to set these fields in the simplest manner are
3095 Suppose you wish to put your name in the upper left hand corner of each
3097 Simply insert the following command in the preamble:
3100 \begin_layout Standard
3109 \begin_layout Standard
3110 You will now see your name in the upper left.
3111 If a field has a default entry that you would like to get rid of (often
3112 the page number appears in the central footer, simply include a command
3113 with a blank argument, e.
3114 \begin_inset space \thinspace{}
3120 \begin_layout Standard
3128 \begin_layout Standard
3129 Let's get really fancy: lets put the section number with the word
3130 \begin_inset Quotes eld
3134 \begin_inset Quotes erd
3138 \begin_inset space \thinspace{}
3142 \begin_inset space ~
3145 Section 3) in the upper left, the page number (e.
3146 \begin_inset space \thinspace{}
3150 \begin_inset space ~
3153 Page 4) in the upper right, your name in the lower left, and the date in
3155 The following commands should now appear in the preamble:
3158 \begin_layout Standard
3168 \begin_layout Standard
3176 \begin_layout Standard
3186 \begin_layout Standard
3195 \begin_layout Standard
3203 \begin_layout Standard
3213 \begin_layout Standard
3226 access LaTeX's section and page counters, and so print out the current
3227 section and page numbers.
3234 simply prints out today's date.
3237 \begin_layout Standard
3238 The thicknesses of the horizontal rules drawn beneath the header and above
3239 the footer can also be modified.
3240 If you don't want one of the headers, set its thickness to 0.
3241 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3242 Use the commands, e.
3243 \begin_inset space \thinspace{}
3253 headrulewidth}{0.4pt}
3261 footrulewidth}{0.4pt}
3263 to set the thicknesses.
3266 \begin_layout Standard
3267 You can switch the header/footer settings on and off for individual pages
3272 thispagestyle{empty}
3278 thispagestyle{plain}
3284 thispagestyle{fancy}
3287 Simply insert them in the text on the page you want changed and mark them
3289 In fact, title pages are marked as plain by default, while following pages
3290 are marked fancy when using the global fancy setting.
3293 \begin_layout Standard
3294 There are more complex commands which will let you insert things in the
3295 upper left on odd numbered pages, etc., but I will refer you to the
3299 package documentation for more descriptions.
3300 For example, if you have a teTeX installation, look for
3302 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3308 \begin_layout Standard
3309 As a final example, it is possible to include an Encapsulated PostScript
3310 file in the header or footer.
3311 Suppose you want to put a company logo in the upper lefthand corner.
3312 You might try something like
3315 \begin_layout Standard
3324 includegraphics{logo.eps}}}
3327 \begin_layout Standard
3329 (you may need to preface this with
3333 usepackage{graphics}
3335 if you don't include EPS files elsewhere in your document).
3338 \begin_layout Section
3339 Itemize Bullet Selection
3340 \begin_inset CommandInset label
3349 \begin_layout Standard
3355 \begin_layout Subsection
3359 \begin_layout Standard
3360 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3361 Using this dialog you can easily specify what bullet shape to use at each
3362 level of an itemized list.
3363 These settings are document-wide so you won't be able to specify different
3364 sets of bullets for different paragraphs
3368 \begin_layout Plain Layout
3369 Well, actually you can but you'll have to do it by hand.
3377 \begin_layout Subsection
3381 \begin_layout Standard
3382 Open the dialog by selecting the
3387 ocument\SpecialChar \menuseparator
3394 menu item and then select the
3404 \begin_layout Standard
3405 The dialog provides you with a table of bullet shapes.
3406 A column of buttons on the left of the table provides access to the six
3407 different panels of bullet shapes.
3408 The row of buttons across the top is used to select which bullet depth
3410 A text entry under the table shows the currently selected bullet shape's
3411 LaTeX equivalent and this can be edited if desired.
3412 If you do modify the text you will also need to specify any needed packages
3413 in the LaTeX preamble.
3416 \begin_layout Standard
3417 The six panels are divided up by the packages they require.
3418 The following table shows the mappings from button name to LaTeX packages.
3421 \begin_layout Standard
3423 \begin_inset Tabular
3424 <lyxtabular version="3" rows="7" columns="2">
3426 <column alignment="center" valignment="top" width="0pt">
3427 <column alignment="center" valignment="top" width="0pt">
3429 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3432 \begin_layout Plain Layout
3447 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3450 \begin_layout Plain Layout
3467 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3470 \begin_layout Plain Layout
3485 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3488 \begin_layout Plain Layout
3504 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3507 \begin_layout Plain Layout
3522 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3525 \begin_layout Plain Layout
3542 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3545 \begin_layout Plain Layout
3560 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3563 \begin_layout Plain Layout
3580 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3583 \begin_layout Plain Layout
3598 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3601 \begin_layout Plain Layout
3618 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3621 \begin_layout Plain Layout
3636 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3639 \begin_layout Plain Layout
3656 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3659 \begin_layout Plain Layout
3674 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3677 \begin_layout Plain Layout
3700 \begin_layout Standard
3701 LyX doesn't stop you using bullets from packages you don't have.
3702 If you get errors from LaTeX when you try to view or print the file then
3703 its likely you are missing a package.
3704 LyX doesn't restrict your use since you may be editing locally and exporting
3708 \begin_layout Subsection
3712 \begin_layout Standard
3713 Select which bullet depth you want to change then select the bullet shape
3715 Any changes will not be visible in LyX, but are visible when viewing the
3716 document using xdvi or ghostview.
3719 \begin_layout Standard
3720 You can reset a bullet shape to the default simply by clicking your right
3721 mouse button on the appropriate bullet depth button.
3724 \begin_layout Standard
3729 want to have multiple sets of paragraphs with different sets of bullets
3730 in each then you're going to have to get your hands dirty.
3731 The itemize bullet selection dialog can help though because it provides
3732 you with the LaTeX code for a wide range of bullet shapes.
3733 To make your own custom paragraphs you have the following options:
3736 \begin_layout Standard
3740 \begin_layout Plain Layout
3756 \begin_layout Standard
3760 \begin_layout Plain Layout
3782 \begin_layout Itemize
3783 Use the LaTeX command
3789 to specify a new bullet shape for a given depth.
3790 You'll also need to save the current bullet shape so you can restore it
3792 In this itemized list the following LaTeX code was used to change the bullet
3793 used for the first depth.
3794 \begin_inset Newline newline
3810 \begin_inset Newline newline
3826 \begin_inset Newline newline
3831 Note that the itemize depth is specified in Roman numerals as part of the
3841 \begin_layout Itemize
3845 \begin_layout Plain Layout
3858 Specify each individual entry by starting each item with the bullet shape
3859 enclosed in square brackets and set as TeX.
3860 For example, this item was started with
3873 \begin_layout Standard
3877 \begin_layout Plain Layout
3893 \begin_layout Standard
3894 You'll also need to revert the labelitem back to its previous setting for
3895 the global bullet shape settings to remain in effect.
3896 The way used here was:
3897 \begin_inset Newline newline
3911 \begin_layout Chapter
3912 Special Document Classes
3915 \begin_layout Section
3916 \begin_inset CommandInset label
3918 name "sec:AMS-LaTeX"
3925 \begin_layout Standard
3928 David Johnson; updated by Richard Heck
3931 \begin_layout Standard
3932 \begin_inset VSpace bigskip
3938 \begin_layout Standard
3940 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3941 papers to be submitted to American Mathematical Society publications.
3942 The layouts are not tailored to a specific journal, but easily can be.
3943 You should refer to the AMS documentation for specific instructions for
3944 each journal (usually it will entail only changing a single line in the
3946 That documentation is available on the Web at
3947 \begin_inset Flex URL
3950 \begin_layout Plain Layout
3958 \begin_inset Flex URL
3961 \begin_layout Plain Layout
3963 ftp://ftp.ams.org/pub/tex/amslatex/
3969 These layouts are appropriate, and useful, for any mathematical writing.
3973 \begin_layout Standard
3974 There are two basic AMS LaTeX layouts:
3977 \begin_layout Enumerate
3978 amsart: The standard AMS article format.
3981 \begin_layout Enumerate
3982 amsbook: the standard AMS book (really, monograph) format.
3986 \begin_layout Standard
3987 These layouts themselves contain only the minimum necessary to use the AMS
3989 They do not, in particular, contain any of the `theorem' environments used
3990 for setting theorems, lemmas, and the like.
3991 These are contained, instead, in the
3992 \begin_inset Flex CharStyle:Code
3995 \begin_layout Plain Layout
4001 module, which you will need to load separately when you selected one of
4003 Less commonly used environments are in the
4004 \begin_inset Flex CharStyle:Code
4007 \begin_layout Plain Layout
4008 Theorems (AMS-Extended)
4017 \begin_layout Standard
4018 By default, theorems and the like are numbered consecutively throughout
4019 the document, but this may be modified by loading the module
4020 \begin_inset Flex CharStyle:Code
4023 \begin_layout Plain Layout
4024 Theorems (Order by Section)
4029 or, if you are using
4030 \begin_inset Flex CharStyle:Code
4033 \begin_layout Plain Layout
4040 \begin_inset Flex CharStyle:Code
4043 \begin_layout Plain Layout
4044 Theorems (Order by Chapter)
4050 These will number the results as
4051 \begin_inset Formula $n.m$
4054 , where the first number refers to the section (or chapter) and the second
4055 refers to the total number of results so far in that section (or chapter).
4056 Many environments are also available unnumbered.
4057 These are indicated by an asterisk at the end.
4058 If you happen to want
4062 unnumbered results, the the module
4063 \begin_inset Flex CharStyle:Code
4066 \begin_layout Plain Layout
4072 provides that option.
4075 \begin_layout Standard
4076 Note that these modules do not
4080 to be used with the AMS classes.
4081 It is perfectly possible to use the
4082 \begin_inset Flex CharStyle:Code
4085 \begin_layout Plain Layout
4091 module, and the others mentioned, with other classes, such as
4092 \begin_inset Flex CharStyle:Code
4095 \begin_layout Plain Layout
4102 \begin_inset Flex CharStyle:Code
4105 \begin_layout Plain Layout
4112 \begin_inset Flex CharStyle:Code
4115 \begin_layout Plain Layout
4124 \begin_layout Subsection
4125 What these layouts provide
4128 \begin_layout Standard
4129 There is a long list of included environments provided by these layouts.
4130 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4131 variety of `theorem' environments.
4132 However, the AMS recommends the environments that are available in LyX.
4136 \begin_layout Standard
4137 The following environments---as well as the standard environments, such
4139 \begin_inset Flex CharStyle:Noun
4142 \begin_layout Plain Layout
4149 \begin_inset Flex CharStyle:Noun
4152 \begin_layout Plain Layout
4159 \begin_inset Flex CharStyle:Noun
4162 \begin_layout Plain Layout
4169 \begin_inset Flex CharStyle:Noun
4172 \begin_layout Plain Layout
4179 \begin_inset Flex CharStyle:Noun
4182 \begin_layout Plain Layout
4189 \begin_inset Flex CharStyle:Code
4192 \begin_layout Plain Layout
4199 \begin_inset Flex CharStyle:Code
4202 \begin_layout Plain Layout
4211 \begin_layout Description
4212 Address This should be the author's permanent address.
4215 \begin_layout Description
4217 \begin_inset space ~
4220 Address This should be the author's temporary address at the time of submission,
4221 if different from the Address.
4224 \begin_layout Description
4225 Email Author's e-mail address
4228 \begin_layout Description
4229 URL Author's Web address, if desired.
4232 \begin_layout Description
4233 Keywords Key words or phrases used to identify specific topics discussed
4237 \begin_layout Description
4238 Subjectclass These refer to the AMS Subject Classifications, published and
4241 Mathematical Reviews
4244 These are also available online at the AMS cites listed above.
4247 \begin_layout Description
4251 \begin_layout Description
4255 \begin_layout Description
4259 \begin_layout Standard
4260 The following environments are provided by both the
4261 \begin_inset Flex CharStyle:Code
4264 \begin_layout Plain Layout
4271 \begin_inset Flex CharStyle:Code
4274 \begin_layout Plain Layout
4280 modules, in the latter case in both starred (unnumbered) and unstarred
4281 (numbered) versions.
4282 These same environments are provided only in the starred versions by the
4284 \begin_inset Flex CharStyle:Code
4287 \begin_layout Plain Layout
4296 \begin_layout Theorem
4297 This is typically used for the statements of major results.
4301 \begin_layout Corollary*
4302 This is used for statements which follow fairly directly from previous statement
4304 Again, these can be major results.
4309 These are smaller results needed to prove other statements.
4312 \begin_layout Proposition
4313 These are less major results which (hopefully) add to the general theory
4317 \begin_layout Conjecture
4318 These are statements provided without justification, which the author does
4319 not know how to prove, but which seem to be true (to the author, at least).
4322 \begin_layout Definition*
4323 Guess what this is for.
4324 The font is different for this environment than for the previous ones.
4328 \begin_layout Example*
4329 Used for examples illustrating proven results.
4332 \begin_layout Problem
4333 It's not really known what this is for.
4334 You should figure it out.
4337 \begin_layout Exercise*
4338 Write a description for this one.
4341 \begin_layout Remark
4342 This environment is also a type of theorem, usually a lesser sort of observation.
4345 \begin_layout Claim*
4346 Often used in the course of giving a proof of a larger result.
4350 Generally, these are used to break up long arguments, using specific instances
4356 The numbering scheme for cases is on its own, not together with other numbered
4362 At the end of this environment , a QED symbol (usually a square, but it
4363 can vary with different styles) is placed.
4364 If you want to have other environments within this one---for example, Case
4365 environments---and have the QED symbol appear only after them, then the
4366 other environments need to be nested within the proof environment.
4368 \begin_inset CommandInset ref
4370 reference "sec:Nesting"
4378 for information on nesting.
4381 \begin_layout Standard
4382 And these are provided by
4383 \begin_inset Flex CharStyle:Code
4386 \begin_layout Plain Layout
4387 Theorems (AMS-Extended)
4395 \begin_layout Criterion*
4396 A required condition.
4399 \begin_layout Algorithm*
4400 A general procedure to be used.
4403 \begin_layout Axiom*
4404 This is a property or statement taken as true within the system being discussed.
4407 \begin_layout Condition*
4408 Sometimes used to state a condition assumed within the present context of
4413 Similar to a Remark.
4416 \begin_layout Notation*
4417 Used for the explanation of, yes, notation.
4420 \begin_layout Summary
4421 Do we really need to tell you?
4424 \begin_layout Acknowledgement*
4428 \begin_layout Conclusion*
4429 Sometimes used at the end of a long train of argument.
4433 Used in a way similar to Proposition, though perhaps lower on the scale.
4436 \begin_layout Standard
4437 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4439 They need to be available on your system in order to use these environments.
4442 \begin_layout Section
4446 \begin_layout Standard
4451 can be used to type letters according to German conventions.
4452 A template file is included in
4454 .../lyx/share/templates
4456 for you to use as a starting point.
4459 \begin_layout Section
4463 \begin_layout Standard
4468 provides an alternative to the standard
4473 It provides similar functionality, but you might prefer this layout with
4474 sans serif sections, headings, and more.
4477 \begin_layout Section
4481 \begin_layout Standard
4487 \begin_layout Subsection
4491 \begin_layout Standard
4492 This section describes how LyX can be used to write articles for submission
4493 to the scientific journal
4495 Astronomy and Astrophysics
4497 (www.edpsciences.fr/aa/
4498 \begin_inset Flex URL
4501 \begin_layout Plain Layout
4503 http://www.edpsciences.fr/aa/
4508 ) using Version 5.01 of the document class
4513 This package can be downloaded from the ftp site
4516 \begin_layout Standard
4517 \begin_inset VSpace medskip
4523 \begin_layout Standard
4525 \begin_inset Flex URL
4528 \begin_layout Plain Layout
4530 ftp://ftp.edpsciences.org/pub/aa/readme.html
4538 \begin_layout Standard
4539 \begin_inset VSpace medskip
4545 \begin_layout Standard
4546 A manual comes together with that package, and this text is not meant to
4547 replace the original manual but merely a short guide how to realize the
4548 correct form of your paper.
4552 \begin_layout Standard
4553 Please note that the publisher of the journal was changed from Springer
4554 to EDP Sciences starting January 1, 2001.
4555 That change implicated also some slight changes of the style files, namely
4556 the removal of the thesaurus command.
4557 The LyX class aa supports the newest version of these style files, V 5.01.
4558 If you have an older version installed, please upgrade.
4559 For compatibility, the old (version 4) layout has been kept as
4564 Please refer to the comments in
4566 LyXDir/layouts/aapaper.layout
4571 \begin_layout Subsection
4575 \begin_layout Standard
4576 It is recommended you start from the example template distributed with LyX.
4577 If you are not using a template, note the following settings:
4580 \begin_layout Itemize
4590 ocument\SpecialChar \menuseparator
4597 dialog (OK, that one was obvious).
4600 \begin_layout Itemize
4601 Don't change the option
4604 \begin_inset space ~
4614 The whole layout is done by the macros, you shouldn't change anything.
4617 \begin_layout Subsection
4621 \begin_layout Standard
4622 First thing to enter is the header information.
4623 It consists of seven entries, of which some are optional.
4627 \begin_layout Itemize
4635 \begin_layout Itemize
4643 \begin_layout Itemize
4651 \begin_layout Itemize
4659 \begin_layout Itemize
4664 : [optional] if more than one author: whom to contact for offprint requests.
4667 \begin_layout Itemize
4672 : [optional] mail address for contacts.
4675 \begin_layout Itemize
4683 Received: <date>; Accepted <date>
4686 \begin_layout Standard
4687 There is no need to issue the
4693 command, this is done automatically by LyX when the header is finished.
4694 Although the order of the single header entries doesn't matter it is advised
4695 to keep the above sequence, just to get the best optics and meets the layout
4696 of the real document.
4699 \begin_layout Standard
4700 If you want to place footnotes in the header block, e.
4701 \begin_inset space \thinspace{}
4705 \begin_inset space ~
4708 to state your present address, just use the standard footnote via
4713 nsert\SpecialChar \menuseparator
4721 LyX will automagically use the term
4730 \begin_layout Standard
4731 In addition to these topics, the macros use three additional LaTeX commands
4732 that have no counterpart in LyX:
4735 \begin_layout Itemize
4742 to separate different names for more than one author and institute, respectivel
4746 \begin_layout Itemize
4753 to mark corresponding author/institute pairs.
4754 The institutes are numbered sequentially as they appear in the
4758 field, so you have to put a marker to each author.
4761 \begin_layout Itemize
4768 to supply an email address for fast contact.
4771 \begin_layout Standard
4772 In all cases, the appropriate command has to be entered in LyX and marked
4778 \begin_layout Subsection
4782 \begin_layout Standard
4783 The abstract should immediately follow the header block.
4784 With version 5 the abstract environment was changed to a command, and there
4785 is now a resctriction to only one paragraph.
4786 In addition, it should contain an entry with the keywords.
4787 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4794 by hand and mark it as LaTeX code.
4795 Refer to the example paper.
4798 \begin_layout Subsection
4799 Supported environments
4802 \begin_layout Standard
4803 The A&A paper layout supports the following environments for structuring
4807 \begin_layout Itemize
4813 \begin_layout Itemize
4819 \begin_layout Itemize
4825 \begin_layout Itemize
4831 \begin_layout Itemize
4837 \begin_layout Itemize
4843 \begin_layout Itemize
4849 \begin_layout Itemize
4855 \begin_layout Itemize
4861 \begin_layout Itemize
4867 \begin_layout Itemize
4873 \begin_layout Itemize
4879 \begin_layout Subsection
4880 Commands not supported by LyX
4883 \begin_layout Standard
4884 Some commands are not yet supported by the
4889 Some have already been mentioned.
4890 For the sake of completeness, they are listed all together here:
4893 \begin_layout Itemize
4901 \begin_layout Itemize
4909 \begin_layout Itemize
4917 \begin_layout Itemize
4925 \begin_layout Itemize
4933 \begin_layout Itemize
4941 \begin_layout Itemize
4949 \begin_layout Itemize
4957 \begin_layout Standard
4958 If you want to use any of these commands, you have to enter them yourself.
4961 Do not forget to mark them as LaTeX code!
4964 \begin_layout Subsection
4965 Figure and Table Floats
4968 \begin_layout Standard
4969 LyX provides support for the necessary float environments
4971 figure, figure*, table
4977 , therefore we won't tell much about it here.
4981 \begin_inset space ~
4987 Just remember that tables should be left-aligned.
4988 For that, select the table and change the alignment in
4993 dit\SpecialChar \menuseparator
4999 \begin_inset space ~
5005 \begin_layout Standard
5006 There is only one special thing: the figures with caption besides the figure.
5007 To create such a figure, you have to do the following:
5010 \begin_layout Enumerate
5011 Create a wide figure float:
5016 nsert\SpecialChar \menuseparator
5021 t\SpecialChar \menuseparator
5024 , then right click in the figure and select
5030 \begin_inset space ~
5038 \begin_layout Enumerate
5039 Enter your caption text.
5042 \begin_layout Enumerate
5047 to move the cursor above the caption.
5050 \begin_layout Enumerate
5054 \begin_layout Enumerate
5055 Position the cursor behind the figure and insert a horizontal fill:
5060 nsert\SpecialChar \menuseparator
5066 \begin_inset space ~
5071 \SpecialChar \menuseparator
5075 \begin_inset space ~
5083 \begin_layout Enumerate
5084 Switch to LaTeX mode:
5087 \begin_inset space ~
5095 \begin_layout Enumerate
5105 Do not close the brace!
5108 \begin_layout Enumerate
5109 Position the cursor behind the caption text, switch to LaTeX mode and insert
5113 \begin_inset space ~
5125 \begin_layout Standard
5126 Also, refer to the figures in the example paper.
5129 \begin_layout Subsection
5133 \begin_layout Standard
5134 For submission, the paper has to be formated in a special double-spacing
5136 For this purpose, you have to give the option
5140 to the documentclass.
5141 This must be done using the extra class options field in the
5146 ocument\SpecialChar \menuseparator
5154 Just enter the string
5161 \begin_layout Subsection
5165 \begin_layout Standard
5170 directory contains an example paper written with LyX.
5171 It is the example paper from the original macro package, translated to
5173 Use it for inspiration, and compare the original LaTeX code with LyX way
5177 \begin_layout Section
5181 \begin_layout Standard
5187 \begin_layout Subsection
5191 \begin_layout Standard
5192 AASTeX is a set of macros produced by the American Astronomical Society
5193 to facilitate electronic manuscript submission to the three journals they
5194 publish: the Astrophysical Journal (including the Letters and Supplement),
5195 the Astronomical Journal, and the Publications of the Astronomical Society
5197 LyX has proven to be an excellent tool for generating these documents,
5198 especially given its equation, citation, and figure handling capabilities.
5199 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5200 is the version described here, or higher.
5201 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5202 incompatible with LyX.
5203 The AASTeX package may be downloaded from the AASTeX Web site
5206 \begin_layout Standard
5207 \begin_inset VSpace medskip
5213 \begin_layout Standard
5215 \begin_inset Flex URL
5218 \begin_layout Plain Layout
5220 http://www.journals.uchicago.edu/AAS/AASTeX
5228 \begin_layout Standard
5229 \begin_inset VSpace medskip
5235 \begin_layout Standard
5236 A complete user guide is contained in that package and you should familiarize
5237 yourself with it thoroughly before embarking on writing a paper in LyX.
5238 LyX will not reduce the need to figure out all the AASTeX commands, it
5239 will only reduce the drudgery of typing everything in.
5240 It is your responsibility to ensure that the final exported LaTeX document
5241 conforms completely to the requirements of the journal to which you are
5242 submitting your paper.
5245 \begin_layout Subsection
5246 Starting a New Paper
5249 \begin_layout Standard
5250 I strongly suggest that you start with the AASTeX template file.
5256 ile\SpecialChar \menuseparator
5266 , enter the new file name, then choose the
5271 This will show the most common fields found in a manuscript.
5272 Simply overwrite the existing text (including the brackets,
5276 ) with the correct information.
5277 Many of the AASTeX commands and environments can be implemented directly
5278 in LyX, but some cannot: most noticeably
5290 , which should stick out like a sore thumb if you actually just opened the
5292 For commands such as these, the LaTeX code must be entered directly and
5294 Such commands are referred to as ERT, or Evil Red Text.
5295 I tried to minimize the amount of ERT needed in an AASTeX document, but
5296 there is still a bit more required than any of us would like.
5299 \begin_layout Subsection
5300 Finishing Your Paper
5303 \begin_layout Standard
5304 When the paper is finished to your satisfaction and previews/prints correctly,
5306 \begin_inset Quotes eld
5310 \begin_inset Quotes erd
5313 actions which need to be done before you submit it to the journals.
5317 \begin_layout Enumerate
5318 Export your paper as a LaTeX file (
5323 ile\SpecialChar \menuseparator
5328 xport\SpecialChar \menuseparator
5339 \begin_layout Enumerate
5344 file with your favorite text editor
5348 \begin_layout Enumerate
5349 remove the comment lines before the
5358 \begin_layout Enumerate
5363 usepackage...{fontenc}
5365 line if it appears (usually just after
5380 \begin_layout Enumerate
5381 remove everything between (and including) the
5393 commands, except for any commands you specifically put into the LaTeX preamble
5394 (which should appear immediately after the
5395 \begin_inset Quotes eld
5398 User specified LaTeX commands
5399 \begin_inset Quotes erd
5410 \begin_layout Enumerate
5411 Run the resulting file through LaTeX to make sure it still processes correctly.
5414 \begin_layout Enumerate
5415 Reread the journal requirements to make sure your filenames and formats
5419 \begin_layout Enumerate
5423 \begin_layout Subsection
5424 Comments On Specific Commands
5427 \begin_layout Standard
5428 I will not describe the detailed usage of the individual AASTeX commands:
5429 the AASTeX User Guide (
5433 ) gives a good description of each.
5434 Thus it's probably easiest for me to go down the list as found in the guide
5435 and offer comments where necessary.
5436 So let's begin \SpecialChar \ldots{}
5440 \begin_layout Subsubsection
5441 Things that work as expected
5444 \begin_layout Standard
5448 \begin_layout Plain Layout
5460 \begin_layout Standard
5461 Because they work as you might expect, I simply list them and the section
5562 begin{thebibliography}
5570 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5571 graphicx figure commands (2.14.1),
5595 (2.15.4, amongst other places),
5622 \begin_layout Standard
5623 The following style options also work correctly:
5644 Simply put them in the
5650 Layout\SpecialChar \menuseparator
5656 \begin_layout Standard
5660 \begin_layout Plain Layout
5672 \begin_layout Subsubsection
5673 Things that work, but require more comment
5676 \begin_layout Standard
5677 The following items work, but require a little more discussion:
5680 \begin_layout Itemize
5681 These items are reserved for use by the journal editors, but you can put
5682 them into the LaTeX preamble if you feel compelled to do so:
5715 \begin_layout Itemize
5716 These items may be placed in the LaTeX preamble, and are included as blanks
5717 in the template file:
5738 \begin_layout Itemize
5745 (2.3) -- can only be used
5746 \begin_inset Quotes eld
5750 \begin_inset Quotes erd
5753 , not in the middle of a paragraph.
5754 Use ERT if you need to embed it.
5757 \begin_layout Itemize
5764 (2.3) -- will have extra {} after it.
5765 This should not cause an error.
5768 \begin_layout Itemize
5775 (2.6) -- can only be used
5776 \begin_inset Quotes eld
5780 \begin_inset Quotes erd
5783 , not in the middle of a paragraph.
5784 Use ERT if you need to embed it.
5787 \begin_layout Itemize
5794 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5798 \begin_layout Itemize
5805 (2.8) -- same as for
5812 \begin_layout Itemize
5819 (2.9) -- will have extra {} after it.
5820 This should not cause an error.
5823 \begin_layout Itemize
5830 (2.11) -- will have extra {} after it.
5831 This should not cause an error.
5834 \begin_layout Itemize
5841 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5842 at the beginning of the text and selecting
5844 Insert\SpecialChar \menuseparator
5849 \begin_inset Quotes eld
5853 \begin_inset Quotes erd
5856 inserts an optional argument of the type needed by
5863 Hopefully it will be renamed someday.
5866 \begin_layout Itemize
5879 for the catalog ID optional parameter
5882 \begin_layout Itemize
5895 for the catalog ID optional parameter
5898 \begin_layout Subsubsection
5899 Things not implemented, use ERT
5902 \begin_layout Standard
5906 \begin_layout Plain Layout
5918 \begin_layout Standard
5941 setcounter{equation}
5943 (2.12), Journal name abbreviations (2.13.4),
5979 (2.15.4, insert it as the first element in the lefthand cell after where
5981 Don't use any of LyX's rules in the table),
5993 (2.15.5), much of Misc (2.17, except
6044 \begin_layout Standard
6048 \begin_layout Plain Layout
6060 \begin_layout Subsubsection
6061 Things that cannot be implemented
6064 \begin_layout Standard
6065 \SpecialChar \ldots{}
6066 at least in any meaningful sort of way, so I suggest ignoring them.
6067 They are the references environment (2.13.3), and the deluxetable environment
6069 If you really, really need to use deluxetable, I suggest editing it in
6070 a separate file with a text editor, then using
6075 nsert\SpecialChar \menuseparator
6081 \begin_inset space ~
6086 to include it in your LyX document.
6091 file to see an example of this.
6094 \begin_layout Subsection
6095 FAQs, Tips, Tricks, and Other Ruminations
6098 \begin_layout Subsubsection
6099 Getting LyX and AASTeX to cooperate
6102 \begin_layout Standard
6103 It can be a bit tricky to get LyX to recognize a new layout and document
6105 When all else fails, do this:
6108 \begin_layout Enumerate
6109 Make certain that LaTeX can find AASTeX.
6110 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6111 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6118 \begin_layout Enumerate
6130 \begin_layout Enumerate
6136 ools\SpecialChar \menuseparator
6143 in LyX, then restart LyX.
6146 \begin_layout Enumerate
6147 Open a regular new file, not from a template.
6148 Does AASTeX appear in the class list in
6153 ocument\SpecialChar \menuseparator
6163 \begin_layout Standard
6164 If you get a warning from an existing AASTeX document about not being able
6165 to find the AASTeX layout or a message about
6166 \begin_inset Quotes eld
6169 You should not mix title layouts with normal ones
6170 \begin_inset Quotes erd
6173 , things haven't been installed correctly.
6176 \begin_layout Subsubsection
6177 LaTeX error processing a table
6180 \begin_layout Standard
6181 LyX, by default, attempts to center the table caption/title.
6182 This seems to produce a bad interaction in AASTeX so you should click somewhere
6183 in the caption/title, then select
6188 dit\SpecialChar \menuseparator
6194 \begin_inset space ~
6211 This took care of it for me.
6214 \begin_layout Subsubsection
6216 \begin_inset CommandInset label
6225 \begin_layout Standard
6226 A couple of things: 1) I have noticed some funny spacing in the reference
6227 entries in the text.
6228 When you enter the bibliography item data, make sure their is
6232 space between the last author and the parenthesis setting off the year;
6236 \begin_inset space \thinspace{}
6240 \begin_inset space ~
6254 2) Entering the references at all is not obvious.
6255 The easiest thing is to start typing your first reference at the end of
6256 the document, then mark it as type
6261 That will put a small gray box in front of what you just typed.
6262 Click on the box to fill in the rest of the information.
6263 For new references, go to the end of an existing reference and press return.
6264 That will create a new line with its own box, etc.
6267 \begin_layout Subsubsection
6271 \begin_layout Standard
6272 Even though AASTeX provides its own figure commands (
6278 , for example), I much prefer LaTeX's standard figure commands (with the
6287 \begin_inset space ~
6290 commands as ERT into a Figure Float box if you desire, but I never have
6291 much luck getting the layout right.
6292 With the standard graphics, LyX will insert a
6296 usepackage{graphicx}
6298 command into the LaTeX preamble and handle the figures in the standard
6299 LaTeX2e way, interspersing the figures in the text.
6300 I believe ApJ accepts figures exactly this way now; AJ might still use
6302 \begin_inset Quotes eld
6305 stack everything at the end
6306 \begin_inset Quotes erd
6312 \begin_layout Subsubsection
6313 Things I could have done, but didn't
6316 \begin_layout Standard
6318 \begin_inset Quotes eld
6322 \begin_inset Quotes erd
6325 things I could have implemented, but chose not to.
6326 For instance, I saw no point in double-spacing the text in the LyX window,
6327 even though it is double-spaced in the paper manuscript.
6328 Also, I chose not to make separate layouts for the preprint and preprint2
6330 Since I assume you will spend most of your time in the plain manuscript
6331 mode anyway, I decided not to chew up more disk space with this.
6335 \begin_layout Subsection
6339 \begin_layout Standard
6340 Your mileage may vary.
6341 I've now had papers published by both ApJ and AJ that have had 98% of the
6342 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6344 I have had no trouble with the submission process, and I'm sure the journals
6345 were never aware that there might be a difference.
6346 So, go forth and publish!
6349 \begin_layout Section
6353 \begin_layout Standard
6356 Panayotis Papasotiriou
6359 \begin_layout Subsection
6363 \begin_layout Standard
6364 The ijmpc package is a set of macros that facilitates electronic manuscript
6367 International Journal of Modern Physics C
6370 Similarly, the ijmpd package is for creating manuscripts to be submitted
6373 International Journal of Modern Physics D
6376 Both journals are published by World Scientific.
6377 The corresponding document classes are named
6386 These files, together with instructions for the authors, can be downloaded
6388 \begin_inset Flex URL
6391 \begin_layout Plain Layout
6393 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6399 \begin_inset Flex URL
6402 \begin_layout Plain Layout
6404 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6410 Both packages are modified versions of the standard
6411 \begin_inset Quotes eld
6415 \begin_inset Quotes erd
6418 package, and they are almost (but not exactly) identical.
6419 Most of their features are supported by LyX.
6420 I have used LyX successfully to write articles submitted to both journals
6421 without any problem.
6424 \begin_layout Subsection
6428 \begin_layout Standard
6429 As usual, the easiest way to write a paper is to start with a template.
6435 ile\SpecialChar \menuseparator
6454 This will give an (almost) empty document that includes the most common
6455 fields found in a manuscript.
6456 Simply overwrite the existing text (including the brackets,
6461 You should keep in mind the following remarks.
6464 \begin_layout Enumerate
6465 LyX won't let you change the font size and the page style of the document,
6466 because such modifications are not allowed by both packages.
6469 \begin_layout Enumerate
6470 The language of the document should not be changed.
6471 Before previewing your paper, be sure that the babel package is not used.
6472 To do this, click on
6477 ools\SpecialChar \menuseparator
6495 checkbox in the language settings, and click on
6506 , if you wish to make this change permanent).
6509 \begin_layout Enumerate
6511 \begin_inset Quotes eld
6515 \begin_inset Quotes erd
6518 style must be used to define keywords.
6521 \begin_layout Enumerate
6522 The ijmpc package provides a style named
6523 \begin_inset Quotes eld
6526 Classification Codes
6527 \begin_inset Quotes erd
6530 , which can be used to define classification codes, such as PACS numbers.
6531 Note that this facility is not supported by the ijmpd package.
6534 \begin_layout Enumerate
6535 Several new environments are available:
6536 \begin_inset Quotes eld
6540 \begin_inset Quotes erd
6544 \begin_inset Quotes eld
6548 \begin_inset Quotes erd
6552 \begin_inset Quotes eld
6556 \begin_inset Quotes erd
6560 \begin_inset Quotes eld
6564 \begin_inset Quotes erd
6568 \begin_inset Quotes eld
6572 \begin_inset Quotes erd
6576 \begin_inset Quotes eld
6580 \begin_inset Quotes erd
6584 \begin_inset Quotes eld
6588 \begin_inset Quotes erd
6592 \begin_inset Quotes eld
6596 \begin_inset Quotes erd
6600 \begin_inset Quotes eld
6604 \begin_inset Quotes erd
6608 \begin_inset Quotes eld
6612 \begin_inset Quotes erd
6616 \begin_inset Quotes eld
6620 \begin_inset Quotes erd
6624 \begin_inset Quotes eld
6628 \begin_inset Quotes erd
6632 \begin_inset Quotes eld
6636 \begin_inset Quotes erd
6640 \begin_inset Quotes eld
6644 \begin_inset Quotes erd
6648 Their use is more or less obvious.
6649 LyX supports all these environments; it will use the proper label, text
6650 style, and numbering scheme for each of them.
6653 \begin_layout Enumerate
6654 Both packages use basic citations; the natbib package should not be used.
6655 In LyX, citation references are shown as usual; in the output, citations
6656 are shown as superscripts.
6657 If you want to use a citation as normal text, you should use the
6662 \begin_inset space \thinspace{}
6666 \begin_inset Quotes eld
6670 \begin_inset space ~
6680 \begin_inset Quotes erd
6686 \begin_layout Enumerate
6688 \begin_inset Quotes eld
6692 \begin_inset Quotes erd
6695 section in both packages.
6696 To put acknowledgments, just use the
6697 \begin_inset Quotes eld
6701 \begin_inset Quotes erd
6707 \begin_layout Enumerate
6708 Appendices may be added to the paper,
6712 the Acknowledgments and
6717 LyX provides a special environment, called
6718 \begin_inset Quotes eld
6722 \begin_inset Quotes erd
6725 which marks the beginning of the appendices.
6726 This environment should be left blank; it just sends a LaTeX command, but
6727 nothing is really printed.
6729 \begin_inset Quotes eld
6733 \begin_inset Quotes erd
6736 is printed with blue letters, as a signal that all sections after that
6737 point are appendices.
6738 To write an appendix, use the
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6747 LyX will number each appendix with capital letters, as required by both
6750 \begin_inset Quotes eld
6754 \begin_inset Quotes erd
6761 be present before the first appendix; if not, all appendices will be numbered
6762 as normal sections in the output.
6765 \begin_layout Enumerate
6766 The ijmpc and the ijmpd packages use the
6770 command to implement table captions.
6771 As a result, a table created by LyX is printed correctly, but its caption
6773 However, you can use some ERT to overpass this problem, so that captions
6774 are printed as expected.
6775 To do so, create a float table as usual, remove the caption, and replace
6786 (sic); you must also the ERT
6790 immediately after the tabular material.
6791 Study the example table included in the template files to see how this
6792 trick is implemented.
6793 Alternatively, If you need table captions, you should implement the whole
6798 file, then include this file to the LyX document (
6803 nsert\SpecialChar \menuseparator
6808 \SpecialChar \menuseparator
6814 \begin_inset space ~
6820 Details on how to create a table float can be found in the files
6828 , included in the corresponding packages.
6831 \begin_layout Subsection
6832 Preparing a paper for submission
6835 \begin_layout Standard
6836 Before you submit your paper you must export the LyX document as a LaTeX
6842 ile\SpecialChar \menuseparator
6847 xport\SpecialChar \menuseparator
6862 \begin_layout Plain Layout
6863 Actually you have the choice between LaTeX (plain) and pdflatex.
6864 If you intend to use pdflatex to prepare the paper, you should use the
6865 pdflatex option so that included graphics are converted to PDF format,
6866 ready for use by pdflatex.
6871 , then make the following changes to the resulting
6878 \begin_layout Enumerate
6879 Remove the comment lines before the
6888 \begin_layout Enumerate
6889 Remove everything between (and including) the
6901 commands, except for any commands you specifically put into the LaTeX preamble.
6904 \begin_layout Standard
6909 file should be saved and processed through LaTeX as many times as necessary.
6910 You may also want to check the resulting
6917 \begin_layout Subsection
6921 \begin_layout Standard
6922 The use of ERT is reduced to two commands, which must be placed at the top
6924 If you started writing your paper by using the
6932 template, the ERT needed is already in its place; you usually don't need
6934 You may only modify the first ERT to specify the information printed to
6935 the top of odd and even pages (authors' names and short paper's title,
6937 This ERT must have the form
6941 markboth{Authors' Names}{Short Paper's Title}
6946 \begin_layout Section
6950 \begin_layout Standard
6956 \begin_layout Subsection
6960 \begin_layout Standard
6961 The iopart package provides a document class to create electronic manuscript
6962 submission to the journals published by the Institute of Physics.
6963 Instructions for the authors how to create a paper using the iopart class
6964 can be downloaded together with the iopart package from the site
6965 \begin_inset Flex URL
6968 \begin_layout Plain Layout
6970 ftp://ftp.iop.org/pub/journals/latex2e
6978 \begin_layout Subsection
6982 \begin_layout Standard
6983 The easiest way to write a paper is to start with the file
6987 that is available in LyX's examples files folder.
6988 Open this file, save it under a new name, and start writing.
6989 The example file explains how to use the special text environments.
6990 Here are the most important advices:
6993 \begin_layout Itemize
6994 To be able to compile your document to a PDF, PS, or DVI, assure that the
6997 Use AMS math package
6999 in the document settings under
7006 \begin_layout Itemize
7009 The title environment defines the kind of your paper.
7010 So use one of the following environments for the title:
7014 \begin_layout Itemize
7023 \begin_layout Itemize
7032 \begin_layout Itemize
7038 for a Topical review
7041 \begin_layout Itemize
7050 \begin_layout Itemize
7059 \begin_layout Itemize
7065 for a Paper (same as Title)
7068 \begin_layout Itemize
7074 for a Preliminary communication
7077 \begin_layout Itemize
7083 for a Rapid communication
7086 \begin_layout Itemize
7092 for a Letter to the editor
7096 \begin_layout Itemize
7099 All title environments except of
7103 can have an optional short title.
7106 \begin_layout Itemize
7107 There is a general title environment
7111 which is not directly supported by the LyX.
7112 This can be used as ERT when your document doesn't fit into one of the
7116 \begin_layout Standard
7117 For more informations like hints for special table and formula formatting,
7118 look at the IOP author guidelines.
7121 \begin_layout Section
7125 \begin_layout Standard
7128 Panayotis Papasotiriou
7131 \begin_layout Subsection
7135 \begin_layout Standard
7136 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7137 that facilitates electronic manuscript submission to the journals they
7139 Most known of them (at least in my domain of interest) are
7141 Astrophysics and Space Science
7147 , but there are many others (see a complete list at
7148 \begin_inset Flex URL
7151 \begin_layout Plain Layout
7153 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7159 The Kluwer package may be downloaded from the site
7160 \begin_inset Flex URL
7163 \begin_layout Plain Layout
7165 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7171 A complete user guide is contained in that package (but it can also be
7172 downloaded separately).
7175 \begin_layout Standard
7176 LyX supports many features of the package but not everything.
7177 However, the ERT needed is reduced to some
7178 \begin_inset Quotes eld
7182 \begin_inset Quotes erd
7185 commands of the package (see
7186 \begin_inset space ~
7190 \begin_inset CommandInset ref
7192 reference "subsec:kluwer_peculiarities"
7197 I have recently used LyX to write an article submitted to the
7199 Astrophysics and Space Science
7201 without any problem.
7204 \begin_layout Subsection
7208 \begin_layout Standard
7209 The easiest way to write a paper is to start with the Kluwer template file.
7212 File\SpecialChar \menuseparator
7227 This will give an (almost) empty document that includes the most common
7228 fields found in a manuscript and a short description of their use.
7229 As in most templates, simply overwrite the existing text (including the
7234 ) with the correct information.
7237 \begin_layout Subsection
7238 Preparing a paper for submission
7241 \begin_layout Standard
7242 As in the AASTeX package, before you submit your paper to a journal you
7244 \begin_inset Quotes eld
7248 \begin_inset Quotes erd
7254 \begin_layout Enumerate
7255 Export your paper as a LaTeX file.
7256 To do this, click on
7261 ile\SpecialChar \menuseparator
7266 xport\SpecialChar \menuseparator
7277 \begin_layout Enumerate
7282 file with a text editor and make the following changes
7286 \begin_layout Enumerate
7287 remove the comment lines before the
7296 \begin_layout Enumerate
7297 remove everything between (and including) the
7309 commands, except for any commands you specifically put into the LaTeX preamble.
7312 \begin_layout Standard
7321 \begin_layout Enumerate
7326 file through LaTeX as many times as necessary (usually up to three).
7329 \begin_layout Enumerate
7335 \begin_inset space \thinspace{}
7342 , and check if everything is OK (it should, if you didn't make any mistake).
7345 \begin_layout Subsection
7346 \begin_inset Quotes eld
7350 \begin_inset Quotes erd
7353 of the Kluwer package
7354 \begin_inset CommandInset label
7356 name "subsec:kluwer_peculiarities"
7363 \begin_layout Standard
7364 The Kluwer package has the following
7365 \begin_inset Quotes eld
7369 \begin_inset Quotes erd
7375 \begin_layout Enumerate
7376 It is possible to write multiple articles in the same LaTeX file
7380 \begin_layout Plain Layout
7381 I can't imagine any good reason to do this.
7387 Each article must be included in the environment
7388 \begin_inset Quotes eld
7392 \begin_inset Quotes erd
7396 Unfortunately, this environment cannot be omitted, even if you write just
7398 Therefore, each article starts with the command
7404 and, obviously, ends with the command
7411 Although this can be implemented in LyX, I didn't included it, since it
7412 looks ugly and can confuse the novice user.
7413 Therefore, you need to enter them directly and mark them as LaTeX code
7415 \begin_inset Quotes eld
7419 \begin_inset Quotes erd
7425 \begin_layout Enumerate
7426 Information given at the beginning of the article (i.e., title, subtitle,
7427 author, institution, running title, running author, abstract and keywords)
7428 must be included in an environment called
7429 \begin_inset Quotes eld
7433 \begin_inset Quotes erd
7437 This is not implemented in LyX, so you must enter title, subtitle etc.
7438 \begin_inset space ~
7441 between two ERT lines (
7456 \begin_layout Enumerate
7457 According to the user manual, the label of each bibliography item must be
7481 \begin_layout Standard
7486 template takes care of all these
7487 \begin_inset Quotes eld
7491 \begin_inset Quotes erd
7495 If you start a new paper using this template you don't need to do anything
7500 \begin_layout Enumerate
7501 don't delete the ERT included in the template, and
7504 \begin_layout Enumerate
7505 copy the example bibliography item included in the template and modify it
7506 as necessary to enter new bibliography items.
7509 \begin_layout Section
7513 \begin_layout Standard
7519 \begin_layout Subsection
7523 \begin_layout Standard
7524 The LyX document classes
7526 article (koma-script)
7530 report (koma-script)
7548 correspond to the LaTeX document classes
7565 \begin_inset space ~
7568 of the Koma-Script family.
7569 They are replacements for the standard document classes
7585 , resp., and fit better to European typography conventions in a number of
7589 \begin_layout Itemize
7590 Standard character size is 11pt in
7592 article (koma-script)
7596 report (koma-script)
7604 letter (koma-script)
7609 \begin_layout Itemize
7610 Headings, labels of the description environment, and a number of elements
7613 letter (koma-script)
7615 document class are set in a bold sans serif font.
7619 \begin_layout Plain Layout
7620 There is a big difference between the bold sans serif old cm fonts and new
7621 ec fonts, especially in the appearance of headings.
7622 In comparison, the ec bold sans serif fonts look a bit thin.
7623 Here the LaTeX package
7631 helps to produce the
7632 \begin_inset Quotes eld
7636 \begin_inset Quotes erd
7639 appearance when using the ec fonts.
7644 The numbering of chapter headings is made in the same way as the numbering
7645 of section headings, that is without the extra line
7646 \begin_inset Quotes eld
7649 Chapter\SpecialChar \ldots{}
7651 \begin_inset Quotes erd
7655 In addition, the appearance of the headings can be modified by using a
7656 number of options (in LyX to be entered in the field
7663 \begin_inset space ~
7673 ayout\SpecialChar \menuseparator
7681 A detailed German description of these options can be found in the Koma-Script
7689 \begin_layout Itemize
7690 The main means in the Koma-Script document classes to design the type area
7699 (in LyX to be entered in the extra class options field in the dialog
7704 ocument\SpecialChar \menuseparator
7712 They make a clearer modification of page margins possible as do the options
7718 ocument\SpecialChar \menuseparator
7726 A detailed German description of these and other type area options can
7727 be found in the Koma-Script documentation
7734 \begin_layout Itemize
7735 The LaTeX document classes of the Koma-Script family define a number of
7736 additional commands.
7737 Those part of it which makes sense in LyX is implemented in corresponding
7741 \begin_layout Standard
7742 A detailed German description of the LaTeX document classes of the Koma-Script
7743 family can be found in the Koma-Script documentation
7751 \begin_layout Plain Layout
7752 There is an English translation
7756 , but it is not a complete one.
7761 The following sections describe only those aspects, which are relevant
7765 \begin_layout Subsection
7766 article (koma-script), report (koma-script), and book (koma-script)
7769 \begin_layout Standard
7770 The document classes
7772 article (koma-script)
7776 report (koma-script)
7786 are implemented in the layout files
7799 They contain all the paragraph types of the corresponding standard document
7812 , resp., partly modified, with the exception of the LyX specific
7816 -type, which is replaced by the new
7820 -type having the same functionality.
7825 -Type there is a number of new paragraph types added.
7832 letter (koma-script)
7837 \begin_layout Itemize
7846 : are equivalents to
7854 , resp., additionally inserting an entry in the table of contents.
7863 are not contained in
7865 article (koma-script)
7870 \begin_layout Itemize
7887 , resp., additionally clearing running heads.
7894 article (koma-script)
7900 \begin_layout Plain Layout
7913 report (koma-script)
7915 , but since this is identical to
7919 , is has not been implemented in LyX.
7927 \begin_layout Itemize
7932 : generates a heading directly above the following paragraph in the standard
7933 character size without affecting the structure of the document.
7936 \begin_layout Itemize
7945 are special captions which respect the different space settings needed
7946 for captions placed above or below an element (if you follow strict typographic
7947 rules, you might want to place table captions always above the table).
7948 You can also use the class option
7965 You need at least Koma-Script version 2.8q to use this.
7968 \begin_layout Itemize
7973 : can be used to set a bonmot, e.
7974 \begin_inset space \thinspace{}
7978 \begin_inset space ~
7981 at the beginning of a chapter.
7982 If you use the optional argument (
7987 nsert\SpecialChar \menuseparator
7989 \begin_inset space ~
7994 ), you can insert the dictum's author there.
7995 Dictum and author are separated by a line.
7996 You need at least Koma-Script version 2.8q to use this.
8003 article (koma-script)
8008 \begin_layout Standard
8009 The following types, together with the standard types
8021 , form the title area of the document.
8022 They must be entered ahead of the first
8023 \begin_inset Quotes eld
8027 \begin_inset Quotes erd
8034 \begin_layout Plain Layout
8035 The corresponding LaTeX commands must appear before the
8046 When such a type is used more than once, the latter usage overwrites the
8047 former one, that means, for every type only the latest usage is valid.
8048 The order of the different types however has, like
8060 , no effect on the appearance of the produced document.
8063 \begin_layout Itemize
8068 : produces a centered paragraph above the ordinary title (
8080 ) for the subject of the document.
8083 \begin_layout Itemize
8088 : produces a centered paragraph below the ordinary title (
8100 ) for the publishers' name.
8103 \begin_layout Itemize
8110 report (koma-script)
8116 produces a centered paragraph on its own page behind the title page, or
8119 article (koma-script)
8121 produces a centered paragraph below the ordinary title (
8140 \begin_layout Itemize
8145 : produces a left aligned paragraph above the ordinary title (
8161 ) for a document`s head.
8164 \begin_layout Itemize
8169 : produces in a double-sided print in
8171 report (koma-script)
8177 a left-aligned paragraph at the top of the title page`s back or has no
8178 effect in a single-sided print or in
8180 article (koma-script)
8185 \begin_layout Itemize
8190 : produces in a double-sided print in
8192 report (koma-script)
8198 a left-aligned paragraph at the bottom of the title page`s back or has
8199 no effect in a single-sided print or in
8201 article (koma-script)
8206 \begin_layout Itemize
8211 : produces a special
8212 \begin_inset Quotes eld
8216 \begin_inset Quotes erd
8219 page ahead of the actual document containing a paragraph without special
8223 \begin_layout Standard
8224 The layout files for the document classes
8226 article (koma-script)
8230 report (koma-script)
8241 This is thought of as a place to define your own types.
8246 in your personal layout directory and edit the file!
8249 \begin_layout Subsection
8250 letter (koma-script)
8253 \begin_layout Standard
8257 \begin_layout Plain Layout
8269 \begin_layout Standard
8273 letter (koma-script)
8275 is implemented in the layout file
8280 It contains all the paragraph types of the corresponding standard document
8285 , partly modified, with the exception of the LyX specific types
8297 type, which is replaced by the new
8302 In addition, it contains, in contrast to the standard document class, the
8320 Furthermore, there are a number of new letter specific types.
8323 \begin_layout Standard
8327 \begin_layout Plain Layout
8339 \begin_layout Standard
8340 The appearance of the letter produced by this document class can be controlled
8341 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8345 \begin_layout Plain Layout
8346 For example, the standard appearance of the letter`s heading, consisting
8347 of name and address, is quite self-willed.
8349 \begin_inset Quotes eld
8353 \begin_inset Quotes erd
8356 heading is produced by the following LaTeX commands in the preamble:
8359 \begin_layout LyX-Code
8369 \begin_layout LyX-Code
8385 \begin_layout LyX-Code
8395 \begin_layout LyX-Code
8415 A detailed German description of such LaTeX commands can be found in the
8416 Koma-Script documentation
8421 With it, the letter's author can produce his personal letter layout.
8424 \begin_layout Standard
8433 define the beginning of the letter and must be used in every letter.
8434 To emphasize them in the LyX document class, they are marked with the letter
8444 \begin_inset space ~
8448 It is possible to write any number of letters in one file.
8453 type produces a new letter using the same addressee and a
8457 type produces a new addressee.
8474 are ordinary paragraph types and can also be used several times in one
8475 and the same letter.
8478 \begin_layout Itemize
8483 : produces a paragraph for the addressee and implicitly defines the beginning
8487 \begin_layout Itemize
8492 : produces a paragraph for the form of address and implicitly produces a
8496 \begin_layout Itemize
8501 : produces a paragraph for a close.
8504 \begin_layout Itemize
8509 : produces a paragraph for a postscript.
8512 \begin_layout Itemize
8517 : produces a paragraph for a distribution list.
8520 \begin_layout Itemize
8525 : produces a paragraph for enclosures.
8528 \begin_layout Standard
8569 are input types provided with a label to enter information, which will
8570 be processed by the document class.
8574 \begin_layout Plain Layout
8575 It could be seen as a matter of inconsequence, that the types
8583 described above are not such input types as well.
8584 Because of the special meaning of those types, however, I have implemented
8585 them as ordinary paragraph types with a one letter mark in the left margin.
8586 Moreover, it would affect my feeling of symmetry, if the
8594 type had such a serious different appearance.
8599 The types must be used ahead of the corresponding
8606 \begin_layout Standard
8607 An implementation of these types in a WYSIWYG fashion does not seem to make
8608 sense, because the real appearance of the produced letter does not only
8609 depend on the usage of the particular type, but also on other factors.
8610 For example, a signature entered in the
8614 type will in the standard behavior appear in the produced letter only,
8615 when in the same letter also a
8620 The entered value of the
8624 type will in the standard behavior not appear in the produced letter at
8626 The possibility to design the letter`s heading freely is already indicated
8627 in a footnote above.
8630 \begin_layout Standard
8631 The input types can also be used as empty paragraphs.
8633 \begin_inset space \thinspace{}
8637 \begin_inset space ~
8649 type is not used at all, in the standard behavior the value of the
8653 type is used as signature, whereas if an empty
8657 type is used, no signature value is defined.
8660 \begin_layout Standard
8661 By using the input types it is possible to write a letter template, containing
8662 filled input types with your personal dates (name, address, etc.) and empty
8663 input types for other dates you want to enter.
8666 \begin_layout Itemize
8671 : sender's name, in the standard behavior appears as a centered paragraph
8672 in small caps in the letter`s heading.
8675 \begin_layout Itemize
8680 : sender's signature, in the standard behavior appears below the
8689 type is used, the value of the
8693 type appears instead.
8696 \begin_layout Itemize
8701 : sender's address, in the standard behavior appears in a centered paragraph
8702 in the letter`s heading below the sender's name.
8705 \begin_layout Itemize
8710 : sender's telephone number, in the standard behavior only sets the LaTeX
8720 \begin_layout Itemize
8725 : place of the letter`s making.
8728 \begin_layout Itemize
8733 : date of the letter`s making.
8742 , in the standard behavior, produce the place and the date in a right-aligned
8743 line below the addressee's field.
8748 type is used, neither place nor date appear, independent of the value of
8758 type is used, the date of the letter `s production is used.
8761 \begin_layout Itemize
8766 : sender`s back address, in the standard behavior appears above the addressee's
8767 field in a small sans serif font.
8770 \begin_layout Itemize
8775 : special mail information, in the standard behavior appears underlined
8776 above the addressee's field below the back address.
8779 \begin_layout Itemize
8784 : additional information, in the standard behavior appears on right side
8785 below the addressee`s field.
8788 \begin_layout Itemize
8793 : the letter's title, in the standard behavior appears in a big, bold, sans
8794 serif font above the subject.
8797 \begin_layout Itemize
8802 : the letter's subject, in the standard behavior appears in a bold font
8810 \begin_layout Standard
8831 produce a business letter like line above the
8835 line containing the fields
8836 \begin_inset Quotes eld
8840 \begin_inset Quotes erd
8844 \begin_inset Quotes eld
8848 \begin_inset Quotes erd
8852 \begin_inset Quotes eld
8856 \begin_inset Quotes erd
8860 \begin_inset Quotes eld
8864 \begin_inset Quotes erd
8868 \begin_inset Quotes eld
8872 \begin_inset Quotes erd
8876 \begin_inset Quotes eld
8880 \begin_inset Quotes erd
8884 For the date field, the value of the
8890 \begin_inset Quotes eld
8893 business letter types
8894 \begin_inset Quotes erd
8897 is used, the value of the
8901 type however does not appear, but only the LaTeX variable
8908 The ordinary output of place and date in a right-aligned line below the
8909 addressee`s field is suppressed.
8910 The types are implemented as input types provided with a label and must
8911 be used ahead of the corresponding
8918 \begin_layout Itemize
8926 \begin_layout Itemize
8934 \begin_layout Itemize
8942 \begin_layout Itemize
8950 \begin_layout Itemize
8958 \begin_layout Subsection
8959 The new letter class: letter (koma-script v.2)
8962 \begin_layout Standard
8965 Jürgen Spitzmüller
8968 \begin_layout Standard
8969 \begin_inset VSpace medskip
8975 \begin_layout Standard
8977 Koma-Script version 2.8 has introduced a new letter class
8981 which supersedes the now unsupported
8986 It has --- on the LaTeX side --- a completely new interface and is not
8987 compatible with the old class.
8988 Therefore, LyX supports both, though it is recommended to use the new class.
8991 \begin_layout Standard
8992 This class covers the same functionality as
8994 letter (koma-script),
9001 (receiver's address, same as
9018 will start a new letter (i.
9019 \begin_inset space \thinspace{}
9023 \begin_inset space ~
9026 you can write several letters per document).
9027 New elements are sender's
9043 and the possibility to use a
9052 nsert\SpecialChar \menuseparator
9062 \begin_layout Standard
9063 The biggest improvement is, though, that the letter's layout is configurable
9064 at almost any needs.
9065 This can be done via the preamble or with a special style file (Letter
9066 Class Option, extension
9070 ), that will be read in as a class option.
9074 \begin_layout Plain Layout
9075 The KOMA package comes with some default
9080 There is, for instance, a
9084 file that follows german typesetting rules, or a
9088 that provides the default layout of the old
9093 The latter can be loaded with the class option
9102 ayout\SpecialChar \menuseparator
9107 ocument\SpecialChar \menuseparator
9119 template that is included in LyX for examples.
9120 A detailed description is to be found in the Koma-Script documentation
9128 \begin_layout Subsection
9132 \begin_layout Standard
9133 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9137 \begin_layout Itemize
9138 The chapter number of a
9142 type appears on a line of its own above the chapter heading instead of
9143 appearing in the same line ahead of it.
9144 The cause for that is the LyX internal behavior for the labeltype
9151 \begin_layout Itemize
9152 The headings of the types
9161 \begin_inset Quotes eld
9165 \begin_inset Quotes erd
9168 LaTeX table of contents, but not in the LyX table of contents (
9173 ocument\SpecialChar \menuseparator
9179 \begin_inset space ~
9183 \begin_inset space ~
9191 \begin_layout Itemize
9196 document class appear in a skip separation mode, not indented.
9197 This is the standard behavior, no special LaTeX commands are needed for
9204 ocument\SpecialChar \menuseparator
9211 dialog the corresponding radio button indicates
9227 value always has the effect that extra LaTeX commands are inserted in the
9228 document to produce the gap, which is not what is wanted in this case.
9231 \begin_layout Section
9239 \begin_layout Standard
9245 \begin_layout Subsection
9249 \begin_layout Standard
9250 These are the layout files for some of the journal formats used by Springer
9251 Verlag and listed on
9252 \begin_inset Flex URL
9255 \begin_layout Plain Layout
9257 http://www.springer.de/author/tex/help-journals.html
9262 , where you should also go to fetch the class files (yes, these are LaTeX2e
9264 It is a modular system: the things common to all journals are implemented
9269 , which journal-specific layout files (such as, e.
9270 \begin_inset space \thinspace{}
9277 for Journal of Geodesy) can include.
9280 \begin_layout Standard
9281 This means that implementing support for any other Springer journal on this
9282 list is as simple as writing your own
9290 file following the outline given in
9298 \begin_layout Standard
9299 It is reasonably well tested only for the Journal of Geodesy.
9308 come with the standard LyX distribution.
9309 Install the relevant class file (downloaded from Springer) in a proper
9310 directory, reconfigure LaTeX (in the teTeX case by running
9314 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9315 LyX and it should work.
9318 \begin_layout Subsection
9322 \begin_layout Standard
9323 A large number of theorem-like styles ---
9329 \SpecialChar \ldots{}
9335 \begin_layout Standard
9338 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9339 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9342 See the Springer class file documentation for details.
9345 \begin_layout Subsection
9349 \begin_layout Itemize
9361 \begin_layout Itemize
9364 Probability Theory and Related Fields
9370 --- Jean-Marc Lasgouttes
9373 \begin_layout Standard
9374 Add your own, it isn't so hard!
9377 \begin_layout Subsection
9381 \begin_layout Standard
9382 These files are partly based on the older
9386 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9392 layout, are now defunct.
9393 Jean-Marc Lasgouttes helped out big in making me find my way around the
9394 LyX layout file mechanism.
9397 \begin_layout Subsection
9401 \begin_layout Standard
9403 But probably less than in the old hacked-LaTeX
9410 \begin_layout Standard
9412 \begin_inset space \thinspace{}
9415 g.: does not display the number for theorem-like layouts, just #.
9418 \begin_layout Section
9426 \begin_layout Standard
9432 \begin_layout Subsection
9436 \begin_layout Standard
9437 These are the layout files for some of the journals of the American Geophysical
9439 It is assumed that you have both the AGU's own class files and AGUplus
9440 installed (everything to be found at
9441 \begin_inset Flex URL
9444 \begin_layout Plain Layout
9446 ftp://ftp.agu.org/journals/latex/journals
9454 \begin_layout Subsection
9458 \begin_layout Standard
9468 They are still called this in the LyX GUI, though their LaTeX equivalents
9469 in the AGU classes are
9480 \begin_layout Standard
9481 Newly defined styles are
9518 These are mostly manuscript attributes and defined in the AGU class documentati
9522 \begin_layout Standard
9523 I suspect this is still badly incomplete.
9526 \begin_layout Subsection
9530 \begin_layout Standard
9547 \begin_layout Subsection
9551 \begin_layout Itemize
9554 Journal of Geophysical Research
9563 \begin_layout Standard
9564 Add your own, it isn't so hard! Look at the
9575 \begin_layout Subsection
9576 Bugs and things to remember
9579 \begin_layout Standard
9580 In order to use the new layouts, you must remember to do the following for
9584 \begin_layout Enumerate
9590 This can be done in the
9592 layout\SpecialChar \menuseparator
9597 document\SpecialChar \menuseparator
9601 (AGU articles are always in English, right? So
9608 \begin_layout Enumerate
9618 (Yes, this is a bug.)
9621 \begin_layout Enumerate
9622 Make sure you use the
9626 bibliography style, by entering
9630 into the second field of the BibTeX inset.
9631 None of the standard styles will do.
9634 \begin_layout Section
9642 \begin_layout Standard
9648 \begin_layout Subsection
9652 \begin_layout Standard
9653 This is the layout file for the European Geophysical Society journals.
9658 can be downloaded from the web site of the EGS under
9659 \begin_inset Flex URL
9662 \begin_layout Plain Layout
9672 \begin_layout Subsection
9676 \begin_layout Standard
9679 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9687 The current layout file is unfortunately very unmodular and would benefit
9688 from using the various
9695 \begin_layout Section
9701 \begin_inset CommandInset label
9710 \begin_layout Standard
9718 \begin_layout Subsection
9722 \begin_layout Standard
9723 This section describes how to use LyX to make slides for overhead projectors.
9724 There are two document classes that can do this: the default slides class
9730 This section documents the former.
9733 \begin_layout Standard
9734 I'm going to say this again, nice and clear, so that there's no misunderstanding
9738 \begin_layout Standard
9739 \begin_inset VSpace bigskip
9745 \begin_layout Standard
9749 This section documents the class
9750 \begin_inset Quotes eld
9758 \begin_inset Quotes erd
9766 \begin_layout Standard
9767 \begin_inset VSpace bigskip
9773 \begin_layout Standard
9774 If you're looking for the documentation for
9775 \begin_inset Quotes eld
9783 \begin_inset Quotes erd
9787 \begin_inset space ~
9791 \begin_inset CommandInset ref
9793 reference "sec:foiltex"
9803 \begin_inset Quotes eld
9811 \begin_inset Quotes erd
9814 ] is actually somewhat better than the default
9822 \begin_layout Plain Layout
9823 \SpecialChar \ldots{}
9824 or so I've been told repeatedly by its advocates.
9825 Having never used it, I have no idea if this claim is true or not.
9830 which this section documents.
9833 \begin_layout Standard
9834 This class is the LaTeX2e improvement of the old
9839 Every LaTeX2e distribution includes this class [which I'll just refer to
9841 \begin_inset Quotes eld
9849 \begin_inset Quotes erd
9852 from now on], so you're bound to have it.
9853 As I noted earlier, there are other classes, such as
9857 , which also produce slides for overhead projectors and do a better job
9859 However, there are some things which
9863 can do which the others can't, such as generate overlays.
9864 Read on to learn more!
9867 \begin_layout Subsection
9869 \begin_inset CommandInset label
9871 name "sec:slidesetup"
9878 \begin_layout Standard
9879 Obviously, to use this document class, you need to select
9880 \begin_inset Quotes eld
9888 \begin_inset Quotes erd
9891 from the class list in the
9896 ocument\SpecialChar \menuseparator
9904 There are some other special things you should know about this class:
9907 \begin_layout Itemize
9908 Don't bother changing the options
9913 They're not supported by the
9920 \begin_layout Itemize
9927 \begin_inset space ~
9932 behaves a bit differently for this class.
9933 The possible choices and what they do are as follows:
9937 \begin_layout Description
9942 The final output contains page numbers in the lower right corner.
9945 \begin_layout Description
9954 , but also prints out any time markers you've put in.
9955 This is the default.
9958 \begin_layout Description
9963 The final output contains no page numbers, time markers, or alignment markers.
9967 \begin_layout Itemize
9972 class has an extra option:
9978 \begin_inset Quotes eld
9986 \begin_inset Quotes erd
9989 in the extra class options.
9993 \begin_layout Standard
9994 Using this options allows you to add time markers to
10000 \begin_inset space ~
10004 \begin_inset CommandInset ref
10006 reference "sec:slideNote"
10014 \begin_layout Standard
10015 You can also use the template file
10016 \begin_inset Quotes eld
10024 \begin_inset Quotes erd
10027 to automatically set up a document to use the
10036 ile\SpecialChar \menuseparator
10038 \begin_inset space ~
10042 \begin_inset space ~
10051 to open your new document].
10052 The template file also contains some examples of the special paragraph
10053 environments used by this class.
10054 I'll describe those next.
10057 \begin_layout Subsection
10058 Paragraph Environments
10061 \begin_layout Subsubsection
10062 Supported Environments
10065 \begin_layout Standard
10066 The first thing you'll notice when you start up a new
10070 document is the font size and type: it's the equivalent of the size
10071 \begin_inset Quotes eld
10079 \begin_inset Quotes erd
10085 \begin_inset space ~
10091 This is also what's used in the output.
10093 \begin_inset Quotes eld
10097 \begin_inset Quotes erd
10100 to remind you that this is a slide.
10101 Your final slides will use a larger font; ergo, you'll have less space.
10102 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10105 \begin_layout Standard
10106 The next thing that becomes obvious is the changes to the paragraph environment
10107 pull-down box [at the far-left end of the toolbar].
10108 Most of the paragraph environments you're used to seeing are missing.
10109 There are also five new ones.
10114 class itself only supports certain paragraph environments:
10117 \begin_layout Itemize
10123 \begin_layout Itemize
10129 \begin_layout Itemize
10135 \begin_layout Itemize
10141 \begin_layout Itemize
10147 \begin_layout Itemize
10153 \begin_layout Itemize
10159 \begin_layout Itemize
10165 \begin_layout Itemize
10171 \begin_layout Itemize
10177 \begin_layout Itemize
10183 \begin_layout Standard
10184 All of the other standard environments, including the section-heading environmen
10185 ts, aren't used in the
10192 \begin_layout Standard
10193 On the other hand, you'll notice the following new environments:
10196 \begin_layout Itemize
10202 \begin_layout Itemize
10208 \begin_layout Itemize
10214 \begin_layout Itemize
10220 \begin_layout Itemize
10226 \begin_layout Standard
10227 These five are kind of quirky, due to a
10228 \begin_inset Quotes eld
10232 \begin_inset Quotes erd
10236 You see, LyX doesn't permit you to nest any other paragraph environment
10237 into an empty environment.
10238 Now, that's fine and dandy, but it means that you wouldn't be able to start
10239 a slide with anything except plain text.
10240 To deal with this, I've performed a little
10241 \begin_inset Quotes eld
10245 \begin_inset Quotes erd
10251 \begin_layout Subsubsection
10252 Quirks of the New Environments
10253 \begin_inset CommandInset label
10255 name "sec:slideQuirk"
10262 \begin_layout Standard
10263 All five of the new paragraph environments are somewhat quirky due to inherent
10264 limitiations in the current version of LyX.
10265 As I just mentioned, LyX forbids environments that begin with another environme
10267 To get around this, the
10271 environment isn't a paragraph environment as described in the
10279 \begin_layout Standard
10280 You should consider
10293 \begin_inset Quotes eld
10296 pseudo-environments.
10297 \begin_inset Quotes erd
10300 They look like a section heading or a
10301 \begin_inset Quotes eld
10309 \begin_inset Quotes erd
10312 but really begin a [and, if necessary, end the previous] paragraph environment.
10322 \begin_inset Quotes eld
10326 \begin_inset Quotes erd
10329 These two perform some action.
10332 \begin_layout Standard
10333 A common feature of all five environments,
10353 , is a rather long-ish label.
10354 The text following this label --- ordinarily the contents of the paragraph
10355 environment --- is utterly irrelevant for
10376 LyX completely ignores it.
10377 In fact, you can leave these five environments completely empty.
10381 \begin_layout Standard
10386 to put any text after the rather long-ish label, you might want to.
10387 This could be a short description of the contents of the
10392 In that case, enter in your descriptive comment and hit
10396 as you normally would.
10399 \begin_layout Standard
10400 If, on the other hand, you don't want to enter in any descriptive text,
10401 you'll hit another LyX quirk.
10402 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10403 environment until you put something in the old one.
10407 \begin_layout Itemize
10408 Start entering the text that will
10436 \begin_layout Itemize
10437 Now move to the beginning of that paragraph.
10441 \begin_layout Itemize
10450 \begin_layout Itemize
10451 Finally, change this new, empty paragraph to a
10475 \begin_layout Standard
10476 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10480 \begin_layout Subsection
10481 Making a Presentation with
10494 \begin_layout Subsubsection
10502 \begin_layout Standard
10503 If you're expecting this section to teach you how to actually make a presentatio
10504 n, you'll be sorely disappointed.
10505 Naturally, I'll describe all of the ways the
10509 class can assist you in preparing the materials for a presentation.
10510 Filling in the contents, however, is up to you.
10515 the LyX philosophy.]
10518 \begin_layout Standard
10523 environment [in the manner described in section
10524 \begin_inset space ~
10528 \begin_inset CommandInset ref
10530 reference "sec:slideQuirk"
10534 ] tells LyX to begin a new slide [duh].
10535 The label for this environment/
10536 \begin_inset Quotes erd
10540 \begin_inset Quotes erd
10544 \begin_inset Quotes eld
10548 \begin_inset Quotes erd
10551 in cool blue, followed by the label,
10552 \begin_inset Quotes eld
10556 \begin_inset Quotes erd
10560 Any text or paragraph environments that follow this one go on the new slide.
10564 \begin_layout Standard
10565 Slides are probably the only time you'll need to forcibly end pages in LyX
10566 (this can be specified in the
10571 In fact, you'll want to, once you finish entering the contents of one slide.
10572 If you've entered more text than can physically fit on a slide, the extra
10573 overflows onto a new slide.
10574 I don't recommend doing this, however, since the overflow slide won't have
10575 any page number on it.
10576 Furthermore, it may interfere with any
10580 you've made to accompany the oversized
10587 \begin_layout Standard
10596 environments work the same way as the
10601 They both create an
10602 \begin_inset Quotes eld
10606 \begin_inset Quotes erd
10609 followed by a label [
10610 \begin_inset Quotes eld
10614 \begin_inset Quotes erd
10618 \begin_inset Quotes eld
10622 \begin_inset Quotes erd
10626 The color is a stunning magenta instead of blue, and the
10627 \begin_inset Quotes eld
10631 \begin_inset Quotes erd
10634 will look different, in style and in length.
10635 The label fonts of all three also differ from one another.
10638 \begin_layout Standard
10643 , if the contents of a
10651 exceed the physical size of a slide or sheet of paper, the extra will overflow
10653 Again, you should avoid this.
10654 It defeats the whole purpose of
10665 \begin_layout Subsubsection
10675 \begin_layout Standard
10680 is a slide that sits atop another slide.
10681 Perhaps you wish to discuss a figure on the main
10685 before displaying the text associated with it.
10686 One way to accomplish this is tape a flap of dark paper over the part of
10691 you want to display later.
10692 This method fails, however, if you wish to overlap one graph with another,
10694 You would then have to fumble while speaking to align the two separate,
10699 s to align the two graphs.
10704 environment in both cases makes life much easier.
10707 \begin_layout Standard
10712 receives the page number of its
10713 \begin_inset Quotes eld
10717 \begin_inset Quotes erd
10725 \begin_inset Quotes eld
10733 \begin_inset Quotes erd
10740 \begin_layout Plain Layout
10741 Presumably, mutliple
10746 \begin_inset Quotes eld
10754 \begin_inset Quotes erd
10758 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10770 \begin_inset Quotes eld
10778 \begin_inset Quotes erd
10782 \begin_inset space ~
10785 appended to the page number of the parent
10795 Clearly, you want the contents of both the
10803 to each fit on a single physical slide! You should probably consider an
10809 \begin_inset Quotes eld
10813 \begin_inset Quotes erd
10825 class provides a visual cue for this: the label at the start of an
10829 is shorter than that at the start of a
10834 Lastly, when you generate printable output, you'll find alignment markers
10835 in all four corners of both the
10839 page and its parent
10844 These will assist you in lining up the two physical slides.
10847 \begin_layout Standard
10848 The major problem in overlaying two slides is aligning the contents of the
10849 two transparencies.
10850 How much space should you leave for that graph on the second slide? Worse
10851 still, what if you want a graph and a sentence on second slide, but there
10852 is text on the main transparency that goes in between them? You could try
10853 and insert vertical space of the right size.
10854 The better way is to use
10865 \begin_layout Standard
10866 As their names imply,
10874 are two command-like paragraph environments that make all subsequent text
10875 invisible and visible, respectively.
10877 \begin_inset space ~
10881 \begin_inset CommandInset ref
10883 reference "sec:slideQuirk"
10887 that you don't place anything
10891 these two environments, however.
10896 , it inserts a centered, sky-blue label into the page reading
10897 \begin_inset Quotes eld
10900 <Invisible Text Follows>
10901 \begin_inset Quotes erd
10905 For paragraphs following this label, the parts of the
10913 ; it doesn't matter which] where they would be contain instead blank space.
10917 \begin_layout Standard
10922 , the corresponding centered label is
10923 \begin_inset Quotes eld
10926 <Visible Text Follows>
10927 \begin_inset Quotes erd
10931 Paragraphs following this label behave normally.
10932 Note that the beginning of a new
10944 automatically shuts off an
10949 It's therefore not necessary to use
10960 \begin_layout Standard
10961 By now, it should be obvious how to create overlay transparencies using
10962 the proper combination of
10981 \begin_layout Enumerate
10986 , including everything that will appear on it, whether on the main slide
10994 \begin_layout Enumerate
10995 Before each figure or paragraph that will appear only on the
11004 If necessary, insert a
11008 environment after the
11015 \begin_layout Enumerate
11020 immediately following the
11027 \begin_layout Enumerate
11028 Copy the contents of this
11039 \begin_layout Enumerate
11044 , change all of the
11055 \begin_layout Standard
11057 You've just made an
11064 \begin_layout Standard
11065 There's one problem with the way I've designed the LyX
11069 class: you can't make text in the middle of a paragraph invisible, nor
11070 make text in the middle of an invisible paragraph visible again.
11071 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11075 \begin_layout Plain Layout
11076 The commands of interest are:
11079 \begin_layout Itemize
11084 invisible \SpecialChar \ldots{}
11088 \begin_layout Itemize
11093 visible \SpecialChar \ldots{}
11097 \begin_layout Plain Layout
11098 \SpecialChar \ldots{}
11099 and need to be marked as TeX.
11101 \begin_inset Quotes eld
11105 \begin_inset Quotes erd
11108 you wish to change goes in between the brackets [and after the
11121 If you don't know how to mark text as TeX, see the appropriate section
11134 \begin_layout Subsubsection
11144 \begin_inset CommandInset label
11146 name "sec:slideNote"
11153 \begin_layout Standard
11162 is associated with a
11163 \begin_inset Quotes eld
11167 \begin_inset Quotes erd
11179 class provides visual cues.
11184 is shorter than that of a
11188 [yet longer than that of an
11192 ] and, like the label of an
11196 is shockingly magenta.
11197 Additionally, the printed
11201 has the page number of its
11202 \begin_inset Quotes eld
11206 \begin_inset Quotes erd
11214 \begin_inset Quotes eld
11222 \begin_inset Quotes erd
11226 \begin_inset Quotes eld
11234 \begin_inset Quotes erd
11238 \begin_inset Quotes eld
11246 \begin_inset Quotes erd
11250 You can have multiple
11254 s associated with a single
11266 , you'll probably want to break up long
11270 s so that they fit on a single sheet of paper.
11273 \begin_layout Standard
11278 is obvious: it contains anything additional you might want to say about
11284 It could also be used as a sheet of reminders for a particular
11289 In the case of the latter, you might want to make use of time markers.
11295 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11302 support for time markers, a
11307 So, you'll have to resort to using the LaTeX codes.
11310 \begin_layout Standard
11311 To use time markers, you'll need to specify the extra class option
11312 \begin_inset Quotes eld
11320 \begin_inset Quotes erd
11324 \begin_inset space ~
11328 \begin_inset CommandInset ref
11330 reference "sec:slidesetup"
11335 This option turns on timing marks, which will appear in the lower-left-hand
11341 To set what appears in the time marker, you use the LaTeX commands
11342 \begin_inset Quotes eld
11352 \begin_inset Quotes erd
11356 \begin_inset Quotes eld
11366 \begin_inset Quotes erd
11370 The arguments of both commands are time measured in seconds.
11372 \begin_inset Quotes eld
11382 \begin_inset Quotes erd
11385 sets the time marker to a given time.
11387 \begin_inset Quotes eld
11397 \begin_inset Quotes erd
11400 increments the time marker by the specified amount.
11401 Using time markers and
11405 s in this fashion, you can remind yourself how much time to spend on a particula
11413 \begin_layout Standard
11414 There's one last feature to describe.
11415 Clearly, you'd like to print out all of your
11423 s on transparencies while printing all of your
11440 with which it is associated.
11441 What's a person to do?
11444 \begin_layout Standard
11445 Luckily, there are two LaTeX commands that allow you to select what to print
11447 Both must be placed into the preamble of your document.
11449 \begin_inset Quotes eld
11461 \begin_inset Quotes erd
11464 will cause the output to contain only the
11473 Correspondingly, the command
11474 \begin_inset Quotes eld
11486 \begin_inset Quotes erd
11489 prevents the output of anything but
11494 I'd advise placing both commands in the preamble and initially comment
11496 You can then preview your entire presentation as you write.
11497 When you're done writing, you can then uncomment one of the two to select
11498 what you want to print.
11499 I like to uncomment
11500 \begin_inset Quotes eld
11512 \begin_inset Quotes erd
11515 , print to a file with
11516 \begin_inset Quotes eld
11524 \begin_inset Quotes erd
11527 in its name, comment it back out, then uncomment
11528 \begin_inset Quotes eld
11540 \begin_inset Quotes erd
11544 \begin_inset Quotes eld
11552 \begin_inset Quotes erd
11556 I can then send either file to a printer, loading transparencies or plain
11557 paper as appropriate.
11560 \begin_layout Standard
11561 You can also provide other arguments to the
11562 \begin_inset Quotes eld
11572 \begin_inset Quotes erd
11576 \begin_inset Quotes eld
11586 \begin_inset Quotes erd
11590 See a good LaTeX book for details.
11593 \begin_layout Subsection
11598 Class Template File
11601 \begin_layout Standard
11602 I have also provided a template file,
11603 \begin_inset Quotes eld
11611 \begin_inset Quotes erd
11619 To use it, begin your new presentation with
11624 ile\SpecialChar \menuseparator
11626 \begin_inset space ~
11630 \begin_inset space ~
11640 Your new LyX presentation file will contain an example
11661 additionally contain an example of the use of
11670 Lastly, the preamble will contain:
11673 \begin_layout LyX-Code
11674 % Uncomment to print out only slides and overlays
11677 \begin_layout LyX-Code
11681 \begin_layout LyX-Code
11687 \begin_inset Newline newline
11693 \begin_layout LyX-Code
11694 % Uncomment to print out only notes
11697 \begin_layout LyX-Code
11701 \begin_layout LyX-Code
11709 \begin_layout Standard
11710 One final thing: I created this class to support the LaTeX2e
11711 \begin_inset Quotes eld
11719 \begin_inset Quotes erd
11722 class, one of the built-in LaTeX2e classes.
11723 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11724 built-in slide class.
11725 It's here if you want it or need it.
11726 There exist other LaTeX2e classes for creating presentations, such as the
11732 \begin_inset space ~
11736 \begin_inset CommandInset ref
11738 reference "sec:foiltex"
11743 \begin_inset Quotes eld
11751 \begin_inset Quotes erd
11754 package [present on some TeX distributions].
11755 The latter is not yet supported under LyX.
11759 \begin_layout Plain Layout
11760 Perhaps you can take on the task\SpecialChar \ldots{}
11766 I know nothing about these other classes.
11767 Try them out to see what sort of alternative they provide.
11770 \begin_layout Section
11779 \begin_inset CommandInset label
11788 \begin_layout Standard
11794 \begin_layout Subsection
11798 \begin_layout Standard
11799 This section describes how to use LyX to make slides for overhead projectors.
11800 There are two document classes that can do this: the default slides class
11806 This section documents the latter.
11809 \begin_layout Standard
11810 I'm going to say this again, nice and clear, so that there's no misunderstanding
11814 \begin_layout Standard
11815 \begin_inset VSpace bigskip
11821 \begin_layout Standard
11825 This section documents the class
11826 \begin_inset Quotes eld
11834 \begin_inset Quotes erd
11842 \begin_layout Standard
11843 \begin_inset VSpace bigskip
11849 \begin_layout Standard
11850 If you're looking for the documentation for
11851 \begin_inset Quotes eld
11859 \begin_inset Quotes erd
11862 , check out section
11863 \begin_inset space ~
11867 \begin_inset CommandInset ref
11869 reference "sec:slitex"
11874 If your machine doesn't have the
11879 \begin_inset Quotes eld
11887 \begin_inset Quotes erd
11890 ] installed, you'll probably have to use the default
11894 class, which isn't quite as good as
11899 \begin_layout Standard
11904 class is designed for use with version 2.1 of the
11908 LaTeX class file which is now an integral part of LaTeX2e.
11911 \begin_layout Subsection
11915 \begin_layout Standard
11916 Obviously, to use this document class, you need to select
11917 \begin_inset Quotes eld
11925 \begin_inset Quotes erd
11938 \begin_inset space ~
11944 There are some settings in the
11947 \begin_inset space ~
11952 dialog that you should know about that are specific to this class:
11955 \begin_layout Itemize
11956 Don't change the options
11967 \begin_inset space ~
11973 They're ignored by the
11980 \begin_layout Itemize
11981 The default font size is 20pt with the other options being 17pt, 25pt and
11985 \begin_layout Itemize
11986 The default font is
11994 but all math equations are still typeset in the usual roman font.
11997 \begin_layout Itemize
12002 TeX supports A4 and Letter paper sizes as well as a special size for working
12004 It doesn't support A5, B5, legal or executive paper sizes.
12007 \begin_layout Itemize
12008 Don't bother changing the
12012 settings because they are ignored anyway.
12013 All floats appear where they are defined in the text.
12016 \begin_layout Itemize
12024 setting behaves a bit differently for this class.
12029 TeX provides extensive footer and header capabilities including a user-defined
12032 \begin_inset space ~
12036 \begin_inset CommandInset ref
12038 reference "sec:foilfoot"
12043 The title page is treated differently to all other pages in the document
12052 has the logo centered at the bottom of the page (if one is defined).
12053 The possible page style choices and what they do are as follows:
12057 \begin_layout Labeling
12058 \labelwidthstring MMMMMMM
12065 The final output contains no page numbers, or other headers or footers
12066 (except footnotes of course).
12070 \begin_layout Labeling
12071 \labelwidthstring MMMMMMM
12078 The final output contains page numbers centered at the bottom of the page.
12079 No other headings or footers (other than footnotes).
12082 \begin_layout Labeling
12083 \labelwidthstring MMMMMMM
12088 Page numbers in lower right corner.
12089 Additional headers and footers are also shown.
12090 This is also the default.
12093 \begin_layout Labeling
12094 \labelwidthstring MMMMMMM
12099 Gives you access to the
12103 package although its use with
12107 TeX is discouraged by the writer of the
12111 TeX package because of some potential page layout clashes.
12115 \begin_layout Subsubsection
12119 \begin_layout Standard
12120 The following options may be used in the extra class options in the
12125 ocument\SpecialChar \menuseparator
12135 \begin_layout Labeling
12136 \labelwidthstring MMMMMMx
12141 This sets up the page layout for 7.33in by 11in paper, which is about the
12142 same aspect ratio as a 35mm slide, making it a bit easier to work with
12146 \begin_layout Labeling
12147 \labelwidthstring MMMMMMx
12152 Places a rule across the page below the header on every page except the
12156 \begin_layout Labeling
12157 \labelwidthstring MMMMMMx
12162 Places a rule across the page above the footer on every page except the
12166 \begin_layout Labeling
12167 \labelwidthstring MMMMMMx
12172 This is automatically set each time you create a new
12181 TeX to use the dvips driver to rotate those pages that are set as landscape
12185 \begin_layout Labeling
12186 \labelwidthstring MMMMMMx
12191 Simply changes the page dimensions to those of a landscape page but doesn't
12193 Thus if you use this option you need to use an external program to rotate
12194 each page or feed your paper through your printer as landscape.
12195 Note that this option effectively reverses the roles of the
12203 environments (don't worry these are described in the next section).
12206 \begin_layout Labeling
12207 \labelwidthstring MMMMMMx
12212 Equation numbers on the left.
12215 \begin_layout Labeling
12216 \labelwidthstring MMMMMMx
12221 Flush-left equations.
12224 \begin_layout Subsection
12225 Supported Environments
12228 \begin_layout Standard
12229 Most of the environments commonly supported in other classes are also supported
12235 There are several additional environments provided by
12239 TeX as well as a couple added by LyX.
12240 The following environments are shared with other classes:
12243 \begin_layout Standard
12247 \begin_layout Plain Layout
12251 begin{multicols}{2}
12259 \begin_layout Itemize
12265 \begin_layout Itemize
12271 \begin_layout Itemize
12277 \begin_layout Itemize
12283 \begin_layout Itemize
12289 \begin_layout Itemize
12295 \begin_layout Itemize
12301 \begin_layout Itemize
12307 \begin_layout Itemize
12313 \begin_layout Itemize
12319 \begin_layout Itemize
12325 \begin_layout Itemize
12331 \begin_layout Itemize
12337 \begin_layout Itemize
12343 \begin_layout Itemize
12349 \begin_layout Itemize
12355 \begin_layout Itemize
12361 \begin_layout Itemize
12367 \begin_layout Standard
12371 \begin_layout Plain Layout
12383 \begin_layout Standard
12384 That is, all the major environments apart from the sectioning environments.
12385 Since foils are essentially self-contained sections, with a title and body,
12390 TeX provides specific commands for starting new foils and these are:
12393 \begin_layout Itemize
12399 \begin_layout Itemize
12405 \begin_layout Standard
12406 LyX also provides slightly modified versions of these two environments called:
12409 \begin_layout Itemize
12415 \begin_layout Itemize
12418 ShortRotatefoilhead
12421 \begin_layout Standard
12422 and the differences will be explained in the next section.
12425 \begin_layout Standard
12426 Since foils are often used in presenting ideas or new theorems and such
12431 TeX also provides a comprehensive box of goodies for presenting them:
12434 \begin_layout Standard
12438 \begin_layout Plain Layout
12442 begin{multicols}{2}
12450 \begin_layout Itemize
12456 \begin_layout Itemize
12462 \begin_layout Itemize
12468 \begin_layout Itemize
12474 \begin_layout Itemize
12480 \begin_layout Itemize
12486 \begin_layout Itemize
12492 \begin_layout Itemize
12498 \begin_layout Itemize
12504 \begin_layout Itemize
12510 \begin_layout Itemize
12516 \begin_layout Standard
12520 \begin_layout Plain Layout
12532 \begin_layout Standard
12533 The starred versions are unnumbered while the unstarred versions are numbered.
12534 There are also two list environments added by LyX and these are:
12537 \begin_layout Itemize
12543 \begin_layout Itemize
12549 \begin_layout Standard
12554 TeX provides some powerful header and footer capabilities that are best
12555 set in the preamble although they may be set at any point in a document.
12556 If you want to change these settings in your document the best place to
12557 do so is at the very top of a foil,
12562 straight after the foilhead.
12565 \begin_layout Standard
12566 For this purpose, the following command styles are provided [
12573 \begin_layout Standard
12577 \begin_layout Plain Layout
12581 begin{multicols}{2}
12589 \begin_layout Itemize
12593 \begin_inset space ~
12599 \begin_layout Itemize
12605 \begin_layout Itemize
12609 \begin_inset space ~
12615 \begin_layout Itemize
12619 \begin_inset space ~
12625 \begin_layout Itemize
12629 \begin_inset space ~
12636 \begin_layout Standard
12637 \begin_inset space ~
12644 \begin_layout Standard
12648 \begin_layout Plain Layout
12660 \begin_layout Standard
12661 There are also a few commands provided by
12665 TeX that aren't directly supported by LyX but I'll tell you what they do
12666 and how to use them in section
12667 \begin_inset space ~
12671 \begin_inset CommandInset ref
12673 reference "sec:unsuppfoils"
12680 \begin_layout Subsection
12681 Building a Set of Foils
12684 \begin_layout Standard
12685 This section will give a simple introduction to using the different environments
12686 to build a set of foils.
12687 If you want to see an example set of foils take a look at the
12691 file accessible from the
12696 ile\SpecialChar \menuseparator
12701 pen\SpecialChar \ldots{}
12712 \begin_layout Subsubsection
12713 Give It a Title Page
12716 \begin_layout Standard
12717 Unlike other classes that provide
12737 creates the title on a page of its own.
12738 If you leave out the
12742 environment LaTeX will substitute the current date (every time you regenerate
12746 \begin_layout Subsubsection
12750 \begin_layout Standard
12751 As I mentioned earlier, there are four ways of starting a new foil.
12752 For portrait foils you should use
12761 The difference between these two environments is the amount of space between
12762 the title of the foil (the foilhead) and the body of the foil.
12765 \begin_layout Standard
12766 Landscape foils are generated using the
12772 ShortRotatefoilhead
12775 Again the only difference is the spacing between foilhead and body.
12776 Both of the short versions have 0.5 inches less separation between the foilhead
12781 \begin_layout Standard
12782 One problem with the support for landscape foils is the requirement that
12783 you have to use the
12787 driver to generate the PostScript output otherwise the foils won't be rotated.
12788 It is possible to get landscape foils even if you haven't got the
12792 driver provided you can feed your foils sideways through your printer ;-)
12795 \begin_layout Subsubsection
12796 Theorems, Lemmas, Proofs and more
12799 \begin_layout Standard
12800 Due to a small bug in LyX you can't have two of the same type of these environme
12801 nts directly following each other.
12802 They must be separated by something.
12803 If you try, you will just be extending the previous environment as if you
12804 had merged the two environments together.
12805 So, how do you get around this problem? The simplest option is to insert
12806 some text between the two environments or add a
12810 environment between the two with just a
12811 \begin_inset Quotes eld
12819 \begin_inset Quotes erd
12823 This will force LyX to produce two separate environments and hence the
12824 correct LaTeX output.
12825 An example is provided in the example file included with the LyX distribution.
12826 Remember, this problem only occurs if you are trying to place two of the
12827 same type of theorem-like environments one directly after the other.
12830 \begin_layout Subsubsection
12834 \begin_layout Standard
12835 You get all the commonly supported list styles found in other classes as
12836 well as two new ones.
12837 I'll only describe the new ones here.
12838 If you want to find out more about the other list environments check out
12844 If you intend to use itemized lists you might also want to read about the
12848 \begin_inset space ~
12852 \begin_inset space ~
12857 dialog described above in section
12858 \begin_inset space ~
12862 \begin_inset CommandInset ref
12864 reference "sec:bullet"
12871 \begin_layout Standard
12872 The two new list styles,
12880 , are designed to make it easier for you to create lists of do's and don'ts
12881 or right and wrong by providing dedicated environments that use a tick
12882 or a cross as the label of the list.
12883 These lists are in fact dedicated variants of the
12888 They do however require that you have the
12892 packages installed.
12895 \begin_layout Subsubsection
12899 \begin_layout Standard
12904 TeX redefines the floating tables and figures so that they appear exactly
12905 where they are in the text rather than pushing them to the top of the page
12906 or to some user specified location.
12907 In fact if you change the float placement settings they are simply ignored.
12910 \begin_layout Subsubsection
12911 Page Headers and Footers
12912 \begin_inset CommandInset label
12914 name "sec:foilfoot"
12921 \begin_layout Standard
12925 \begin_inset space ~
12934 are two commands used to control the left-footer text string.
12935 The first is meant to allow you to include a graphic logo on your foils
12937 \begin_inset Quotes eld
12945 \begin_inset Quotes erd
12949 While the second is meant to provide a classification for the audience,
12953 \begin_inset space \thinspace{}
12959 \begin_inset space ~
12963 It is empty by default.
12966 \begin_layout Standard
12967 The remaining page corners can be filled by
12970 \begin_inset space ~
12975 (which defaults to page numbers),
12978 \begin_inset space ~
12986 \begin_inset space ~
12994 \begin_layout Subsection
13000 \begin_inset CommandInset label
13002 name "sec:unsuppfoils"
13009 \begin_layout Standard
13010 All the commands mentioned below need to be set in a
13018 within another environment.
13021 \begin_layout Subsubsection
13025 \begin_layout Standard
13026 All lengths are adjusted using the
13049 should be replaced by the name given to the length you want to change and
13054 is the length value.
13055 All lengths should be specified in units of length such as inches (
13067 ) or relative to some document or font-based length such as
13077 \begin_layout Standard
13078 It's possible to change the spacing between a foilhead and the body of the
13079 foil by adjusting the length specified by
13086 For example, to make
13090 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13097 foilheadskip}{-0.5in}
13100 \begin_layout Standard
13101 The spacings around floats can be adjusted by setting these lengths:
13104 \begin_layout Labeling
13105 \labelwidthstring MMMMMMMMMMM
13112 Separation between the text and the top of the float
13115 \begin_layout Labeling
13116 \labelwidthstring MMMMMMMMMMM
13123 Separation between the float and the caption
13126 \begin_layout Labeling
13127 \labelwidthstring MMMMMMMMMMM
13134 Separation between the caption and the following text
13137 \begin_layout Labeling
13138 \labelwidthstring MMMMMMMMMMM
13145 You can make the captions narrower than the surrounding text by adjusting
13147 Best done relative to
13156 \begin_layout Standard
13157 There are also several title page related lengths that you may find useful
13158 if you have a long title or several authors:
13161 \begin_layout Labeling
13162 \labelwidthstring MMMMMMMMMMM
13169 Separation from headers to
13174 \begin_layout Labeling
13175 \labelwidthstring MMMMMMMMMMM
13193 \begin_layout Labeling
13194 \labelwidthstring MMMMMMMMMMM
13208 \begin_layout Labeling
13209 \labelwidthstring MMMMMMMMMMM
13225 \begin_layout Labeling
13226 \labelwidthstring MMMMMMMMMMM
13242 \begin_layout Standard
13243 The last length related command affects all the list environments.
13254 a list environment then all the vertical spacing between the list items
13256 Note that this is a command not a length so it doesn't require
13262 like the stuff mentioned above.
13265 \begin_layout Subsubsection
13266 Headers and Footers
13269 \begin_layout Standard
13282 commands control whether the logo in the
13286 definition appear on a given page.
13293 in the preamble then none of the foils will have the logo on them.
13294 If you don't want the logo on a particular page place the
13300 directly after the foilhead of that page and the
13306 directly after the next foilhead.
13309 \begin_layout Standard
13310 If you decide to use the
13314 page style setting in the
13317 \begin_inset space ~
13322 dialog you should probably add
13332 to your preamble so headers and footers on landscape pages are correctly
13333 placed when rotated.
13334 This is due to some clashes between the page layouts provided by the
13345 \begin_layout Section
13346 Latex8 (IEEE Conference Papers)
13349 \begin_layout Standard
13355 \begin_layout Subsection
13359 \begin_layout Standard
13360 Since this class is specifically for writing submissions to IEEE sponsored
13361 conferences I strongly recommend that you get a copy of their Authors Kit.
13366 package and associated bibliography style file is included in the kit.
13367 The Authors Kit is usually sent out by email once your initial submission
13369 There is a lot of useful information in the Authors Kit explaining formatting
13370 restrictions and so on and I will assume you have read this since that
13371 means I don't have to repeat it all here.
13374 \begin_layout Subsection
13378 \begin_layout Standard
13379 [AR\SpecialChar \@.
13383 \begin_layout Subsection
13384 Supported Environments
13387 \begin_layout Itemize
13393 \begin_layout Itemize
13399 \begin_layout Itemize
13405 \begin_layout Itemize
13411 \begin_layout Itemize
13417 \begin_layout Itemize
13423 \begin_layout Itemize
13429 \begin_layout Itemize
13435 \begin_layout Itemize
13441 \begin_layout Subsection
13442 Differences Between Screen and Paper
13445 \begin_layout Standard
13446 There are slight differences in appearance mainly with the presentation
13447 of section counters.
13448 On screen the trailing period of the section counter is missing but it
13449 will appear in the output so don't let this worry you.
13452 \begin_layout Section
13453 Hollywood (Hollywood spec scripts)
13456 \begin_layout Standard
13462 \begin_layout Subsection
13466 \begin_layout Standard
13467 Getting the format of a Hollywood script right is a
13468 \begin_inset Quotes eld
13472 \begin_inset Quotes erd
13475 It is designed to make the readers focus on content and to be easy and
13476 familiar for the actors to read.
13477 Each page of a script should be one minute of film.
13478 Nothing goes in a script that you cannot see or hear on screen.
13479 The courier 12 pt font should be used throughout.
13483 \begin_layout Subsection
13487 \begin_layout Standard
13488 Speakers' lines should NEVER break in mid-sentence.
13489 If a speaker's lines continue over a page break, repeat the
13493 title followed by (Cont'd).
13496 \begin_layout Subsection
13500 \begin_layout Standard
13505 names as labels then cross-reference the label to insert the name.
13506 The cross-reference dialog will show the current cast of characters.
13507 You can use this to insert the speaker name in narratives also.
13510 \begin_layout Subsection
13511 Paper size and Margins
13514 \begin_layout Standard
13515 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13518 \begin_layout Subsection
13522 \begin_layout Standard
13523 The following environments are available.
13524 You can use hollywood.bind to get the bind keys shown at the right.
13527 \begin_layout Itemize
13531 \begin_inset Newline newline
13536 Used where nothing else works.
13540 \begin_layout Itemize
13546 \begin_inset space \hfill{}
13554 \begin_inset Newline newline
13557 Usually followed by something like
13558 \begin_inset Quotes eld
13561 on Sally waking up.
13562 \begin_inset Quotes erd
13568 \begin_layout Itemize
13572 \begin_inset space \hfill{}
13576 \begin_inset Newline newline
13581 Introduces a new INTERIOR camera set-up.
13582 Always followed by DAY or NIGHT, or something similar to define the lighting
13584 Everthing on this line in CAPS.
13587 \begin_layout Itemize
13591 \begin_inset space \hfill{}
13595 \begin_inset Newline newline
13600 Introduces a new EXTERIOR camera set-up.
13601 Everthing on this line in CAPS.
13604 \begin_layout Itemize
13608 \begin_inset space \hfill{}
13612 \begin_inset Newline newline
13617 The character speaking.
13620 \begin_layout Itemize
13624 \begin_inset space \hfill{}
13628 \begin_inset Newline newline
13633 Instructions to the speaker.
13634 The () are automatically inserted, but only the ( will show in LyX.
13635 Both will be printed.
13638 \begin_layout Itemize
13642 \begin_inset space \hfill{}
13646 \begin_inset Newline newline
13658 \begin_layout Itemize
13662 \begin_inset space \hfill{}
13666 \begin_inset Newline newline
13671 Camera movement instruction.
13673 \begin_inset space \thinspace{}
13677 \begin_inset space ~
13683 \begin_layout Itemize
13687 \begin_inset space \hfill{}
13693 \begin_layout Itemize
13697 \begin_inset space \hfill{}
13703 \begin_layout Itemize
13707 \begin_inset space \hfill{}
13713 \begin_layout Itemize
13717 \begin_inset space \hfill{}
13723 \begin_layout Subsection
13727 \begin_layout Itemize
13728 (O.S) --- off screen
13731 \begin_layout Itemize
13732 (V.0) --- voice over
13735 \begin_layout Itemize
13740 \begin_layout Itemize
13745 \begin_layout Itemize
13746 PAN --- camera movement
13749 \begin_layout Itemize
13750 INSERT --- cut to close-up of
13753 \begin_layout Section
13757 \begin_layout Standard
13763 \begin_layout Subsection
13767 \begin_layout Standard
13768 Broadway is for writing plays.
13769 The format is more decorative than Hollywood, and much less standardized.
13770 This format should be suitable for workshops.
13773 \begin_layout Subsection
13777 \begin_layout Standard
13778 The same as in Hollywood.
13781 \begin_layout Subsection
13785 \begin_layout Standard
13790 names as labels then cross-reference the label to insert the name.
13791 The cross-reference dialog will show the current cast of characters.
13794 \begin_layout Subsection
13795 Paper size and Margins
13798 \begin_layout Standard
13799 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13802 \begin_layout Subsection
13806 \begin_layout Standard
13807 The following environments are available.
13808 You can use broadway.bind to get the bind keys shown at the right.
13811 \begin_layout Itemize
13815 \begin_inset Newline newline
13820 You should not have to use this, but it is here for anything that does not
13824 \begin_layout Itemize
13828 \begin_inset space \hfill{}
13832 \begin_inset Newline newline
13837 Used to describe stage setting and the action.
13838 First use of speaker names in all CAPs.
13841 \begin_layout Itemize
13845 \begin_inset space \hfill{}
13849 \begin_inset Newline newline
13854 Automatically numbered.
13855 On screen it will be arabic, but will print as Roman.
13858 \begin_layout Itemize
13862 \begin_inset space \hfill{}
13866 \begin_inset Newline newline
13876 It is just centered text.
13879 \begin_layout Itemize
13883 \begin_inset space \hfill{}
13887 \begin_inset Newline newline
13892 Not automatically numbered.
13893 You supply the number.
13894 This is because I couldn't figure out how.
13897 \begin_layout Itemize
13901 \begin_inset space \hfill{}
13905 \begin_inset Newline newline
13910 A special case of Narrative to describe the setting and action as the curtain
13914 \begin_layout Itemize
13918 \begin_inset space \hfill{}
13922 \begin_inset Newline newline
13927 The speaker's (actor's) title, centered in all CAPS.
13930 \begin_layout Itemize
13934 \begin_inset space \hfill{}
13938 \begin_inset Newline newline
13943 Instructions to the speaker.
13944 The parentheses are automatically inserted.
13945 The ( will appear on screen, but both will be in the printed play.
13946 This environment is only used within
13953 \begin_layout Itemize
13957 \begin_inset space \hfill{}
13961 \begin_inset Newline newline
13966 What the Speaker says.
13969 \begin_layout Itemize
13973 \begin_inset space \hfill{}
13977 \begin_inset Newline newline
13982 The curtain comes down.
13985 \begin_layout Itemize
13989 \begin_inset space \hfill{}
13995 \begin_layout Itemize
13999 \begin_inset space \hfill{}
14005 \begin_layout Itemize
14009 \begin_inset space \hfill{}
14015 \begin_layout Standard
14019 \begin_layout Section
14023 \begin_layout Standard
14029 \begin_layout Standard
14030 \begin_inset VSpace bigskip
14036 \begin_layout Standard
14041 \begin_inset space ~
14046 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14047 \begin_inset Formula $\beta$
14050 release of May, 1999) class.
14053 \begin_layout Standard
14058 textclass, which works with RevTeX 3.1.
14059 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14060 That means that it doesn't interact very well with LyX, which requires
14061 LaTeX2e, although it has been kludged to work.
14062 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14066 \begin_inset space ~
14071 textclass should also be pretty easy to use.
14074 \begin_layout Standard
14075 These documents are supposed to be used in
14079 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14080 macros, and assume you'll know what to put in the preamble if necessary.
14083 \begin_layout Subsection
14087 \begin_layout Standard
14088 All you need to do is install RevTeX 4, as described in the package's README
14090 The package can be found at The RevTeX 4 Web Site
14091 \begin_inset Flex URL
14094 \begin_layout Plain Layout
14096 http://publish.aps.org/revtex4/
14102 Install it somewhere that LaTeX can see it.
14103 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14104 (i.e., not the directory where you installed the class file.) Then, if you
14105 reconfigure LyX, it will find the class file and let you use the RevTeX4
14109 \begin_layout Standard
14110 Probably the easiest way to get started is either to import a RevTeX 4 document
14118 \begin_inset space ~
14123 template, found in the templates directory.
14126 \begin_layout Subsection
14130 \begin_layout Standard
14131 Optional arguments to
14138 \begin_inset Quotes eld
14142 \begin_inset Quotes erd
14146 \begin_inset Quotes eld
14150 \begin_inset Quotes erd
14160 \begin_inset space ~
14168 \begin_inset space ~
14174 Remember that in RevTeX, at least one optional argument is required!
14177 \begin_layout Standard
14178 Other preamble matter, like
14185 \begin_inset space ~
14195 \begin_inset space ~
14200 dialog, also as usual.
14203 \begin_layout Subsection
14207 \begin_layout Standard
14208 The layouts basically correspond to the commands in RevTeX4.0.
14209 For example, the Email layout corresponds to
14216 Note that (at least as of RevTeX 4.0 Beta), the
14224 layouts are exactly equivalent, so you shouldn't need to use both.
14228 \begin_layout Plain Layout
14229 In case you're curious, both were included so that
14233 would be able to translate both
14253 \begin_layout Subsection
14257 \begin_layout Standard
14258 There are a couple of important unique aspects of RevTeX 4 which might cause
14259 bugs that will be even more confusing in LyX.
14262 \begin_layout Standard
14280 The LyX equivalent is that there is a separate Thanks layout.
14285 write footnotes in the
14289 layout, or weird things may happen.
14290 See the RevTeX 4 documentation for more details.
14293 \begin_layout Standard
14297 \begin_inset space ~
14305 \begin_inset space ~
14314 layouts must be placed
14322 layout and the corresponding
14339 , the LaTeX won't compile.
14342 \begin_layout Subsection
14346 \begin_layout Standard
14347 The main problem with this layout is that you can't use the optional arguments
14348 to layouts like Email and Title.
14349 (The problem is not unique to this layout; you can't use optional arguments
14350 to the Section layouts either.) This means that after you export that file
14351 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14352 need to edit the LaTeX file with a text editor to add the optional arguments
14354 \begin_inset space \thinspace{}
14357 g., the running title for the page headers.
14358 Lacking these layouts makes the
14364 (and the equivalent
14370 ) useless, so the corresponding layouts don't exist, and will have to be
14375 \begin_layout Plain Layout
14380 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14381 has not been updated yet to take advantage of it.
14389 \begin_layout Section
14390 Article (mwart), book (mwbk) and report (mwrep)
14391 \begin_inset OptArg
14394 \begin_layout Plain Layout
14407 \begin_layout Standard
14413 \begin_layout Standard
14414 The LyX document classes
14430 correspond to the LaTeX document classes
14443 They are replacements for the standard document classes
14455 , resp., and fit better to Polish typography conventions in a number of points.
14459 \begin_layout Standard
14463 \begin_layout Itemize
14464 Unnumbered titles (with star, eg.
14469 ) are added into table of contents,
14472 \begin_layout Itemize
14473 Additional page styles:
14477 \begin_layout Description
14478 uheadings header with separated lines,
14481 \begin_layout Description
14482 myheadings custom header, contents headers via commands:
14497 \begin_layout Description
14498 myuheadings custom header with separated lines,
14501 \begin_layout Description
14502 outer page number is placed on outer side of page
14506 \begin_layout Itemize
14511 \begin_layout Description
14512 rmheadings serif titles --- default,
14515 \begin_layout Description
14516 sfheadings sansserif titles,
14519 \begin_layout Description
14520 authortitle on title page first placed is author next title --- default,
14523 \begin_layout Description
14524 titleauthor on title page first placed is title next author,
14527 \begin_layout Description
14528 withmarginpar reserve place on page for margins.
14532 \begin_layout Section
14536 \begin_layout Standard
14542 \begin_layout Standard
14543 Elsevier Science Publishers B.V.
14544 provides a standard LaTeX document class (
14548 ) for submitting articles to their various journals.
14549 The style file can be downloaded directly from their web site:
14550 \begin_inset Flex URL
14553 \begin_layout Plain Layout
14555 http://authors.elsevier.com/
14561 Instructions are supplied along with the class file, which details the
14562 requirements of the publishers.
14563 LyX includes package that allows for the use of this class, by a layout
14564 and a template file.
14565 Installation of the class file is the same as for any other LaTeX package;
14566 instructions are provided in the Elsevier documentation.
14569 \begin_layout Standard
14579 As the Elsevier class file is based mainly on the standard article class,
14580 most of the normal functionality is provided.
14581 The Elsevier class defines a number of mathematical environments, which
14582 are similar to the AMS environments.
14583 These commands are all described in the Elsevier documentation, and are
14587 \begin_layout Standard
14588 The easiest way to use the Elsevier style is to base documents on the included
14590 It is best not to use options such as fancy headings or the geometry package,
14591 as elements such as these are defined by Elsevier in their style file.
14592 Ideally, no extra packages except those mentioned in the Elsevier documentation
14594 Essentially, Elsevier require as
14595 \begin_inset Quotes eld
14599 \begin_inset Quotes erd
14602 a LaTeX file as possible, as their intention is to take the supplied file
14603 and replace the class file with one for the particular journal to which
14604 the paper has been submitted.
14605 This also means that not too much time should be spent on the formating
14607 When it comes to be published, this will change anyway.
14608 The rest of the usage for this layout is substantially the same as for
14609 the normal article class.
14610 For details of what Elsevier do and don't allow, refer to their documentation.
14613 \begin_layout Section
14617 \begin_layout Standard
14620 Jürgen Spitzmüller
14623 \begin_layout Subsection
14627 \begin_layout Standard
14628 Memoir is a very powerful and constantly evolving class.
14629 It has been designed with regard to fictional and non-fictional literature.
14630 Its aim is to let the user have maximum control over the typesetting of
14632 Memoir is based on the standard book class, but it can also emulate the
14633 article class (see below).
14636 \begin_layout Standard
14637 Peter Wilson, the developer of Memoir, is known as the author of lots of
14638 useful packages in the LaTeX world.
14639 Most of them have been merged with Memoir.
14640 Therefore, it is much easier to layout the table of contents, appendices,
14641 chapter designs and such.
14642 LyX, though, does not support all of these goodies natively.
14643 Some of them might be added to forthcoming releases
14647 \begin_layout Plain Layout
14648 You are invited to send suggestions to
14649 \begin_inset Flex URL
14652 \begin_layout Plain Layout
14654 lyx-devel@lists.lyx.org
14664 , lots will probably never, due to the limitations of LyX's framework.
14665 Of course you can still use all features with the help of some native LaTeX
14670 \begin_layout Plain Layout
14675 \begin_layout Plain Layout
14685 \begin_inset space ~
14689 \begin_inset CommandInset ref
14691 reference "sec:Inserting-LaTeX-Code"
14701 In this section, we can only list those features which are natively supported
14703 For detailed descriptions (and for the rest of features) we are recommending
14704 to have a look at the detailed manual of the Memoir class
14708 \begin_layout Plain Layout
14713 \begin_layout Plain Layout
14723 \begin_inset Flex URL
14726 \begin_layout Plain Layout
14728 CTAN:/macros/latex/memoir/memman.pdf
14738 , which is not only a user guide for the class, but also both a comprehensive
14739 description on good typesetting and a superb example for good typesetting
14743 \begin_layout Subsection
14744 Basic features and restrictions
14747 \begin_layout Standard
14748 Memoir supports basically all features of the standard book classes.
14749 There are, however, some differences, as follows:
14752 \begin_layout Description
14754 \begin_inset space ~
14757 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14760 \begin_layout Description
14762 \begin_inset space ~
14765 style: The fancy page style is not supported, due to a command clash between
14766 Memoir and the fancyhdr package (they are both defining a command with
14767 the same name, which confuses LaTeX).
14768 Instead, Memoir comes with a bunch of own page styles (see
14770 Layout\SpecialChar \menuseparator
14771 Document\SpecialChar \menuseparator
14773 \begin_inset space ~
14779 If you want to use these for the chapter pages, you have to use the command
14786 in the main text or in preamble (e.
14787 \begin_inset space \thinspace{}
14791 \begin_inset space ~
14798 chapterstyle{companion}
14803 \begin_layout Description
14804 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14805 an optional argument in the standard classes.
14806 With this, you can specify an alternative version of the title for the
14807 table of contents and the headers (for instance, if the title is too long).
14808 In LyX, you can do this via
14810 Insert\SpecialChar \menuseparator
14812 \begin_inset space ~
14817 at the beginning of a chapter/section.
14818 Memoir features a second optional argument and thus separates the table
14819 of contents from the header.
14820 You can define three variants of a title with this: one for the main text,
14821 one for the table of contents, and one for the headers.
14822 Simply insert two optional arguments if you need this feature, the first
14823 one containing the short title for the Table of Contents, the second one
14824 containing an alternative short title for the headers.
14827 \begin_layout Description
14828 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14829 of contents, the list of figures and the list of table start a new page
14831 Memoir does not follow this route.
14832 You have to insert a page break yourself, if you want to have one.
14835 \begin_layout Description
14836 Titlepage: For some unknown reason, Memoir uses pagination on the title
14837 page (in the standard classes, title pages are
14838 \begin_inset Quotes eld
14842 \begin_inset Quotes erd
14846 \begin_inset space \thinspace{}
14850 \begin_inset space ~
14854 If you want an empty title page, type
14858 aliaspagestyle{title}{empty}
14863 \begin_layout Description
14864 Article: With the class option
14870 Layout\SpecialChar \menuseparator
14871 Document\SpecialChar \menuseparator
14873 \begin_inset space ~
14878 ), you can emulate article style.
14879 That is, counters (footnotes, figures, tables etc.) will not be reset on
14880 new chapters, chapters don't start a new page (but are---in contrary to
14882 \begin_inset Quotes eld
14886 \begin_inset Quotes erd
14889 article classes---still allowed), parts, though, use their own page, as
14893 \begin_layout Description
14894 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14895 font commands, which have been used in the old LaTeX version 2.09 (e.
14896 \begin_inset space \thinspace{}
14900 \begin_inset space ~
14916 It produces an error and stops LaTeX whenever such a command appears.
14921 reallows the commands and spits out warnings instead (which does at least
14923 Since a lot of packages and particularly BibTeX style files are still using
14924 those commands, we have decided to use this option by default.
14927 \begin_layout Subsection
14931 \begin_layout Standard
14932 We will only describe the features supported by LyX (which is not much currently
14934 Please consult the Memoir manual
14938 \begin_layout Plain Layout
14943 \begin_layout Plain Layout
14953 \begin_inset Flex URL
14956 \begin_layout Plain Layout
14958 CTAN:/macros/latex/memoir/memman.pdf
14971 \begin_layout Description
14972 Abstract: You may wonder why an abstract is an extra feature.
14973 Well, it is in book class.
14974 Usually books don't have abstracts.
14975 Memoir, however, has.
14976 You can use it wherever and how often you like.
14979 \begin_layout Description
14980 Chapterprecis: You may know this from belletristic: The contents of a chapter
14981 is shortly described below the title and also in the table of contents
14983 \begin_inset space \thinspace{}
14987 \begin_inset space ~
14992 Our hero arrives in Troia; he loses some friends; he finds others
14995 Chapterprecis does exactly this.
14996 It is therefore only sensible below a chapter.
14999 \begin_layout Description
15000 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15001 The epigraph environment provides an elegant way of typesetting such a
15003 The motto itself (text) and its author (source) are divided by a short
15005 Unfortunately, we have to fool LyX a bit here again, since the environment
15006 needs two arguments (text and source).
15007 In this case, we have to use curly brackets (in TeX mode) between the two
15018 <author of the slogan>.
15021 \begin_layout Description
15022 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15023 complex figurative poems).
15024 LyX can only support a few of them.
15025 One is poemtitle, which is a centered title for poems, which will also
15026 be added to the table of contents (verse is the standard environment for
15028 Memoir has some enhanced versions of verse, but you need to use ERT, because
15029 they have to be nested inside regular verse environments, which is not
15030 possible with LyX).
15033 \begin_layout Description
15034 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15037 \begin_layout Chapter
15038 LyX Features needing Extra Software
15041 \begin_layout Section
15045 \begin_layout Standard
15051 \begin_layout Subsection
15055 \begin_layout Standard
15056 When you to have the
15060 program installed, you'll find in the
15067 \begin_inset space ~
15078 \begin_inset CommandInset href
15080 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15087 \begin_layout Standard
15092 package is a program that was written by
15097 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15098 and easy to forget.
15099 The program runs over your LaTeX file and checks the integrity of the file,
15100 and flags some common errors.
15101 In other technical words, it is
15108 \begin_layout Standard
15109 Well, what is a syntax checker doing in LyX which is supposed to produce
15110 correct LaTeX anyways? The answer is simple: Just as
15114 not only checks the
15118 of C programs, but also does
15122 checks for type-errors,
15126 catches some common
15130 errors, in addition to the syntactical ones.
15135 is capable of detecting several common errors, such as
15138 \begin_layout Itemize
15139 Ellipsis detection:
15140 \begin_inset Newline newline
15143 Use \SpecialChar \ldots{}
15147 \begin_layout Itemize
15148 No space in front of/after parenthesis:
15149 \begin_inset Newline newline
15155 \begin_layout Itemize
15156 Enforcement of normal space after common abbreviations:
15157 \begin_inset Newline newline
15162 is too wide spacing.
15165 \begin_layout Itemize
15166 Enforcement of end-of-sentence space when the last sentence ends with a
15168 \begin_inset Newline newline
15172 And this is wrong spacing.
15175 \begin_layout Itemize
15176 Space in front of labels and similar commands:
15177 \begin_inset Newline newline
15180 The label should stick right up to the text to avoid falling to a wrong
15183 \begin_inset CommandInset label
15193 \begin_layout Plain Layout
15194 This footnote is in danger of falling off to a wrong page
15199 The label is separated too much.
15202 \begin_layout Itemize
15203 Space in front of references, instead of hard spaces:
15204 \begin_inset Newline newline
15207 In you are in bad luck, the text will break right between the referenced
15208 text and reference number, and that's a pity.
15210 \begin_inset CommandInset ref
15212 reference "sec:chktex"
15219 \begin_layout Itemize
15221 \begin_inset Quotes eld
15225 \begin_inset Quotes erd
15229 \begin_inset Formula $\times$
15233 \begin_inset Newline newline
15236 2x2 looks cheap compared to
15237 \begin_inset Formula $2\times2$
15243 \begin_layout Standard
15244 and more \SpecialChar \ldots{}
15245 It is an invaluable tool when you are
15246 \begin_inset Quotes eld
15250 \begin_inset Quotes erd
15253 your document before printing, and you should run it right after the obligatory
15254 spelling check, and before you go fine tuning the typesetting.
15257 \begin_layout Subsection
15261 \begin_layout Standard
15262 If you have the program installed, usage is as simple as choosing
15267 ools\SpecialChar \menuseparator
15273 \begin_inset space ~
15279 This will make LyX generate a LaTeX file of your document, start
15283 to check it, and then make LyX insert
15284 \begin_inset Quotes eld
15288 \begin_inset Quotes erd
15291 with the warnings from
15295 , if there were any.
15296 The warnings will be placed close to the point of the mistake, and you
15297 can quickly find them by using the
15302 avigate\SpecialChar \menuseparator
15309 menu item, or the shortcut key
15318 Open the error boxes by clicking on them with the mouse, or use the shortcut
15327 bindings, or the corresponding
15336 Read the warning and correct the mistake, if it is a mistake.
15337 If you have trouble understanding what the warning is about, you can safely
15339 Remember that there is a hidden layer between the document on screen and
15340 the technical details in invoking
15344 , and this gap can make some warnings seem arcane or just right down plain
15348 \begin_layout Standard
15349 This document is an excellent testing bed for the feature, and it should
15350 provide quite a few warnings for you to fiddle with.
15351 Since computers are only so smart, expect most of the warnings to be false
15355 \begin_layout Subsection
15356 How to fine tune it
15359 \begin_layout Standard
15360 Sometimes, you'll find that
15364 makes more noise than suits your mood.
15365 Then you can choose not to use it, wait until your mood changes, or try
15370 to get better along with you.
15371 Another choice in the most desperate situations is to use
15376 iew\SpecialChar \menuseparator
15382 \begin_inset space ~
15386 \begin_inset space ~
15390 \begin_inset space ~
15395 , which will get rid of all warnings instantly.
15398 \begin_layout Standard
15407 very configurable and extensible, you shouldn't expect to solve all problems
15413 Since LyX has to generate a somewhat special LaTeX file to be able to match
15414 the line numbers from the
15422 \begin_layout Plain Layout
15423 You can inspect the specific output from
15429 Edit\SpecialChar \menuseparator
15431 \begin_inset space ~
15435 \begin_inset space ~
15449 to the internal document structure, some of the warnings will not seen
15450 to appear correctly.
15451 There are two things you can do about this:
15454 \begin_layout Itemize
15459 invocation command line in
15475 installation configuration file (usually with the file
15480 See below to learn what warnings can be enabled and disabled on the command
15485 \begin_layout Itemize
15486 Export your document as a raw LaTeX file using
15491 ile\SpecialChar \menuseparator
15496 xport\SpecialChar \menuseparator
15508 Invoked in this way, it can be a hassle to find the corresponding place
15509 in the document inside LyX, but with a little patience, you should be able
15513 \begin_layout Standard
15514 Here follows the warning messages that can be enabled and disabled in
15523 to disable a warning, and
15527 to enable a warning.
15528 The emphasized entries are disabled by default, because the default is
15531 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15536 \begin_layout Standard
15537 Notice that you should only use the options that enable and disable warnings,
15538 because LyX relies on some of the other command line parameters to be set
15539 in a specific way to have a chance to communicate with
15546 \begin_layout Enumerate
15550 Command terminated with space.
15553 \begin_layout Enumerate
15556 Non-breaking space (
15557 \begin_inset Quotes eld
15565 \begin_inset Quotes erd
15568 ) should have been used.
15571 \begin_layout Enumerate
15575 You should enclose the previous parenthesis with
15576 \begin_inset Quotes eld
15584 \begin_inset Quotes erd
15590 \begin_layout Enumerate
15593 Italic correction (
15594 \begin_inset Quotes eld
15604 \begin_inset Quotes erd
15607 ) found in non-italic buffer.
15610 \begin_layout Enumerate
15613 Italic correction (
15614 \begin_inset Quotes eld
15624 \begin_inset Quotes erd
15627 ) found more than once.
15630 \begin_layout Enumerate
15634 No italic correction (
15635 \begin_inset Quotes eld
15645 \begin_inset Quotes erd
15651 \begin_layout Enumerate
15655 \begin_inset Quotes eld
15663 \begin_inset Quotes erd
15667 \begin_inset Quotes eld
15675 \begin_inset Quotes erd
15681 \begin_layout Enumerate
15684 Wrong length of dash may have been used.
15687 \begin_layout Enumerate
15691 \begin_inset Quotes eld
15699 \begin_inset Quotes erd
15703 \begin_inset Quotes eld
15711 \begin_inset Quotes erd
15717 \begin_layout Enumerate
15721 \begin_inset Quotes eld
15729 \begin_inset Quotes erd
15735 \begin_layout Enumerate
15739 \begin_inset Quotes eld
15747 \begin_inset Quotes erd
15750 to achieve an ellipsis.
15753 \begin_layout Enumerate
15756 Inter-word spacing (
15757 \begin_inset Quotes eld
15767 \begin_inset Quotes eld
15770 ) should perhaps be used.
15773 \begin_layout Enumerate
15776 Inter-sentence spacing (
15777 \begin_inset Quotes eld
15787 \begin_inset Quotes erd
15790 ) should perhaps be used.
15793 \begin_layout Enumerate
15796 Could not find argument for command.
15799 \begin_layout Enumerate
15803 \begin_inset Quotes eld
15811 \begin_inset Quotes erd
15817 \begin_layout Enumerate
15820 Math mode still on at end of LaTeX file.
15823 \begin_layout Enumerate
15827 \begin_inset Quotes eld
15835 \begin_inset Quotes erd
15838 doesn't match the number of
15839 \begin_inset Quotes eld
15847 \begin_inset Quotes erd
15853 \begin_layout Enumerate
15856 You should use either
15859 \begin_inset Quotes eld
15867 \begin_inset Quotes erd
15872 as an alternative to
15873 \begin_inset Quotes eld
15881 \begin_inset Quotes erd
15887 \begin_layout Enumerate
15894 " (ASCII 39) instead of "
15901 \begin_layout Enumerate
15904 User-specified pattern found.
15907 \begin_layout Enumerate
15910 This command might not be intended.
15913 \begin_layout Enumerate
15920 \begin_layout Enumerate
15938 \begin_layout Enumerate
15941 Delete this space to maintain correct page references.
15944 \begin_layout Enumerate
15948 You might wish to put this between a pair of
15949 \begin_inset Quotes eld
15957 \begin_inset Quotes erd
15963 \begin_layout Enumerate
15966 You ought to remove spaces in front of punctuation.
15969 \begin_layout Enumerate
15972 Could not execute LaTeX command.
15975 \begin_layout Enumerate
15984 in front of small punctuation.
15987 \begin_layout Enumerate
15995 may look prettier here.
15998 \begin_layout Enumerate
16002 Multiple spaces detected in output.
16005 \begin_layout Enumerate
16008 This text may be ignored.
16011 \begin_layout Enumerate
16017 \begin_inset Quotes eld
16022 to begin quotation, not
16029 \begin_layout Enumerate
16036 to end quotation, not
16039 \begin_inset Quotes eld
16047 \begin_layout Enumerate
16053 \begin_layout Enumerate
16056 You should perhaps use
16057 \begin_inset Quotes eld
16065 \begin_inset Quotes erd
16071 \begin_layout Enumerate
16074 You should put a space in front of/after parenthesis.
16077 \begin_layout Enumerate
16080 You should avoid spaces in front of/after parenthesis.
16083 \begin_layout Enumerate
16087 You should not use punctuation in front of/after quotes.
16090 \begin_layout Enumerate
16093 Double space found.
16096 \begin_layout Enumerate
16099 You should put punctuation outside inner/inside display math mode.
16102 \begin_layout Enumerate
16105 You ought to not use primitive TeX in LaTeX code.
16108 \begin_layout Enumerate
16111 You should remove spaces in front of
16112 \begin_inset Quotes eld
16120 \begin_inset Quotes erd
16126 \begin_layout Enumerate
16129 \begin_inset Quotes eld
16137 \begin_inset Quotes erd
16140 is normally not followed by
16141 \begin_inset Quotes eld
16149 \begin_inset Quotes erd
16155 \begin_layout Standard
16156 In later versions of LyX, we hope to provide a more complete interface to
16157 this tool (and it's smaller cousin
16161 ) to exploit the full power of it.
16162 But it's not exactly useless as it is now: go try it on one of your existing
16163 documents of a certain length and be surprised.
16166 \begin_layout Section
16167 Version Control in LyX
16170 \begin_layout Standard
16173 Lars Gullik Bjønnes,
16180 \begin_layout Subsection
16184 \begin_layout Standard
16185 A friend of mine wanted to try LyX for a group project.
16186 When he didn't find support for version control or file locking, he dropped
16188 This angered me a bit, so I thought that I should at least make support
16189 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16190 This has now been done.
16191 LyX now supports some of the most basic RCS commands.
16192 If you need to something a bit more sophisticated you will have to do that
16193 manually in an xterm.
16196 \begin_layout Standard
16197 Before you begin to use the version control features in LyX, you should
16199 \begin_inset Quotes eld
16203 \begin_inset Quotes erd
16206 (a man file, read it with
16211 This file describes all the basic features of RCS.
16212 You should especially notice the comment about a RCS directory, and the
16213 notion of a master RCS file (the file ending in
16220 \begin_layout Standard
16221 Later basic CVS/SVN support was added.
16222 You should be familiar with CVS/SVN usage before start using it under LyX.
16223 Most of the log messages are not currently displayed after operations -
16224 you can check them in terminal window if unsure.
16227 \begin_layout Standard
16228 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16229 package---no guarantees are made for older versions.
16232 \begin_layout Subsection
16233 RCS commands in LyX
16236 \begin_layout Standard
16237 The following sections describe the RCS commands supported by LyX.
16238 You can find them in the
16243 ile\SpecialChar \menuseparator
16249 \begin_inset space ~
16257 \begin_layout Subsubsection
16263 \begin_layout Standard
16264 If your document is not under revision control, this is the only item shown
16266 And if it is under revision control, the
16273 item is not visible.
16277 \begin_layout Standard
16278 This command registers your document with RCS (unless you are under the
16279 directory managed by CVS)\SpecialChar \@.
16280 You are asked interactively to supply an initial
16281 description of the document.
16282 The document is now set in Read-Only mode and you have to
16285 \begin_inset space ~
16289 \begin_inset space ~
16293 \begin_inset space ~
16298 , before making any changes to it.
16299 A document under revision control has a
16300 \begin_inset Quotes eld
16303 [RCS:<version> <locker>]
16304 \begin_inset Quotes erd
16307 item tagged to the filename in the minibuffer.
16310 \begin_layout Standard
16311 RCS command that is run:
16313 ci -q -u -i -t-"<initial description>" <file-name>
16316 \begin_layout Standard
16321 to understand the switches.
16325 \begin_layout Subsubsection
16331 \begin_layout Standard
16332 When you are finished editing a file, you check in your changes.
16333 When you do this, you are asked for a description of the changes.
16334 This is stored in the history log.
16335 The version number is bumped, your changes are applied to the master RCS
16336 file, the document is unlocked and set to Read-Only mode.
16340 \begin_layout Standard
16343 ci -q -u -m"<description>" <file-name>
16346 \begin_layout Subsubsection
16352 \begin_layout Standard
16353 By doing this you lock the document so that only you can edit it.
16354 This will also make the document Read-Write only for you.
16355 You will usually continue editing for a while and when you are finished
16356 you check in your changes.
16357 The status line is changed to reflect that you have locked the file.
16361 \begin_layout Standard
16364 co -q -l <file-name>
16367 \begin_layout Subsubsection
16370 Revert To Repository Version
16373 \begin_layout Standard
16374 This will discard all changes made to the document since the last check
16376 You get a warning before changes are discarded.
16379 \begin_layout Standard
16382 co -f -u<version> <file-name>
16385 \begin_layout Subsubsection
16391 \begin_layout Standard
16392 This makes as if the last check in never happened.
16393 No changes are made to the document loaded into LyX, but the last version
16394 is removed from the master RCS file.
16398 \begin_layout Standard
16401 rcs -o<version> <file-name>
16404 \begin_layout Subsubsection
16410 \begin_layout Standard
16411 This show the complete history of the RCS document.
16416 is shown in a browser.
16424 \begin_layout Subsection
16425 CVS commands in LyX
16428 \begin_layout Standard
16429 CVS is now partially supported by LyX.
16430 You can find the commands in the
16435 ile\SpecialChar \menuseparator
16441 \begin_inset space ~
16449 \begin_layout Subsubsection
16455 \begin_layout Standard
16456 If your document is not under revision control, this is the only item shown
16458 And if it is under revision control, the
16465 item is not visible.
16469 \begin_layout Standard
16470 This command registers in CVS your document ONLY in case you have already
16471 the documents directory under CVS control (in particular
16476 This means you have to checkout the archive by yourself.
16480 \begin_layout Standard
16481 Then you are asked interactively to supply an initial description of the
16483 Don't forget that registered file is not yet commited.
16486 \begin_layout Standard
16487 CVS command that is run:
16490 \begin_inset Quotes erd
16494 \begin_inset Quotes eld
16498 \begin_inset Quotes erd
16504 \begin_layout Standard
16509 to understand the switches.
16513 \begin_layout Subsubsection
16519 \begin_layout Standard
16520 When you are finished editing a file, you commit your changes.
16521 When you do this, you are asked for a description of the changes.
16522 After that changes are commited.
16525 \begin_layout Standard
16528 cvs -q commit -m"<description>" <file-name>
16531 \begin_layout Subsubsection
16534 Revert To Repository Version
16537 \begin_layout Standard
16538 This will discard all changes made to the document since the last check
16540 You get a warning before changes are discarded.
16541 Firstly the file is deleted, secondly CVS update command is run.
16544 \begin_layout Standard
16548 \begin_inset Quotes eld
16552 \begin_inset Quotes erd
16558 \begin_layout Subsubsection
16564 \begin_layout Standard
16565 This show the complete history of the CVS document.
16569 \begin_inset Quotes eld
16573 \begin_inset Quotes erd
16578 is shown in a browser.
16581 \begin_layout Subsection
16582 SVN commands in LyX
16585 \begin_layout Standard
16586 SVN is now partially supported by LyX.
16587 You can find the commands in the
16592 ile\SpecialChar \menuseparator
16598 \begin_inset space ~
16604 Please note that if you use password protected access to repository via
16605 ssh, you will be asked in terminal window.
16608 \begin_layout Subsubsection
16614 \begin_layout Standard
16615 If your document is not under revision control, this is the only item shown
16617 And if it is under revision control, the
16624 item is not visible.
16628 \begin_layout Standard
16629 This command registers in SVN your document ONLY in case you have already
16630 the documents directory under SVN control (in particular
16635 This means you have to checkout the archive by yourself.
16639 \begin_layout Standard
16640 Then you are asked interactively to supply an initial description of the
16642 Don't forget that registered file is not yet commited.
16645 \begin_layout Standard
16646 SVN command that is run:
16649 \begin_inset Quotes eld
16653 \begin_inset Quotes erd
16659 \begin_layout Standard
16664 to understand the switches.
16668 \begin_layout Subsubsection
16674 \begin_layout Standard
16675 When you are finished editing a file, you commit your changes.
16676 When you do this, you are asked for a description of the changes.
16677 After that changes are commited.
16680 \begin_layout Standard
16683 svn commit -q -m"<description>" <file-name>
16686 \begin_layout Subsubsection
16692 \begin_layout Standard
16693 Updates the changes of this file from the repository.
16694 Be sure you understand SVN merging and conflicts resolving before using
16695 this function, because all conflicts has to be done manually by you!
16698 \begin_layout Standard
16702 \begin_inset Quotes eld
16706 \begin_inset Quotes erd
16712 \begin_layout Subsubsection
16715 Revert To Repository Version
16718 \begin_layout Standard
16719 This will discard all changes made to the document since the last check
16721 You get a warning before changes are discarded.
16725 \begin_layout Standard
16729 \begin_inset Quotes eld
16733 \begin_inset Quotes erd
16739 \begin_layout Subsubsection
16745 \begin_layout Standard
16746 This show the complete history of the SVN document.
16750 \begin_inset Quotes eld
16754 \begin_inset Quotes erd
16759 is shown in a browser.
16762 \begin_layout Section
16763 Literate Programming
16766 \begin_layout Standard
16771 (kayvan@sylvan.com)
16775 original documentation written by
16777 Edmar Wienskoski Jr.
16780 (edmar-w-jr@technologist.com)
16783 \begin_layout Subsection
16787 \begin_layout Standard
16788 The main purpose of this documentation is to show you how to use LyX for
16789 literate programming.
16790 Where it is assumed that you are familiar with this programming technique,
16792 \begin_inset Quotes eld
16796 \begin_inset Quotes erd
16800 \begin_inset Quotes eld
16804 \begin_inset Quotes erd
16808 If that is not the case, please follow the web links provided in the following
16810 There is a lot of good documentation out there covering old development
16811 history to the latest tools tips.
16814 \begin_layout Standard
16815 It is also assumed that you are familiar with LyX itself to a point that
16816 you are comfortable changing your LyX preferences, and X resources file.
16817 If that is not the case please refer to other LyX documentation to cover
16818 your specific needs.
16821 \begin_layout Subsection
16822 Literate Programming
16825 \begin_layout Standard
16826 From the Literate Programming FAQ:
16829 \begin_layout Quotation
16830 Literate programming is the combination of documentation and source together
16831 in a fashion suited for reading by human beings.
16832 In fact, literate programs should be enjoyable reading, even inviting!
16833 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16834 and documentation in a single file.
16835 Literate programming tools then parse the file to produce either readable
16836 documentation or compilable source.
16837 The WEB style of literate programming was created by D.E.
16838 Knuth during the development of his TeX typesetting software.
16842 \begin_layout Standard
16843 Another excerpt says:
16846 \begin_layout Quotation
16849 How is literate programming different from verbose commenting?
16852 \begin_layout Quotation
16853 There are three distinguishing characteristics.
16854 In order of importance, they are:
16858 \begin_layout Itemize
16859 flexible order of elaboration
16862 \begin_layout Itemize
16863 automatic support for browsing
16866 \begin_layout Itemize
16867 typeset documentation, especially diagrams and mathematics
16871 \begin_layout Standard
16872 Now that I sparked your curiosity, take a look in the references.
16875 \begin_layout Subsubsection
16879 \begin_layout Standard
16880 The complete Literate Programming FAQ can be found at:
16883 \begin_layout Quote
16884 Literate Programming FAQ
16885 \begin_inset Flex URL
16888 \begin_layout Plain Layout
16890 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16898 \begin_layout Standard
16899 The FAQ lists 23 (twenty three!) different literate programming tools.
16900 Where some are specialized or
16901 \begin_inset Quotes eld
16905 \begin_inset Quotes erd
16908 for particular programming languages, while other have general scope.
16913 for my own use for several reasons:
16916 \begin_layout Itemize
16917 It can generate the documentation either in LaTeX or HTML.
16920 \begin_layout Itemize
16921 It has a open architecture, i.e., it is easy to plug in new filters and to
16922 perform special processing that you may need.
16926 \begin_layout Itemize
16927 There is a good selection of filters available already (the HTML is one
16931 \begin_layout Itemize
16935 \begin_layout Standard
16936 The Noweb web page can be found at:
16939 \begin_layout Quote
16941 \begin_inset Flex URL
16944 \begin_layout Plain Layout
16946 http://www.cs.virginia.edu/~nr/noweb/
16954 \begin_layout Standard
16955 Starting from there you can reach many other interesting links and even
16956 some literate program examples.
16959 \begin_layout Subsection
16960 \begin_inset CommandInset label
16962 name "sub:LyX-and-Literate"
16966 LyX and Literate Programming
16969 \begin_layout Standard
16970 The LyX support for Literate Programming is provided by using the generic
16971 LyX convertors mechanism.
16972 This support is provided in a
16973 \begin_inset Quotes eld
16977 \begin_inset Quotes erd
16980 way, i.e., you will be able to use this new LyX feature with some other literate
16981 programming tool of your choice by just changing your LyX preferences.
16984 \begin_layout Subsubsection
16985 Generating documents and code (weaving and tangling)
16988 \begin_layout Paragraph
16989 Selecting the document class
16992 \begin_layout Standard
16993 If you have installed Noweb and LyX successfully, whenever you open a new
16994 document or try to change the document class of an existing one, you will
16995 find that there are three new document classes available:
16998 \begin_layout Itemize
17002 \begin_layout Itemize
17006 \begin_layout Itemize
17010 \begin_layout Standard
17011 You must select one of them to create your literate documents from.
17015 \begin_layout Standard
17016 Note that literate documents are not limited to these three classes.
17017 New classes can be generated from other styles like letter or in combination
17018 with other class variations like Article (AMS).
17019 If you have special needs that cannot be covered by one of the existing
17020 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17021 will arrange to insert a new entry, or teach you how to do it.
17025 \begin_layout Plain Layout
17026 It is very simple, it involves the creation of a file with four lines, and
17027 re-running of the auto configuration.
17032 Moreover, if you use a literate tool other than Noweb you may need to create
17033 a new set of document classes for it.
17036 \begin_layout Paragraph
17040 \begin_layout Standard
17041 LyX enables you to write code with a layout named
17049 \begin_layout Plain Layout
17050 The equivalent Noweb term is
17051 \begin_inset Quotes eld
17055 \begin_inset Quotes erd
17059 For historical reasons, I got used to the term
17060 \begin_inset Quotes eld
17064 \begin_inset Quotes erd
17067 introduced by other literate tool named Nuweb, which I used for many years
17068 before rendering myself to Noweb.
17073 Noweb delimits scraps like this:
17076 \begin_layout LyX-Code
17080 \begin_layout LyX-Code
17084 \begin_layout LyX-Code
17088 \begin_layout LyX-Code
17092 \begin_layout LyX-Code
17096 \begin_layout Standard
17097 The problem is that whatever is written in between the << and the
17101 must be taken literally, i.e., LyX should be prevented from making any special
17102 interpretation of what has been written.
17103 This is handled by a special layout named Scrap, that works like a normal
17104 paragraph but has a free spacing capability.
17107 \begin_layout Standard
17108 The down side of the Scrap paragraph layout is that consecutive paragraphs
17109 of code will be spaced with one empty line in the source code and also
17110 in the printed documentation.
17111 The work around is to enter each line of code within a single Scrap, with
17112 a newline (ctrl-return).
17113 The example above will look like this:
17117 \begin_layout Plain Layout
17118 If you have a printed version of this document you will not see any difference
17119 between the previous example and this one.
17127 \begin_layout LyX-Code
17129 \begin_inset Newline newline
17133 \begin_inset Newline newline
17137 \begin_inset Newline newline
17141 \begin_inset Newline newline
17147 \begin_layout Standard
17148 This layout works fine.
17149 The only real inconvenience is that you have to type ctrl-return instead
17154 \begin_layout Plain Layout
17155 It is in my list of
17156 \begin_inset Quotes eld
17160 \begin_inset Quotes erd
17171 \begin_layout Standard
17172 As a special note, you can also use the
17173 \begin_inset Quotes eld
17177 \begin_inset Quotes erd
17180 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17184 \begin_layout LyX-Code
17186 \begin_inset Newline newline
17189 def some_function(args):
17190 \begin_inset Newline newline
17193 "This is the doc string for this function."
17194 \begin_inset Newline newline
17197 print "My args: ", args
17200 \begin_layout LyX-Code
17201 @ %def some_function
17204 \begin_layout Standard
17205 For an example of this usage and the resulting cross-reference output, look
17206 at the Literate python program in
17208 LIBDIR/examples/listerrors.lyx
17210 which should make this all clear.
17213 \begin_layout Paragraph
17214 Generating the documentation
17217 \begin_layout Standard
17218 At this point you already have a new document file with a proper document
17219 class, and with some code and text on it.
17220 How do I print it? The answer is simple, you select
17225 iew\SpecialChar \menuseparator
17233 Just like you would do for a plain document.
17234 No special procedure is required.
17237 \begin_layout Standard
17238 To help orientate you, I will now explain what happens inside LyX:
17241 \begin_layout Enumerate
17247 pdate\SpecialChar \menuseparator
17254 menu option is chosen, a LaTeX file is generated.
17259 \begin_layout Standard
17260 If the document is of any literate class the generated file will be named
17261 with an extension name defined by the
17262 \begin_inset Quotes eld
17266 \begin_inset Quotes erd
17269 format (defined in the Preferences panel), otherwise the file will have
17278 \begin_layout Enumerate
17279 Note that the only difference so far is in the name of the file, no special
17280 processing is required by LyX.
17281 Given that you formatted the code using the Scrap layout that, by itself,
17282 takes care of the business.
17285 \begin_layout Enumerate
17286 If the document is of any literate class LyX will then use the internal
17287 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17291 \begin_layout Plain Layout
17292 The converters are defined in the
17297 ools\SpecialChar \menuseparator
17305 \begin_inset Quotes eld
17309 \begin_inset Quotes erd
17314 \begin_inset CommandInset ref
17316 reference "sub:converters"
17324 manual for general information about converters.
17329 to generate the LaTeX file.
17333 \begin_layout Standard
17334 Otherwise it will just skip this step.
17338 \begin_layout Enumerate
17339 Finally, LaTeX is invoked and the regular post processing continues as in
17343 \begin_layout Standard
17344 Independence from a particular
17345 \begin_inset Quotes eld
17349 \begin_inset Quotes erd
17352 is easily achieved by changing the commands that are run by the various
17356 \begin_layout Paragraph
17357 Generating the code
17360 \begin_layout Standard
17361 When the build menu option is chosen or the corresponding button in the
17362 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17363 Next, LyX invokes the
17368 This converter needs to be defined by the user and is not installed by
17369 default, though the Program format is.
17370 This converter (like any other converter) will have two parts:
17373 \begin_layout Enumerate
17374 The converter program itself.
17375 This program performs the conversion from the one format to the other (in
17376 this case, from the Noweb format to the Program pseudo-format).
17379 \begin_layout Enumerate
17380 The error log parser.
17381 This is a program whose sole purpose is to rewrite error messages in a
17382 format that LyX understands.
17383 This makes it possible for LyX to place error boxes in the right places
17384 in the file buffer.
17387 \begin_layout Standard
17388 The first part, the
17389 \begin_inset Quotes eld
17393 \begin_inset Quotes erd
17396 setting, should be set to
17397 \begin_inset Quotes eld
17405 \begin_inset Quotes erd
17409 This basically means that LyX will call
17410 \begin_inset Quotes eld
17414 \begin_inset Quotes erd
17417 (a program or script) with the name of the Noweb file (normally a file
17418 in the LyX temp directory).
17422 \begin_layout Standard
17423 This is an implementation of
17424 \begin_inset Quotes eld
17428 \begin_inset Quotes erd
17431 that you can place in a directory on your path:
17434 \begin_layout LyX-Code
17438 \begin_layout LyX-Code
17442 \begin_layout LyX-Code
17443 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17446 \begin_layout Standard
17447 The next part of the converter setting is the
17448 \begin_inset Quotes eld
17452 \begin_inset Quotes erd
17455 which is to be set to
17456 \begin_inset Quotes eld
17461 parselog=listerrors
17464 \begin_inset Quotes erd
17468 This will run any errors that are generated by the
17469 \begin_inset Quotes eld
17473 \begin_inset Quotes erd
17476 process through the
17477 \begin_inset Quotes eld
17481 \begin_inset Quotes erd
17487 \begin_layout Standard
17488 The converter code looks in
17496 then on the path for the
17497 \begin_inset Quotes eld
17501 \begin_inset Quotes erd
17507 \begin_layout Standard
17508 The build will normally take place in LyX's temporary directory, so the
17509 files produced by the conversion will be in that directory.
17510 LyX will copy out what it regards as the `main' file, but the
17514 conversion may produce several files, and so most of these would then be
17515 deleted when LyX was closed.
17516 The present solution is to use a `copier',
17520 \begin_layout Plain Layout
17522 \begin_inset CommandInset ref
17524 reference "sec:converters-etc"
17532 manual for information on these.
17541 script in its default mode, so that the entire contents of the temporary
17542 directory is copied.
17543 More will get copied than is needed, to be sure, but nothing will be lost.
17544 If, however, you know what extensions the generated files will have, this
17545 can be improved by using the
17554 This option takes a comma-separated list of extensions to copy.
17555 So, for example, if the conversion will generate only files with the extensions
17564 , then the correct definition would be:
17567 \begin_layout LyX-Code
17568 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17571 \begin_layout Standard
17572 The result will be that only files with these two extensions will be copied
17576 \begin_layout Paragraph
17577 Build instructions in the document
17580 \begin_layout Standard
17581 The last piece of the integration between LyX and noweb is the
17582 \begin_inset Quotes eld
17586 \begin_inset Quotes erd
17590 Generally, the instructions for building your program should be embedded
17591 in a scrap of its own.
17593 \begin_inset Quotes eld
17597 \begin_inset Quotes erd
17600 above uses the notangle command to look for this scrap (called
17601 \begin_inset Quotes eld
17605 \begin_inset Quotes erd
17608 ) and runs its contents through
17609 \begin_inset Quotes eld
17613 \begin_inset Quotes erd
17619 \begin_layout Standard
17620 Typically, such a scrap would look something like this:
17623 \begin_layout LyX-Code
17625 \begin_inset Newline newline
17629 \begin_inset Newline newline
17633 \begin_inset Newline newline
17636 if [ -z "${NOWEB_SOURCE}" ]
17637 \begin_inset Newline newline
17641 \begin_inset Newline newline
17644 NOWEB_SOURCE=myfile.nw
17645 \begin_inset Newline newline
17649 \begin_inset Newline newline
17653 code to extract files ...]
17654 \begin_inset Newline newline
17658 code to compile files ...]
17659 \begin_inset Newline newline
17665 \begin_layout Standard
17668 LIBDIR/examples/listerrors.lyx
17672 LIBDIR/examples/Literate.lyx
17674 which implement two versions of the
17675 \begin_inset Quotes eld
17679 \begin_inset Quotes erd
17682 program for some illustrations of how all of these pieces go together or
17685 LIBDIR/examples/noweb2lyx.lyx.
17688 Interestingly, these three files show off the language-indepence of the
17689 LyX literate programming support since they are written in Python, C and
17693 \begin_layout Subsubsection
17697 \begin_layout Standard
17698 All the Literate Programming support is configured by the
17703 ools\SpecialChar \menuseparator
17711 \begin_inset Quotes eld
17715 \begin_inset Quotes erd
17719 The important parts are:
17722 \begin_layout Description
17724 \begin_inset space ~
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17736 \begin_inset space ~
17739 format Set up via the Formats tab, this is where the Noweb-specific pieces
17749 , the file extension is set to
17754 This tells LyX to create a file with a
17758 extension in the first step of the conversion process.
17761 \begin_layout Description
17763 \begin_inset space ~
17771 \begin_inset space ~
17774 format This is an empty format whose sole purpose is to be the endpoint
17775 of a conversion (which then allows us to set up a converter for it).
17778 \begin_layout Description
17787 This converter performs the
17788 \begin_inset Quotes eld
17792 \begin_inset Quotes erd
17795 of the literate document.
17796 For Noweb, it is set to
17797 \begin_inset Quotes eld
17802 noweave -delay -index $$i > $$o
17805 \begin_inset Quotes erd
17811 \begin_layout Description
17821 \begin_inset Quotes eld
17825 \begin_inset Quotes erd
17829 As stated above, the Converter is set to
17830 \begin_inset Quotes eld
17838 \begin_inset Quotes erd
17841 , with Flags set to
17842 \begin_inset Quotes eld
17847 originaldir,parselog=listerrors
17850 \begin_inset Quotes erd
17856 \begin_layout Subsubsection
17860 \begin_layout Standard
17861 There is also a new function implemented in the LyX server, the
17862 \begin_inset Quotes eld
17865 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17869 \begin_layout Standard
17870 When debugging code with ddd/gdb, it is possible to invoke a text editor
17871 at the current execution position with a single key stroke.
17872 The default ddd configuration for that is shift-ctrl-V.
17873 It happens that you can define the editor command line invocation in ddd
17879 dit\SpecialChar \menuseparator
17884 references\SpecialChar \menuseparator
17891 dialog and changing the "Edit Sources" entry.
17894 \begin_layout Standard
17895 I take advantage of the new created LyX server function and this ddd feature,
17897 \begin_inset Quotes eld
17901 \begin_inset Quotes erd
17907 \begin_layout LyX-Code
17908 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17911 \begin_layout Standard
17912 With this, whenever you are using ddd and find a point in the program that
17913 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17914 ddd you forward this information to LyX through the LyX server and then
17915 the LyX window will show the same file with the cursor at the same position
17916 ddd was pointing to.
17917 No more guessing or long scrolling to locate a point in the program back
17921 \begin_layout Standard
17922 Note however that you must enable the LyX server to get this feature working
17923 (it is disabled by default).
17924 You can enable it in
17936 ) by entering in the
17941 \begin_inset Quotes eld
17946 /home/<your-home-directory>/.lyx/lyxpipe
17949 \begin_inset Quotes erd
17955 \begin_layout Standard
17956 Read the LyX server documentation in the
17958 Customization Manual
17960 for further information.
17963 \begin_layout Subsubsection
17967 \begin_layout Standard
17968 There are six new buttons that can be added to your LyX toolbar.
17969 Five of these buttons are short cuts to layout styles:
17990 The last one is a short cut to the
17991 \begin_inset Quotes eld
17995 \begin_inset Quotes erd
18002 \begin_layout Standard
18003 LyX has a range of buttons that are available for tool bar customization.
18004 In my toolbar I like to combine the six short cuts above with two more:
18012 \SpecialChar \menuseparator
18020 \SpecialChar \menuseparator
18033 iew\SpecialChar \menuseparator
18041 Here is how it looks like:
18044 \begin_layout LyX-Code
18048 \begin_layout LyX-Code
18052 \begin_layout LyX-Code
18053 Icon "layout Standard"
18056 \begin_layout LyX-Code
18057 Icon "layout Section"
18060 \begin_layout LyX-Code
18061 Icon "layout LaTeX"
18064 \begin_layout LyX-Code
18065 Icon "layout LyX-Code"
18068 \begin_layout LyX-Code
18069 Icon "layout Scrap"
18072 \begin_layout LyX-Code
18076 \begin_layout LyX-Code
18080 \begin_layout LyX-Code
18081 Icon "buffer-typeset"
18084 \begin_layout LyX-Code
18085 Icon "build-program"
18088 \begin_layout LyX-Code
18092 \begin_layout LyX-Code
18096 \begin_layout LyX-Code
18100 \begin_layout LyX-Code
18104 \begin_layout LyX-Code
18108 \begin_layout Subsubsection
18109 Colors customization
18112 \begin_layout Standard
18113 There are a number of colors in LyX that can be customized in
18118 One of the things that bothers people is the LaTeX font color.
18119 The default color is red, since the scraps uses LaTeX font, and there is
18120 a lot of scraps in literate documents, you may get tired of seeing everything
18122 You can change it by going to the tabs
18131 \begin_layout Standard
18132 The next thing is the visible presence of the newline character in the screen.
18133 You can choose the color of this particular character and make it blend
18135 I recommend you choosing a color that is close to the background but not
18136 equal, that way you still can see it is there, but it is not bothering
18141 \begin_layout Chapter
18142 Secrets of the LaTeX Masters
18143 \begin_inset CommandInset label
18152 \begin_layout Standard
18153 Though LyX is a powerful tool, it cannot hope to support everything that
18154 can be done with pure TeX/LaTeX.
18155 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18156 as long as you are not afraid to use that
18157 \begin_inset Quotes eld
18161 \begin_inset Quotes erd
18164 button on the toolbar or add things to the LaTeX preamble.
18165 This section lists some tips, tricks, and otherwise cool ideas to give
18166 your document that extra little flair.
18169 Do try this at home
18171 , just start with something a little smaller and less important than your
18175 \begin_layout Standard
18176 Most ideas in this section require less common files in your LaTeX installation.
18177 If you have a system like teTeX, most will already be available.
18178 A few, however, will need to be downloaded from one of the CTAN archives.
18179 Often, there are several ways to do something, or several LaTeX style files
18180 which do the same thing.
18181 We do not endorse one choice over another, we simply claim that we have
18182 done a particular task with a particular file.
18183 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18186 \begin_layout Section
18190 \begin_layout Standard
18193 Lars Gullik Bjønnes
18196 \begin_layout Subsection
18200 \begin_layout Standard
18201 The aim for this chapter
18205 \begin_layout Plain Layout
18206 Editor's note: Lars' original chapter was a masterful description of how
18212 However, it was too long to flow smoothly in this document.
18213 I have therefore chosen to excerpt the most important sections here (sorry,
18214 Lars); you can read the original chapter (and more of the story!) in the
18217 examples/multicol.lyx
18225 is to show how the LaTeX package
18229 can be used in a LyX document.
18230 As LyX doesn't support the
18234 package natively yet, we have to use some small hacks.
18235 By reading this section it should be obvious how to do this.
18238 \begin_layout Subsection
18242 \begin_layout Standard
18247 package allows switching between one and multicolumn format on the same
18249 Footnotes are handled correctly (for the most part), but will be placed
18250 at the bottom of the page and not under each column.
18251 LaTeX's float mechanism, however, is partly disabled in the current implementat
18253 At the moment only page-wide floats can be used within the scope of the
18257 \begin_layout Subsection
18261 \begin_layout Subsubsection
18265 \begin_layout Standard
18266 If you want to have two columns in your text, you have use LaTeX mode to
18271 begin{multicols}{2}
18273 at the point where you want the two column layout to start, and then
18279 where you want it to end.
18283 \begin_layout Standard
18287 \begin_layout Plain Layout
18291 begin{multicols}{2}
18299 \begin_layout Standard
18304 The Adventure of the Empty House
18307 \begin_inset Newline newline
18312 Sir Arthur Conan Doyle
18315 \begin_layout Standard
18318 It was in the spring of the year 1894 that all London was interested, and
18319 the fashionable world dismayed, by the murder of the Honourable Ronald
18320 Adair under most unusual and inexplicable circumstances.
18321 The public has already learned those particulars of the crime which came
18322 out in the police investigation, but a good deal was suppressed upon that
18323 occasion, since the case for the prosecution was so overwhelmingly strong
18324 that it was not necessary to bring forward all the facts.
18325 Only now, at the end of nearly ten years, am I allowed to supply those
18326 missing links which make up the whole of that remarkable chain.
18327 The crime was of interest in itself, but that interest was as nothing to
18328 me compared to the inconceivable sequel, which afforded me the greatest
18329 shock and surprise of any event in my adventurous life.
18330 Even now, after this long interval, I find myself thrilling as I think
18331 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18332 ty which utterly submerged my mind.
18333 Let me say to that public, which has shown some interest in those glimpses
18334 which I have occasionally given them of the thoughts and actions of a very
18335 remarkable man, that they are not to blame me if I have not shared my knowledge
18336 with them, for I should have considered it my first duty to do so, had
18337 I not been barred by a positive prohibition from his own lips, which was
18338 only withdrawn upon the third of last month.
18341 \begin_layout Standard
18345 \begin_layout Plain Layout
18357 \begin_layout Subsubsection
18361 \begin_layout Standard
18362 The same pattern is used when you want more than two columns:
18365 \begin_layout Standard
18369 \begin_layout Plain Layout
18373 begin{multicols}{3}
18381 \begin_layout Standard
18384 It can be imagined that my close intimacy with Sherlock Holmes had interested
18385 me deeply in crime, and that after his disappearance I never failed to
18386 read with care the various problems which came before the public.
18387 And I even attempted, more than once, for my own private satisfaction,
18388 to employ his methods in their solution, though with indifferent success.
18389 There was none, however, which appealed to me like this tragedy of Ronald
18391 As I read the evidence at the inquest, which led up to a verdict of willful
18392 murder against some person or persons unknown, I realized more clearly
18393 than I had ever done the loss which the community had sustained by the
18394 death of Sherlock Holmes.
18395 There were points about this strange business which would, I was sure,
18396 have specially appealed to him, and the efforts of the police would have
18397 been supplemented, or more probably anticipated, by the trained observation
18398 and the alert mind of the first criminal agent in Europe.
18399 All day, as I drove upon my round, I turned over the case in my mind and
18400 found no explanation which appeared to me to be adequate.
18401 At the risk of telling a twice-told tale, I will recapitulate the facts
18402 as they were known to the public at the conclusion of the inquest.
18405 \begin_layout Standard
18409 \begin_layout Plain Layout
18421 \begin_layout Standard
18422 You can have more than 3 columns if you want to, but that might not be very
18423 pleasant for the eye.
18426 \begin_layout Subsubsection
18427 Columns inside columns
18430 \begin_layout Standard
18431 You can even have columns inside columns:
18434 \begin_layout Standard
18438 \begin_layout Plain Layout
18442 begin{multicols}{2}
18450 \begin_layout Standard
18453 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18454 at that time governor of one of the Australian colonies.
18455 Adair's mother had returned from Australia to undergo the operation for
18456 cataract, and she, her son Ronald, and her daughter Hilda were living together
18460 \begin_layout Standard
18464 \begin_layout Plain Layout
18468 begin{multicols}{2}
18476 \begin_layout Standard
18479 The youth moved in the best society--had, so far as was known, no enemies
18480 and no particular vices.
18481 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18482 had been broken off by mutual consent some months before, and there was
18483 no sign that it had left any very profound feeling behind it.
18484 For the rest {sic} the man's life moved in a narrow and conventional circle,
18485 for his habits were quiet and his nature unemotional.
18486 Yet it was upon this easy-going young aristocrat that death came, in most
18487 strange and unexpected form, between the hours of ten and eleven-twenty
18488 on the night of March 30, 1894.
18491 \begin_layout Standard
18495 \begin_layout Plain Layout
18507 \begin_layout Standard
18510 Ronald Adair was fond of cards--playing continually, but never for such
18511 stakes as would hurt him.
18512 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18513 It was shown that, after dinner on the day of his death, he had played
18514 a rubber of whist at the latter club.
18515 He had also played there in the afternoon.
18520 The evidence of those who had played with him-- Mr.
18521 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18522 and that there was a fairly equal fall of the cards.
18523 Adair might have lost five pounds, but not more.
18524 His fortune was a considerable one, and such a loss could not in any way
18526 He had played nearly every day at one club or other, but he was a cautious
18527 player, and usually rose a winner.
18528 It came out in evidence that, in partnership with Colonel Moran, he had
18529 actually won as much as four hundred and twenty pounds in a sitting, some
18530 weeks before, from Godfrey Milner and Lord Balmoral.
18531 So much for his recent history as it came out at the inquest.
18534 \begin_layout Standard
18538 \begin_layout Plain Layout
18550 \begin_layout Standard
18551 Please do read the file
18553 examples/multicol.lyx
18555 for more advanced examples including column and header spacing, vertical
18556 separator lines, and more.
18559 \begin_layout Section
18564 Paragraph Environment
18565 \begin_inset OptArg
18568 \begin_layout Plain Layout
18569 Numbering in Enumerate
18577 \begin_layout Standard
18583 \begin_layout Standard
18584 \begin_inset VSpace bigskip
18590 \begin_layout Standard
18592 The default numbering for the
18596 paragraph environment begins with Arabic numbers and ends with uppercase
18598 Suppose, however, you wanted a different type of numbering scheme.
18599 Here's a quickie example of how to change the numbering scheme:
18602 \begin_layout LyX-Code
18612 \begin_layout LyX-Code
18622 \begin_layout LyX-Code
18632 \begin_layout LyX-Code
18642 \begin_layout Standard
18643 \SpecialChar \ldots{}
18644 which changes the numbering scheme to uppercase Roman numerals, uppercase
18645 letters, Arabic numbers, and lowercase letter.
18648 \begin_layout Standard
18649 Additionally, the previous example also adds a little bit extra to the numbering
18651 For example, the first level label actually looks like:
18652 \begin_inset Quotes eld
18656 \begin_inset Quotes erd
18660 For ease of reading, we'll describe what the numbering schemes look like
18661 using a notation something like this: <
18662 \begin_inset Quotes eld
18666 \begin_inset Quotes erd
18670 \begin_inset space ~
18674 \begin_inset Quotes erd
18678 \begin_inset Quotes erd
18682 \begin_inset space ~
18686 \begin_inset Quotes erd
18690 \begin_inset Quotes erd
18694 \begin_inset space ~
18698 \begin_inset Quotes eld
18702 \begin_inset Quotes erd
18709 \begin_layout Standard
18710 As you can see in the example, there is a label command for each nesting
18717 \SpecialChar \ldots{}
18724 , as well as a counter,
18728 \SpecialChar \ldots{}
18734 There are also five
18735 \begin_inset Quotes eld
18739 \begin_inset Quotes erd
18772 , each of which take one counter as an argument.
18773 You can add characters before or after these, but there's no need to add
18777 \begin_layout Standard
18778 You can get really fancy with these.
18782 \begin_layout LyX-Code
18796 \begin_layout LyX-Code
18808 \begin_layout LyX-Code
18818 \begin_layout LyX-Code
18828 \begin_layout Standard
18829 produces the somewhat out of hand numbering scheme: <
18830 \begin_inset Quotes eld
18834 \begin_inset Quotes erd
18838 \begin_inset space ~
18842 \begin_inset Quotes erd
18846 \begin_inset Quotes erd
18850 \begin_inset space ~
18854 \begin_inset Quotes erd
18858 \begin_inset Quotes erd
18862 \begin_inset space ~
18866 \begin_inset Quotes eld
18870 \begin_inset Quotes erd
18877 \begin_layout Standard
18881 \begin_layout Section
18885 \begin_layout Standard
18891 \begin_layout Standard
18892 \begin_inset VSpace bigskip
18898 \begin_layout Standard
18903 \begin_layout Plain Layout
18909 tmpfont}{cmr17 scaled 2500}{
18921 \begin_layout Standard
18926 \begin_layout Plain Layout
18937 hose of you who like the style of old books probably also like
18938 \begin_inset Quotes eld
18942 \begin_inset Quotes erd
18945 ---those large capital letters which begin each new chapter or section.
18946 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18947 know some plain TeX!) but does require a lot of work and many iterations,
18948 as you can see by all the ugly TeX-mode stuff at the beginning of this
18952 \begin_layout Standard
18956 \begin_layout Plain Layout
18962 bigdrop{-1em}{3}{ptmri}{T}+
18967 here is a much easier way of doing this, of course.
18976 ) package from CTAN allows a simple way to add such letters to your documents.
18977 Since this package is not a standard part of teTeX, I can't demonstrate
18978 it within this document, but if you copy this paragraph to a new document,
18980 \begin_inset Quotes eld
18990 \begin_inset Quotes erd
18993 and the pluses from the TeX code at the beginning of the paragraph, and
18998 usepackage{dropcaps}
19000 to your LaTeX preamble, you will get a nice Times Roman Italic
19001 \begin_inset Quotes eld
19005 \begin_inset Quotes erd
19008 , whose height is three lines of text and which protrudes 1 em into the
19010 (Make certain you have copied
19011 \begin_inset Quotes eld
19019 \begin_inset Quotes erd
19022 into a directory where TeX can see it.) The first argument is the amount
19023 of indentation; in this case the negative sign moves it into the margin.
19024 The second argument is the height of the letter in number of lines of text.
19025 The third argument is the font name: virtually anything which has a tfm
19026 file should work (wade through the
19028 .../texmf/fonts/tfm
19030 directory for possibilities).
19031 My personal favorite is
19032 \begin_inset Quotes eld
19040 \begin_inset Quotes erd
19043 , a fancy German font specifically designed for dropped capitals.
19044 The fourth argument is the letter (or letters) to be dropped.
19049 package also offers the
19055 command, as well as a slightly simplified
19064 \begin_layout Section
19065 Non-standard Paragraph Shapes
19068 \begin_layout Standard
19074 \begin_layout Standard
19075 \begin_inset VSpace bigskip
19081 \begin_layout Standard
19085 \begin_layout Plain Layout
19097 \begin_layout Standard
19101 \begin_layout Plain Layout
19110 \begin_layout Plain Layout
19124 \begin_layout Standard
19129 \begin_layout Plain Layout
19140 \begin_layout Plain Layout
19149 \begin_layout Plain Layout
19158 \begin_layout Plain Layout
19167 \begin_layout Plain Layout
19176 \begin_layout Plain Layout
19185 \begin_layout Plain Layout
19194 \begin_layout Plain Layout
19203 \begin_layout Plain Layout
19212 \begin_layout Plain Layout
19221 \begin_layout Plain Layout
19230 \begin_layout Plain Layout
19239 \begin_layout Plain Layout
19248 \begin_layout Plain Layout
19257 \begin_layout Plain Layout
19266 \begin_layout Plain Layout
19275 \begin_layout Plain Layout
19284 \begin_layout Plain Layout
19293 \begin_layout Plain Layout
19302 \begin_layout Plain Layout
19308 There are times when the tyranny of rectangular paragraphs must be overthrown.
19309 In such situations, a call to the delightful plain TeX command
19316 As you can see, completely arbitrary shapes can be laid out with a suitable
19317 set of linelength definitions.
19318 While this parshape may look a bit silly and useless, one could conceive
19319 of situations such as finely tuned dropped capitals, word wrapping around
19320 non-rectangular graphics, etc.
19321 which will benefit from such handcrafting.
19324 \begin_layout Standard
19325 \begin_inset VSpace bigskip
19331 \begin_layout Standard
19336 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19343 is the number of lines of text which define the paragraph.
19344 If there turn out to be fewer lines, the shape is truncated; if there are
19345 more, the excess lines have the same dimensions as the last line of the
19355 entries specify the indentation of the line from the left margin, and the
19356 length of the line as measured from that point.
19357 The shape applies only to the current paragraph; everything is reset to
19358 normal for the next paragraph.
19361 \begin_layout Standard
19365 \begin_layout Plain Layout
19377 \begin_layout Section
19381 \begin_layout Standard
19382 As you can see, the examples in this section range from the useful to the
19384 While I don't expect that anyone will ever need the paragraph shape demonstrate
19385 d in the last section, the important point is that you can do almost anything
19386 you want in LyX if you are willing to figure out how to do it in TeX and
19388 TeX is a fantastically powerful typesetting system and all that power is
19389 available to you since LyX uses it as its backend.