1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual 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
55 InsetLayout CharStyle:MenuItem
64 \newcommand*{\menuitem}[1]{{\sffamily #1}}
72 \font_typewriter default
73 \font_default_family default
83 \pdf_title "LyX's Extended manual"
84 \pdf_author "LyX Team"
85 \pdf_subject "LyX's extended documentation"
86 \pdf_keywords "LyX, Documentation, Extended"
88 \pdf_bookmarksnumbered true
89 \pdf_bookmarksopen false
90 \pdf_bookmarksopenlevel 1
95 \pdf_pagebackref false
96 \pdf_pdfusetitle false
97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
104 \paperorientation portrait
107 \paragraph_separation indent
109 \quotes_language english
112 \paperpagestyle headings
113 \tracking_changes false
114 \output_changes false
122 Extended LyX Features
130 \begin_layout Plain Layout
132 Principal maintainer of this file is
137 If you have comments or error corrections, please send them to the LyX
138 Documentation mailing list,
139 \begin_inset Flex CharStyle:Code
142 \begin_layout Plain Layout
144 <lyx-docs@lists.lyx.org>
157 \begin_layout Standard
158 \begin_inset CommandInset toc
159 LatexCommand tableofcontents
166 \begin_layout Chapter
170 \begin_layout Standard
173 Extended LyX Features
175 manual, which you are now reading, is essentially Part II of the
177 User's Guide\SpecialChar \@.
180 The reason for separating this document out is simple: the
184 is already huge, and it contains all of the basic features one needs to
185 know in order to prepare most documents.
186 However, the LyX Team has a long-term goal of making LyX extensible through
187 various configuration files and external packages.
188 That means that if you want to support the Fizzwizzle LaTeX package, you
189 can create a layout file (or module) for it without having to alter LyX
191 We've already had contributions of several new features this way.
192 This is the place where all of that gets documented.
195 \begin_layout Standard
196 This manual also documents some special features, like fax support, version
197 control, and SGML support, which require additional software to work properly.
198 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
199 spruce up your documents by directly using the powerful features of LaTeX.
204 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
207 \begin_layout Standard
208 If you haven't read the
212 yet, you are definitely in the wrong manual.
217 is the first place to go, since it will direct you to the correct manual,
218 and it also describes the notation and format of all of the manuals.
219 You should also be thoroughly familiar with the
223 and all of the basic features of LyX.
227 \begin_layout Standard
228 In this document, many sections are independent articles contributed by
229 an individual and are noted as such.
230 This person is generally whoever wrote the layout file for the new document
231 class or LaTeX package, or implemented the feature.
232 If there is no mention of an author to a chapter [or chapter sections],
233 that means it was written by the LyX Documentation Team.
236 \begin_layout Standard
237 Since all the topics in this manual depend heavily on LyX's interaction
238 with LaTeX, this first chapter covers the inner workings of LyX and how
239 to direct LyX to generate exactly the LaTeX code you want.
240 It is obviously for more seasoned LyX users.
243 \begin_layout Chapter
247 \begin_layout Section
251 \begin_layout Standard
252 This chapter is for both TeX-nicians and the LaTeX-curious.
253 In it, we'll explain how LyX and LaTeX work together to produce printable
255 This is the only place in any of the manuals where we assume you know something
259 \begin_layout Standard
260 At one time, LyX was called a
261 \begin_inset Quotes eld
264 WYSIWYM frontend to LaTeX,
265 \begin_inset Quotes erd
268 but that's no longer true.
269 There are frontends to LaTeX out there.
270 They are basically editors with the ability to run LaTeX and mark any errors
271 in the file you're editing.
280 run LaTeX, and it also marks errors in the file, it also does much, much
282 Thanks to the WYSIWYM concept, you don't need to know LaTeX to use LyX
284 LyX has also added a few extensions to LaTeX.
285 Try the following sometime: select
287 Export\SpecialChar \menuseparator
299 View\SpecialChar \menuseparator
302 ), then look at the preamble of the resulting
307 You'll notice a variety of new macros defined specifically by LyX.
308 These macros are defined automatically, according to the features you use
312 \begin_layout Standard
313 There are several commands that automatically invoke LaTeX.
317 \begin_layout Itemize
323 iew\SpecialChar \menuseparator
333 \begin_layout Itemize
339 iew\SpecialChar \menuseparator
344 pdate\SpecialChar \menuseparator
350 \begin_layout Itemize
358 \SpecialChar \menuseparator
364 \begin_layout Itemize
372 \SpecialChar \menuseparator
378 \begin_layout Standard
379 They will only invoke LaTeX if the file has changed since the last time
384 \begin_layout Standard
385 When it runs LaTeX on the file you're editing, LyX performs these steps:
388 \begin_layout Enumerate
389 Convert the document to LaTeX and save to a file with the extension
400 \begin_layout Enumerate
405 file (maybe several times), and run any other commands (such as bibtex
406 or makeindex) needed to compile the LaTeX file.
409 \begin_layout Enumerate
410 If there are any errors, show the error log.
413 \begin_layout Standard
414 If you've run LaTeX using
422 , LyX then runs a dvi viewer to display DVI-file.
431 , LyX performs further steps:
434 \begin_layout Itemize
439 to convert the DVI file to PostScript®.
442 \begin_layout Itemize
443 Run a Postscript viewer, such as
447 , to display the PostScript® file.
450 \begin_layout Standard
451 LyX does similar things when viewing, or exporting, other formats.
454 \begin_layout Section
455 Translating LaTeX files into LyX
458 \begin_layout Standard
459 You can import a LaTeX file into LyX by using the
464 ile\SpecialChar \menuseparator
469 mport\SpecialChar \menuseparator
477 This will call a program named
481 ---which will create a file
489 ---and then LyX will attempt to open that file.
492 \begin_layout Standard
497 will translate most legal LaTeX, but not everything.
498 It will put things it doesn't understand into ERT, so after translating
503 , you can look for ERT and hand-edit it to look right.
506 \begin_layout Section
507 \begin_inset CommandInset label
509 name "sec:Inserting-TeX-Code"
513 Inserting TeX Code into LyX Documents
516 \begin_layout Standard
517 This is a rather important point: You can always insert TeX code into any
519 LyX cannot, and will never be able to, display every possible LaTeX construct.
520 If ever you need to insert LaTeX commands into your LyX document, you can
521 use the TeX Code box, which you can insert into your document with
523 Insert\SpecialChar \menuseparator
529 \begin_layout Standard
530 Here's an example of inserting LaTeX commands in a LyX document.
531 The code looks like this:
534 \begin_layout LyX-Code
538 \begin_inset Newline newline
544 \begin_inset Newline newline
547 This is an example for a minipage environment.
549 \begin_inset Newline newline
552 can put nearly everything in it, even (non-floating)
553 \begin_inset Newline newline
558 \begin_inset Newline newline
564 \begin_inset Newline newline
568 \begin_inset Newline newline
574 \begin_inset Newline newline
580 \begin_inset Newline newline
586 \begin_inset Newline newline
591 \begin_inset Newline newline
597 \begin_inset Newline newline
603 \begin_inset Newline newline
609 \begin_inset Newline newline
617 \begin_layout LyX-Code
621 \begin_layout Standard
622 The TeX Code box containing this text is directly after this paragraph.
623 Those of you reading the manual in LyX will only see the ERT inset.
624 Those reading a printed version of the manuals will see the actual results:
627 \begin_layout Standard
631 \begin_layout Plain Layout
638 \begin_layout Plain Layout
645 \begin_layout Plain Layout
647 This is an example for a minipage environment.
648 You can put nearly everything in it, even (non-floating) figures and tables.
652 \begin_layout Plain Layout
659 \begin_layout Plain Layout
664 \begin_layout Plain Layout
671 \begin_layout Plain Layout
678 \begin_layout Plain Layout
685 \begin_layout Plain Layout
691 \begin_layout Plain Layout
698 \begin_layout Plain Layout
705 \begin_layout Plain Layout
712 \begin_layout Plain Layout
724 \begin_layout Standard
725 In addition to using ERT, you can also create a separate file containing
726 some complex LaTeX structure and then use
728 Insert\SpecialChar \menuseparator
735 to include your file (you should select the type
740 We recommend that you only do this if you have a
749 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
753 \begin_layout Standard
754 There are a few last points to emphasize:
757 \begin_layout Itemize
758 Inside of LyX, LaTeX code appears
763 \begin_layout Itemize
768 check if your LaTeX code is correct.
771 \begin_layout Itemize
772 Beware reinventing the wheel.
775 \begin_layout Standard
776 On that last point, LyX does have quite a few features tucked into it, and
778 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
779 feature before you decide you have to do it by hand.
780 Moreover, there are numerous LaTeX packages out there to do all sorts of
781 things, from labels to envelopes to fancy multipage tables.
783 \begin_inset CommandInset href
786 target "http://www.ctan.org/"
793 \begin_layout Standard
794 If you do need to do some wild and fancy things within your document, be
795 sure to check out a good LaTeX book for assistance.
796 There are a number of them listed in the bibliography of the
803 \begin_layout Section
804 LyX and the LaTeX Preamble
807 \begin_layout Subsection
808 About the LaTeX Preamble
811 \begin_layout Standard
812 If you already know LaTeX, there is no need to explain here what the preamble
814 If you don't, the following will give you some ideas---we recommend again
815 that you consult a LaTeX book for further information.
816 In any case, you should read the points below, because they explain what
817 you can do and what you don't need to do in the LaTeX preamble of a LyX
821 \begin_layout Standard
822 The LaTeX preamble comes at the very beginning of a document,
830 \begin_layout Itemize
831 declare the document class.
832 LyX already does this for you.
836 \begin_layout Standard
837 If you're a seasoned LaTeX-nician, and you have some custom document class
838 you want to use, check out the
842 for information on how to make LyX interface to it.
843 Be sure to submit your efforts to the LyX Team for inclusion in future
848 \begin_layout Itemize
849 declare the usage of packages.
850 LaTeX packages provide special commands, which are only available within
851 a document when the package has been declared in the preamble.
852 For example, the package
856 forces all paragraphs to be indented.
857 There are other packages for labels, envelopes, margins, etc.
861 \begin_layout Itemize
862 set counters, variables, lengths and widths.
863 There are several LaTeX counters and variables which
867 be set globally from within the preamble in order to have the desired effect.
868 (There are variables which you can set and reset inside the document, too.)
869 Margins are a good example of something which must be set in the preamble.
870 Another example is the label format for lists.
871 You can actually set these just about anywhere, but it's best to do it
872 just once, inside the preamble.
875 \begin_layout Itemize
876 declare user defined commands [with
888 ], mostly abbreviations for LaTeX commands which appear very often inside
890 Although the preamble is a good place to declare such commands, they
894 be declared anywhere else (before they are used for the first time, of
895 course\SpecialChar \ldots{}
897 This can be useful if there is a lot of raw LaTeX code in your document,
898 which normally should not be the case.
901 \begin_layout Standard
902 LyX adds its own set of definitions to the preamble of the
907 This makes LaTeX files generated by LyX portable.
910 \begin_layout Subsection
911 Changing the Preamble
914 \begin_layout Standard
915 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
916 can't change them without patching LyX itself.
917 You can, however, add your own stuff to the preamble by selecting
939 \SpecialChar \menuseparator
948 LyX adds anything in the
952 dialog to its own built-in preamble.
953 Before adding your own declarations in the preamble, you should make sure
954 that LyX doesn't already support what you want to do (remember what we
955 said about reinventing the wheel?).
958 make sure your preamble code is correct
961 LyX doesn't check it.
964 \begin_layout Subsection
968 \begin_layout Standard
969 Here are some examples of what you can add to a preamble, and what they
973 \begin_layout Subsubsection
977 \begin_layout Standard
978 There are two variables under LaTeX that control page position:
991 Their names should be self-explanatory.
992 These variables are useful if you think for a moment about computer labels.
993 Sometimes, the size of a print medium and the area of the medium that you
994 can actually print on aren't the same.
1010 \begin_layout Standard
1011 The default values for
1023 are both 0 pt., i.e., the page isn't shifted.
1026 \begin_layout Standard
1027 Unfortunately, some DVI drivers always seem to shift the page.
1028 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1029 If you're using LyX on a system that you don't personally maintain, and
1030 your sysadmin is a doofus,
1043 Suppose you're left and top margins are always 0.5 inches too big.
1044 You can add this to the preamble:
1047 \begin_layout LyX-Code
1055 \begin_layout LyX-Code
1063 \begin_layout Standard
1064 and your margins should now be correct.
1067 \begin_layout Subsubsection
1071 \begin_layout Standard
1072 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1073 There's a rather nice package, available at your nearest CTAN archive,
1074 for printing sheets of labels:
1079 Now, your system may not have this package installed by default.
1080 We leave that up to you to check.
1081 You'll also want to read the documentation for it; we're not going to do
1083 Since this is an example, however, we'll give you an example of how you
1087 \begin_layout Standard
1088 First, make sure you're using the
1093 Next, you need to put the following in your preamble:
1096 \begin_layout LyX-Code
1102 \begin_layout LyX-Code
1108 \begin_layout LyX-Code
1114 \begin_layout LyX-Code
1120 \begin_layout LyX-Code
1126 \begin_layout LyX-Code
1132 \begin_layout LyX-Code
1138 \begin_layout Standard
1139 This sets things up for Avery® label sheets, stock #5360.
1140 You're now ready to print labels, but you'll need to insert LaTeX code,
1141 placing the commands
1153 around each label text.
1154 This and other special features of
1158 are explained in its documentation.
1161 \begin_layout Standard
1162 Someday, someone may write a LyX layout file to support this package directly.
1163 Maybe that someone is you.
1166 \begin_layout Subsubsection
1167 Example #3: Paragraph Indentation
1170 \begin_layout Standard
1171 Americans are trained to indent the first line of
1176 As with all of their other weird quirks, most Americans will whine and
1177 moan until they can have their way and indent the first line of all paragraphs.
1182 \begin_layout Standard
1183 Of course, this behavior isn't standard typography.
1184 In books, you typically only indent the first line of a paragraph
1188 it follows another one.
1189 The idea behind indenting the first line of a paragraph is to distinguish
1190 neighboring paragraphs from one another.
1191 If there is no previous paragraph, for example, it follows a figure, or
1192 is the first paragraph in a section, then there is no special indentation.
1196 \begin_layout Standard
1197 If you're a typical American, though, you don't care about such esoteric
1198 things; you want your indentation! Add this to the preamble:
1201 \begin_layout LyX-Code
1204 usepackage{indentfirst}
1207 \begin_layout Standard
1208 If your TeX distribution isn't a braindead one, you'll have this package,
1209 and all of your paragraphs will get the indentation you think they deserve.
1212 \begin_layout Subsubsection
1213 Example #4: This Document
1216 \begin_layout Standard
1217 You can also check out the preamble of this document to get an idea of some
1218 of the advanced things you can do.
1219 Also, there are more examples and an assortment of LaTeX
1220 \begin_inset Quotes eld
1224 \begin_inset Quotes erd
1228 \begin_inset space ~
1232 \begin_inset CommandInset ref
1234 reference "cha:secrets"
1242 \begin_layout Section
1243 LyX and LaTeX Errors
1246 \begin_layout Standard
1247 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1249 It then uses the log-file from the LaTeX run to do a post-mortem.
1250 LyX will then display a dialog listing the errors, and clicking on any
1251 one of them will take you to the position in your LyX file where the error
1255 \begin_layout Standard
1256 Some folks also like to look at the log file directly, accessible from
1261 ocument\SpecialChar \menuseparator
1267 \begin_inset space ~
1271 \begin_inset space ~
1277 There are some fairly common error messages and warnings.
1278 We'll cover those here.
1279 You should look at a good LaTeX book for a complete listing.
1282 \begin_layout Itemize
1283 \begin_inset Quotes eld
1291 \begin_inset Quotes eld
1298 \begin_layout Standard
1299 Anything beginning with these word is a warning message for the purpose
1301 \begin_inset Quotes eld
1305 \begin_inset Quotes erd
1308 the LaTeX code itself.
1309 You'll get messages like this if you added or changed cross-references
1310 or bibliography entries, in which case, LaTeX is trying to tell you that
1311 you need to make another run.
1314 \begin_layout Standard
1315 You can by-and-large ignore these.
1319 \begin_layout Itemize
1320 \begin_inset Quotes eld
1328 \begin_inset Quotes erd
1335 \begin_layout Standard
1336 Another warning message, this time about fonts which LaTeX couldn't find.
1337 The rest of the message will often say something about a replacement font
1341 \begin_layout Standard
1342 You can safely ignore these.
1346 \begin_layout Itemize
1347 \begin_inset Quotes eld
1357 \begin_inset Quotes erd
1364 \begin_layout Standard
1370 They are warning you about lines that were too long and run past the right
1372 Almost always, this is unnoticeable in the final output.
1373 Or, only one or two characters extend past the margin.
1374 LaTeX seems to generate at least one of these messages for just about any
1378 \begin_layout Standard
1379 You can ignore these stupid messages.
1380 Your eyes will tell you if there's a problem with something that's too
1381 wide; just look at the output.
1385 \begin_layout Itemize
1386 \begin_inset Quotes eld
1396 \begin_inset Quotes erd
1403 \begin_layout Standard
1404 Not quite as common as its cousin.
1405 LaTeX seems to like to print lines that are a bit too wide as opposed to
1406 ones that are a bit too narrow.
1407 We have no idea why.
1410 \begin_layout Standard
1411 You can ignore these, too.
1415 \begin_layout Itemize
1416 \begin_inset Quotes eld
1426 \begin_inset Quotes erd
1430 \begin_inset Quotes eld
1440 \begin_inset Quotes erd
1447 \begin_layout Standard
1448 Warnings about troubles breaking the page.
1449 Once again, just look at the output.
1450 Your eyes will tell you where something has gone wrong.
1454 \begin_layout Itemize
1455 \begin_inset Quotes eld
1461 \begin_inset Quotes els
1465 \begin_inset Quotes ers
1471 \begin_inset Quotes erd
1478 \begin_layout Standard
1480 \begin_inset Quotes eld
1484 \begin_inset Quotes erd
1487 isn't installed on this system.
1488 This usually appears because some package your document needs isn't installed.
1489 If you didn't touch the preamble or didn't use the
1495 command, then one of the packages LyX tried to load is missing.
1501 elp\SpecialChar \menuseparator
1508 to get a list of packages that LyX knows about.
1509 This file is updated whenever you reconfigure LyX (using
1516 \SpecialChar \menuseparator
1521 ) and tells you which packages have been detected and what they do.
1524 \begin_layout Standard
1535 command and the package in question isn't installed, then you'll need to
1536 install it yourself.
1540 \begin_layout Itemize
1541 \begin_inset Quotes eld
1546 LaTeX Error: Unknown option
1549 \begin_inset Quotes erd
1556 \begin_layout Standard
1557 Error messages beginning with this are trying to tell you that you specified
1558 a bad or undefined option to a package.
1559 Check the package's documentation.
1563 \begin_layout Itemize
1564 \begin_inset Quotes eld
1569 Undefined control sequence
1572 \begin_inset Quotes erd
1579 \begin_layout Standard
1580 If you've inserted LaTeX code into your document, but made a typo, you'll
1582 You may have forgotten to load a package.
1583 In any case, this error message usually means that you used an undefined
1589 \begin_layout Standard
1590 There are other error and warning messages.
1591 Some are self-explanatory.
1592 These are usually LaTeX messages.
1593 Others are downright cryptic.
1594 These are actually TeX error messages, and we really have
1598 what they mean or how to decipher them.
1601 \begin_layout Standard
1602 There's a general sequence you should follow if you get error messages:
1605 \begin_layout Enumerate
1606 Look at the LaTeX code you inserted for typos.
1609 \begin_layout Enumerate
1610 If there are no typos, check that you used the command(s) correctly.
1613 \begin_layout Enumerate
1614 If you get a bunch of error boxes piled up at the very top of the document,
1615 it means that there are errors in the preamble.
1616 Start debugging your preamble.
1619 \begin_layout Enumerate
1620 If you didn't add anything to the preamble and didn't add any LaTeX code
1621 to the document, the first suspect is your LaTeX distribution itself.
1622 Check for missing packages and install them.
1625 \begin_layout Enumerate
1626 Okay, so there are no missing packages.
1627 Did you use any of the fine-tuning options in LyX? Specifically, did you
1632 any of them, like trying to manually insert lots of
1635 \begin_inset space ~
1648 s? Did you try to kludge something together with these instead of using
1649 the appropriate paragraph environment?
1652 \begin_layout Enumerate
1653 All right, you didn't use any of the fine-tuning options, you played by
1655 Did you try to pull a fancy maneuver? Did you do something funky inside
1656 a table or an equation, like inserting a graphic into a table cell?
1659 \begin_layout Enumerate
1660 Do you have long sections of text where LaTeX cannot find a place to break
1661 a line? By default, LaTeX is rather strict about how much extra inter-word
1662 spacing it will add in order to break a line.
1663 Preferably, you should rework the paragraph to avoid the problem.
1664 If this isn't an option, you can wrap your text in
1670 to make LaTeX's line breaking more, well, sloppy.
1673 \begin_layout Enumerate
1674 Did you go overboard with the nesting? LyX (currently) doesn't check to
1675 make sure you're in the limits for nesting environments.
1676 If you nested a bunch of environments to the
1677 \begin_inset Formula $17^{\mathrm{th}}$
1680 level, that's the problem.
1683 \begin_layout Enumerate
1684 Okay, you didn't get any error messages, but your output looks whacked.
1685 If you have a table or figure that's too wide or long for the page, you
1690 \begin_layout Enumerate
1691 rescale the figure so it fits.
1694 \begin_layout Enumerate
1695 trim down the table so it fits.
1698 \begin_layout Standard
1699 If something else is wrong with the output, and you didn't try to pull anything
1700 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1704 \begin_layout Standard
1705 If all this doesn't help --- well, then
1709 you might have found a bug in LyX\SpecialChar \ldots{}
1713 \begin_layout Chapter
1717 \begin_layout Section
1718 Customizing Bibliographies with BibTeX
1721 \begin_layout Standard
1722 The basics how to use BibTeX are explained in section
1724 Bibliography databases (BibTeX)
1731 The following subsections explain special bibliography features supported
1735 \begin_layout Subsection
1736 Alternative Citation Styles
1739 \begin_layout Standard
1740 Standard BibTeX uses numbers (e.g.,
1741 \begin_inset Quotes eld
1745 \begin_inset Quotes erd
1748 ) to refer to a cited work.
1749 However, in many scientific disciplines, other citation styles are in use.
1750 The most common one is the author-year style (e.g.,
1751 \begin_inset Quotes eld
1755 \begin_inset Quotes erd
1759 LyX supports two packages that provide this style,
1768 Both packages have their own pros and cons, which cannot be listed in detail.
1769 If you only want to have simple author-year (or author-numerical) style
1770 or if you want to use one of the countless style files for natbib, than
1775 package is probably your choice.
1776 If you need special features like short title references, ibidem etc., you
1777 might consider the fairly new
1784 \begin_layout Standard
1785 The handling of both packages in LyX is basically the same.
1788 Document\SpecialChar \menuseparator
1804 With both packages, you will get some extra features in the citation dialog
1805 and you can select the style of the reference (
1806 \begin_inset Quotes eld
1810 \begin_inset Quotes erd
1814 \begin_inset Quotes eld
1818 \begin_inset Quotes erd
1822 \begin_inset Quotes eld
1826 \begin_inset Quotes erd
1830 \begin_inset Quotes eld
1834 \begin_inset Quotes erd
1838 Note that both packages need specifically designed style files (they both
1839 ship their own, while there are lots of additional style files and even
1840 an interactive style file builder
1844 \begin_layout Plain Layout
1846 \begin_inset Flex URL
1849 \begin_layout Plain Layout
1851 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
1868 \begin_layout Subsection
1869 Sectioned Bibliographies
1872 \begin_layout Standard
1873 Sometimes you might need to divide your bibliography into several sections.
1874 If you are for instance a historian, the possibility to separate sources
1875 and scientific works is most likely a
1876 \begin_inset Quotes eld
1880 \begin_inset Quotes erd
1884 Unfortunately, BibTeX itself does not allow you to do this.
1885 But with the help of some LaTeX packages, BibTeX can be extended to fit
1889 \begin_layout Standard
1890 LyX provides native support for one of these packages,
1898 \begin_layout Plain Layout
1900 \begin_inset Flex URL
1903 \begin_layout Plain Layout
1905 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
1915 The advantage of this package (compared to other packages like
1919 ) is that you don't need to define new citation commands.
1920 Instead, you need to prepare different bibliographic databases which include
1921 the entries for the different sections of the bibliography.
1922 For example: If you want to divide your bibliography into the sections
1924 \begin_inset Quotes eld
1928 \begin_inset Quotes erd
1932 \begin_inset Quotes eld
1936 \begin_inset Quotes erd
1939 , you first need to create two bibliographic databases, e.
1940 \begin_inset space \thinspace{}
1944 \begin_inset space \space{}
1959 \begin_layout Standard
1962 Document\SpecialChar \menuseparator
1972 \begin_inset space ~
1978 Now you can insert multiple BibTeX bibliographies, one for each section
1979 of your bibliography.
1980 Returning to our example: Insert the BibTeX bibliography
1984 and a second one for the database
1989 You are free to use the same or different styles for each section.
1990 Additionally, you can chose if the bibliography section should contain
1992 \begin_inset Quotes eld
1995 all cited references
1996 \begin_inset Quotes erd
1999 of the specified database(s) (which is the default),
2000 \begin_inset Quotes eld
2003 all uncited references
2004 \begin_inset Quotes erd
2008 \begin_inset Quotes eld
2012 \begin_inset Quotes erd
2016 This might be useful if you would like to separate your bibliography into
2018 \begin_inset Quotes eld
2022 \begin_inset Quotes erd
2026 \begin_inset Quotes eld
2030 \begin_inset Quotes erd
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2042 The titles for the sections can be added as ordinary sections or subsections.
2047 removes the bibliography title, you have manually re-add that, too (as
2048 a chapter* or section*, for instance).
2051 \begin_layout Subsection
2052 Multiple Bibliographies
2055 \begin_layout Standard
2056 Multiple bibliographies, e.
2057 \begin_inset space \thinspace{}
2061 \begin_inset space \space{}
2064 a bibliography for each section or chapter of the document, are not supported
2070 package, which is used for the creation of sectioned bibliographies in
2071 LyX (see the previous section), provides an easy way to solve this task,
2072 if you are willing to use some TeX Code (see section
2073 \begin_inset space ~
2077 \begin_inset CommandInset ref
2079 reference "sec:Inserting-TeX-Code"
2087 \begin_layout Plain Layout
2088 An alternative approach is to use the
2096 package, respectively.
2104 \begin_layout Standard
2107 Document\SpecialChar \menuseparator
2117 \begin_inset space ~
2123 In the document, you have to enclose the sections, which shall contain
2124 their own bibliography (including the BibTeX bibliography itself), between
2137 (those commands have to be inserted as ERT).
2138 The bibliography will contain all references which have been cited in the
2144 If you are using this approach, then
2148 citation reference has to be inside some btUnit.
2149 Also, the btUnits cannot be nested.
2152 \begin_layout Standard
2156 \begin_layout Section
2160 \begin_layout Subsection
2164 \begin_layout Standard
2165 When you are working on a large file with many sections, it is often convenient
2166 to break up the document into several files, or perhaps you have something
2167 where a table may change from time to time, but the preceding text does
2169 In these cases, you should seriously consider using multipart documents.
2170 For example, scientific papers often have five major sections: the introduction
2171 , observations, results, discussion, and conclusion.
2172 Each of these could be its own separate LyX file, with one
2173 \begin_inset Quotes eld
2177 \begin_inset Quotes erd
2180 file which contains the title, authors, abstract, references, etc., plus
2181 the five included files.
2182 It is important to note that each of these files is a full LyX file which
2183 can be formatted and printed on its own, as well as included in a master
2185 Each of these files must have the same document class, however--- don't
2186 attempt to mix book classes with article classes.
2187 You may also include LaTeX files; however, these files must not have their
2193 everything up to and including the
2205 line must be deleted) or else errors will be generated when you try to
2209 \begin_layout Standard
2210 LyX allows you to include files quite easily with
2212 Insert\SpecialChar \menuseparator
2214 \begin_inset space ~
2220 When you click on this selection a small box is inserted into the file
2221 at the current cursor location.
2222 Clicking on the box raises a dialog which allows you to select the file
2223 to be included, and the method of its inclusion.
2227 \begin_layout Standard
2228 The file selection box should by now be obvious.
2229 The three inclusion methods are
2230 \begin_inset Quotes eld
2234 \begin_inset Quotes erd
2238 \begin_inset Quotes eld
2242 \begin_inset Quotes erd
2246 \begin_inset Quotes eld
2250 \begin_inset Quotes erd
2254 The difference between
2255 \begin_inset Quotes eld
2259 \begin_inset Quotes erd
2263 \begin_inset Quotes eld
2267 \begin_inset Quotes erd
2270 is really only meaningful to LaTeXperts, but the practical difference is
2271 that files which are
2272 \begin_inset Quotes eld
2276 \begin_inset Quotes erd
2279 are typeset beginning on a new page, while files which are
2280 \begin_inset Quotes eld
2284 \begin_inset Quotes erd
2287 are typeset starting on the current page.
2288 Perhaps the labeling in LyX will be changed someday to reflect this.
2291 \begin_layout Standard
2292 Generally, the master file is converted into a full LaTeX file before typesettin
2293 g, while the included files are converted to LaTeX files which do not have
2294 all the preamble information.
2300 \begin_inset space ~
2307 button prevents this conversion.
2310 \begin_layout Standard
2312 \begin_inset Quotes eld
2316 \begin_inset Quotes erd
2319 included file allows you to include a file typeset exactly as it appears
2321 \begin_inset space ~
2324 verbatim mode, with the characters set in a fixed-width typewriter font.
2325 Normally, spaces in this file are invisible, though two consecutive spaces
2326 are conserved, unlike LyX's normal treatment of spaces.
2327 However, setting the
2330 \begin_inset space ~
2334 \begin_inset space ~
2338 \begin_inset space ~
2343 checkbox typesets a mark to unambiguously define the presence of a space.
2347 \begin_layout Subsection
2348 Cross-References Between Files
2351 \begin_layout Standard
2352 It is possible to set up cross-references between the different files.
2353 First, open all the files in question: let's call them A and B in a two
2354 file example, where B is included in A.
2355 Let's say you insert a label in A, then want to reference it in B.
2356 Open the cross-reference dialog in whilst in document B, and you can select
2358 \begin_inset Quotes eld
2362 \begin_inset Quotes erd
2368 \begin_layout Subsection
2369 Bibliography Lists in all Subdocuments
2372 \begin_layout Standard
2373 Copy the bibliography list with all entries to all subdocuments and transform
2375 This way LyX will find the
2379 -files and you can easily insert references without making the bibliography
2383 \begin_layout Standard
2384 As the bibliography list is in a comment, LaTeX won't use use it and the
2385 references will look like this [?] instead of [1].
2386 A solution is to use the LaTeX-package
2390 that will only include comments by processing the files separately.
2391 To do this, add in the LaTeX preamble of every subdocument the following:
2394 \begin_layout LyX-Code
2400 \begin_layout LyX-Code
2403 includecomment{comment}
2406 \begin_layout Standard
2408 \begin_inset Flex URL
2411 \begin_layout Plain Layout
2413 http://wiki.lyx.org/FAQ/Unsorted#toc31
2421 \begin_layout Section
2422 Fancy Headers and Footers
2425 \begin_layout Standard
2426 The default page layout is rather plain; for an article document class,
2427 all you get is a centered page number at the bottom of the page.
2428 This document is the book class, so it appears to be a bit fancier, but
2429 to really put on a show, you need to set the document page style to
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2437 , as mentioned in the
2440 \begin_inset space ~
2446 This section describes the LaTeX codes you need to insert in your LaTeX
2447 preamble or the text in order to get the desired effects.
2450 \begin_layout Standard
2451 The page header is divided into three fields, not surprisingly labeled
2452 \begin_inset Quotes eld
2456 \begin_inset Quotes erd
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2468 \begin_inset Quotes eld
2472 \begin_inset Quotes erd
2476 The footer is also divided into these three fields.
2477 The LaTeX commands to set these fields in the simplest manner are
2502 Suppose you wish to put your name in the upper left hand corner of each
2504 Simply insert the following command in the preamble:
2507 \begin_layout Standard
2516 \begin_layout Standard
2517 You will now see your name in the upper left.
2518 If a field has a default entry that you would like to get rid of (often
2519 the page number appears in the central footer, simply include a command
2520 with a blank argument, e.
2521 \begin_inset space \thinspace{}
2527 \begin_layout Standard
2535 \begin_layout Standard
2536 Let's get really fancy: lets put the section number with the word
2537 \begin_inset Quotes eld
2541 \begin_inset Quotes erd
2545 \begin_inset space \thinspace{}
2549 \begin_inset space ~
2552 Section 3) in the upper left, the page number (e.
2553 \begin_inset space \thinspace{}
2557 \begin_inset space ~
2560 Page 4) in the upper right, your name in the lower left, and the date in
2562 The following commands should now appear in the preamble:
2565 \begin_layout Standard
2575 \begin_layout Standard
2583 \begin_layout Standard
2593 \begin_layout Standard
2602 \begin_layout Standard
2610 \begin_layout Standard
2620 \begin_layout Standard
2633 access LaTeX's section and page counters, and so print out the current
2634 section and page numbers.
2641 simply prints out today's date.
2644 \begin_layout Standard
2645 The thicknesses of the horizontal rules drawn beneath the header and above
2646 the footer can also be modified.
2647 If you don't want one of the headers, set its thickness to 0.
2648 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2649 Use the commands, e.
2650 \begin_inset space \thinspace{}
2660 headrulewidth}{0.4pt}
2668 footrulewidth}{0.4pt}
2670 to set the thicknesses.
2673 \begin_layout Standard
2674 You can switch the header/footer settings on and off for individual pages
2679 thispagestyle{empty}
2685 thispagestyle{plain}
2691 thispagestyle{fancy}
2694 Simply insert them in the text on the page you want changed and mark them
2696 In fact, title pages are marked as plain by default, while following pages
2697 are marked fancy when using the global fancy setting.
2700 \begin_layout Standard
2701 There are more complex commands which will let you insert things in the
2702 upper left on odd numbered pages, etc., but I will refer you to the
2706 package documentation for more descriptions.
2707 For example, if you have a teTeX installation, look for
2709 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2715 \begin_layout Standard
2716 As a final example, it is possible to include an Encapsulated PostScript
2717 file in the header or footer.
2718 Suppose you want to put a company logo in the upper lefthand corner.
2719 You might try something like
2722 \begin_layout Standard
2731 includegraphics{logo.eps}}}
2734 \begin_layout Standard
2736 (you may need to preface this with
2740 usepackage{graphics}
2742 if you don't include EPS files elsewhere in your document).
2745 \begin_layout Section
2746 Itemize Bullet Selection
2747 \begin_inset CommandInset label
2756 \begin_layout Standard
2762 \begin_layout Subsection
2766 \begin_layout Standard
2767 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
2768 Using this dialog you can easily specify what bullet shape to use at each
2769 level of an itemized list.
2770 These settings are document-wide so you won't be able to specify different
2771 sets of bullets for different paragraphs
2775 \begin_layout Plain Layout
2776 Well, actually you can but you'll have to do it by hand.
2784 \begin_layout Subsection
2788 \begin_layout Standard
2789 Open the dialog by selecting the
2794 ocument\SpecialChar \menuseparator
2801 menu item and then select the
2811 \begin_layout Standard
2812 The dialog provides you with a table of bullet shapes.
2813 A column of buttons on the left of the table provides access to the six
2814 different panels of bullet shapes.
2815 The row of buttons across the top is used to select which bullet depth
2817 A text entry under the table shows the currently selected bullet shape's
2818 LaTeX equivalent and this can be edited if desired.
2819 If you do modify the text you will also need to specify any needed packages
2820 in the LaTeX preamble.
2823 \begin_layout Standard
2824 The six panels are divided up by the packages they require.
2825 The following table shows the mappings from button name to LaTeX packages.
2828 \begin_layout Standard
2830 \begin_inset Tabular
2831 <lyxtabular version="3" rows="7" columns="2">
2833 <column alignment="center" valignment="top" width="0pt">
2834 <column alignment="center" valignment="top" width="0pt">
2836 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2839 \begin_layout Plain Layout
2854 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2857 \begin_layout Plain Layout
2874 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2877 \begin_layout Plain Layout
2892 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2895 \begin_layout Plain Layout
2911 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2914 \begin_layout Plain Layout
2929 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2932 \begin_layout Plain Layout
2949 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2952 \begin_layout Plain Layout
2967 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2970 \begin_layout Plain Layout
2987 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2990 \begin_layout Plain Layout
3005 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3008 \begin_layout Plain Layout
3025 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3028 \begin_layout Plain Layout
3043 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3046 \begin_layout Plain Layout
3063 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3066 \begin_layout Plain Layout
3081 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3084 \begin_layout Plain Layout
3107 \begin_layout Standard
3108 LyX doesn't stop you using bullets from packages you don't have.
3109 If you get errors from LaTeX when you try to view or print the file then
3110 its likely you are missing a package.
3111 LyX doesn't restrict your use since you may be editing locally and exporting
3115 \begin_layout Subsection
3119 \begin_layout Standard
3120 Select which bullet depth you want to change then select the bullet shape
3122 Any changes will not be visible in LyX, but are visible when viewing the
3123 document using xdvi or ghostview.
3126 \begin_layout Standard
3127 You can reset a bullet shape to the default simply by clicking your right
3128 mouse button on the appropriate bullet depth button.
3131 \begin_layout Standard
3136 want to have multiple sets of paragraphs with different sets of bullets
3137 in each then you're going to have to get your hands dirty.
3138 The itemize bullet selection dialog can help though because it provides
3139 you with the LaTeX code for a wide range of bullet shapes.
3140 To make your own custom paragraphs you have the following options:
3143 \begin_layout Standard
3147 \begin_layout Plain Layout
3163 \begin_layout Standard
3167 \begin_layout Plain Layout
3189 \begin_layout Itemize
3190 Use the LaTeX command
3196 to specify a new bullet shape for a given depth.
3197 You'll also need to save the current bullet shape so you can restore it
3199 In this itemized list the following LaTeX code was used to change the bullet
3200 used for the first depth.
3201 \begin_inset Newline newline
3217 \begin_inset Newline newline
3233 \begin_inset Newline newline
3238 Note that the itemize depth is specified in Roman numerals as part of the
3248 \begin_layout Itemize
3252 \begin_layout Plain Layout
3265 Specify each individual entry by starting each item with the bullet shape
3266 enclosed in square brackets and set as TeX.
3267 For example, this item was started with
3280 \begin_layout Standard
3284 \begin_layout Plain Layout
3300 \begin_layout Standard
3301 You'll also need to revert the labelitem back to its previous setting for
3302 the global bullet shape settings to remain in effect.
3303 The way used here was:
3304 \begin_inset Newline newline
3318 \begin_layout Chapter
3322 \begin_layout Section
3326 \begin_layout Standard
3327 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
3328 and retrieve information about the LyX internal state.
3329 This is only intended for advanced users, but they should find it useful.
3330 It is by writing to the LyX server, for example, that bibliography managers,
3331 such as JabRef, are able to
3332 \begin_inset Quotes eld
3336 \begin_inset Quotes erd
3342 \begin_layout Standard
3343 Please note that, at present,
3345 the server does not work on Windows
3351 \begin_layout Plain Layout
3352 There is no reason it cannot do so.
3353 But none of the developers on Windows® have yet implemented this functionality
3362 \begin_layout Section
3363 Starting the LyX Server
3366 \begin_layout Standard
3367 The LyX server works through the use of a pair of named pipes.
3368 These are usually located in
3369 \begin_inset Flex CharStyle:Code
3372 \begin_layout Plain Layout
3379 \begin_inset Quotes eld
3383 \begin_inset Flex CharStyle:Code
3386 \begin_layout Plain Layout
3393 \begin_inset Quotes erd
3397 \begin_inset Quotes eld
3401 \begin_inset Flex CharStyle:Code
3404 \begin_layout Plain Layout
3411 \begin_inset Quotes erd
3415 External programs write into
3416 \begin_inset Flex CharStyle:Code
3419 \begin_layout Plain Layout
3425 and read back data from
3426 \begin_inset Flex CharStyle:Code
3429 \begin_layout Plain Layout
3436 The stem of the pipe names can be defined in the
3437 \begin_inset Flex CharStyle:MenuItem
3440 \begin_layout Plain Layout
3445 ools\SpecialChar \menuseparator
3456 \begin_inset Flex CharStyle:Code
3459 \begin_layout Plain Layout
3460 "/home/myhome/lyxpipe"
3470 configure this manually in order for the server to start.
3473 \begin_layout Standard
3475 \begin_inset Flex CharStyle:Code
3478 \begin_layout Plain Layout
3485 \begin_inset Flex CharStyle:Code
3488 \begin_layout Plain Layout
3494 ' to create the pipes.
3495 If one of the pipes already exists, LyX will assume that another LyX process
3496 is already running and will not start the server.
3497 This means that if LyX crashes, or if for some other reason, a
3498 \begin_inset Quotes eld
3502 \begin_inset Quotes erd
3505 pipe is left in existence when LyX closes, then LyX will not start the
3507 (This is bug 641.) You will need to delete the pipes manually and then restart
3511 \begin_layout Standard
3512 To have several LyX processes with servers at the same time, you have to
3513 use different configurations, perhaps by using separate user directories,
3515 \begin_inset Flex CharStyle:Code
3518 \begin_layout Plain Layout
3524 file, for each process.
3527 \begin_layout Standard
3528 If you are developing a client program, you might find it useful to enable
3529 debugging information from the LyX server.
3530 Do this by starting LyX as
3531 \begin_inset Flex CharStyle:Code
3534 \begin_layout Plain Layout
3543 \begin_layout Standard
3544 Other than this, there are a few points to consider:
3547 \begin_layout Itemize
3548 Both server and clients must run on UNIX or OS/2 machines.
3549 Communications between LyX on UNIX and clients on OS/2 or vice versa is
3550 not possible right now.
3553 \begin_layout Itemize
3554 On OS/2, only one client can connect to LyXServer at a time.
3557 \begin_layout Itemize
3558 On OS/2, clients must open the input pipe with
3559 \begin_inset Flex CharStyle:Code
3562 \begin_layout Plain Layout
3571 \begin_layout Standard
3572 You can find a complete example client written in C in the source distribution
3574 \begin_inset Flex CharStyle:Code
3577 \begin_layout Plain Layout
3578 development/lyxserver/server_monitor.c
3586 \begin_layout Section
3587 Normal communication
3590 \begin_layout Standard
3591 To issue a LyX call, the client writes a line of ASCII text into the input
3593 This line has the following format:
3610 \begin_layout Description
3611 clientname is a name that the client can choose arbitrarily.
3612 Its only use is that LyX will echo it if it sends an answer---so a client
3613 can dispatch results from different requesters.
3616 \begin_layout Description
3617 function is the function you want LyX to perform.
3618 It is the same as the commands you'd use in the minibuffer.
3621 \begin_layout Description
3622 argument is an optional argument which is meaningful only to some functions
3624 \begin_inset Quotes eld
3628 \begin_inset Quotes erd
3631 LFUN will insert the argument as text at the cursor position).
3634 \begin_layout Standard
3635 The answer from LyX will arrive in the output pipe and be of the form
3652 \begin_layout Standard
3661 are just echoed from the command request, while
3665 is more or less useful information filled according to how the command
3666 execution worked out.
3667 Some commands, such as
3668 \begin_inset Quotes eld
3672 \begin_inset Quotes erd
3675 , will return information about the internal state of LyX, while other will
3676 return an empty data-response.
3677 This means that the command execution went fine.
3680 \begin_layout Standard
3681 In case of errors, the response from LyX will have this form
3698 \begin_layout Standard
3703 should contain an explanation of why the command failed.
3706 \begin_layout Standard
3710 \begin_layout LyX-Code
3711 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
3714 \begin_layout LyX-Code
3715 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
3716 \begin_inset Newline newline
3719 read a <~/.lyxpipe.out
3720 \begin_inset Newline newline
3726 \begin_layout Section
3730 \begin_layout Standard
3731 LyX can notify clients of events going on asynchronously.
3732 Currently it will only do this if the user binds a key sequence with the
3734 \begin_inset Quotes eld
3738 \begin_inset Quotes erd
3742 The format of the string LyX sends is as follows:
3746 \begin_inset Flex CharStyle:Code
3749 \begin_layout Plain Layout
3760 \begin_layout Standard
3765 is the printed representation of the key sequence that was actually typed
3769 \begin_layout Standard
3770 This mechanism can be used to extend LyX's command set and implement macros.
3771 Bind some key sequence to
3772 \begin_inset Quotes eld
3776 \begin_inset Quotes erd
3780 Then start a client that listens on the output pipe, dispatches the command
3781 according to the sequence, and starts a function that may use LyX calls
3782 and LyX requests to issue a command or a series of commands to LyX.
3785 \begin_layout Section
3786 The simple LyX Server Protocol
3789 \begin_layout Standard
3790 LyX implements a simple protocol that can be used for session management.
3791 All messages are of the form
3804 \begin_layout Standard
3810 \begin_inset Quotes eld
3814 \begin_inset Quotes erd
3818 \begin_inset Quotes eld
3822 \begin_inset Quotes erd
3827 \begin_inset Quotes eld
3831 \begin_inset Quotes erd
3834 is received from a client, LyX will report back to inform the client that
3835 it's listening to it's messages, while
3836 \begin_inset Quotes eld
3840 \begin_inset Quotes erd
3843 sent from LyX will inform clients that LyX is closing.
3846 \begin_layout Chapter
3847 Special Document Classes
3850 \begin_layout Section
3854 \begin_layout Standard
3857 David Johnson; updated by Richard Heck
3860 \begin_layout Standard
3861 \begin_inset VSpace bigskip
3867 \begin_layout Standard
3869 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3870 papers to be submitted to American Mathematical Society publications.
3871 The layouts are not tailored to a specific journal, but easily can be.
3872 You should refer to the AMS documentation for specific instructions for
3873 each journal (usually it will entail only changing a single line in the
3875 That documentation is available on the Web at
3876 \begin_inset Flex URL
3879 \begin_layout Plain Layout
3887 \begin_inset Flex URL
3890 \begin_layout Plain Layout
3892 ftp://ftp.ams.org/pub/tex/amslatex/
3898 These layouts are appropriate, and useful, for any mathematical writing.
3902 \begin_layout Standard
3903 There are two basic AMS LaTeX layouts:
3906 \begin_layout Itemize
3907 amsart: The standard AMS article format.
3910 \begin_layout Itemize
3911 amsbook: the standard AMS book (really, monograph) format.
3915 \begin_layout Standard
3916 The layouts themselves contain only the minimum necessary to use the AMS
3918 They do not, in particular, contain any of the `theorem' environments used
3919 for setting theorems, lemmas, and the like.
3920 These are contained, instead, in the
3921 \begin_inset Flex CharStyle:Code
3924 \begin_layout Plain Layout
3930 module, which is loaded by default when when you select one of the AMS
3932 (It can also be used with other classes and can be removed, if you would
3933 rather use something else.) Less commonly used environments are in the
3934 \begin_inset Flex CharStyle:Code
3937 \begin_layout Plain Layout
3938 Theorems (AMS-Extended)
3943 module, which must be loaded manually.
3946 \begin_layout Standard
3947 By default, theorems and the like are numbered consecutively throughout
3948 the document, but this may be modified by loading the module
3949 \begin_inset Flex CharStyle:Code
3952 \begin_layout Plain Layout
3953 Theorems (Order by Section)
3958 or, if you are using
3959 \begin_inset Flex CharStyle:Code
3962 \begin_layout Plain Layout
3969 \begin_inset Flex CharStyle:Code
3972 \begin_layout Plain Layout
3973 Theorems (Order by Chapter)
3979 These will number the results as
3980 \begin_inset Formula $n.m$
3983 , where the first number refers to the section (or chapter) and the second
3984 refers to the total number of results so far in that section (or chapter).
3985 Many environments are also available unnumbered.
3986 These are indicated by an asterisk at the end.
3987 If you happen to want
3991 unnumbered results, the the module
3992 \begin_inset Flex CharStyle:Code
3995 \begin_layout Plain Layout
4001 provides that option.
4004 \begin_layout Standard
4005 Note that these modules do not
4009 to be used with the AMS classes.
4010 It is perfectly possible to use the
4011 \begin_inset Flex CharStyle:Code
4014 \begin_layout Plain Layout
4020 module, and the others mentioned, with other classes, such as
4021 \begin_inset Flex CharStyle:Code
4024 \begin_layout Plain Layout
4031 \begin_inset Flex CharStyle:Code
4034 \begin_layout Plain Layout
4041 \begin_inset Flex CharStyle:Code
4044 \begin_layout Plain Layout
4053 \begin_layout Subsection
4054 What these layouts provide
4057 \begin_layout Standard
4058 There is a long list of included environments provided by these layouts.
4059 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4060 variety of `theorem' environments.
4061 However, the AMS recommends the environments that are available in LyX.
4065 \begin_layout Standard
4066 The following environments---as well as the standard environments, such
4068 \begin_inset Flex CharStyle:Noun
4071 \begin_layout Plain Layout
4078 \begin_inset Flex CharStyle:Noun
4081 \begin_layout Plain Layout
4088 \begin_inset Flex CharStyle:Noun
4091 \begin_layout Plain Layout
4098 \begin_inset Flex CharStyle:Noun
4101 \begin_layout Plain Layout
4108 \begin_inset Flex CharStyle:Noun
4111 \begin_layout Plain Layout
4118 \begin_inset Flex CharStyle:Code
4121 \begin_layout Plain Layout
4128 \begin_inset Flex CharStyle:Code
4131 \begin_layout Plain Layout
4140 \begin_layout Description
4141 Address This should be the author's permanent address.
4144 \begin_layout Description
4146 \begin_inset space ~
4149 Address This should be the author's temporary address at the time of submission,
4150 if different from the Address.
4153 \begin_layout Description
4154 Email Author's e-mail address
4157 \begin_layout Description
4158 URL Author's Web address, if desired.
4161 \begin_layout Description
4162 Keywords Key words or phrases used to identify specific topics discussed
4166 \begin_layout Description
4167 Subjectclass These refer to the AMS Subject Classifications, published and
4170 Mathematical Reviews
4173 These are also available online at the AMS cites listed above.
4176 \begin_layout Description
4180 \begin_layout Description
4184 \begin_layout Description
4188 \begin_layout Standard
4189 The following environments are provided by both the
4190 \begin_inset Flex CharStyle:Code
4193 \begin_layout Plain Layout
4200 \begin_inset Flex CharStyle:Code
4203 \begin_layout Plain Layout
4209 modules, in the latter case in both starred (unnumbered) and unstarred
4210 (numbered) versions.
4211 These same environments are provided only in the starred versions by the
4213 \begin_inset Flex CharStyle:Code
4216 \begin_layout Plain Layout
4225 \begin_layout Theorem
4226 This is typically used for the statements of major results.
4230 \begin_layout Corollary*
4231 This is used for statements which follow fairly directly from previous statement
4233 Again, these can be major results.
4238 These are smaller results needed to prove other statements.
4241 \begin_layout Proposition
4242 These are less major results which (hopefully) add to the general theory
4246 \begin_layout Conjecture
4247 These are statements provided without justification, which the author does
4248 not know how to prove, but which seem to be true (to the author, at least).
4251 \begin_layout Definition*
4252 Guess what this is for.
4253 The font is different for this environment than for the previous ones.
4257 \begin_layout Example*
4258 Used for examples illustrating proven results.
4261 \begin_layout Problem
4262 It's not really known what this is for.
4263 You should figure it out.
4266 \begin_layout Exercise*
4267 Write a description for this one.
4270 \begin_layout Remark
4271 This environment is also a type of theorem, usually a lesser sort of observation.
4274 \begin_layout Claim*
4275 Often used in the course of giving a proof of a larger result.
4279 Generally, these are used to break up long arguments, using specific instances
4285 The numbering scheme for cases is on its own, not together with other numbered
4291 At the end of this environment , a QED symbol (usually a square, but it
4292 can vary with different styles) is placed.
4293 If you want to have other environments within this one---for example, Case
4294 environments---and have the QED symbol appear only after them, then the
4295 other environments need to be nested within the proof environment.
4298 Nesting Environments
4304 for information on nesting.
4307 \begin_layout Standard
4308 And these are provided by
4309 \begin_inset Flex CharStyle:Code
4312 \begin_layout Plain Layout
4313 Theorems (AMS-Extended)
4321 \begin_layout Criterion*
4322 A required condition.
4325 \begin_layout Algorithm*
4326 A general procedure to be used.
4329 \begin_layout Axiom*
4330 This is a property or statement taken as true within the system being discussed.
4333 \begin_layout Condition*
4334 Sometimes used to state a condition assumed within the present context of
4339 Similar to a Remark.
4342 \begin_layout Notation*
4343 Used for the explanation of, yes, notation.
4346 \begin_layout Summary
4347 Do we really need to tell you?
4350 \begin_layout Acknowledgement*
4354 \begin_layout Conclusion*
4355 Sometimes used at the end of a long train of argument.
4359 Used in a way similar to Proposition, though perhaps lower on the scale.
4362 \begin_layout Standard
4363 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4365 They need to be available on your system in order to use these environments.
4368 \begin_layout Section
4372 \begin_layout Standard
4377 can be used to type letters according to German conventions.
4378 A template file is included in
4380 .../lyx/share/templates
4382 for you to use as a starting point.
4385 \begin_layout Section
4389 \begin_layout Standard
4394 provides an alternative to the standard
4399 It provides similar functionality, but you might prefer this layout with
4400 sans serif sections, headings, and more.
4403 \begin_layout Section
4407 \begin_layout Standard
4413 \begin_layout Subsection
4417 \begin_layout Standard
4418 This section describes how LyX can be used to write articles for submission
4419 to the scientific journal
4421 Astronomy and Astrophysics
4423 (www.edpsciences.fr/aa/
4424 \begin_inset Flex URL
4427 \begin_layout Plain Layout
4429 http://www.edpsciences.fr/aa/
4434 ) using Version 5.01 of the document class
4439 This package can be downloaded from the ftp site
4442 \begin_layout Standard
4443 \begin_inset VSpace medskip
4449 \begin_layout Standard
4451 \begin_inset Flex URL
4454 \begin_layout Plain Layout
4456 ftp://ftp.edpsciences.org/pub/aa/readme.html
4464 \begin_layout Standard
4465 \begin_inset VSpace medskip
4471 \begin_layout Standard
4472 A manual comes together with that package, and this text is not meant to
4473 replace the original manual but merely a short guide how to realize the
4474 correct form of your paper.
4478 \begin_layout Standard
4479 Please note that the publisher of the journal was changed from Springer
4480 to EDP Sciences starting January 1, 2001.
4481 That change implicated also some slight changes of the style files, namely
4482 the removal of the thesaurus command.
4483 The LyX class aa supports the newest version of these style files, V 5.01.
4484 If you have an older version installed, please upgrade.
4485 For compatibility, the old (version 4) layout has been kept as
4490 Please refer to the comments in
4492 LyXDir/layouts/aapaper.layout
4497 \begin_layout Subsection
4501 \begin_layout Standard
4502 It is recommended you start from the example template distributed with LyX.
4503 If you are not using a template, note the following settings:
4506 \begin_layout Itemize
4516 ocument\SpecialChar \menuseparator
4523 dialog (OK, that one was obvious).
4526 \begin_layout Itemize
4527 Don't change the option
4530 \begin_inset space ~
4540 The whole layout is done by the macros, you shouldn't change anything.
4543 \begin_layout Subsection
4547 \begin_layout Standard
4548 First thing to enter is the header information.
4549 It consists of seven entries, of which some are optional.
4553 \begin_layout Itemize
4561 \begin_layout Itemize
4569 \begin_layout Itemize
4577 \begin_layout Itemize
4585 \begin_layout Itemize
4590 : [optional] if more than one author: whom to contact for offprint requests.
4593 \begin_layout Itemize
4598 : [optional] mail address for contacts.
4601 \begin_layout Itemize
4609 Received: <date>; Accepted <date>
4612 \begin_layout Standard
4613 There is no need to issue the
4619 command, this is done automatically by LyX when the header is finished.
4620 Although the order of the single header entries doesn't matter it is advised
4621 to keep the above sequence, just to get the best optics and meets the layout
4622 of the real document.
4625 \begin_layout Standard
4626 If you want to place footnotes in the header block, e.
4627 \begin_inset space \thinspace{}
4631 \begin_inset space ~
4634 to state your present address, just use the standard footnote via
4639 nsert\SpecialChar \menuseparator
4647 LyX will automagically use the term
4656 \begin_layout Standard
4657 In addition to these topics, the macros use three additional LaTeX commands
4658 that have no counterpart in LyX:
4661 \begin_layout Itemize
4668 to separate different names for more than one author and institute, respectivel
4672 \begin_layout Itemize
4679 to mark corresponding author/institute pairs.
4680 The institutes are numbered sequentially as they appear in the
4684 field, so you have to put a marker to each author.
4687 \begin_layout Itemize
4694 to supply an email address for fast contact.
4697 \begin_layout Standard
4698 In all cases, the appropriate command has to be entered in LyX and marked
4704 \begin_layout Subsection
4708 \begin_layout Standard
4709 The abstract should immediately follow the header block.
4710 With version 5 the abstract environment was changed to a command, and there
4711 is now a resctriction to only one paragraph.
4712 In addition, it should contain an entry with the keywords.
4713 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4720 by hand and mark it as LaTeX code.
4721 Refer to the example paper.
4724 \begin_layout Subsection
4725 Supported environments
4728 \begin_layout Standard
4729 The A&A paper layout supports the following environments for structuring
4733 \begin_layout Itemize
4739 \begin_layout Itemize
4745 \begin_layout Itemize
4751 \begin_layout Itemize
4757 \begin_layout Itemize
4763 \begin_layout Itemize
4769 \begin_layout Itemize
4775 \begin_layout Itemize
4781 \begin_layout Itemize
4787 \begin_layout Itemize
4793 \begin_layout Itemize
4799 \begin_layout Itemize
4805 \begin_layout Subsection
4806 Commands not supported by LyX
4809 \begin_layout Standard
4810 Some commands are not yet supported by the
4815 Some have already been mentioned.
4816 For the sake of completeness, they are listed all together here:
4819 \begin_layout Itemize
4827 \begin_layout Itemize
4835 \begin_layout Itemize
4843 \begin_layout Itemize
4851 \begin_layout Itemize
4859 \begin_layout Itemize
4867 \begin_layout Itemize
4875 \begin_layout Itemize
4883 \begin_layout Standard
4884 If you want to use any of these commands, you have to enter them yourself.
4887 Do not forget to mark them as LaTeX code!
4890 \begin_layout Subsection
4891 Figure and Table Floats
4894 \begin_layout Standard
4895 LyX provides support for the necessary float environments
4897 figure, figure*, table
4903 , therefore we won't tell much about it here.
4907 \begin_inset space ~
4913 Just remember that tables should be left-aligned.
4914 For that, select the table and change the alignment in
4919 dit\SpecialChar \menuseparator
4925 \begin_inset space ~
4931 \begin_layout Standard
4932 There is only one special thing: the figures with caption besides the figure.
4933 To create such a figure, you have to do the following:
4936 \begin_layout Enumerate
4937 Create a wide figure float:
4942 nsert\SpecialChar \menuseparator
4947 t\SpecialChar \menuseparator
4950 , then right click in the figure and select
4956 \begin_inset space ~
4964 \begin_layout Enumerate
4965 Enter your caption text.
4968 \begin_layout Enumerate
4973 to move the cursor above the caption.
4976 \begin_layout Enumerate
4980 \begin_layout Enumerate
4981 Position the cursor behind the figure and insert a horizontal fill:
4986 nsert\SpecialChar \menuseparator
4992 \begin_inset space ~
4997 \SpecialChar \menuseparator
5001 \begin_inset space ~
5009 \begin_layout Enumerate
5010 Switch to LaTeX mode:
5013 \begin_inset space ~
5021 \begin_layout Enumerate
5031 Do not close the brace!
5034 \begin_layout Enumerate
5035 Position the cursor behind the caption text, switch to LaTeX mode and insert
5039 \begin_inset space ~
5051 \begin_layout Standard
5052 Also, refer to the figures in the example paper.
5055 \begin_layout Subsection
5059 \begin_layout Standard
5060 For submission, the paper has to be formated in a special double-spacing
5062 For this purpose, you have to give the option
5066 to the documentclass.
5067 This must be done using the extra class options field in the
5072 ocument\SpecialChar \menuseparator
5080 Just enter the string
5087 \begin_layout Subsection
5091 \begin_layout Standard
5096 directory contains an example paper written with LyX.
5097 It is the example paper from the original macro package, translated to
5099 Use it for inspiration, and compare the original LaTeX code with LyX way
5103 \begin_layout Section
5107 \begin_layout Standard
5113 \begin_layout Subsection
5117 \begin_layout Standard
5118 AASTeX is a set of macros produced by the American Astronomical Society
5119 to facilitate electronic manuscript submission to the three journals they
5120 publish: the Astrophysical Journal (including the Letters and Supplement),
5121 the Astronomical Journal, and the Publications of the Astronomical Society
5123 LyX has proven to be an excellent tool for generating these documents,
5124 especially given its equation, citation, and figure handling capabilities.
5125 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5126 is the version described here, or higher.
5127 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5128 incompatible with LyX.
5129 The AASTeX package may be downloaded from the AASTeX Web site
5132 \begin_layout Standard
5133 \begin_inset VSpace medskip
5139 \begin_layout Standard
5141 \begin_inset Flex URL
5144 \begin_layout Plain Layout
5146 http://www.journals.uchicago.edu/AAS/AASTeX
5154 \begin_layout Standard
5155 \begin_inset VSpace medskip
5161 \begin_layout Standard
5162 A complete user guide is contained in that package and you should familiarize
5163 yourself with it thoroughly before embarking on writing a paper in LyX.
5164 LyX will not reduce the need to figure out all the AASTeX commands, it
5165 will only reduce the drudgery of typing everything in.
5166 It is your responsibility to ensure that the final exported LaTeX document
5167 conforms completely to the requirements of the journal to which you are
5168 submitting your paper.
5171 \begin_layout Subsection
5172 Starting a New Paper
5175 \begin_layout Standard
5176 I strongly suggest that you start with the AASTeX template file.
5182 ile\SpecialChar \menuseparator
5192 , enter the new file name, then choose the
5197 This will show the most common fields found in a manuscript.
5198 Simply overwrite the existing text (including the brackets,
5202 ) with the correct information.
5203 Many of the AASTeX commands and environments can be implemented directly
5204 in LyX, but some cannot: most noticeably
5216 , which should stick out like a sore thumb if you actually just opened the
5218 For commands such as these, the LaTeX code must be entered directly and
5220 Such commands are referred to as ERT, or Evil Red Text.
5221 I tried to minimize the amount of ERT needed in an AASTeX document, but
5222 there is still a bit more required than any of us would like.
5225 \begin_layout Subsection
5226 Finishing Your Paper
5229 \begin_layout Standard
5230 When the paper is finished to your satisfaction and previews/prints correctly,
5232 \begin_inset Quotes eld
5236 \begin_inset Quotes erd
5239 actions which need to be done before you submit it to the journals.
5243 \begin_layout Enumerate
5244 Export your paper as a LaTeX file (
5249 ile\SpecialChar \menuseparator
5254 xport\SpecialChar \menuseparator
5265 \begin_layout Enumerate
5270 file with your favorite text editor
5274 \begin_layout Enumerate
5275 remove the comment lines before the
5284 \begin_layout Enumerate
5289 usepackage...{fontenc}
5291 line if it appears (usually just after
5306 \begin_layout Enumerate
5307 remove everything between (and including) the
5319 commands, except for any commands you specifically put into the LaTeX preamble
5320 (which should appear immediately after the
5321 \begin_inset Quotes eld
5324 User specified LaTeX commands
5325 \begin_inset Quotes erd
5336 \begin_layout Enumerate
5337 Run the resulting file through LaTeX to make sure it still processes correctly.
5340 \begin_layout Enumerate
5341 Reread the journal requirements to make sure your filenames and formats
5345 \begin_layout Enumerate
5349 \begin_layout Subsection
5350 Comments On Specific Commands
5353 \begin_layout Standard
5354 I will not describe the detailed usage of the individual AASTeX commands:
5355 the AASTeX User Guide (
5359 ) gives a good description of each.
5360 Thus it's probably easiest for me to go down the list as found in the guide
5361 and offer comments where necessary.
5362 So let's begin \SpecialChar \ldots{}
5366 \begin_layout Subsubsection
5367 Things that work as expected
5370 \begin_layout Standard
5374 \begin_layout Plain Layout
5386 \begin_layout Standard
5387 Because they work as you might expect, I simply list them and the section
5488 begin{thebibliography}
5496 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5497 graphicx figure commands (2.14.1),
5521 (2.15.4, amongst other places),
5548 \begin_layout Standard
5549 The following style options also work correctly:
5570 Simply put them in the
5576 Layout\SpecialChar \menuseparator
5582 \begin_layout Standard
5586 \begin_layout Plain Layout
5598 \begin_layout Subsubsection
5599 Things that work, but require more comment
5602 \begin_layout Standard
5603 The following items work, but require a little more discussion:
5606 \begin_layout Itemize
5607 These items are reserved for use by the journal editors, but you can put
5608 them into the LaTeX preamble if you feel compelled to do so:
5641 \begin_layout Itemize
5642 These items may be placed in the LaTeX preamble, and are included as blanks
5643 in the template file:
5664 \begin_layout Itemize
5671 (2.3) -- can only be used
5672 \begin_inset Quotes eld
5676 \begin_inset Quotes erd
5679 , not in the middle of a paragraph.
5680 Use ERT if you need to embed it.
5683 \begin_layout Itemize
5690 (2.3) -- will have extra {} after it.
5691 This should not cause an error.
5694 \begin_layout Itemize
5701 (2.6) -- can only be used
5702 \begin_inset Quotes eld
5706 \begin_inset Quotes erd
5709 , not in the middle of a paragraph.
5710 Use ERT if you need to embed it.
5713 \begin_layout Itemize
5720 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5724 \begin_layout Itemize
5731 (2.8) -- same as for
5738 \begin_layout Itemize
5745 (2.9) -- will have extra {} after it.
5746 This should not cause an error.
5749 \begin_layout Itemize
5756 (2.11) -- will have extra {} after it.
5757 This should not cause an error.
5760 \begin_layout Itemize
5767 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5768 at the beginning of the text and selecting
5770 Insert\SpecialChar \menuseparator
5775 \begin_inset Quotes eld
5779 \begin_inset Quotes erd
5782 inserts an optional argument of the type needed by
5789 Hopefully it will be renamed someday.
5792 \begin_layout Itemize
5805 for the catalog ID optional parameter
5808 \begin_layout Itemize
5821 for the catalog ID optional parameter
5824 \begin_layout Subsubsection
5825 Things not implemented, use ERT
5828 \begin_layout Standard
5832 \begin_layout Plain Layout
5844 \begin_layout Standard
5867 setcounter{equation}
5869 (2.12), Journal name abbreviations (2.13.4),
5905 (2.15.4, insert it as the first element in the lefthand cell after where
5907 Don't use any of LyX's rules in the table),
5919 (2.15.5), much of Misc (2.17, except
5970 \begin_layout Standard
5974 \begin_layout Plain Layout
5986 \begin_layout Subsubsection
5987 Things that cannot be implemented
5990 \begin_layout Standard
5991 \SpecialChar \ldots{}
5992 at least in any meaningful sort of way, so I suggest ignoring them.
5993 They are the references environment (2.13.3), and the deluxetable environment
5995 If you really, really need to use deluxetable, I suggest editing it in
5996 a separate file with a text editor, then using
6001 nsert\SpecialChar \menuseparator
6007 \begin_inset space ~
6012 to include it in your LyX document.
6017 file to see an example of this.
6020 \begin_layout Subsection
6021 FAQs, Tips, Tricks, and Other Ruminations
6024 \begin_layout Subsubsection
6025 Getting LyX and AASTeX to cooperate
6028 \begin_layout Standard
6029 It can be a bit tricky to get LyX to recognize a new layout and document
6031 When all else fails, do this:
6034 \begin_layout Enumerate
6035 Make certain that LaTeX can find AASTeX.
6036 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6037 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6044 \begin_layout Enumerate
6056 \begin_layout Enumerate
6062 ools\SpecialChar \menuseparator
6069 in LyX, then restart LyX.
6072 \begin_layout Enumerate
6073 Open a regular new file, not from a template.
6074 Does AASTeX appear in the class list in
6079 ocument\SpecialChar \menuseparator
6089 \begin_layout Standard
6090 If you get a warning from an existing AASTeX document about not being able
6091 to find the AASTeX layout or a message about
6092 \begin_inset Quotes eld
6095 You should not mix title layouts with normal ones
6096 \begin_inset Quotes erd
6099 , things haven't been installed correctly.
6102 \begin_layout Subsubsection
6103 LaTeX error processing a table
6106 \begin_layout Standard
6107 LyX, by default, attempts to center the table caption/title.
6108 This seems to produce a bad interaction in AASTeX so you should click somewhere
6109 in the caption/title, then select
6114 dit\SpecialChar \menuseparator
6120 \begin_inset space ~
6137 This took care of it for me.
6140 \begin_layout Subsubsection
6144 \begin_layout Standard
6145 A couple of things: 1) I have noticed some funny spacing in the reference
6146 entries in the text.
6147 When you enter the bibliography item data, make sure their is
6151 space between the last author and the parenthesis setting off the year;
6155 \begin_inset space \thinspace{}
6159 \begin_inset space ~
6173 2) Entering the references at all is not obvious.
6174 The easiest thing is to start typing your first reference at the end of
6175 the document, then mark it as type
6180 That will put a small gray box in front of what you just typed.
6181 Click on the box to fill in the rest of the information.
6182 For new references, go to the end of an existing reference and press return.
6183 That will create a new line with its own box, etc.
6186 \begin_layout Subsubsection
6190 \begin_layout Standard
6191 Even though AASTeX provides its own figure commands (
6197 , for example), I much prefer LaTeX's standard figure commands (with the
6206 \begin_inset space ~
6209 commands as ERT into a Figure Float box if you desire, but I never have
6210 much luck getting the layout right.
6211 With the standard graphics, LyX will insert a
6215 usepackage{graphicx}
6217 command into the LaTeX preamble and handle the figures in the standard
6218 LaTeX2e way, interspersing the figures in the text.
6219 I believe ApJ accepts figures exactly this way now; AJ might still use
6221 \begin_inset Quotes eld
6224 stack everything at the end
6225 \begin_inset Quotes erd
6231 \begin_layout Subsubsection
6232 Things I could have done, but didn't
6235 \begin_layout Standard
6237 \begin_inset Quotes eld
6241 \begin_inset Quotes erd
6244 things I could have implemented, but chose not to.
6245 For instance, I saw no point in double-spacing the text in the LyX window,
6246 even though it is double-spaced in the paper manuscript.
6247 Also, I chose not to make separate layouts for the preprint and preprint2
6249 Since I assume you will spend most of your time in the plain manuscript
6250 mode anyway, I decided not to chew up more disk space with this.
6254 \begin_layout Subsection
6258 \begin_layout Standard
6259 Your mileage may vary.
6260 I've now had papers published by both ApJ and AJ that have had 98% of the
6261 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6263 I have had no trouble with the submission process, and I'm sure the journals
6264 were never aware that there might be a difference.
6265 So, go forth and publish!
6268 \begin_layout Section
6272 \begin_layout Standard
6275 Panayotis Papasotiriou
6278 \begin_layout Subsection
6282 \begin_layout Standard
6283 The ijmpc package is a set of macros that facilitates electronic manuscript
6286 International Journal of Modern Physics C
6289 Similarly, the ijmpd package is for creating manuscripts to be submitted
6292 International Journal of Modern Physics D
6295 Both journals are published by World Scientific.
6296 The corresponding document classes are named
6305 These files, together with instructions for the authors, can be downloaded
6307 \begin_inset Flex URL
6310 \begin_layout Plain Layout
6312 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6318 \begin_inset Flex URL
6321 \begin_layout Plain Layout
6323 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6329 Both packages are modified versions of the standard
6330 \begin_inset Quotes eld
6334 \begin_inset Quotes erd
6337 package, and they are almost (but not exactly) identical.
6338 Most of their features are supported by LyX.
6339 I have used LyX successfully to write articles submitted to both journals
6340 without any problem.
6343 \begin_layout Subsection
6347 \begin_layout Standard
6348 As usual, the easiest way to write a paper is to start with a template.
6354 ile\SpecialChar \menuseparator
6373 This will give an (almost) empty document that includes the most common
6374 fields found in a manuscript.
6375 Simply overwrite the existing text (including the brackets,
6380 You should keep in mind the following remarks.
6383 \begin_layout Enumerate
6384 LyX won't let you change the font size and the page style of the document,
6385 because such modifications are not allowed by both packages.
6388 \begin_layout Enumerate
6389 The language of the document should not be changed.
6390 Before previewing your paper, be sure that the babel package is not used.
6391 To do this, click on
6396 ools\SpecialChar \menuseparator
6414 checkbox in the language settings, and click on
6425 , if you wish to make this change permanent).
6428 \begin_layout Enumerate
6430 \begin_inset Quotes eld
6434 \begin_inset Quotes erd
6437 style must be used to define keywords.
6440 \begin_layout Enumerate
6441 The ijmpc package provides a style named
6442 \begin_inset Quotes eld
6445 Classification Codes
6446 \begin_inset Quotes erd
6449 , which can be used to define classification codes, such as PACS numbers.
6450 Note that this facility is not supported by the ijmpd package.
6453 \begin_layout Enumerate
6454 Several new environments are available:
6455 \begin_inset Quotes eld
6459 \begin_inset Quotes erd
6463 \begin_inset Quotes eld
6467 \begin_inset Quotes erd
6471 \begin_inset Quotes eld
6475 \begin_inset Quotes erd
6479 \begin_inset Quotes eld
6483 \begin_inset Quotes erd
6487 \begin_inset Quotes eld
6491 \begin_inset Quotes erd
6495 \begin_inset Quotes eld
6499 \begin_inset Quotes erd
6503 \begin_inset Quotes eld
6507 \begin_inset Quotes erd
6511 \begin_inset Quotes eld
6515 \begin_inset Quotes erd
6519 \begin_inset Quotes eld
6523 \begin_inset Quotes erd
6527 \begin_inset Quotes eld
6531 \begin_inset Quotes erd
6535 \begin_inset Quotes eld
6539 \begin_inset Quotes erd
6543 \begin_inset Quotes eld
6547 \begin_inset Quotes erd
6551 \begin_inset Quotes eld
6555 \begin_inset Quotes erd
6559 \begin_inset Quotes eld
6563 \begin_inset Quotes erd
6567 Their use is more or less obvious.
6568 LyX supports all these environments; it will use the proper label, text
6569 style, and numbering scheme for each of them.
6572 \begin_layout Enumerate
6573 Both packages use basic citations; the natbib package should not be used.
6574 In LyX, citation references are shown as usual; in the output, citations
6575 are shown as superscripts.
6576 If you want to use a citation as normal text, you should use the
6581 \begin_inset space \thinspace{}
6585 \begin_inset Quotes eld
6589 \begin_inset space ~
6599 \begin_inset Quotes erd
6605 \begin_layout Enumerate
6607 \begin_inset Quotes eld
6611 \begin_inset Quotes erd
6614 section in both packages.
6615 To put acknowledgments, just use the
6616 \begin_inset Quotes eld
6620 \begin_inset Quotes erd
6626 \begin_layout Enumerate
6627 Appendices may be added to the paper,
6631 the Acknowledgments and
6636 LyX provides a special environment, called
6637 \begin_inset Quotes eld
6641 \begin_inset Quotes erd
6644 which marks the beginning of the appendices.
6645 This environment should be left blank; it just sends a LaTeX command, but
6646 nothing is really printed.
6648 \begin_inset Quotes eld
6652 \begin_inset Quotes erd
6655 is printed with blue letters, as a signal that all sections after that
6656 point are appendices.
6657 To write an appendix, use the
6658 \begin_inset Quotes eld
6662 \begin_inset Quotes erd
6666 LyX will number each appendix with capital letters, as required by both
6669 \begin_inset Quotes eld
6673 \begin_inset Quotes erd
6680 be present before the first appendix; if not, all appendices will be numbered
6681 as normal sections in the output.
6684 \begin_layout Enumerate
6685 The ijmpc and the ijmpd packages use the
6689 command to implement table captions.
6690 As a result, a table created by LyX is printed correctly, but its caption
6692 However, you can use some ERT to overpass this problem, so that captions
6693 are printed as expected.
6694 To do so, create a float table as usual, remove the caption, and replace
6705 (sic); you must also the ERT
6709 immediately after the tabular material.
6710 Study the example table included in the template files to see how this
6711 trick is implemented.
6712 Alternatively, If you need table captions, you should implement the whole
6717 file, then include this file to the LyX document (
6722 nsert\SpecialChar \menuseparator
6727 \SpecialChar \menuseparator
6733 \begin_inset space ~
6739 Details on how to create a table float can be found in the files
6747 , included in the corresponding packages.
6750 \begin_layout Subsection
6751 Preparing a paper for submission
6754 \begin_layout Standard
6755 Before you submit your paper you must export the LyX document as a LaTeX
6761 ile\SpecialChar \menuseparator
6766 xport\SpecialChar \menuseparator
6781 \begin_layout Plain Layout
6782 Actually you have the choice between LaTeX (plain) and pdflatex.
6783 If you intend to use pdflatex to prepare the paper, you should use the
6784 pdflatex option so that included graphics are converted to PDF format,
6785 ready for use by pdflatex.
6790 , then make the following changes to the resulting
6797 \begin_layout Enumerate
6798 Remove the comment lines before the
6807 \begin_layout Enumerate
6808 Remove everything between (and including) the
6820 commands, except for any commands you specifically put into the LaTeX preamble.
6823 \begin_layout Standard
6828 file should be saved and processed through LaTeX as many times as necessary.
6829 You may also want to check the resulting
6836 \begin_layout Subsection
6840 \begin_layout Standard
6841 The use of ERT is reduced to two commands, which must be placed at the top
6843 If you started writing your paper by using the
6851 template, the ERT needed is already in its place; you usually don't need
6853 You may only modify the first ERT to specify the information printed to
6854 the top of odd and even pages (authors' names and short paper's title,
6856 This ERT must have the form
6860 markboth{Authors' Names}{Short Paper's Title}
6865 \begin_layout Section
6869 \begin_layout Standard
6875 \begin_layout Subsection
6879 \begin_layout Standard
6880 The iopart package provides a document class to create electronic manuscript
6881 submission to the journals published by the Institute of Physics.
6882 Instructions for the authors how to create a paper using the iopart class
6883 can be downloaded together with the iopart package from the site
6884 \begin_inset Flex URL
6887 \begin_layout Plain Layout
6889 ftp://ftp.iop.org/pub/journals/latex2e
6897 \begin_layout Subsection
6901 \begin_layout Standard
6902 The easiest way to write a paper is to start with the file
6906 that is available in LyX's examples files folder.
6907 Open this file, save it under a new name, and start writing.
6908 The example file explains how to use the special text environments.
6909 Here are the most important advices:
6912 \begin_layout Itemize
6913 To be able to compile your document to a PDF, PS, or DVI, assure that the
6916 Use AMS math package
6918 in the document settings under
6925 \begin_layout Itemize
6928 The title environment defines the kind of your paper.
6929 So use one of the following environments for the title:
6933 \begin_layout Itemize
6942 \begin_layout Itemize
6951 \begin_layout Itemize
6957 for a Topical review
6960 \begin_layout Itemize
6969 \begin_layout Itemize
6978 \begin_layout Itemize
6984 for a Paper (same as Title)
6987 \begin_layout Itemize
6993 for a Preliminary communication
6996 \begin_layout Itemize
7002 for a Rapid communication
7005 \begin_layout Itemize
7011 for a Letter to the editor
7015 \begin_layout Itemize
7018 All title environments except of
7022 can have an optional short title.
7025 \begin_layout Itemize
7026 There is a general title environment
7030 which is not directly supported by the LyX.
7031 This can be used as ERT when your document doesn't fit into one of the
7035 \begin_layout Standard
7036 For more informations like hints for special table and formula formatting,
7037 look at the IOP author guidelines.
7040 \begin_layout Section
7044 \begin_layout Standard
7047 Panayotis Papasotiriou
7050 \begin_layout Subsection
7054 \begin_layout Standard
7055 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7056 that facilitates electronic manuscript submission to the journals they
7058 Most known of them (at least in my domain of interest) are
7060 Astrophysics and Space Science
7066 , but there are many others (see a complete list at
7067 \begin_inset Flex URL
7070 \begin_layout Plain Layout
7072 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7078 The Kluwer package may be downloaded from the site
7079 \begin_inset Flex URL
7082 \begin_layout Plain Layout
7084 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7090 A complete user guide is contained in that package (but it can also be
7091 downloaded separately).
7094 \begin_layout Standard
7095 LyX supports many features of the package but not everything.
7096 However, the ERT needed is reduced to some
7097 \begin_inset Quotes eld
7101 \begin_inset Quotes erd
7104 commands of the package (see
7105 \begin_inset space ~
7109 \begin_inset CommandInset ref
7111 reference "subsec:kluwer_peculiarities"
7116 I have recently used LyX to write an article submitted to the
7118 Astrophysics and Space Science
7120 without any problem.
7123 \begin_layout Subsection
7127 \begin_layout Standard
7128 The easiest way to write a paper is to start with the Kluwer template file.
7131 File\SpecialChar \menuseparator
7146 This will give an (almost) empty document that includes the most common
7147 fields found in a manuscript and a short description of their use.
7148 As in most templates, simply overwrite the existing text (including the
7153 ) with the correct information.
7156 \begin_layout Subsection
7157 Preparing a paper for submission
7160 \begin_layout Standard
7161 As in the AASTeX package, before you submit your paper to a journal you
7163 \begin_inset Quotes eld
7167 \begin_inset Quotes erd
7173 \begin_layout Enumerate
7174 Export your paper as a LaTeX file.
7175 To do this, click on
7180 ile\SpecialChar \menuseparator
7185 xport\SpecialChar \menuseparator
7196 \begin_layout Enumerate
7201 file with a text editor and make the following changes
7205 \begin_layout Enumerate
7206 remove the comment lines before the
7215 \begin_layout Enumerate
7216 remove everything between (and including) the
7228 commands, except for any commands you specifically put into the LaTeX preamble.
7231 \begin_layout Standard
7240 \begin_layout Enumerate
7245 file through LaTeX as many times as necessary (usually up to three).
7248 \begin_layout Enumerate
7254 \begin_inset space \thinspace{}
7261 , and check if everything is OK (it should, if you didn't make any mistake).
7264 \begin_layout Subsection
7265 \begin_inset Quotes eld
7269 \begin_inset Quotes erd
7272 of the Kluwer package
7273 \begin_inset CommandInset label
7275 name "subsec:kluwer_peculiarities"
7282 \begin_layout Standard
7283 The Kluwer package has the following
7284 \begin_inset Quotes eld
7288 \begin_inset Quotes erd
7294 \begin_layout Enumerate
7295 It is possible to write multiple articles in the same LaTeX file
7299 \begin_layout Plain Layout
7300 I can't imagine any good reason to do this.
7306 Each article must be included in the environment
7307 \begin_inset Quotes eld
7311 \begin_inset Quotes erd
7315 Unfortunately, this environment cannot be omitted, even if you write just
7317 Therefore, each article starts with the command
7323 and, obviously, ends with the command
7330 Although this can be implemented in LyX, I didn't included it, since it
7331 looks ugly and can confuse the novice user.
7332 Therefore, you need to enter them directly and mark them as LaTeX code
7334 \begin_inset Quotes eld
7338 \begin_inset Quotes erd
7344 \begin_layout Enumerate
7345 Information given at the beginning of the article (i.e., title, subtitle,
7346 author, institution, running title, running author, abstract and keywords)
7347 must be included in an environment called
7348 \begin_inset Quotes eld
7352 \begin_inset Quotes erd
7356 This is not implemented in LyX, so you must enter title, subtitle etc.
7357 \begin_inset space ~
7360 between two ERT lines (
7375 \begin_layout Enumerate
7376 According to the user manual, the label of each bibliography item must be
7400 \begin_layout Standard
7405 template takes care of all these
7406 \begin_inset Quotes eld
7410 \begin_inset Quotes erd
7414 If you start a new paper using this template you don't need to do anything
7419 \begin_layout Enumerate
7420 don't delete the ERT included in the template, and
7423 \begin_layout Enumerate
7424 copy the example bibliography item included in the template and modify it
7425 as necessary to enter new bibliography items.
7428 \begin_layout Section
7432 \begin_layout Standard
7438 \begin_layout Subsection
7442 \begin_layout Standard
7443 The LyX document classes
7445 article (koma-script)
7449 report (koma-script)
7467 correspond to the LaTeX document classes
7484 \begin_inset space ~
7487 of the Koma-Script family.
7488 They are replacements for the standard document classes
7504 , resp., and fit better to European typography conventions in a number of
7508 \begin_layout Itemize
7509 Standard character size is 11pt in
7511 article (koma-script)
7515 report (koma-script)
7523 letter (koma-script)
7528 \begin_layout Itemize
7529 Headings, labels of the description environment, and a number of elements
7532 letter (koma-script)
7534 document class are set in a bold sans serif font.
7538 \begin_layout Plain Layout
7539 There is a big difference between the bold sans serif old cm fonts and new
7540 ec fonts, especially in the appearance of headings.
7541 In comparison, the ec bold sans serif fonts look a bit thin.
7542 Here the LaTeX package
7550 helps to produce the
7551 \begin_inset Quotes eld
7555 \begin_inset Quotes erd
7558 appearance when using the ec fonts.
7563 The numbering of chapter headings is made in the same way as the numbering
7564 of section headings, that is without the extra line
7565 \begin_inset Quotes eld
7568 Chapter\SpecialChar \ldots{}
7570 \begin_inset Quotes erd
7574 In addition, the appearance of the headings can be modified by using a
7575 number of options (in LyX to be entered in the field
7582 \begin_inset space ~
7592 ayout\SpecialChar \menuseparator
7600 A detailed German description of these options can be found in the Koma-Script
7608 \begin_layout Itemize
7609 The main means in the Koma-Script document classes to design the type area
7618 (in LyX to be entered in the extra class options field in the dialog
7623 ocument\SpecialChar \menuseparator
7631 They make a clearer modification of page margins possible as do the options
7637 ocument\SpecialChar \menuseparator
7645 A detailed German description of these and other type area options can
7646 be found in the Koma-Script documentation
7653 \begin_layout Itemize
7654 The LaTeX document classes of the Koma-Script family define a number of
7655 additional commands.
7656 Those part of it which makes sense in LyX is implemented in corresponding
7660 \begin_layout Standard
7661 A detailed German description of the LaTeX document classes of the Koma-Script
7662 family can be found in the Koma-Script documentation
7670 \begin_layout Plain Layout
7671 There is an English translation
7675 , but it is not a complete one.
7680 The following sections describe only those aspects, which are relevant
7684 \begin_layout Subsection
7685 article (koma-script), report (koma-script), and book (koma-script)
7688 \begin_layout Standard
7689 The document classes
7691 article (koma-script)
7695 report (koma-script)
7705 are implemented in the layout files
7718 They contain all the paragraph types of the corresponding standard document
7731 , resp., partly modified, with the exception of the LyX specific
7735 -type, which is replaced by the new
7739 -type having the same functionality.
7744 -Type there is a number of new paragraph types added.
7751 letter (koma-script)
7756 \begin_layout Itemize
7765 : are equivalents to
7773 , resp., additionally inserting an entry in the table of contents.
7782 are not contained in
7784 article (koma-script)
7789 \begin_layout Itemize
7806 , resp., additionally clearing running heads.
7813 article (koma-script)
7819 \begin_layout Plain Layout
7832 report (koma-script)
7834 , but since this is identical to
7838 , is has not been implemented in LyX.
7846 \begin_layout Itemize
7851 : generates a heading directly above the following paragraph in the standard
7852 character size without affecting the structure of the document.
7855 \begin_layout Itemize
7864 are special captions which respect the different space settings needed
7865 for captions placed above or below an element (if you follow strict typographic
7866 rules, you might want to place table captions always above the table).
7867 You can also use the class option
7884 You need at least Koma-Script version 2.8q to use this.
7887 \begin_layout Itemize
7892 : can be used to set a bonmot, e.
7893 \begin_inset space \thinspace{}
7897 \begin_inset space ~
7900 at the beginning of a chapter.
7901 If you use the optional argument (
7906 nsert\SpecialChar \menuseparator
7908 \begin_inset space ~
7913 ), you can insert the dictum's author there.
7914 Dictum and author are separated by a line.
7915 You need at least Koma-Script version 2.8q to use this.
7922 article (koma-script)
7927 \begin_layout Standard
7928 The following types, together with the standard types
7940 , form the title area of the document.
7941 They must be entered ahead of the first
7942 \begin_inset Quotes eld
7946 \begin_inset Quotes erd
7953 \begin_layout Plain Layout
7954 The corresponding LaTeX commands must appear before the
7965 When such a type is used more than once, the latter usage overwrites the
7966 former one, that means, for every type only the latest usage is valid.
7967 The order of the different types however has, like
7979 , no effect on the appearance of the produced document.
7982 \begin_layout Itemize
7987 : produces a centered paragraph above the ordinary title (
7999 ) for the subject of the document.
8002 \begin_layout Itemize
8007 : produces a centered paragraph below the ordinary title (
8019 ) for the publishers' name.
8022 \begin_layout Itemize
8029 report (koma-script)
8035 produces a centered paragraph on its own page behind the title page, or
8038 article (koma-script)
8040 produces a centered paragraph below the ordinary title (
8059 \begin_layout Itemize
8064 : produces a left aligned paragraph above the ordinary title (
8080 ) for a document`s head.
8083 \begin_layout Itemize
8088 : produces in a double-sided print in
8090 report (koma-script)
8096 a left-aligned paragraph at the top of the title page`s back or has no
8097 effect in a single-sided print or in
8099 article (koma-script)
8104 \begin_layout Itemize
8109 : produces in a double-sided print in
8111 report (koma-script)
8117 a left-aligned paragraph at the bottom of the title page`s back or has
8118 no effect in a single-sided print or in
8120 article (koma-script)
8125 \begin_layout Itemize
8130 : produces a special
8131 \begin_inset Quotes eld
8135 \begin_inset Quotes erd
8138 page ahead of the actual document containing a paragraph without special
8142 \begin_layout Standard
8143 The layout files for the document classes
8145 article (koma-script)
8149 report (koma-script)
8160 This is thought of as a place to define your own types.
8165 in your personal layout directory and edit the file!
8168 \begin_layout Subsection
8169 letter (koma-script)
8172 \begin_layout Standard
8176 \begin_layout Plain Layout
8188 \begin_layout Standard
8192 letter (koma-script)
8194 is implemented in the layout file
8199 It contains all the paragraph types of the corresponding standard document
8204 , partly modified, with the exception of the LyX specific types
8216 type, which is replaced by the new
8221 In addition, it contains, in contrast to the standard document class, the
8239 Furthermore, there are a number of new letter specific types.
8242 \begin_layout Standard
8246 \begin_layout Plain Layout
8258 \begin_layout Standard
8259 The appearance of the letter produced by this document class can be controlled
8260 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8264 \begin_layout Plain Layout
8265 For example, the standard appearance of the letter`s heading, consisting
8266 of name and address, is quite self-willed.
8268 \begin_inset Quotes eld
8272 \begin_inset Quotes erd
8275 heading is produced by the following LaTeX commands in the preamble:
8278 \begin_layout LyX-Code
8288 \begin_layout LyX-Code
8304 \begin_layout LyX-Code
8314 \begin_layout LyX-Code
8334 A detailed German description of such LaTeX commands can be found in the
8335 Koma-Script documentation
8340 With it, the letter's author can produce his personal letter layout.
8343 \begin_layout Standard
8352 define the beginning of the letter and must be used in every letter.
8353 To emphasize them in the LyX document class, they are marked with the letter
8363 \begin_inset space ~
8367 It is possible to write any number of letters in one file.
8372 type produces a new letter using the same addressee and a
8376 type produces a new addressee.
8393 are ordinary paragraph types and can also be used several times in one
8394 and the same letter.
8397 \begin_layout Itemize
8402 : produces a paragraph for the addressee and implicitly defines the beginning
8406 \begin_layout Itemize
8411 : produces a paragraph for the form of address and implicitly produces a
8415 \begin_layout Itemize
8420 : produces a paragraph for a close.
8423 \begin_layout Itemize
8428 : produces a paragraph for a postscript.
8431 \begin_layout Itemize
8436 : produces a paragraph for a distribution list.
8439 \begin_layout Itemize
8444 : produces a paragraph for enclosures.
8447 \begin_layout Standard
8488 are input types provided with a label to enter information, which will
8489 be processed by the document class.
8493 \begin_layout Plain Layout
8494 It could be seen as a matter of inconsequence, that the types
8502 described above are not such input types as well.
8503 Because of the special meaning of those types, however, I have implemented
8504 them as ordinary paragraph types with a one letter mark in the left margin.
8505 Moreover, it would affect my feeling of symmetry, if the
8513 type had such a serious different appearance.
8518 The types must be used ahead of the corresponding
8525 \begin_layout Standard
8526 An implementation of these types in a WYSIWYG fashion does not seem to make
8527 sense, because the real appearance of the produced letter does not only
8528 depend on the usage of the particular type, but also on other factors.
8529 For example, a signature entered in the
8533 type will in the standard behavior appear in the produced letter only,
8534 when in the same letter also a
8539 The entered value of the
8543 type will in the standard behavior not appear in the produced letter at
8545 The possibility to design the letter`s heading freely is already indicated
8546 in a footnote above.
8549 \begin_layout Standard
8550 The input types can also be used as empty paragraphs.
8552 \begin_inset space \thinspace{}
8556 \begin_inset space ~
8568 type is not used at all, in the standard behavior the value of the
8572 type is used as signature, whereas if an empty
8576 type is used, no signature value is defined.
8579 \begin_layout Standard
8580 By using the input types it is possible to write a letter template, containing
8581 filled input types with your personal dates (name, address, etc.) and empty
8582 input types for other dates you want to enter.
8585 \begin_layout Itemize
8590 : sender's name, in the standard behavior appears as a centered paragraph
8591 in small caps in the letter`s heading.
8594 \begin_layout Itemize
8599 : sender's signature, in the standard behavior appears below the
8608 type is used, the value of the
8612 type appears instead.
8615 \begin_layout Itemize
8620 : sender's address, in the standard behavior appears in a centered paragraph
8621 in the letter`s heading below the sender's name.
8624 \begin_layout Itemize
8629 : sender's telephone number, in the standard behavior only sets the LaTeX
8639 \begin_layout Itemize
8644 : place of the letter`s making.
8647 \begin_layout Itemize
8652 : date of the letter`s making.
8661 , in the standard behavior, produce the place and the date in a right-aligned
8662 line below the addressee's field.
8667 type is used, neither place nor date appear, independent of the value of
8677 type is used, the date of the letter `s production is used.
8680 \begin_layout Itemize
8685 : sender`s back address, in the standard behavior appears above the addressee's
8686 field in a small sans serif font.
8689 \begin_layout Itemize
8694 : special mail information, in the standard behavior appears underlined
8695 above the addressee's field below the back address.
8698 \begin_layout Itemize
8703 : additional information, in the standard behavior appears on right side
8704 below the addressee`s field.
8707 \begin_layout Itemize
8712 : the letter's title, in the standard behavior appears in a big, bold, sans
8713 serif font above the subject.
8716 \begin_layout Itemize
8721 : the letter's subject, in the standard behavior appears in a bold font
8729 \begin_layout Standard
8750 produce a business letter like line above the
8754 line containing the fields
8755 \begin_inset Quotes eld
8759 \begin_inset Quotes erd
8763 \begin_inset Quotes eld
8767 \begin_inset Quotes erd
8771 \begin_inset Quotes eld
8775 \begin_inset Quotes erd
8779 \begin_inset Quotes eld
8783 \begin_inset Quotes erd
8787 \begin_inset Quotes eld
8791 \begin_inset Quotes erd
8795 \begin_inset Quotes eld
8799 \begin_inset Quotes erd
8803 For the date field, the value of the
8809 \begin_inset Quotes eld
8812 business letter types
8813 \begin_inset Quotes erd
8816 is used, the value of the
8820 type however does not appear, but only the LaTeX variable
8827 The ordinary output of place and date in a right-aligned line below the
8828 addressee`s field is suppressed.
8829 The types are implemented as input types provided with a label and must
8830 be used ahead of the corresponding
8837 \begin_layout Itemize
8845 \begin_layout Itemize
8853 \begin_layout Itemize
8861 \begin_layout Itemize
8869 \begin_layout Itemize
8877 \begin_layout Subsection
8878 The new letter class: letter (koma-script v.2)
8881 \begin_layout Standard
8884 Jürgen Spitzmüller
8887 \begin_layout Standard
8888 \begin_inset VSpace medskip
8894 \begin_layout Standard
8896 Koma-Script version 2.8 has introduced a new letter class
8900 which supersedes the now unsupported
8905 It has --- on the LaTeX side --- a completely new interface and is not
8906 compatible with the old class.
8907 Therefore, LyX supports both, though it is recommended to use the new class.
8910 \begin_layout Standard
8911 This class covers the same functionality as
8913 letter (koma-script),
8920 (receiver's address, same as
8937 will start a new letter (i.
8938 \begin_inset space \thinspace{}
8942 \begin_inset space ~
8945 you can write several letters per document).
8946 New elements are sender's
8962 and the possibility to use a
8971 nsert\SpecialChar \menuseparator
8981 \begin_layout Standard
8982 The biggest improvement is, though, that the letter's layout is configurable
8983 at almost any needs.
8984 This can be done via the preamble or with a special style file (Letter
8985 Class Option, extension
8989 ), that will be read in as a class option.
8993 \begin_layout Plain Layout
8994 The KOMA package comes with some default
8999 There is, for instance, a
9003 file that follows german typesetting rules, or a
9007 that provides the default layout of the old
9012 The latter can be loaded with the class option
9021 ayout\SpecialChar \menuseparator
9026 ocument\SpecialChar \menuseparator
9038 template that is included in LyX for examples.
9039 A detailed description is to be found in the Koma-Script documentation
9047 \begin_layout Subsection
9051 \begin_layout Standard
9052 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9056 \begin_layout Itemize
9057 The chapter number of a
9061 type appears on a line of its own above the chapter heading instead of
9062 appearing in the same line ahead of it.
9063 The cause for that is the LyX internal behavior for the labeltype
9070 \begin_layout Itemize
9071 The headings of the types
9080 \begin_inset Quotes eld
9084 \begin_inset Quotes erd
9087 LaTeX table of contents, but not in the LyX table of contents (
9092 ocument\SpecialChar \menuseparator
9098 \begin_inset space ~
9102 \begin_inset space ~
9110 \begin_layout Itemize
9115 document class appear in a skip separation mode, not indented.
9116 This is the standard behavior, no special LaTeX commands are needed for
9123 ocument\SpecialChar \menuseparator
9130 dialog the corresponding radio button indicates
9146 value always has the effect that extra LaTeX commands are inserted in the
9147 document to produce the gap, which is not what is wanted in this case.
9150 \begin_layout Section
9158 \begin_layout Standard
9164 \begin_layout Subsection
9168 \begin_layout Standard
9169 These are the layout files for some of the journal formats used by Springer
9170 Verlag and listed on
9171 \begin_inset Flex URL
9174 \begin_layout Plain Layout
9176 http://www.springer.de/author/tex/help-journals.html
9181 , where you should also go to fetch the class files (yes, these are LaTeX2e
9183 It is a modular system: the things common to all journals are implemented
9188 , which journal-specific layout files (such as, e.
9189 \begin_inset space \thinspace{}
9196 for Journal of Geodesy) can include.
9199 \begin_layout Standard
9200 This means that implementing support for any other Springer journal on this
9201 list is as simple as writing your own
9209 file following the outline given in
9217 \begin_layout Standard
9218 It is reasonably well tested only for the Journal of Geodesy.
9227 come with the standard LyX distribution.
9228 Install the relevant class file (downloaded from Springer) in a proper
9229 directory, reconfigure LaTeX (in the teTeX case by running
9233 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9234 LyX and it should work.
9237 \begin_layout Subsection
9241 \begin_layout Standard
9242 A large number of theorem-like styles ---
9248 \SpecialChar \ldots{}
9254 \begin_layout Standard
9257 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9258 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9261 See the Springer class file documentation for details.
9264 \begin_layout Subsection
9268 \begin_layout Itemize
9280 \begin_layout Itemize
9283 Probability Theory and Related Fields
9289 --- Jean-Marc Lasgouttes
9292 \begin_layout Standard
9293 Add your own, it isn't so hard!
9296 \begin_layout Subsection
9300 \begin_layout Standard
9301 These files are partly based on the older
9305 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9311 layout, are now defunct.
9312 Jean-Marc Lasgouttes helped out big in making me find my way around the
9313 LyX layout file mechanism.
9316 \begin_layout Subsection
9320 \begin_layout Standard
9322 But probably less than in the old hacked-LaTeX
9329 \begin_layout Standard
9331 \begin_inset space \thinspace{}
9334 g.: does not display the number for theorem-like layouts, just #.
9337 \begin_layout Section
9345 \begin_layout Standard
9351 \begin_layout Subsection
9355 \begin_layout Standard
9356 These are the layout files for some of the journals of the American Geophysical
9358 It is assumed that you have both the AGU's own class files and AGUplus
9359 installed (everything to be found at
9360 \begin_inset Flex URL
9363 \begin_layout Plain Layout
9365 ftp://ftp.agu.org/journals/latex/journals
9373 \begin_layout Subsection
9377 \begin_layout Standard
9387 They are still called this in the LyX GUI, though their LaTeX equivalents
9388 in the AGU classes are
9399 \begin_layout Standard
9400 Newly defined styles are
9437 These are mostly manuscript attributes and defined in the AGU class documentati
9441 \begin_layout Standard
9442 I suspect this is still badly incomplete.
9445 \begin_layout Subsection
9449 \begin_layout Standard
9466 \begin_layout Subsection
9470 \begin_layout Itemize
9473 Journal of Geophysical Research
9482 \begin_layout Standard
9483 Add your own, it isn't so hard! Look at the
9494 \begin_layout Subsection
9495 Bugs and things to remember
9498 \begin_layout Standard
9499 In order to use the new layouts, you must remember to do the following for
9503 \begin_layout Enumerate
9509 This can be done in the
9511 layout\SpecialChar \menuseparator
9516 document\SpecialChar \menuseparator
9520 (AGU articles are always in English, right? So
9527 \begin_layout Enumerate
9537 (Yes, this is a bug.)
9540 \begin_layout Enumerate
9541 Make sure you use the
9545 bibliography style, by entering
9549 into the second field of the BibTeX inset.
9550 None of the standard styles will do.
9553 \begin_layout Section
9561 \begin_layout Standard
9567 \begin_layout Subsection
9571 \begin_layout Standard
9572 This is the layout file for the European Geophysical Society journals.
9577 can be downloaded from the web site of the EGS under
9578 \begin_inset Flex URL
9581 \begin_layout Plain Layout
9591 \begin_layout Subsection
9595 \begin_layout Standard
9598 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9606 The current layout file is unfortunately very unmodular and would benefit
9607 from using the various
9614 \begin_layout Section
9620 \begin_inset CommandInset label
9629 \begin_layout Standard
9637 \begin_layout Subsection
9641 \begin_layout Standard
9642 This section describes how to use LyX to make slides for overhead projectors.
9643 There are two document classes that can do this: the default slides class
9649 This section documents the former.
9652 \begin_layout Standard
9653 I'm going to say this again, nice and clear, so that there's no misunderstanding
9657 \begin_layout Standard
9658 \begin_inset VSpace bigskip
9664 \begin_layout Standard
9668 This section documents the class
9669 \begin_inset Quotes eld
9677 \begin_inset Quotes erd
9685 \begin_layout Standard
9686 \begin_inset VSpace bigskip
9692 \begin_layout Standard
9693 If you're looking for the documentation for
9694 \begin_inset Quotes eld
9702 \begin_inset Quotes erd
9706 \begin_inset space ~
9710 \begin_inset CommandInset ref
9712 reference "sec:foiltex"
9722 \begin_inset Quotes eld
9730 \begin_inset Quotes erd
9733 ] is actually somewhat better than the default
9741 \begin_layout Plain Layout
9742 \SpecialChar \ldots{}
9743 or so I've been told repeatedly by its advocates.
9744 Having never used it, I have no idea if this claim is true or not.
9749 which this section documents.
9752 \begin_layout Standard
9753 This class is the LaTeX2e improvement of the old
9758 Every LaTeX2e distribution includes this class [which I'll just refer to
9760 \begin_inset Quotes eld
9768 \begin_inset Quotes erd
9771 from now on], so you're bound to have it.
9772 As I noted earlier, there are other classes, such as
9776 , which also produce slides for overhead projectors and do a better job
9778 However, there are some things which
9782 can do which the others can't, such as generate overlays.
9783 Read on to learn more!
9786 \begin_layout Subsection
9788 \begin_inset CommandInset label
9790 name "sec:slidesetup"
9797 \begin_layout Standard
9798 Obviously, to use this document class, you need to select
9799 \begin_inset Quotes eld
9807 \begin_inset Quotes erd
9810 from the class list in the
9815 ocument\SpecialChar \menuseparator
9823 There are some other special things you should know about this class:
9826 \begin_layout Itemize
9827 Don't bother changing the options
9832 They're not supported by the
9839 \begin_layout Itemize
9846 \begin_inset space ~
9851 behaves a bit differently for this class.
9852 The possible choices and what they do are as follows:
9856 \begin_layout Description
9861 The final output contains page numbers in the lower right corner.
9864 \begin_layout Description
9873 , but also prints out any time markers you've put in.
9874 This is the default.
9877 \begin_layout Description
9882 The final output contains no page numbers, time markers, or alignment markers.
9886 \begin_layout Itemize
9891 class has an extra option:
9897 \begin_inset Quotes eld
9905 \begin_inset Quotes erd
9908 in the extra class options.
9912 \begin_layout Standard
9913 Using this options allows you to add time markers to
9919 \begin_inset space ~
9923 \begin_inset CommandInset ref
9925 reference "sec:slideNote"
9933 \begin_layout Standard
9934 You can also use the template file
9935 \begin_inset Quotes eld
9943 \begin_inset Quotes erd
9946 to automatically set up a document to use the
9955 ile\SpecialChar \menuseparator
9957 \begin_inset space ~
9961 \begin_inset space ~
9970 to open your new document].
9971 The template file also contains some examples of the special paragraph
9972 environments used by this class.
9973 I'll describe those next.
9976 \begin_layout Subsection
9977 Paragraph Environments
9980 \begin_layout Subsubsection
9981 Supported Environments
9984 \begin_layout Standard
9985 The first thing you'll notice when you start up a new
9989 document is the font size and type: it's the equivalent of the size
9990 \begin_inset Quotes eld
9998 \begin_inset Quotes erd
10004 \begin_inset space ~
10010 This is also what's used in the output.
10012 \begin_inset Quotes eld
10016 \begin_inset Quotes erd
10019 to remind you that this is a slide.
10020 Your final slides will use a larger font; ergo, you'll have less space.
10021 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10024 \begin_layout Standard
10025 The next thing that becomes obvious is the changes to the paragraph environment
10026 pull-down box [at the far-left end of the toolbar].
10027 Most of the paragraph environments you're used to seeing are missing.
10028 There are also five new ones.
10033 class itself only supports certain paragraph environments:
10036 \begin_layout Itemize
10042 \begin_layout Itemize
10048 \begin_layout Itemize
10054 \begin_layout Itemize
10060 \begin_layout Itemize
10066 \begin_layout Itemize
10072 \begin_layout Itemize
10078 \begin_layout Itemize
10084 \begin_layout Itemize
10090 \begin_layout Itemize
10096 \begin_layout Itemize
10102 \begin_layout Standard
10103 All of the other standard environments, including the section-heading environmen
10104 ts, aren't used in the
10111 \begin_layout Standard
10112 On the other hand, you'll notice the following new environments:
10115 \begin_layout Itemize
10121 \begin_layout Itemize
10127 \begin_layout Itemize
10133 \begin_layout Itemize
10139 \begin_layout Itemize
10145 \begin_layout Standard
10146 These five are kind of quirky, due to a
10147 \begin_inset Quotes eld
10151 \begin_inset Quotes erd
10155 You see, LyX doesn't permit you to nest any other paragraph environment
10156 into an empty environment.
10157 Now, that's fine and dandy, but it means that you wouldn't be able to start
10158 a slide with anything except plain text.
10159 To deal with this, I've performed a little
10160 \begin_inset Quotes eld
10164 \begin_inset Quotes erd
10170 \begin_layout Subsubsection
10171 Quirks of the New Environments
10172 \begin_inset CommandInset label
10174 name "sec:slideQuirk"
10181 \begin_layout Standard
10182 All five of the new paragraph environments are somewhat quirky due to inherent
10183 limitiations in the current version of LyX.
10184 As I just mentioned, LyX forbids environments that begin with another environme
10186 To get around this, the
10190 environment isn't a paragraph environment as described in the
10198 \begin_layout Standard
10199 You should consider
10212 \begin_inset Quotes eld
10215 pseudo-environments.
10216 \begin_inset Quotes erd
10219 They look like a section heading or a
10220 \begin_inset Quotes eld
10228 \begin_inset Quotes erd
10231 but really begin a [and, if necessary, end the previous] paragraph environment.
10241 \begin_inset Quotes eld
10245 \begin_inset Quotes erd
10248 These two perform some action.
10251 \begin_layout Standard
10252 A common feature of all five environments,
10272 , is a rather long-ish label.
10273 The text following this label --- ordinarily the contents of the paragraph
10274 environment --- is utterly irrelevant for
10295 LyX completely ignores it.
10296 In fact, you can leave these five environments completely empty.
10300 \begin_layout Standard
10305 to put any text after the rather long-ish label, you might want to.
10306 This could be a short description of the contents of the
10311 In that case, enter in your descriptive comment and hit
10315 as you normally would.
10318 \begin_layout Standard
10319 If, on the other hand, you don't want to enter in any descriptive text,
10320 you'll hit another LyX quirk.
10321 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10322 environment until you put something in the old one.
10326 \begin_layout Itemize
10327 Start entering the text that will
10355 \begin_layout Itemize
10356 Now move to the beginning of that paragraph.
10360 \begin_layout Itemize
10369 \begin_layout Itemize
10370 Finally, change this new, empty paragraph to a
10394 \begin_layout Standard
10395 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10399 \begin_layout Subsection
10400 Making a Presentation with
10413 \begin_layout Subsubsection
10421 \begin_layout Standard
10422 If you're expecting this section to teach you how to actually make a presentatio
10423 n, you'll be sorely disappointed.
10424 Naturally, I'll describe all of the ways the
10428 class can assist you in preparing the materials for a presentation.
10429 Filling in the contents, however, is up to you.
10434 the LyX philosophy.]
10437 \begin_layout Standard
10442 environment [in the manner described in section
10443 \begin_inset space ~
10447 \begin_inset CommandInset ref
10449 reference "sec:slideQuirk"
10453 ] tells LyX to begin a new slide [duh].
10454 The label for this environment/
10455 \begin_inset Quotes erd
10459 \begin_inset Quotes erd
10463 \begin_inset Quotes eld
10467 \begin_inset Quotes erd
10470 in cool blue, followed by the label,
10471 \begin_inset Quotes eld
10475 \begin_inset Quotes erd
10479 Any text or paragraph environments that follow this one go on the new slide.
10483 \begin_layout Standard
10484 Slides are probably the only time you'll need to forcibly end pages in LyX
10485 (this can be specified in the
10490 In fact, you'll want to, once you finish entering the contents of one slide.
10491 If you've entered more text than can physically fit on a slide, the extra
10492 overflows onto a new slide.
10493 I don't recommend doing this, however, since the overflow slide won't have
10494 any page number on it.
10495 Furthermore, it may interfere with any
10499 you've made to accompany the oversized
10506 \begin_layout Standard
10515 environments work the same way as the
10520 They both create an
10521 \begin_inset Quotes eld
10525 \begin_inset Quotes erd
10528 followed by a label [
10529 \begin_inset Quotes eld
10533 \begin_inset Quotes erd
10537 \begin_inset Quotes eld
10541 \begin_inset Quotes erd
10545 The color is a stunning magenta instead of blue, and the
10546 \begin_inset Quotes eld
10550 \begin_inset Quotes erd
10553 will look different, in style and in length.
10554 The label fonts of all three also differ from one another.
10557 \begin_layout Standard
10562 , if the contents of a
10570 exceed the physical size of a slide or sheet of paper, the extra will overflow
10572 Again, you should avoid this.
10573 It defeats the whole purpose of
10584 \begin_layout Subsubsection
10594 \begin_layout Standard
10599 is a slide that sits atop another slide.
10600 Perhaps you wish to discuss a figure on the main
10604 before displaying the text associated with it.
10605 One way to accomplish this is tape a flap of dark paper over the part of
10610 you want to display later.
10611 This method fails, however, if you wish to overlap one graph with another,
10613 You would then have to fumble while speaking to align the two separate,
10618 s to align the two graphs.
10623 environment in both cases makes life much easier.
10626 \begin_layout Standard
10631 receives the page number of its
10632 \begin_inset Quotes eld
10636 \begin_inset Quotes erd
10644 \begin_inset Quotes eld
10652 \begin_inset Quotes erd
10659 \begin_layout Plain Layout
10660 Presumably, mutliple
10665 \begin_inset Quotes eld
10673 \begin_inset Quotes erd
10677 \begin_inset Quotes eld
10685 \begin_inset Quotes erd
10689 \begin_inset Quotes eld
10697 \begin_inset Quotes erd
10701 \begin_inset space ~
10704 appended to the page number of the parent
10714 Clearly, you want the contents of both the
10722 to each fit on a single physical slide! You should probably consider an
10728 \begin_inset Quotes eld
10732 \begin_inset Quotes erd
10744 class provides a visual cue for this: the label at the start of an
10748 is shorter than that at the start of a
10753 Lastly, when you generate printable output, you'll find alignment markers
10754 in all four corners of both the
10758 page and its parent
10763 These will assist you in lining up the two physical slides.
10766 \begin_layout Standard
10767 The major problem in overlaying two slides is aligning the contents of the
10768 two transparencies.
10769 How much space should you leave for that graph on the second slide? Worse
10770 still, what if you want a graph and a sentence on second slide, but there
10771 is text on the main transparency that goes in between them? You could try
10772 and insert vertical space of the right size.
10773 The better way is to use
10784 \begin_layout Standard
10785 As their names imply,
10793 are two command-like paragraph environments that make all subsequent text
10794 invisible and visible, respectively.
10796 \begin_inset space ~
10800 \begin_inset CommandInset ref
10802 reference "sec:slideQuirk"
10806 that you don't place anything
10810 these two environments, however.
10815 , it inserts a centered, sky-blue label into the page reading
10816 \begin_inset Quotes eld
10819 <Invisible Text Follows>
10820 \begin_inset Quotes erd
10824 For paragraphs following this label, the parts of the
10832 ; it doesn't matter which] where they would be contain instead blank space.
10836 \begin_layout Standard
10841 , the corresponding centered label is
10842 \begin_inset Quotes eld
10845 <Visible Text Follows>
10846 \begin_inset Quotes erd
10850 Paragraphs following this label behave normally.
10851 Note that the beginning of a new
10863 automatically shuts off an
10868 It's therefore not necessary to use
10879 \begin_layout Standard
10880 By now, it should be obvious how to create overlay transparencies using
10881 the proper combination of
10900 \begin_layout Enumerate
10905 , including everything that will appear on it, whether on the main slide
10913 \begin_layout Enumerate
10914 Before each figure or paragraph that will appear only on the
10923 If necessary, insert a
10927 environment after the
10934 \begin_layout Enumerate
10939 immediately following the
10946 \begin_layout Enumerate
10947 Copy the contents of this
10958 \begin_layout Enumerate
10963 , change all of the
10974 \begin_layout Standard
10976 You've just made an
10983 \begin_layout Standard
10984 There's one problem with the way I've designed the LyX
10988 class: you can't make text in the middle of a paragraph invisible, nor
10989 make text in the middle of an invisible paragraph visible again.
10990 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10994 \begin_layout Plain Layout
10995 The commands of interest are:
10998 \begin_layout Itemize
11003 invisible \SpecialChar \ldots{}
11007 \begin_layout Itemize
11012 visible \SpecialChar \ldots{}
11016 \begin_layout Plain Layout
11017 \SpecialChar \ldots{}
11018 and need to be marked as TeX.
11020 \begin_inset Quotes eld
11024 \begin_inset Quotes erd
11027 you wish to change goes in between the brackets [and after the
11040 If you don't know how to mark text as TeX, see the appropriate section
11053 \begin_layout Subsubsection
11063 \begin_inset CommandInset label
11065 name "sec:slideNote"
11072 \begin_layout Standard
11081 is associated with a
11082 \begin_inset Quotes eld
11086 \begin_inset Quotes erd
11098 class provides visual cues.
11103 is shorter than that of a
11107 [yet longer than that of an
11111 ] and, like the label of an
11115 is shockingly magenta.
11116 Additionally, the printed
11120 has the page number of its
11121 \begin_inset Quotes eld
11125 \begin_inset Quotes erd
11133 \begin_inset Quotes eld
11141 \begin_inset Quotes erd
11145 \begin_inset Quotes eld
11153 \begin_inset Quotes erd
11157 \begin_inset Quotes eld
11165 \begin_inset Quotes erd
11169 You can have multiple
11173 s associated with a single
11185 , you'll probably want to break up long
11189 s so that they fit on a single sheet of paper.
11192 \begin_layout Standard
11197 is obvious: it contains anything additional you might want to say about
11203 It could also be used as a sheet of reminders for a particular
11208 In the case of the latter, you might want to make use of time markers.
11214 \begin_inset Quotes eld
11218 \begin_inset Quotes erd
11221 support for time markers, a
11226 So, you'll have to resort to using the LaTeX codes.
11229 \begin_layout Standard
11230 To use time markers, you'll need to specify the extra class option
11231 \begin_inset Quotes eld
11239 \begin_inset Quotes erd
11243 \begin_inset space ~
11247 \begin_inset CommandInset ref
11249 reference "sec:slidesetup"
11254 This option turns on timing marks, which will appear in the lower-left-hand
11260 To set what appears in the time marker, you use the LaTeX commands
11261 \begin_inset Quotes eld
11271 \begin_inset Quotes erd
11275 \begin_inset Quotes eld
11285 \begin_inset Quotes erd
11289 The arguments of both commands are time measured in seconds.
11291 \begin_inset Quotes eld
11301 \begin_inset Quotes erd
11304 sets the time marker to a given time.
11306 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11319 increments the time marker by the specified amount.
11320 Using time markers and
11324 s in this fashion, you can remind yourself how much time to spend on a particula
11332 \begin_layout Standard
11333 There's one last feature to describe.
11334 Clearly, you'd like to print out all of your
11342 s on transparencies while printing all of your
11359 with which it is associated.
11360 What's a person to do?
11363 \begin_layout Standard
11364 Luckily, there are two LaTeX commands that allow you to select what to print
11366 Both must be placed into the preamble of your document.
11368 \begin_inset Quotes eld
11380 \begin_inset Quotes erd
11383 will cause the output to contain only the
11392 Correspondingly, the command
11393 \begin_inset Quotes eld
11405 \begin_inset Quotes erd
11408 prevents the output of anything but
11413 I'd advise placing both commands in the preamble and initially comment
11415 You can then preview your entire presentation as you write.
11416 When you're done writing, you can then uncomment one of the two to select
11417 what you want to print.
11418 I like to uncomment
11419 \begin_inset Quotes eld
11431 \begin_inset Quotes erd
11434 , print to a file with
11435 \begin_inset Quotes eld
11443 \begin_inset Quotes erd
11446 in its name, comment it back out, then uncomment
11447 \begin_inset Quotes eld
11459 \begin_inset Quotes erd
11463 \begin_inset Quotes eld
11471 \begin_inset Quotes erd
11475 I can then send either file to a printer, loading transparencies or plain
11476 paper as appropriate.
11479 \begin_layout Standard
11480 You can also provide other arguments to the
11481 \begin_inset Quotes eld
11491 \begin_inset Quotes erd
11495 \begin_inset Quotes eld
11505 \begin_inset Quotes erd
11509 See a good LaTeX book for details.
11512 \begin_layout Subsection
11517 Class Template File
11520 \begin_layout Standard
11521 I have also provided a template file,
11522 \begin_inset Quotes eld
11530 \begin_inset Quotes erd
11538 To use it, begin your new presentation with
11543 ile\SpecialChar \menuseparator
11545 \begin_inset space ~
11549 \begin_inset space ~
11559 Your new LyX presentation file will contain an example
11580 additionally contain an example of the use of
11589 Lastly, the preamble will contain:
11592 \begin_layout LyX-Code
11593 % Uncomment to print out only slides and overlays
11596 \begin_layout LyX-Code
11600 \begin_layout LyX-Code
11606 \begin_inset Newline newline
11612 \begin_layout LyX-Code
11613 % Uncomment to print out only notes
11616 \begin_layout LyX-Code
11620 \begin_layout LyX-Code
11628 \begin_layout Standard
11629 One final thing: I created this class to support the LaTeX2e
11630 \begin_inset Quotes eld
11638 \begin_inset Quotes erd
11641 class, one of the built-in LaTeX2e classes.
11642 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11643 built-in slide class.
11644 It's here if you want it or need it.
11645 There exist other LaTeX2e classes for creating presentations, such as the
11651 \begin_inset space ~
11655 \begin_inset CommandInset ref
11657 reference "sec:foiltex"
11662 \begin_inset Quotes eld
11670 \begin_inset Quotes erd
11673 package [present on some TeX distributions].
11674 The latter is not yet supported under LyX.
11678 \begin_layout Plain Layout
11679 Perhaps you can take on the task\SpecialChar \ldots{}
11685 I know nothing about these other classes.
11686 Try them out to see what sort of alternative they provide.
11689 \begin_layout Section
11698 \begin_inset CommandInset label
11707 \begin_layout Standard
11713 \begin_layout Subsection
11717 \begin_layout Standard
11718 This section describes how to use LyX to make slides for overhead projectors.
11719 There are two document classes that can do this: the default slides class
11725 This section documents the latter.
11728 \begin_layout Standard
11729 I'm going to say this again, nice and clear, so that there's no misunderstanding
11733 \begin_layout Standard
11734 \begin_inset VSpace bigskip
11740 \begin_layout Standard
11744 This section documents the class
11745 \begin_inset Quotes eld
11753 \begin_inset Quotes erd
11761 \begin_layout Standard
11762 \begin_inset VSpace bigskip
11768 \begin_layout Standard
11769 If you're looking for the documentation for
11770 \begin_inset Quotes eld
11778 \begin_inset Quotes erd
11781 , check out section
11782 \begin_inset space ~
11786 \begin_inset CommandInset ref
11788 reference "sec:slitex"
11793 If your machine doesn't have the
11798 \begin_inset Quotes eld
11806 \begin_inset Quotes erd
11809 ] installed, you'll probably have to use the default
11813 class, which isn't quite as good as
11818 \begin_layout Standard
11823 class is designed for use with version 2.1 of the
11827 LaTeX class file which is now an integral part of LaTeX2e.
11830 \begin_layout Subsection
11834 \begin_layout Standard
11835 Obviously, to use this document class, you need to select
11836 \begin_inset Quotes eld
11844 \begin_inset Quotes erd
11857 \begin_inset space ~
11863 There are some settings in the
11866 \begin_inset space ~
11871 dialog that you should know about that are specific to this class:
11874 \begin_layout Itemize
11875 Don't change the options
11886 \begin_inset space ~
11892 They're ignored by the
11899 \begin_layout Itemize
11900 The default font size is 20pt with the other options being 17pt, 25pt and
11904 \begin_layout Itemize
11905 The default font is
11913 but all math equations are still typeset in the usual roman font.
11916 \begin_layout Itemize
11921 TeX supports A4 and Letter paper sizes as well as a special size for working
11923 It doesn't support A5, B5, legal or executive paper sizes.
11926 \begin_layout Itemize
11927 Don't bother changing the
11931 settings because they are ignored anyway.
11932 All floats appear where they are defined in the text.
11935 \begin_layout Itemize
11943 setting behaves a bit differently for this class.
11948 TeX provides extensive footer and header capabilities including a user-defined
11951 \begin_inset space ~
11955 \begin_inset CommandInset ref
11957 reference "sec:foilfoot"
11962 The title page is treated differently to all other pages in the document
11971 has the logo centered at the bottom of the page (if one is defined).
11972 The possible page style choices and what they do are as follows:
11976 \begin_layout Labeling
11977 \labelwidthstring MMMMMMM
11984 The final output contains no page numbers, or other headers or footers
11985 (except footnotes of course).
11989 \begin_layout Labeling
11990 \labelwidthstring MMMMMMM
11997 The final output contains page numbers centered at the bottom of the page.
11998 No other headings or footers (other than footnotes).
12001 \begin_layout Labeling
12002 \labelwidthstring MMMMMMM
12007 Page numbers in lower right corner.
12008 Additional headers and footers are also shown.
12009 This is also the default.
12012 \begin_layout Labeling
12013 \labelwidthstring MMMMMMM
12018 Gives you access to the
12022 package although its use with
12026 TeX is discouraged by the writer of the
12030 TeX package because of some potential page layout clashes.
12034 \begin_layout Subsubsection
12038 \begin_layout Standard
12039 The following options may be used in the extra class options in the
12044 ocument\SpecialChar \menuseparator
12054 \begin_layout Labeling
12055 \labelwidthstring MMMMMMx
12060 This sets up the page layout for 7.33in by 11in paper, which is about the
12061 same aspect ratio as a 35mm slide, making it a bit easier to work with
12065 \begin_layout Labeling
12066 \labelwidthstring MMMMMMx
12071 Places a rule across the page below the header on every page except the
12075 \begin_layout Labeling
12076 \labelwidthstring MMMMMMx
12081 Places a rule across the page above the footer on every page except the
12085 \begin_layout Labeling
12086 \labelwidthstring MMMMMMx
12091 This is automatically set each time you create a new
12100 TeX to use the dvips driver to rotate those pages that are set as landscape
12104 \begin_layout Labeling
12105 \labelwidthstring MMMMMMx
12110 Simply changes the page dimensions to those of a landscape page but doesn't
12112 Thus if you use this option you need to use an external program to rotate
12113 each page or feed your paper through your printer as landscape.
12114 Note that this option effectively reverses the roles of the
12122 environments (don't worry these are described in the next section).
12125 \begin_layout Labeling
12126 \labelwidthstring MMMMMMx
12131 Equation numbers on the left.
12134 \begin_layout Labeling
12135 \labelwidthstring MMMMMMx
12140 Flush-left equations.
12143 \begin_layout Subsection
12144 Supported Environments
12147 \begin_layout Standard
12148 Most of the environments commonly supported in other classes are also supported
12154 There are several additional environments provided by
12158 TeX as well as a couple added by LyX.
12159 The following environments are shared with other classes:
12162 \begin_layout Standard
12166 \begin_layout Plain Layout
12170 begin{multicols}{2}
12178 \begin_layout Itemize
12184 \begin_layout Itemize
12190 \begin_layout Itemize
12196 \begin_layout Itemize
12202 \begin_layout Itemize
12208 \begin_layout Itemize
12214 \begin_layout Itemize
12220 \begin_layout Itemize
12226 \begin_layout Itemize
12232 \begin_layout Itemize
12238 \begin_layout Itemize
12244 \begin_layout Itemize
12250 \begin_layout Itemize
12256 \begin_layout Itemize
12262 \begin_layout Itemize
12268 \begin_layout Itemize
12274 \begin_layout Itemize
12280 \begin_layout Itemize
12286 \begin_layout Standard
12290 \begin_layout Plain Layout
12302 \begin_layout Standard
12303 That is, all the major environments apart from the sectioning environments.
12304 Since foils are essentially self-contained sections, with a title and body,
12309 TeX provides specific commands for starting new foils and these are:
12312 \begin_layout Itemize
12318 \begin_layout Itemize
12324 \begin_layout Standard
12325 LyX also provides slightly modified versions of these two environments called:
12328 \begin_layout Itemize
12334 \begin_layout Itemize
12337 ShortRotatefoilhead
12340 \begin_layout Standard
12341 and the differences will be explained in the next section.
12344 \begin_layout Standard
12345 Since foils are often used in presenting ideas or new theorems and such
12350 TeX also provides a comprehensive box of goodies for presenting them:
12353 \begin_layout Standard
12357 \begin_layout Plain Layout
12361 begin{multicols}{2}
12369 \begin_layout Itemize
12375 \begin_layout Itemize
12381 \begin_layout Itemize
12387 \begin_layout Itemize
12393 \begin_layout Itemize
12399 \begin_layout Itemize
12405 \begin_layout Itemize
12411 \begin_layout Itemize
12417 \begin_layout Itemize
12423 \begin_layout Itemize
12429 \begin_layout Itemize
12435 \begin_layout Standard
12439 \begin_layout Plain Layout
12451 \begin_layout Standard
12452 The starred versions are unnumbered while the unstarred versions are numbered.
12453 There are also two list environments added by LyX and these are:
12456 \begin_layout Itemize
12462 \begin_layout Itemize
12468 \begin_layout Standard
12473 TeX provides some powerful header and footer capabilities that are best
12474 set in the preamble although they may be set at any point in a document.
12475 If you want to change these settings in your document the best place to
12476 do so is at the very top of a foil,
12481 straight after the foilhead.
12484 \begin_layout Standard
12485 For this purpose, the following command styles are provided [
12492 \begin_layout Standard
12496 \begin_layout Plain Layout
12500 begin{multicols}{2}
12508 \begin_layout Itemize
12512 \begin_inset space ~
12518 \begin_layout Itemize
12524 \begin_layout Itemize
12528 \begin_inset space ~
12534 \begin_layout Itemize
12538 \begin_inset space ~
12544 \begin_layout Itemize
12548 \begin_inset space ~
12555 \begin_layout Standard
12556 \begin_inset space ~
12563 \begin_layout Standard
12567 \begin_layout Plain Layout
12579 \begin_layout Standard
12580 There are also a few commands provided by
12584 TeX that aren't directly supported by LyX but I'll tell you what they do
12585 and how to use them in section
12586 \begin_inset space ~
12590 \begin_inset CommandInset ref
12592 reference "sec:unsuppfoils"
12599 \begin_layout Subsection
12600 Building a Set of Foils
12603 \begin_layout Standard
12604 This section will give a simple introduction to using the different environments
12605 to build a set of foils.
12606 If you want to see an example set of foils, take a look at the
12610 file you find in LyX's
12617 \begin_layout Subsubsection
12618 Give It a Title Page
12621 \begin_layout Standard
12622 Unlike other classes that provide
12642 creates the title on a page of its own.
12643 If you leave out the
12647 environment LaTeX will substitute the current date (every time you regenerate
12651 \begin_layout Subsubsection
12655 \begin_layout Standard
12656 As I mentioned earlier, there are four ways of starting a new foil.
12657 For portrait foils you should use
12666 The difference between these two environments is the amount of space between
12667 the title of the foil (the foilhead) and the body of the foil.
12670 \begin_layout Standard
12671 Landscape foils are generated using the
12677 ShortRotatefoilhead
12680 Again the only difference is the spacing between foilhead and body.
12681 Both of the short versions have 0.5 inches less separation between the foilhead
12686 \begin_layout Standard
12687 One problem with the support for landscape foils is the requirement that
12688 you have to use the
12692 driver to generate the PostScript output otherwise the foils won't be rotated.
12693 It is possible to get landscape foils even if you haven't got the
12697 driver provided you can feed your foils sideways through your printer ;-)
12700 \begin_layout Subsubsection
12701 Theorems, Lemmas, Proofs and more
12704 \begin_layout Standard
12705 Due to a small bug in LyX you can't have two of the same type of these environme
12706 nts directly following each other.
12707 They must be separated by something.
12708 If you try, you will just be extending the previous environment as if you
12709 had merged the two environments together.
12710 So, how do you get around this problem? The simplest option is to insert
12711 some text between the two environments or add a
12715 environment between the two with just a
12716 \begin_inset Quotes eld
12724 \begin_inset Quotes erd
12728 This will force LyX to produce two separate environments and hence the
12729 correct LaTeX output.
12730 An example is provided in the example file included with the LyX distribution.
12731 Remember, this problem only occurs if you are trying to place two of the
12732 same type of theorem-like environments one directly after the other.
12735 \begin_layout Subsubsection
12739 \begin_layout Standard
12740 You get all the commonly supported list styles found in other classes as
12741 well as two new ones.
12742 I'll only describe the new ones here.
12743 If you want to find out more about the other list environments check out
12749 If you intend to use itemized lists you might also want to read about the
12753 \begin_inset space ~
12757 \begin_inset space ~
12762 dialog described above in section
12763 \begin_inset space ~
12767 \begin_inset CommandInset ref
12769 reference "sec:bullet"
12776 \begin_layout Standard
12777 The two new list styles,
12785 , are designed to make it easier for you to create lists of do's and don'ts
12786 or right and wrong by providing dedicated environments that use a tick
12787 or a cross as the label of the list.
12788 These lists are in fact dedicated variants of the
12793 They do however require that you have the
12797 packages installed.
12800 \begin_layout Subsubsection
12804 \begin_layout Standard
12809 TeX redefines the floating tables and figures so that they appear exactly
12810 where they are in the text rather than pushing them to the top of the page
12811 or to some user specified location.
12812 In fact if you change the float placement settings they are simply ignored.
12815 \begin_layout Subsubsection
12816 Page Headers and Footers
12817 \begin_inset CommandInset label
12819 name "sec:foilfoot"
12826 \begin_layout Standard
12830 \begin_inset space ~
12839 are two commands used to control the left-footer text string.
12840 The first is meant to allow you to include a graphic logo on your foils
12842 \begin_inset Quotes eld
12850 \begin_inset Quotes erd
12854 While the second is meant to provide a classification for the audience,
12858 \begin_inset space \thinspace{}
12864 \begin_inset space ~
12868 It is empty by default.
12871 \begin_layout Standard
12872 The remaining page corners can be filled by
12875 \begin_inset space ~
12880 (which defaults to page numbers),
12883 \begin_inset space ~
12891 \begin_inset space ~
12899 \begin_layout Subsection
12905 \begin_inset CommandInset label
12907 name "sec:unsuppfoils"
12914 \begin_layout Standard
12915 All the commands mentioned below need to be set in a
12923 within another environment.
12926 \begin_layout Subsubsection
12930 \begin_layout Standard
12931 All lengths are adjusted using the
12954 should be replaced by the name given to the length you want to change and
12959 is the length value.
12960 All lengths should be specified in units of length such as inches (
12972 ) or relative to some document or font-based length such as
12982 \begin_layout Standard
12983 It's possible to change the spacing between a foilhead and the body of the
12984 foil by adjusting the length specified by
12991 For example, to make
12995 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13002 foilheadskip}{-0.5in}
13005 \begin_layout Standard
13006 The spacings around floats can be adjusted by setting these lengths:
13009 \begin_layout Labeling
13010 \labelwidthstring MMMMMMMMMMM
13017 Separation between the text and the top of the float
13020 \begin_layout Labeling
13021 \labelwidthstring MMMMMMMMMMM
13028 Separation between the float and the caption
13031 \begin_layout Labeling
13032 \labelwidthstring MMMMMMMMMMM
13039 Separation between the caption and the following text
13042 \begin_layout Labeling
13043 \labelwidthstring MMMMMMMMMMM
13050 You can make the captions narrower than the surrounding text by adjusting
13052 Best done relative to
13061 \begin_layout Standard
13062 There are also several title page related lengths that you may find useful
13063 if you have a long title or several authors:
13066 \begin_layout Labeling
13067 \labelwidthstring MMMMMMMMMMM
13074 Separation from headers to
13079 \begin_layout Labeling
13080 \labelwidthstring MMMMMMMMMMM
13098 \begin_layout Labeling
13099 \labelwidthstring MMMMMMMMMMM
13113 \begin_layout Labeling
13114 \labelwidthstring MMMMMMMMMMM
13130 \begin_layout Labeling
13131 \labelwidthstring MMMMMMMMMMM
13147 \begin_layout Standard
13148 The last length related command affects all the list environments.
13159 a list environment then all the vertical spacing between the list items
13161 Note that this is a command not a length so it doesn't require
13167 like the stuff mentioned above.
13170 \begin_layout Subsubsection
13171 Headers and Footers
13174 \begin_layout Standard
13187 commands control whether the logo in the
13191 definition appear on a given page.
13198 in the preamble then none of the foils will have the logo on them.
13199 If you don't want the logo on a particular page place the
13205 directly after the foilhead of that page and the
13211 directly after the next foilhead.
13214 \begin_layout Standard
13215 If you decide to use the
13219 page style setting in the
13222 \begin_inset space ~
13227 dialog you should probably add
13237 to your preamble so headers and footers on landscape pages are correctly
13238 placed when rotated.
13239 This is due to some clashes between the page layouts provided by the
13250 \begin_layout Section
13251 Latex8 (IEEE Conference Papers)
13254 \begin_layout Standard
13260 \begin_layout Subsection
13264 \begin_layout Standard
13265 Since this class is specifically for writing submissions to IEEE sponsored
13266 conferences I strongly recommend that you get a copy of their Authors Kit.
13271 package and associated bibliography style file is included in the kit.
13272 The Authors Kit is usually sent out by email once your initial submission
13274 There is a lot of useful information in the Authors Kit explaining formatting
13275 restrictions and so on and I will assume you have read this since that
13276 means I don't have to repeat it all here.
13279 \begin_layout Subsection
13283 \begin_layout Standard
13284 [AR\SpecialChar \@.
13288 \begin_layout Subsection
13289 Supported Environments
13292 \begin_layout Itemize
13298 \begin_layout Itemize
13304 \begin_layout Itemize
13310 \begin_layout Itemize
13316 \begin_layout Itemize
13322 \begin_layout Itemize
13328 \begin_layout Itemize
13334 \begin_layout Itemize
13340 \begin_layout Itemize
13346 \begin_layout Subsection
13347 Differences Between Screen and Paper
13350 \begin_layout Standard
13351 There are slight differences in appearance mainly with the presentation
13352 of section counters.
13353 On screen the trailing period of the section counter is missing but it
13354 will appear in the output so don't let this worry you.
13357 \begin_layout Section
13358 Hollywood (Hollywood spec scripts)
13361 \begin_layout Standard
13367 \begin_layout Subsection
13371 \begin_layout Standard
13372 Getting the format of a Hollywood script right is a
13373 \begin_inset Quotes eld
13377 \begin_inset Quotes erd
13380 It is designed to make the readers focus on content and to be easy and
13381 familiar for the actors to read.
13382 Each page of a script should be one minute of film.
13383 Nothing goes in a script that you cannot see or hear on screen.
13384 The courier 12 pt font should be used throughout.
13388 \begin_layout Subsection
13392 \begin_layout Standard
13393 Speakers' lines should NEVER break in mid-sentence.
13394 If a speaker's lines continue over a page break, repeat the
13398 title followed by (Cont'd).
13401 \begin_layout Subsection
13405 \begin_layout Standard
13410 names as labels then cross-reference the label to insert the name.
13411 The cross-reference dialog will show the current cast of characters.
13412 You can use this to insert the speaker name in narratives also.
13415 \begin_layout Subsection
13416 Paper size and Margins
13419 \begin_layout Standard
13420 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13423 \begin_layout Subsection
13427 \begin_layout Standard
13428 The following environments are available.
13429 You can use hollywood.bind to get the bind keys shown at the right.
13432 \begin_layout Itemize
13436 \begin_inset Newline newline
13441 Used where nothing else works.
13445 \begin_layout Itemize
13451 \begin_inset space \hfill{}
13459 \begin_inset Newline newline
13462 Usually followed by something like
13463 \begin_inset Quotes eld
13466 on Sally waking up.
13467 \begin_inset Quotes erd
13473 \begin_layout Itemize
13477 \begin_inset space \hfill{}
13481 \begin_inset Newline newline
13486 Introduces a new INTERIOR camera set-up.
13487 Always followed by DAY or NIGHT, or something similar to define the lighting
13489 Everthing on this line in CAPS.
13492 \begin_layout Itemize
13496 \begin_inset space \hfill{}
13500 \begin_inset Newline newline
13505 Introduces a new EXTERIOR camera set-up.
13506 Everthing on this line in CAPS.
13509 \begin_layout Itemize
13513 \begin_inset space \hfill{}
13517 \begin_inset Newline newline
13522 The character speaking.
13525 \begin_layout Itemize
13529 \begin_inset space \hfill{}
13533 \begin_inset Newline newline
13538 Instructions to the speaker.
13539 The () are automatically inserted, but only the ( will show in LyX.
13540 Both will be printed.
13543 \begin_layout Itemize
13547 \begin_inset space \hfill{}
13551 \begin_inset Newline newline
13563 \begin_layout Itemize
13567 \begin_inset space \hfill{}
13571 \begin_inset Newline newline
13576 Camera movement instruction.
13578 \begin_inset space \thinspace{}
13582 \begin_inset space ~
13588 \begin_layout Itemize
13592 \begin_inset space \hfill{}
13598 \begin_layout Itemize
13602 \begin_inset space \hfill{}
13608 \begin_layout Itemize
13612 \begin_inset space \hfill{}
13618 \begin_layout Itemize
13622 \begin_inset space \hfill{}
13628 \begin_layout Subsection
13632 \begin_layout Itemize
13633 (O.S) --- off screen
13636 \begin_layout Itemize
13637 (V.0) --- voice over
13640 \begin_layout Itemize
13645 \begin_layout Itemize
13650 \begin_layout Itemize
13651 PAN --- camera movement
13654 \begin_layout Itemize
13655 INSERT --- cut to close-up of
13658 \begin_layout Section
13662 \begin_layout Standard
13668 \begin_layout Subsection
13672 \begin_layout Standard
13673 Broadway is for writing plays.
13674 The format is more decorative than Hollywood, and much less standardized.
13675 This format should be suitable for workshops.
13678 \begin_layout Subsection
13682 \begin_layout Standard
13683 The same as in Hollywood.
13686 \begin_layout Subsection
13690 \begin_layout Standard
13695 names as labels then cross-reference the label to insert the name.
13696 The cross-reference dialog will show the current cast of characters.
13699 \begin_layout Subsection
13700 Paper size and Margins
13703 \begin_layout Standard
13704 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13707 \begin_layout Subsection
13711 \begin_layout Standard
13712 The following environments are available.
13713 You can use broadway.bind to get the bind keys shown at the right.
13716 \begin_layout Itemize
13720 \begin_inset Newline newline
13725 You should not have to use this, but it is here for anything that does not
13729 \begin_layout Itemize
13733 \begin_inset space \hfill{}
13737 \begin_inset Newline newline
13742 Used to describe stage setting and the action.
13743 First use of speaker names in all CAPs.
13746 \begin_layout Itemize
13750 \begin_inset space \hfill{}
13754 \begin_inset Newline newline
13759 Automatically numbered.
13760 On screen it will be arabic, but will print as Roman.
13763 \begin_layout Itemize
13767 \begin_inset space \hfill{}
13771 \begin_inset Newline newline
13781 It is just centered text.
13784 \begin_layout Itemize
13788 \begin_inset space \hfill{}
13792 \begin_inset Newline newline
13797 Not automatically numbered.
13798 You supply the number.
13799 This is because I couldn't figure out how.
13802 \begin_layout Itemize
13806 \begin_inset space \hfill{}
13810 \begin_inset Newline newline
13815 A special case of Narrative to describe the setting and action as the curtain
13819 \begin_layout Itemize
13823 \begin_inset space \hfill{}
13827 \begin_inset Newline newline
13832 The speaker's (actor's) title, centered in all CAPS.
13835 \begin_layout Itemize
13839 \begin_inset space \hfill{}
13843 \begin_inset Newline newline
13848 Instructions to the speaker.
13849 The parentheses are automatically inserted.
13850 The ( will appear on screen, but both will be in the printed play.
13851 This environment is only used within
13858 \begin_layout Itemize
13862 \begin_inset space \hfill{}
13866 \begin_inset Newline newline
13871 What the Speaker says.
13874 \begin_layout Itemize
13878 \begin_inset space \hfill{}
13882 \begin_inset Newline newline
13887 The curtain comes down.
13890 \begin_layout Itemize
13894 \begin_inset space \hfill{}
13900 \begin_layout Itemize
13904 \begin_inset space \hfill{}
13910 \begin_layout Itemize
13914 \begin_inset space \hfill{}
13920 \begin_layout Standard
13924 \begin_layout Section
13928 \begin_layout Standard
13934 \begin_layout Standard
13935 \begin_inset VSpace bigskip
13941 \begin_layout Standard
13946 \begin_inset space ~
13951 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13952 \begin_inset Formula $\beta$
13955 release of May, 1999) class.
13958 \begin_layout Standard
13963 textclass, which works with RevTeX 3.1.
13964 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13965 That means that it doesn't interact very well with LyX, which requires
13966 LaTeX2e, although it has been kludged to work.
13967 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13971 \begin_inset space ~
13976 textclass should also be pretty easy to use.
13979 \begin_layout Standard
13980 These documents are supposed to be used in
13984 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13985 macros, and assume you'll know what to put in the preamble if necessary.
13988 \begin_layout Subsection
13992 \begin_layout Standard
13993 All you need to do is install RevTeX 4, as described in the package's README
13995 The package can be found at The RevTeX 4 Web Site
13996 \begin_inset Flex URL
13999 \begin_layout Plain Layout
14001 http://publish.aps.org/revtex4/
14007 Install it somewhere that LaTeX can see it.
14008 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14009 (i.e., not the directory where you installed the class file.) Then, if you
14010 reconfigure LyX, it will find the class file and let you use the RevTeX4
14014 \begin_layout Standard
14015 Probably the easiest way to get started is either to import a RevTeX 4 document
14023 \begin_inset space ~
14028 template, found in the templates directory.
14031 \begin_layout Subsection
14035 \begin_layout Standard
14036 Optional arguments to
14043 \begin_inset Quotes eld
14047 \begin_inset Quotes erd
14051 \begin_inset Quotes eld
14055 \begin_inset Quotes erd
14065 \begin_inset space ~
14073 \begin_inset space ~
14079 Remember that in RevTeX, at least one optional argument is required!
14082 \begin_layout Standard
14083 Other preamble matter, like
14090 \begin_inset space ~
14100 \begin_inset space ~
14105 dialog, also as usual.
14108 \begin_layout Subsection
14112 \begin_layout Standard
14113 The layouts basically correspond to the commands in RevTeX4.0.
14114 For example, the Email layout corresponds to
14121 Note that (at least as of RevTeX 4.0 Beta), the
14129 layouts are exactly equivalent, so you shouldn't need to use both.
14133 \begin_layout Plain Layout
14134 In case you're curious, both were included so that
14138 would be able to translate both
14158 \begin_layout Subsection
14162 \begin_layout Standard
14163 There are a couple of important unique aspects of RevTeX 4 which might cause
14164 bugs that will be even more confusing in LyX.
14167 \begin_layout Standard
14185 The LyX equivalent is that there is a separate Thanks layout.
14190 write footnotes in the
14194 layout, or weird things may happen.
14195 See the RevTeX 4 documentation for more details.
14198 \begin_layout Standard
14202 \begin_inset space ~
14210 \begin_inset space ~
14219 layouts must be placed
14227 layout and the corresponding
14244 , the LaTeX won't compile.
14247 \begin_layout Subsection
14251 \begin_layout Standard
14252 The main problem with this layout is that you can't use the optional arguments
14253 to layouts like Email and Title.
14254 (The problem is not unique to this layout; you can't use optional arguments
14255 to the Section layouts either.) This means that after you export that file
14256 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14257 need to edit the LaTeX file with a text editor to add the optional arguments
14259 \begin_inset space \thinspace{}
14262 g., the running title for the page headers.
14263 Lacking these layouts makes the
14269 (and the equivalent
14275 ) useless, so the corresponding layouts don't exist, and will have to be
14280 \begin_layout Plain Layout
14285 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14286 has not been updated yet to take advantage of it.
14294 \begin_layout Section
14295 Article (mwart), book (mwbk) and report (mwrep)
14296 \begin_inset OptArg
14299 \begin_layout Plain Layout
14312 \begin_layout Standard
14318 \begin_layout Standard
14319 The LyX document classes
14335 correspond to the LaTeX document classes
14348 They are replacements for the standard document classes
14360 , resp., and fit better to Polish typography conventions in a number of points.
14364 \begin_layout Standard
14368 \begin_layout Itemize
14369 Unnumbered titles (with star, eg.
14374 ) are added into table of contents,
14377 \begin_layout Itemize
14378 Additional page styles:
14382 \begin_layout Description
14383 uheadings header with separated lines,
14386 \begin_layout Description
14387 myheadings custom header, contents headers via commands:
14402 \begin_layout Description
14403 myuheadings custom header with separated lines,
14406 \begin_layout Description
14407 outer page number is placed on outer side of page
14411 \begin_layout Itemize
14416 \begin_layout Description
14417 rmheadings serif titles --- default,
14420 \begin_layout Description
14421 sfheadings sansserif titles,
14424 \begin_layout Description
14425 authortitle on title page first placed is author next title --- default,
14428 \begin_layout Description
14429 titleauthor on title page first placed is title next author,
14432 \begin_layout Description
14433 withmarginpar reserve place on page for margins.
14437 \begin_layout Section
14441 \begin_layout Standard
14447 \begin_layout Standard
14448 Elsevier Science Publishers B.V.
14449 provides a standard LaTeX document class (
14453 ) for submitting articles to their various journals.
14454 The style file can be downloaded directly from their web site:
14455 \begin_inset Flex URL
14458 \begin_layout Plain Layout
14460 http://authors.elsevier.com/
14466 Instructions are supplied along with the class file, which details the
14467 requirements of the publishers.
14468 LyX includes package that allows for the use of this class, by a layout
14469 and a template file.
14470 Installation of the class file is the same as for any other LaTeX package;
14471 instructions are provided in the Elsevier documentation.
14474 \begin_layout Standard
14484 As the Elsevier class file is based mainly on the standard article class,
14485 most of the normal functionality is provided.
14486 The Elsevier class defines a number of mathematical environments, which
14487 are similar to the AMS environments.
14488 These commands are all described in the Elsevier documentation, and are
14492 \begin_layout Standard
14493 The easiest way to use the Elsevier style is to base documents on the included
14495 It is best not to use options such as fancy headings or the geometry package,
14496 as elements such as these are defined by Elsevier in their style file.
14497 Ideally, no extra packages except those mentioned in the Elsevier documentation
14499 Essentially, Elsevier require as
14500 \begin_inset Quotes eld
14504 \begin_inset Quotes erd
14507 a LaTeX file as possible, as their intention is to take the supplied file
14508 and replace the class file with one for the particular journal to which
14509 the paper has been submitted.
14510 This also means that not too much time should be spent on the formating
14512 When it comes to be published, this will change anyway.
14513 The rest of the usage for this layout is substantially the same as for
14514 the normal article class.
14515 For details of what Elsevier do and don't allow, refer to their documentation.
14518 \begin_layout Section
14522 \begin_layout Standard
14525 Jürgen Spitzmüller
14528 \begin_layout Subsection
14532 \begin_layout Standard
14533 Memoir is a very powerful and constantly evolving class.
14534 It has been designed with regard to fictional and non-fictional literature.
14535 Its aim is to let the user have maximum control over the typesetting of
14537 Memoir is based on the standard book class, but it can also emulate the
14538 article class (see below).
14541 \begin_layout Standard
14542 Peter Wilson, the developer of Memoir, is known as the author of lots of
14543 useful packages in the LaTeX world.
14544 Most of them have been merged with Memoir.
14545 Therefore, it is much easier to layout the table of contents, appendices,
14546 chapter designs and such.
14547 LyX, though, does not support all of these goodies natively.
14548 Some of them might be added to forthcoming releases
14552 \begin_layout Plain Layout
14553 You are invited to send suggestions to
14554 \begin_inset Flex URL
14557 \begin_layout Plain Layout
14559 lyx-devel@lists.lyx.org
14569 , lots will probably never, due to the limitations of LyX's framework.
14570 Of course you can still use all features with the help of some native LaTeX
14575 \begin_layout Plain Layout
14580 \begin_layout Plain Layout
14590 \begin_inset space ~
14594 \begin_inset CommandInset ref
14596 reference "sec:Inserting-TeX-Code"
14606 In this section, we can only list those features which are natively supported
14608 For detailed descriptions (and for the rest of features) we are recommending
14609 to have a look at the detailed manual of the Memoir class
14613 \begin_layout Plain Layout
14618 \begin_layout Plain Layout
14628 \begin_inset Flex URL
14631 \begin_layout Plain Layout
14633 CTAN:/macros/latex/memoir/memman.pdf
14643 , which is not only a user guide for the class, but also both a comprehensive
14644 description on good typesetting and a superb example for good typesetting
14648 \begin_layout Subsection
14649 Basic features and restrictions
14652 \begin_layout Standard
14653 Memoir supports basically all features of the standard book classes.
14654 There are, however, some differences, as follows:
14657 \begin_layout Description
14659 \begin_inset space ~
14662 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14665 \begin_layout Description
14667 \begin_inset space ~
14670 style: The fancy page style is not supported, due to a command clash between
14671 Memoir and the fancyhdr package (they are both defining a command with
14672 the same name, which confuses LaTeX).
14673 Instead, Memoir comes with a bunch of own page styles (see
14675 Layout\SpecialChar \menuseparator
14676 Document\SpecialChar \menuseparator
14678 \begin_inset space ~
14684 If you want to use these for the chapter pages, you have to use the command
14691 in the main text or in preamble (e.
14692 \begin_inset space \thinspace{}
14696 \begin_inset space ~
14703 chapterstyle{companion}
14708 \begin_layout Description
14709 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14710 an optional argument in the standard classes.
14711 With this, you can specify an alternative version of the title for the
14712 table of contents and the headers (for instance, if the title is too long).
14713 In LyX, you can do this via
14715 Insert\SpecialChar \menuseparator
14717 \begin_inset space ~
14722 at the beginning of a chapter/section.
14723 Memoir features a second optional argument and thus separates the table
14724 of contents from the header.
14725 You can define three variants of a title with this: one for the main text,
14726 one for the table of contents, and one for the headers.
14727 Simply insert two optional arguments if you need this feature, the first
14728 one containing the short title for the Table of Contents, the second one
14729 containing an alternative short title for the headers.
14732 \begin_layout Description
14733 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14734 of contents, the list of figures and the list of table start a new page
14736 Memoir does not follow this route.
14737 You have to insert a page break yourself, if you want to have one.
14740 \begin_layout Description
14741 Titlepage: For some unknown reason, Memoir uses pagination on the title
14742 page (in the standard classes, title pages are
14743 \begin_inset Quotes eld
14747 \begin_inset Quotes erd
14751 \begin_inset space \thinspace{}
14755 \begin_inset space ~
14759 If you want an empty title page, type
14763 aliaspagestyle{title}{empty}
14768 \begin_layout Description
14769 Article: With the class option
14775 Layout\SpecialChar \menuseparator
14776 Document\SpecialChar \menuseparator
14778 \begin_inset space ~
14783 ), you can emulate article style.
14784 That is, counters (footnotes, figures, tables etc.) will not be reset on
14785 new chapters, chapters don't start a new page (but are---in contrary to
14787 \begin_inset Quotes eld
14791 \begin_inset Quotes erd
14794 article classes---still allowed), parts, though, use their own page, as
14798 \begin_layout Description
14799 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14800 font commands, which have been used in the old LaTeX version 2.09 (e.
14801 \begin_inset space \thinspace{}
14805 \begin_inset space ~
14821 It produces an error and stops LaTeX whenever such a command appears.
14826 reallows the commands and spits out warnings instead (which does at least
14828 Since a lot of packages and particularly BibTeX style files are still using
14829 those commands, we have decided to use this option by default.
14832 \begin_layout Subsection
14836 \begin_layout Standard
14837 We will only describe the features supported by LyX (which is not much currently
14839 Please consult the Memoir manual
14843 \begin_layout Plain Layout
14848 \begin_layout Plain Layout
14858 \begin_inset Flex URL
14861 \begin_layout Plain Layout
14863 CTAN:/macros/latex/memoir/memman.pdf
14876 \begin_layout Description
14877 Abstract: You may wonder why an abstract is an extra feature.
14878 Well, it is in book class.
14879 Usually books don't have abstracts.
14880 Memoir, however, has.
14881 You can use it wherever and how often you like.
14884 \begin_layout Description
14885 Chapterprecis: You may know this from belletristic: The contents of a chapter
14886 is shortly described below the title and also in the table of contents
14888 \begin_inset space \thinspace{}
14892 \begin_inset space ~
14897 Our hero arrives in Troia; he loses some friends; he finds others
14900 Chapterprecis does exactly this.
14901 It is therefore only sensible below a chapter.
14904 \begin_layout Description
14905 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14906 The epigraph environment provides an elegant way of typesetting such a
14908 The motto itself (text) and its author (source) are divided by a short
14910 Unfortunately, we have to fool LyX a bit here again, since the environment
14911 needs two arguments (text and source).
14912 In this case, we have to use curly brackets (in TeX mode) between the two
14923 <author of the slogan>.
14926 \begin_layout Description
14927 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14928 complex figurative poems).
14929 LyX can only support a few of them.
14930 One is poemtitle, which is a centered title for poems, which will also
14931 be added to the table of contents (verse is the standard environment for
14933 Memoir has some enhanced versions of verse, but you need to use ERT, because
14934 they have to be nested inside regular verse environments, which is not
14935 possible with LyX).
14938 \begin_layout Description
14939 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14942 \begin_layout Chapter
14943 LyX Features needing Extra Software
14946 \begin_layout Section
14950 \begin_layout Standard
14956 \begin_layout Subsection
14960 \begin_layout Standard
14961 When you to have the
14965 program installed, you'll find in the
14972 \begin_inset space ~
14983 \begin_inset CommandInset href
14985 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14992 \begin_layout Standard
14997 package is a program that was written by
15002 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15003 and easy to forget.
15004 The program runs over your LaTeX file and checks the integrity of the file,
15005 and flags some common errors.
15006 In other technical words, it is
15013 \begin_layout Standard
15014 Well, what is a syntax checker doing in LyX which is supposed to produce
15015 correct LaTeX anyways? The answer is simple: Just as
15019 not only checks the
15023 of C programs, but also does
15027 checks for type-errors,
15031 catches some common
15035 errors, in addition to the syntactical ones.
15040 is capable of detecting several common errors, such as
15043 \begin_layout Itemize
15044 Ellipsis detection:
15045 \begin_inset Newline newline
15048 Use \SpecialChar \ldots{}
15052 \begin_layout Itemize
15053 No space in front of/after parenthesis:
15054 \begin_inset Newline newline
15060 \begin_layout Itemize
15061 Enforcement of normal space after common abbreviations:
15062 \begin_inset Newline newline
15067 is too wide spacing.
15070 \begin_layout Itemize
15071 Enforcement of end-of-sentence space when the last sentence ends with a
15073 \begin_inset Newline newline
15077 And this is wrong spacing.
15080 \begin_layout Itemize
15081 Space in front of labels and similar commands:
15082 \begin_inset Newline newline
15085 The label should stick right up to the text to avoid falling to a wrong
15088 \begin_inset CommandInset label
15098 \begin_layout Plain Layout
15099 This footnote is in danger of falling off to a wrong page
15104 The label is separated too much.
15107 \begin_layout Itemize
15108 Space in front of references, instead of hard spaces:
15109 \begin_inset Newline newline
15112 In you are in bad luck, the text will break right between the referenced
15113 text and reference number, and that's a pity.
15115 \begin_inset CommandInset ref
15117 reference "sec:chktex"
15124 \begin_layout Itemize
15126 \begin_inset Quotes eld
15130 \begin_inset Quotes erd
15134 \begin_inset Formula $\times$
15138 \begin_inset Newline newline
15141 2x2 looks cheap compared to
15142 \begin_inset Formula $2\times2$
15148 \begin_layout Standard
15149 and more \SpecialChar \ldots{}
15150 It is an invaluable tool when you are
15151 \begin_inset Quotes eld
15155 \begin_inset Quotes erd
15158 your document before printing, and you should run it right after the obligatory
15159 spelling check, and before you go fine tuning the typesetting.
15162 \begin_layout Subsection
15166 \begin_layout Standard
15167 If you have the program installed, usage is as simple as choosing
15172 ools\SpecialChar \menuseparator
15178 \begin_inset space ~
15184 This will make LyX generate a LaTeX file of your document, start
15188 to check it, and then make LyX insert
15189 \begin_inset Quotes eld
15193 \begin_inset Quotes erd
15196 with the warnings from
15200 , if there were any.
15201 The warnings will be placed close to the point of the mistake, and you
15202 can quickly find them by using the
15207 avigate\SpecialChar \menuseparator
15214 menu item, or the shortcut key
15223 Open the error boxes by clicking on them with the mouse, or use the shortcut
15232 bindings, or the corresponding
15241 Read the warning and correct the mistake, if it is a mistake.
15242 If you have trouble understanding what the warning is about, you can safely
15244 Remember that there is a hidden layer between the document on screen and
15245 the technical details in invoking
15249 , and this gap can make some warnings seem arcane or just right down plain
15253 \begin_layout Standard
15254 This document is an excellent testing bed for the feature, and it should
15255 provide quite a few warnings for you to fiddle with.
15256 Since computers are only so smart, expect most of the warnings to be false
15260 \begin_layout Subsection
15261 How to fine tune it
15264 \begin_layout Standard
15265 Sometimes, you'll find that
15269 makes more noise than suits your mood.
15270 Then you can choose not to use it, wait until your mood changes, or try
15275 to get better along with you.
15276 Another choice in the most desperate situations is to use
15281 iew\SpecialChar \menuseparator
15287 \begin_inset space ~
15291 \begin_inset space ~
15295 \begin_inset space ~
15300 , which will get rid of all warnings instantly.
15303 \begin_layout Standard
15312 very configurable and extensible, you shouldn't expect to solve all problems
15318 Since LyX has to generate a somewhat special LaTeX file to be able to match
15319 the line numbers from the
15327 \begin_layout Plain Layout
15328 You can inspect the specific output from
15334 Edit\SpecialChar \menuseparator
15336 \begin_inset space ~
15340 \begin_inset space ~
15354 to the internal document structure, some of the warnings will not seen
15355 to appear correctly.
15356 There are two things you can do about this:
15359 \begin_layout Itemize
15364 invocation command line in
15380 installation configuration file (usually with the file
15385 See below to learn what warnings can be enabled and disabled on the command
15390 \begin_layout Itemize
15391 Export your document as a raw LaTeX file using
15396 ile\SpecialChar \menuseparator
15401 xport\SpecialChar \menuseparator
15413 Invoked in this way, it can be a hassle to find the corresponding place
15414 in the document inside LyX, but with a little patience, you should be able
15418 \begin_layout Standard
15419 Here follows the warning messages that can be enabled and disabled in
15428 to disable a warning, and
15432 to enable a warning.
15433 The emphasized entries are disabled by default, because the default is
15436 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15441 \begin_layout Standard
15442 Notice that you should only use the options that enable and disable warnings,
15443 because LyX relies on some of the other command line parameters to be set
15444 in a specific way to have a chance to communicate with
15451 \begin_layout Enumerate
15455 Command terminated with space.
15458 \begin_layout Enumerate
15461 Non-breaking space (
15462 \begin_inset Quotes eld
15470 \begin_inset Quotes erd
15473 ) should have been used.
15476 \begin_layout Enumerate
15480 You should enclose the previous parenthesis with
15481 \begin_inset Quotes eld
15489 \begin_inset Quotes erd
15495 \begin_layout Enumerate
15498 Italic correction (
15499 \begin_inset Quotes eld
15509 \begin_inset Quotes erd
15512 ) found in non-italic buffer.
15515 \begin_layout Enumerate
15518 Italic correction (
15519 \begin_inset Quotes eld
15529 \begin_inset Quotes erd
15532 ) found more than once.
15535 \begin_layout Enumerate
15539 No italic correction (
15540 \begin_inset Quotes eld
15550 \begin_inset Quotes erd
15556 \begin_layout Enumerate
15560 \begin_inset Quotes eld
15568 \begin_inset Quotes erd
15572 \begin_inset Quotes eld
15580 \begin_inset Quotes erd
15586 \begin_layout Enumerate
15589 Wrong length of dash may have been used.
15592 \begin_layout Enumerate
15596 \begin_inset Quotes eld
15604 \begin_inset Quotes erd
15608 \begin_inset Quotes eld
15616 \begin_inset Quotes erd
15622 \begin_layout Enumerate
15626 \begin_inset Quotes eld
15634 \begin_inset Quotes erd
15640 \begin_layout Enumerate
15644 \begin_inset Quotes eld
15652 \begin_inset Quotes erd
15655 to achieve an ellipsis.
15658 \begin_layout Enumerate
15661 Inter-word spacing (
15662 \begin_inset Quotes eld
15672 \begin_inset Quotes eld
15675 ) should perhaps be used.
15678 \begin_layout Enumerate
15681 Inter-sentence spacing (
15682 \begin_inset Quotes eld
15692 \begin_inset Quotes erd
15695 ) should perhaps be used.
15698 \begin_layout Enumerate
15701 Could not find argument for command.
15704 \begin_layout Enumerate
15708 \begin_inset Quotes eld
15716 \begin_inset Quotes erd
15722 \begin_layout Enumerate
15725 Math mode still on at end of LaTeX file.
15728 \begin_layout Enumerate
15732 \begin_inset Quotes eld
15740 \begin_inset Quotes erd
15743 doesn't match the number of
15744 \begin_inset Quotes eld
15752 \begin_inset Quotes erd
15758 \begin_layout Enumerate
15761 You should use either
15764 \begin_inset Quotes eld
15772 \begin_inset Quotes erd
15777 as an alternative to
15778 \begin_inset Quotes eld
15786 \begin_inset Quotes erd
15792 \begin_layout Enumerate
15799 " (ASCII 39) instead of "
15806 \begin_layout Enumerate
15809 User-specified pattern found.
15812 \begin_layout Enumerate
15815 This command might not be intended.
15818 \begin_layout Enumerate
15825 \begin_layout Enumerate
15843 \begin_layout Enumerate
15846 Delete this space to maintain correct page references.
15849 \begin_layout Enumerate
15853 You might wish to put this between a pair of
15854 \begin_inset Quotes eld
15862 \begin_inset Quotes erd
15868 \begin_layout Enumerate
15871 You ought to remove spaces in front of punctuation.
15874 \begin_layout Enumerate
15877 Could not execute LaTeX command.
15880 \begin_layout Enumerate
15889 in front of small punctuation.
15892 \begin_layout Enumerate
15900 may look prettier here.
15903 \begin_layout Enumerate
15907 Multiple spaces detected in output.
15910 \begin_layout Enumerate
15913 This text may be ignored.
15916 \begin_layout Enumerate
15922 \begin_inset Quotes eld
15927 to begin quotation, not
15934 \begin_layout Enumerate
15941 to end quotation, not
15944 \begin_inset Quotes eld
15952 \begin_layout Enumerate
15958 \begin_layout Enumerate
15961 You should perhaps use
15962 \begin_inset Quotes eld
15970 \begin_inset Quotes erd
15976 \begin_layout Enumerate
15979 You should put a space in front of/after parenthesis.
15982 \begin_layout Enumerate
15985 You should avoid spaces in front of/after parenthesis.
15988 \begin_layout Enumerate
15992 You should not use punctuation in front of/after quotes.
15995 \begin_layout Enumerate
15998 Double space found.
16001 \begin_layout Enumerate
16004 You should put punctuation outside inner/inside display math mode.
16007 \begin_layout Enumerate
16010 You ought to not use primitive TeX in LaTeX code.
16013 \begin_layout Enumerate
16016 You should remove spaces in front of
16017 \begin_inset Quotes eld
16025 \begin_inset Quotes erd
16031 \begin_layout Enumerate
16034 \begin_inset Quotes eld
16042 \begin_inset Quotes erd
16045 is normally not followed by
16046 \begin_inset Quotes eld
16054 \begin_inset Quotes erd
16060 \begin_layout Standard
16061 In later versions of LyX, we hope to provide a more complete interface to
16062 this tool (and it's smaller cousin
16066 ) to exploit the full power of it.
16067 But it's not exactly useless as it is now: go try it on one of your existing
16068 documents of a certain length and be surprised.
16071 \begin_layout Section
16072 Version Control in LyX
16075 \begin_layout Standard
16078 Lars Gullik Bjønnes,
16085 \begin_layout Subsection
16089 \begin_layout Standard
16090 A friend of mine wanted to try LyX for a group project.
16091 When he didn't find support for version control or file locking, he dropped
16093 This angered me a bit, so I thought that I should at least make support
16094 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16095 This has now been done.
16096 LyX now supports some of the most basic RCS commands.
16097 If you need to something a bit more sophisticated you will have to do that
16098 manually in an xterm.
16101 \begin_layout Standard
16102 Before you begin to use the version control features in LyX, you should
16104 \begin_inset Quotes eld
16108 \begin_inset Quotes erd
16111 (a man file, read it with
16116 This file describes all the basic features of RCS.
16117 You should especially notice the comment about a RCS directory, and the
16118 notion of a master RCS file (the file ending in
16125 \begin_layout Standard
16126 Later basic CVS/SVN support was added.
16127 You should be familiar with CVS/SVN usage before start using it under LyX.
16128 Most of the log messages are not currently displayed after operations -
16129 you can check them in terminal window if unsure.
16132 \begin_layout Standard
16133 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16134 package---no guarantees are made for older versions.
16137 \begin_layout Subsection
16138 RCS commands in LyX
16141 \begin_layout Standard
16142 The following sections describe the RCS commands supported by LyX.
16143 You can find them in the
16148 ile\SpecialChar \menuseparator
16154 \begin_inset space ~
16162 \begin_layout Subsubsection
16168 \begin_layout Standard
16169 If your document is not under revision control, this is the only item shown
16171 And if it is under revision control, the
16178 item is not visible.
16182 \begin_layout Standard
16183 This command registers your document with RCS (unless you are under the
16184 directory managed by CVS)\SpecialChar \@.
16185 You are asked interactively to supply an initial
16186 description of the document.
16187 The document is now set in Read-Only mode and you have to
16190 \begin_inset space ~
16194 \begin_inset space ~
16198 \begin_inset space ~
16203 , before making any changes to it.
16204 A document under revision control has a
16205 \begin_inset Quotes eld
16208 [RCS:<version> <locker>]
16209 \begin_inset Quotes erd
16212 item tagged to the filename in the minibuffer.
16215 \begin_layout Standard
16216 RCS command that is run:
16218 ci -q -u -i -t-"<initial description>" <file-name>
16221 \begin_layout Standard
16226 to understand the switches.
16230 \begin_layout Subsubsection
16236 \begin_layout Standard
16237 When you are finished editing a file, you check in your changes.
16238 When you do this, you are asked for a description of the changes.
16239 This is stored in the history log.
16240 The version number is bumped, your changes are applied to the master RCS
16241 file, the document is unlocked and set to Read-Only mode.
16245 \begin_layout Standard
16248 ci -q -u -m"<description>" <file-name>
16251 \begin_layout Subsubsection
16257 \begin_layout Standard
16258 By doing this you lock the document so that only you can edit it.
16259 This will also make the document Read-Write only for you.
16260 You will usually continue editing for a while and when you are finished
16261 you check in your changes.
16262 The status line is changed to reflect that you have locked the file.
16266 \begin_layout Standard
16269 co -q -l <file-name>
16272 \begin_layout Subsubsection
16275 Revert To Repository Version
16278 \begin_layout Standard
16279 This will discard all changes made to the document since the last check
16281 You get a warning before changes are discarded.
16284 \begin_layout Standard
16287 co -f -u<version> <file-name>
16290 \begin_layout Subsubsection
16296 \begin_layout Standard
16297 This makes as if the last check in never happened.
16298 No changes are made to the document loaded into LyX, but the last version
16299 is removed from the master RCS file.
16303 \begin_layout Standard
16306 rcs -o<version> <file-name>
16309 \begin_layout Subsubsection
16315 \begin_layout Standard
16316 This show the complete history of the RCS document.
16321 is shown in a browser.
16329 \begin_layout Subsection
16330 CVS commands in LyX
16333 \begin_layout Standard
16334 CVS is now partially supported by LyX.
16335 You can find the commands in the
16340 ile\SpecialChar \menuseparator
16346 \begin_inset space ~
16354 \begin_layout Subsubsection
16360 \begin_layout Standard
16361 If your document is not under revision control, this is the only item shown
16363 And if it is under revision control, the
16370 item is not visible.
16374 \begin_layout Standard
16375 This command registers in CVS your document ONLY in case you have already
16376 the documents directory under CVS control (in particular
16381 This means you have to checkout the archive by yourself.
16385 \begin_layout Standard
16386 Then you are asked interactively to supply an initial description of the
16388 Don't forget that registered file is not yet commited.
16391 \begin_layout Standard
16392 CVS command that is run:
16395 \begin_inset Quotes erd
16399 \begin_inset Quotes eld
16403 \begin_inset Quotes erd
16409 \begin_layout Standard
16414 to understand the switches.
16418 \begin_layout Subsubsection
16424 \begin_layout Standard
16425 When you are finished editing a file, you commit your changes.
16426 When you do this, you are asked for a description of the changes.
16427 After that changes are commited.
16430 \begin_layout Standard
16433 cvs -q commit -m"<description>" <file-name>
16436 \begin_layout Subsubsection
16439 Revert To Repository Version
16442 \begin_layout Standard
16443 This will discard all changes made to the document since the last check
16445 You get a warning before changes are discarded.
16446 Firstly the file is deleted, secondly CVS update command is run.
16449 \begin_layout Standard
16453 \begin_inset Quotes eld
16457 \begin_inset Quotes erd
16463 \begin_layout Subsubsection
16469 \begin_layout Standard
16470 This show the complete history of the CVS document.
16474 \begin_inset Quotes eld
16478 \begin_inset Quotes erd
16483 is shown in a browser.
16486 \begin_layout Subsection
16487 SVN commands in LyX
16490 \begin_layout Standard
16491 SVN is now partially supported by LyX.
16492 You can find the commands in the
16497 ile\SpecialChar \menuseparator
16503 \begin_inset space ~
16509 Please note that if you use password protected access to repository via
16510 ssh, you will be asked in terminal window.
16513 \begin_layout Subsubsection
16519 \begin_layout Standard
16520 If your document is not under revision control, this is the only item shown
16522 And if it is under revision control, the
16529 item is not visible.
16533 \begin_layout Standard
16534 This command registers in SVN your document ONLY in case you have already
16535 the documents directory under SVN control (in particular
16540 This means you have to checkout the archive by yourself.
16544 \begin_layout Standard
16545 Then you are asked interactively to supply an initial description of the
16547 Don't forget that registered file is not yet commited.
16550 \begin_layout Standard
16551 SVN command that is run:
16554 \begin_inset Quotes eld
16558 \begin_inset Quotes erd
16564 \begin_layout Standard
16569 to understand the switches.
16573 \begin_layout Subsubsection
16579 \begin_layout Standard
16580 When you are finished editing a file, you commit your changes.
16581 When you do this, you are asked for a description of the changes.
16582 After that changes are commited.
16585 \begin_layout Standard
16588 svn commit -q -m"<description>" <file-name>
16591 \begin_layout Subsubsection
16597 \begin_layout Standard
16598 Updates the changes of this file from the repository.
16599 Be sure you understand SVN merging and conflicts resolving before using
16600 this function, because all conflicts has to be done manually by you!
16603 \begin_layout Standard
16607 \begin_inset Quotes eld
16611 \begin_inset Quotes erd
16617 \begin_layout Subsubsection
16620 Revert To Repository Version
16623 \begin_layout Standard
16624 This will discard all changes made to the document since the last check
16626 You get a warning before changes are discarded.
16630 \begin_layout Standard
16634 \begin_inset Quotes eld
16638 \begin_inset Quotes erd
16644 \begin_layout Subsubsection
16650 \begin_layout Standard
16651 This show the complete history of the SVN document.
16655 \begin_inset Quotes eld
16659 \begin_inset Quotes erd
16664 is shown in a browser.
16667 \begin_layout Section
16668 Literate Programming
16671 \begin_layout Standard
16676 (kayvan@sylvan.com)
16680 original documentation written by
16682 Edmar Wienskoski Jr.
16685 (edmar-w-jr@technologist.com)
16688 \begin_layout Subsection
16692 \begin_layout Standard
16693 The main purpose of this documentation is to show you how to use LyX for
16694 literate programming.
16695 Where it is assumed that you are familiar with this programming technique,
16697 \begin_inset Quotes eld
16701 \begin_inset Quotes erd
16705 \begin_inset Quotes eld
16709 \begin_inset Quotes erd
16713 If that is not the case, please follow the web links provided in the following
16715 There is a lot of good documentation out there covering old development
16716 history to the latest tools tips.
16719 \begin_layout Standard
16720 It is also assumed that you are familiar with LyX itself to a point that
16721 you are comfortable changing your LyX preferences, and X resources file.
16722 If that is not the case please refer to other LyX documentation to cover
16723 your specific needs.
16726 \begin_layout Subsection
16727 Literate Programming
16730 \begin_layout Standard
16731 From the Literate Programming FAQ:
16734 \begin_layout Quotation
16735 Literate programming is the combination of documentation and source together
16736 in a fashion suited for reading by human beings.
16737 In fact, literate programs should be enjoyable reading, even inviting!
16738 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16739 and documentation in a single file.
16740 Literate programming tools then parse the file to produce either readable
16741 documentation or compilable source.
16742 The WEB style of literate programming was created by D.E.
16743 Knuth during the development of his TeX typesetting software.
16747 \begin_layout Standard
16748 Another excerpt says:
16751 \begin_layout Quotation
16754 How is literate programming different from verbose commenting?
16757 \begin_layout Quotation
16758 There are three distinguishing characteristics.
16759 In order of importance, they are:
16763 \begin_layout Itemize
16764 flexible order of elaboration
16767 \begin_layout Itemize
16768 automatic support for browsing
16771 \begin_layout Itemize
16772 typeset documentation, especially diagrams and mathematics
16776 \begin_layout Standard
16777 Now that I sparked your curiosity, take a look in the references.
16780 \begin_layout Subsubsection
16784 \begin_layout Standard
16785 The complete Literate Programming FAQ can be found at:
16788 \begin_layout Quote
16789 Literate Programming FAQ
16790 \begin_inset Flex URL
16793 \begin_layout Plain Layout
16795 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16803 \begin_layout Standard
16804 The FAQ lists 23 (twenty three!) different literate programming tools.
16805 Where some are specialized or
16806 \begin_inset Quotes eld
16810 \begin_inset Quotes erd
16813 for particular programming languages, while other have general scope.
16818 for my own use for several reasons:
16821 \begin_layout Itemize
16822 It can generate the documentation either in LaTeX or HTML.
16825 \begin_layout Itemize
16826 It has a open architecture, i.e., it is easy to plug in new filters and to
16827 perform special processing that you may need.
16831 \begin_layout Itemize
16832 There is a good selection of filters available already (the HTML is one
16836 \begin_layout Itemize
16840 \begin_layout Standard
16841 The Noweb web page can be found at:
16844 \begin_layout Quote
16846 \begin_inset Flex URL
16849 \begin_layout Plain Layout
16851 http://www.cs.virginia.edu/~nr/noweb/
16859 \begin_layout Standard
16860 Starting from there you can reach many other interesting links and even
16861 some literate program examples.
16864 \begin_layout Subsection
16865 LyX and Literate Programming
16868 \begin_layout Standard
16869 The LyX support for Literate Programming is provided by using the generic
16870 LyX convertors mechanism.
16871 This support is provided in a
16872 \begin_inset Quotes eld
16876 \begin_inset Quotes erd
16879 way, i.e., you will be able to use this new LyX feature with some other literate
16880 programming tool of your choice by just changing your LyX preferences.
16883 \begin_layout Subsubsection
16884 Generating documents and code (weaving and tangling)
16887 \begin_layout Paragraph
16888 Selecting the document class
16891 \begin_layout Standard
16892 If you have installed Noweb and LyX successfully, whenever you open a new
16893 document or try to change the document class of an existing one, you will
16894 find that there are three new document classes available:
16897 \begin_layout Itemize
16901 \begin_layout Itemize
16905 \begin_layout Itemize
16909 \begin_layout Standard
16910 You must select one of them to create your literate documents from.
16914 \begin_layout Standard
16915 Note that literate documents are not limited to these three classes.
16916 New classes can be generated from other styles like letter or in combination
16917 with other class variations like Article (AMS).
16918 If you have special needs that cannot be covered by one of the existing
16919 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16920 will arrange to insert a new entry, or teach you how to do it.
16924 \begin_layout Plain Layout
16925 It is very simple, it involves the creation of a file with four lines, and
16926 re-running of the auto configuration.
16931 Moreover, if you use a literate tool other than Noweb you may need to create
16932 a new set of document classes for it.
16935 \begin_layout Paragraph
16939 \begin_layout Standard
16940 LyX enables you to write code with a layout named
16948 \begin_layout Plain Layout
16949 The equivalent Noweb term is
16950 \begin_inset Quotes eld
16954 \begin_inset Quotes erd
16958 For historical reasons, I got used to the term
16959 \begin_inset Quotes eld
16963 \begin_inset Quotes erd
16966 introduced by other literate tool named Nuweb, which I used for many years
16967 before rendering myself to Noweb.
16972 Noweb delimits scraps like this:
16975 \begin_layout LyX-Code
16979 \begin_layout LyX-Code
16983 \begin_layout LyX-Code
16987 \begin_layout LyX-Code
16991 \begin_layout LyX-Code
16995 \begin_layout Standard
16996 The problem is that whatever is written in between the << and the
17000 must be taken literally, i.e., LyX should be prevented from making any special
17001 interpretation of what has been written.
17002 This is handled by a special layout named Scrap, that works like a normal
17003 paragraph but has a free spacing capability.
17006 \begin_layout Standard
17007 The down side of the Scrap paragraph layout is that consecutive paragraphs
17008 of code will be spaced with one empty line in the source code and also
17009 in the printed documentation.
17010 The work around is to enter each line of code within a single Scrap, with
17011 a newline (ctrl-return).
17012 The example above will look like this:
17016 \begin_layout Plain Layout
17017 If you have a printed version of this document you will not see any difference
17018 between the previous example and this one.
17026 \begin_layout LyX-Code
17028 \begin_inset Newline newline
17032 \begin_inset Newline newline
17036 \begin_inset Newline newline
17040 \begin_inset Newline newline
17046 \begin_layout Standard
17047 This layout works fine.
17048 The only real inconvenience is that you have to type ctrl-return instead
17053 \begin_layout Plain Layout
17054 It is in my list of
17055 \begin_inset Quotes eld
17059 \begin_inset Quotes erd
17070 \begin_layout Standard
17071 As a special note, you can also use the
17072 \begin_inset Quotes eld
17076 \begin_inset Quotes erd
17079 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17083 \begin_layout LyX-Code
17085 \begin_inset Newline newline
17088 def some_function(args):
17089 \begin_inset Newline newline
17092 "This is the doc string for this function."
17093 \begin_inset Newline newline
17096 print "My args: ", args
17099 \begin_layout LyX-Code
17100 @ %def some_function
17103 \begin_layout Standard
17104 For an example of this usage and the resulting cross-reference output, look
17105 at the Literate python program in
17107 LIBDIR/examples/listerrors.lyx
17109 which should make this all clear.
17112 \begin_layout Paragraph
17113 Generating the documentation
17116 \begin_layout Standard
17117 At this point you already have a new document file with a proper document
17118 class, and with some code and text on it.
17119 How do I print it? The answer is simple, you select
17124 iew\SpecialChar \menuseparator
17132 Just like you would do for a plain document.
17133 No special procedure is required.
17136 \begin_layout Standard
17137 To help orientate you, I will now explain what happens inside LyX:
17140 \begin_layout Enumerate
17143 Update\SpecialChar \menuseparator
17146 menu option is chosen, a LaTeX file is generated.
17151 \begin_layout Standard
17152 If the document is of any literate class the generated file will be named
17153 with an extension name defined by the
17154 \begin_inset Quotes eld
17158 \begin_inset Quotes erd
17161 format (defined in the Preferences panel), otherwise the file will have
17170 \begin_layout Enumerate
17171 Note that the only difference so far is in the name of the file, no special
17172 processing is required by LyX.
17173 Given that you formatted the code using the Scrap layout that, by itself,
17174 takes care of the business.
17177 \begin_layout Enumerate
17178 If the document is of any literate class LyX will then use the internal
17179 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17183 \begin_layout Plain Layout
17184 The converters are defined in the
17186 Tools\SpecialChar \menuseparator
17190 \begin_inset Quotes eld
17194 \begin_inset Quotes erd
17206 manual for general information about converters.
17211 to generate the LaTeX file.
17215 \begin_layout Standard
17216 Otherwise it will just skip this step.
17220 \begin_layout Enumerate
17221 Finally, LaTeX is invoked and the regular post processing continues as in
17225 \begin_layout Standard
17226 Independence from a particular
17227 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17234 is easily achieved by changing the commands that are run by the various
17238 \begin_layout Paragraph
17239 Generating the code
17242 \begin_layout Standard
17243 When the build menu option is chosen or the corresponding button in the
17244 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17245 Next, LyX invokes the
17250 This converter needs to be defined by the user and is not installed by
17251 default, though the Program format is.
17252 This converter (like any other converter) will have two parts:
17255 \begin_layout Enumerate
17256 The converter program itself.
17257 This program performs the conversion from the one format to the other (in
17258 this case, from the Noweb format to the Program pseudo-format).
17261 \begin_layout Enumerate
17262 The error log parser.
17263 This is a program whose sole purpose is to rewrite error messages in a
17264 format that LyX understands.
17265 This makes it possible for LyX to place error boxes in the right places
17266 in the file buffer.
17269 \begin_layout Standard
17270 The first part, the
17271 \begin_inset Quotes eld
17275 \begin_inset Quotes erd
17278 setting, should be set to
17279 \begin_inset Quotes eld
17287 \begin_inset Quotes erd
17291 This basically means that LyX will call
17292 \begin_inset Quotes eld
17296 \begin_inset Quotes erd
17299 (a program or script) with the name of the Noweb file (normally a file
17300 in the LyX temp directory).
17304 \begin_layout Standard
17305 This is an implementation of
17306 \begin_inset Quotes eld
17310 \begin_inset Quotes erd
17313 that you can place in a directory on your path:
17316 \begin_layout LyX-Code
17320 \begin_layout LyX-Code
17324 \begin_layout LyX-Code
17325 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17328 \begin_layout Standard
17329 The next part of the converter setting is the
17330 \begin_inset Quotes eld
17334 \begin_inset Quotes erd
17337 which is to be set to
17338 \begin_inset Quotes eld
17343 parselog=listerrors
17346 \begin_inset Quotes erd
17350 This will run any errors that are generated by the
17351 \begin_inset Quotes eld
17355 \begin_inset Quotes erd
17358 process through the
17359 \begin_inset Quotes eld
17363 \begin_inset Quotes erd
17369 \begin_layout Standard
17370 The converter code looks in
17378 then on the path for the
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17389 \begin_layout Standard
17390 The build will normally take place in LyX's temporary directory, so the
17391 files produced by the conversion will be in that directory.
17392 LyX will copy out what it regards as the `main' file, but the
17396 conversion may produce several files, and so most of these would then be
17397 deleted when LyX was closed.
17398 The present solution is to use a `copier',
17402 \begin_layout Plain Layout
17411 manual for information on these.
17420 script in its default mode, so that the entire contents of the temporary
17421 directory is copied.
17422 More will get copied than is needed, to be sure, but nothing will be lost.
17423 If, however, you know what extensions the generated files will have, this
17424 can be improved by using the
17433 This option takes a comma-separated list of extensions to copy.
17434 So, for example, if the conversion will generate only files with the extensions
17443 , then the correct definition would be:
17446 \begin_layout LyX-Code
17447 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17450 \begin_layout Standard
17451 The result will be that only files with these two extensions will be copied
17455 \begin_layout Paragraph
17456 Build instructions in the document
17459 \begin_layout Standard
17460 The last piece of the integration between LyX and noweb is the
17461 \begin_inset Quotes eld
17465 \begin_inset Quotes erd
17469 Generally, the instructions for building your program should be embedded
17470 in a scrap of its own.
17472 \begin_inset Quotes eld
17476 \begin_inset Quotes erd
17479 above uses the notangle command to look for this scrap (called
17480 \begin_inset Quotes eld
17484 \begin_inset Quotes erd
17487 ) and runs its contents through
17488 \begin_inset Quotes eld
17492 \begin_inset Quotes erd
17498 \begin_layout Standard
17499 Typically, such a scrap would look something like this:
17502 \begin_layout LyX-Code
17504 \begin_inset Newline newline
17508 \begin_inset Newline newline
17512 \begin_inset Newline newline
17515 if [ -z "${NOWEB_SOURCE}" ]
17516 \begin_inset Newline newline
17520 \begin_inset Newline newline
17523 NOWEB_SOURCE=myfile.nw
17524 \begin_inset Newline newline
17528 \begin_inset Newline newline
17532 code to extract files ...]
17533 \begin_inset Newline newline
17537 code to compile files ...]
17538 \begin_inset Newline newline
17544 \begin_layout Standard
17547 LIBDIR/examples/listerrors.lyx
17551 LIBDIR/examples/Literate.lyx
17553 which implement two versions of the
17554 \begin_inset Quotes eld
17558 \begin_inset Quotes erd
17561 program for some illustrations of how all of these pieces go together or
17564 LIBDIR/examples/noweb2lyx.lyx.
17567 Interestingly, these three files show off the language-indepence of the
17568 LyX literate programming support since they are written in Python, C and
17572 \begin_layout Subsubsection
17576 \begin_layout Standard
17577 All the Literate Programming support is configured by the
17582 ools\SpecialChar \menuseparator
17590 \begin_inset Quotes eld
17594 \begin_inset Quotes erd
17598 The important parts are:
17601 \begin_layout Description
17603 \begin_inset space ~
17607 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17615 \begin_inset space ~
17618 format Set up via the Formats tab, this is where the Noweb-specific pieces
17628 , the file extension is set to
17633 This tells LyX to create a file with a
17637 extension in the first step of the conversion process.
17640 \begin_layout Description
17642 \begin_inset space ~
17650 \begin_inset space ~
17653 format This is an empty format whose sole purpose is to be the endpoint
17654 of a conversion (which then allows us to set up a converter for it).
17657 \begin_layout Description
17666 This converter performs the
17667 \begin_inset Quotes eld
17671 \begin_inset Quotes erd
17674 of the literate document.
17675 For Noweb, it is set to
17676 \begin_inset Quotes eld
17681 noweave -delay -index $$i > $$o
17684 \begin_inset Quotes erd
17690 \begin_layout Description
17700 \begin_inset Quotes eld
17704 \begin_inset Quotes erd
17708 As stated above, the Converter is set to
17709 \begin_inset Quotes eld
17717 \begin_inset Quotes erd
17720 , with Flags set to
17721 \begin_inset Quotes eld
17726 originaldir,parselog=listerrors
17729 \begin_inset Quotes erd
17735 \begin_layout Subsubsection
17739 \begin_layout Standard
17740 There is also a new function implemented in the LyX server, the
17741 \begin_inset Quotes eld
17744 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17748 \begin_layout Standard
17749 When debugging code with ddd/gdb, it is possible to invoke a text editor
17750 at the current execution position with a single key stroke.
17751 The default ddd configuration for that is shift-ctrl-V.
17752 It happens that you can define the editor command line invocation in ddd
17758 dit\SpecialChar \menuseparator
17763 references\SpecialChar \menuseparator
17770 dialog and changing the "Edit Sources" entry.
17773 \begin_layout Standard
17774 I take advantage of the new created LyX server function and this ddd feature,
17776 \begin_inset Quotes eld
17780 \begin_inset Quotes erd
17786 \begin_layout LyX-Code
17787 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17790 \begin_layout Standard
17791 With this, whenever you are using ddd and find a point in the program that
17792 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17793 ddd you forward this information to LyX through the LyX server and then
17794 the LyX window will show the same file with the cursor at the same position
17795 ddd was pointing to.
17796 No more guessing or long scrolling to locate a point in the program back
17800 \begin_layout Standard
17801 Note however that you must enable the LyX server to get this feature working
17802 (it is disabled by default).
17803 You can enable it in
17815 ) by entering in the
17820 \begin_inset Quotes eld
17825 /home/<your-home-directory>/.lyx/lyxpipe
17828 \begin_inset Quotes erd
17834 \begin_layout Standard
17835 Read the LyX server documentation in the
17837 Customization Manual
17839 for further information.
17842 \begin_layout Subsubsection
17846 \begin_layout Standard
17847 There are six new buttons that can be added to your LyX toolbar.
17848 Five of these buttons are short cuts to layout styles:
17869 The last one is a short cut to the
17870 \begin_inset Quotes eld
17874 \begin_inset Quotes erd
17881 \begin_layout Standard
17882 LyX has a range of buttons that are available for tool bar customization.
17883 In my toolbar I like to combine the six short cuts above with two more:
17891 \SpecialChar \menuseparator
17899 \SpecialChar \menuseparator
17912 iew\SpecialChar \menuseparator
17920 Here is how it looks like:
17923 \begin_layout LyX-Code
17927 \begin_layout LyX-Code
17931 \begin_layout LyX-Code
17932 Icon "layout Standard"
17935 \begin_layout LyX-Code
17936 Icon "layout Section"
17939 \begin_layout LyX-Code
17940 Icon "layout LaTeX"
17943 \begin_layout LyX-Code
17944 Icon "layout LyX-Code"
17947 \begin_layout LyX-Code
17948 Icon "layout Scrap"
17951 \begin_layout LyX-Code
17955 \begin_layout LyX-Code
17959 \begin_layout LyX-Code
17960 Icon "buffer-typeset"
17963 \begin_layout LyX-Code
17964 Icon "build-program"
17967 \begin_layout LyX-Code
17971 \begin_layout LyX-Code
17975 \begin_layout LyX-Code
17979 \begin_layout LyX-Code
17983 \begin_layout LyX-Code
17987 \begin_layout Subsubsection
17988 Colors customization
17991 \begin_layout Standard
17992 There are a number of colors in LyX that can be customized in
17997 One of the things that bothers people is the LaTeX font color.
17998 The default color is red, since the scraps uses LaTeX font, and there is
17999 a lot of scraps in literate documents, you may get tired of seeing everything
18001 You can change it by going to the tabs
18010 \begin_layout Standard
18011 The next thing is the visible presence of the newline character in the screen.
18012 You can choose the color of this particular character and make it blend
18014 I recommend you choosing a color that is close to the background but not
18015 equal, that way you still can see it is there, but it is not bothering
18020 \begin_layout Chapter
18021 Secrets of the LaTeX Masters
18022 \begin_inset CommandInset label
18031 \begin_layout Standard
18032 Though LyX is a powerful tool, it cannot hope to support everything that
18033 can be done with pure TeX/LaTeX.
18034 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18035 as long as you are not afraid to use that
18036 \begin_inset Quotes eld
18040 \begin_inset Quotes erd
18043 button on the toolbar or add things to the LaTeX preamble.
18044 This section lists some tips, tricks, and otherwise cool ideas to give
18045 your document that extra little flair.
18048 Do try this at home
18050 , just start with something a little smaller and less important than your
18054 \begin_layout Standard
18055 Most ideas in this section require less common files in your LaTeX installation.
18056 If you have a system like teTeX, most will already be available.
18057 A few, however, will need to be downloaded from one of the CTAN archives.
18058 Often, there are several ways to do something, or several LaTeX style files
18059 which do the same thing.
18060 We do not endorse one choice over another, we simply claim that we have
18061 done a particular task with a particular file.
18062 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18065 \begin_layout Section
18069 \begin_layout Standard
18072 Lars Gullik Bjønnes
18075 \begin_layout Subsection
18079 \begin_layout Standard
18080 The aim for this chapter
18084 \begin_layout Plain Layout
18085 Editor's note: Lars' original chapter was a masterful description of how
18091 However, it was too long to flow smoothly in this document.
18092 I have therefore chosen to excerpt the most important sections here (sorry,
18093 Lars); you can read the original chapter (and more of the story!) in the
18096 examples/multicol.lyx
18104 is to show how the LaTeX package
18108 can be used in a LyX document.
18109 As LyX doesn't support the
18113 package natively yet, we have to use some small hacks.
18114 By reading this section it should be obvious how to do this.
18117 \begin_layout Subsection
18121 \begin_layout Standard
18126 package allows switching between one and multicolumn format on the same
18128 Footnotes are handled correctly (for the most part), but will be placed
18129 at the bottom of the page and not under each column.
18130 LaTeX's float mechanism, however, is partly disabled in the current implementat
18132 At the moment only page-wide floats can be used within the scope of the
18136 \begin_layout Subsection
18140 \begin_layout Subsubsection
18144 \begin_layout Standard
18145 If you want to have two columns in your text, you have use LaTeX mode to
18150 begin{multicols}{2}
18152 at the point where you want the two column layout to start, and then
18158 where you want it to end.
18162 \begin_layout Standard
18166 \begin_layout Plain Layout
18170 begin{multicols}{2}
18178 \begin_layout Standard
18183 The Adventure of the Empty House
18186 \begin_inset Newline newline
18191 Sir Arthur Conan Doyle
18194 \begin_layout Standard
18197 It was in the spring of the year 1894 that all London was interested, and
18198 the fashionable world dismayed, by the murder of the Honourable Ronald
18199 Adair under most unusual and inexplicable circumstances.
18200 The public has already learned those particulars of the crime which came
18201 out in the police investigation, but a good deal was suppressed upon that
18202 occasion, since the case for the prosecution was so overwhelmingly strong
18203 that it was not necessary to bring forward all the facts.
18204 Only now, at the end of nearly ten years, am I allowed to supply those
18205 missing links which make up the whole of that remarkable chain.
18206 The crime was of interest in itself, but that interest was as nothing to
18207 me compared to the inconceivable sequel, which afforded me the greatest
18208 shock and surprise of any event in my adventurous life.
18209 Even now, after this long interval, I find myself thrilling as I think
18210 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18211 ty which utterly submerged my mind.
18212 Let me say to that public, which has shown some interest in those glimpses
18213 which I have occasionally given them of the thoughts and actions of a very
18214 remarkable man, that they are not to blame me if I have not shared my knowledge
18215 with them, for I should have considered it my first duty to do so, had
18216 I not been barred by a positive prohibition from his own lips, which was
18217 only withdrawn upon the third of last month.
18220 \begin_layout Standard
18224 \begin_layout Plain Layout
18236 \begin_layout Subsubsection
18240 \begin_layout Standard
18241 The same pattern is used when you want more than two columns:
18244 \begin_layout Standard
18248 \begin_layout Plain Layout
18252 begin{multicols}{3}
18260 \begin_layout Standard
18263 It can be imagined that my close intimacy with Sherlock Holmes had interested
18264 me deeply in crime, and that after his disappearance I never failed to
18265 read with care the various problems which came before the public.
18266 And I even attempted, more than once, for my own private satisfaction,
18267 to employ his methods in their solution, though with indifferent success.
18268 There was none, however, which appealed to me like this tragedy of Ronald
18270 As I read the evidence at the inquest, which led up to a verdict of willful
18271 murder against some person or persons unknown, I realized more clearly
18272 than I had ever done the loss which the community had sustained by the
18273 death of Sherlock Holmes.
18274 There were points about this strange business which would, I was sure,
18275 have specially appealed to him, and the efforts of the police would have
18276 been supplemented, or more probably anticipated, by the trained observation
18277 and the alert mind of the first criminal agent in Europe.
18278 All day, as I drove upon my round, I turned over the case in my mind and
18279 found no explanation which appeared to me to be adequate.
18280 At the risk of telling a twice-told tale, I will recapitulate the facts
18281 as they were known to the public at the conclusion of the inquest.
18284 \begin_layout Standard
18288 \begin_layout Plain Layout
18300 \begin_layout Standard
18301 You can have more than 3 columns if you want to, but that might not be very
18302 pleasant for the eye.
18305 \begin_layout Subsubsection
18306 Columns inside columns
18309 \begin_layout Standard
18310 You can even have columns inside columns:
18313 \begin_layout Standard
18317 \begin_layout Plain Layout
18321 begin{multicols}{2}
18329 \begin_layout Standard
18332 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18333 at that time governor of one of the Australian colonies.
18334 Adair's mother had returned from Australia to undergo the operation for
18335 cataract, and she, her son Ronald, and her daughter Hilda were living together
18339 \begin_layout Standard
18343 \begin_layout Plain Layout
18347 begin{multicols}{2}
18355 \begin_layout Standard
18358 The youth moved in the best society--had, so far as was known, no enemies
18359 and no particular vices.
18360 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18361 had been broken off by mutual consent some months before, and there was
18362 no sign that it had left any very profound feeling behind it.
18363 For the rest {sic} the man's life moved in a narrow and conventional circle,
18364 for his habits were quiet and his nature unemotional.
18365 Yet it was upon this easy-going young aristocrat that death came, in most
18366 strange and unexpected form, between the hours of ten and eleven-twenty
18367 on the night of March 30, 1894.
18370 \begin_layout Standard
18374 \begin_layout Plain Layout
18386 \begin_layout Standard
18389 Ronald Adair was fond of cards--playing continually, but never for such
18390 stakes as would hurt him.
18391 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18392 It was shown that, after dinner on the day of his death, he had played
18393 a rubber of whist at the latter club.
18394 He had also played there in the afternoon.
18399 The evidence of those who had played with him-- Mr.
18400 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18401 and that there was a fairly equal fall of the cards.
18402 Adair might have lost five pounds, but not more.
18403 His fortune was a considerable one, and such a loss could not in any way
18405 He had played nearly every day at one club or other, but he was a cautious
18406 player, and usually rose a winner.
18407 It came out in evidence that, in partnership with Colonel Moran, he had
18408 actually won as much as four hundred and twenty pounds in a sitting, some
18409 weeks before, from Godfrey Milner and Lord Balmoral.
18410 So much for his recent history as it came out at the inquest.
18413 \begin_layout Standard
18417 \begin_layout Plain Layout
18429 \begin_layout Standard
18430 Please do read the file
18432 examples/multicol.lyx
18434 for more advanced examples including column and header spacing, vertical
18435 separator lines, and more.
18438 \begin_layout Section
18443 Paragraph Environment
18444 \begin_inset OptArg
18447 \begin_layout Plain Layout
18448 Numbering in Enumerate
18456 \begin_layout Standard
18462 \begin_layout Standard
18463 \begin_inset VSpace bigskip
18469 \begin_layout Standard
18471 The default numbering for the
18475 paragraph environment begins with Arabic numbers and ends with uppercase
18477 Suppose, however, you wanted a different type of numbering scheme.
18478 Here's a quickie example of how to change the numbering scheme:
18481 \begin_layout LyX-Code
18491 \begin_layout LyX-Code
18501 \begin_layout LyX-Code
18511 \begin_layout LyX-Code
18521 \begin_layout Standard
18522 \SpecialChar \ldots{}
18523 which changes the numbering scheme to uppercase Roman numerals, uppercase
18524 letters, Arabic numbers, and lowercase letter.
18527 \begin_layout Standard
18528 Additionally, the previous example also adds a little bit extra to the numbering
18530 For example, the first level label actually looks like:
18531 \begin_inset Quotes eld
18535 \begin_inset Quotes erd
18539 For ease of reading, we'll describe what the numbering schemes look like
18540 using a notation something like this: <
18541 \begin_inset Quotes eld
18545 \begin_inset Quotes erd
18549 \begin_inset space ~
18553 \begin_inset Quotes erd
18557 \begin_inset Quotes erd
18561 \begin_inset space ~
18565 \begin_inset Quotes erd
18569 \begin_inset Quotes erd
18573 \begin_inset space ~
18577 \begin_inset Quotes eld
18581 \begin_inset Quotes erd
18588 \begin_layout Standard
18589 As you can see in the example, there is a label command for each nesting
18596 \SpecialChar \ldots{}
18603 , as well as a counter,
18607 \SpecialChar \ldots{}
18613 There are also five
18614 \begin_inset Quotes eld
18618 \begin_inset Quotes erd
18651 , each of which take one counter as an argument.
18652 You can add characters before or after these, but there's no need to add
18656 \begin_layout Standard
18657 You can get really fancy with these.
18661 \begin_layout LyX-Code
18675 \begin_layout LyX-Code
18687 \begin_layout LyX-Code
18697 \begin_layout LyX-Code
18707 \begin_layout Standard
18708 produces the somewhat out of hand numbering scheme: <
18709 \begin_inset Quotes eld
18713 \begin_inset Quotes erd
18717 \begin_inset space ~
18721 \begin_inset Quotes erd
18725 \begin_inset Quotes erd
18729 \begin_inset space ~
18733 \begin_inset Quotes erd
18737 \begin_inset Quotes erd
18741 \begin_inset space ~
18745 \begin_inset Quotes eld
18749 \begin_inset Quotes erd
18756 \begin_layout Standard
18760 \begin_layout Section
18764 \begin_layout Standard
18770 \begin_layout Standard
18771 \begin_inset VSpace bigskip
18777 \begin_layout Standard
18782 \begin_layout Plain Layout
18788 tmpfont}{cmr17 scaled 2500}{
18800 \begin_layout Standard
18805 \begin_layout Plain Layout
18816 hose of you who like the style of old books probably also like
18817 \begin_inset Quotes eld
18821 \begin_inset Quotes erd
18824 ---those large capital letters which begin each new chapter or section.
18825 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18826 know some plain TeX!) but does require a lot of work and many iterations,
18827 as you can see by all the ugly TeX-mode stuff at the beginning of this
18831 \begin_layout Standard
18835 \begin_layout Plain Layout
18841 bigdrop{-1em}{3}{ptmri}{T}+
18846 here is a much easier way of doing this, of course.
18855 ) package from CTAN allows a simple way to add such letters to your documents.
18856 Since this package is not a standard part of teTeX, I can't demonstrate
18857 it within this document, but if you copy this paragraph to a new document,
18859 \begin_inset Quotes eld
18869 \begin_inset Quotes erd
18872 and the pluses from the TeX code at the beginning of the paragraph, and
18877 usepackage{dropcaps}
18879 to your LaTeX preamble, you will get a nice Times Roman Italic
18880 \begin_inset Quotes eld
18884 \begin_inset Quotes erd
18887 , whose height is three lines of text and which protrudes 1 em into the
18889 (Make certain you have copied
18890 \begin_inset Quotes eld
18898 \begin_inset Quotes erd
18901 into a directory where TeX can see it.) The first argument is the amount
18902 of indentation; in this case the negative sign moves it into the margin.
18903 The second argument is the height of the letter in number of lines of text.
18904 The third argument is the font name: virtually anything which has a tfm
18905 file should work (wade through the
18907 .../texmf/fonts/tfm
18909 directory for possibilities).
18910 My personal favorite is
18911 \begin_inset Quotes eld
18919 \begin_inset Quotes erd
18922 , a fancy German font specifically designed for dropped capitals.
18923 The fourth argument is the letter (or letters) to be dropped.
18928 package also offers the
18934 command, as well as a slightly simplified
18943 \begin_layout Section
18944 Non-standard Paragraph Shapes
18947 \begin_layout Standard
18953 \begin_layout Standard
18954 \begin_inset VSpace bigskip
18960 \begin_layout Standard
18964 \begin_layout Plain Layout
18976 \begin_layout Standard
18980 \begin_layout Plain Layout
18989 \begin_layout Plain Layout
19003 \begin_layout Standard
19008 \begin_layout Plain Layout
19019 \begin_layout Plain Layout
19028 \begin_layout Plain Layout
19037 \begin_layout Plain Layout
19046 \begin_layout Plain Layout
19055 \begin_layout Plain Layout
19064 \begin_layout Plain Layout
19073 \begin_layout Plain Layout
19082 \begin_layout Plain Layout
19091 \begin_layout Plain Layout
19100 \begin_layout Plain Layout
19109 \begin_layout Plain Layout
19118 \begin_layout Plain Layout
19127 \begin_layout Plain Layout
19136 \begin_layout Plain Layout
19145 \begin_layout Plain Layout
19154 \begin_layout Plain Layout
19163 \begin_layout Plain Layout
19172 \begin_layout Plain Layout
19181 \begin_layout Plain Layout
19187 There are times when the tyranny of rectangular paragraphs must be overthrown.
19188 In such situations, a call to the delightful plain TeX command
19195 As you can see, completely arbitrary shapes can be laid out with a suitable
19196 set of linelength definitions.
19197 While this parshape may look a bit silly and useless, one could conceive
19198 of situations such as finely tuned dropped capitals, word wrapping around
19199 non-rectangular graphics, etc.
19200 which will benefit from such handcrafting.
19203 \begin_layout Standard
19204 \begin_inset VSpace bigskip
19210 \begin_layout Standard
19215 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19222 is the number of lines of text which define the paragraph.
19223 If there turn out to be fewer lines, the shape is truncated; if there are
19224 more, the excess lines have the same dimensions as the last line of the
19234 entries specify the indentation of the line from the left margin, and the
19235 length of the line as measured from that point.
19236 The shape applies only to the current paragraph; everything is reset to
19237 normal for the next paragraph.
19240 \begin_layout Standard
19244 \begin_layout Plain Layout
19256 \begin_layout Section
19260 \begin_layout Standard
19261 As you can see, the examples in this section range from the useful to the
19263 While I don't expect that anyone will ever need the paragraph shape demonstrate
19264 d in the last section, the important point is that you can do almost anything
19265 you want in LyX if you are willing to figure out how to do it in TeX and
19267 TeX is a fantastically powerful typesetting system and all that power is
19268 available to you since LyX uses it as its backend.
projects / lyx.git / blob