1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the User's Guide prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the User's Guide may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
57 \font_typewriter default
58 \font_default_family default
68 \pdf_title "LyX's Extended manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX's extended documentation"
71 \pdf_keywords "LyX, Documentation, Extended"
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen false
75 \pdf_bookmarksopenlevel 1
80 \pdf_pagebackref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
89 \paperorientation portrait
92 \paragraph_separation indent
94 \quotes_language english
97 \paperpagestyle headings
98 \tracking_changes false
107 Extended LyX Features
115 \begin_layout Plain Layout
117 Principal maintainer of this file is
122 If you have comments or error corrections, please send them to the LyX
123 Documentation mailing list, <lyx-docs@lists.lyx.org>.
131 \begin_layout Standard
132 \begin_inset CommandInset toc
133 LatexCommand tableofcontents
140 \begin_layout Chapter
144 \begin_layout Standard
147 Extended LyX Features
149 manual, which you are now reading, is essentially Part II of the
151 User's Guide\SpecialChar \@.
154 The reason for splitting this document is simple: the
158 is already huge, and it contains all of the basic features one needs to
159 know in order to prepare most documents.
160 However, the LyX Team has a long-term goal of making LyX extensible through
161 various configuration files and external packages.
162 That means that if you want to support the Fizzwizzle LaTeX package, you
163 can create a layout file for it without having to alter LyX itself.
164 We've already had contributions of several new features this way.
165 This is the place where all of that gets documented.
168 \begin_layout Standard
169 This manual also documents some special features, like fax support, version
170 control, and SGML support, which require additional software to work properly.
171 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
172 spruce up your documents by directly using the powerful features of LaTeX.
177 only WYSIWYM, and will only ever interface to certain LaTeX features.
180 \begin_layout Standard
181 Of course, with all of this extra documentation,
183 Extended LyX Features
185 may itself grow too big for its britches.
186 In that case, you can just call it the
187 \begin_inset Quotes eld
191 \begin_inset Quotes erd
197 \begin_layout Standard
198 If you haven't read the
202 yet, you are definitely in the wrong manual.
207 is the first place to go, since it will direct you to the correct manual,
208 and it also describes the notation and format of all of the manuals.
209 You should also be thoroughly familiar with the
213 and all of the basic features of LyX.
217 \begin_layout Standard
218 In this document, many sections are independent articles contributed by
219 an individual and are noted as such.
220 This person is generally whoever wrote the layout file for the new document
221 class or LaTeX package, or implemented the feature.
222 If there is no mention of an author to a chapter [or chapter sections],
223 that means it was written by the LyX Documentation Team.
226 \begin_layout Standard
227 Since all the topics in this manual depend heavily on LyX's interaction
228 with LaTeX, this first chapter covers the inner workings of LyX and how
229 to direct LyX to generate exactly the LaTeX code you want.
230 It is obviously for more seasoned LyX users.
233 \begin_layout Chapter
237 \begin_layout Section
241 \begin_layout Standard
242 \begin_inset CommandInset label
244 name "sec:lyxandlatex"
248 This chapter is for both TeX-nicians and the LaTeX-curious.
249 In it, we'll explain how LyX and LaTeX work together to produce printable
251 This is the only place in any of the manuals where we assume you know something
255 \begin_layout Standard
256 At one time, we called LyX a
257 \begin_inset Quotes eld
260 WYSIWYM frontend to LaTeX,
261 \begin_inset Quotes erd
264 but that's no longer true.
265 There are frontends to LaTeX out there.
266 They are basically editors with the ability to run LaTeX and mark any errors
267 in the file you're editing.
276 run LaTeX, and it also marks errors in the file, it also does much, much
278 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
279 LyX has also added a few extensions to LaTeX.
280 Try the following sometime: select
282 Export\SpecialChar \menuseparator
292 menu, then look at the preamble of the resulting
297 You'll notice a variety of new macros defined specifically by LyX.
298 These macros are defined automatically, according to the features you use
302 \begin_layout Standard
303 There are several commands that automatically invoke LaTeX.
307 \begin_layout Itemize
313 iew\SpecialChar \menuseparator
323 \begin_layout Itemize
329 iew\SpecialChar \menuseparator
334 pdate\SpecialChar \menuseparator
340 \begin_layout Itemize
348 \SpecialChar \menuseparator
354 \begin_layout Itemize
362 \SpecialChar \menuseparator
368 \begin_layout Standard
369 They will only invoke LaTeX if the file has changed since the last time
374 \begin_layout Standard
375 When you run LaTeX on the file you're editing, LyX performs these steps:
378 \begin_layout Enumerate
379 Convert the document to LaTeX and save to a file with the extension
390 \begin_layout Enumerate
395 file (maybe several times).
398 \begin_layout Enumerate
399 If there are any errors, insert error boxes in the document to mark where
401 These boxes are transient and are not saved along with the document.
404 \begin_layout Standard
405 If you've run LaTeX using
433 , LyX performs two more steps:
436 \begin_layout Itemize
441 to convert the DVI file to PostScript:
445 \begin_layout Itemize
454 , the output file has the extension
459 \begin_layout Itemize
471 , the output file has the extension
479 \begin_layout Itemize
484 or send the PostScript file to the printer.
487 \begin_layout Section
488 \begin_inset Quotes eld
491 Help! LyX generated an unreadable
496 \begin_inset Quotes erd
502 \begin_layout Standard
503 Die-hard LaTeX users will scream and howl this into the night, then declare
504 LyX useless, simply because they didn't RTFM.
507 \begin_layout Standard
508 We're going to set the record straight.
509 LyX produces two kinds of LaTeX files.
510 One is human readable.
511 The other is LyX readable.
512 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
518 file is not human readable.
519 Don't even try to read it.
524 file that you can send to a colleague, select
529 xport\SpecialChar \menuseparator
546 \begin_layout Section
547 Translating LaTeX files into LyX
548 \begin_inset CommandInset label
550 name "sec:Translating-LaTeX-files"
557 \begin_layout Standard
558 You can import a LaTeX file into LyX by using the
563 ile\SpecialChar \menuseparator
568 mport\SpecialChar \menuseparator
576 This will call a program named
580 ---which will create a file
588 ---and then open that file.
591 \begin_layout Standard
596 will translate most legal LaTeX, but not everything.
597 It will leave things it doesn't understand in TeX mode, so after translating
602 , you can look for red text and hand-edit it to look right.
605 \begin_layout Standard
606 If you just want to put a piece of LaTeX code into a LyX file, see Section
611 \begin_inset CommandInset ref
613 reference "sec:latexcodes"
620 \begin_layout Section
621 Inserting LaTeX Code into LyX Documents
622 \begin_inset CommandInset label
624 name "sec:Inserting-LaTeX-Code"
631 \begin_layout Standard
632 \begin_inset CommandInset label
634 name "sec:latexcodes"
638 This is a rather important point: You can always insert LaTeX code into
640 LyX simply cannot, and will probably never be able to, display every possible
642 If ever you need to insert LaTeX commands into your LyX document, you can
643 use the ERT box, which you can insert into your document with
648 nsert\SpecialChar \menuseparator
656 The ERT box comes in three forms: collapsed, open, and inlined.
657 The first two are used just like any other collapsible (foldable) box (such
658 as footnotes), and are useful for significant amounts of LaTeX commands.
660 \begin_inset Quotes eld
664 \begin_inset Quotes erd
667 ERT box displays its content as part of the button, and is useful for very
668 short sections of LaTeX commands.
673 \begin_layout Plain Layout
683 \begin_layout Standard
684 You can switch between all three by right-clicking on the ERT.
685 Note that if you want more than one line of LaTeX commands, you cannot
686 use the inlined mode.
689 \begin_layout Standard
690 Here's an example of inserting LaTeX commands in a LyX document.
691 The code looks like this:
694 \begin_layout LyX-Code
698 \begin_inset Newline newline
704 \begin_inset Newline newline
707 This is an example for a minipage environment.
709 \begin_inset Newline newline
712 can put nearly everything in it, even (non-floating)
713 \begin_inset Newline newline
718 \begin_inset Newline newline
724 \begin_inset Newline newline
728 \begin_inset Newline newline
734 \begin_inset Newline newline
740 \begin_inset Newline newline
746 \begin_inset Newline newline
751 \begin_inset Newline newline
757 \begin_inset Newline newline
763 \begin_inset Newline newline
769 \begin_inset Newline newline
777 \begin_layout LyX-Code
781 \begin_layout Standard
782 The ERT box containing this text is directly after this paragraph.
783 Those of you reading the manual online will only see a bunch of funky text
785 Those reading a printed version of the manuals will see the actual results:
788 \begin_layout Standard
792 \begin_layout Plain Layout
799 \begin_layout Plain Layout
806 \begin_layout Plain Layout
808 This is an example for a minipage environment.
809 You can put nearly everything in it, even (non-floating) figures and tables.
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
825 \begin_layout Plain Layout
832 \begin_layout Plain Layout
839 \begin_layout Plain Layout
846 \begin_layout Plain Layout
852 \begin_layout Plain Layout
859 \begin_layout Plain Layout
866 \begin_layout Plain Layout
873 \begin_layout Plain Layout
885 \begin_layout Standard
886 In addition to these two methods, you can also create a separate file containing
887 some complex LaTeX structure.
893 nsert\SpecialChar \menuseparator
904 to include your file (you should select the type
909 We recommend that you only do this if you have a
918 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
922 \begin_layout Standard
923 There are a few last notes to emphasize:
926 \begin_layout Itemize
927 Inside of LyX, LaTeX code appears
932 \begin_layout Itemize
937 check if your LaTeX code is correct.
940 \begin_layout Itemize
941 Beware reinventing the wheel.
944 \begin_layout Standard
945 That last note refers to two things.
946 First, LyX does have quite a few features tucked into it, and more are
948 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
949 feature before you go off merrily coding LaTeX.
950 Second, there are numerous LaTeX packages out there to do all sorts of
951 things, from labels to envelopes to fancy multipage tables.
952 Check out a CTAN site for details (see Section
953 \begin_inset Quotes eld
957 \begin_inset Quotes erd
968 \begin_layout Plain Layout
973 : I seem to do this an awful lot.
974 Sat down and merrily began coding something to print out labels, only to
975 learn that there were already 2 different LaTeX packages to do this.
976 Worse yet --- I had them already!
984 \begin_layout Standard
985 If you do need to do some wild and fancy things within your document, be
986 sure to check out a good LaTeX book for assistance.
987 There are a number of them listed in the bibliography of the
994 \begin_layout Standard
995 There are a number of LaTeX commands which have to be placed before the
996 beginning of the actual text.
997 They go into the preamble, and this is explained in the next section.
1000 \begin_layout Section
1001 LyX and the LaTeX Preamble
1004 \begin_layout Subsection
1005 About the LaTeX Preamble
1008 \begin_layout Standard
1009 \begin_inset CommandInset label
1015 If you already know LaTeX, there is no need to explain here what the preamble
1017 If you don't, the following will give you some ideas --- we recommend again
1018 that you consult a LaTeX book for further information.
1019 In any case, you should read the points below, because they explain what
1020 you can do and what you don't need to do in the LaTeX preamble of a LyX
1024 \begin_layout Standard
1025 The LaTeX preamble comes at the very beginning of a document,
1033 \begin_layout Itemize
1034 declare the document class.
1035 LyX already does this for you.
1039 \begin_layout Standard
1040 If you're a seasoned LaTeX-nician, and you have some custom document class
1041 you want to use, check out the
1043 Customization Manual
1045 for information on how to make LyX interface to it.
1046 Be sure to submit your efforts to the LyX Team for inclusion in future
1051 \begin_layout Itemize
1052 declare the usage of packages.
1053 LaTeX packages provide special commands, which are only available within
1054 a document when the package has been declared in the preamble.
1055 For example, the package
1059 forces all paragraphs to be indented.
1060 There are other packages for labels, envelopes, margins, etc.
1064 \begin_layout Itemize
1065 set counters, variables, lengths and widths.
1066 There are several LaTeX counters and variables which
1070 be set globally from within the preamble in order to have the desired effect.
1071 [There are other variables which you can set and reset inside the document,
1072 too.] Margins are a good example of something which must be set in the preamble.
1073 Another example is the label format for lists.
1074 You can actually set these just about anywhere, but it's best to do it
1075 just once, inside the preamble.
1078 \begin_layout Itemize
1079 declare user defined commands [with
1091 ], mostly abbreviations for LaTeX commands which appear very often inside
1093 Although the preamble is a good place to declare such commands, they
1097 be declared anywhere else [but
1101 they are used for the first time, of course\SpecialChar \ldots{}
1103 This can be useful if there is a lot of raw LaTeX code in your document,
1104 which normally should not be the case.
1107 \begin_layout Standard
1108 LyX adds its own set of definitions to the preamble of the
1113 This makes LaTeX files generated by LyX portable.
1116 \begin_layout Subsection
1117 Changing the Preamble
1120 \begin_layout Standard
1121 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1122 can't change them without patching LyX itself.
1123 You can, however, add your own stuff to the preamble.
1124 There are two ways to do this:
1127 \begin_layout Enumerate
1134 \begin_inset space ~
1157 \SpecialChar \menuseparator
1165 dialog, depending on your frontend.
1166 Note that the LyX keybindings will not work in this dialog, alas.
1169 \begin_layout Enumerate
1170 Use the preamble contents you've added as your default template (see
1171 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1182 ), so that it will be the default preamble for any file you create.
1185 \begin_layout Standard
1186 LyX adds anything in the
1193 dialog to its own built-in preamble.
1194 Before adding your own declarations in the preamble, you should make sure
1195 that LyX doesn't already support what you want to do (remember what we
1196 said about reinventing the wheel?).
1199 make sure your preamble code is correct
1202 LyX doesn't check it.
1205 \begin_layout Subsection
1209 \begin_layout Standard
1210 Here are some examples of what you can add to a preamble, and what they
1214 \begin_layout Subsubsection
1218 \begin_layout Standard
1219 There are two variables under LaTeX that control page position:
1232 Their names should be self-explanatory.
1233 These variables are useful if you think for a moment about computer labels.
1234 Sometimes, the size of a print medium and the area of the medium that you
1235 can actually print on aren't the same.
1251 \begin_layout Standard
1252 The default values for
1265 \begin_inset space ~
1269 \begin_inset space ~
1273 \begin_inset space ~
1276 the page isn't shifted.
1279 \begin_layout Standard
1280 Unfortunately, some DVI drivers always seem to shift the page.
1281 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1282 If you're using LyX on a system that you don't personally maintain, and
1283 your sysadmin is a doofus,
1296 Suppose you're left and top margins are always 0.5 inches too big.
1297 You can add this to the preamble:
1300 \begin_layout LyX-Code
1308 \begin_layout LyX-Code
1316 \begin_layout Standard
1317 \SpecialChar \ldots{}
1318 and your margins should now be correct.
1321 \begin_layout Subsubsection
1325 \begin_layout Standard
1326 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1327 There's a rather nice package, available at your nearest CTAN archive,
1328 for printing sheets of labels, called
1333 Now, your system may not have this package installed by default.
1334 We leave that up to you to check.
1335 You'll also want to read the documentation for it; we're not going to do
1337 Since this is an example, however, we'll give you an example of how you
1341 \begin_layout Standard
1342 First, make sure you're using the
1347 Next, you need to put the following in your preamble:
1350 \begin_layout LyX-Code
1356 \begin_layout LyX-Code
1362 \begin_layout LyX-Code
1368 \begin_layout LyX-Code
1374 \begin_layout LyX-Code
1380 \begin_layout LyX-Code
1386 \begin_layout LyX-Code
1392 \begin_layout Standard
1393 This sets things up for Avery® label sheets, stock #5360.
1394 You're now ready to print labels, but you'll need to insert LaTeX code,
1395 placing the commands
1407 around each label text.
1408 This and other special features of
1412 are explained in its documentation.
1415 \begin_layout Standard
1416 Someday, someone may write a LyX layout file to support this package directly.
1417 Maybe that someone is you.
1420 \begin_layout Subsubsection
1421 Example #3: Paragraph Indentation
1424 \begin_layout Standard
1425 Americans are trained to indent the first line of
1430 As with all of their other weird quirks, most Americans will whine and
1431 moan until they can have their way and indent the first line of all paragraphs.
1435 \begin_layout Plain Layout
1440 : This was written by an American ---
1444 ! It's my perception of my fellow countrymen.
1445 Tough if you don't like it.
1454 \begin_layout Standard
1455 Of course, this behavior isn't standard typography.
1456 In books, you typically only indent the first line of a paragraph
1460 it follows another one.
1461 The idea behind indenting the first line of a paragraph is to distinguish
1462 neighboring paragraphs from one another.
1463 If there is no previous paragraph, for example, it follows a figure, or
1464 is the first paragraph in a section, then there is no special indentation.
1468 \begin_layout Standard
1469 If you're a typical American, though, you don't care about such esoteric
1470 things; you want your indentation! Add this to the preamble:
1473 \begin_layout LyX-Code
1476 usepackage{indentfirst}
1479 \begin_layout Standard
1480 If your TeX distribution isn't a braindead one, you'll have this package,
1481 and all of your paragraphs will get the indentation you think they deserve.
1484 \begin_layout Subsubsection
1485 Example #4: This Document
1488 \begin_layout Standard
1489 You can also check out the preamble of this document to get an idea of some
1490 of the advanced things you can do.
1491 You'll probably need to make the
1496 reamble\SpecialChar \ldots{}
1499 dialog full-screen to see most of it.
1500 Also, there are more examples and an assortment of LaTeX
1501 \begin_inset Quotes eld
1505 \begin_inset Quotes erd
1509 \begin_inset space ~
1513 \begin_inset CommandInset ref
1515 reference "cha:secrets"
1523 \begin_layout Section
1524 LyX and LaTeX Errors
1527 \begin_layout Standard
1528 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1530 It then uses the log-file from the LaTeX run to do a post-mortem.
1531 As we stated earlier in the chapter, LyX generates two kinds of
1535 files, one of which it uses to locate errors in the document.
1536 If there was an error someplace, LyX will put a box with the word
1537 \begin_inset Quotes eld
1541 \begin_inset Quotes erd
1544 at the appropriate place in the document.
1548 \begin_layout Plain Layout
1549 LyX will occasionally misguess where the error was.
1550 This will typically happen with tables, figures, math, and the preamble.
1555 It will also display a message alerting you to the fact that there were
1559 \begin_layout Standard
1560 You can navigate through the errors by using
1576 \begin_inset Quotes eld
1580 \begin_inset Quotes erd
1583 the error-boxes and view the error message LaTeX produced by clicking on
1587 \begin_layout Standard
1588 Some folks also like to look at the log file directly, accessible from
1593 ocument\SpecialChar \menuseparator
1599 \begin_inset space ~
1603 \begin_inset space ~
1609 There are some fairly common error messages and warnings.
1610 We'll cover those here.
1611 You should look at a good LaTeX book for a complete listing.
1614 \begin_layout Itemize
1615 \begin_inset Quotes eld
1623 \begin_inset Quotes eld
1630 \begin_layout Standard
1631 Anything beginning with these word is a warning message for the purpose
1633 \begin_inset Quotes eld
1637 \begin_inset Quotes erd
1640 the LaTeX code itself.
1641 You'll get messages like this if you added or changed cross-references
1642 or bibliography entries, in which case, LaTeX is trying to tell you that
1643 you need to make another run.
1646 \begin_layout Standard
1647 You can by-and-large ignore these.
1651 \begin_layout Itemize
1652 \begin_inset Quotes eld
1660 \begin_inset Quotes erd
1667 \begin_layout Standard
1668 Another warning message, this time about fonts which LaTeX couldn't find.
1669 The rest of the message will often say something about a replacement font
1673 \begin_layout Standard
1674 You can safely ignore these.
1678 \begin_layout Itemize
1679 \begin_inset Quotes eld
1689 \begin_inset Quotes erd
1696 \begin_layout Standard
1702 They are warning you about lines that were too long and run past the right
1704 Almost always, this is unnoticeable in the final output.
1705 Or, only one or two characters extend past the margin.
1706 LaTeX seems to generate at least one of these messages for just about any
1710 \begin_layout Standard
1711 You can ignore these stupid messages.
1712 Your eyes will tell you if there's a problem with something that's too
1713 wide; just look at the output.
1717 \begin_layout Itemize
1718 \begin_inset Quotes eld
1728 \begin_inset Quotes erd
1735 \begin_layout Standard
1736 Not quite as common as its cousin.
1737 LaTeX seems to like to print lines that are a bit too wide as opposed to
1738 ones that are a bit too narrow.
1739 We have no idea why.
1742 \begin_layout Standard
1743 You can ignore these, too.
1747 \begin_layout Itemize
1748 \begin_inset Quotes eld
1758 \begin_inset Quotes erd
1762 \begin_inset Quotes eld
1772 \begin_inset Quotes erd
1779 \begin_layout Standard
1780 Warnings about troubles breaking the page.
1781 Once again, just look at the output.
1782 Your eyes will tell you where something has gone wrong.
1786 \begin_layout Itemize
1787 \begin_inset Quotes eld
1793 \begin_inset Quotes els
1797 \begin_inset Quotes ers
1803 \begin_inset Quotes erd
1810 \begin_layout Standard
1812 \begin_inset Quotes eld
1816 \begin_inset Quotes erd
1819 isn't installed on this system.
1820 This usually appears because some package your document needs isn't installed.
1821 If you didn't touch the preamble or didn't use the
1827 command, then one of the packages LyX tried to load is missing.
1833 elp\SpecialChar \menuseparator
1840 , to get a list of packages that LyX knows about.
1841 This file is updated whenever you reconfigure LyX (using
1848 \SpecialChar \menuseparator
1853 ) and tells you which packages have been detected and what they do.
1856 \begin_layout Standard
1867 command, and the package in question isn't installed, you'll need to install
1872 \begin_layout Itemize
1873 \begin_inset Quotes eld
1878 LaTeX Error: Unknown option
1881 \begin_inset Quotes erd
1888 \begin_layout Standard
1889 Error messages beginning with this are trying to tell you that you specified
1890 a bad or undefined option to a package.
1891 Check the package's documentation.
1895 \begin_layout Itemize
1896 \begin_inset Quotes eld
1901 Undefined control sequence
1904 \begin_inset Quotes erd
1911 \begin_layout Standard
1912 If you've inserted LaTeX code into your document, but made a typo, you'll
1914 You may have forgotten to load a package.
1915 In any case, this error message usually means that you used an undefined
1920 \begin_layout Standard
1921 There are other error and warning messages.
1922 Some are self-explanatory.
1923 These are usually LaTeX messages.
1924 Others are downright cryptic.
1925 These are actually TeX error messages, and we really have
1929 what they mean or how to decipher them.
1932 \begin_layout Standard
1933 There's a general sequence you should follow if you get error messages:
1936 \begin_layout Enumerate
1937 Look at the LaTeX code you inserted for typos.
1940 \begin_layout Enumerate
1941 If there are no typos, check and see that you used the command(s) correctly.
1944 \begin_layout Enumerate
1945 If you get a bunch of error boxes piled up at the very top of the document,
1946 it means that there are errors in the preamble.
1947 Start debugging your preamble.
1950 \begin_layout Enumerate
1951 If you didn't add anything to the preamble and didn't add any LaTeX code
1952 to the document, the first suspect is your LaTeX distribution itself.
1953 Check for missing packages and install them.
1956 \begin_layout Enumerate
1957 Okay, so there are no missing packages.
1958 Did you use any of the fine-tuning options in LyX? Specifically, did you
1963 any of them, like trying to manually insert lots of
1966 \begin_inset space ~
1979 s? Did you try to kludge something together with these instead of using
1980 the appropriate paragraph environment?
1983 \begin_layout Enumerate
1984 All right, you didn't use any of the fine-tuning options, you played by
1986 Did you try to pull a fancy maneuver? Did you do something funky inside
1987 a table or an equation, like inserting a graphic into a table cell?
1990 \begin_layout Enumerate
1991 Do you have long sections of text where LaTeX cannot find a place to break
1992 a line? By default, LaTeX is rather strict about how much extra inter-word
1993 spacing it will add in order to break a line.
1994 Preferably, you should rework the paragraph to avoid the problem.
1995 If this isn't an option, you can wrap your text in
2001 to make LaTeX's line breaking more, well, sloppy.
2004 \begin_layout Enumerate
2005 Did you go overboard with the nesting? LyX (currently) doesn't check to
2006 make sure you're in the limits for nesting environments.
2007 If you nested a bunch of environments to the
2008 \begin_inset Formula $17^{\mathrm{th}}$
2011 level, that's the problem.
2014 \begin_layout Enumerate
2015 Okay, you didn't get any error messages, but your output looks whacked.
2016 If you have a table or figure that's too wide or long for the page, you
2021 \begin_layout Enumerate
2022 rescale the figure so it fits.
2025 \begin_layout Enumerate
2026 trim down the table so it fits.
2029 \begin_layout Standard
2030 If something else is wrong with the output, and you didn't try to pull anything
2031 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2035 \begin_layout Standard
2036 If all this doesn't help --- well, then
2040 you might have found a bug in LyX\SpecialChar \ldots{}
2044 \begin_layout Chapter
2048 \begin_layout Section
2049 Preparing a Bibliography with BibTeX
2052 \begin_layout Standard
2053 Tha basics how to use BibTeX are explained in section
2055 Bibliography databases (BibTeX)
2062 The following subsections explains special bibliography features supported
2066 \begin_layout Subsection
2067 Alternative Citation Styles
2070 \begin_layout Standard
2071 Standard BibTeX uses numbers (e.
2072 \begin_inset space \thinspace{}
2076 \begin_inset space \space{}
2080 \begin_inset Quotes eld
2084 \begin_inset Quotes erd
2087 ) to refer to a cited work.
2088 However, in many scientific disciplines, other citation styles are in use.
2089 The most common one is the author-year style (e.
2090 \begin_inset space \thinspace{}
2094 \begin_inset space \space{}
2098 \begin_inset Quotes eld
2102 \begin_inset Quotes erd
2106 LyX supports two packages that provide this style,
2115 Both packages have their own pros and cons, which cannot be listed in detail.
2116 If you only want to have simple author-year (or author-numerical) style
2117 or if you want to use one of the countless style files for natbib, than
2122 package is probably your choice.
2123 If you need special features like short title references, ibidem etc., you
2124 might consider the fairly new
2131 \begin_layout Standard
2132 The handling of both packages in LyX is basically the same.
2135 Document\SpecialChar \menuseparator
2151 With both packages, you will get some extra features in the citation dialog
2152 and you can select the style of the reference (
2153 \begin_inset Quotes eld
2157 \begin_inset Quotes erd
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2169 \begin_inset Quotes eld
2173 \begin_inset Quotes erd
2177 \begin_inset Quotes eld
2181 \begin_inset Quotes erd
2185 Note that both packages need specifically designed style files (they both
2186 ship their own, while there are lots of additional style files and even
2187 an interactive style file builder
2191 \begin_layout Plain Layout
2193 \begin_inset Flex URL
2196 \begin_layout Plain Layout
2198 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2215 \begin_layout Subsection
2216 Sectionated Bibliographies
2219 \begin_layout Standard
2220 Sometimes you might need to divide your bibliography into several sections.
2221 If you are for instance a historian, the possibility to separate sources
2222 and scientific works is most likely a
2223 \begin_inset Quotes eld
2227 \begin_inset Quotes erd
2231 Unfortunately, BibTeX itself does not allow you to do this.
2232 But with the help of some LaTeX packages, BibTeX can be extended to fit
2236 \begin_layout Standard
2237 LyX provides native support for one of these packages,
2245 \begin_layout Plain Layout
2247 \begin_inset Flex URL
2250 \begin_layout Plain Layout
2252 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2262 The advantage of this package (compared to other packages like
2266 ) is that you don't need to define new citation commands.
2267 Instead, you need to prepare different bibliographic databases which include
2268 the entries for the different sections of the bibliography.
2269 For example: If you want to divide your bibliography into the sections
2271 \begin_inset Quotes eld
2275 \begin_inset Quotes erd
2279 \begin_inset Quotes eld
2283 \begin_inset Quotes erd
2286 , you first need to create two bibliographic databases, e.
2287 \begin_inset space \thinspace{}
2291 \begin_inset space \space{}
2306 \begin_layout Standard
2309 Document\SpecialChar \menuseparator
2319 \begin_inset space ~
2325 Now you can insert multiple BibTeX bibliographies, one for each section
2326 of your bibliography.
2327 Returning to our example: Insert the BibTeX bibliography
2331 and a second one for the database
2336 You are free to use the same or different styles for each section.
2337 Additionally, you can chose if the bibliography section should contain
2339 \begin_inset Quotes eld
2342 all cited references
2343 \begin_inset Quotes erd
2346 of the specified database(s) (which is the default),
2347 \begin_inset Quotes eld
2350 all uncited references
2351 \begin_inset Quotes erd
2355 \begin_inset Quotes eld
2359 \begin_inset Quotes erd
2363 This might be useful if you would like to separate your bibliography into
2365 \begin_inset Quotes eld
2369 \begin_inset Quotes erd
2373 \begin_inset Quotes eld
2377 \begin_inset Quotes erd
2381 \begin_inset Quotes eld
2385 \begin_inset Quotes erd
2389 The titles for the sections can be added as ordinary sections or subsections.
2394 removes the bibliography title, you have manually re-add that, too (as
2395 a chapter* or section*, for instance).
2398 \begin_layout Subsection
2399 Multiple Bibliographies
2402 \begin_layout Standard
2403 Multiple bibliographies, e.
2404 \begin_inset space \thinspace{}
2408 \begin_inset space \space{}
2411 a bibliography for each section or chapter of the document, are not supported
2417 package, which is used for the creation of sectionated bibliographies in
2418 LyX (see the previous section), provides an easy way to solve this task,
2419 if you are willing to use some LaTeX-Code (ERT, cf.
2420 \begin_inset space ~
2424 \begin_inset space ~
2428 \begin_inset CommandInset ref
2430 reference "sec:Inserting-LaTeX-Code"
2438 \begin_layout Plain Layout
2439 An alternative approach is to use the
2447 package, respectively.
2455 \begin_layout Standard
2458 Document\SpecialChar \menuseparator
2468 \begin_inset space ~
2474 In the document, you have to enclose the sections, which shall contain
2475 their own bibliography (including the BibTeX bibliography itself), between
2488 (those commands have to be inserted as ERT).
2489 The bibliography will contain all references which have been cited in the
2495 If you are using this approach, then
2499 citation reference has to be inside some btUnit.
2500 Also, the btUnits cannot be nested.
2503 \begin_layout Standard
2507 \begin_layout Section
2511 \begin_layout Subsection
2515 \begin_layout Standard
2516 When you are working on a large file with many sections, it is often convenient
2517 to break up the document into several files, or perhaps you have something
2518 where a table may change from time to time, but the preceding text does
2520 In these cases, you should seriously consider using multipart documents.
2521 For example, scientific papers often have five major sections: the introduction
2522 , observations, results, discussion, and conclusion.
2523 Each of these could be its own separate LyX file, with one
2524 \begin_inset Quotes eld
2528 \begin_inset Quotes erd
2531 file which contains the title, authors, abstract, references, etc., plus
2532 the five included files.
2533 It is important to note that each of these files is a full LyX file which
2534 can be formatted and printed on its own, as well as included in a master
2536 Each of these files must have the same document class, however--- don't
2537 attempt to mix book classes with article classes.
2538 You may also include LaTeX files; however, these files must not have their
2544 everything up to and including the
2556 line must be deleted) or else errors will be generated when you try to
2560 \begin_layout Standard
2561 LyX allows you to include files quite easily with
2563 Insert\SpecialChar \menuseparator
2565 \begin_inset space ~
2571 When you click on this selection a small box is inserted into the file
2572 at the current cursor location.
2573 Clicking on the box raises a dialog which allows you to select the file
2574 to be included, and the method of its inclusion.
2578 \begin_layout Standard
2579 The file selection box should by now be obvious.
2580 The three inclusion methods are
2581 \begin_inset Quotes eld
2585 \begin_inset Quotes erd
2589 \begin_inset Quotes eld
2593 \begin_inset Quotes erd
2597 \begin_inset Quotes eld
2601 \begin_inset Quotes erd
2605 The difference between
2606 \begin_inset Quotes eld
2610 \begin_inset Quotes erd
2614 \begin_inset Quotes eld
2618 \begin_inset Quotes erd
2621 is really only meaningful to LaTeXperts, but the practical difference is
2622 that files which are
2623 \begin_inset Quotes eld
2627 \begin_inset Quotes erd
2630 are typeset beginning on a new page, while files which are
2631 \begin_inset Quotes eld
2635 \begin_inset Quotes erd
2638 are typeset starting on the current page.
2639 Perhaps the labeling in LyX will be changed someday to reflect this.
2642 \begin_layout Standard
2643 Generally, the master file is converted into a full LaTeX file before typesettin
2644 g, while the included files are converted to LaTeX files which do not have
2645 all the preamble information.
2651 \begin_inset space ~
2658 button prevents this conversion.
2661 \begin_layout Standard
2663 \begin_inset Quotes eld
2667 \begin_inset Quotes erd
2670 included file allows you to include a file typeset exactly as it appears
2672 \begin_inset space ~
2675 verbatim mode, with the characters set in a fixed-width typewriter font.
2676 Normally, spaces in this file are invisible, though two consecutive spaces
2677 are conserved, unlike LyX's normal treatment of spaces.
2678 However, setting the
2681 \begin_inset space ~
2685 \begin_inset space ~
2689 \begin_inset space ~
2694 checkbox typesets a mark to unambiguously define the presence of a space.
2698 \begin_layout Subsection
2699 Cross-References Between Files
2702 \begin_layout Standard
2703 It is possible to set up cross-references between the different files.
2704 First, open all the files in question: let's call them A and B in a two
2705 file example, where B is included in A.
2706 Let's say you insert a label in A, then want to reference it in B.
2707 Open the cross-reference dialog in whilst in document B, and you can select
2709 \begin_inset Quotes eld
2713 \begin_inset Quotes erd
2719 \begin_layout Subsection
2720 Bibliography Lists in all Subdocuments
2723 \begin_layout Standard
2724 Copy the bibliography list with all entries to all subdocuments and transform
2726 This way LyX will find the
2730 -files and you can easily insert references without making the bibliography
2734 \begin_layout Standard
2735 As the bibliography list is in a comment, LaTeX won't use use it and the
2736 references will look like this [?] instead of [1].
2737 A solution is to use the LaTeX-package
2741 that will only include comments by processing the files separately.
2742 To do this, add in the LaTeX preamble of every subdocument the following:
2745 \begin_layout LyX-Code
2751 \begin_layout LyX-Code
2754 includecomment{comment}
2757 \begin_layout Standard
2759 \begin_inset Flex URL
2762 \begin_layout Plain Layout
2764 http://wiki.lyx.org/FAQ/Unsorted#toc31
2772 \begin_layout Section
2773 Fancy Headers and Footers
2776 \begin_layout Standard
2777 The default page layout is rather plain; for an article document class,
2778 all you get is a centered page number at the bottom of the page.
2779 This document is the book class, so it appears to be a bit fancier, but
2780 to really put on a show, you need to set the document page style to
2781 \begin_inset Quotes eld
2785 \begin_inset Quotes erd
2788 , as mentioned in the
2791 \begin_inset space ~
2797 This section describes the LaTeX codes you need to insert in your LaTeX
2798 preamble or the text in order to get the desired effects.
2801 \begin_layout Standard
2802 The page header is divided into three fields, not surprisingly labeled
2803 \begin_inset Quotes eld
2807 \begin_inset Quotes erd
2811 \begin_inset Quotes eld
2815 \begin_inset Quotes erd
2819 \begin_inset Quotes eld
2823 \begin_inset Quotes erd
2827 The footer is also divided into these three fields.
2828 The LaTeX commands to set these fields in the simplest manner are
2853 Suppose you wish to put your name in the upper left hand corner of each
2855 Simply insert the following command in the preamble:
2858 \begin_layout Standard
2867 \begin_layout Standard
2868 You will now see your name in the upper left.
2869 If a field has a default entry that you would like to get rid of (often
2870 the page number appears in the central footer, simply include a command
2871 with a blank argument, e.
2872 \begin_inset space \thinspace{}
2878 \begin_layout Standard
2886 \begin_layout Standard
2887 Let's get really fancy: lets put the section number with the word
2888 \begin_inset Quotes eld
2892 \begin_inset Quotes erd
2896 \begin_inset space \thinspace{}
2900 \begin_inset space ~
2903 Section 3) in the upper left, the page number (e.
2904 \begin_inset space \thinspace{}
2908 \begin_inset space ~
2911 Page 4) in the upper right, your name in the lower left, and the date in
2913 The following commands should now appear in the preamble:
2916 \begin_layout Standard
2926 \begin_layout Standard
2934 \begin_layout Standard
2944 \begin_layout Standard
2953 \begin_layout Standard
2961 \begin_layout Standard
2971 \begin_layout Standard
2984 access LaTeX's section and page counters, and so print out the current
2985 section and page numbers.
2992 simply prints out today's date.
2995 \begin_layout Standard
2996 The thicknesses of the horizontal rules drawn beneath the header and above
2997 the footer can also be modified.
2998 If you don't want one of the headers, set its thickness to 0.
2999 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3000 Use the commands, e.
3001 \begin_inset space \thinspace{}
3011 headrulewidth}{0.4pt}
3019 footrulewidth}{0.4pt}
3021 to set the thicknesses.
3024 \begin_layout Standard
3025 You can switch the header/footer settings on and off for individual pages
3030 thispagestyle{empty}
3036 thispagestyle{plain}
3042 thispagestyle{fancy}
3045 Simply insert them in the text on the page you want changed and mark them
3047 In fact, title pages are marked as plain by default, while following pages
3048 are marked fancy when using the global fancy setting.
3051 \begin_layout Standard
3052 There are more complex commands which will let you insert things in the
3053 upper left on odd numbered pages, etc., but I will refer you to the
3057 package documentation for more descriptions.
3058 For example, if you have a teTeX installation, look for
3060 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3066 \begin_layout Standard
3067 As a final example, it is possible to include an Encapsulated PostScript
3068 file in the header or footer.
3069 Suppose you want to put a company logo in the upper lefthand corner.
3070 You might try something like
3073 \begin_layout Standard
3082 includegraphics{logo.eps}}}
3085 \begin_layout Standard
3087 (you may need to preface this with
3091 usepackage{graphics}
3093 if you don't include EPS files elsewhere in your document).
3096 \begin_layout Section
3097 Itemize Bullet Selection
3098 \begin_inset CommandInset label
3107 \begin_layout Standard
3113 \begin_layout Subsection
3117 \begin_layout Standard
3118 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3119 Using this dialog you can easily specify what bullet shape to use at each
3120 level of an itemized list.
3121 These settings are document-wide so you won't be able to specify different
3122 sets of bullets for different paragraphs
3126 \begin_layout Plain Layout
3127 Well, actually you can but you'll have to do it by hand.
3135 \begin_layout Subsection
3139 \begin_layout Standard
3140 Open the dialog by selecting the
3145 ocument\SpecialChar \menuseparator
3152 menu item and then select the
3162 \begin_layout Standard
3163 The dialog provides you with a table of bullet shapes.
3164 A column of buttons on the left of the table provides access to the six
3165 different panels of bullet shapes.
3166 The row of buttons across the top is used to select which bullet depth
3168 A text entry under the table shows the currently selected bullet shape's
3169 LaTeX equivalent and this can be edited if desired.
3170 If you do modify the text you will also need to specify any needed packages
3171 in the LaTeX preamble.
3174 \begin_layout Standard
3175 The six panels are divided up by the packages they require.
3176 The following table shows the mappings from button name to LaTeX packages.
3179 \begin_layout Standard
3181 \begin_inset Tabular
3182 <lyxtabular version="3" rows="7" columns="2">
3184 <column alignment="center" valignment="top" width="0pt">
3185 <column alignment="center" valignment="top" width="0pt">
3187 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3190 \begin_layout Plain Layout
3205 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3208 \begin_layout Plain Layout
3225 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3228 \begin_layout Plain Layout
3243 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3246 \begin_layout Plain Layout
3262 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3265 \begin_layout Plain Layout
3280 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3283 \begin_layout Plain Layout
3300 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3303 \begin_layout Plain Layout
3318 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3321 \begin_layout Plain Layout
3338 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3341 \begin_layout Plain Layout
3356 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3359 \begin_layout Plain Layout
3376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3379 \begin_layout Plain Layout
3394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3397 \begin_layout Plain Layout
3414 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3417 \begin_layout Plain Layout
3432 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3435 \begin_layout Plain Layout
3458 \begin_layout Standard
3459 LyX doesn't stop you using bullets from packages you don't have.
3460 If you get errors from LaTeX when you try to view or print the file then
3461 its likely you are missing a package.
3462 LyX doesn't restrict your use since you may be editing locally and exporting
3466 \begin_layout Subsection
3470 \begin_layout Standard
3471 Select which bullet depth you want to change then select the bullet shape
3473 Any changes will not be visible in LyX, but are visible when viewing the
3474 document using xdvi or ghostview.
3477 \begin_layout Standard
3478 You can reset a bullet shape to the default simply by clicking your right
3479 mouse button on the appropriate bullet depth button.
3482 \begin_layout Standard
3487 want to have multiple sets of paragraphs with different sets of bullets
3488 in each then you're going to have to get your hands dirty.
3489 The itemize bullet selection dialog can help though because it provides
3490 you with the LaTeX code for a wide range of bullet shapes.
3491 To make your own custom paragraphs you have the following options:
3494 \begin_layout Standard
3498 \begin_layout Plain Layout
3514 \begin_layout Standard
3518 \begin_layout Plain Layout
3540 \begin_layout Itemize
3541 Use the LaTeX command
3547 to specify a new bullet shape for a given depth.
3548 You'll also need to save the current bullet shape so you can restore it
3550 In this itemized list the following LaTeX code was used to change the bullet
3551 used for the first depth.
3552 \begin_inset Newline newline
3568 \begin_inset Newline newline
3584 \begin_inset Newline newline
3589 Note that the itemize depth is specified in Roman numerals as part of the
3599 \begin_layout Itemize
3603 \begin_layout Plain Layout
3616 Specify each individual entry by starting each item with the bullet shape
3617 enclosed in square brackets and set as TeX.
3618 For example, this item was started with
3631 \begin_layout Standard
3635 \begin_layout Plain Layout
3651 \begin_layout Standard
3652 You'll also need to revert the labelitem back to its previous setting for
3653 the global bullet shape settings to remain in effect.
3654 The way used here was:
3655 \begin_inset Newline newline
3669 \begin_layout Chapter
3670 Special Document Classes
3673 \begin_layout Section
3674 \begin_inset CommandInset label
3676 name "sec:AMS-LaTeX"
3683 \begin_layout Standard
3686 David Johnson; updated by Richard Heck
3689 \begin_layout Standard
3690 \begin_inset VSpace bigskip
3696 \begin_layout Standard
3698 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3699 papers to be submitted to American Mathematical Society publications.
3700 The layouts are not tailored to a specific journal, but easily can be.
3701 You should refer to the AMS documentation for specific instructions for
3702 each journal (usually it will entail only changing a single line in the
3704 That documentation is available on the Web at
3705 \begin_inset Flex URL
3708 \begin_layout Plain Layout
3716 \begin_inset Flex URL
3719 \begin_layout Plain Layout
3721 ftp://ftp.ams.org/pub/tex/amslatex/
3727 These layouts are appropriate, and useful, for any mathematical writing.
3731 \begin_layout Standard
3732 There are two basic AMS LaTeX layouts:
3735 \begin_layout Enumerate
3736 amsart: The standard AMS article format.
3739 \begin_layout Enumerate
3740 amsbook: the standard AMS book (really, monograph) format.
3744 \begin_layout Standard
3745 These layouts themselves contain only the minimum necessary to use the AMS
3747 They do not, in particular, contain any of the `theorem' environments used
3748 for setting theorems, lemmas, and the like.
3749 These are contained, instead, in the
3750 \begin_inset Flex CharStyle:Code
3753 \begin_layout Plain Layout
3759 module, which you will need to load separately when you selected one of
3761 Less commonly used environments are in the
3762 \begin_inset Flex CharStyle:Code
3765 \begin_layout Plain Layout
3766 Theorems (AMS-Extended)
3775 \begin_layout Standard
3776 By default, theorems and the like are numbered consecutively throughout
3777 the document, but this may be modified by loading the module
3778 \begin_inset Flex CharStyle:Code
3781 \begin_layout Plain Layout
3782 Theorems (Order by Section)
3787 or, if you are using
3788 \begin_inset Flex CharStyle:Code
3791 \begin_layout Plain Layout
3798 \begin_inset Flex CharStyle:Code
3801 \begin_layout Plain Layout
3802 Theorems (Order by Chapter)
3808 These will number the results as
3809 \begin_inset Formula $n.m$
3812 , where the first number refers to the section (or chapter) and the second
3813 refers to the total number of results so far in that section (or chapter).
3814 Many environments are also available unnumbered.
3815 These are indicated by an asterisk at the end.
3816 If you happen to want
3820 unnumbered results, the the module
3821 \begin_inset Flex CharStyle:Code
3824 \begin_layout Plain Layout
3830 provides that option.
3833 \begin_layout Standard
3834 Note that these modules do not
3838 to be used with the AMS classes.
3839 It is perfectly possible to use the
3840 \begin_inset Flex CharStyle:Code
3843 \begin_layout Plain Layout
3849 module, and the others mentioned, with other classes, such as
3850 \begin_inset Flex CharStyle:Code
3853 \begin_layout Plain Layout
3860 \begin_inset Flex CharStyle:Code
3863 \begin_layout Plain Layout
3870 \begin_inset Flex CharStyle:Code
3873 \begin_layout Plain Layout
3882 \begin_layout Subsection
3883 What these layouts provide
3886 \begin_layout Standard
3887 There is a long list of included environments provided by these layouts.
3888 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3889 variety of `theorem' environments.
3890 However, the AMS recommends the environments that are available in LyX.
3894 \begin_layout Standard
3895 The following environments---as well as the standard environments, such
3897 \begin_inset Flex CharStyle:Noun
3900 \begin_layout Plain Layout
3907 \begin_inset Flex CharStyle:Noun
3910 \begin_layout Plain Layout
3917 \begin_inset Flex CharStyle:Noun
3920 \begin_layout Plain Layout
3927 \begin_inset Flex CharStyle:Noun
3930 \begin_layout Plain Layout
3937 \begin_inset Flex CharStyle:Noun
3940 \begin_layout Plain Layout
3947 \begin_inset Flex CharStyle:Code
3950 \begin_layout Plain Layout
3957 \begin_inset Flex CharStyle:Code
3960 \begin_layout Plain Layout
3969 \begin_layout Description
3970 Address This should be the author's permanent address.
3973 \begin_layout Description
3975 \begin_inset space ~
3978 Address This should be the author's temporary address at the time of submission,
3979 if different from the Address.
3982 \begin_layout Description
3983 Email Author's e-mail address
3986 \begin_layout Description
3987 URL Author's Web address, if desired.
3990 \begin_layout Description
3991 Keywords Key words or phrases used to identify specific topics discussed
3995 \begin_layout Description
3996 Subjectclass These refer to the AMS Subject Classifications, published and
3999 Mathematical Reviews
4002 These are also available online at the AMS cites listed above.
4005 \begin_layout Description
4009 \begin_layout Description
4013 \begin_layout Description
4017 \begin_layout Standard
4018 The following environments are provided by both the
4019 \begin_inset Flex CharStyle:Code
4022 \begin_layout Plain Layout
4029 \begin_inset Flex CharStyle:Code
4032 \begin_layout Plain Layout
4038 modules, in the latter case in both starred (unnumbered) and unstarred
4039 (numbered) versions.
4040 These same environments are provided only in the starred versions by the
4042 \begin_inset Flex CharStyle:Code
4045 \begin_layout Plain Layout
4054 \begin_layout Theorem
4055 This is typically used for the statements of major results.
4059 \begin_layout Corollary*
4060 This is used for statements which follow fairly directly from previous statement
4062 Again, these can be major results.
4067 These are smaller results needed to prove other statements.
4070 \begin_layout Proposition
4071 These are less major results which (hopefully) add to the general theory
4075 \begin_layout Conjecture
4076 These are statements provided without justification, which the author does
4077 not know how to prove, but which seem to be true (to the author, at least).
4080 \begin_layout Definition*
4081 Guess what this is for.
4082 The font is different for this environment than for the previous ones.
4086 \begin_layout Example*
4087 Used for examples illustrating proven results.
4090 \begin_layout Problem
4091 It's not really known what this is for.
4092 You should figure it out.
4095 \begin_layout Exercise*
4096 Write a description for this one.
4099 \begin_layout Remark
4100 This environment is also a type of theorem, usually a lesser sort of observation.
4103 \begin_layout Claim*
4104 Often used in the course of giving a proof of a larger result.
4108 Generally, these are used to break up long arguments, using specific instances
4114 The numbering scheme for cases is on its own, not together with other numbered
4120 At the end of this environment , a QED symbol (usually a square, but it
4121 can vary with different styles) is placed.
4122 If you want to have other environments within this one---for example, Case
4123 environments---and have the QED symbol appear only after them, then the
4124 other environments need to be nested within the proof environment.
4127 Nesting Environments
4133 for information on nesting.
4136 \begin_layout Standard
4137 And these are provided by
4138 \begin_inset Flex CharStyle:Code
4141 \begin_layout Plain Layout
4142 Theorems (AMS-Extended)
4150 \begin_layout Criterion*
4151 A required condition.
4154 \begin_layout Algorithm*
4155 A general procedure to be used.
4158 \begin_layout Axiom*
4159 This is a property or statement taken as true within the system being discussed.
4162 \begin_layout Condition*
4163 Sometimes used to state a condition assumed within the present context of
4168 Similar to a Remark.
4171 \begin_layout Notation*
4172 Used for the explanation of, yes, notation.
4175 \begin_layout Summary
4176 Do we really need to tell you?
4179 \begin_layout Acknowledgement*
4183 \begin_layout Conclusion*
4184 Sometimes used at the end of a long train of argument.
4188 Used in a way similar to Proposition, though perhaps lower on the scale.
4191 \begin_layout Standard
4192 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4194 They need to be available on your system in order to use these environments.
4197 \begin_layout Section
4201 \begin_layout Standard
4206 can be used to type letters according to German conventions.
4207 A template file is included in
4209 .../lyx/share/templates
4211 for you to use as a starting point.
4214 \begin_layout Section
4218 \begin_layout Standard
4223 provides an alternative to the standard
4228 It provides similar functionality, but you might prefer this layout with
4229 sans serif sections, headings, and more.
4232 \begin_layout Section
4236 \begin_layout Standard
4242 \begin_layout Subsection
4246 \begin_layout Standard
4247 This section describes how LyX can be used to write articles for submission
4248 to the scientific journal
4250 Astronomy and Astrophysics
4252 (www.edpsciences.fr/aa/
4253 \begin_inset Flex URL
4256 \begin_layout Plain Layout
4258 http://www.edpsciences.fr/aa/
4263 ) using Version 5.01 of the document class
4268 This package can be downloaded from the ftp site
4271 \begin_layout Standard
4272 \begin_inset VSpace medskip
4278 \begin_layout Standard
4280 \begin_inset Flex URL
4283 \begin_layout Plain Layout
4285 ftp://ftp.edpsciences.org/pub/aa/readme.html
4293 \begin_layout Standard
4294 \begin_inset VSpace medskip
4300 \begin_layout Standard
4301 A manual comes together with that package, and this text is not meant to
4302 replace the original manual but merely a short guide how to realize the
4303 correct form of your paper.
4307 \begin_layout Standard
4308 Please note that the publisher of the journal was changed from Springer
4309 to EDP Sciences starting January 1, 2001.
4310 That change implicated also some slight changes of the style files, namely
4311 the removal of the thesaurus command.
4312 The LyX class aa supports the newest version of these style files, V 5.01.
4313 If you have an older version installed, please upgrade.
4314 For compatibility, the old (version 4) layout has been kept as
4319 Please refer to the comments in
4321 LyXDir/layouts/aapaper.layout
4326 \begin_layout Subsection
4330 \begin_layout Standard
4331 It is recommended you start from the example template distributed with LyX.
4332 If you are not using a template, note the following settings:
4335 \begin_layout Itemize
4345 ocument\SpecialChar \menuseparator
4352 dialog (OK, that one was obvious).
4355 \begin_layout Itemize
4356 Don't change the option
4359 \begin_inset space ~
4369 The whole layout is done by the macros, you shouldn't change anything.
4372 \begin_layout Subsection
4376 \begin_layout Standard
4377 First thing to enter is the header information.
4378 It consists of seven entries, of which some are optional.
4382 \begin_layout Itemize
4390 \begin_layout Itemize
4398 \begin_layout Itemize
4406 \begin_layout Itemize
4414 \begin_layout Itemize
4419 : [optional] if more than one author: whom to contact for offprint requests.
4422 \begin_layout Itemize
4427 : [optional] mail address for contacts.
4430 \begin_layout Itemize
4438 Received: <date>; Accepted <date>
4441 \begin_layout Standard
4442 There is no need to issue the
4448 command, this is done automatically by LyX when the header is finished.
4449 Although the order of the single header entries doesn't matter it is advised
4450 to keep the above sequence, just to get the best optics and meets the layout
4451 of the real document.
4454 \begin_layout Standard
4455 If you want to place footnotes in the header block, e.
4456 \begin_inset space \thinspace{}
4460 \begin_inset space ~
4463 to state your present address, just use the standard footnote via
4468 nsert\SpecialChar \menuseparator
4476 LyX will automagically use the term
4485 \begin_layout Standard
4486 In addition to these topics, the macros use three additional LaTeX commands
4487 that have no counterpart in LyX:
4490 \begin_layout Itemize
4497 to separate different names for more than one author and institute, respectivel
4501 \begin_layout Itemize
4508 to mark corresponding author/institute pairs.
4509 The institutes are numbered sequentially as they appear in the
4513 field, so you have to put a marker to each author.
4516 \begin_layout Itemize
4523 to supply an email address for fast contact.
4526 \begin_layout Standard
4527 In all cases, the appropriate command has to be entered in LyX and marked
4533 \begin_layout Subsection
4537 \begin_layout Standard
4538 The abstract should immediately follow the header block.
4539 With version 5 the abstract environment was changed to a command, and there
4540 is now a resctriction to only one paragraph.
4541 In addition, it should contain an entry with the keywords.
4542 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4549 by hand and mark it as LaTeX code.
4550 Refer to the example paper.
4553 \begin_layout Subsection
4554 Supported environments
4557 \begin_layout Standard
4558 The A&A paper layout supports the following environments for structuring
4562 \begin_layout Itemize
4568 \begin_layout Itemize
4574 \begin_layout Itemize
4580 \begin_layout Itemize
4586 \begin_layout Itemize
4592 \begin_layout Itemize
4598 \begin_layout Itemize
4604 \begin_layout Itemize
4610 \begin_layout Itemize
4616 \begin_layout Itemize
4622 \begin_layout Itemize
4628 \begin_layout Itemize
4634 \begin_layout Subsection
4635 Commands not supported by LyX
4638 \begin_layout Standard
4639 Some commands are not yet supported by the
4644 Some have already been mentioned.
4645 For the sake of completeness, they are listed all together here:
4648 \begin_layout Itemize
4656 \begin_layout Itemize
4664 \begin_layout Itemize
4672 \begin_layout Itemize
4680 \begin_layout Itemize
4688 \begin_layout Itemize
4696 \begin_layout Itemize
4704 \begin_layout Itemize
4712 \begin_layout Standard
4713 If you want to use any of these commands, you have to enter them yourself.
4716 Do not forget to mark them as LaTeX code!
4719 \begin_layout Subsection
4720 Figure and Table Floats
4723 \begin_layout Standard
4724 LyX provides support for the necessary float environments
4726 figure, figure*, table
4732 , therefore we won't tell much about it here.
4736 \begin_inset space ~
4742 Just remember that tables should be left-aligned.
4743 For that, select the table and change the alignment in
4748 dit\SpecialChar \menuseparator
4754 \begin_inset space ~
4760 \begin_layout Standard
4761 There is only one special thing: the figures with caption besides the figure.
4762 To create such a figure, you have to do the following:
4765 \begin_layout Enumerate
4766 Create a wide figure float:
4771 nsert\SpecialChar \menuseparator
4776 t\SpecialChar \menuseparator
4779 , then right click in the figure and select
4785 \begin_inset space ~
4793 \begin_layout Enumerate
4794 Enter your caption text.
4797 \begin_layout Enumerate
4802 to move the cursor above the caption.
4805 \begin_layout Enumerate
4809 \begin_layout Enumerate
4810 Position the cursor behind the figure and insert a horizontal fill:
4815 nsert\SpecialChar \menuseparator
4821 \begin_inset space ~
4826 \SpecialChar \menuseparator
4830 \begin_inset space ~
4838 \begin_layout Enumerate
4839 Switch to LaTeX mode:
4842 \begin_inset space ~
4850 \begin_layout Enumerate
4860 Do not close the brace!
4863 \begin_layout Enumerate
4864 Position the cursor behind the caption text, switch to LaTeX mode and insert
4868 \begin_inset space ~
4880 \begin_layout Standard
4881 Also, refer to the figures in the example paper.
4884 \begin_layout Subsection
4888 \begin_layout Standard
4889 For submission, the paper has to be formated in a special double-spacing
4891 For this purpose, you have to give the option
4895 to the documentclass.
4896 This must be done using the extra class options field in the
4901 ocument\SpecialChar \menuseparator
4909 Just enter the string
4916 \begin_layout Subsection
4920 \begin_layout Standard
4925 directory contains an example paper written with LyX.
4926 It is the example paper from the original macro package, translated to
4928 Use it for inspiration, and compare the original LaTeX code with LyX way
4932 \begin_layout Section
4936 \begin_layout Standard
4942 \begin_layout Subsection
4946 \begin_layout Standard
4947 AASTeX is a set of macros produced by the American Astronomical Society
4948 to facilitate electronic manuscript submission to the three journals they
4949 publish: the Astrophysical Journal (including the Letters and Supplement),
4950 the Astronomical Journal, and the Publications of the Astronomical Society
4952 LyX has proven to be an excellent tool for generating these documents,
4953 especially given its equation, citation, and figure handling capabilities.
4954 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4955 is the version described here, or higher.
4956 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4957 incompatible with LyX.
4958 The AASTeX package may be downloaded from the AASTeX Web site
4961 \begin_layout Standard
4962 \begin_inset VSpace medskip
4968 \begin_layout Standard
4970 \begin_inset Flex URL
4973 \begin_layout Plain Layout
4975 http://www.journals.uchicago.edu/AAS/AASTeX
4983 \begin_layout Standard
4984 \begin_inset VSpace medskip
4990 \begin_layout Standard
4991 A complete user guide is contained in that package and you should familiarize
4992 yourself with it thoroughly before embarking on writing a paper in LyX.
4993 LyX will not reduce the need to figure out all the AASTeX commands, it
4994 will only reduce the drudgery of typing everything in.
4995 It is your responsibility to ensure that the final exported LaTeX document
4996 conforms completely to the requirements of the journal to which you are
4997 submitting your paper.
5000 \begin_layout Subsection
5001 Starting a New Paper
5004 \begin_layout Standard
5005 I strongly suggest that you start with the AASTeX template file.
5011 ile\SpecialChar \menuseparator
5021 , enter the new file name, then choose the
5026 This will show the most common fields found in a manuscript.
5027 Simply overwrite the existing text (including the brackets,
5031 ) with the correct information.
5032 Many of the AASTeX commands and environments can be implemented directly
5033 in LyX, but some cannot: most noticeably
5045 , which should stick out like a sore thumb if you actually just opened the
5047 For commands such as these, the LaTeX code must be entered directly and
5049 Such commands are referred to as ERT, or Evil Red Text.
5050 I tried to minimize the amount of ERT needed in an AASTeX document, but
5051 there is still a bit more required than any of us would like.
5054 \begin_layout Subsection
5055 Finishing Your Paper
5058 \begin_layout Standard
5059 When the paper is finished to your satisfaction and previews/prints correctly,
5061 \begin_inset Quotes eld
5065 \begin_inset Quotes erd
5068 actions which need to be done before you submit it to the journals.
5072 \begin_layout Enumerate
5073 Export your paper as a LaTeX file (
5078 ile\SpecialChar \menuseparator
5083 xport\SpecialChar \menuseparator
5094 \begin_layout Enumerate
5099 file with your favorite text editor
5103 \begin_layout Enumerate
5104 remove the comment lines before the
5113 \begin_layout Enumerate
5118 usepackage...{fontenc}
5120 line if it appears (usually just after
5135 \begin_layout Enumerate
5136 remove everything between (and including) the
5148 commands, except for any commands you specifically put into the LaTeX preamble
5149 (which should appear immediately after the
5150 \begin_inset Quotes eld
5153 User specified LaTeX commands
5154 \begin_inset Quotes erd
5165 \begin_layout Enumerate
5166 Run the resulting file through LaTeX to make sure it still processes correctly.
5169 \begin_layout Enumerate
5170 Reread the journal requirements to make sure your filenames and formats
5174 \begin_layout Enumerate
5178 \begin_layout Subsection
5179 Comments On Specific Commands
5182 \begin_layout Standard
5183 I will not describe the detailed usage of the individual AASTeX commands:
5184 the AASTeX User Guide (
5188 ) gives a good description of each.
5189 Thus it's probably easiest for me to go down the list as found in the guide
5190 and offer comments where necessary.
5191 So let's begin \SpecialChar \ldots{}
5195 \begin_layout Subsubsection
5196 Things that work as expected
5199 \begin_layout Standard
5203 \begin_layout Plain Layout
5215 \begin_layout Standard
5216 Because they work as you might expect, I simply list them and the section
5317 begin{thebibliography}
5325 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5326 graphicx figure commands (2.14.1),
5350 (2.15.4, amongst other places),
5377 \begin_layout Standard
5378 The following style options also work correctly:
5399 Simply put them in the
5405 Layout\SpecialChar \menuseparator
5411 \begin_layout Standard
5415 \begin_layout Plain Layout
5427 \begin_layout Subsubsection
5428 Things that work, but require more comment
5431 \begin_layout Standard
5432 The following items work, but require a little more discussion:
5435 \begin_layout Itemize
5436 These items are reserved for use by the journal editors, but you can put
5437 them into the LaTeX preamble if you feel compelled to do so:
5470 \begin_layout Itemize
5471 These items may be placed in the LaTeX preamble, and are included as blanks
5472 in the template file:
5493 \begin_layout Itemize
5500 (2.3) -- can only be used
5501 \begin_inset Quotes eld
5505 \begin_inset Quotes erd
5508 , not in the middle of a paragraph.
5509 Use ERT if you need to embed it.
5512 \begin_layout Itemize
5519 (2.3) -- will have extra {} after it.
5520 This should not cause an error.
5523 \begin_layout Itemize
5530 (2.6) -- can only be used
5531 \begin_inset Quotes eld
5535 \begin_inset Quotes erd
5538 , not in the middle of a paragraph.
5539 Use ERT if you need to embed it.
5542 \begin_layout Itemize
5549 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5553 \begin_layout Itemize
5560 (2.8) -- same as for
5567 \begin_layout Itemize
5574 (2.9) -- will have extra {} after it.
5575 This should not cause an error.
5578 \begin_layout Itemize
5585 (2.11) -- will have extra {} after it.
5586 This should not cause an error.
5589 \begin_layout Itemize
5596 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5597 at the beginning of the text and selecting
5599 Insert\SpecialChar \menuseparator
5604 \begin_inset Quotes eld
5608 \begin_inset Quotes erd
5611 inserts an optional argument of the type needed by
5618 Hopefully it will be renamed someday.
5621 \begin_layout Itemize
5634 for the catalog ID optional parameter
5637 \begin_layout Itemize
5650 for the catalog ID optional parameter
5653 \begin_layout Subsubsection
5654 Things not implemented, use ERT
5657 \begin_layout Standard
5661 \begin_layout Plain Layout
5673 \begin_layout Standard
5696 setcounter{equation}
5698 (2.12), Journal name abbreviations (2.13.4),
5734 (2.15.4, insert it as the first element in the lefthand cell after where
5736 Don't use any of LyX's rules in the table),
5748 (2.15.5), much of Misc (2.17, except
5799 \begin_layout Standard
5803 \begin_layout Plain Layout
5815 \begin_layout Subsubsection
5816 Things that cannot be implemented
5819 \begin_layout Standard
5820 \SpecialChar \ldots{}
5821 at least in any meaningful sort of way, so I suggest ignoring them.
5822 They are the references environment (2.13.3), and the deluxetable environment
5824 If you really, really need to use deluxetable, I suggest editing it in
5825 a separate file with a text editor, then using
5830 nsert\SpecialChar \menuseparator
5836 \begin_inset space ~
5841 to include it in your LyX document.
5846 file to see an example of this.
5849 \begin_layout Subsection
5850 FAQs, Tips, Tricks, and Other Ruminations
5853 \begin_layout Subsubsection
5854 Getting LyX and AASTeX to cooperate
5857 \begin_layout Standard
5858 It can be a bit tricky to get LyX to recognize a new layout and document
5860 When all else fails, do this:
5863 \begin_layout Enumerate
5864 Make certain that LaTeX can find AASTeX.
5865 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5866 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5873 \begin_layout Enumerate
5885 \begin_layout Enumerate
5891 ools\SpecialChar \menuseparator
5898 in LyX, then restart LyX.
5901 \begin_layout Enumerate
5902 Open a regular new file, not from a template.
5903 Does AASTeX appear in the class list in
5908 ocument\SpecialChar \menuseparator
5918 \begin_layout Standard
5919 If you get a warning from an existing AASTeX document about not being able
5920 to find the AASTeX layout or a message about
5921 \begin_inset Quotes eld
5924 You should not mix title layouts with normal ones
5925 \begin_inset Quotes erd
5928 , things haven't been installed correctly.
5931 \begin_layout Subsubsection
5932 LaTeX error processing a table
5935 \begin_layout Standard
5936 LyX, by default, attempts to center the table caption/title.
5937 This seems to produce a bad interaction in AASTeX so you should click somewhere
5938 in the caption/title, then select
5943 dit\SpecialChar \menuseparator
5949 \begin_inset space ~
5966 This took care of it for me.
5969 \begin_layout Subsubsection
5971 \begin_inset CommandInset label
5980 \begin_layout Standard
5981 A couple of things: 1) I have noticed some funny spacing in the reference
5982 entries in the text.
5983 When you enter the bibliography item data, make sure their is
5987 space between the last author and the parenthesis setting off the year;
5991 \begin_inset space \thinspace{}
5995 \begin_inset space ~
6009 2) Entering the references at all is not obvious.
6010 The easiest thing is to start typing your first reference at the end of
6011 the document, then mark it as type
6016 That will put a small gray box in front of what you just typed.
6017 Click on the box to fill in the rest of the information.
6018 For new references, go to the end of an existing reference and press return.
6019 That will create a new line with its own box, etc.
6022 \begin_layout Subsubsection
6026 \begin_layout Standard
6027 Even though AASTeX provides its own figure commands (
6033 , for example), I much prefer LaTeX's standard figure commands (with the
6042 \begin_inset space ~
6045 commands as ERT into a Figure Float box if you desire, but I never have
6046 much luck getting the layout right.
6047 With the standard graphics, LyX will insert a
6051 usepackage{graphicx}
6053 command into the LaTeX preamble and handle the figures in the standard
6054 LaTeX2e way, interspersing the figures in the text.
6055 I believe ApJ accepts figures exactly this way now; AJ might still use
6057 \begin_inset Quotes eld
6060 stack everything at the end
6061 \begin_inset Quotes erd
6067 \begin_layout Subsubsection
6068 Things I could have done, but didn't
6071 \begin_layout Standard
6073 \begin_inset Quotes eld
6077 \begin_inset Quotes erd
6080 things I could have implemented, but chose not to.
6081 For instance, I saw no point in double-spacing the text in the LyX window,
6082 even though it is double-spaced in the paper manuscript.
6083 Also, I chose not to make separate layouts for the preprint and preprint2
6085 Since I assume you will spend most of your time in the plain manuscript
6086 mode anyway, I decided not to chew up more disk space with this.
6090 \begin_layout Subsection
6094 \begin_layout Standard
6095 Your mileage may vary.
6096 I've now had papers published by both ApJ and AJ that have had 98% of the
6097 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6099 I have had no trouble with the submission process, and I'm sure the journals
6100 were never aware that there might be a difference.
6101 So, go forth and publish!
6104 \begin_layout Section
6108 \begin_layout Standard
6111 Panayotis Papasotiriou
6114 \begin_layout Subsection
6118 \begin_layout Standard
6119 The ijmpc package is a set of macros that facilitates electronic manuscript
6122 International Journal of Modern Physics C
6125 Similarly, the ijmpd package is for creating manuscripts to be submitted
6128 International Journal of Modern Physics D
6131 Both journals are published by World Scientific.
6132 The corresponding document classes are named
6141 These files, together with instructions for the authors, can be downloaded
6143 \begin_inset Flex URL
6146 \begin_layout Plain Layout
6148 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6154 \begin_inset Flex URL
6157 \begin_layout Plain Layout
6159 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6165 Both packages are modified versions of the standard
6166 \begin_inset Quotes eld
6170 \begin_inset Quotes erd
6173 package, and they are almost (but not exactly) identical.
6174 Most of their features are supported by LyX.
6175 I have used LyX successfully to write articles submitted to both journals
6176 without any problem.
6179 \begin_layout Subsection
6183 \begin_layout Standard
6184 As usual, the easiest way to write a paper is to start with a template.
6190 ile\SpecialChar \menuseparator
6209 This will give an (almost) empty document that includes the most common
6210 fields found in a manuscript.
6211 Simply overwrite the existing text (including the brackets,
6216 You should keep in mind the following remarks.
6219 \begin_layout Enumerate
6220 LyX won't let you change the font size and the page style of the document,
6221 because such modifications are not allowed by both packages.
6224 \begin_layout Enumerate
6225 The language of the document should not be changed.
6226 Before previewing your paper, be sure that the babel package is not used.
6227 To do this, click on
6232 ools\SpecialChar \menuseparator
6250 checkbox in the language settings, and click on
6261 , if you wish to make this change permanent).
6264 \begin_layout Enumerate
6266 \begin_inset Quotes eld
6270 \begin_inset Quotes erd
6273 style must be used to define keywords.
6276 \begin_layout Enumerate
6277 The ijmpc package provides a style named
6278 \begin_inset Quotes eld
6281 Classification Codes
6282 \begin_inset Quotes erd
6285 , which can be used to define classification codes, such as PACS numbers.
6286 Note that this facility is not supported by the ijmpd package.
6289 \begin_layout Enumerate
6290 Several new environments are available:
6291 \begin_inset Quotes eld
6295 \begin_inset Quotes erd
6299 \begin_inset Quotes eld
6303 \begin_inset Quotes erd
6307 \begin_inset Quotes eld
6311 \begin_inset Quotes erd
6315 \begin_inset Quotes eld
6319 \begin_inset Quotes erd
6323 \begin_inset Quotes eld
6327 \begin_inset Quotes erd
6331 \begin_inset Quotes eld
6335 \begin_inset Quotes erd
6339 \begin_inset Quotes eld
6343 \begin_inset Quotes erd
6347 \begin_inset Quotes eld
6351 \begin_inset Quotes erd
6355 \begin_inset Quotes eld
6359 \begin_inset Quotes erd
6363 \begin_inset Quotes eld
6367 \begin_inset Quotes erd
6371 \begin_inset Quotes eld
6375 \begin_inset Quotes erd
6379 \begin_inset Quotes eld
6383 \begin_inset Quotes erd
6387 \begin_inset Quotes eld
6391 \begin_inset Quotes erd
6395 \begin_inset Quotes eld
6399 \begin_inset Quotes erd
6403 Their use is more or less obvious.
6404 LyX supports all these environments; it will use the proper label, text
6405 style, and numbering scheme for each of them.
6408 \begin_layout Enumerate
6409 Both packages use basic citations; the natbib package should not be used.
6410 In LyX, citation references are shown as usual; in the output, citations
6411 are shown as superscripts.
6412 If you want to use a citation as normal text, you should use the
6417 \begin_inset space \thinspace{}
6421 \begin_inset Quotes eld
6425 \begin_inset space ~
6435 \begin_inset Quotes erd
6441 \begin_layout Enumerate
6443 \begin_inset Quotes eld
6447 \begin_inset Quotes erd
6450 section in both packages.
6451 To put acknowledgments, just use the
6452 \begin_inset Quotes eld
6456 \begin_inset Quotes erd
6462 \begin_layout Enumerate
6463 Appendices may be added to the paper,
6467 the Acknowledgments and
6472 LyX provides a special environment, called
6473 \begin_inset Quotes eld
6477 \begin_inset Quotes erd
6480 which marks the beginning of the appendices.
6481 This environment should be left blank; it just sends a LaTeX command, but
6482 nothing is really printed.
6484 \begin_inset Quotes eld
6488 \begin_inset Quotes erd
6491 is printed with blue letters, as a signal that all sections after that
6492 point are appendices.
6493 To write an appendix, use the
6494 \begin_inset Quotes eld
6498 \begin_inset Quotes erd
6502 LyX will number each appendix with capital letters, as required by both
6505 \begin_inset Quotes eld
6509 \begin_inset Quotes erd
6516 be present before the first appendix; if not, all appendices will be numbered
6517 as normal sections in the output.
6520 \begin_layout Enumerate
6521 The ijmpc and the ijmpd packages use the
6525 command to implement table captions.
6526 As a result, a table created by LyX is printed correctly, but its caption
6528 However, you can use some ERT to overpass this problem, so that captions
6529 are printed as expected.
6530 To do so, create a float table as usual, remove the caption, and replace
6541 (sic); you must also the ERT
6545 immediately after the tabular material.
6546 Study the example table included in the template files to see how this
6547 trick is implemented.
6548 Alternatively, If you need table captions, you should implement the whole
6553 file, then include this file to the LyX document (
6558 nsert\SpecialChar \menuseparator
6563 \SpecialChar \menuseparator
6569 \begin_inset space ~
6575 Details on how to create a table float can be found in the files
6583 , included in the corresponding packages.
6586 \begin_layout Subsection
6587 Preparing a paper for submission
6590 \begin_layout Standard
6591 Before you submit your paper you must export the LyX document as a LaTeX
6597 ile\SpecialChar \menuseparator
6602 xport\SpecialChar \menuseparator
6617 \begin_layout Plain Layout
6618 Actually you have the choice between LaTeX (plain) and pdflatex.
6619 If you intend to use pdflatex to prepare the paper, you should use the
6620 pdflatex option so that included graphics are converted to PDF format,
6621 ready for use by pdflatex.
6626 , then make the following changes to the resulting
6633 \begin_layout Enumerate
6634 Remove the comment lines before the
6643 \begin_layout Enumerate
6644 Remove everything between (and including) the
6656 commands, except for any commands you specifically put into the LaTeX preamble.
6659 \begin_layout Standard
6664 file should be saved and processed through LaTeX as many times as necessary.
6665 You may also want to check the resulting
6672 \begin_layout Subsection
6676 \begin_layout Standard
6677 The use of ERT is reduced to two commands, which must be placed at the top
6679 If you started writing your paper by using the
6687 template, the ERT needed is already in its place; you usually don't need
6689 You may only modify the first ERT to specify the information printed to
6690 the top of odd and even pages (authors' names and short paper's title,
6692 This ERT must have the form
6696 markboth{Authors' Names}{Short Paper's Title}
6701 \begin_layout Section
6705 \begin_layout Standard
6711 \begin_layout Subsection
6715 \begin_layout Standard
6716 The iopart package provides a document class to create electronic manuscript
6717 submission to the journals published by the Institute of Physics.
6718 Instructions for the authors how to create a paper using the iopart class
6719 can be downloaded together with the iopart package from the site
6720 \begin_inset Flex URL
6723 \begin_layout Plain Layout
6725 ftp://ftp.iop.org/pub/journals/latex2e
6733 \begin_layout Subsection
6737 \begin_layout Standard
6738 The easiest way to write a paper is to start with the file
6742 that is available in LyX's examples files folder.
6743 Open this file, save it under a new name, and start writing.
6744 The example file explains how to use the special text environments.
6745 Here are the most important advices:
6748 \begin_layout Itemize
6749 To be able to compile your document to a PDF, PS, or DVI, assure that the
6752 Use AMS math package
6754 in the document settings under
6761 \begin_layout Itemize
6764 The title environment defines the kind of your paper.
6765 So use one of the following environments for the title:
6769 \begin_layout Itemize
6778 \begin_layout Itemize
6787 \begin_layout Itemize
6793 for a Topical review
6796 \begin_layout Itemize
6805 \begin_layout Itemize
6814 \begin_layout Itemize
6820 for a Paper (same as Title)
6823 \begin_layout Itemize
6829 for a Preliminary communication
6832 \begin_layout Itemize
6838 for a Rapid communication
6841 \begin_layout Itemize
6847 for a Letter to the editor
6851 \begin_layout Itemize
6854 All title environments except of
6858 can have an optional short title.
6861 \begin_layout Itemize
6862 There is a general title environment
6866 which is not directly supported by the LyX.
6867 This can be used as ERT when your document doesn't fit into one of the
6871 \begin_layout Standard
6872 For more informations like hints for special table and formula formatting,
6873 look at the IOP author guidelines.
6876 \begin_layout Section
6880 \begin_layout Standard
6883 Panayotis Papasotiriou
6886 \begin_layout Subsection
6890 \begin_layout Standard
6891 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6892 that facilitates electronic manuscript submission to the journals they
6894 Most known of them (at least in my domain of interest) are
6896 Astrophysics and Space Science
6902 , but there are many others (see a complete list at
6903 \begin_inset Flex URL
6906 \begin_layout Plain Layout
6908 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6914 The Kluwer package may be downloaded from the site
6915 \begin_inset Flex URL
6918 \begin_layout Plain Layout
6920 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6926 A complete user guide is contained in that package (but it can also be
6927 downloaded separately).
6930 \begin_layout Standard
6931 LyX supports many features of the package but not everything.
6932 However, the ERT needed is reduced to some
6933 \begin_inset Quotes eld
6937 \begin_inset Quotes erd
6940 commands of the package (see
6941 \begin_inset space ~
6945 \begin_inset CommandInset ref
6947 reference "subsec:kluwer_peculiarities"
6952 I have recently used LyX to write an article submitted to the
6954 Astrophysics and Space Science
6956 without any problem.
6959 \begin_layout Subsection
6963 \begin_layout Standard
6964 The easiest way to write a paper is to start with the Kluwer template file.
6967 File\SpecialChar \menuseparator
6982 This will give an (almost) empty document that includes the most common
6983 fields found in a manuscript and a short description of their use.
6984 As in most templates, simply overwrite the existing text (including the
6989 ) with the correct information.
6992 \begin_layout Subsection
6993 Preparing a paper for submission
6996 \begin_layout Standard
6997 As in the AASTeX package, before you submit your paper to a journal you
6999 \begin_inset Quotes eld
7003 \begin_inset Quotes erd
7009 \begin_layout Enumerate
7010 Export your paper as a LaTeX file.
7011 To do this, click on
7016 ile\SpecialChar \menuseparator
7021 xport\SpecialChar \menuseparator
7032 \begin_layout Enumerate
7037 file with a text editor and make the following changes
7041 \begin_layout Enumerate
7042 remove the comment lines before the
7051 \begin_layout Enumerate
7052 remove everything between (and including) the
7064 commands, except for any commands you specifically put into the LaTeX preamble.
7067 \begin_layout Standard
7076 \begin_layout Enumerate
7081 file through LaTeX as many times as necessary (usually up to three).
7084 \begin_layout Enumerate
7090 \begin_inset space \thinspace{}
7097 , and check if everything is OK (it should, if you didn't make any mistake).
7100 \begin_layout Subsection
7101 \begin_inset Quotes eld
7105 \begin_inset Quotes erd
7108 of the Kluwer package
7109 \begin_inset CommandInset label
7111 name "subsec:kluwer_peculiarities"
7118 \begin_layout Standard
7119 The Kluwer package has the following
7120 \begin_inset Quotes eld
7124 \begin_inset Quotes erd
7130 \begin_layout Enumerate
7131 It is possible to write multiple articles in the same LaTeX file
7135 \begin_layout Plain Layout
7136 I can't imagine any good reason to do this.
7142 Each article must be included in the environment
7143 \begin_inset Quotes eld
7147 \begin_inset Quotes erd
7151 Unfortunately, this environment cannot be omitted, even if you write just
7153 Therefore, each article starts with the command
7159 and, obviously, ends with the command
7166 Although this can be implemented in LyX, I didn't included it, since it
7167 looks ugly and can confuse the novice user.
7168 Therefore, you need to enter them directly and mark them as LaTeX code
7170 \begin_inset Quotes eld
7174 \begin_inset Quotes erd
7180 \begin_layout Enumerate
7181 Information given at the beginning of the article (i.e., title, subtitle,
7182 author, institution, running title, running author, abstract and keywords)
7183 must be included in an environment called
7184 \begin_inset Quotes eld
7188 \begin_inset Quotes erd
7192 This is not implemented in LyX, so you must enter title, subtitle etc.
7193 \begin_inset space ~
7196 between two ERT lines (
7211 \begin_layout Enumerate
7212 According to the user manual, the label of each bibliography item must be
7236 \begin_layout Standard
7241 template takes care of all these
7242 \begin_inset Quotes eld
7246 \begin_inset Quotes erd
7250 If you start a new paper using this template you don't need to do anything
7255 \begin_layout Enumerate
7256 don't delete the ERT included in the template, and
7259 \begin_layout Enumerate
7260 copy the example bibliography item included in the template and modify it
7261 as necessary to enter new bibliography items.
7264 \begin_layout Section
7268 \begin_layout Standard
7274 \begin_layout Subsection
7278 \begin_layout Standard
7279 The LyX document classes
7281 article (koma-script)
7285 report (koma-script)
7303 correspond to the LaTeX document classes
7320 \begin_inset space ~
7323 of the Koma-Script family.
7324 They are replacements for the standard document classes
7340 , resp., and fit better to European typography conventions in a number of
7344 \begin_layout Itemize
7345 Standard character size is 11pt in
7347 article (koma-script)
7351 report (koma-script)
7359 letter (koma-script)
7364 \begin_layout Itemize
7365 Headings, labels of the description environment, and a number of elements
7368 letter (koma-script)
7370 document class are set in a bold sans serif font.
7374 \begin_layout Plain Layout
7375 There is a big difference between the bold sans serif old cm fonts and new
7376 ec fonts, especially in the appearance of headings.
7377 In comparison, the ec bold sans serif fonts look a bit thin.
7378 Here the LaTeX package
7386 helps to produce the
7387 \begin_inset Quotes eld
7391 \begin_inset Quotes erd
7394 appearance when using the ec fonts.
7399 The numbering of chapter headings is made in the same way as the numbering
7400 of section headings, that is without the extra line
7401 \begin_inset Quotes eld
7404 Chapter\SpecialChar \ldots{}
7406 \begin_inset Quotes erd
7410 In addition, the appearance of the headings can be modified by using a
7411 number of options (in LyX to be entered in the field
7418 \begin_inset space ~
7428 ayout\SpecialChar \menuseparator
7436 A detailed German description of these options can be found in the Koma-Script
7444 \begin_layout Itemize
7445 The main means in the Koma-Script document classes to design the type area
7454 (in LyX to be entered in the extra class options field in the dialog
7459 ocument\SpecialChar \menuseparator
7467 They make a clearer modification of page margins possible as do the options
7473 ocument\SpecialChar \menuseparator
7481 A detailed German description of these and other type area options can
7482 be found in the Koma-Script documentation
7489 \begin_layout Itemize
7490 The LaTeX document classes of the Koma-Script family define a number of
7491 additional commands.
7492 Those part of it which makes sense in LyX is implemented in corresponding
7496 \begin_layout Standard
7497 A detailed German description of the LaTeX document classes of the Koma-Script
7498 family can be found in the Koma-Script documentation
7506 \begin_layout Plain Layout
7507 There is an English translation
7511 , but it is not a complete one.
7516 The following sections describe only those aspects, which are relevant
7520 \begin_layout Subsection
7521 article (koma-script), report (koma-script), and book (koma-script)
7524 \begin_layout Standard
7525 The document classes
7527 article (koma-script)
7531 report (koma-script)
7541 are implemented in the layout files
7554 They contain all the paragraph types of the corresponding standard document
7567 , resp., partly modified, with the exception of the LyX specific
7571 -type, which is replaced by the new
7575 -type having the same functionality.
7580 -Type there is a number of new paragraph types added.
7587 letter (koma-script)
7592 \begin_layout Itemize
7601 : are equivalents to
7609 , resp., additionally inserting an entry in the table of contents.
7618 are not contained in
7620 article (koma-script)
7625 \begin_layout Itemize
7642 , resp., additionally clearing running heads.
7649 article (koma-script)
7655 \begin_layout Plain Layout
7668 report (koma-script)
7670 , but since this is identical to
7674 , is has not been implemented in LyX.
7682 \begin_layout Itemize
7687 : generates a heading directly above the following paragraph in the standard
7688 character size without affecting the structure of the document.
7691 \begin_layout Itemize
7700 are special captions which respect the different space settings needed
7701 for captions placed above or below an element (if you follow strict typographic
7702 rules, you might want to place table captions always above the table).
7703 You can also use the class option
7720 You need at least Koma-Script version 2.8q to use this.
7723 \begin_layout Itemize
7728 : can be used to set a bonmot, e.
7729 \begin_inset space \thinspace{}
7733 \begin_inset space ~
7736 at the beginning of a chapter.
7737 If you use the optional argument (
7742 nsert\SpecialChar \menuseparator
7744 \begin_inset space ~
7749 ), you can insert the dictum's author there.
7750 Dictum and author are separated by a line.
7751 You need at least Koma-Script version 2.8q to use this.
7758 article (koma-script)
7763 \begin_layout Standard
7764 The following types, together with the standard types
7776 , form the title area of the document.
7777 They must be entered ahead of the first
7778 \begin_inset Quotes eld
7782 \begin_inset Quotes erd
7789 \begin_layout Plain Layout
7790 The corresponding LaTeX commands must appear before the
7801 When such a type is used more than once, the latter usage overwrites the
7802 former one, that means, for every type only the latest usage is valid.
7803 The order of the different types however has, like
7815 , no effect on the appearance of the produced document.
7818 \begin_layout Itemize
7823 : produces a centered paragraph above the ordinary title (
7835 ) for the subject of the document.
7838 \begin_layout Itemize
7843 : produces a centered paragraph below the ordinary title (
7855 ) for the publishers' name.
7858 \begin_layout Itemize
7865 report (koma-script)
7871 produces a centered paragraph on its own page behind the title page, or
7874 article (koma-script)
7876 produces a centered paragraph below the ordinary title (
7895 \begin_layout Itemize
7900 : produces a left aligned paragraph above the ordinary title (
7916 ) for a document`s head.
7919 \begin_layout Itemize
7924 : produces in a double-sided print in
7926 report (koma-script)
7932 a left-aligned paragraph at the top of the title page`s back or has no
7933 effect in a single-sided print or in
7935 article (koma-script)
7940 \begin_layout Itemize
7945 : produces in a double-sided print in
7947 report (koma-script)
7953 a left-aligned paragraph at the bottom of the title page`s back or has
7954 no effect in a single-sided print or in
7956 article (koma-script)
7961 \begin_layout Itemize
7966 : produces a special
7967 \begin_inset Quotes eld
7971 \begin_inset Quotes erd
7974 page ahead of the actual document containing a paragraph without special
7978 \begin_layout Standard
7979 The layout files for the document classes
7981 article (koma-script)
7985 report (koma-script)
7996 This is thought of as a place to define your own types.
8001 in your personal layout directory and edit the file!
8004 \begin_layout Subsection
8005 letter (koma-script)
8008 \begin_layout Standard
8012 \begin_layout Plain Layout
8024 \begin_layout Standard
8028 letter (koma-script)
8030 is implemented in the layout file
8035 It contains all the paragraph types of the corresponding standard document
8040 , partly modified, with the exception of the LyX specific types
8052 type, which is replaced by the new
8057 In addition, it contains, in contrast to the standard document class, the
8075 Furthermore, there are a number of new letter specific types.
8078 \begin_layout Standard
8082 \begin_layout Plain Layout
8094 \begin_layout Standard
8095 The appearance of the letter produced by this document class can be controlled
8096 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8100 \begin_layout Plain Layout
8101 For example, the standard appearance of the letter`s heading, consisting
8102 of name and address, is quite self-willed.
8104 \begin_inset Quotes eld
8108 \begin_inset Quotes erd
8111 heading is produced by the following LaTeX commands in the preamble:
8114 \begin_layout LyX-Code
8124 \begin_layout LyX-Code
8140 \begin_layout LyX-Code
8150 \begin_layout LyX-Code
8170 A detailed German description of such LaTeX commands can be found in the
8171 Koma-Script documentation
8176 With it, the letter's author can produce his personal letter layout.
8179 \begin_layout Standard
8188 define the beginning of the letter and must be used in every letter.
8189 To emphasize them in the LyX document class, they are marked with the letter
8199 \begin_inset space ~
8203 It is possible to write any number of letters in one file.
8208 type produces a new letter using the same addressee and a
8212 type produces a new addressee.
8229 are ordinary paragraph types and can also be used several times in one
8230 and the same letter.
8233 \begin_layout Itemize
8238 : produces a paragraph for the addressee and implicitly defines the beginning
8242 \begin_layout Itemize
8247 : produces a paragraph for the form of address and implicitly produces a
8251 \begin_layout Itemize
8256 : produces a paragraph for a close.
8259 \begin_layout Itemize
8264 : produces a paragraph for a postscript.
8267 \begin_layout Itemize
8272 : produces a paragraph for a distribution list.
8275 \begin_layout Itemize
8280 : produces a paragraph for enclosures.
8283 \begin_layout Standard
8324 are input types provided with a label to enter information, which will
8325 be processed by the document class.
8329 \begin_layout Plain Layout
8330 It could be seen as a matter of inconsequence, that the types
8338 described above are not such input types as well.
8339 Because of the special meaning of those types, however, I have implemented
8340 them as ordinary paragraph types with a one letter mark in the left margin.
8341 Moreover, it would affect my feeling of symmetry, if the
8349 type had such a serious different appearance.
8354 The types must be used ahead of the corresponding
8361 \begin_layout Standard
8362 An implementation of these types in a WYSIWYG fashion does not seem to make
8363 sense, because the real appearance of the produced letter does not only
8364 depend on the usage of the particular type, but also on other factors.
8365 For example, a signature entered in the
8369 type will in the standard behavior appear in the produced letter only,
8370 when in the same letter also a
8375 The entered value of the
8379 type will in the standard behavior not appear in the produced letter at
8381 The possibility to design the letter`s heading freely is already indicated
8382 in a footnote above.
8385 \begin_layout Standard
8386 The input types can also be used as empty paragraphs.
8388 \begin_inset space \thinspace{}
8392 \begin_inset space ~
8404 type is not used at all, in the standard behavior the value of the
8408 type is used as signature, whereas if an empty
8412 type is used, no signature value is defined.
8415 \begin_layout Standard
8416 By using the input types it is possible to write a letter template, containing
8417 filled input types with your personal dates (name, address, etc.) and empty
8418 input types for other dates you want to enter.
8421 \begin_layout Itemize
8426 : sender's name, in the standard behavior appears as a centered paragraph
8427 in small caps in the letter`s heading.
8430 \begin_layout Itemize
8435 : sender's signature, in the standard behavior appears below the
8444 type is used, the value of the
8448 type appears instead.
8451 \begin_layout Itemize
8456 : sender's address, in the standard behavior appears in a centered paragraph
8457 in the letter`s heading below the sender's name.
8460 \begin_layout Itemize
8465 : sender's telephone number, in the standard behavior only sets the LaTeX
8475 \begin_layout Itemize
8480 : place of the letter`s making.
8483 \begin_layout Itemize
8488 : date of the letter`s making.
8497 , in the standard behavior, produce the place and the date in a right-aligned
8498 line below the addressee's field.
8503 type is used, neither place nor date appear, independent of the value of
8513 type is used, the date of the letter `s production is used.
8516 \begin_layout Itemize
8521 : sender`s back address, in the standard behavior appears above the addressee's
8522 field in a small sans serif font.
8525 \begin_layout Itemize
8530 : special mail information, in the standard behavior appears underlined
8531 above the addressee's field below the back address.
8534 \begin_layout Itemize
8539 : additional information, in the standard behavior appears on right side
8540 below the addressee`s field.
8543 \begin_layout Itemize
8548 : the letter's title, in the standard behavior appears in a big, bold, sans
8549 serif font above the subject.
8552 \begin_layout Itemize
8557 : the letter's subject, in the standard behavior appears in a bold font
8565 \begin_layout Standard
8586 produce a business letter like line above the
8590 line containing the fields
8591 \begin_inset Quotes eld
8595 \begin_inset Quotes erd
8599 \begin_inset Quotes eld
8603 \begin_inset Quotes erd
8607 \begin_inset Quotes eld
8611 \begin_inset Quotes erd
8615 \begin_inset Quotes eld
8619 \begin_inset Quotes erd
8623 \begin_inset Quotes eld
8627 \begin_inset Quotes erd
8631 \begin_inset Quotes eld
8635 \begin_inset Quotes erd
8639 For the date field, the value of the
8645 \begin_inset Quotes eld
8648 business letter types
8649 \begin_inset Quotes erd
8652 is used, the value of the
8656 type however does not appear, but only the LaTeX variable
8663 The ordinary output of place and date in a right-aligned line below the
8664 addressee`s field is suppressed.
8665 The types are implemented as input types provided with a label and must
8666 be used ahead of the corresponding
8673 \begin_layout Itemize
8681 \begin_layout Itemize
8689 \begin_layout Itemize
8697 \begin_layout Itemize
8705 \begin_layout Itemize
8713 \begin_layout Subsection
8714 The new letter class: letter (koma-script v.2)
8717 \begin_layout Standard
8720 Jürgen Spitzmüller
8723 \begin_layout Standard
8724 \begin_inset VSpace medskip
8730 \begin_layout Standard
8732 Koma-Script version 2.8 has introduced a new letter class
8736 which supersedes the now unsupported
8741 It has --- on the LaTeX side --- a completely new interface and is not
8742 compatible with the old class.
8743 Therefore, LyX supports both, though it is recommended to use the new class.
8746 \begin_layout Standard
8747 This class covers the same functionality as
8749 letter (koma-script),
8756 (receiver's address, same as
8773 will start a new letter (i.
8774 \begin_inset space \thinspace{}
8778 \begin_inset space ~
8781 you can write several letters per document).
8782 New elements are sender's
8798 and the possibility to use a
8807 nsert\SpecialChar \menuseparator
8817 \begin_layout Standard
8818 The biggest improvement is, though, that the letter's layout is configurable
8819 at almost any needs.
8820 This can be done via the preamble or with a special style file (Letter
8821 Class Option, extension
8825 ), that will be read in as a class option.
8829 \begin_layout Plain Layout
8830 The KOMA package comes with some default
8835 There is, for instance, a
8839 file that follows german typesetting rules, or a
8843 that provides the default layout of the old
8848 The latter can be loaded with the class option
8857 ayout\SpecialChar \menuseparator
8862 ocument\SpecialChar \menuseparator
8874 template that is included in LyX for examples.
8875 A detailed description is to be found in the Koma-Script documentation
8883 \begin_layout Subsection
8887 \begin_layout Standard
8888 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8892 \begin_layout Itemize
8893 The chapter number of a
8897 type appears on a line of its own above the chapter heading instead of
8898 appearing in the same line ahead of it.
8899 The cause for that is the LyX internal behavior for the labeltype
8906 \begin_layout Itemize
8907 The headings of the types
8916 \begin_inset Quotes eld
8920 \begin_inset Quotes erd
8923 LaTeX table of contents, but not in the LyX table of contents (
8928 ocument\SpecialChar \menuseparator
8934 \begin_inset space ~
8938 \begin_inset space ~
8946 \begin_layout Itemize
8951 document class appear in a skip separation mode, not indented.
8952 This is the standard behavior, no special LaTeX commands are needed for
8959 ocument\SpecialChar \menuseparator
8966 dialog the corresponding radio button indicates
8982 value always has the effect that extra LaTeX commands are inserted in the
8983 document to produce the gap, which is not what is wanted in this case.
8986 \begin_layout Section
8994 \begin_layout Standard
9000 \begin_layout Subsection
9004 \begin_layout Standard
9005 These are the layout files for some of the journal formats used by Springer
9006 Verlag and listed on
9007 \begin_inset Flex URL
9010 \begin_layout Plain Layout
9012 http://www.springer.de/author/tex/help-journals.html
9017 , where you should also go to fetch the class files (yes, these are LaTeX2e
9019 It is a modular system: the things common to all journals are implemented
9024 , which journal-specific layout files (such as, e.
9025 \begin_inset space \thinspace{}
9032 for Journal of Geodesy) can include.
9035 \begin_layout Standard
9036 This means that implementing support for any other Springer journal on this
9037 list is as simple as writing your own
9045 file following the outline given in
9053 \begin_layout Standard
9054 It is reasonably well tested only for the Journal of Geodesy.
9063 come with the standard LyX distribution.
9064 Install the relevant class file (downloaded from Springer) in a proper
9065 directory, reconfigure LaTeX (in the teTeX case by running
9069 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9070 LyX and it should work.
9073 \begin_layout Subsection
9077 \begin_layout Standard
9078 A large number of theorem-like styles ---
9084 \SpecialChar \ldots{}
9090 \begin_layout Standard
9093 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9094 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9097 See the Springer class file documentation for details.
9100 \begin_layout Subsection
9104 \begin_layout Itemize
9116 \begin_layout Itemize
9119 Probability Theory and Related Fields
9125 --- Jean-Marc Lasgouttes
9128 \begin_layout Standard
9129 Add your own, it isn't so hard!
9132 \begin_layout Subsection
9136 \begin_layout Standard
9137 These files are partly based on the older
9141 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9147 layout, are now defunct.
9148 Jean-Marc Lasgouttes helped out big in making me find my way around the
9149 LyX layout file mechanism.
9152 \begin_layout Subsection
9156 \begin_layout Standard
9158 But probably less than in the old hacked-LaTeX
9165 \begin_layout Standard
9167 \begin_inset space \thinspace{}
9170 g.: does not display the number for theorem-like layouts, just #.
9173 \begin_layout Section
9181 \begin_layout Standard
9187 \begin_layout Subsection
9191 \begin_layout Standard
9192 These are the layout files for some of the journals of the American Geophysical
9194 It is assumed that you have both the AGU's own class files and AGUplus
9195 installed (everything to be found at
9196 \begin_inset Flex URL
9199 \begin_layout Plain Layout
9201 ftp://ftp.agu.org/journals/latex/journals
9209 \begin_layout Subsection
9213 \begin_layout Standard
9223 They are still called this in the LyX GUI, though their LaTeX equivalents
9224 in the AGU classes are
9235 \begin_layout Standard
9236 Newly defined styles are
9273 These are mostly manuscript attributes and defined in the AGU class documentati
9277 \begin_layout Standard
9278 I suspect this is still badly incomplete.
9281 \begin_layout Subsection
9285 \begin_layout Standard
9302 \begin_layout Subsection
9306 \begin_layout Itemize
9309 Journal of Geophysical Research
9318 \begin_layout Standard
9319 Add your own, it isn't so hard! Look at the
9330 \begin_layout Subsection
9331 Bugs and things to remember
9334 \begin_layout Standard
9335 In order to use the new layouts, you must remember to do the following for
9339 \begin_layout Enumerate
9345 This can be done in the
9347 layout\SpecialChar \menuseparator
9352 document\SpecialChar \menuseparator
9356 (AGU articles are always in English, right? So
9363 \begin_layout Enumerate
9373 (Yes, this is a bug.)
9376 \begin_layout Enumerate
9377 Make sure you use the
9381 bibliography style, by entering
9385 into the second field of the BibTeX inset.
9386 None of the standard styles will do.
9389 \begin_layout Section
9397 \begin_layout Standard
9403 \begin_layout Subsection
9407 \begin_layout Standard
9408 This is the layout file for the European Geophysical Society journals.
9413 can be downloaded from the web site of the EGS under
9414 \begin_inset Flex URL
9417 \begin_layout Plain Layout
9427 \begin_layout Subsection
9431 \begin_layout Standard
9434 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9442 The current layout file is unfortunately very unmodular and would benefit
9443 from using the various
9450 \begin_layout Section
9456 \begin_inset CommandInset label
9465 \begin_layout Standard
9473 \begin_layout Subsection
9477 \begin_layout Standard
9478 This section describes how to use LyX to make slides for overhead projectors.
9479 There are two document classes that can do this: the default slides class
9485 This section documents the former.
9488 \begin_layout Standard
9489 I'm going to say this again, nice and clear, so that there's no misunderstanding
9493 \begin_layout Standard
9494 \begin_inset VSpace bigskip
9500 \begin_layout Standard
9504 This section documents the class
9505 \begin_inset Quotes eld
9513 \begin_inset Quotes erd
9521 \begin_layout Standard
9522 \begin_inset VSpace bigskip
9528 \begin_layout Standard
9529 If you're looking for the documentation for
9530 \begin_inset Quotes eld
9538 \begin_inset Quotes erd
9542 \begin_inset space ~
9546 \begin_inset CommandInset ref
9548 reference "sec:foiltex"
9558 \begin_inset Quotes eld
9566 \begin_inset Quotes erd
9569 ] is actually somewhat better than the default
9577 \begin_layout Plain Layout
9578 \SpecialChar \ldots{}
9579 or so I've been told repeatedly by its advocates.
9580 Having never used it, I have no idea if this claim is true or not.
9585 which this section documents.
9588 \begin_layout Standard
9589 This class is the LaTeX2e improvement of the old
9594 Every LaTeX2e distribution includes this class [which I'll just refer to
9596 \begin_inset Quotes eld
9604 \begin_inset Quotes erd
9607 from now on], so you're bound to have it.
9608 As I noted earlier, there are other classes, such as
9612 , which also produce slides for overhead projectors and do a better job
9614 However, there are some things which
9618 can do which the others can't, such as generate overlays.
9619 Read on to learn more!
9622 \begin_layout Subsection
9624 \begin_inset CommandInset label
9626 name "sec:slidesetup"
9633 \begin_layout Standard
9634 Obviously, to use this document class, you need to select
9635 \begin_inset Quotes eld
9643 \begin_inset Quotes erd
9646 from the class list in the
9651 ocument\SpecialChar \menuseparator
9659 There are some other special things you should know about this class:
9662 \begin_layout Itemize
9663 Don't bother changing the options
9668 They're not supported by the
9675 \begin_layout Itemize
9682 \begin_inset space ~
9687 behaves a bit differently for this class.
9688 The possible choices and what they do are as follows:
9692 \begin_layout Description
9697 The final output contains page numbers in the lower right corner.
9700 \begin_layout Description
9709 , but also prints out any time markers you've put in.
9710 This is the default.
9713 \begin_layout Description
9718 The final output contains no page numbers, time markers, or alignment markers.
9722 \begin_layout Itemize
9727 class has an extra option:
9733 \begin_inset Quotes eld
9741 \begin_inset Quotes erd
9744 in the extra class options.
9748 \begin_layout Standard
9749 Using this options allows you to add time markers to
9755 \begin_inset space ~
9759 \begin_inset CommandInset ref
9761 reference "sec:slideNote"
9769 \begin_layout Standard
9770 You can also use the template file
9771 \begin_inset Quotes eld
9779 \begin_inset Quotes erd
9782 to automatically set up a document to use the
9791 ile\SpecialChar \menuseparator
9793 \begin_inset space ~
9797 \begin_inset space ~
9806 to open your new document].
9807 The template file also contains some examples of the special paragraph
9808 environments used by this class.
9809 I'll describe those next.
9812 \begin_layout Subsection
9813 Paragraph Environments
9816 \begin_layout Subsubsection
9817 Supported Environments
9820 \begin_layout Standard
9821 The first thing you'll notice when you start up a new
9825 document is the font size and type: it's the equivalent of the size
9826 \begin_inset Quotes eld
9834 \begin_inset Quotes erd
9840 \begin_inset space ~
9846 This is also what's used in the output.
9848 \begin_inset Quotes eld
9852 \begin_inset Quotes erd
9855 to remind you that this is a slide.
9856 Your final slides will use a larger font; ergo, you'll have less space.
9857 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9860 \begin_layout Standard
9861 The next thing that becomes obvious is the changes to the paragraph environment
9862 pull-down box [at the far-left end of the toolbar].
9863 Most of the paragraph environments you're used to seeing are missing.
9864 There are also five new ones.
9869 class itself only supports certain paragraph environments:
9872 \begin_layout Itemize
9878 \begin_layout Itemize
9884 \begin_layout Itemize
9890 \begin_layout Itemize
9896 \begin_layout Itemize
9902 \begin_layout Itemize
9908 \begin_layout Itemize
9914 \begin_layout Itemize
9920 \begin_layout Itemize
9926 \begin_layout Itemize
9932 \begin_layout Itemize
9938 \begin_layout Standard
9939 All of the other standard environments, including the section-heading environmen
9940 ts, aren't used in the
9947 \begin_layout Standard
9948 On the other hand, you'll notice the following new environments:
9951 \begin_layout Itemize
9957 \begin_layout Itemize
9963 \begin_layout Itemize
9969 \begin_layout Itemize
9975 \begin_layout Itemize
9981 \begin_layout Standard
9982 These five are kind of quirky, due to a
9983 \begin_inset Quotes eld
9987 \begin_inset Quotes erd
9991 You see, LyX doesn't permit you to nest any other paragraph environment
9992 into an empty environment.
9993 Now, that's fine and dandy, but it means that you wouldn't be able to start
9994 a slide with anything except plain text.
9995 To deal with this, I've performed a little
9996 \begin_inset Quotes eld
10000 \begin_inset Quotes erd
10006 \begin_layout Subsubsection
10007 Quirks of the New Environments
10008 \begin_inset CommandInset label
10010 name "sec:slideQuirk"
10017 \begin_layout Standard
10018 All five of the new paragraph environments are somewhat quirky due to inherent
10019 limitiations in the current version of LyX.
10020 As I just mentioned, LyX forbids environments that begin with another environme
10022 To get around this, the
10026 environment isn't a paragraph environment as described in the
10034 \begin_layout Standard
10035 You should consider
10048 \begin_inset Quotes eld
10051 pseudo-environments.
10052 \begin_inset Quotes erd
10055 They look like a section heading or a
10056 \begin_inset Quotes eld
10064 \begin_inset Quotes erd
10067 but really begin a [and, if necessary, end the previous] paragraph environment.
10077 \begin_inset Quotes eld
10081 \begin_inset Quotes erd
10084 These two perform some action.
10087 \begin_layout Standard
10088 A common feature of all five environments,
10108 , is a rather long-ish label.
10109 The text following this label --- ordinarily the contents of the paragraph
10110 environment --- is utterly irrelevant for
10131 LyX completely ignores it.
10132 In fact, you can leave these five environments completely empty.
10136 \begin_layout Standard
10141 to put any text after the rather long-ish label, you might want to.
10142 This could be a short description of the contents of the
10147 In that case, enter in your descriptive comment and hit
10151 as you normally would.
10154 \begin_layout Standard
10155 If, on the other hand, you don't want to enter in any descriptive text,
10156 you'll hit another LyX quirk.
10157 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10158 environment until you put something in the old one.
10162 \begin_layout Itemize
10163 Start entering the text that will
10191 \begin_layout Itemize
10192 Now move to the beginning of that paragraph.
10196 \begin_layout Itemize
10205 \begin_layout Itemize
10206 Finally, change this new, empty paragraph to a
10230 \begin_layout Standard
10231 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10235 \begin_layout Subsection
10236 Making a Presentation with
10249 \begin_layout Subsubsection
10257 \begin_layout Standard
10258 If you're expecting this section to teach you how to actually make a presentatio
10259 n, you'll be sorely disappointed.
10260 Naturally, I'll describe all of the ways the
10264 class can assist you in preparing the materials for a presentation.
10265 Filling in the contents, however, is up to you.
10270 the LyX philosophy.]
10273 \begin_layout Standard
10278 environment [in the manner described in section
10279 \begin_inset space ~
10283 \begin_inset CommandInset ref
10285 reference "sec:slideQuirk"
10289 ] tells LyX to begin a new slide [duh].
10290 The label for this environment/
10291 \begin_inset Quotes erd
10295 \begin_inset Quotes erd
10299 \begin_inset Quotes eld
10303 \begin_inset Quotes erd
10306 in cool blue, followed by the label,
10307 \begin_inset Quotes eld
10311 \begin_inset Quotes erd
10315 Any text or paragraph environments that follow this one go on the new slide.
10319 \begin_layout Standard
10320 Slides are probably the only time you'll need to forcibly end pages in LyX
10321 (this can be specified in the
10326 In fact, you'll want to, once you finish entering the contents of one slide.
10327 If you've entered more text than can physically fit on a slide, the extra
10328 overflows onto a new slide.
10329 I don't recommend doing this, however, since the overflow slide won't have
10330 any page number on it.
10331 Furthermore, it may interfere with any
10335 you've made to accompany the oversized
10342 \begin_layout Standard
10351 environments work the same way as the
10356 They both create an
10357 \begin_inset Quotes eld
10361 \begin_inset Quotes erd
10364 followed by a label [
10365 \begin_inset Quotes eld
10369 \begin_inset Quotes erd
10373 \begin_inset Quotes eld
10377 \begin_inset Quotes erd
10381 The color is a stunning magenta instead of blue, and the
10382 \begin_inset Quotes eld
10386 \begin_inset Quotes erd
10389 will look different, in style and in length.
10390 The label fonts of all three also differ from one another.
10393 \begin_layout Standard
10398 , if the contents of a
10406 exceed the physical size of a slide or sheet of paper, the extra will overflow
10408 Again, you should avoid this.
10409 It defeats the whole purpose of
10420 \begin_layout Subsubsection
10430 \begin_layout Standard
10435 is a slide that sits atop another slide.
10436 Perhaps you wish to discuss a figure on the main
10440 before displaying the text associated with it.
10441 One way to accomplish this is tape a flap of dark paper over the part of
10446 you want to display later.
10447 This method fails, however, if you wish to overlap one graph with another,
10449 You would then have to fumble while speaking to align the two separate,
10454 s to align the two graphs.
10459 environment in both cases makes life much easier.
10462 \begin_layout Standard
10467 receives the page number of its
10468 \begin_inset Quotes eld
10472 \begin_inset Quotes erd
10480 \begin_inset Quotes eld
10488 \begin_inset Quotes erd
10495 \begin_layout Plain Layout
10496 Presumably, mutliple
10501 \begin_inset Quotes eld
10509 \begin_inset Quotes erd
10513 \begin_inset Quotes eld
10521 \begin_inset Quotes erd
10525 \begin_inset Quotes eld
10533 \begin_inset Quotes erd
10537 \begin_inset space ~
10540 appended to the page number of the parent
10550 Clearly, you want the contents of both the
10558 to each fit on a single physical slide! You should probably consider an
10564 \begin_inset Quotes eld
10568 \begin_inset Quotes erd
10580 class provides a visual cue for this: the label at the start of an
10584 is shorter than that at the start of a
10589 Lastly, when you generate printable output, you'll find alignment markers
10590 in all four corners of both the
10594 page and its parent
10599 These will assist you in lining up the two physical slides.
10602 \begin_layout Standard
10603 The major problem in overlaying two slides is aligning the contents of the
10604 two transparencies.
10605 How much space should you leave for that graph on the second slide? Worse
10606 still, what if you want a graph and a sentence on second slide, but there
10607 is text on the main transparency that goes in between them? You could try
10608 and insert vertical space of the right size.
10609 The better way is to use
10620 \begin_layout Standard
10621 As their names imply,
10629 are two command-like paragraph environments that make all subsequent text
10630 invisible and visible, respectively.
10632 \begin_inset space ~
10636 \begin_inset CommandInset ref
10638 reference "sec:slideQuirk"
10642 that you don't place anything
10646 these two environments, however.
10651 , it inserts a centered, sky-blue label into the page reading
10652 \begin_inset Quotes eld
10655 <Invisible Text Follows>
10656 \begin_inset Quotes erd
10660 For paragraphs following this label, the parts of the
10668 ; it doesn't matter which] where they would be contain instead blank space.
10672 \begin_layout Standard
10677 , the corresponding centered label is
10678 \begin_inset Quotes eld
10681 <Visible Text Follows>
10682 \begin_inset Quotes erd
10686 Paragraphs following this label behave normally.
10687 Note that the beginning of a new
10699 automatically shuts off an
10704 It's therefore not necessary to use
10715 \begin_layout Standard
10716 By now, it should be obvious how to create overlay transparencies using
10717 the proper combination of
10736 \begin_layout Enumerate
10741 , including everything that will appear on it, whether on the main slide
10749 \begin_layout Enumerate
10750 Before each figure or paragraph that will appear only on the
10759 If necessary, insert a
10763 environment after the
10770 \begin_layout Enumerate
10775 immediately following the
10782 \begin_layout Enumerate
10783 Copy the contents of this
10794 \begin_layout Enumerate
10799 , change all of the
10810 \begin_layout Standard
10812 You've just made an
10819 \begin_layout Standard
10820 There's one problem with the way I've designed the LyX
10824 class: you can't make text in the middle of a paragraph invisible, nor
10825 make text in the middle of an invisible paragraph visible again.
10826 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10830 \begin_layout Plain Layout
10831 The commands of interest are:
10834 \begin_layout Itemize
10839 invisible \SpecialChar \ldots{}
10843 \begin_layout Itemize
10848 visible \SpecialChar \ldots{}
10852 \begin_layout Plain Layout
10853 \SpecialChar \ldots{}
10854 and need to be marked as TeX.
10856 \begin_inset Quotes eld
10860 \begin_inset Quotes erd
10863 you wish to change goes in between the brackets [and after the
10876 If you don't know how to mark text as TeX, see the appropriate section
10889 \begin_layout Subsubsection
10899 \begin_inset CommandInset label
10901 name "sec:slideNote"
10908 \begin_layout Standard
10917 is associated with a
10918 \begin_inset Quotes eld
10922 \begin_inset Quotes erd
10934 class provides visual cues.
10939 is shorter than that of a
10943 [yet longer than that of an
10947 ] and, like the label of an
10951 is shockingly magenta.
10952 Additionally, the printed
10956 has the page number of its
10957 \begin_inset Quotes eld
10961 \begin_inset Quotes erd
10969 \begin_inset Quotes eld
10977 \begin_inset Quotes erd
10981 \begin_inset Quotes eld
10989 \begin_inset Quotes erd
10993 \begin_inset Quotes eld
11001 \begin_inset Quotes erd
11005 You can have multiple
11009 s associated with a single
11021 , you'll probably want to break up long
11025 s so that they fit on a single sheet of paper.
11028 \begin_layout Standard
11033 is obvious: it contains anything additional you might want to say about
11039 It could also be used as a sheet of reminders for a particular
11044 In the case of the latter, you might want to make use of time markers.
11050 \begin_inset Quotes eld
11054 \begin_inset Quotes erd
11057 support for time markers, a
11062 So, you'll have to resort to using the LaTeX codes.
11065 \begin_layout Standard
11066 To use time markers, you'll need to specify the extra class option
11067 \begin_inset Quotes eld
11075 \begin_inset Quotes erd
11079 \begin_inset space ~
11083 \begin_inset CommandInset ref
11085 reference "sec:slidesetup"
11090 This option turns on timing marks, which will appear in the lower-left-hand
11096 To set what appears in the time marker, you use the LaTeX commands
11097 \begin_inset Quotes eld
11107 \begin_inset Quotes erd
11111 \begin_inset Quotes eld
11121 \begin_inset Quotes erd
11125 The arguments of both commands are time measured in seconds.
11127 \begin_inset Quotes eld
11137 \begin_inset Quotes erd
11140 sets the time marker to a given time.
11142 \begin_inset Quotes eld
11152 \begin_inset Quotes erd
11155 increments the time marker by the specified amount.
11156 Using time markers and
11160 s in this fashion, you can remind yourself how much time to spend on a particula
11168 \begin_layout Standard
11169 There's one last feature to describe.
11170 Clearly, you'd like to print out all of your
11178 s on transparencies while printing all of your
11195 with which it is associated.
11196 What's a person to do?
11199 \begin_layout Standard
11200 Luckily, there are two LaTeX commands that allow you to select what to print
11202 Both must be placed into the preamble of your document.
11204 \begin_inset Quotes eld
11216 \begin_inset Quotes erd
11219 will cause the output to contain only the
11228 Correspondingly, the command
11229 \begin_inset Quotes eld
11241 \begin_inset Quotes erd
11244 prevents the output of anything but
11249 I'd advise placing both commands in the preamble and initially comment
11251 You can then preview your entire presentation as you write.
11252 When you're done writing, you can then uncomment one of the two to select
11253 what you want to print.
11254 I like to uncomment
11255 \begin_inset Quotes eld
11267 \begin_inset Quotes erd
11270 , print to a file with
11271 \begin_inset Quotes eld
11279 \begin_inset Quotes erd
11282 in its name, comment it back out, then uncomment
11283 \begin_inset Quotes eld
11295 \begin_inset Quotes erd
11299 \begin_inset Quotes eld
11307 \begin_inset Quotes erd
11311 I can then send either file to a printer, loading transparencies or plain
11312 paper as appropriate.
11315 \begin_layout Standard
11316 You can also provide other arguments to the
11317 \begin_inset Quotes eld
11327 \begin_inset Quotes erd
11331 \begin_inset Quotes eld
11341 \begin_inset Quotes erd
11345 See a good LaTeX book for details.
11348 \begin_layout Subsection
11353 Class Template File
11356 \begin_layout Standard
11357 I have also provided a template file,
11358 \begin_inset Quotes eld
11366 \begin_inset Quotes erd
11374 To use it, begin your new presentation with
11379 ile\SpecialChar \menuseparator
11381 \begin_inset space ~
11385 \begin_inset space ~
11395 Your new LyX presentation file will contain an example
11416 additionally contain an example of the use of
11425 Lastly, the preamble will contain:
11428 \begin_layout LyX-Code
11429 % Uncomment to print out only slides and overlays
11432 \begin_layout LyX-Code
11436 \begin_layout LyX-Code
11442 \begin_inset Newline newline
11448 \begin_layout LyX-Code
11449 % Uncomment to print out only notes
11452 \begin_layout LyX-Code
11456 \begin_layout LyX-Code
11464 \begin_layout Standard
11465 One final thing: I created this class to support the LaTeX2e
11466 \begin_inset Quotes eld
11474 \begin_inset Quotes erd
11477 class, one of the built-in LaTeX2e classes.
11478 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11479 built-in slide class.
11480 It's here if you want it or need it.
11481 There exist other LaTeX2e classes for creating presentations, such as the
11487 \begin_inset space ~
11491 \begin_inset CommandInset ref
11493 reference "sec:foiltex"
11498 \begin_inset Quotes eld
11506 \begin_inset Quotes erd
11509 package [present on some TeX distributions].
11510 The latter is not yet supported under LyX.
11514 \begin_layout Plain Layout
11515 Perhaps you can take on the task\SpecialChar \ldots{}
11521 I know nothing about these other classes.
11522 Try them out to see what sort of alternative they provide.
11525 \begin_layout Section
11534 \begin_inset CommandInset label
11543 \begin_layout Standard
11549 \begin_layout Subsection
11553 \begin_layout Standard
11554 This section describes how to use LyX to make slides for overhead projectors.
11555 There are two document classes that can do this: the default slides class
11561 This section documents the latter.
11564 \begin_layout Standard
11565 I'm going to say this again, nice and clear, so that there's no misunderstanding
11569 \begin_layout Standard
11570 \begin_inset VSpace bigskip
11576 \begin_layout Standard
11580 This section documents the class
11581 \begin_inset Quotes eld
11589 \begin_inset Quotes erd
11597 \begin_layout Standard
11598 \begin_inset VSpace bigskip
11604 \begin_layout Standard
11605 If you're looking for the documentation for
11606 \begin_inset Quotes eld
11614 \begin_inset Quotes erd
11617 , check out section
11618 \begin_inset space ~
11622 \begin_inset CommandInset ref
11624 reference "sec:slitex"
11629 If your machine doesn't have the
11634 \begin_inset Quotes eld
11642 \begin_inset Quotes erd
11645 ] installed, you'll probably have to use the default
11649 class, which isn't quite as good as
11654 \begin_layout Standard
11659 class is designed for use with version 2.1 of the
11663 LaTeX class file which is now an integral part of LaTeX2e.
11666 \begin_layout Subsection
11670 \begin_layout Standard
11671 Obviously, to use this document class, you need to select
11672 \begin_inset Quotes eld
11680 \begin_inset Quotes erd
11693 \begin_inset space ~
11699 There are some settings in the
11702 \begin_inset space ~
11707 dialog that you should know about that are specific to this class:
11710 \begin_layout Itemize
11711 Don't change the options
11722 \begin_inset space ~
11728 They're ignored by the
11735 \begin_layout Itemize
11736 The default font size is 20pt with the other options being 17pt, 25pt and
11740 \begin_layout Itemize
11741 The default font is
11749 but all math equations are still typeset in the usual roman font.
11752 \begin_layout Itemize
11757 TeX supports A4 and Letter paper sizes as well as a special size for working
11759 It doesn't support A5, B5, legal or executive paper sizes.
11762 \begin_layout Itemize
11763 Don't bother changing the
11767 settings because they are ignored anyway.
11768 All floats appear where they are defined in the text.
11771 \begin_layout Itemize
11779 setting behaves a bit differently for this class.
11784 TeX provides extensive footer and header capabilities including a user-defined
11787 \begin_inset space ~
11791 \begin_inset CommandInset ref
11793 reference "sec:foilfoot"
11798 The title page is treated differently to all other pages in the document
11807 has the logo centered at the bottom of the page (if one is defined).
11808 The possible page style choices and what they do are as follows:
11812 \begin_layout Labeling
11813 \labelwidthstring MMMMMMM
11820 The final output contains no page numbers, or other headers or footers
11821 (except footnotes of course).
11825 \begin_layout Labeling
11826 \labelwidthstring MMMMMMM
11833 The final output contains page numbers centered at the bottom of the page.
11834 No other headings or footers (other than footnotes).
11837 \begin_layout Labeling
11838 \labelwidthstring MMMMMMM
11843 Page numbers in lower right corner.
11844 Additional headers and footers are also shown.
11845 This is also the default.
11848 \begin_layout Labeling
11849 \labelwidthstring MMMMMMM
11854 Gives you access to the
11858 package although its use with
11862 TeX is discouraged by the writer of the
11866 TeX package because of some potential page layout clashes.
11870 \begin_layout Subsubsection
11874 \begin_layout Standard
11875 The following options may be used in the extra class options in the
11880 ocument\SpecialChar \menuseparator
11890 \begin_layout Labeling
11891 \labelwidthstring MMMMMMx
11896 This sets up the page layout for 7.33in by 11in paper, which is about the
11897 same aspect ratio as a 35mm slide, making it a bit easier to work with
11901 \begin_layout Labeling
11902 \labelwidthstring MMMMMMx
11907 Places a rule across the page below the header on every page except the
11911 \begin_layout Labeling
11912 \labelwidthstring MMMMMMx
11917 Places a rule across the page above the footer on every page except the
11921 \begin_layout Labeling
11922 \labelwidthstring MMMMMMx
11927 This is automatically set each time you create a new
11936 TeX to use the dvips driver to rotate those pages that are set as landscape
11940 \begin_layout Labeling
11941 \labelwidthstring MMMMMMx
11946 Simply changes the page dimensions to those of a landscape page but doesn't
11948 Thus if you use this option you need to use an external program to rotate
11949 each page or feed your paper through your printer as landscape.
11950 Note that this option effectively reverses the roles of the
11958 environments (don't worry these are described in the next section).
11961 \begin_layout Labeling
11962 \labelwidthstring MMMMMMx
11967 Equation numbers on the left.
11970 \begin_layout Labeling
11971 \labelwidthstring MMMMMMx
11976 Flush-left equations.
11979 \begin_layout Subsection
11980 Supported Environments
11983 \begin_layout Standard
11984 Most of the environments commonly supported in other classes are also supported
11990 There are several additional environments provided by
11994 TeX as well as a couple added by LyX.
11995 The following environments are shared with other classes:
11998 \begin_layout Standard
12002 \begin_layout Plain Layout
12006 begin{multicols}{2}
12014 \begin_layout Itemize
12020 \begin_layout Itemize
12026 \begin_layout Itemize
12032 \begin_layout Itemize
12038 \begin_layout Itemize
12044 \begin_layout Itemize
12050 \begin_layout Itemize
12056 \begin_layout Itemize
12062 \begin_layout Itemize
12068 \begin_layout Itemize
12074 \begin_layout Itemize
12080 \begin_layout Itemize
12086 \begin_layout Itemize
12092 \begin_layout Itemize
12098 \begin_layout Itemize
12104 \begin_layout Itemize
12110 \begin_layout Itemize
12116 \begin_layout Itemize
12122 \begin_layout Standard
12126 \begin_layout Plain Layout
12138 \begin_layout Standard
12139 That is, all the major environments apart from the sectioning environments.
12140 Since foils are essentially self-contained sections, with a title and body,
12145 TeX provides specific commands for starting new foils and these are:
12148 \begin_layout Itemize
12154 \begin_layout Itemize
12160 \begin_layout Standard
12161 LyX also provides slightly modified versions of these two environments called:
12164 \begin_layout Itemize
12170 \begin_layout Itemize
12173 ShortRotatefoilhead
12176 \begin_layout Standard
12177 and the differences will be explained in the next section.
12180 \begin_layout Standard
12181 Since foils are often used in presenting ideas or new theorems and such
12186 TeX also provides a comprehensive box of goodies for presenting them:
12189 \begin_layout Standard
12193 \begin_layout Plain Layout
12197 begin{multicols}{2}
12205 \begin_layout Itemize
12211 \begin_layout Itemize
12217 \begin_layout Itemize
12223 \begin_layout Itemize
12229 \begin_layout Itemize
12235 \begin_layout Itemize
12241 \begin_layout Itemize
12247 \begin_layout Itemize
12253 \begin_layout Itemize
12259 \begin_layout Itemize
12265 \begin_layout Itemize
12271 \begin_layout Standard
12275 \begin_layout Plain Layout
12287 \begin_layout Standard
12288 The starred versions are unnumbered while the unstarred versions are numbered.
12289 There are also two list environments added by LyX and these are:
12292 \begin_layout Itemize
12298 \begin_layout Itemize
12304 \begin_layout Standard
12309 TeX provides some powerful header and footer capabilities that are best
12310 set in the preamble although they may be set at any point in a document.
12311 If you want to change these settings in your document the best place to
12312 do so is at the very top of a foil,
12317 straight after the foilhead.
12320 \begin_layout Standard
12321 For this purpose, the following command styles are provided [
12328 \begin_layout Standard
12332 \begin_layout Plain Layout
12336 begin{multicols}{2}
12344 \begin_layout Itemize
12348 \begin_inset space ~
12354 \begin_layout Itemize
12360 \begin_layout Itemize
12364 \begin_inset space ~
12370 \begin_layout Itemize
12374 \begin_inset space ~
12380 \begin_layout Itemize
12384 \begin_inset space ~
12391 \begin_layout Standard
12392 \begin_inset space ~
12399 \begin_layout Standard
12403 \begin_layout Plain Layout
12415 \begin_layout Standard
12416 There are also a few commands provided by
12420 TeX that aren't directly supported by LyX but I'll tell you what they do
12421 and how to use them in section
12422 \begin_inset space ~
12426 \begin_inset CommandInset ref
12428 reference "sec:unsuppfoils"
12435 \begin_layout Subsection
12436 Building a Set of Foils
12439 \begin_layout Standard
12440 This section will give a simple introduction to using the different environments
12441 to build a set of foils.
12442 If you want to see an example set of foils, take a look at the
12446 file you find in LyX's
12453 \begin_layout Subsubsection
12454 Give It a Title Page
12457 \begin_layout Standard
12458 Unlike other classes that provide
12478 creates the title on a page of its own.
12479 If you leave out the
12483 environment LaTeX will substitute the current date (every time you regenerate
12487 \begin_layout Subsubsection
12491 \begin_layout Standard
12492 As I mentioned earlier, there are four ways of starting a new foil.
12493 For portrait foils you should use
12502 The difference between these two environments is the amount of space between
12503 the title of the foil (the foilhead) and the body of the foil.
12506 \begin_layout Standard
12507 Landscape foils are generated using the
12513 ShortRotatefoilhead
12516 Again the only difference is the spacing between foilhead and body.
12517 Both of the short versions have 0.5 inches less separation between the foilhead
12522 \begin_layout Standard
12523 One problem with the support for landscape foils is the requirement that
12524 you have to use the
12528 driver to generate the PostScript output otherwise the foils won't be rotated.
12529 It is possible to get landscape foils even if you haven't got the
12533 driver provided you can feed your foils sideways through your printer ;-)
12536 \begin_layout Subsubsection
12537 Theorems, Lemmas, Proofs and more
12540 \begin_layout Standard
12541 Due to a small bug in LyX you can't have two of the same type of these environme
12542 nts directly following each other.
12543 They must be separated by something.
12544 If you try, you will just be extending the previous environment as if you
12545 had merged the two environments together.
12546 So, how do you get around this problem? The simplest option is to insert
12547 some text between the two environments or add a
12551 environment between the two with just a
12552 \begin_inset Quotes eld
12560 \begin_inset Quotes erd
12564 This will force LyX to produce two separate environments and hence the
12565 correct LaTeX output.
12566 An example is provided in the example file included with the LyX distribution.
12567 Remember, this problem only occurs if you are trying to place two of the
12568 same type of theorem-like environments one directly after the other.
12571 \begin_layout Subsubsection
12575 \begin_layout Standard
12576 You get all the commonly supported list styles found in other classes as
12577 well as two new ones.
12578 I'll only describe the new ones here.
12579 If you want to find out more about the other list environments check out
12585 If you intend to use itemized lists you might also want to read about the
12589 \begin_inset space ~
12593 \begin_inset space ~
12598 dialog described above in section
12599 \begin_inset space ~
12603 \begin_inset CommandInset ref
12605 reference "sec:bullet"
12612 \begin_layout Standard
12613 The two new list styles,
12621 , are designed to make it easier for you to create lists of do's and don'ts
12622 or right and wrong by providing dedicated environments that use a tick
12623 or a cross as the label of the list.
12624 These lists are in fact dedicated variants of the
12629 They do however require that you have the
12633 packages installed.
12636 \begin_layout Subsubsection
12640 \begin_layout Standard
12645 TeX redefines the floating tables and figures so that they appear exactly
12646 where they are in the text rather than pushing them to the top of the page
12647 or to some user specified location.
12648 In fact if you change the float placement settings they are simply ignored.
12651 \begin_layout Subsubsection
12652 Page Headers and Footers
12653 \begin_inset CommandInset label
12655 name "sec:foilfoot"
12662 \begin_layout Standard
12666 \begin_inset space ~
12675 are two commands used to control the left-footer text string.
12676 The first is meant to allow you to include a graphic logo on your foils
12678 \begin_inset Quotes eld
12686 \begin_inset Quotes erd
12690 While the second is meant to provide a classification for the audience,
12694 \begin_inset space \thinspace{}
12700 \begin_inset space ~
12704 It is empty by default.
12707 \begin_layout Standard
12708 The remaining page corners can be filled by
12711 \begin_inset space ~
12716 (which defaults to page numbers),
12719 \begin_inset space ~
12727 \begin_inset space ~
12735 \begin_layout Subsection
12741 \begin_inset CommandInset label
12743 name "sec:unsuppfoils"
12750 \begin_layout Standard
12751 All the commands mentioned below need to be set in a
12759 within another environment.
12762 \begin_layout Subsubsection
12766 \begin_layout Standard
12767 All lengths are adjusted using the
12790 should be replaced by the name given to the length you want to change and
12795 is the length value.
12796 All lengths should be specified in units of length such as inches (
12808 ) or relative to some document or font-based length such as
12818 \begin_layout Standard
12819 It's possible to change the spacing between a foilhead and the body of the
12820 foil by adjusting the length specified by
12827 For example, to make
12831 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12838 foilheadskip}{-0.5in}
12841 \begin_layout Standard
12842 The spacings around floats can be adjusted by setting these lengths:
12845 \begin_layout Labeling
12846 \labelwidthstring MMMMMMMMMMM
12853 Separation between the text and the top of the float
12856 \begin_layout Labeling
12857 \labelwidthstring MMMMMMMMMMM
12864 Separation between the float and the caption
12867 \begin_layout Labeling
12868 \labelwidthstring MMMMMMMMMMM
12875 Separation between the caption and the following text
12878 \begin_layout Labeling
12879 \labelwidthstring MMMMMMMMMMM
12886 You can make the captions narrower than the surrounding text by adjusting
12888 Best done relative to
12897 \begin_layout Standard
12898 There are also several title page related lengths that you may find useful
12899 if you have a long title or several authors:
12902 \begin_layout Labeling
12903 \labelwidthstring MMMMMMMMMMM
12910 Separation from headers to
12915 \begin_layout Labeling
12916 \labelwidthstring MMMMMMMMMMM
12934 \begin_layout Labeling
12935 \labelwidthstring MMMMMMMMMMM
12949 \begin_layout Labeling
12950 \labelwidthstring MMMMMMMMMMM
12966 \begin_layout Labeling
12967 \labelwidthstring MMMMMMMMMMM
12983 \begin_layout Standard
12984 The last length related command affects all the list environments.
12995 a list environment then all the vertical spacing between the list items
12997 Note that this is a command not a length so it doesn't require
13003 like the stuff mentioned above.
13006 \begin_layout Subsubsection
13007 Headers and Footers
13010 \begin_layout Standard
13023 commands control whether the logo in the
13027 definition appear on a given page.
13034 in the preamble then none of the foils will have the logo on them.
13035 If you don't want the logo on a particular page place the
13041 directly after the foilhead of that page and the
13047 directly after the next foilhead.
13050 \begin_layout Standard
13051 If you decide to use the
13055 page style setting in the
13058 \begin_inset space ~
13063 dialog you should probably add
13073 to your preamble so headers and footers on landscape pages are correctly
13074 placed when rotated.
13075 This is due to some clashes between the page layouts provided by the
13086 \begin_layout Section
13087 Latex8 (IEEE Conference Papers)
13090 \begin_layout Standard
13096 \begin_layout Subsection
13100 \begin_layout Standard
13101 Since this class is specifically for writing submissions to IEEE sponsored
13102 conferences I strongly recommend that you get a copy of their Authors Kit.
13107 package and associated bibliography style file is included in the kit.
13108 The Authors Kit is usually sent out by email once your initial submission
13110 There is a lot of useful information in the Authors Kit explaining formatting
13111 restrictions and so on and I will assume you have read this since that
13112 means I don't have to repeat it all here.
13115 \begin_layout Subsection
13119 \begin_layout Standard
13120 [AR\SpecialChar \@.
13124 \begin_layout Subsection
13125 Supported Environments
13128 \begin_layout Itemize
13134 \begin_layout Itemize
13140 \begin_layout Itemize
13146 \begin_layout Itemize
13152 \begin_layout Itemize
13158 \begin_layout Itemize
13164 \begin_layout Itemize
13170 \begin_layout Itemize
13176 \begin_layout Itemize
13182 \begin_layout Subsection
13183 Differences Between Screen and Paper
13186 \begin_layout Standard
13187 There are slight differences in appearance mainly with the presentation
13188 of section counters.
13189 On screen the trailing period of the section counter is missing but it
13190 will appear in the output so don't let this worry you.
13193 \begin_layout Section
13194 Hollywood (Hollywood spec scripts)
13197 \begin_layout Standard
13203 \begin_layout Subsection
13207 \begin_layout Standard
13208 Getting the format of a Hollywood script right is a
13209 \begin_inset Quotes eld
13213 \begin_inset Quotes erd
13216 It is designed to make the readers focus on content and to be easy and
13217 familiar for the actors to read.
13218 Each page of a script should be one minute of film.
13219 Nothing goes in a script that you cannot see or hear on screen.
13220 The courier 12 pt font should be used throughout.
13224 \begin_layout Subsection
13228 \begin_layout Standard
13229 Speakers' lines should NEVER break in mid-sentence.
13230 If a speaker's lines continue over a page break, repeat the
13234 title followed by (Cont'd).
13237 \begin_layout Subsection
13241 \begin_layout Standard
13246 names as labels then cross-reference the label to insert the name.
13247 The cross-reference dialog will show the current cast of characters.
13248 You can use this to insert the speaker name in narratives also.
13251 \begin_layout Subsection
13252 Paper size and Margins
13255 \begin_layout Standard
13256 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13259 \begin_layout Subsection
13263 \begin_layout Standard
13264 The following environments are available.
13265 You can use hollywood.bind to get the bind keys shown at the right.
13268 \begin_layout Itemize
13272 \begin_inset Newline newline
13277 Used where nothing else works.
13281 \begin_layout Itemize
13287 \begin_inset space \hfill{}
13295 \begin_inset Newline newline
13298 Usually followed by something like
13299 \begin_inset Quotes eld
13302 on Sally waking up.
13303 \begin_inset Quotes erd
13309 \begin_layout Itemize
13313 \begin_inset space \hfill{}
13317 \begin_inset Newline newline
13322 Introduces a new INTERIOR camera set-up.
13323 Always followed by DAY or NIGHT, or something similar to define the lighting
13325 Everthing on this line in CAPS.
13328 \begin_layout Itemize
13332 \begin_inset space \hfill{}
13336 \begin_inset Newline newline
13341 Introduces a new EXTERIOR camera set-up.
13342 Everthing on this line in CAPS.
13345 \begin_layout Itemize
13349 \begin_inset space \hfill{}
13353 \begin_inset Newline newline
13358 The character speaking.
13361 \begin_layout Itemize
13365 \begin_inset space \hfill{}
13369 \begin_inset Newline newline
13374 Instructions to the speaker.
13375 The () are automatically inserted, but only the ( will show in LyX.
13376 Both will be printed.
13379 \begin_layout Itemize
13383 \begin_inset space \hfill{}
13387 \begin_inset Newline newline
13399 \begin_layout Itemize
13403 \begin_inset space \hfill{}
13407 \begin_inset Newline newline
13412 Camera movement instruction.
13414 \begin_inset space \thinspace{}
13418 \begin_inset space ~
13424 \begin_layout Itemize
13428 \begin_inset space \hfill{}
13434 \begin_layout Itemize
13438 \begin_inset space \hfill{}
13444 \begin_layout Itemize
13448 \begin_inset space \hfill{}
13454 \begin_layout Itemize
13458 \begin_inset space \hfill{}
13464 \begin_layout Subsection
13468 \begin_layout Itemize
13469 (O.S) --- off screen
13472 \begin_layout Itemize
13473 (V.0) --- voice over
13476 \begin_layout Itemize
13481 \begin_layout Itemize
13486 \begin_layout Itemize
13487 PAN --- camera movement
13490 \begin_layout Itemize
13491 INSERT --- cut to close-up of
13494 \begin_layout Section
13498 \begin_layout Standard
13504 \begin_layout Subsection
13508 \begin_layout Standard
13509 Broadway is for writing plays.
13510 The format is more decorative than Hollywood, and much less standardized.
13511 This format should be suitable for workshops.
13514 \begin_layout Subsection
13518 \begin_layout Standard
13519 The same as in Hollywood.
13522 \begin_layout Subsection
13526 \begin_layout Standard
13531 names as labels then cross-reference the label to insert the name.
13532 The cross-reference dialog will show the current cast of characters.
13535 \begin_layout Subsection
13536 Paper size and Margins
13539 \begin_layout Standard
13540 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13543 \begin_layout Subsection
13547 \begin_layout Standard
13548 The following environments are available.
13549 You can use broadway.bind to get the bind keys shown at the right.
13552 \begin_layout Itemize
13556 \begin_inset Newline newline
13561 You should not have to use this, but it is here for anything that does not
13565 \begin_layout Itemize
13569 \begin_inset space \hfill{}
13573 \begin_inset Newline newline
13578 Used to describe stage setting and the action.
13579 First use of speaker names in all CAPs.
13582 \begin_layout Itemize
13586 \begin_inset space \hfill{}
13590 \begin_inset Newline newline
13595 Automatically numbered.
13596 On screen it will be arabic, but will print as Roman.
13599 \begin_layout Itemize
13603 \begin_inset space \hfill{}
13607 \begin_inset Newline newline
13617 It is just centered text.
13620 \begin_layout Itemize
13624 \begin_inset space \hfill{}
13628 \begin_inset Newline newline
13633 Not automatically numbered.
13634 You supply the number.
13635 This is because I couldn't figure out how.
13638 \begin_layout Itemize
13642 \begin_inset space \hfill{}
13646 \begin_inset Newline newline
13651 A special case of Narrative to describe the setting and action as the curtain
13655 \begin_layout Itemize
13659 \begin_inset space \hfill{}
13663 \begin_inset Newline newline
13668 The speaker's (actor's) title, centered in all CAPS.
13671 \begin_layout Itemize
13675 \begin_inset space \hfill{}
13679 \begin_inset Newline newline
13684 Instructions to the speaker.
13685 The parentheses are automatically inserted.
13686 The ( will appear on screen, but both will be in the printed play.
13687 This environment is only used within
13694 \begin_layout Itemize
13698 \begin_inset space \hfill{}
13702 \begin_inset Newline newline
13707 What the Speaker says.
13710 \begin_layout Itemize
13714 \begin_inset space \hfill{}
13718 \begin_inset Newline newline
13723 The curtain comes down.
13726 \begin_layout Itemize
13730 \begin_inset space \hfill{}
13736 \begin_layout Itemize
13740 \begin_inset space \hfill{}
13746 \begin_layout Itemize
13750 \begin_inset space \hfill{}
13756 \begin_layout Standard
13760 \begin_layout Section
13764 \begin_layout Standard
13770 \begin_layout Standard
13771 \begin_inset VSpace bigskip
13777 \begin_layout Standard
13782 \begin_inset space ~
13787 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13788 \begin_inset Formula $\beta$
13791 release of May, 1999) class.
13794 \begin_layout Standard
13799 textclass, which works with RevTeX 3.1.
13800 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13801 That means that it doesn't interact very well with LyX, which requires
13802 LaTeX2e, although it has been kludged to work.
13803 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13807 \begin_inset space ~
13812 textclass should also be pretty easy to use.
13815 \begin_layout Standard
13816 These documents are supposed to be used in
13820 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13821 macros, and assume you'll know what to put in the preamble if necessary.
13824 \begin_layout Subsection
13828 \begin_layout Standard
13829 All you need to do is install RevTeX 4, as described in the package's README
13831 The package can be found at The RevTeX 4 Web Site
13832 \begin_inset Flex URL
13835 \begin_layout Plain Layout
13837 http://publish.aps.org/revtex4/
13843 Install it somewhere that LaTeX can see it.
13844 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13845 (i.e., not the directory where you installed the class file.) Then, if you
13846 reconfigure LyX, it will find the class file and let you use the RevTeX4
13850 \begin_layout Standard
13851 Probably the easiest way to get started is either to import a RevTeX 4 document
13859 \begin_inset space ~
13864 template, found in the templates directory.
13867 \begin_layout Subsection
13871 \begin_layout Standard
13872 Optional arguments to
13879 \begin_inset Quotes eld
13883 \begin_inset Quotes erd
13887 \begin_inset Quotes eld
13891 \begin_inset Quotes erd
13901 \begin_inset space ~
13909 \begin_inset space ~
13915 Remember that in RevTeX, at least one optional argument is required!
13918 \begin_layout Standard
13919 Other preamble matter, like
13926 \begin_inset space ~
13936 \begin_inset space ~
13941 dialog, also as usual.
13944 \begin_layout Subsection
13948 \begin_layout Standard
13949 The layouts basically correspond to the commands in RevTeX4.0.
13950 For example, the Email layout corresponds to
13957 Note that (at least as of RevTeX 4.0 Beta), the
13965 layouts are exactly equivalent, so you shouldn't need to use both.
13969 \begin_layout Plain Layout
13970 In case you're curious, both were included so that
13974 would be able to translate both
13994 \begin_layout Subsection
13998 \begin_layout Standard
13999 There are a couple of important unique aspects of RevTeX 4 which might cause
14000 bugs that will be even more confusing in LyX.
14003 \begin_layout Standard
14021 The LyX equivalent is that there is a separate Thanks layout.
14026 write footnotes in the
14030 layout, or weird things may happen.
14031 See the RevTeX 4 documentation for more details.
14034 \begin_layout Standard
14038 \begin_inset space ~
14046 \begin_inset space ~
14055 layouts must be placed
14063 layout and the corresponding
14080 , the LaTeX won't compile.
14083 \begin_layout Subsection
14087 \begin_layout Standard
14088 The main problem with this layout is that you can't use the optional arguments
14089 to layouts like Email and Title.
14090 (The problem is not unique to this layout; you can't use optional arguments
14091 to the Section layouts either.) This means that after you export that file
14092 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14093 need to edit the LaTeX file with a text editor to add the optional arguments
14095 \begin_inset space \thinspace{}
14098 g., the running title for the page headers.
14099 Lacking these layouts makes the
14105 (and the equivalent
14111 ) useless, so the corresponding layouts don't exist, and will have to be
14116 \begin_layout Plain Layout
14121 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14122 has not been updated yet to take advantage of it.
14130 \begin_layout Section
14131 Article (mwart), book (mwbk) and report (mwrep)
14132 \begin_inset OptArg
14135 \begin_layout Plain Layout
14148 \begin_layout Standard
14154 \begin_layout Standard
14155 The LyX document classes
14171 correspond to the LaTeX document classes
14184 They are replacements for the standard document classes
14196 , resp., and fit better to Polish typography conventions in a number of points.
14200 \begin_layout Standard
14204 \begin_layout Itemize
14205 Unnumbered titles (with star, eg.
14210 ) are added into table of contents,
14213 \begin_layout Itemize
14214 Additional page styles:
14218 \begin_layout Description
14219 uheadings header with separated lines,
14222 \begin_layout Description
14223 myheadings custom header, contents headers via commands:
14238 \begin_layout Description
14239 myuheadings custom header with separated lines,
14242 \begin_layout Description
14243 outer page number is placed on outer side of page
14247 \begin_layout Itemize
14252 \begin_layout Description
14253 rmheadings serif titles --- default,
14256 \begin_layout Description
14257 sfheadings sansserif titles,
14260 \begin_layout Description
14261 authortitle on title page first placed is author next title --- default,
14264 \begin_layout Description
14265 titleauthor on title page first placed is title next author,
14268 \begin_layout Description
14269 withmarginpar reserve place on page for margins.
14273 \begin_layout Section
14277 \begin_layout Standard
14283 \begin_layout Standard
14284 Elsevier Science Publishers B.V.
14285 provides a standard LaTeX document class (
14289 ) for submitting articles to their various journals.
14290 The style file can be downloaded directly from their web site:
14291 \begin_inset Flex URL
14294 \begin_layout Plain Layout
14296 http://authors.elsevier.com/
14302 Instructions are supplied along with the class file, which details the
14303 requirements of the publishers.
14304 LyX includes package that allows for the use of this class, by a layout
14305 and a template file.
14306 Installation of the class file is the same as for any other LaTeX package;
14307 instructions are provided in the Elsevier documentation.
14310 \begin_layout Standard
14320 As the Elsevier class file is based mainly on the standard article class,
14321 most of the normal functionality is provided.
14322 The Elsevier class defines a number of mathematical environments, which
14323 are similar to the AMS environments.
14324 These commands are all described in the Elsevier documentation, and are
14328 \begin_layout Standard
14329 The easiest way to use the Elsevier style is to base documents on the included
14331 It is best not to use options such as fancy headings or the geometry package,
14332 as elements such as these are defined by Elsevier in their style file.
14333 Ideally, no extra packages except those mentioned in the Elsevier documentation
14335 Essentially, Elsevier require as
14336 \begin_inset Quotes eld
14340 \begin_inset Quotes erd
14343 a LaTeX file as possible, as their intention is to take the supplied file
14344 and replace the class file with one for the particular journal to which
14345 the paper has been submitted.
14346 This also means that not too much time should be spent on the formating
14348 When it comes to be published, this will change anyway.
14349 The rest of the usage for this layout is substantially the same as for
14350 the normal article class.
14351 For details of what Elsevier do and don't allow, refer to their documentation.
14354 \begin_layout Section
14358 \begin_layout Standard
14361 Jürgen Spitzmüller
14364 \begin_layout Subsection
14368 \begin_layout Standard
14369 Memoir is a very powerful and constantly evolving class.
14370 It has been designed with regard to fictional and non-fictional literature.
14371 Its aim is to let the user have maximum control over the typesetting of
14373 Memoir is based on the standard book class, but it can also emulate the
14374 article class (see below).
14377 \begin_layout Standard
14378 Peter Wilson, the developer of Memoir, is known as the author of lots of
14379 useful packages in the LaTeX world.
14380 Most of them have been merged with Memoir.
14381 Therefore, it is much easier to layout the table of contents, appendices,
14382 chapter designs and such.
14383 LyX, though, does not support all of these goodies natively.
14384 Some of them might be added to forthcoming releases
14388 \begin_layout Plain Layout
14389 You are invited to send suggestions to
14390 \begin_inset Flex URL
14393 \begin_layout Plain Layout
14395 lyx-devel@lists.lyx.org
14405 , lots will probably never, due to the limitations of LyX's framework.
14406 Of course you can still use all features with the help of some native LaTeX
14411 \begin_layout Plain Layout
14416 \begin_layout Plain Layout
14426 \begin_inset space ~
14430 \begin_inset CommandInset ref
14432 reference "sec:Inserting-LaTeX-Code"
14442 In this section, we can only list those features which are natively supported
14444 For detailed descriptions (and for the rest of features) we are recommending
14445 to have a look at the detailed manual of the Memoir class
14449 \begin_layout Plain Layout
14454 \begin_layout Plain Layout
14464 \begin_inset Flex URL
14467 \begin_layout Plain Layout
14469 CTAN:/macros/latex/memoir/memman.pdf
14479 , which is not only a user guide for the class, but also both a comprehensive
14480 description on good typesetting and a superb example for good typesetting
14484 \begin_layout Subsection
14485 Basic features and restrictions
14488 \begin_layout Standard
14489 Memoir supports basically all features of the standard book classes.
14490 There are, however, some differences, as follows:
14493 \begin_layout Description
14495 \begin_inset space ~
14498 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14501 \begin_layout Description
14503 \begin_inset space ~
14506 style: The fancy page style is not supported, due to a command clash between
14507 Memoir and the fancyhdr package (they are both defining a command with
14508 the same name, which confuses LaTeX).
14509 Instead, Memoir comes with a bunch of own page styles (see
14511 Layout\SpecialChar \menuseparator
14512 Document\SpecialChar \menuseparator
14514 \begin_inset space ~
14520 If you want to use these for the chapter pages, you have to use the command
14527 in the main text or in preamble (e.
14528 \begin_inset space \thinspace{}
14532 \begin_inset space ~
14539 chapterstyle{companion}
14544 \begin_layout Description
14545 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14546 an optional argument in the standard classes.
14547 With this, you can specify an alternative version of the title for the
14548 table of contents and the headers (for instance, if the title is too long).
14549 In LyX, you can do this via
14551 Insert\SpecialChar \menuseparator
14553 \begin_inset space ~
14558 at the beginning of a chapter/section.
14559 Memoir features a second optional argument and thus separates the table
14560 of contents from the header.
14561 You can define three variants of a title with this: one for the main text,
14562 one for the table of contents, and one for the headers.
14563 Simply insert two optional arguments if you need this feature, the first
14564 one containing the short title for the Table of Contents, the second one
14565 containing an alternative short title for the headers.
14568 \begin_layout Description
14569 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14570 of contents, the list of figures and the list of table start a new page
14572 Memoir does not follow this route.
14573 You have to insert a page break yourself, if you want to have one.
14576 \begin_layout Description
14577 Titlepage: For some unknown reason, Memoir uses pagination on the title
14578 page (in the standard classes, title pages are
14579 \begin_inset Quotes eld
14583 \begin_inset Quotes erd
14587 \begin_inset space \thinspace{}
14591 \begin_inset space ~
14595 If you want an empty title page, type
14599 aliaspagestyle{title}{empty}
14604 \begin_layout Description
14605 Article: With the class option
14611 Layout\SpecialChar \menuseparator
14612 Document\SpecialChar \menuseparator
14614 \begin_inset space ~
14619 ), you can emulate article style.
14620 That is, counters (footnotes, figures, tables etc.) will not be reset on
14621 new chapters, chapters don't start a new page (but are---in contrary to
14623 \begin_inset Quotes eld
14627 \begin_inset Quotes erd
14630 article classes---still allowed), parts, though, use their own page, as
14634 \begin_layout Description
14635 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14636 font commands, which have been used in the old LaTeX version 2.09 (e.
14637 \begin_inset space \thinspace{}
14641 \begin_inset space ~
14657 It produces an error and stops LaTeX whenever such a command appears.
14662 reallows the commands and spits out warnings instead (which does at least
14664 Since a lot of packages and particularly BibTeX style files are still using
14665 those commands, we have decided to use this option by default.
14668 \begin_layout Subsection
14672 \begin_layout Standard
14673 We will only describe the features supported by LyX (which is not much currently
14675 Please consult the Memoir manual
14679 \begin_layout Plain Layout
14684 \begin_layout Plain Layout
14694 \begin_inset Flex URL
14697 \begin_layout Plain Layout
14699 CTAN:/macros/latex/memoir/memman.pdf
14712 \begin_layout Description
14713 Abstract: You may wonder why an abstract is an extra feature.
14714 Well, it is in book class.
14715 Usually books don't have abstracts.
14716 Memoir, however, has.
14717 You can use it wherever and how often you like.
14720 \begin_layout Description
14721 Chapterprecis: You may know this from belletristic: The contents of a chapter
14722 is shortly described below the title and also in the table of contents
14724 \begin_inset space \thinspace{}
14728 \begin_inset space ~
14733 Our hero arrives in Troia; he loses some friends; he finds others
14736 Chapterprecis does exactly this.
14737 It is therefore only sensible below a chapter.
14740 \begin_layout Description
14741 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14742 The epigraph environment provides an elegant way of typesetting such a
14744 The motto itself (text) and its author (source) are divided by a short
14746 Unfortunately, we have to fool LyX a bit here again, since the environment
14747 needs two arguments (text and source).
14748 In this case, we have to use curly brackets (in TeX mode) between the two
14759 <author of the slogan>.
14762 \begin_layout Description
14763 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14764 complex figurative poems).
14765 LyX can only support a few of them.
14766 One is poemtitle, which is a centered title for poems, which will also
14767 be added to the table of contents (verse is the standard environment for
14769 Memoir has some enhanced versions of verse, but you need to use ERT, because
14770 they have to be nested inside regular verse environments, which is not
14771 possible with LyX).
14774 \begin_layout Description
14775 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14778 \begin_layout Chapter
14779 LyX Features needing Extra Software
14782 \begin_layout Section
14786 \begin_layout Standard
14792 \begin_layout Subsection
14796 \begin_layout Standard
14797 When you to have the
14801 program installed, you'll find in the
14808 \begin_inset space ~
14819 \begin_inset CommandInset href
14821 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14828 \begin_layout Standard
14833 package is a program that was written by
14838 in frustration because some constructs in LaTeX are sometimes non-intuitive,
14839 and easy to forget.
14840 The program runs over your LaTeX file and checks the integrity of the file,
14841 and flags some common errors.
14842 In other technical words, it is
14849 \begin_layout Standard
14850 Well, what is a syntax checker doing in LyX which is supposed to produce
14851 correct LaTeX anyways? The answer is simple: Just as
14855 not only checks the
14859 of C programs, but also does
14863 checks for type-errors,
14867 catches some common
14871 errors, in addition to the syntactical ones.
14876 is capable of detecting several common errors, such as
14879 \begin_layout Itemize
14880 Ellipsis detection:
14881 \begin_inset Newline newline
14884 Use \SpecialChar \ldots{}
14888 \begin_layout Itemize
14889 No space in front of/after parenthesis:
14890 \begin_inset Newline newline
14896 \begin_layout Itemize
14897 Enforcement of normal space after common abbreviations:
14898 \begin_inset Newline newline
14903 is too wide spacing.
14906 \begin_layout Itemize
14907 Enforcement of end-of-sentence space when the last sentence ends with a
14909 \begin_inset Newline newline
14913 And this is wrong spacing.
14916 \begin_layout Itemize
14917 Space in front of labels and similar commands:
14918 \begin_inset Newline newline
14921 The label should stick right up to the text to avoid falling to a wrong
14924 \begin_inset CommandInset label
14934 \begin_layout Plain Layout
14935 This footnote is in danger of falling off to a wrong page
14940 The label is separated too much.
14943 \begin_layout Itemize
14944 Space in front of references, instead of hard spaces:
14945 \begin_inset Newline newline
14948 In you are in bad luck, the text will break right between the referenced
14949 text and reference number, and that's a pity.
14951 \begin_inset CommandInset ref
14953 reference "sec:chktex"
14960 \begin_layout Itemize
14962 \begin_inset Quotes eld
14966 \begin_inset Quotes erd
14970 \begin_inset Formula $\times$
14974 \begin_inset Newline newline
14977 2x2 looks cheap compared to
14978 \begin_inset Formula $2\times2$
14984 \begin_layout Standard
14985 and more \SpecialChar \ldots{}
14986 It is an invaluable tool when you are
14987 \begin_inset Quotes eld
14991 \begin_inset Quotes erd
14994 your document before printing, and you should run it right after the obligatory
14995 spelling check, and before you go fine tuning the typesetting.
14998 \begin_layout Subsection
15002 \begin_layout Standard
15003 If you have the program installed, usage is as simple as choosing
15008 ools\SpecialChar \menuseparator
15014 \begin_inset space ~
15020 This will make LyX generate a LaTeX file of your document, start
15024 to check it, and then make LyX insert
15025 \begin_inset Quotes eld
15029 \begin_inset Quotes erd
15032 with the warnings from
15036 , if there were any.
15037 The warnings will be placed close to the point of the mistake, and you
15038 can quickly find them by using the
15043 avigate\SpecialChar \menuseparator
15050 menu item, or the shortcut key
15059 Open the error boxes by clicking on them with the mouse, or use the shortcut
15068 bindings, or the corresponding
15077 Read the warning and correct the mistake, if it is a mistake.
15078 If you have trouble understanding what the warning is about, you can safely
15080 Remember that there is a hidden layer between the document on screen and
15081 the technical details in invoking
15085 , and this gap can make some warnings seem arcane or just right down plain
15089 \begin_layout Standard
15090 This document is an excellent testing bed for the feature, and it should
15091 provide quite a few warnings for you to fiddle with.
15092 Since computers are only so smart, expect most of the warnings to be false
15096 \begin_layout Subsection
15097 How to fine tune it
15100 \begin_layout Standard
15101 Sometimes, you'll find that
15105 makes more noise than suits your mood.
15106 Then you can choose not to use it, wait until your mood changes, or try
15111 to get better along with you.
15112 Another choice in the most desperate situations is to use
15117 iew\SpecialChar \menuseparator
15123 \begin_inset space ~
15127 \begin_inset space ~
15131 \begin_inset space ~
15136 , which will get rid of all warnings instantly.
15139 \begin_layout Standard
15148 very configurable and extensible, you shouldn't expect to solve all problems
15154 Since LyX has to generate a somewhat special LaTeX file to be able to match
15155 the line numbers from the
15163 \begin_layout Plain Layout
15164 You can inspect the specific output from
15170 Edit\SpecialChar \menuseparator
15172 \begin_inset space ~
15176 \begin_inset space ~
15190 to the internal document structure, some of the warnings will not seen
15191 to appear correctly.
15192 There are two things you can do about this:
15195 \begin_layout Itemize
15200 invocation command line in
15216 installation configuration file (usually with the file
15221 See below to learn what warnings can be enabled and disabled on the command
15226 \begin_layout Itemize
15227 Export your document as a raw LaTeX file using
15232 ile\SpecialChar \menuseparator
15237 xport\SpecialChar \menuseparator
15249 Invoked in this way, it can be a hassle to find the corresponding place
15250 in the document inside LyX, but with a little patience, you should be able
15254 \begin_layout Standard
15255 Here follows the warning messages that can be enabled and disabled in
15264 to disable a warning, and
15268 to enable a warning.
15269 The emphasized entries are disabled by default, because the default is
15272 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15277 \begin_layout Standard
15278 Notice that you should only use the options that enable and disable warnings,
15279 because LyX relies on some of the other command line parameters to be set
15280 in a specific way to have a chance to communicate with
15287 \begin_layout Enumerate
15291 Command terminated with space.
15294 \begin_layout Enumerate
15297 Non-breaking space (
15298 \begin_inset Quotes eld
15306 \begin_inset Quotes erd
15309 ) should have been used.
15312 \begin_layout Enumerate
15316 You should enclose the previous parenthesis with
15317 \begin_inset Quotes eld
15325 \begin_inset Quotes erd
15331 \begin_layout Enumerate
15334 Italic correction (
15335 \begin_inset Quotes eld
15345 \begin_inset Quotes erd
15348 ) found in non-italic buffer.
15351 \begin_layout Enumerate
15354 Italic correction (
15355 \begin_inset Quotes eld
15365 \begin_inset Quotes erd
15368 ) found more than once.
15371 \begin_layout Enumerate
15375 No italic correction (
15376 \begin_inset Quotes eld
15386 \begin_inset Quotes erd
15392 \begin_layout Enumerate
15396 \begin_inset Quotes eld
15404 \begin_inset Quotes erd
15408 \begin_inset Quotes eld
15416 \begin_inset Quotes erd
15422 \begin_layout Enumerate
15425 Wrong length of dash may have been used.
15428 \begin_layout Enumerate
15432 \begin_inset Quotes eld
15440 \begin_inset Quotes erd
15444 \begin_inset Quotes eld
15452 \begin_inset Quotes erd
15458 \begin_layout Enumerate
15462 \begin_inset Quotes eld
15470 \begin_inset Quotes erd
15476 \begin_layout Enumerate
15480 \begin_inset Quotes eld
15488 \begin_inset Quotes erd
15491 to achieve an ellipsis.
15494 \begin_layout Enumerate
15497 Inter-word spacing (
15498 \begin_inset Quotes eld
15508 \begin_inset Quotes eld
15511 ) should perhaps be used.
15514 \begin_layout Enumerate
15517 Inter-sentence spacing (
15518 \begin_inset Quotes eld
15528 \begin_inset Quotes erd
15531 ) should perhaps be used.
15534 \begin_layout Enumerate
15537 Could not find argument for command.
15540 \begin_layout Enumerate
15544 \begin_inset Quotes eld
15552 \begin_inset Quotes erd
15558 \begin_layout Enumerate
15561 Math mode still on at end of LaTeX file.
15564 \begin_layout Enumerate
15568 \begin_inset Quotes eld
15576 \begin_inset Quotes erd
15579 doesn't match the number of
15580 \begin_inset Quotes eld
15588 \begin_inset Quotes erd
15594 \begin_layout Enumerate
15597 You should use either
15600 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15613 as an alternative to
15614 \begin_inset Quotes eld
15622 \begin_inset Quotes erd
15628 \begin_layout Enumerate
15635 " (ASCII 39) instead of "
15642 \begin_layout Enumerate
15645 User-specified pattern found.
15648 \begin_layout Enumerate
15651 This command might not be intended.
15654 \begin_layout Enumerate
15661 \begin_layout Enumerate
15679 \begin_layout Enumerate
15682 Delete this space to maintain correct page references.
15685 \begin_layout Enumerate
15689 You might wish to put this between a pair of
15690 \begin_inset Quotes eld
15698 \begin_inset Quotes erd
15704 \begin_layout Enumerate
15707 You ought to remove spaces in front of punctuation.
15710 \begin_layout Enumerate
15713 Could not execute LaTeX command.
15716 \begin_layout Enumerate
15725 in front of small punctuation.
15728 \begin_layout Enumerate
15736 may look prettier here.
15739 \begin_layout Enumerate
15743 Multiple spaces detected in output.
15746 \begin_layout Enumerate
15749 This text may be ignored.
15752 \begin_layout Enumerate
15758 \begin_inset Quotes eld
15763 to begin quotation, not
15770 \begin_layout Enumerate
15777 to end quotation, not
15780 \begin_inset Quotes eld
15788 \begin_layout Enumerate
15794 \begin_layout Enumerate
15797 You should perhaps use
15798 \begin_inset Quotes eld
15806 \begin_inset Quotes erd
15812 \begin_layout Enumerate
15815 You should put a space in front of/after parenthesis.
15818 \begin_layout Enumerate
15821 You should avoid spaces in front of/after parenthesis.
15824 \begin_layout Enumerate
15828 You should not use punctuation in front of/after quotes.
15831 \begin_layout Enumerate
15834 Double space found.
15837 \begin_layout Enumerate
15840 You should put punctuation outside inner/inside display math mode.
15843 \begin_layout Enumerate
15846 You ought to not use primitive TeX in LaTeX code.
15849 \begin_layout Enumerate
15852 You should remove spaces in front of
15853 \begin_inset Quotes eld
15861 \begin_inset Quotes erd
15867 \begin_layout Enumerate
15870 \begin_inset Quotes eld
15878 \begin_inset Quotes erd
15881 is normally not followed by
15882 \begin_inset Quotes eld
15890 \begin_inset Quotes erd
15896 \begin_layout Standard
15897 In later versions of LyX, we hope to provide a more complete interface to
15898 this tool (and it's smaller cousin
15902 ) to exploit the full power of it.
15903 But it's not exactly useless as it is now: go try it on one of your existing
15904 documents of a certain length and be surprised.
15907 \begin_layout Section
15908 Version Control in LyX
15911 \begin_layout Standard
15914 Lars Gullik Bjønnes,
15921 \begin_layout Subsection
15925 \begin_layout Standard
15926 A friend of mine wanted to try LyX for a group project.
15927 When he didn't find support for version control or file locking, he dropped
15929 This angered me a bit, so I thought that I should at least make support
15930 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
15931 This has now been done.
15932 LyX now supports some of the most basic RCS commands.
15933 If you need to something a bit more sophisticated you will have to do that
15934 manually in an xterm.
15937 \begin_layout Standard
15938 Before you begin to use the version control features in LyX, you should
15940 \begin_inset Quotes eld
15944 \begin_inset Quotes erd
15947 (a man file, read it with
15952 This file describes all the basic features of RCS.
15953 You should especially notice the comment about a RCS directory, and the
15954 notion of a master RCS file (the file ending in
15961 \begin_layout Standard
15962 Later basic CVS/SVN support was added.
15963 You should be familiar with CVS/SVN usage before start using it under LyX.
15964 Most of the log messages are not currently displayed after operations -
15965 you can check them in terminal window if unsure.
15968 \begin_layout Standard
15969 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
15970 package---no guarantees are made for older versions.
15973 \begin_layout Subsection
15974 RCS commands in LyX
15977 \begin_layout Standard
15978 The following sections describe the RCS commands supported by LyX.
15979 You can find them in the
15984 ile\SpecialChar \menuseparator
15990 \begin_inset space ~
15998 \begin_layout Subsubsection
16004 \begin_layout Standard
16005 If your document is not under revision control, this is the only item shown
16007 And if it is under revision control, the
16014 item is not visible.
16018 \begin_layout Standard
16019 This command registers your document with RCS (unless you are under the
16020 directory managed by CVS)\SpecialChar \@.
16021 You are asked interactively to supply an initial
16022 description of the document.
16023 The document is now set in Read-Only mode and you have to
16026 \begin_inset space ~
16030 \begin_inset space ~
16034 \begin_inset space ~
16039 , before making any changes to it.
16040 A document under revision control has a
16041 \begin_inset Quotes eld
16044 [RCS:<version> <locker>]
16045 \begin_inset Quotes erd
16048 item tagged to the filename in the minibuffer.
16051 \begin_layout Standard
16052 RCS command that is run:
16054 ci -q -u -i -t-"<initial description>" <file-name>
16057 \begin_layout Standard
16062 to understand the switches.
16066 \begin_layout Subsubsection
16072 \begin_layout Standard
16073 When you are finished editing a file, you check in your changes.
16074 When you do this, you are asked for a description of the changes.
16075 This is stored in the history log.
16076 The version number is bumped, your changes are applied to the master RCS
16077 file, the document is unlocked and set to Read-Only mode.
16081 \begin_layout Standard
16084 ci -q -u -m"<description>" <file-name>
16087 \begin_layout Subsubsection
16093 \begin_layout Standard
16094 By doing this you lock the document so that only you can edit it.
16095 This will also make the document Read-Write only for you.
16096 You will usually continue editing for a while and when you are finished
16097 you check in your changes.
16098 The status line is changed to reflect that you have locked the file.
16102 \begin_layout Standard
16105 co -q -l <file-name>
16108 \begin_layout Subsubsection
16111 Revert To Repository Version
16114 \begin_layout Standard
16115 This will discard all changes made to the document since the last check
16117 You get a warning before changes are discarded.
16120 \begin_layout Standard
16123 co -f -u<version> <file-name>
16126 \begin_layout Subsubsection
16132 \begin_layout Standard
16133 This makes as if the last check in never happened.
16134 No changes are made to the document loaded into LyX, but the last version
16135 is removed from the master RCS file.
16139 \begin_layout Standard
16142 rcs -o<version> <file-name>
16145 \begin_layout Subsubsection
16151 \begin_layout Standard
16152 This show the complete history of the RCS document.
16157 is shown in a browser.
16165 \begin_layout Subsection
16166 CVS commands in LyX
16169 \begin_layout Standard
16170 CVS is now partially supported by LyX.
16171 You can find the commands in the
16176 ile\SpecialChar \menuseparator
16182 \begin_inset space ~
16190 \begin_layout Subsubsection
16196 \begin_layout Standard
16197 If your document is not under revision control, this is the only item shown
16199 And if it is under revision control, the
16206 item is not visible.
16210 \begin_layout Standard
16211 This command registers in CVS your document ONLY in case you have already
16212 the documents directory under CVS control (in particular
16217 This means you have to checkout the archive by yourself.
16221 \begin_layout Standard
16222 Then you are asked interactively to supply an initial description of the
16224 Don't forget that registered file is not yet commited.
16227 \begin_layout Standard
16228 CVS command that is run:
16231 \begin_inset Quotes erd
16235 \begin_inset Quotes eld
16239 \begin_inset Quotes erd
16245 \begin_layout Standard
16250 to understand the switches.
16254 \begin_layout Subsubsection
16260 \begin_layout Standard
16261 When you are finished editing a file, you commit your changes.
16262 When you do this, you are asked for a description of the changes.
16263 After that changes are commited.
16266 \begin_layout Standard
16269 cvs -q commit -m"<description>" <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.
16282 Firstly the file is deleted, secondly CVS update command is run.
16285 \begin_layout Standard
16289 \begin_inset Quotes eld
16293 \begin_inset Quotes erd
16299 \begin_layout Subsubsection
16305 \begin_layout Standard
16306 This show the complete history of the CVS document.
16310 \begin_inset Quotes eld
16314 \begin_inset Quotes erd
16319 is shown in a browser.
16322 \begin_layout Subsection
16323 SVN commands in LyX
16326 \begin_layout Standard
16327 SVN is now partially supported by LyX.
16328 You can find the commands in the
16333 ile\SpecialChar \menuseparator
16339 \begin_inset space ~
16345 Please note that if you use password protected access to repository via
16346 ssh, you will be asked in terminal window.
16349 \begin_layout Subsubsection
16355 \begin_layout Standard
16356 If your document is not under revision control, this is the only item shown
16358 And if it is under revision control, the
16365 item is not visible.
16369 \begin_layout Standard
16370 This command registers in SVN your document ONLY in case you have already
16371 the documents directory under SVN control (in particular
16376 This means you have to checkout the archive by yourself.
16380 \begin_layout Standard
16381 Then you are asked interactively to supply an initial description of the
16383 Don't forget that registered file is not yet commited.
16386 \begin_layout Standard
16387 SVN command that is run:
16390 \begin_inset Quotes eld
16394 \begin_inset Quotes erd
16400 \begin_layout Standard
16405 to understand the switches.
16409 \begin_layout Subsubsection
16415 \begin_layout Standard
16416 When you are finished editing a file, you commit your changes.
16417 When you do this, you are asked for a description of the changes.
16418 After that changes are commited.
16421 \begin_layout Standard
16424 svn commit -q -m"<description>" <file-name>
16427 \begin_layout Subsubsection
16433 \begin_layout Standard
16434 Updates the changes of this file from the repository.
16435 Be sure you understand SVN merging and conflicts resolving before using
16436 this function, because all conflicts has to be done manually by you!
16439 \begin_layout Standard
16443 \begin_inset Quotes eld
16447 \begin_inset Quotes erd
16453 \begin_layout Subsubsection
16456 Revert To Repository Version
16459 \begin_layout Standard
16460 This will discard all changes made to the document since the last check
16462 You get a warning before changes are discarded.
16466 \begin_layout Standard
16470 \begin_inset Quotes eld
16474 \begin_inset Quotes erd
16480 \begin_layout Subsubsection
16486 \begin_layout Standard
16487 This show the complete history of the SVN document.
16491 \begin_inset Quotes eld
16495 \begin_inset Quotes erd
16500 is shown in a browser.
16503 \begin_layout Section
16504 Literate Programming
16507 \begin_layout Standard
16512 (kayvan@sylvan.com)
16516 original documentation written by
16518 Edmar Wienskoski Jr.
16521 (edmar-w-jr@technologist.com)
16524 \begin_layout Subsection
16528 \begin_layout Standard
16529 The main purpose of this documentation is to show you how to use LyX for
16530 literate programming.
16531 Where it is assumed that you are familiar with this programming technique,
16533 \begin_inset Quotes eld
16537 \begin_inset Quotes erd
16541 \begin_inset Quotes eld
16545 \begin_inset Quotes erd
16549 If that is not the case, please follow the web links provided in the following
16551 There is a lot of good documentation out there covering old development
16552 history to the latest tools tips.
16555 \begin_layout Standard
16556 It is also assumed that you are familiar with LyX itself to a point that
16557 you are comfortable changing your LyX preferences, and X resources file.
16558 If that is not the case please refer to other LyX documentation to cover
16559 your specific needs.
16562 \begin_layout Subsection
16563 Literate Programming
16566 \begin_layout Standard
16567 From the Literate Programming FAQ:
16570 \begin_layout Quotation
16571 Literate programming is the combination of documentation and source together
16572 in a fashion suited for reading by human beings.
16573 In fact, literate programs should be enjoyable reading, even inviting!
16574 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16575 and documentation in a single file.
16576 Literate programming tools then parse the file to produce either readable
16577 documentation or compilable source.
16578 The WEB style of literate programming was created by D.E.
16579 Knuth during the development of his TeX typesetting software.
16583 \begin_layout Standard
16584 Another excerpt says:
16587 \begin_layout Quotation
16590 How is literate programming different from verbose commenting?
16593 \begin_layout Quotation
16594 There are three distinguishing characteristics.
16595 In order of importance, they are:
16599 \begin_layout Itemize
16600 flexible order of elaboration
16603 \begin_layout Itemize
16604 automatic support for browsing
16607 \begin_layout Itemize
16608 typeset documentation, especially diagrams and mathematics
16612 \begin_layout Standard
16613 Now that I sparked your curiosity, take a look in the references.
16616 \begin_layout Subsubsection
16620 \begin_layout Standard
16621 The complete Literate Programming FAQ can be found at:
16624 \begin_layout Quote
16625 Literate Programming FAQ
16626 \begin_inset Flex URL
16629 \begin_layout Plain Layout
16631 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16639 \begin_layout Standard
16640 The FAQ lists 23 (twenty three!) different literate programming tools.
16641 Where some are specialized or
16642 \begin_inset Quotes eld
16646 \begin_inset Quotes erd
16649 for particular programming languages, while other have general scope.
16654 for my own use for several reasons:
16657 \begin_layout Itemize
16658 It can generate the documentation either in LaTeX or HTML.
16661 \begin_layout Itemize
16662 It has a open architecture, i.e., it is easy to plug in new filters and to
16663 perform special processing that you may need.
16667 \begin_layout Itemize
16668 There is a good selection of filters available already (the HTML is one
16672 \begin_layout Itemize
16676 \begin_layout Standard
16677 The Noweb web page can be found at:
16680 \begin_layout Quote
16682 \begin_inset Flex URL
16685 \begin_layout Plain Layout
16687 http://www.cs.virginia.edu/~nr/noweb/
16695 \begin_layout Standard
16696 Starting from there you can reach many other interesting links and even
16697 some literate program examples.
16700 \begin_layout Subsection
16701 \begin_inset CommandInset label
16703 name "sub:LyX-and-Literate"
16707 LyX and Literate Programming
16710 \begin_layout Standard
16711 The LyX support for Literate Programming is provided by using the generic
16712 LyX convertors mechanism.
16713 This support is provided in a
16714 \begin_inset Quotes eld
16718 \begin_inset Quotes erd
16721 way, i.e., you will be able to use this new LyX feature with some other literate
16722 programming tool of your choice by just changing your LyX preferences.
16725 \begin_layout Subsubsection
16726 Generating documents and code (weaving and tangling)
16729 \begin_layout Paragraph
16730 Selecting the document class
16733 \begin_layout Standard
16734 If you have installed Noweb and LyX successfully, whenever you open a new
16735 document or try to change the document class of an existing one, you will
16736 find that there are three new document classes available:
16739 \begin_layout Itemize
16743 \begin_layout Itemize
16747 \begin_layout Itemize
16751 \begin_layout Standard
16752 You must select one of them to create your literate documents from.
16756 \begin_layout Standard
16757 Note that literate documents are not limited to these three classes.
16758 New classes can be generated from other styles like letter or in combination
16759 with other class variations like Article (AMS).
16760 If you have special needs that cannot be covered by one of the existing
16761 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16762 will arrange to insert a new entry, or teach you how to do it.
16766 \begin_layout Plain Layout
16767 It is very simple, it involves the creation of a file with four lines, and
16768 re-running of the auto configuration.
16773 Moreover, if you use a literate tool other than Noweb you may need to create
16774 a new set of document classes for it.
16777 \begin_layout Paragraph
16781 \begin_layout Standard
16782 LyX enables you to write code with a layout named
16790 \begin_layout Plain Layout
16791 The equivalent Noweb term is
16792 \begin_inset Quotes eld
16796 \begin_inset Quotes erd
16800 For historical reasons, I got used to the term
16801 \begin_inset Quotes eld
16805 \begin_inset Quotes erd
16808 introduced by other literate tool named Nuweb, which I used for many years
16809 before rendering myself to Noweb.
16814 Noweb delimits scraps like this:
16817 \begin_layout LyX-Code
16821 \begin_layout LyX-Code
16825 \begin_layout LyX-Code
16829 \begin_layout LyX-Code
16833 \begin_layout LyX-Code
16837 \begin_layout Standard
16838 The problem is that whatever is written in between the << and the
16842 must be taken literally, i.e., LyX should be prevented from making any special
16843 interpretation of what has been written.
16844 This is handled by a special layout named Scrap, that works like a normal
16845 paragraph but has a free spacing capability.
16848 \begin_layout Standard
16849 The down side of the Scrap paragraph layout is that consecutive paragraphs
16850 of code will be spaced with one empty line in the source code and also
16851 in the printed documentation.
16852 The work around is to enter each line of code within a single Scrap, with
16853 a newline (ctrl-return).
16854 The example above will look like this:
16858 \begin_layout Plain Layout
16859 If you have a printed version of this document you will not see any difference
16860 between the previous example and this one.
16868 \begin_layout LyX-Code
16870 \begin_inset Newline newline
16874 \begin_inset Newline newline
16878 \begin_inset Newline newline
16882 \begin_inset Newline newline
16888 \begin_layout Standard
16889 This layout works fine.
16890 The only real inconvenience is that you have to type ctrl-return instead
16895 \begin_layout Plain Layout
16896 It is in my list of
16897 \begin_inset Quotes eld
16901 \begin_inset Quotes erd
16912 \begin_layout Standard
16913 As a special note, you can also use the
16914 \begin_inset Quotes eld
16918 \begin_inset Quotes erd
16921 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16925 \begin_layout LyX-Code
16927 \begin_inset Newline newline
16930 def some_function(args):
16931 \begin_inset Newline newline
16934 "This is the doc string for this function."
16935 \begin_inset Newline newline
16938 print "My args: ", args
16941 \begin_layout LyX-Code
16942 @ %def some_function
16945 \begin_layout Standard
16946 For an example of this usage and the resulting cross-reference output, look
16947 at the Literate python program in
16949 LIBDIR/examples/listerrors.lyx
16951 which should make this all clear.
16954 \begin_layout Paragraph
16955 Generating the documentation
16958 \begin_layout Standard
16959 At this point you already have a new document file with a proper document
16960 class, and with some code and text on it.
16961 How do I print it? The answer is simple, you select
16966 iew\SpecialChar \menuseparator
16974 Just like you would do for a plain document.
16975 No special procedure is required.
16978 \begin_layout Standard
16979 To help orientate you, I will now explain what happens inside LyX:
16982 \begin_layout Enumerate
16985 Update\SpecialChar \menuseparator
16988 menu option is chosen, a LaTeX file is generated.
16993 \begin_layout Standard
16994 If the document is of any literate class the generated file will be named
16995 with an extension name defined by the
16996 \begin_inset Quotes eld
17000 \begin_inset Quotes erd
17003 format (defined in the Preferences panel), otherwise the file will have
17012 \begin_layout Enumerate
17013 Note that the only difference so far is in the name of the file, no special
17014 processing is required by LyX.
17015 Given that you formatted the code using the Scrap layout that, by itself,
17016 takes care of the business.
17019 \begin_layout Enumerate
17020 If the document is of any literate class LyX will then use the internal
17021 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17025 \begin_layout Plain Layout
17026 The converters are defined in the
17028 Tools\SpecialChar \menuseparator
17032 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17048 manual for general information about converters.
17053 to generate the LaTeX file.
17057 \begin_layout Standard
17058 Otherwise it will just skip this step.
17062 \begin_layout Enumerate
17063 Finally, LaTeX is invoked and the regular post processing continues as in
17067 \begin_layout Standard
17068 Independence from a particular
17069 \begin_inset Quotes eld
17073 \begin_inset Quotes erd
17076 is easily achieved by changing the commands that are run by the various
17080 \begin_layout Paragraph
17081 Generating the code
17084 \begin_layout Standard
17085 When the build menu option is chosen or the corresponding button in the
17086 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17087 Next, LyX invokes the
17092 This converter needs to be defined by the user and is not installed by
17093 default, though the Program format is.
17094 This converter (like any other converter) will have two parts:
17097 \begin_layout Enumerate
17098 The converter program itself.
17099 This program performs the conversion from the one format to the other (in
17100 this case, from the Noweb format to the Program pseudo-format).
17103 \begin_layout Enumerate
17104 The error log parser.
17105 This is a program whose sole purpose is to rewrite error messages in a
17106 format that LyX understands.
17107 This makes it possible for LyX to place error boxes in the right places
17108 in the file buffer.
17111 \begin_layout Standard
17112 The first part, the
17113 \begin_inset Quotes eld
17117 \begin_inset Quotes erd
17120 setting, should be set to
17121 \begin_inset Quotes eld
17129 \begin_inset Quotes erd
17133 This basically means that LyX will call
17134 \begin_inset Quotes eld
17138 \begin_inset Quotes erd
17141 (a program or script) with the name of the Noweb file (normally a file
17142 in the LyX temp directory).
17146 \begin_layout Standard
17147 This is an implementation of
17148 \begin_inset Quotes eld
17152 \begin_inset Quotes erd
17155 that you can place in a directory on your path:
17158 \begin_layout LyX-Code
17162 \begin_layout LyX-Code
17166 \begin_layout LyX-Code
17167 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17170 \begin_layout Standard
17171 The next part of the converter setting is the
17172 \begin_inset Quotes eld
17176 \begin_inset Quotes erd
17179 which is to be set to
17180 \begin_inset Quotes eld
17185 parselog=listerrors
17188 \begin_inset Quotes erd
17192 This will run any errors that are generated by the
17193 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17200 process through the
17201 \begin_inset Quotes eld
17205 \begin_inset Quotes erd
17211 \begin_layout Standard
17212 The converter code looks in
17220 then on the path for the
17221 \begin_inset Quotes eld
17225 \begin_inset Quotes erd
17231 \begin_layout Standard
17232 The build will normally take place in LyX's temporary directory, so the
17233 files produced by the conversion will be in that directory.
17234 LyX will copy out what it regards as the `main' file, but the
17238 conversion may produce several files, and so most of these would then be
17239 deleted when LyX was closed.
17240 The present solution is to use a `copier',
17244 \begin_layout Plain Layout
17253 manual for information on these.
17262 script in its default mode, so that the entire contents of the temporary
17263 directory is copied.
17264 More will get copied than is needed, to be sure, but nothing will be lost.
17265 If, however, you know what extensions the generated files will have, this
17266 can be improved by using the
17275 This option takes a comma-separated list of extensions to copy.
17276 So, for example, if the conversion will generate only files with the extensions
17285 , then the correct definition would be:
17288 \begin_layout LyX-Code
17289 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17292 \begin_layout Standard
17293 The result will be that only files with these two extensions will be copied
17297 \begin_layout Paragraph
17298 Build instructions in the document
17301 \begin_layout Standard
17302 The last piece of the integration between LyX and noweb is the
17303 \begin_inset Quotes eld
17307 \begin_inset Quotes erd
17311 Generally, the instructions for building your program should be embedded
17312 in a scrap of its own.
17314 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17321 above uses the notangle command to look for this scrap (called
17322 \begin_inset Quotes eld
17326 \begin_inset Quotes erd
17329 ) and runs its contents through
17330 \begin_inset Quotes eld
17334 \begin_inset Quotes erd
17340 \begin_layout Standard
17341 Typically, such a scrap would look something like this:
17344 \begin_layout LyX-Code
17346 \begin_inset Newline newline
17350 \begin_inset Newline newline
17354 \begin_inset Newline newline
17357 if [ -z "${NOWEB_SOURCE}" ]
17358 \begin_inset Newline newline
17362 \begin_inset Newline newline
17365 NOWEB_SOURCE=myfile.nw
17366 \begin_inset Newline newline
17370 \begin_inset Newline newline
17374 code to extract files ...]
17375 \begin_inset Newline newline
17379 code to compile files ...]
17380 \begin_inset Newline newline
17386 \begin_layout Standard
17389 LIBDIR/examples/listerrors.lyx
17393 LIBDIR/examples/Literate.lyx
17395 which implement two versions of the
17396 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17403 program for some illustrations of how all of these pieces go together or
17406 LIBDIR/examples/noweb2lyx.lyx.
17409 Interestingly, these three files show off the language-indepence of the
17410 LyX literate programming support since they are written in Python, C and
17414 \begin_layout Subsubsection
17418 \begin_layout Standard
17419 All the Literate Programming support is configured by the
17424 ools\SpecialChar \menuseparator
17432 \begin_inset Quotes eld
17436 \begin_inset Quotes erd
17440 The important parts are:
17443 \begin_layout Description
17445 \begin_inset space ~
17449 \begin_inset Quotes eld
17453 \begin_inset Quotes erd
17457 \begin_inset space ~
17460 format Set up via the Formats tab, this is where the Noweb-specific pieces
17470 , the file extension is set to
17475 This tells LyX to create a file with a
17479 extension in the first step of the conversion process.
17482 \begin_layout Description
17484 \begin_inset space ~
17492 \begin_inset space ~
17495 format This is an empty format whose sole purpose is to be the endpoint
17496 of a conversion (which then allows us to set up a converter for it).
17499 \begin_layout Description
17508 This converter performs the
17509 \begin_inset Quotes eld
17513 \begin_inset Quotes erd
17516 of the literate document.
17517 For Noweb, it is set to
17518 \begin_inset Quotes eld
17523 noweave -delay -index $$i > $$o
17526 \begin_inset Quotes erd
17532 \begin_layout Description
17542 \begin_inset Quotes eld
17546 \begin_inset Quotes erd
17550 As stated above, the Converter is set to
17551 \begin_inset Quotes eld
17559 \begin_inset Quotes erd
17562 , with Flags set to
17563 \begin_inset Quotes eld
17568 originaldir,parselog=listerrors
17571 \begin_inset Quotes erd
17577 \begin_layout Subsubsection
17581 \begin_layout Standard
17582 There is also a new function implemented in the LyX server, the
17583 \begin_inset Quotes eld
17586 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17590 \begin_layout Standard
17591 When debugging code with ddd/gdb, it is possible to invoke a text editor
17592 at the current execution position with a single key stroke.
17593 The default ddd configuration for that is shift-ctrl-V.
17594 It happens that you can define the editor command line invocation in ddd
17600 dit\SpecialChar \menuseparator
17605 references\SpecialChar \menuseparator
17612 dialog and changing the "Edit Sources" entry.
17615 \begin_layout Standard
17616 I take advantage of the new created LyX server function and this ddd feature,
17618 \begin_inset Quotes eld
17622 \begin_inset Quotes erd
17628 \begin_layout LyX-Code
17629 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17632 \begin_layout Standard
17633 With this, whenever you are using ddd and find a point in the program that
17634 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17635 ddd you forward this information to LyX through the LyX server and then
17636 the LyX window will show the same file with the cursor at the same position
17637 ddd was pointing to.
17638 No more guessing or long scrolling to locate a point in the program back
17642 \begin_layout Standard
17643 Note however that you must enable the LyX server to get this feature working
17644 (it is disabled by default).
17645 You can enable it in
17657 ) by entering in the
17662 \begin_inset Quotes eld
17667 /home/<your-home-directory>/.lyx/lyxpipe
17670 \begin_inset Quotes erd
17676 \begin_layout Standard
17677 Read the LyX server documentation in the
17679 Customization Manual
17681 for further information.
17684 \begin_layout Subsubsection
17688 \begin_layout Standard
17689 There are six new buttons that can be added to your LyX toolbar.
17690 Five of these buttons are short cuts to layout styles:
17711 The last one is a short cut to the
17712 \begin_inset Quotes eld
17716 \begin_inset Quotes erd
17723 \begin_layout Standard
17724 LyX has a range of buttons that are available for tool bar customization.
17725 In my toolbar I like to combine the six short cuts above with two more:
17733 \SpecialChar \menuseparator
17741 \SpecialChar \menuseparator
17754 iew\SpecialChar \menuseparator
17762 Here is how it looks like:
17765 \begin_layout LyX-Code
17769 \begin_layout LyX-Code
17773 \begin_layout LyX-Code
17774 Icon "layout Standard"
17777 \begin_layout LyX-Code
17778 Icon "layout Section"
17781 \begin_layout LyX-Code
17782 Icon "layout LaTeX"
17785 \begin_layout LyX-Code
17786 Icon "layout LyX-Code"
17789 \begin_layout LyX-Code
17790 Icon "layout Scrap"
17793 \begin_layout LyX-Code
17797 \begin_layout LyX-Code
17801 \begin_layout LyX-Code
17802 Icon "buffer-typeset"
17805 \begin_layout LyX-Code
17806 Icon "build-program"
17809 \begin_layout LyX-Code
17813 \begin_layout LyX-Code
17817 \begin_layout LyX-Code
17821 \begin_layout LyX-Code
17825 \begin_layout LyX-Code
17829 \begin_layout Subsubsection
17830 Colors customization
17833 \begin_layout Standard
17834 There are a number of colors in LyX that can be customized in
17839 One of the things that bothers people is the LaTeX font color.
17840 The default color is red, since the scraps uses LaTeX font, and there is
17841 a lot of scraps in literate documents, you may get tired of seeing everything
17843 You can change it by going to the tabs
17852 \begin_layout Standard
17853 The next thing is the visible presence of the newline character in the screen.
17854 You can choose the color of this particular character and make it blend
17856 I recommend you choosing a color that is close to the background but not
17857 equal, that way you still can see it is there, but it is not bothering
17862 \begin_layout Chapter
17863 Secrets of the LaTeX Masters
17864 \begin_inset CommandInset label
17873 \begin_layout Standard
17874 Though LyX is a powerful tool, it cannot hope to support everything that
17875 can be done with pure TeX/LaTeX.
17876 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17877 as long as you are not afraid to use that
17878 \begin_inset Quotes eld
17882 \begin_inset Quotes erd
17885 button on the toolbar or add things to the LaTeX preamble.
17886 This section lists some tips, tricks, and otherwise cool ideas to give
17887 your document that extra little flair.
17890 Do try this at home
17892 , just start with something a little smaller and less important than your
17896 \begin_layout Standard
17897 Most ideas in this section require less common files in your LaTeX installation.
17898 If you have a system like teTeX, most will already be available.
17899 A few, however, will need to be downloaded from one of the CTAN archives.
17900 Often, there are several ways to do something, or several LaTeX style files
17901 which do the same thing.
17902 We do not endorse one choice over another, we simply claim that we have
17903 done a particular task with a particular file.
17904 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17907 \begin_layout Section
17911 \begin_layout Standard
17914 Lars Gullik Bjønnes
17917 \begin_layout Subsection
17921 \begin_layout Standard
17922 The aim for this chapter
17926 \begin_layout Plain Layout
17927 Editor's note: Lars' original chapter was a masterful description of how
17933 However, it was too long to flow smoothly in this document.
17934 I have therefore chosen to excerpt the most important sections here (sorry,
17935 Lars); you can read the original chapter (and more of the story!) in the
17938 examples/multicol.lyx
17946 is to show how the LaTeX package
17950 can be used in a LyX document.
17951 As LyX doesn't support the
17955 package natively yet, we have to use some small hacks.
17956 By reading this section it should be obvious how to do this.
17959 \begin_layout Subsection
17963 \begin_layout Standard
17968 package allows switching between one and multicolumn format on the same
17970 Footnotes are handled correctly (for the most part), but will be placed
17971 at the bottom of the page and not under each column.
17972 LaTeX's float mechanism, however, is partly disabled in the current implementat
17974 At the moment only page-wide floats can be used within the scope of the
17978 \begin_layout Subsection
17982 \begin_layout Subsubsection
17986 \begin_layout Standard
17987 If you want to have two columns in your text, you have use LaTeX mode to
17992 begin{multicols}{2}
17994 at the point where you want the two column layout to start, and then
18000 where you want it to end.
18004 \begin_layout Standard
18008 \begin_layout Plain Layout
18012 begin{multicols}{2}
18020 \begin_layout Standard
18025 The Adventure of the Empty House
18028 \begin_inset Newline newline
18033 Sir Arthur Conan Doyle
18036 \begin_layout Standard
18039 It was in the spring of the year 1894 that all London was interested, and
18040 the fashionable world dismayed, by the murder of the Honourable Ronald
18041 Adair under most unusual and inexplicable circumstances.
18042 The public has already learned those particulars of the crime which came
18043 out in the police investigation, but a good deal was suppressed upon that
18044 occasion, since the case for the prosecution was so overwhelmingly strong
18045 that it was not necessary to bring forward all the facts.
18046 Only now, at the end of nearly ten years, am I allowed to supply those
18047 missing links which make up the whole of that remarkable chain.
18048 The crime was of interest in itself, but that interest was as nothing to
18049 me compared to the inconceivable sequel, which afforded me the greatest
18050 shock and surprise of any event in my adventurous life.
18051 Even now, after this long interval, I find myself thrilling as I think
18052 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18053 ty which utterly submerged my mind.
18054 Let me say to that public, which has shown some interest in those glimpses
18055 which I have occasionally given them of the thoughts and actions of a very
18056 remarkable man, that they are not to blame me if I have not shared my knowledge
18057 with them, for I should have considered it my first duty to do so, had
18058 I not been barred by a positive prohibition from his own lips, which was
18059 only withdrawn upon the third of last month.
18062 \begin_layout Standard
18066 \begin_layout Plain Layout
18078 \begin_layout Subsubsection
18082 \begin_layout Standard
18083 The same pattern is used when you want more than two columns:
18086 \begin_layout Standard
18090 \begin_layout Plain Layout
18094 begin{multicols}{3}
18102 \begin_layout Standard
18105 It can be imagined that my close intimacy with Sherlock Holmes had interested
18106 me deeply in crime, and that after his disappearance I never failed to
18107 read with care the various problems which came before the public.
18108 And I even attempted, more than once, for my own private satisfaction,
18109 to employ his methods in their solution, though with indifferent success.
18110 There was none, however, which appealed to me like this tragedy of Ronald
18112 As I read the evidence at the inquest, which led up to a verdict of willful
18113 murder against some person or persons unknown, I realized more clearly
18114 than I had ever done the loss which the community had sustained by the
18115 death of Sherlock Holmes.
18116 There were points about this strange business which would, I was sure,
18117 have specially appealed to him, and the efforts of the police would have
18118 been supplemented, or more probably anticipated, by the trained observation
18119 and the alert mind of the first criminal agent in Europe.
18120 All day, as I drove upon my round, I turned over the case in my mind and
18121 found no explanation which appeared to me to be adequate.
18122 At the risk of telling a twice-told tale, I will recapitulate the facts
18123 as they were known to the public at the conclusion of the inquest.
18126 \begin_layout Standard
18130 \begin_layout Plain Layout
18142 \begin_layout Standard
18143 You can have more than 3 columns if you want to, but that might not be very
18144 pleasant for the eye.
18147 \begin_layout Subsubsection
18148 Columns inside columns
18151 \begin_layout Standard
18152 You can even have columns inside columns:
18155 \begin_layout Standard
18159 \begin_layout Plain Layout
18163 begin{multicols}{2}
18171 \begin_layout Standard
18174 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18175 at that time governor of one of the Australian colonies.
18176 Adair's mother had returned from Australia to undergo the operation for
18177 cataract, and she, her son Ronald, and her daughter Hilda were living together
18181 \begin_layout Standard
18185 \begin_layout Plain Layout
18189 begin{multicols}{2}
18197 \begin_layout Standard
18200 The youth moved in the best society--had, so far as was known, no enemies
18201 and no particular vices.
18202 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18203 had been broken off by mutual consent some months before, and there was
18204 no sign that it had left any very profound feeling behind it.
18205 For the rest {sic} the man's life moved in a narrow and conventional circle,
18206 for his habits were quiet and his nature unemotional.
18207 Yet it was upon this easy-going young aristocrat that death came, in most
18208 strange and unexpected form, between the hours of ten and eleven-twenty
18209 on the night of March 30, 1894.
18212 \begin_layout Standard
18216 \begin_layout Plain Layout
18228 \begin_layout Standard
18231 Ronald Adair was fond of cards--playing continually, but never for such
18232 stakes as would hurt him.
18233 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18234 It was shown that, after dinner on the day of his death, he had played
18235 a rubber of whist at the latter club.
18236 He had also played there in the afternoon.
18241 The evidence of those who had played with him-- Mr.
18242 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18243 and that there was a fairly equal fall of the cards.
18244 Adair might have lost five pounds, but not more.
18245 His fortune was a considerable one, and such a loss could not in any way
18247 He had played nearly every day at one club or other, but he was a cautious
18248 player, and usually rose a winner.
18249 It came out in evidence that, in partnership with Colonel Moran, he had
18250 actually won as much as four hundred and twenty pounds in a sitting, some
18251 weeks before, from Godfrey Milner and Lord Balmoral.
18252 So much for his recent history as it came out at the inquest.
18255 \begin_layout Standard
18259 \begin_layout Plain Layout
18271 \begin_layout Standard
18272 Please do read the file
18274 examples/multicol.lyx
18276 for more advanced examples including column and header spacing, vertical
18277 separator lines, and more.
18280 \begin_layout Section
18285 Paragraph Environment
18286 \begin_inset OptArg
18289 \begin_layout Plain Layout
18290 Numbering in Enumerate
18298 \begin_layout Standard
18304 \begin_layout Standard
18305 \begin_inset VSpace bigskip
18311 \begin_layout Standard
18313 The default numbering for the
18317 paragraph environment begins with Arabic numbers and ends with uppercase
18319 Suppose, however, you wanted a different type of numbering scheme.
18320 Here's a quickie example of how to change the numbering scheme:
18323 \begin_layout LyX-Code
18333 \begin_layout LyX-Code
18343 \begin_layout LyX-Code
18353 \begin_layout LyX-Code
18363 \begin_layout Standard
18364 \SpecialChar \ldots{}
18365 which changes the numbering scheme to uppercase Roman numerals, uppercase
18366 letters, Arabic numbers, and lowercase letter.
18369 \begin_layout Standard
18370 Additionally, the previous example also adds a little bit extra to the numbering
18372 For example, the first level label actually looks like:
18373 \begin_inset Quotes eld
18377 \begin_inset Quotes erd
18381 For ease of reading, we'll describe what the numbering schemes look like
18382 using a notation something like this: <
18383 \begin_inset Quotes eld
18387 \begin_inset Quotes erd
18391 \begin_inset space ~
18395 \begin_inset Quotes erd
18399 \begin_inset Quotes erd
18403 \begin_inset space ~
18407 \begin_inset Quotes erd
18411 \begin_inset Quotes erd
18415 \begin_inset space ~
18419 \begin_inset Quotes eld
18423 \begin_inset Quotes erd
18430 \begin_layout Standard
18431 As you can see in the example, there is a label command for each nesting
18438 \SpecialChar \ldots{}
18445 , as well as a counter,
18449 \SpecialChar \ldots{}
18455 There are also five
18456 \begin_inset Quotes eld
18460 \begin_inset Quotes erd
18493 , each of which take one counter as an argument.
18494 You can add characters before or after these, but there's no need to add
18498 \begin_layout Standard
18499 You can get really fancy with these.
18503 \begin_layout LyX-Code
18517 \begin_layout LyX-Code
18529 \begin_layout LyX-Code
18539 \begin_layout LyX-Code
18549 \begin_layout Standard
18550 produces the somewhat out of hand numbering scheme: <
18551 \begin_inset Quotes eld
18555 \begin_inset Quotes erd
18559 \begin_inset space ~
18563 \begin_inset Quotes erd
18567 \begin_inset Quotes erd
18571 \begin_inset space ~
18575 \begin_inset Quotes erd
18579 \begin_inset Quotes erd
18583 \begin_inset space ~
18587 \begin_inset Quotes eld
18591 \begin_inset Quotes erd
18598 \begin_layout Standard
18602 \begin_layout Section
18606 \begin_layout Standard
18612 \begin_layout Standard
18613 \begin_inset VSpace bigskip
18619 \begin_layout Standard
18624 \begin_layout Plain Layout
18630 tmpfont}{cmr17 scaled 2500}{
18642 \begin_layout Standard
18647 \begin_layout Plain Layout
18658 hose of you who like the style of old books probably also like
18659 \begin_inset Quotes eld
18663 \begin_inset Quotes erd
18666 ---those large capital letters which begin each new chapter or section.
18667 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18668 know some plain TeX!) but does require a lot of work and many iterations,
18669 as you can see by all the ugly TeX-mode stuff at the beginning of this
18673 \begin_layout Standard
18677 \begin_layout Plain Layout
18683 bigdrop{-1em}{3}{ptmri}{T}+
18688 here is a much easier way of doing this, of course.
18697 ) package from CTAN allows a simple way to add such letters to your documents.
18698 Since this package is not a standard part of teTeX, I can't demonstrate
18699 it within this document, but if you copy this paragraph to a new document,
18701 \begin_inset Quotes eld
18711 \begin_inset Quotes erd
18714 and the pluses from the TeX code at the beginning of the paragraph, and
18719 usepackage{dropcaps}
18721 to your LaTeX preamble, you will get a nice Times Roman Italic
18722 \begin_inset Quotes eld
18726 \begin_inset Quotes erd
18729 , whose height is three lines of text and which protrudes 1 em into the
18731 (Make certain you have copied
18732 \begin_inset Quotes eld
18740 \begin_inset Quotes erd
18743 into a directory where TeX can see it.) The first argument is the amount
18744 of indentation; in this case the negative sign moves it into the margin.
18745 The second argument is the height of the letter in number of lines of text.
18746 The third argument is the font name: virtually anything which has a tfm
18747 file should work (wade through the
18749 .../texmf/fonts/tfm
18751 directory for possibilities).
18752 My personal favorite is
18753 \begin_inset Quotes eld
18761 \begin_inset Quotes erd
18764 , a fancy German font specifically designed for dropped capitals.
18765 The fourth argument is the letter (or letters) to be dropped.
18770 package also offers the
18776 command, as well as a slightly simplified
18785 \begin_layout Section
18786 Non-standard Paragraph Shapes
18789 \begin_layout Standard
18795 \begin_layout Standard
18796 \begin_inset VSpace bigskip
18802 \begin_layout Standard
18806 \begin_layout Plain Layout
18818 \begin_layout Standard
18822 \begin_layout Plain Layout
18831 \begin_layout Plain Layout
18845 \begin_layout Standard
18850 \begin_layout Plain Layout
18861 \begin_layout Plain Layout
18870 \begin_layout Plain Layout
18879 \begin_layout Plain Layout
18888 \begin_layout Plain Layout
18897 \begin_layout Plain Layout
18906 \begin_layout Plain Layout
18915 \begin_layout Plain Layout
18924 \begin_layout Plain Layout
18933 \begin_layout Plain Layout
18942 \begin_layout Plain Layout
18951 \begin_layout Plain Layout
18960 \begin_layout Plain Layout
18969 \begin_layout Plain Layout
18978 \begin_layout Plain Layout
18987 \begin_layout Plain Layout
18996 \begin_layout Plain Layout
19005 \begin_layout Plain Layout
19014 \begin_layout Plain Layout
19023 \begin_layout Plain Layout
19029 There are times when the tyranny of rectangular paragraphs must be overthrown.
19030 In such situations, a call to the delightful plain TeX command
19037 As you can see, completely arbitrary shapes can be laid out with a suitable
19038 set of linelength definitions.
19039 While this parshape may look a bit silly and useless, one could conceive
19040 of situations such as finely tuned dropped capitals, word wrapping around
19041 non-rectangular graphics, etc.
19042 which will benefit from such handcrafting.
19045 \begin_layout Standard
19046 \begin_inset VSpace bigskip
19052 \begin_layout Standard
19057 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19064 is the number of lines of text which define the paragraph.
19065 If there turn out to be fewer lines, the shape is truncated; if there are
19066 more, the excess lines have the same dimensions as the last line of the
19076 entries specify the indentation of the line from the left margin, and the
19077 length of the line as measured from that point.
19078 The shape applies only to the current paragraph; everything is reset to
19079 normal for the next paragraph.
19082 \begin_layout Standard
19086 \begin_layout Plain Layout
19098 \begin_layout Section
19102 \begin_layout Standard
19103 As you can see, the examples in this section range from the useful to the
19105 While I don't expect that anyone will ever need the paragraph shape demonstrate
19106 d in the last section, the important point is that you can do almost anything
19107 you want in LyX if you are willing to figure out how to do it in TeX and
19109 TeX is a fantastically powerful typesetting system and all that power is
19110 available to you since LyX uses it as its backend.
projects / lyx.git / blob