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 This chapter is for both TeX-nicians and the LaTeX-curious.
243 In it, we'll explain how LyX and LaTeX work together to produce printable
245 This is the only place in any of the manuals where we assume you know something
249 \begin_layout Standard
250 At one time, we called LyX a
251 \begin_inset Quotes eld
254 WYSIWYM frontend to LaTeX,
255 \begin_inset Quotes erd
258 but that's no longer true.
259 There are frontends to LaTeX out there.
260 They are basically editors with the ability to run LaTeX and mark any errors
261 in the file you're editing.
270 run LaTeX, and it also marks errors in the file, it also does much, much
272 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
273 LyX has also added a few extensions to LaTeX.
274 Try the following sometime: select
276 Export\SpecialChar \menuseparator
286 menu, then look at the preamble of the resulting
291 You'll notice a variety of new macros defined specifically by LyX.
292 These macros are defined automatically, according to the features you use
296 \begin_layout Standard
297 There are several commands that automatically invoke LaTeX.
301 \begin_layout Itemize
307 iew\SpecialChar \menuseparator
317 \begin_layout Itemize
323 iew\SpecialChar \menuseparator
328 pdate\SpecialChar \menuseparator
334 \begin_layout Itemize
342 \SpecialChar \menuseparator
348 \begin_layout Itemize
356 \SpecialChar \menuseparator
362 \begin_layout Standard
363 They will only invoke LaTeX if the file has changed since the last time
368 \begin_layout Standard
369 When you run LaTeX on the file you're editing, LyX performs these steps:
372 \begin_layout Enumerate
373 Convert the document to LaTeX and save to a file with the extension
384 \begin_layout Enumerate
389 file (maybe several times).
392 \begin_layout Enumerate
393 If there are any errors, insert error boxes in the document to mark where
395 These boxes are transient and are not saved along with the document.
398 \begin_layout Standard
399 If you've run LaTeX using
427 , LyX performs two more steps:
430 \begin_layout Itemize
435 to convert the DVI file to PostScript:
439 \begin_layout Itemize
448 , the output file has the extension
453 \begin_layout Itemize
465 , the output file has the extension
473 \begin_layout Itemize
478 or send the PostScript file to the printer.
481 \begin_layout Section
482 \begin_inset Quotes eld
485 Help! LyX generated an unreadable
490 \begin_inset Quotes erd
496 \begin_layout Standard
497 Die-hard LaTeX users will scream and howl this into the night, then declare
498 LyX useless, simply because they didn't RTFM.
501 \begin_layout Standard
502 We're going to set the record straight.
503 LyX produces two kinds of LaTeX files.
504 One is human readable.
505 The other is LyX readable.
506 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
512 file is not human readable.
513 Don't even try to read it.
518 file that you can send to a colleague, select
523 xport\SpecialChar \menuseparator
540 \begin_layout Section
541 Translating LaTeX files into LyX
544 \begin_layout Standard
545 You can import a LaTeX file into LyX by using the
550 ile\SpecialChar \menuseparator
555 mport\SpecialChar \menuseparator
563 This will call a program named
567 ---which will create a file
575 ---and then open that file.
578 \begin_layout Standard
583 will translate most legal LaTeX, but not everything.
584 It will leave things it doesn't understand in TeX mode, so after translating
589 , you can look for red text and hand-edit it to look right.
592 \begin_layout Standard
593 If you just want to put a piece of TeX code into a LyX file, see section
598 \begin_inset CommandInset ref
600 reference "sec:Inserting-TeX-Code"
607 \begin_layout Section
608 Inserting TeX Code into LyX Documents
609 \begin_inset CommandInset label
611 name "sec:Inserting-TeX-Code"
618 \begin_layout Standard
619 This is a rather important point: You can always insert TeX code into any
621 LyX simply cannot, and will probably never be able to, display every possible
623 If ever you need to insert LaTeX commands into your LyX document, you can
624 use the TeX Code box, which you can insert into your document with
626 Insert\SpecialChar \menuseparator
630 The TeX Code box comes in three forms: collapsed, open, and inlined.
631 The first two are used just like any other collapsible (foldable) box (such
632 as footnotes), and are useful for significant amounts of LaTeX commands.
634 \begin_inset Quotes eld
638 \begin_inset Quotes erd
641 TeX Code box displays its content as part of the button, and is useful
642 for very short sections of LaTeX commands.
647 \begin_layout Plain Layout
657 \begin_layout Standard
658 You can switch between all three by right-clicking on the TeX Code.
659 Note that if you want more than one line of LaTeX commands, you cannot
660 use the inlined mode.
663 \begin_layout Standard
664 Here's an example of inserting LaTeX commands in a LyX document.
665 The code looks like this:
668 \begin_layout LyX-Code
672 \begin_inset Newline newline
678 \begin_inset Newline newline
681 This is an example for a minipage environment.
683 \begin_inset Newline newline
686 can put nearly everything in it, even (non-floating)
687 \begin_inset Newline newline
692 \begin_inset Newline newline
698 \begin_inset Newline newline
702 \begin_inset Newline newline
708 \begin_inset Newline newline
714 \begin_inset Newline newline
720 \begin_inset Newline newline
725 \begin_inset Newline newline
731 \begin_inset Newline newline
737 \begin_inset Newline newline
743 \begin_inset Newline newline
751 \begin_layout LyX-Code
755 \begin_layout Standard
756 The TeX Code box containing this text is directly after this paragraph.
757 Those of you reading the manual online will only see a bunch of funky text
759 Those reading a printed version of the manuals will see the actual results:
762 \begin_layout Standard
766 \begin_layout Plain Layout
773 \begin_layout Plain Layout
780 \begin_layout Plain Layout
782 This is an example for a minipage environment.
783 You can put nearly everything in it, even (non-floating) figures and tables.
787 \begin_layout Plain Layout
794 \begin_layout Plain Layout
799 \begin_layout Plain Layout
806 \begin_layout Plain Layout
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
826 \begin_layout Plain Layout
833 \begin_layout Plain Layout
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
859 \begin_layout Standard
860 In addition to these two methods, you can also create a separate file containing
861 some complex LaTeX structure.
864 Insert\SpecialChar \menuseparator
871 to include your file (you should select the type
876 We recommend that you only do this if you have a
885 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
889 \begin_layout Standard
890 There are a few last notes to emphasize:
893 \begin_layout Itemize
894 Inside of LyX, LaTeX code appears
899 \begin_layout Itemize
904 check if your LaTeX code is correct.
907 \begin_layout Itemize
908 Beware reinventing the wheel.
911 \begin_layout Standard
912 That last note refers to two things.
913 First, LyX does have quite a few features tucked into it, and more are
915 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
916 feature before you go off merrily coding LaTeX.
917 Second, there are numerous LaTeX packages out there to do all sorts of
918 things, from labels to envelopes to fancy multipage tables.
919 Check out a CTAN site for details (see Section
920 \begin_inset Quotes eld
924 \begin_inset Quotes erd
935 \begin_layout Plain Layout
940 : I seem to do this an awful lot.
941 Sat down and merrily began coding something to print out labels, only to
942 learn that there were already 2 different LaTeX packages to do this.
943 Worse yet --- I had them already!
951 \begin_layout Standard
952 If you do need to do some wild and fancy things within your document, be
953 sure to check out a good LaTeX book for assistance.
954 There are a number of them listed in the bibliography of the
961 \begin_layout Standard
962 There are a number of LaTeX commands which have to be placed before the
963 beginning of the actual text.
964 They go into the preamble, and this is explained in the next section.
967 \begin_layout Section
968 LyX and the LaTeX Preamble
971 \begin_layout Subsection
972 About the LaTeX Preamble
975 \begin_layout Standard
976 If you already know LaTeX, there is no need to explain here what the preamble
978 If you don't, the following will give you some ideas --- we recommend again
979 that you consult a LaTeX book for further information.
980 In any case, you should read the points below, because they explain what
981 you can do and what you don't need to do in the LaTeX preamble of a LyX
985 \begin_layout Standard
986 The LaTeX preamble comes at the very beginning of a document,
994 \begin_layout Itemize
995 declare the document class.
996 LyX already does this for you.
1000 \begin_layout Standard
1001 If you're a seasoned LaTeX-nician, and you have some custom document class
1002 you want to use, check out the
1004 Customization Manual
1006 for information on how to make LyX interface to it.
1007 Be sure to submit your efforts to the LyX Team for inclusion in future
1012 \begin_layout Itemize
1013 declare the usage of packages.
1014 LaTeX packages provide special commands, which are only available within
1015 a document when the package has been declared in the preamble.
1016 For example, the package
1020 forces all paragraphs to be indented.
1021 There are other packages for labels, envelopes, margins, etc.
1025 \begin_layout Itemize
1026 set counters, variables, lengths and widths.
1027 There are several LaTeX counters and variables which
1031 be set globally from within the preamble in order to have the desired effect.
1032 [There are other variables which you can set and reset inside the document,
1033 too.] Margins are a good example of something which must be set in the preamble.
1034 Another example is the label format for lists.
1035 You can actually set these just about anywhere, but it's best to do it
1036 just once, inside the preamble.
1039 \begin_layout Itemize
1040 declare user defined commands [with
1052 ], mostly abbreviations for LaTeX commands which appear very often inside
1054 Although the preamble is a good place to declare such commands, they
1058 be declared anywhere else [but
1062 they are used for the first time, of course\SpecialChar \ldots{}
1064 This can be useful if there is a lot of raw LaTeX code in your document,
1065 which normally should not be the case.
1068 \begin_layout Standard
1069 LyX adds its own set of definitions to the preamble of the
1074 This makes LaTeX files generated by LyX portable.
1077 \begin_layout Subsection
1078 Changing the Preamble
1081 \begin_layout Standard
1082 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1083 can't change them without patching LyX itself.
1084 You can, however, add your own stuff to the preamble.
1085 There are two ways to do this:
1088 \begin_layout Enumerate
1095 \begin_inset space ~
1118 \SpecialChar \menuseparator
1126 dialog, depending on your frontend.
1127 Note that the LyX keybindings will not work in this dialog, alas.
1130 \begin_layout Enumerate
1131 Use the preamble contents you've added as your default template (see
1132 \begin_inset Quotes eld
1136 \begin_inset Quotes erd
1143 ), so that it will be the default preamble for any file you create.
1146 \begin_layout Standard
1147 LyX adds anything in the
1154 dialog to its own built-in preamble.
1155 Before adding your own declarations in the preamble, you should make sure
1156 that LyX doesn't already support what you want to do (remember what we
1157 said about reinventing the wheel?).
1160 make sure your preamble code is correct
1163 LyX doesn't check it.
1166 \begin_layout Subsection
1170 \begin_layout Standard
1171 Here are some examples of what you can add to a preamble, and what they
1175 \begin_layout Subsubsection
1179 \begin_layout Standard
1180 There are two variables under LaTeX that control page position:
1193 Their names should be self-explanatory.
1194 These variables are useful if you think for a moment about computer labels.
1195 Sometimes, the size of a print medium and the area of the medium that you
1196 can actually print on aren't the same.
1212 \begin_layout Standard
1213 The default values for
1226 \begin_inset space ~
1230 \begin_inset space ~
1234 \begin_inset space ~
1237 the page isn't shifted.
1240 \begin_layout Standard
1241 Unfortunately, some DVI drivers always seem to shift the page.
1242 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1243 If you're using LyX on a system that you don't personally maintain, and
1244 your sysadmin is a doofus,
1257 Suppose you're left and top margins are always 0.5 inches too big.
1258 You can add this to the preamble:
1261 \begin_layout LyX-Code
1269 \begin_layout LyX-Code
1277 \begin_layout Standard
1278 \SpecialChar \ldots{}
1279 and your margins should now be correct.
1282 \begin_layout Subsubsection
1286 \begin_layout Standard
1287 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1288 There's a rather nice package, available at your nearest CTAN archive,
1289 for printing sheets of labels, called
1294 Now, your system may not have this package installed by default.
1295 We leave that up to you to check.
1296 You'll also want to read the documentation for it; we're not going to do
1298 Since this is an example, however, we'll give you an example of how you
1302 \begin_layout Standard
1303 First, make sure you're using the
1308 Next, you need to put the following in your preamble:
1311 \begin_layout LyX-Code
1317 \begin_layout LyX-Code
1323 \begin_layout LyX-Code
1329 \begin_layout LyX-Code
1335 \begin_layout LyX-Code
1341 \begin_layout LyX-Code
1347 \begin_layout LyX-Code
1353 \begin_layout Standard
1354 This sets things up for Avery® label sheets, stock #5360.
1355 You're now ready to print labels, but you'll need to insert LaTeX code,
1356 placing the commands
1368 around each label text.
1369 This and other special features of
1373 are explained in its documentation.
1376 \begin_layout Standard
1377 Someday, someone may write a LyX layout file to support this package directly.
1378 Maybe that someone is you.
1381 \begin_layout Subsubsection
1382 Example #3: Paragraph Indentation
1385 \begin_layout Standard
1386 Americans are trained to indent the first line of
1391 As with all of their other weird quirks, most Americans will whine and
1392 moan until they can have their way and indent the first line of all paragraphs.
1396 \begin_layout Plain Layout
1401 : This was written by an American ---
1405 ! It's my perception of my fellow countrymen.
1406 Tough if you don't like it.
1415 \begin_layout Standard
1416 Of course, this behavior isn't standard typography.
1417 In books, you typically only indent the first line of a paragraph
1421 it follows another one.
1422 The idea behind indenting the first line of a paragraph is to distinguish
1423 neighboring paragraphs from one another.
1424 If there is no previous paragraph, for example, it follows a figure, or
1425 is the first paragraph in a section, then there is no special indentation.
1429 \begin_layout Standard
1430 If you're a typical American, though, you don't care about such esoteric
1431 things; you want your indentation! Add this to the preamble:
1434 \begin_layout LyX-Code
1437 usepackage{indentfirst}
1440 \begin_layout Standard
1441 If your TeX distribution isn't a braindead one, you'll have this package,
1442 and all of your paragraphs will get the indentation you think they deserve.
1445 \begin_layout Subsubsection
1446 Example #4: This Document
1449 \begin_layout Standard
1450 You can also check out the preamble of this document to get an idea of some
1451 of the advanced things you can do.
1452 You'll probably need to make the
1457 reamble\SpecialChar \ldots{}
1460 dialog full-screen to see most of it.
1461 Also, there are more examples and an assortment of LaTeX
1462 \begin_inset Quotes eld
1466 \begin_inset Quotes erd
1470 \begin_inset space ~
1474 \begin_inset CommandInset ref
1476 reference "cha:secrets"
1484 \begin_layout Section
1485 LyX and LaTeX Errors
1488 \begin_layout Standard
1489 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1491 It then uses the log-file from the LaTeX run to do a post-mortem.
1492 As we stated earlier in the chapter, LyX generates two kinds of
1496 files, one of which it uses to locate errors in the document.
1497 If there was an error someplace, LyX will put a box with the word
1498 \begin_inset Quotes eld
1502 \begin_inset Quotes erd
1505 at the appropriate place in the document.
1509 \begin_layout Plain Layout
1510 LyX will occasionally misguess where the error was.
1511 This will typically happen with tables, figures, math, and the preamble.
1516 It will also display a message alerting you to the fact that there were
1520 \begin_layout Standard
1521 You can navigate through the errors by using
1537 \begin_inset Quotes eld
1541 \begin_inset Quotes erd
1544 the error-boxes and view the error message LaTeX produced by clicking on
1548 \begin_layout Standard
1549 Some folks also like to look at the log file directly, accessible from
1554 ocument\SpecialChar \menuseparator
1560 \begin_inset space ~
1564 \begin_inset space ~
1570 There are some fairly common error messages and warnings.
1571 We'll cover those here.
1572 You should look at a good LaTeX book for a complete listing.
1575 \begin_layout Itemize
1576 \begin_inset Quotes eld
1584 \begin_inset Quotes eld
1591 \begin_layout Standard
1592 Anything beginning with these word is a warning message for the purpose
1594 \begin_inset Quotes eld
1598 \begin_inset Quotes erd
1601 the LaTeX code itself.
1602 You'll get messages like this if you added or changed cross-references
1603 or bibliography entries, in which case, LaTeX is trying to tell you that
1604 you need to make another run.
1607 \begin_layout Standard
1608 You can by-and-large ignore these.
1612 \begin_layout Itemize
1613 \begin_inset Quotes eld
1621 \begin_inset Quotes erd
1628 \begin_layout Standard
1629 Another warning message, this time about fonts which LaTeX couldn't find.
1630 The rest of the message will often say something about a replacement font
1634 \begin_layout Standard
1635 You can safely ignore these.
1639 \begin_layout Itemize
1640 \begin_inset Quotes eld
1650 \begin_inset Quotes erd
1657 \begin_layout Standard
1663 They are warning you about lines that were too long and run past the right
1665 Almost always, this is unnoticeable in the final output.
1666 Or, only one or two characters extend past the margin.
1667 LaTeX seems to generate at least one of these messages for just about any
1671 \begin_layout Standard
1672 You can ignore these stupid messages.
1673 Your eyes will tell you if there's a problem with something that's too
1674 wide; just look at the output.
1678 \begin_layout Itemize
1679 \begin_inset Quotes eld
1689 \begin_inset Quotes erd
1696 \begin_layout Standard
1697 Not quite as common as its cousin.
1698 LaTeX seems to like to print lines that are a bit too wide as opposed to
1699 ones that are a bit too narrow.
1700 We have no idea why.
1703 \begin_layout Standard
1704 You can ignore these, too.
1708 \begin_layout Itemize
1709 \begin_inset Quotes eld
1719 \begin_inset Quotes erd
1723 \begin_inset Quotes eld
1733 \begin_inset Quotes erd
1740 \begin_layout Standard
1741 Warnings about troubles breaking the page.
1742 Once again, just look at the output.
1743 Your eyes will tell you where something has gone wrong.
1747 \begin_layout Itemize
1748 \begin_inset Quotes eld
1754 \begin_inset Quotes els
1758 \begin_inset Quotes ers
1764 \begin_inset Quotes erd
1771 \begin_layout Standard
1773 \begin_inset Quotes eld
1777 \begin_inset Quotes erd
1780 isn't installed on this system.
1781 This usually appears because some package your document needs isn't installed.
1782 If you didn't touch the preamble or didn't use the
1788 command, then one of the packages LyX tried to load is missing.
1794 elp\SpecialChar \menuseparator
1801 , to get a list of packages that LyX knows about.
1802 This file is updated whenever you reconfigure LyX (using
1809 \SpecialChar \menuseparator
1814 ) and tells you which packages have been detected and what they do.
1817 \begin_layout Standard
1828 command, and the package in question isn't installed, you'll need to install
1833 \begin_layout Itemize
1834 \begin_inset Quotes eld
1839 LaTeX Error: Unknown option
1842 \begin_inset Quotes erd
1849 \begin_layout Standard
1850 Error messages beginning with this are trying to tell you that you specified
1851 a bad or undefined option to a package.
1852 Check the package's documentation.
1856 \begin_layout Itemize
1857 \begin_inset Quotes eld
1862 Undefined control sequence
1865 \begin_inset Quotes erd
1872 \begin_layout Standard
1873 If you've inserted LaTeX code into your document, but made a typo, you'll
1875 You may have forgotten to load a package.
1876 In any case, this error message usually means that you used an undefined
1881 \begin_layout Standard
1882 There are other error and warning messages.
1883 Some are self-explanatory.
1884 These are usually LaTeX messages.
1885 Others are downright cryptic.
1886 These are actually TeX error messages, and we really have
1890 what they mean or how to decipher them.
1893 \begin_layout Standard
1894 There's a general sequence you should follow if you get error messages:
1897 \begin_layout Enumerate
1898 Look at the LaTeX code you inserted for typos.
1901 \begin_layout Enumerate
1902 If there are no typos, check and see that you used the command(s) correctly.
1905 \begin_layout Enumerate
1906 If you get a bunch of error boxes piled up at the very top of the document,
1907 it means that there are errors in the preamble.
1908 Start debugging your preamble.
1911 \begin_layout Enumerate
1912 If you didn't add anything to the preamble and didn't add any LaTeX code
1913 to the document, the first suspect is your LaTeX distribution itself.
1914 Check for missing packages and install them.
1917 \begin_layout Enumerate
1918 Okay, so there are no missing packages.
1919 Did you use any of the fine-tuning options in LyX? Specifically, did you
1924 any of them, like trying to manually insert lots of
1927 \begin_inset space ~
1940 s? Did you try to kludge something together with these instead of using
1941 the appropriate paragraph environment?
1944 \begin_layout Enumerate
1945 All right, you didn't use any of the fine-tuning options, you played by
1947 Did you try to pull a fancy maneuver? Did you do something funky inside
1948 a table or an equation, like inserting a graphic into a table cell?
1951 \begin_layout Enumerate
1952 Do you have long sections of text where LaTeX cannot find a place to break
1953 a line? By default, LaTeX is rather strict about how much extra inter-word
1954 spacing it will add in order to break a line.
1955 Preferably, you should rework the paragraph to avoid the problem.
1956 If this isn't an option, you can wrap your text in
1962 to make LaTeX's line breaking more, well, sloppy.
1965 \begin_layout Enumerate
1966 Did you go overboard with the nesting? LyX (currently) doesn't check to
1967 make sure you're in the limits for nesting environments.
1968 If you nested a bunch of environments to the
1969 \begin_inset Formula $17^{\mathrm{th}}$
1972 level, that's the problem.
1975 \begin_layout Enumerate
1976 Okay, you didn't get any error messages, but your output looks whacked.
1977 If you have a table or figure that's too wide or long for the page, you
1982 \begin_layout Enumerate
1983 rescale the figure so it fits.
1986 \begin_layout Enumerate
1987 trim down the table so it fits.
1990 \begin_layout Standard
1991 If something else is wrong with the output, and you didn't try to pull anything
1992 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1996 \begin_layout Standard
1997 If all this doesn't help --- well, then
2001 you might have found a bug in LyX\SpecialChar \ldots{}
2005 \begin_layout Chapter
2009 \begin_layout Section
2010 Customizing Bibliographies with BibTeX
2013 \begin_layout Standard
2014 The basics how to use BibTeX are explained in section
2016 Bibliography databases (BibTeX)
2023 The following subsections explain special bibliography features supported
2027 \begin_layout Subsection
2028 Alternative Citation Styles
2031 \begin_layout Standard
2032 Standard BibTeX uses numbers (e.
2033 \begin_inset space \thinspace{}
2037 \begin_inset space \space{}
2041 \begin_inset Quotes eld
2045 \begin_inset Quotes erd
2048 ) to refer to a cited work.
2049 However, in many scientific disciplines, other citation styles are in use.
2050 The most common one is the author-year style (e.
2051 \begin_inset space \thinspace{}
2055 \begin_inset space \space{}
2059 \begin_inset Quotes eld
2063 \begin_inset Quotes erd
2067 LyX supports two packages that provide this style,
2076 Both packages have their own pros and cons, which cannot be listed in detail.
2077 If you only want to have simple author-year (or author-numerical) style
2078 or if you want to use one of the countless style files for natbib, than
2083 package is probably your choice.
2084 If you need special features like short title references, ibidem etc., you
2085 might consider the fairly new
2092 \begin_layout Standard
2093 The handling of both packages in LyX is basically the same.
2096 Document\SpecialChar \menuseparator
2112 With both packages, you will get some extra features in the citation dialog
2113 and you can select the style of the reference (
2114 \begin_inset Quotes eld
2118 \begin_inset Quotes erd
2122 \begin_inset Quotes eld
2126 \begin_inset Quotes erd
2130 \begin_inset Quotes eld
2134 \begin_inset Quotes erd
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2146 Note that both packages need specifically designed style files (they both
2147 ship their own, while there are lots of additional style files and even
2148 an interactive style file builder
2152 \begin_layout Plain Layout
2154 \begin_inset Flex URL
2157 \begin_layout Plain Layout
2159 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2176 \begin_layout Subsection
2177 Sectioned Bibliographies
2180 \begin_layout Standard
2181 Sometimes you might need to divide your bibliography into several sections.
2182 If you are for instance a historian, the possibility to separate sources
2183 and scientific works is most likely a
2184 \begin_inset Quotes eld
2188 \begin_inset Quotes erd
2192 Unfortunately, BibTeX itself does not allow you to do this.
2193 But with the help of some LaTeX packages, BibTeX can be extended to fit
2197 \begin_layout Standard
2198 LyX provides native support for one of these packages,
2206 \begin_layout Plain Layout
2208 \begin_inset Flex URL
2211 \begin_layout Plain Layout
2213 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2223 The advantage of this package (compared to other packages like
2227 ) is that you don't need to define new citation commands.
2228 Instead, you need to prepare different bibliographic databases which include
2229 the entries for the different sections of the bibliography.
2230 For example: If you want to divide your bibliography into the sections
2232 \begin_inset Quotes eld
2236 \begin_inset Quotes erd
2240 \begin_inset Quotes eld
2244 \begin_inset Quotes erd
2247 , you first need to create two bibliographic databases, e.
2248 \begin_inset space \thinspace{}
2252 \begin_inset space \space{}
2267 \begin_layout Standard
2270 Document\SpecialChar \menuseparator
2280 \begin_inset space ~
2286 Now you can insert multiple BibTeX bibliographies, one for each section
2287 of your bibliography.
2288 Returning to our example: Insert the BibTeX bibliography
2292 and a second one for the database
2297 You are free to use the same or different styles for each section.
2298 Additionally, you can chose if the bibliography section should contain
2300 \begin_inset Quotes eld
2303 all cited references
2304 \begin_inset Quotes erd
2307 of the specified database(s) (which is the default),
2308 \begin_inset Quotes eld
2311 all uncited references
2312 \begin_inset Quotes erd
2316 \begin_inset Quotes eld
2320 \begin_inset Quotes erd
2324 This might be useful if you would like to separate your bibliography into
2326 \begin_inset Quotes eld
2330 \begin_inset Quotes erd
2334 \begin_inset Quotes eld
2338 \begin_inset Quotes erd
2342 \begin_inset Quotes eld
2346 \begin_inset Quotes erd
2350 The titles for the sections can be added as ordinary sections or subsections.
2355 removes the bibliography title, you have manually re-add that, too (as
2356 a chapter* or section*, for instance).
2359 \begin_layout Subsection
2360 Multiple Bibliographies
2363 \begin_layout Standard
2364 Multiple bibliographies, e.
2365 \begin_inset space \thinspace{}
2369 \begin_inset space \space{}
2372 a bibliography for each section or chapter of the document, are not supported
2378 package, which is used for the creation of sectioned bibliographies in
2379 LyX (see the previous section), provides an easy way to solve this task,
2380 if you are willing to use some TeX Code (see section
2381 \begin_inset space ~
2385 \begin_inset CommandInset ref
2387 reference "sec:Inserting-TeX-Code"
2395 \begin_layout Plain Layout
2396 An alternative approach is to use the
2404 package, respectively.
2412 \begin_layout Standard
2415 Document\SpecialChar \menuseparator
2425 \begin_inset space ~
2431 In the document, you have to enclose the sections, which shall contain
2432 their own bibliography (including the BibTeX bibliography itself), between
2445 (those commands have to be inserted as ERT).
2446 The bibliography will contain all references which have been cited in the
2452 If you are using this approach, then
2456 citation reference has to be inside some btUnit.
2457 Also, the btUnits cannot be nested.
2460 \begin_layout Standard
2464 \begin_layout Section
2468 \begin_layout Subsection
2472 \begin_layout Standard
2473 When you are working on a large file with many sections, it is often convenient
2474 to break up the document into several files, or perhaps you have something
2475 where a table may change from time to time, but the preceding text does
2477 In these cases, you should seriously consider using multipart documents.
2478 For example, scientific papers often have five major sections: the introduction
2479 , observations, results, discussion, and conclusion.
2480 Each of these could be its own separate LyX file, with one
2481 \begin_inset Quotes eld
2485 \begin_inset Quotes erd
2488 file which contains the title, authors, abstract, references, etc., plus
2489 the five included files.
2490 It is important to note that each of these files is a full LyX file which
2491 can be formatted and printed on its own, as well as included in a master
2493 Each of these files must have the same document class, however--- don't
2494 attempt to mix book classes with article classes.
2495 You may also include LaTeX files; however, these files must not have their
2501 everything up to and including the
2513 line must be deleted) or else errors will be generated when you try to
2517 \begin_layout Standard
2518 LyX allows you to include files quite easily with
2520 Insert\SpecialChar \menuseparator
2522 \begin_inset space ~
2528 When you click on this selection a small box is inserted into the file
2529 at the current cursor location.
2530 Clicking on the box raises a dialog which allows you to select the file
2531 to be included, and the method of its inclusion.
2535 \begin_layout Standard
2536 The file selection box should by now be obvious.
2537 The three inclusion methods are
2538 \begin_inset Quotes eld
2542 \begin_inset Quotes erd
2546 \begin_inset Quotes eld
2550 \begin_inset Quotes erd
2554 \begin_inset Quotes eld
2558 \begin_inset Quotes erd
2562 The difference between
2563 \begin_inset Quotes eld
2567 \begin_inset Quotes erd
2571 \begin_inset Quotes eld
2575 \begin_inset Quotes erd
2578 is really only meaningful to LaTeXperts, but the practical difference is
2579 that files which are
2580 \begin_inset Quotes eld
2584 \begin_inset Quotes erd
2587 are typeset beginning on a new page, while files which are
2588 \begin_inset Quotes eld
2592 \begin_inset Quotes erd
2595 are typeset starting on the current page.
2596 Perhaps the labeling in LyX will be changed someday to reflect this.
2599 \begin_layout Standard
2600 Generally, the master file is converted into a full LaTeX file before typesettin
2601 g, while the included files are converted to LaTeX files which do not have
2602 all the preamble information.
2608 \begin_inset space ~
2615 button prevents this conversion.
2618 \begin_layout Standard
2620 \begin_inset Quotes eld
2624 \begin_inset Quotes erd
2627 included file allows you to include a file typeset exactly as it appears
2629 \begin_inset space ~
2632 verbatim mode, with the characters set in a fixed-width typewriter font.
2633 Normally, spaces in this file are invisible, though two consecutive spaces
2634 are conserved, unlike LyX's normal treatment of spaces.
2635 However, setting the
2638 \begin_inset space ~
2642 \begin_inset space ~
2646 \begin_inset space ~
2651 checkbox typesets a mark to unambiguously define the presence of a space.
2655 \begin_layout Subsection
2656 Cross-References Between Files
2659 \begin_layout Standard
2660 It is possible to set up cross-references between the different files.
2661 First, open all the files in question: let's call them A and B in a two
2662 file example, where B is included in A.
2663 Let's say you insert a label in A, then want to reference it in B.
2664 Open the cross-reference dialog in whilst in document B, and you can select
2666 \begin_inset Quotes eld
2670 \begin_inset Quotes erd
2676 \begin_layout Subsection
2677 Bibliography Lists in all Subdocuments
2680 \begin_layout Standard
2681 Copy the bibliography list with all entries to all subdocuments and transform
2683 This way LyX will find the
2687 -files and you can easily insert references without making the bibliography
2691 \begin_layout Standard
2692 As the bibliography list is in a comment, LaTeX won't use use it and the
2693 references will look like this [?] instead of [1].
2694 A solution is to use the LaTeX-package
2698 that will only include comments by processing the files separately.
2699 To do this, add in the LaTeX preamble of every subdocument the following:
2702 \begin_layout LyX-Code
2708 \begin_layout LyX-Code
2711 includecomment{comment}
2714 \begin_layout Standard
2716 \begin_inset Flex URL
2719 \begin_layout Plain Layout
2721 http://wiki.lyx.org/FAQ/Unsorted#toc31
2729 \begin_layout Section
2730 Fancy Headers and Footers
2733 \begin_layout Standard
2734 The default page layout is rather plain; for an article document class,
2735 all you get is a centered page number at the bottom of the page.
2736 This document is the book class, so it appears to be a bit fancier, but
2737 to really put on a show, you need to set the document page style to
2738 \begin_inset Quotes eld
2742 \begin_inset Quotes erd
2745 , as mentioned in the
2748 \begin_inset space ~
2754 This section describes the LaTeX codes you need to insert in your LaTeX
2755 preamble or the text in order to get the desired effects.
2758 \begin_layout Standard
2759 The page header is divided into three fields, not surprisingly labeled
2760 \begin_inset Quotes eld
2764 \begin_inset Quotes erd
2768 \begin_inset Quotes eld
2772 \begin_inset Quotes erd
2776 \begin_inset Quotes eld
2780 \begin_inset Quotes erd
2784 The footer is also divided into these three fields.
2785 The LaTeX commands to set these fields in the simplest manner are
2810 Suppose you wish to put your name in the upper left hand corner of each
2812 Simply insert the following command in the preamble:
2815 \begin_layout Standard
2824 \begin_layout Standard
2825 You will now see your name in the upper left.
2826 If a field has a default entry that you would like to get rid of (often
2827 the page number appears in the central footer, simply include a command
2828 with a blank argument, e.
2829 \begin_inset space \thinspace{}
2835 \begin_layout Standard
2843 \begin_layout Standard
2844 Let's get really fancy: lets put the section number with the word
2845 \begin_inset Quotes eld
2849 \begin_inset Quotes erd
2853 \begin_inset space \thinspace{}
2857 \begin_inset space ~
2860 Section 3) in the upper left, the page number (e.
2861 \begin_inset space \thinspace{}
2865 \begin_inset space ~
2868 Page 4) in the upper right, your name in the lower left, and the date in
2870 The following commands should now appear in the preamble:
2873 \begin_layout Standard
2883 \begin_layout Standard
2891 \begin_layout Standard
2901 \begin_layout Standard
2910 \begin_layout Standard
2918 \begin_layout Standard
2928 \begin_layout Standard
2941 access LaTeX's section and page counters, and so print out the current
2942 section and page numbers.
2949 simply prints out today's date.
2952 \begin_layout Standard
2953 The thicknesses of the horizontal rules drawn beneath the header and above
2954 the footer can also be modified.
2955 If you don't want one of the headers, set its thickness to 0.
2956 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2957 Use the commands, e.
2958 \begin_inset space \thinspace{}
2968 headrulewidth}{0.4pt}
2976 footrulewidth}{0.4pt}
2978 to set the thicknesses.
2981 \begin_layout Standard
2982 You can switch the header/footer settings on and off for individual pages
2987 thispagestyle{empty}
2993 thispagestyle{plain}
2999 thispagestyle{fancy}
3002 Simply insert them in the text on the page you want changed and mark them
3004 In fact, title pages are marked as plain by default, while following pages
3005 are marked fancy when using the global fancy setting.
3008 \begin_layout Standard
3009 There are more complex commands which will let you insert things in the
3010 upper left on odd numbered pages, etc., but I will refer you to the
3014 package documentation for more descriptions.
3015 For example, if you have a teTeX installation, look for
3017 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3023 \begin_layout Standard
3024 As a final example, it is possible to include an Encapsulated PostScript
3025 file in the header or footer.
3026 Suppose you want to put a company logo in the upper lefthand corner.
3027 You might try something like
3030 \begin_layout Standard
3039 includegraphics{logo.eps}}}
3042 \begin_layout Standard
3044 (you may need to preface this with
3048 usepackage{graphics}
3050 if you don't include EPS files elsewhere in your document).
3053 \begin_layout Section
3054 Itemize Bullet Selection
3055 \begin_inset CommandInset label
3064 \begin_layout Standard
3070 \begin_layout Subsection
3074 \begin_layout Standard
3075 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3076 Using this dialog you can easily specify what bullet shape to use at each
3077 level of an itemized list.
3078 These settings are document-wide so you won't be able to specify different
3079 sets of bullets for different paragraphs
3083 \begin_layout Plain Layout
3084 Well, actually you can but you'll have to do it by hand.
3092 \begin_layout Subsection
3096 \begin_layout Standard
3097 Open the dialog by selecting the
3102 ocument\SpecialChar \menuseparator
3109 menu item and then select the
3119 \begin_layout Standard
3120 The dialog provides you with a table of bullet shapes.
3121 A column of buttons on the left of the table provides access to the six
3122 different panels of bullet shapes.
3123 The row of buttons across the top is used to select which bullet depth
3125 A text entry under the table shows the currently selected bullet shape's
3126 LaTeX equivalent and this can be edited if desired.
3127 If you do modify the text you will also need to specify any needed packages
3128 in the LaTeX preamble.
3131 \begin_layout Standard
3132 The six panels are divided up by the packages they require.
3133 The following table shows the mappings from button name to LaTeX packages.
3136 \begin_layout Standard
3138 \begin_inset Tabular
3139 <lyxtabular version="3" rows="7" columns="2">
3141 <column alignment="center" valignment="top" width="0pt">
3142 <column alignment="center" valignment="top" width="0pt">
3144 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3147 \begin_layout Plain Layout
3162 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3165 \begin_layout Plain Layout
3182 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3185 \begin_layout Plain Layout
3200 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3203 \begin_layout Plain Layout
3219 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3222 \begin_layout Plain Layout
3237 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3240 \begin_layout Plain Layout
3257 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3260 \begin_layout Plain Layout
3275 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3278 \begin_layout Plain Layout
3295 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3298 \begin_layout Plain Layout
3313 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3316 \begin_layout Plain Layout
3333 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3336 \begin_layout Plain Layout
3351 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3354 \begin_layout Plain Layout
3371 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3374 \begin_layout Plain Layout
3389 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3392 \begin_layout Plain Layout
3415 \begin_layout Standard
3416 LyX doesn't stop you using bullets from packages you don't have.
3417 If you get errors from LaTeX when you try to view or print the file then
3418 its likely you are missing a package.
3419 LyX doesn't restrict your use since you may be editing locally and exporting
3423 \begin_layout Subsection
3427 \begin_layout Standard
3428 Select which bullet depth you want to change then select the bullet shape
3430 Any changes will not be visible in LyX, but are visible when viewing the
3431 document using xdvi or ghostview.
3434 \begin_layout Standard
3435 You can reset a bullet shape to the default simply by clicking your right
3436 mouse button on the appropriate bullet depth button.
3439 \begin_layout Standard
3444 want to have multiple sets of paragraphs with different sets of bullets
3445 in each then you're going to have to get your hands dirty.
3446 The itemize bullet selection dialog can help though because it provides
3447 you with the LaTeX code for a wide range of bullet shapes.
3448 To make your own custom paragraphs you have the following options:
3451 \begin_layout Standard
3455 \begin_layout Plain Layout
3471 \begin_layout Standard
3475 \begin_layout Plain Layout
3497 \begin_layout Itemize
3498 Use the LaTeX command
3504 to specify a new bullet shape for a given depth.
3505 You'll also need to save the current bullet shape so you can restore it
3507 In this itemized list the following LaTeX code was used to change the bullet
3508 used for the first depth.
3509 \begin_inset Newline newline
3525 \begin_inset Newline newline
3541 \begin_inset Newline newline
3546 Note that the itemize depth is specified in Roman numerals as part of the
3556 \begin_layout Itemize
3560 \begin_layout Plain Layout
3573 Specify each individual entry by starting each item with the bullet shape
3574 enclosed in square brackets and set as TeX.
3575 For example, this item was started with
3588 \begin_layout Standard
3592 \begin_layout Plain Layout
3608 \begin_layout Standard
3609 You'll also need to revert the labelitem back to its previous setting for
3610 the global bullet shape settings to remain in effect.
3611 The way used here was:
3612 \begin_inset Newline newline
3626 \begin_layout Chapter
3627 Special Document Classes
3630 \begin_layout Section
3634 \begin_layout Standard
3637 David Johnson; updated by Richard Heck
3640 \begin_layout Standard
3641 \begin_inset VSpace bigskip
3647 \begin_layout Standard
3649 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3650 papers to be submitted to American Mathematical Society publications.
3651 The layouts are not tailored to a specific journal, but easily can be.
3652 You should refer to the AMS documentation for specific instructions for
3653 each journal (usually it will entail only changing a single line in the
3655 That documentation is available on the Web at
3656 \begin_inset Flex URL
3659 \begin_layout Plain Layout
3667 \begin_inset Flex URL
3670 \begin_layout Plain Layout
3672 ftp://ftp.ams.org/pub/tex/amslatex/
3678 These layouts are appropriate, and useful, for any mathematical writing.
3682 \begin_layout Standard
3683 There are two basic AMS LaTeX layouts:
3686 \begin_layout Enumerate
3687 amsart: The standard AMS article format.
3690 \begin_layout Enumerate
3691 amsbook: the standard AMS book (really, monograph) format.
3695 \begin_layout Standard
3696 These layouts themselves contain only the minimum necessary to use the AMS
3698 They do not, in particular, contain any of the `theorem' environments used
3699 for setting theorems, lemmas, and the like.
3700 These are contained, instead, in the
3701 \begin_inset Flex CharStyle:Code
3704 \begin_layout Plain Layout
3710 module, which you will need to load separately when you selected one of
3712 Less commonly used environments are in the
3713 \begin_inset Flex CharStyle:Code
3716 \begin_layout Plain Layout
3717 Theorems (AMS-Extended)
3726 \begin_layout Standard
3727 By default, theorems and the like are numbered consecutively throughout
3728 the document, but this may be modified by loading the module
3729 \begin_inset Flex CharStyle:Code
3732 \begin_layout Plain Layout
3733 Theorems (Order by Section)
3738 or, if you are using
3739 \begin_inset Flex CharStyle:Code
3742 \begin_layout Plain Layout
3749 \begin_inset Flex CharStyle:Code
3752 \begin_layout Plain Layout
3753 Theorems (Order by Chapter)
3759 These will number the results as
3760 \begin_inset Formula $n.m$
3763 , where the first number refers to the section (or chapter) and the second
3764 refers to the total number of results so far in that section (or chapter).
3765 Many environments are also available unnumbered.
3766 These are indicated by an asterisk at the end.
3767 If you happen to want
3771 unnumbered results, the the module
3772 \begin_inset Flex CharStyle:Code
3775 \begin_layout Plain Layout
3781 provides that option.
3784 \begin_layout Standard
3785 Note that these modules do not
3789 to be used with the AMS classes.
3790 It is perfectly possible to use the
3791 \begin_inset Flex CharStyle:Code
3794 \begin_layout Plain Layout
3800 module, and the others mentioned, with other classes, such as
3801 \begin_inset Flex CharStyle:Code
3804 \begin_layout Plain Layout
3811 \begin_inset Flex CharStyle:Code
3814 \begin_layout Plain Layout
3821 \begin_inset Flex CharStyle:Code
3824 \begin_layout Plain Layout
3833 \begin_layout Subsection
3834 What these layouts provide
3837 \begin_layout Standard
3838 There is a long list of included environments provided by these layouts.
3839 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3840 variety of `theorem' environments.
3841 However, the AMS recommends the environments that are available in LyX.
3845 \begin_layout Standard
3846 The following environments---as well as the standard environments, such
3848 \begin_inset Flex CharStyle:Noun
3851 \begin_layout Plain Layout
3858 \begin_inset Flex CharStyle:Noun
3861 \begin_layout Plain Layout
3868 \begin_inset Flex CharStyle:Noun
3871 \begin_layout Plain Layout
3878 \begin_inset Flex CharStyle:Noun
3881 \begin_layout Plain Layout
3888 \begin_inset Flex CharStyle:Noun
3891 \begin_layout Plain Layout
3898 \begin_inset Flex CharStyle:Code
3901 \begin_layout Plain Layout
3908 \begin_inset Flex CharStyle:Code
3911 \begin_layout Plain Layout
3920 \begin_layout Description
3921 Address This should be the author's permanent address.
3924 \begin_layout Description
3926 \begin_inset space ~
3929 Address This should be the author's temporary address at the time of submission,
3930 if different from the Address.
3933 \begin_layout Description
3934 Email Author's e-mail address
3937 \begin_layout Description
3938 URL Author's Web address, if desired.
3941 \begin_layout Description
3942 Keywords Key words or phrases used to identify specific topics discussed
3946 \begin_layout Description
3947 Subjectclass These refer to the AMS Subject Classifications, published and
3950 Mathematical Reviews
3953 These are also available online at the AMS cites listed above.
3956 \begin_layout Description
3960 \begin_layout Description
3964 \begin_layout Description
3968 \begin_layout Standard
3969 The following environments are provided by both the
3970 \begin_inset Flex CharStyle:Code
3973 \begin_layout Plain Layout
3980 \begin_inset Flex CharStyle:Code
3983 \begin_layout Plain Layout
3989 modules, in the latter case in both starred (unnumbered) and unstarred
3990 (numbered) versions.
3991 These same environments are provided only in the starred versions by the
3993 \begin_inset Flex CharStyle:Code
3996 \begin_layout Plain Layout
4005 \begin_layout Theorem
4006 This is typically used for the statements of major results.
4010 \begin_layout Corollary*
4011 This is used for statements which follow fairly directly from previous statement
4013 Again, these can be major results.
4018 These are smaller results needed to prove other statements.
4021 \begin_layout Proposition
4022 These are less major results which (hopefully) add to the general theory
4026 \begin_layout Conjecture
4027 These are statements provided without justification, which the author does
4028 not know how to prove, but which seem to be true (to the author, at least).
4031 \begin_layout Definition*
4032 Guess what this is for.
4033 The font is different for this environment than for the previous ones.
4037 \begin_layout Example*
4038 Used for examples illustrating proven results.
4041 \begin_layout Problem
4042 It's not really known what this is for.
4043 You should figure it out.
4046 \begin_layout Exercise*
4047 Write a description for this one.
4050 \begin_layout Remark
4051 This environment is also a type of theorem, usually a lesser sort of observation.
4054 \begin_layout Claim*
4055 Often used in the course of giving a proof of a larger result.
4059 Generally, these are used to break up long arguments, using specific instances
4065 The numbering scheme for cases is on its own, not together with other numbered
4071 At the end of this environment , a QED symbol (usually a square, but it
4072 can vary with different styles) is placed.
4073 If you want to have other environments within this one---for example, Case
4074 environments---and have the QED symbol appear only after them, then the
4075 other environments need to be nested within the proof environment.
4078 Nesting Environments
4084 for information on nesting.
4087 \begin_layout Standard
4088 And these are provided by
4089 \begin_inset Flex CharStyle:Code
4092 \begin_layout Plain Layout
4093 Theorems (AMS-Extended)
4101 \begin_layout Criterion*
4102 A required condition.
4105 \begin_layout Algorithm*
4106 A general procedure to be used.
4109 \begin_layout Axiom*
4110 This is a property or statement taken as true within the system being discussed.
4113 \begin_layout Condition*
4114 Sometimes used to state a condition assumed within the present context of
4119 Similar to a Remark.
4122 \begin_layout Notation*
4123 Used for the explanation of, yes, notation.
4126 \begin_layout Summary
4127 Do we really need to tell you?
4130 \begin_layout Acknowledgement*
4134 \begin_layout Conclusion*
4135 Sometimes used at the end of a long train of argument.
4139 Used in a way similar to Proposition, though perhaps lower on the scale.
4142 \begin_layout Standard
4143 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4145 They need to be available on your system in order to use these environments.
4148 \begin_layout Section
4152 \begin_layout Standard
4157 can be used to type letters according to German conventions.
4158 A template file is included in
4160 .../lyx/share/templates
4162 for you to use as a starting point.
4165 \begin_layout Section
4169 \begin_layout Standard
4174 provides an alternative to the standard
4179 It provides similar functionality, but you might prefer this layout with
4180 sans serif sections, headings, and more.
4183 \begin_layout Section
4187 \begin_layout Standard
4193 \begin_layout Subsection
4197 \begin_layout Standard
4198 This section describes how LyX can be used to write articles for submission
4199 to the scientific journal
4201 Astronomy and Astrophysics
4203 (www.edpsciences.fr/aa/
4204 \begin_inset Flex URL
4207 \begin_layout Plain Layout
4209 http://www.edpsciences.fr/aa/
4214 ) using Version 5.01 of the document class
4219 This package can be downloaded from the ftp site
4222 \begin_layout Standard
4223 \begin_inset VSpace medskip
4229 \begin_layout Standard
4231 \begin_inset Flex URL
4234 \begin_layout Plain Layout
4236 ftp://ftp.edpsciences.org/pub/aa/readme.html
4244 \begin_layout Standard
4245 \begin_inset VSpace medskip
4251 \begin_layout Standard
4252 A manual comes together with that package, and this text is not meant to
4253 replace the original manual but merely a short guide how to realize the
4254 correct form of your paper.
4258 \begin_layout Standard
4259 Please note that the publisher of the journal was changed from Springer
4260 to EDP Sciences starting January 1, 2001.
4261 That change implicated also some slight changes of the style files, namely
4262 the removal of the thesaurus command.
4263 The LyX class aa supports the newest version of these style files, V 5.01.
4264 If you have an older version installed, please upgrade.
4265 For compatibility, the old (version 4) layout has been kept as
4270 Please refer to the comments in
4272 LyXDir/layouts/aapaper.layout
4277 \begin_layout Subsection
4281 \begin_layout Standard
4282 It is recommended you start from the example template distributed with LyX.
4283 If you are not using a template, note the following settings:
4286 \begin_layout Itemize
4296 ocument\SpecialChar \menuseparator
4303 dialog (OK, that one was obvious).
4306 \begin_layout Itemize
4307 Don't change the option
4310 \begin_inset space ~
4320 The whole layout is done by the macros, you shouldn't change anything.
4323 \begin_layout Subsection
4327 \begin_layout Standard
4328 First thing to enter is the header information.
4329 It consists of seven entries, of which some are optional.
4333 \begin_layout Itemize
4341 \begin_layout Itemize
4349 \begin_layout Itemize
4357 \begin_layout Itemize
4365 \begin_layout Itemize
4370 : [optional] if more than one author: whom to contact for offprint requests.
4373 \begin_layout Itemize
4378 : [optional] mail address for contacts.
4381 \begin_layout Itemize
4389 Received: <date>; Accepted <date>
4392 \begin_layout Standard
4393 There is no need to issue the
4399 command, this is done automatically by LyX when the header is finished.
4400 Although the order of the single header entries doesn't matter it is advised
4401 to keep the above sequence, just to get the best optics and meets the layout
4402 of the real document.
4405 \begin_layout Standard
4406 If you want to place footnotes in the header block, e.
4407 \begin_inset space \thinspace{}
4411 \begin_inset space ~
4414 to state your present address, just use the standard footnote via
4419 nsert\SpecialChar \menuseparator
4427 LyX will automagically use the term
4436 \begin_layout Standard
4437 In addition to these topics, the macros use three additional LaTeX commands
4438 that have no counterpart in LyX:
4441 \begin_layout Itemize
4448 to separate different names for more than one author and institute, respectivel
4452 \begin_layout Itemize
4459 to mark corresponding author/institute pairs.
4460 The institutes are numbered sequentially as they appear in the
4464 field, so you have to put a marker to each author.
4467 \begin_layout Itemize
4474 to supply an email address for fast contact.
4477 \begin_layout Standard
4478 In all cases, the appropriate command has to be entered in LyX and marked
4484 \begin_layout Subsection
4488 \begin_layout Standard
4489 The abstract should immediately follow the header block.
4490 With version 5 the abstract environment was changed to a command, and there
4491 is now a resctriction to only one paragraph.
4492 In addition, it should contain an entry with the keywords.
4493 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4500 by hand and mark it as LaTeX code.
4501 Refer to the example paper.
4504 \begin_layout Subsection
4505 Supported environments
4508 \begin_layout Standard
4509 The A&A paper layout supports the following environments for structuring
4513 \begin_layout Itemize
4519 \begin_layout Itemize
4525 \begin_layout Itemize
4531 \begin_layout Itemize
4537 \begin_layout Itemize
4543 \begin_layout Itemize
4549 \begin_layout Itemize
4555 \begin_layout Itemize
4561 \begin_layout Itemize
4567 \begin_layout Itemize
4573 \begin_layout Itemize
4579 \begin_layout Itemize
4585 \begin_layout Subsection
4586 Commands not supported by LyX
4589 \begin_layout Standard
4590 Some commands are not yet supported by the
4595 Some have already been mentioned.
4596 For the sake of completeness, they are listed all together here:
4599 \begin_layout Itemize
4607 \begin_layout Itemize
4615 \begin_layout Itemize
4623 \begin_layout Itemize
4631 \begin_layout Itemize
4639 \begin_layout Itemize
4647 \begin_layout Itemize
4655 \begin_layout Itemize
4663 \begin_layout Standard
4664 If you want to use any of these commands, you have to enter them yourself.
4667 Do not forget to mark them as LaTeX code!
4670 \begin_layout Subsection
4671 Figure and Table Floats
4674 \begin_layout Standard
4675 LyX provides support for the necessary float environments
4677 figure, figure*, table
4683 , therefore we won't tell much about it here.
4687 \begin_inset space ~
4693 Just remember that tables should be left-aligned.
4694 For that, select the table and change the alignment in
4699 dit\SpecialChar \menuseparator
4705 \begin_inset space ~
4711 \begin_layout Standard
4712 There is only one special thing: the figures with caption besides the figure.
4713 To create such a figure, you have to do the following:
4716 \begin_layout Enumerate
4717 Create a wide figure float:
4722 nsert\SpecialChar \menuseparator
4727 t\SpecialChar \menuseparator
4730 , then right click in the figure and select
4736 \begin_inset space ~
4744 \begin_layout Enumerate
4745 Enter your caption text.
4748 \begin_layout Enumerate
4753 to move the cursor above the caption.
4756 \begin_layout Enumerate
4760 \begin_layout Enumerate
4761 Position the cursor behind the figure and insert a horizontal fill:
4766 nsert\SpecialChar \menuseparator
4772 \begin_inset space ~
4777 \SpecialChar \menuseparator
4781 \begin_inset space ~
4789 \begin_layout Enumerate
4790 Switch to LaTeX mode:
4793 \begin_inset space ~
4801 \begin_layout Enumerate
4811 Do not close the brace!
4814 \begin_layout Enumerate
4815 Position the cursor behind the caption text, switch to LaTeX mode and insert
4819 \begin_inset space ~
4831 \begin_layout Standard
4832 Also, refer to the figures in the example paper.
4835 \begin_layout Subsection
4839 \begin_layout Standard
4840 For submission, the paper has to be formated in a special double-spacing
4842 For this purpose, you have to give the option
4846 to the documentclass.
4847 This must be done using the extra class options field in the
4852 ocument\SpecialChar \menuseparator
4860 Just enter the string
4867 \begin_layout Subsection
4871 \begin_layout Standard
4876 directory contains an example paper written with LyX.
4877 It is the example paper from the original macro package, translated to
4879 Use it for inspiration, and compare the original LaTeX code with LyX way
4883 \begin_layout Section
4887 \begin_layout Standard
4893 \begin_layout Subsection
4897 \begin_layout Standard
4898 AASTeX is a set of macros produced by the American Astronomical Society
4899 to facilitate electronic manuscript submission to the three journals they
4900 publish: the Astrophysical Journal (including the Letters and Supplement),
4901 the Astronomical Journal, and the Publications of the Astronomical Society
4903 LyX has proven to be an excellent tool for generating these documents,
4904 especially given its equation, citation, and figure handling capabilities.
4905 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4906 is the version described here, or higher.
4907 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4908 incompatible with LyX.
4909 The AASTeX package may be downloaded from the AASTeX Web site
4912 \begin_layout Standard
4913 \begin_inset VSpace medskip
4919 \begin_layout Standard
4921 \begin_inset Flex URL
4924 \begin_layout Plain Layout
4926 http://www.journals.uchicago.edu/AAS/AASTeX
4934 \begin_layout Standard
4935 \begin_inset VSpace medskip
4941 \begin_layout Standard
4942 A complete user guide is contained in that package and you should familiarize
4943 yourself with it thoroughly before embarking on writing a paper in LyX.
4944 LyX will not reduce the need to figure out all the AASTeX commands, it
4945 will only reduce the drudgery of typing everything in.
4946 It is your responsibility to ensure that the final exported LaTeX document
4947 conforms completely to the requirements of the journal to which you are
4948 submitting your paper.
4951 \begin_layout Subsection
4952 Starting a New Paper
4955 \begin_layout Standard
4956 I strongly suggest that you start with the AASTeX template file.
4962 ile\SpecialChar \menuseparator
4972 , enter the new file name, then choose the
4977 This will show the most common fields found in a manuscript.
4978 Simply overwrite the existing text (including the brackets,
4982 ) with the correct information.
4983 Many of the AASTeX commands and environments can be implemented directly
4984 in LyX, but some cannot: most noticeably
4996 , which should stick out like a sore thumb if you actually just opened the
4998 For commands such as these, the LaTeX code must be entered directly and
5000 Such commands are referred to as ERT, or Evil Red Text.
5001 I tried to minimize the amount of ERT needed in an AASTeX document, but
5002 there is still a bit more required than any of us would like.
5005 \begin_layout Subsection
5006 Finishing Your Paper
5009 \begin_layout Standard
5010 When the paper is finished to your satisfaction and previews/prints correctly,
5012 \begin_inset Quotes eld
5016 \begin_inset Quotes erd
5019 actions which need to be done before you submit it to the journals.
5023 \begin_layout Enumerate
5024 Export your paper as a LaTeX file (
5029 ile\SpecialChar \menuseparator
5034 xport\SpecialChar \menuseparator
5045 \begin_layout Enumerate
5050 file with your favorite text editor
5054 \begin_layout Enumerate
5055 remove the comment lines before the
5064 \begin_layout Enumerate
5069 usepackage...{fontenc}
5071 line if it appears (usually just after
5086 \begin_layout Enumerate
5087 remove everything between (and including) the
5099 commands, except for any commands you specifically put into the LaTeX preamble
5100 (which should appear immediately after the
5101 \begin_inset Quotes eld
5104 User specified LaTeX commands
5105 \begin_inset Quotes erd
5116 \begin_layout Enumerate
5117 Run the resulting file through LaTeX to make sure it still processes correctly.
5120 \begin_layout Enumerate
5121 Reread the journal requirements to make sure your filenames and formats
5125 \begin_layout Enumerate
5129 \begin_layout Subsection
5130 Comments On Specific Commands
5133 \begin_layout Standard
5134 I will not describe the detailed usage of the individual AASTeX commands:
5135 the AASTeX User Guide (
5139 ) gives a good description of each.
5140 Thus it's probably easiest for me to go down the list as found in the guide
5141 and offer comments where necessary.
5142 So let's begin \SpecialChar \ldots{}
5146 \begin_layout Subsubsection
5147 Things that work as expected
5150 \begin_layout Standard
5154 \begin_layout Plain Layout
5166 \begin_layout Standard
5167 Because they work as you might expect, I simply list them and the section
5268 begin{thebibliography}
5276 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5277 graphicx figure commands (2.14.1),
5301 (2.15.4, amongst other places),
5328 \begin_layout Standard
5329 The following style options also work correctly:
5350 Simply put them in the
5356 Layout\SpecialChar \menuseparator
5362 \begin_layout Standard
5366 \begin_layout Plain Layout
5378 \begin_layout Subsubsection
5379 Things that work, but require more comment
5382 \begin_layout Standard
5383 The following items work, but require a little more discussion:
5386 \begin_layout Itemize
5387 These items are reserved for use by the journal editors, but you can put
5388 them into the LaTeX preamble if you feel compelled to do so:
5421 \begin_layout Itemize
5422 These items may be placed in the LaTeX preamble, and are included as blanks
5423 in the template file:
5444 \begin_layout Itemize
5451 (2.3) -- can only be used
5452 \begin_inset Quotes eld
5456 \begin_inset Quotes erd
5459 , not in the middle of a paragraph.
5460 Use ERT if you need to embed it.
5463 \begin_layout Itemize
5470 (2.3) -- will have extra {} after it.
5471 This should not cause an error.
5474 \begin_layout Itemize
5481 (2.6) -- can only be used
5482 \begin_inset Quotes eld
5486 \begin_inset Quotes erd
5489 , not in the middle of a paragraph.
5490 Use ERT if you need to embed it.
5493 \begin_layout Itemize
5500 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5504 \begin_layout Itemize
5511 (2.8) -- same as for
5518 \begin_layout Itemize
5525 (2.9) -- will have extra {} after it.
5526 This should not cause an error.
5529 \begin_layout Itemize
5536 (2.11) -- will have extra {} after it.
5537 This should not cause an error.
5540 \begin_layout Itemize
5547 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5548 at the beginning of the text and selecting
5550 Insert\SpecialChar \menuseparator
5555 \begin_inset Quotes eld
5559 \begin_inset Quotes erd
5562 inserts an optional argument of the type needed by
5569 Hopefully it will be renamed someday.
5572 \begin_layout Itemize
5585 for the catalog ID optional parameter
5588 \begin_layout Itemize
5601 for the catalog ID optional parameter
5604 \begin_layout Subsubsection
5605 Things not implemented, use ERT
5608 \begin_layout Standard
5612 \begin_layout Plain Layout
5624 \begin_layout Standard
5647 setcounter{equation}
5649 (2.12), Journal name abbreviations (2.13.4),
5685 (2.15.4, insert it as the first element in the lefthand cell after where
5687 Don't use any of LyX's rules in the table),
5699 (2.15.5), much of Misc (2.17, except
5750 \begin_layout Standard
5754 \begin_layout Plain Layout
5766 \begin_layout Subsubsection
5767 Things that cannot be implemented
5770 \begin_layout Standard
5771 \SpecialChar \ldots{}
5772 at least in any meaningful sort of way, so I suggest ignoring them.
5773 They are the references environment (2.13.3), and the deluxetable environment
5775 If you really, really need to use deluxetable, I suggest editing it in
5776 a separate file with a text editor, then using
5781 nsert\SpecialChar \menuseparator
5787 \begin_inset space ~
5792 to include it in your LyX document.
5797 file to see an example of this.
5800 \begin_layout Subsection
5801 FAQs, Tips, Tricks, and Other Ruminations
5804 \begin_layout Subsubsection
5805 Getting LyX and AASTeX to cooperate
5808 \begin_layout Standard
5809 It can be a bit tricky to get LyX to recognize a new layout and document
5811 When all else fails, do this:
5814 \begin_layout Enumerate
5815 Make certain that LaTeX can find AASTeX.
5816 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5817 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5824 \begin_layout Enumerate
5836 \begin_layout Enumerate
5842 ools\SpecialChar \menuseparator
5849 in LyX, then restart LyX.
5852 \begin_layout Enumerate
5853 Open a regular new file, not from a template.
5854 Does AASTeX appear in the class list in
5859 ocument\SpecialChar \menuseparator
5869 \begin_layout Standard
5870 If you get a warning from an existing AASTeX document about not being able
5871 to find the AASTeX layout or a message about
5872 \begin_inset Quotes eld
5875 You should not mix title layouts with normal ones
5876 \begin_inset Quotes erd
5879 , things haven't been installed correctly.
5882 \begin_layout Subsubsection
5883 LaTeX error processing a table
5886 \begin_layout Standard
5887 LyX, by default, attempts to center the table caption/title.
5888 This seems to produce a bad interaction in AASTeX so you should click somewhere
5889 in the caption/title, then select
5894 dit\SpecialChar \menuseparator
5900 \begin_inset space ~
5917 This took care of it for me.
5920 \begin_layout Subsubsection
5924 \begin_layout Standard
5925 A couple of things: 1) I have noticed some funny spacing in the reference
5926 entries in the text.
5927 When you enter the bibliography item data, make sure their is
5931 space between the last author and the parenthesis setting off the year;
5935 \begin_inset space \thinspace{}
5939 \begin_inset space ~
5953 2) Entering the references at all is not obvious.
5954 The easiest thing is to start typing your first reference at the end of
5955 the document, then mark it as type
5960 That will put a small gray box in front of what you just typed.
5961 Click on the box to fill in the rest of the information.
5962 For new references, go to the end of an existing reference and press return.
5963 That will create a new line with its own box, etc.
5966 \begin_layout Subsubsection
5970 \begin_layout Standard
5971 Even though AASTeX provides its own figure commands (
5977 , for example), I much prefer LaTeX's standard figure commands (with the
5986 \begin_inset space ~
5989 commands as ERT into a Figure Float box if you desire, but I never have
5990 much luck getting the layout right.
5991 With the standard graphics, LyX will insert a
5995 usepackage{graphicx}
5997 command into the LaTeX preamble and handle the figures in the standard
5998 LaTeX2e way, interspersing the figures in the text.
5999 I believe ApJ accepts figures exactly this way now; AJ might still use
6001 \begin_inset Quotes eld
6004 stack everything at the end
6005 \begin_inset Quotes erd
6011 \begin_layout Subsubsection
6012 Things I could have done, but didn't
6015 \begin_layout Standard
6017 \begin_inset Quotes eld
6021 \begin_inset Quotes erd
6024 things I could have implemented, but chose not to.
6025 For instance, I saw no point in double-spacing the text in the LyX window,
6026 even though it is double-spaced in the paper manuscript.
6027 Also, I chose not to make separate layouts for the preprint and preprint2
6029 Since I assume you will spend most of your time in the plain manuscript
6030 mode anyway, I decided not to chew up more disk space with this.
6034 \begin_layout Subsection
6038 \begin_layout Standard
6039 Your mileage may vary.
6040 I've now had papers published by both ApJ and AJ that have had 98% of the
6041 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6043 I have had no trouble with the submission process, and I'm sure the journals
6044 were never aware that there might be a difference.
6045 So, go forth and publish!
6048 \begin_layout Section
6052 \begin_layout Standard
6055 Panayotis Papasotiriou
6058 \begin_layout Subsection
6062 \begin_layout Standard
6063 The ijmpc package is a set of macros that facilitates electronic manuscript
6066 International Journal of Modern Physics C
6069 Similarly, the ijmpd package is for creating manuscripts to be submitted
6072 International Journal of Modern Physics D
6075 Both journals are published by World Scientific.
6076 The corresponding document classes are named
6085 These files, together with instructions for the authors, can be downloaded
6087 \begin_inset Flex URL
6090 \begin_layout Plain Layout
6092 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6098 \begin_inset Flex URL
6101 \begin_layout Plain Layout
6103 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6109 Both packages are modified versions of the standard
6110 \begin_inset Quotes eld
6114 \begin_inset Quotes erd
6117 package, and they are almost (but not exactly) identical.
6118 Most of their features are supported by LyX.
6119 I have used LyX successfully to write articles submitted to both journals
6120 without any problem.
6123 \begin_layout Subsection
6127 \begin_layout Standard
6128 As usual, the easiest way to write a paper is to start with a template.
6134 ile\SpecialChar \menuseparator
6153 This will give an (almost) empty document that includes the most common
6154 fields found in a manuscript.
6155 Simply overwrite the existing text (including the brackets,
6160 You should keep in mind the following remarks.
6163 \begin_layout Enumerate
6164 LyX won't let you change the font size and the page style of the document,
6165 because such modifications are not allowed by both packages.
6168 \begin_layout Enumerate
6169 The language of the document should not be changed.
6170 Before previewing your paper, be sure that the babel package is not used.
6171 To do this, click on
6176 ools\SpecialChar \menuseparator
6194 checkbox in the language settings, and click on
6205 , if you wish to make this change permanent).
6208 \begin_layout Enumerate
6210 \begin_inset Quotes eld
6214 \begin_inset Quotes erd
6217 style must be used to define keywords.
6220 \begin_layout Enumerate
6221 The ijmpc package provides a style named
6222 \begin_inset Quotes eld
6225 Classification Codes
6226 \begin_inset Quotes erd
6229 , which can be used to define classification codes, such as PACS numbers.
6230 Note that this facility is not supported by the ijmpd package.
6233 \begin_layout Enumerate
6234 Several new environments are available:
6235 \begin_inset Quotes eld
6239 \begin_inset Quotes erd
6243 \begin_inset Quotes eld
6247 \begin_inset Quotes erd
6251 \begin_inset Quotes eld
6255 \begin_inset Quotes erd
6259 \begin_inset Quotes eld
6263 \begin_inset Quotes erd
6267 \begin_inset Quotes eld
6271 \begin_inset Quotes erd
6275 \begin_inset Quotes eld
6279 \begin_inset Quotes erd
6283 \begin_inset Quotes eld
6287 \begin_inset Quotes erd
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 Their use is more or less obvious.
6348 LyX supports all these environments; it will use the proper label, text
6349 style, and numbering scheme for each of them.
6352 \begin_layout Enumerate
6353 Both packages use basic citations; the natbib package should not be used.
6354 In LyX, citation references are shown as usual; in the output, citations
6355 are shown as superscripts.
6356 If you want to use a citation as normal text, you should use the
6361 \begin_inset space \thinspace{}
6365 \begin_inset Quotes eld
6369 \begin_inset space ~
6379 \begin_inset Quotes erd
6385 \begin_layout Enumerate
6387 \begin_inset Quotes eld
6391 \begin_inset Quotes erd
6394 section in both packages.
6395 To put acknowledgments, just use the
6396 \begin_inset Quotes eld
6400 \begin_inset Quotes erd
6406 \begin_layout Enumerate
6407 Appendices may be added to the paper,
6411 the Acknowledgments and
6416 LyX provides a special environment, called
6417 \begin_inset Quotes eld
6421 \begin_inset Quotes erd
6424 which marks the beginning of the appendices.
6425 This environment should be left blank; it just sends a LaTeX command, but
6426 nothing is really printed.
6428 \begin_inset Quotes eld
6432 \begin_inset Quotes erd
6435 is printed with blue letters, as a signal that all sections after that
6436 point are appendices.
6437 To write an appendix, use the
6438 \begin_inset Quotes eld
6442 \begin_inset Quotes erd
6446 LyX will number each appendix with capital letters, as required by both
6449 \begin_inset Quotes eld
6453 \begin_inset Quotes erd
6460 be present before the first appendix; if not, all appendices will be numbered
6461 as normal sections in the output.
6464 \begin_layout Enumerate
6465 The ijmpc and the ijmpd packages use the
6469 command to implement table captions.
6470 As a result, a table created by LyX is printed correctly, but its caption
6472 However, you can use some ERT to overpass this problem, so that captions
6473 are printed as expected.
6474 To do so, create a float table as usual, remove the caption, and replace
6485 (sic); you must also the ERT
6489 immediately after the tabular material.
6490 Study the example table included in the template files to see how this
6491 trick is implemented.
6492 Alternatively, If you need table captions, you should implement the whole
6497 file, then include this file to the LyX document (
6502 nsert\SpecialChar \menuseparator
6507 \SpecialChar \menuseparator
6513 \begin_inset space ~
6519 Details on how to create a table float can be found in the files
6527 , included in the corresponding packages.
6530 \begin_layout Subsection
6531 Preparing a paper for submission
6534 \begin_layout Standard
6535 Before you submit your paper you must export the LyX document as a LaTeX
6541 ile\SpecialChar \menuseparator
6546 xport\SpecialChar \menuseparator
6561 \begin_layout Plain Layout
6562 Actually you have the choice between LaTeX (plain) and pdflatex.
6563 If you intend to use pdflatex to prepare the paper, you should use the
6564 pdflatex option so that included graphics are converted to PDF format,
6565 ready for use by pdflatex.
6570 , then make the following changes to the resulting
6577 \begin_layout Enumerate
6578 Remove the comment lines before the
6587 \begin_layout Enumerate
6588 Remove everything between (and including) the
6600 commands, except for any commands you specifically put into the LaTeX preamble.
6603 \begin_layout Standard
6608 file should be saved and processed through LaTeX as many times as necessary.
6609 You may also want to check the resulting
6616 \begin_layout Subsection
6620 \begin_layout Standard
6621 The use of ERT is reduced to two commands, which must be placed at the top
6623 If you started writing your paper by using the
6631 template, the ERT needed is already in its place; you usually don't need
6633 You may only modify the first ERT to specify the information printed to
6634 the top of odd and even pages (authors' names and short paper's title,
6636 This ERT must have the form
6640 markboth{Authors' Names}{Short Paper's Title}
6645 \begin_layout Section
6649 \begin_layout Standard
6655 \begin_layout Subsection
6659 \begin_layout Standard
6660 The iopart package provides a document class to create electronic manuscript
6661 submission to the journals published by the Institute of Physics.
6662 Instructions for the authors how to create a paper using the iopart class
6663 can be downloaded together with the iopart package from the site
6664 \begin_inset Flex URL
6667 \begin_layout Plain Layout
6669 ftp://ftp.iop.org/pub/journals/latex2e
6677 \begin_layout Subsection
6681 \begin_layout Standard
6682 The easiest way to write a paper is to start with the file
6686 that is available in LyX's examples files folder.
6687 Open this file, save it under a new name, and start writing.
6688 The example file explains how to use the special text environments.
6689 Here are the most important advices:
6692 \begin_layout Itemize
6693 To be able to compile your document to a PDF, PS, or DVI, assure that the
6696 Use AMS math package
6698 in the document settings under
6705 \begin_layout Itemize
6708 The title environment defines the kind of your paper.
6709 So use one of the following environments for the title:
6713 \begin_layout Itemize
6722 \begin_layout Itemize
6731 \begin_layout Itemize
6737 for a Topical review
6740 \begin_layout Itemize
6749 \begin_layout Itemize
6758 \begin_layout Itemize
6764 for a Paper (same as Title)
6767 \begin_layout Itemize
6773 for a Preliminary communication
6776 \begin_layout Itemize
6782 for a Rapid communication
6785 \begin_layout Itemize
6791 for a Letter to the editor
6795 \begin_layout Itemize
6798 All title environments except of
6802 can have an optional short title.
6805 \begin_layout Itemize
6806 There is a general title environment
6810 which is not directly supported by the LyX.
6811 This can be used as ERT when your document doesn't fit into one of the
6815 \begin_layout Standard
6816 For more informations like hints for special table and formula formatting,
6817 look at the IOP author guidelines.
6820 \begin_layout Section
6824 \begin_layout Standard
6827 Panayotis Papasotiriou
6830 \begin_layout Subsection
6834 \begin_layout Standard
6835 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6836 that facilitates electronic manuscript submission to the journals they
6838 Most known of them (at least in my domain of interest) are
6840 Astrophysics and Space Science
6846 , but there are many others (see a complete list at
6847 \begin_inset Flex URL
6850 \begin_layout Plain Layout
6852 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6858 The Kluwer package may be downloaded from the site
6859 \begin_inset Flex URL
6862 \begin_layout Plain Layout
6864 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6870 A complete user guide is contained in that package (but it can also be
6871 downloaded separately).
6874 \begin_layout Standard
6875 LyX supports many features of the package but not everything.
6876 However, the ERT needed is reduced to some
6877 \begin_inset Quotes eld
6881 \begin_inset Quotes erd
6884 commands of the package (see
6885 \begin_inset space ~
6889 \begin_inset CommandInset ref
6891 reference "subsec:kluwer_peculiarities"
6896 I have recently used LyX to write an article submitted to the
6898 Astrophysics and Space Science
6900 without any problem.
6903 \begin_layout Subsection
6907 \begin_layout Standard
6908 The easiest way to write a paper is to start with the Kluwer template file.
6911 File\SpecialChar \menuseparator
6926 This will give an (almost) empty document that includes the most common
6927 fields found in a manuscript and a short description of their use.
6928 As in most templates, simply overwrite the existing text (including the
6933 ) with the correct information.
6936 \begin_layout Subsection
6937 Preparing a paper for submission
6940 \begin_layout Standard
6941 As in the AASTeX package, before you submit your paper to a journal you
6943 \begin_inset Quotes eld
6947 \begin_inset Quotes erd
6953 \begin_layout Enumerate
6954 Export your paper as a LaTeX file.
6955 To do this, click on
6960 ile\SpecialChar \menuseparator
6965 xport\SpecialChar \menuseparator
6976 \begin_layout Enumerate
6981 file with a text editor and make the following changes
6985 \begin_layout Enumerate
6986 remove the comment lines before the
6995 \begin_layout Enumerate
6996 remove everything between (and including) the
7008 commands, except for any commands you specifically put into the LaTeX preamble.
7011 \begin_layout Standard
7020 \begin_layout Enumerate
7025 file through LaTeX as many times as necessary (usually up to three).
7028 \begin_layout Enumerate
7034 \begin_inset space \thinspace{}
7041 , and check if everything is OK (it should, if you didn't make any mistake).
7044 \begin_layout Subsection
7045 \begin_inset Quotes eld
7049 \begin_inset Quotes erd
7052 of the Kluwer package
7053 \begin_inset CommandInset label
7055 name "subsec:kluwer_peculiarities"
7062 \begin_layout Standard
7063 The Kluwer package has the following
7064 \begin_inset Quotes eld
7068 \begin_inset Quotes erd
7074 \begin_layout Enumerate
7075 It is possible to write multiple articles in the same LaTeX file
7079 \begin_layout Plain Layout
7080 I can't imagine any good reason to do this.
7086 Each article must be included in the environment
7087 \begin_inset Quotes eld
7091 \begin_inset Quotes erd
7095 Unfortunately, this environment cannot be omitted, even if you write just
7097 Therefore, each article starts with the command
7103 and, obviously, ends with the command
7110 Although this can be implemented in LyX, I didn't included it, since it
7111 looks ugly and can confuse the novice user.
7112 Therefore, you need to enter them directly and mark them as LaTeX code
7114 \begin_inset Quotes eld
7118 \begin_inset Quotes erd
7124 \begin_layout Enumerate
7125 Information given at the beginning of the article (i.e., title, subtitle,
7126 author, institution, running title, running author, abstract and keywords)
7127 must be included in an environment called
7128 \begin_inset Quotes eld
7132 \begin_inset Quotes erd
7136 This is not implemented in LyX, so you must enter title, subtitle etc.
7137 \begin_inset space ~
7140 between two ERT lines (
7155 \begin_layout Enumerate
7156 According to the user manual, the label of each bibliography item must be
7180 \begin_layout Standard
7185 template takes care of all these
7186 \begin_inset Quotes eld
7190 \begin_inset Quotes erd
7194 If you start a new paper using this template you don't need to do anything
7199 \begin_layout Enumerate
7200 don't delete the ERT included in the template, and
7203 \begin_layout Enumerate
7204 copy the example bibliography item included in the template and modify it
7205 as necessary to enter new bibliography items.
7208 \begin_layout Section
7212 \begin_layout Standard
7218 \begin_layout Subsection
7222 \begin_layout Standard
7223 The LyX document classes
7225 article (koma-script)
7229 report (koma-script)
7247 correspond to the LaTeX document classes
7264 \begin_inset space ~
7267 of the Koma-Script family.
7268 They are replacements for the standard document classes
7284 , resp., and fit better to European typography conventions in a number of
7288 \begin_layout Itemize
7289 Standard character size is 11pt in
7291 article (koma-script)
7295 report (koma-script)
7303 letter (koma-script)
7308 \begin_layout Itemize
7309 Headings, labels of the description environment, and a number of elements
7312 letter (koma-script)
7314 document class are set in a bold sans serif font.
7318 \begin_layout Plain Layout
7319 There is a big difference between the bold sans serif old cm fonts and new
7320 ec fonts, especially in the appearance of headings.
7321 In comparison, the ec bold sans serif fonts look a bit thin.
7322 Here the LaTeX package
7330 helps to produce the
7331 \begin_inset Quotes eld
7335 \begin_inset Quotes erd
7338 appearance when using the ec fonts.
7343 The numbering of chapter headings is made in the same way as the numbering
7344 of section headings, that is without the extra line
7345 \begin_inset Quotes eld
7348 Chapter\SpecialChar \ldots{}
7350 \begin_inset Quotes erd
7354 In addition, the appearance of the headings can be modified by using a
7355 number of options (in LyX to be entered in the field
7362 \begin_inset space ~
7372 ayout\SpecialChar \menuseparator
7380 A detailed German description of these options can be found in the Koma-Script
7388 \begin_layout Itemize
7389 The main means in the Koma-Script document classes to design the type area
7398 (in LyX to be entered in the extra class options field in the dialog
7403 ocument\SpecialChar \menuseparator
7411 They make a clearer modification of page margins possible as do the options
7417 ocument\SpecialChar \menuseparator
7425 A detailed German description of these and other type area options can
7426 be found in the Koma-Script documentation
7433 \begin_layout Itemize
7434 The LaTeX document classes of the Koma-Script family define a number of
7435 additional commands.
7436 Those part of it which makes sense in LyX is implemented in corresponding
7440 \begin_layout Standard
7441 A detailed German description of the LaTeX document classes of the Koma-Script
7442 family can be found in the Koma-Script documentation
7450 \begin_layout Plain Layout
7451 There is an English translation
7455 , but it is not a complete one.
7460 The following sections describe only those aspects, which are relevant
7464 \begin_layout Subsection
7465 article (koma-script), report (koma-script), and book (koma-script)
7468 \begin_layout Standard
7469 The document classes
7471 article (koma-script)
7475 report (koma-script)
7485 are implemented in the layout files
7498 They contain all the paragraph types of the corresponding standard document
7511 , resp., partly modified, with the exception of the LyX specific
7515 -type, which is replaced by the new
7519 -type having the same functionality.
7524 -Type there is a number of new paragraph types added.
7531 letter (koma-script)
7536 \begin_layout Itemize
7545 : are equivalents to
7553 , resp., additionally inserting an entry in the table of contents.
7562 are not contained in
7564 article (koma-script)
7569 \begin_layout Itemize
7586 , resp., additionally clearing running heads.
7593 article (koma-script)
7599 \begin_layout Plain Layout
7612 report (koma-script)
7614 , but since this is identical to
7618 , is has not been implemented in LyX.
7626 \begin_layout Itemize
7631 : generates a heading directly above the following paragraph in the standard
7632 character size without affecting the structure of the document.
7635 \begin_layout Itemize
7644 are special captions which respect the different space settings needed
7645 for captions placed above or below an element (if you follow strict typographic
7646 rules, you might want to place table captions always above the table).
7647 You can also use the class option
7664 You need at least Koma-Script version 2.8q to use this.
7667 \begin_layout Itemize
7672 : can be used to set a bonmot, e.
7673 \begin_inset space \thinspace{}
7677 \begin_inset space ~
7680 at the beginning of a chapter.
7681 If you use the optional argument (
7686 nsert\SpecialChar \menuseparator
7688 \begin_inset space ~
7693 ), you can insert the dictum's author there.
7694 Dictum and author are separated by a line.
7695 You need at least Koma-Script version 2.8q to use this.
7702 article (koma-script)
7707 \begin_layout Standard
7708 The following types, together with the standard types
7720 , form the title area of the document.
7721 They must be entered ahead of the first
7722 \begin_inset Quotes eld
7726 \begin_inset Quotes erd
7733 \begin_layout Plain Layout
7734 The corresponding LaTeX commands must appear before the
7745 When such a type is used more than once, the latter usage overwrites the
7746 former one, that means, for every type only the latest usage is valid.
7747 The order of the different types however has, like
7759 , no effect on the appearance of the produced document.
7762 \begin_layout Itemize
7767 : produces a centered paragraph above the ordinary title (
7779 ) for the subject of the document.
7782 \begin_layout Itemize
7787 : produces a centered paragraph below the ordinary title (
7799 ) for the publishers' name.
7802 \begin_layout Itemize
7809 report (koma-script)
7815 produces a centered paragraph on its own page behind the title page, or
7818 article (koma-script)
7820 produces a centered paragraph below the ordinary title (
7839 \begin_layout Itemize
7844 : produces a left aligned paragraph above the ordinary title (
7860 ) for a document`s head.
7863 \begin_layout Itemize
7868 : produces in a double-sided print in
7870 report (koma-script)
7876 a left-aligned paragraph at the top of the title page`s back or has no
7877 effect in a single-sided print or in
7879 article (koma-script)
7884 \begin_layout Itemize
7889 : produces in a double-sided print in
7891 report (koma-script)
7897 a left-aligned paragraph at the bottom of the title page`s back or has
7898 no effect in a single-sided print or in
7900 article (koma-script)
7905 \begin_layout Itemize
7910 : produces a special
7911 \begin_inset Quotes eld
7915 \begin_inset Quotes erd
7918 page ahead of the actual document containing a paragraph without special
7922 \begin_layout Standard
7923 The layout files for the document classes
7925 article (koma-script)
7929 report (koma-script)
7940 This is thought of as a place to define your own types.
7945 in your personal layout directory and edit the file!
7948 \begin_layout Subsection
7949 letter (koma-script)
7952 \begin_layout Standard
7956 \begin_layout Plain Layout
7968 \begin_layout Standard
7972 letter (koma-script)
7974 is implemented in the layout file
7979 It contains all the paragraph types of the corresponding standard document
7984 , partly modified, with the exception of the LyX specific types
7996 type, which is replaced by the new
8001 In addition, it contains, in contrast to the standard document class, the
8019 Furthermore, there are a number of new letter specific types.
8022 \begin_layout Standard
8026 \begin_layout Plain Layout
8038 \begin_layout Standard
8039 The appearance of the letter produced by this document class can be controlled
8040 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8044 \begin_layout Plain Layout
8045 For example, the standard appearance of the letter`s heading, consisting
8046 of name and address, is quite self-willed.
8048 \begin_inset Quotes eld
8052 \begin_inset Quotes erd
8055 heading is produced by the following LaTeX commands in the preamble:
8058 \begin_layout LyX-Code
8068 \begin_layout LyX-Code
8084 \begin_layout LyX-Code
8094 \begin_layout LyX-Code
8114 A detailed German description of such LaTeX commands can be found in the
8115 Koma-Script documentation
8120 With it, the letter's author can produce his personal letter layout.
8123 \begin_layout Standard
8132 define the beginning of the letter and must be used in every letter.
8133 To emphasize them in the LyX document class, they are marked with the letter
8143 \begin_inset space ~
8147 It is possible to write any number of letters in one file.
8152 type produces a new letter using the same addressee and a
8156 type produces a new addressee.
8173 are ordinary paragraph types and can also be used several times in one
8174 and the same letter.
8177 \begin_layout Itemize
8182 : produces a paragraph for the addressee and implicitly defines the beginning
8186 \begin_layout Itemize
8191 : produces a paragraph for the form of address and implicitly produces a
8195 \begin_layout Itemize
8200 : produces a paragraph for a close.
8203 \begin_layout Itemize
8208 : produces a paragraph for a postscript.
8211 \begin_layout Itemize
8216 : produces a paragraph for a distribution list.
8219 \begin_layout Itemize
8224 : produces a paragraph for enclosures.
8227 \begin_layout Standard
8268 are input types provided with a label to enter information, which will
8269 be processed by the document class.
8273 \begin_layout Plain Layout
8274 It could be seen as a matter of inconsequence, that the types
8282 described above are not such input types as well.
8283 Because of the special meaning of those types, however, I have implemented
8284 them as ordinary paragraph types with a one letter mark in the left margin.
8285 Moreover, it would affect my feeling of symmetry, if the
8293 type had such a serious different appearance.
8298 The types must be used ahead of the corresponding
8305 \begin_layout Standard
8306 An implementation of these types in a WYSIWYG fashion does not seem to make
8307 sense, because the real appearance of the produced letter does not only
8308 depend on the usage of the particular type, but also on other factors.
8309 For example, a signature entered in the
8313 type will in the standard behavior appear in the produced letter only,
8314 when in the same letter also a
8319 The entered value of the
8323 type will in the standard behavior not appear in the produced letter at
8325 The possibility to design the letter`s heading freely is already indicated
8326 in a footnote above.
8329 \begin_layout Standard
8330 The input types can also be used as empty paragraphs.
8332 \begin_inset space \thinspace{}
8336 \begin_inset space ~
8348 type is not used at all, in the standard behavior the value of the
8352 type is used as signature, whereas if an empty
8356 type is used, no signature value is defined.
8359 \begin_layout Standard
8360 By using the input types it is possible to write a letter template, containing
8361 filled input types with your personal dates (name, address, etc.) and empty
8362 input types for other dates you want to enter.
8365 \begin_layout Itemize
8370 : sender's name, in the standard behavior appears as a centered paragraph
8371 in small caps in the letter`s heading.
8374 \begin_layout Itemize
8379 : sender's signature, in the standard behavior appears below the
8388 type is used, the value of the
8392 type appears instead.
8395 \begin_layout Itemize
8400 : sender's address, in the standard behavior appears in a centered paragraph
8401 in the letter`s heading below the sender's name.
8404 \begin_layout Itemize
8409 : sender's telephone number, in the standard behavior only sets the LaTeX
8419 \begin_layout Itemize
8424 : place of the letter`s making.
8427 \begin_layout Itemize
8432 : date of the letter`s making.
8441 , in the standard behavior, produce the place and the date in a right-aligned
8442 line below the addressee's field.
8447 type is used, neither place nor date appear, independent of the value of
8457 type is used, the date of the letter `s production is used.
8460 \begin_layout Itemize
8465 : sender`s back address, in the standard behavior appears above the addressee's
8466 field in a small sans serif font.
8469 \begin_layout Itemize
8474 : special mail information, in the standard behavior appears underlined
8475 above the addressee's field below the back address.
8478 \begin_layout Itemize
8483 : additional information, in the standard behavior appears on right side
8484 below the addressee`s field.
8487 \begin_layout Itemize
8492 : the letter's title, in the standard behavior appears in a big, bold, sans
8493 serif font above the subject.
8496 \begin_layout Itemize
8501 : the letter's subject, in the standard behavior appears in a bold font
8509 \begin_layout Standard
8530 produce a business letter like line above the
8534 line containing the fields
8535 \begin_inset Quotes eld
8539 \begin_inset Quotes erd
8543 \begin_inset Quotes eld
8547 \begin_inset Quotes erd
8551 \begin_inset Quotes eld
8555 \begin_inset Quotes erd
8559 \begin_inset Quotes eld
8563 \begin_inset Quotes erd
8567 \begin_inset Quotes eld
8571 \begin_inset Quotes erd
8575 \begin_inset Quotes eld
8579 \begin_inset Quotes erd
8583 For the date field, the value of the
8589 \begin_inset Quotes eld
8592 business letter types
8593 \begin_inset Quotes erd
8596 is used, the value of the
8600 type however does not appear, but only the LaTeX variable
8607 The ordinary output of place and date in a right-aligned line below the
8608 addressee`s field is suppressed.
8609 The types are implemented as input types provided with a label and must
8610 be used ahead of the corresponding
8617 \begin_layout Itemize
8625 \begin_layout Itemize
8633 \begin_layout Itemize
8641 \begin_layout Itemize
8649 \begin_layout Itemize
8657 \begin_layout Subsection
8658 The new letter class: letter (koma-script v.2)
8661 \begin_layout Standard
8664 Jürgen Spitzmüller
8667 \begin_layout Standard
8668 \begin_inset VSpace medskip
8674 \begin_layout Standard
8676 Koma-Script version 2.8 has introduced a new letter class
8680 which supersedes the now unsupported
8685 It has --- on the LaTeX side --- a completely new interface and is not
8686 compatible with the old class.
8687 Therefore, LyX supports both, though it is recommended to use the new class.
8690 \begin_layout Standard
8691 This class covers the same functionality as
8693 letter (koma-script),
8700 (receiver's address, same as
8717 will start a new letter (i.
8718 \begin_inset space \thinspace{}
8722 \begin_inset space ~
8725 you can write several letters per document).
8726 New elements are sender's
8742 and the possibility to use a
8751 nsert\SpecialChar \menuseparator
8761 \begin_layout Standard
8762 The biggest improvement is, though, that the letter's layout is configurable
8763 at almost any needs.
8764 This can be done via the preamble or with a special style file (Letter
8765 Class Option, extension
8769 ), that will be read in as a class option.
8773 \begin_layout Plain Layout
8774 The KOMA package comes with some default
8779 There is, for instance, a
8783 file that follows german typesetting rules, or a
8787 that provides the default layout of the old
8792 The latter can be loaded with the class option
8801 ayout\SpecialChar \menuseparator
8806 ocument\SpecialChar \menuseparator
8818 template that is included in LyX for examples.
8819 A detailed description is to be found in the Koma-Script documentation
8827 \begin_layout Subsection
8831 \begin_layout Standard
8832 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8836 \begin_layout Itemize
8837 The chapter number of a
8841 type appears on a line of its own above the chapter heading instead of
8842 appearing in the same line ahead of it.
8843 The cause for that is the LyX internal behavior for the labeltype
8850 \begin_layout Itemize
8851 The headings of the types
8860 \begin_inset Quotes eld
8864 \begin_inset Quotes erd
8867 LaTeX table of contents, but not in the LyX table of contents (
8872 ocument\SpecialChar \menuseparator
8878 \begin_inset space ~
8882 \begin_inset space ~
8890 \begin_layout Itemize
8895 document class appear in a skip separation mode, not indented.
8896 This is the standard behavior, no special LaTeX commands are needed for
8903 ocument\SpecialChar \menuseparator
8910 dialog the corresponding radio button indicates
8926 value always has the effect that extra LaTeX commands are inserted in the
8927 document to produce the gap, which is not what is wanted in this case.
8930 \begin_layout Section
8938 \begin_layout Standard
8944 \begin_layout Subsection
8948 \begin_layout Standard
8949 These are the layout files for some of the journal formats used by Springer
8950 Verlag and listed on
8951 \begin_inset Flex URL
8954 \begin_layout Plain Layout
8956 http://www.springer.de/author/tex/help-journals.html
8961 , where you should also go to fetch the class files (yes, these are LaTeX2e
8963 It is a modular system: the things common to all journals are implemented
8968 , which journal-specific layout files (such as, e.
8969 \begin_inset space \thinspace{}
8976 for Journal of Geodesy) can include.
8979 \begin_layout Standard
8980 This means that implementing support for any other Springer journal on this
8981 list is as simple as writing your own
8989 file following the outline given in
8997 \begin_layout Standard
8998 It is reasonably well tested only for the Journal of Geodesy.
9007 come with the standard LyX distribution.
9008 Install the relevant class file (downloaded from Springer) in a proper
9009 directory, reconfigure LaTeX (in the teTeX case by running
9013 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9014 LyX and it should work.
9017 \begin_layout Subsection
9021 \begin_layout Standard
9022 A large number of theorem-like styles ---
9028 \SpecialChar \ldots{}
9034 \begin_layout Standard
9037 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9038 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9041 See the Springer class file documentation for details.
9044 \begin_layout Subsection
9048 \begin_layout Itemize
9060 \begin_layout Itemize
9063 Probability Theory and Related Fields
9069 --- Jean-Marc Lasgouttes
9072 \begin_layout Standard
9073 Add your own, it isn't so hard!
9076 \begin_layout Subsection
9080 \begin_layout Standard
9081 These files are partly based on the older
9085 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9091 layout, are now defunct.
9092 Jean-Marc Lasgouttes helped out big in making me find my way around the
9093 LyX layout file mechanism.
9096 \begin_layout Subsection
9100 \begin_layout Standard
9102 But probably less than in the old hacked-LaTeX
9109 \begin_layout Standard
9111 \begin_inset space \thinspace{}
9114 g.: does not display the number for theorem-like layouts, just #.
9117 \begin_layout Section
9125 \begin_layout Standard
9131 \begin_layout Subsection
9135 \begin_layout Standard
9136 These are the layout files for some of the journals of the American Geophysical
9138 It is assumed that you have both the AGU's own class files and AGUplus
9139 installed (everything to be found at
9140 \begin_inset Flex URL
9143 \begin_layout Plain Layout
9145 ftp://ftp.agu.org/journals/latex/journals
9153 \begin_layout Subsection
9157 \begin_layout Standard
9167 They are still called this in the LyX GUI, though their LaTeX equivalents
9168 in the AGU classes are
9179 \begin_layout Standard
9180 Newly defined styles are
9217 These are mostly manuscript attributes and defined in the AGU class documentati
9221 \begin_layout Standard
9222 I suspect this is still badly incomplete.
9225 \begin_layout Subsection
9229 \begin_layout Standard
9246 \begin_layout Subsection
9250 \begin_layout Itemize
9253 Journal of Geophysical Research
9262 \begin_layout Standard
9263 Add your own, it isn't so hard! Look at the
9274 \begin_layout Subsection
9275 Bugs and things to remember
9278 \begin_layout Standard
9279 In order to use the new layouts, you must remember to do the following for
9283 \begin_layout Enumerate
9289 This can be done in the
9291 layout\SpecialChar \menuseparator
9296 document\SpecialChar \menuseparator
9300 (AGU articles are always in English, right? So
9307 \begin_layout Enumerate
9317 (Yes, this is a bug.)
9320 \begin_layout Enumerate
9321 Make sure you use the
9325 bibliography style, by entering
9329 into the second field of the BibTeX inset.
9330 None of the standard styles will do.
9333 \begin_layout Section
9341 \begin_layout Standard
9347 \begin_layout Subsection
9351 \begin_layout Standard
9352 This is the layout file for the European Geophysical Society journals.
9357 can be downloaded from the web site of the EGS under
9358 \begin_inset Flex URL
9361 \begin_layout Plain Layout
9371 \begin_layout Subsection
9375 \begin_layout Standard
9378 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9386 The current layout file is unfortunately very unmodular and would benefit
9387 from using the various
9394 \begin_layout Section
9400 \begin_inset CommandInset label
9409 \begin_layout Standard
9417 \begin_layout Subsection
9421 \begin_layout Standard
9422 This section describes how to use LyX to make slides for overhead projectors.
9423 There are two document classes that can do this: the default slides class
9429 This section documents the former.
9432 \begin_layout Standard
9433 I'm going to say this again, nice and clear, so that there's no misunderstanding
9437 \begin_layout Standard
9438 \begin_inset VSpace bigskip
9444 \begin_layout Standard
9448 This section documents the class
9449 \begin_inset Quotes eld
9457 \begin_inset Quotes erd
9465 \begin_layout Standard
9466 \begin_inset VSpace bigskip
9472 \begin_layout Standard
9473 If you're looking for the documentation for
9474 \begin_inset Quotes eld
9482 \begin_inset Quotes erd
9486 \begin_inset space ~
9490 \begin_inset CommandInset ref
9492 reference "sec:foiltex"
9502 \begin_inset Quotes eld
9510 \begin_inset Quotes erd
9513 ] is actually somewhat better than the default
9521 \begin_layout Plain Layout
9522 \SpecialChar \ldots{}
9523 or so I've been told repeatedly by its advocates.
9524 Having never used it, I have no idea if this claim is true or not.
9529 which this section documents.
9532 \begin_layout Standard
9533 This class is the LaTeX2e improvement of the old
9538 Every LaTeX2e distribution includes this class [which I'll just refer to
9540 \begin_inset Quotes eld
9548 \begin_inset Quotes erd
9551 from now on], so you're bound to have it.
9552 As I noted earlier, there are other classes, such as
9556 , which also produce slides for overhead projectors and do a better job
9558 However, there are some things which
9562 can do which the others can't, such as generate overlays.
9563 Read on to learn more!
9566 \begin_layout Subsection
9568 \begin_inset CommandInset label
9570 name "sec:slidesetup"
9577 \begin_layout Standard
9578 Obviously, to use this document class, you need to select
9579 \begin_inset Quotes eld
9587 \begin_inset Quotes erd
9590 from the class list in the
9595 ocument\SpecialChar \menuseparator
9603 There are some other special things you should know about this class:
9606 \begin_layout Itemize
9607 Don't bother changing the options
9612 They're not supported by the
9619 \begin_layout Itemize
9626 \begin_inset space ~
9631 behaves a bit differently for this class.
9632 The possible choices and what they do are as follows:
9636 \begin_layout Description
9641 The final output contains page numbers in the lower right corner.
9644 \begin_layout Description
9653 , but also prints out any time markers you've put in.
9654 This is the default.
9657 \begin_layout Description
9662 The final output contains no page numbers, time markers, or alignment markers.
9666 \begin_layout Itemize
9671 class has an extra option:
9677 \begin_inset Quotes eld
9685 \begin_inset Quotes erd
9688 in the extra class options.
9692 \begin_layout Standard
9693 Using this options allows you to add time markers to
9699 \begin_inset space ~
9703 \begin_inset CommandInset ref
9705 reference "sec:slideNote"
9713 \begin_layout Standard
9714 You can also use the template file
9715 \begin_inset Quotes eld
9723 \begin_inset Quotes erd
9726 to automatically set up a document to use the
9735 ile\SpecialChar \menuseparator
9737 \begin_inset space ~
9741 \begin_inset space ~
9750 to open your new document].
9751 The template file also contains some examples of the special paragraph
9752 environments used by this class.
9753 I'll describe those next.
9756 \begin_layout Subsection
9757 Paragraph Environments
9760 \begin_layout Subsubsection
9761 Supported Environments
9764 \begin_layout Standard
9765 The first thing you'll notice when you start up a new
9769 document is the font size and type: it's the equivalent of the size
9770 \begin_inset Quotes eld
9778 \begin_inset Quotes erd
9784 \begin_inset space ~
9790 This is also what's used in the output.
9792 \begin_inset Quotes eld
9796 \begin_inset Quotes erd
9799 to remind you that this is a slide.
9800 Your final slides will use a larger font; ergo, you'll have less space.
9801 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9804 \begin_layout Standard
9805 The next thing that becomes obvious is the changes to the paragraph environment
9806 pull-down box [at the far-left end of the toolbar].
9807 Most of the paragraph environments you're used to seeing are missing.
9808 There are also five new ones.
9813 class itself only supports certain paragraph environments:
9816 \begin_layout Itemize
9822 \begin_layout Itemize
9828 \begin_layout Itemize
9834 \begin_layout Itemize
9840 \begin_layout Itemize
9846 \begin_layout Itemize
9852 \begin_layout Itemize
9858 \begin_layout Itemize
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Itemize
9882 \begin_layout Standard
9883 All of the other standard environments, including the section-heading environmen
9884 ts, aren't used in the
9891 \begin_layout Standard
9892 On the other hand, you'll notice the following new environments:
9895 \begin_layout Itemize
9901 \begin_layout Itemize
9907 \begin_layout Itemize
9913 \begin_layout Itemize
9919 \begin_layout Itemize
9925 \begin_layout Standard
9926 These five are kind of quirky, due to a
9927 \begin_inset Quotes eld
9931 \begin_inset Quotes erd
9935 You see, LyX doesn't permit you to nest any other paragraph environment
9936 into an empty environment.
9937 Now, that's fine and dandy, but it means that you wouldn't be able to start
9938 a slide with anything except plain text.
9939 To deal with this, I've performed a little
9940 \begin_inset Quotes eld
9944 \begin_inset Quotes erd
9950 \begin_layout Subsubsection
9951 Quirks of the New Environments
9952 \begin_inset CommandInset label
9954 name "sec:slideQuirk"
9961 \begin_layout Standard
9962 All five of the new paragraph environments are somewhat quirky due to inherent
9963 limitiations in the current version of LyX.
9964 As I just mentioned, LyX forbids environments that begin with another environme
9966 To get around this, the
9970 environment isn't a paragraph environment as described in the
9978 \begin_layout Standard
9992 \begin_inset Quotes eld
9995 pseudo-environments.
9996 \begin_inset Quotes erd
9999 They look like a section heading or a
10000 \begin_inset Quotes eld
10008 \begin_inset Quotes erd
10011 but really begin a [and, if necessary, end the previous] paragraph environment.
10021 \begin_inset Quotes eld
10025 \begin_inset Quotes erd
10028 These two perform some action.
10031 \begin_layout Standard
10032 A common feature of all five environments,
10052 , is a rather long-ish label.
10053 The text following this label --- ordinarily the contents of the paragraph
10054 environment --- is utterly irrelevant for
10075 LyX completely ignores it.
10076 In fact, you can leave these five environments completely empty.
10080 \begin_layout Standard
10085 to put any text after the rather long-ish label, you might want to.
10086 This could be a short description of the contents of the
10091 In that case, enter in your descriptive comment and hit
10095 as you normally would.
10098 \begin_layout Standard
10099 If, on the other hand, you don't want to enter in any descriptive text,
10100 you'll hit another LyX quirk.
10101 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10102 environment until you put something in the old one.
10106 \begin_layout Itemize
10107 Start entering the text that will
10135 \begin_layout Itemize
10136 Now move to the beginning of that paragraph.
10140 \begin_layout Itemize
10149 \begin_layout Itemize
10150 Finally, change this new, empty paragraph to a
10174 \begin_layout Standard
10175 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10179 \begin_layout Subsection
10180 Making a Presentation with
10193 \begin_layout Subsubsection
10201 \begin_layout Standard
10202 If you're expecting this section to teach you how to actually make a presentatio
10203 n, you'll be sorely disappointed.
10204 Naturally, I'll describe all of the ways the
10208 class can assist you in preparing the materials for a presentation.
10209 Filling in the contents, however, is up to you.
10214 the LyX philosophy.]
10217 \begin_layout Standard
10222 environment [in the manner described in section
10223 \begin_inset space ~
10227 \begin_inset CommandInset ref
10229 reference "sec:slideQuirk"
10233 ] tells LyX to begin a new slide [duh].
10234 The label for this environment/
10235 \begin_inset Quotes erd
10239 \begin_inset Quotes erd
10243 \begin_inset Quotes eld
10247 \begin_inset Quotes erd
10250 in cool blue, followed by the label,
10251 \begin_inset Quotes eld
10255 \begin_inset Quotes erd
10259 Any text or paragraph environments that follow this one go on the new slide.
10263 \begin_layout Standard
10264 Slides are probably the only time you'll need to forcibly end pages in LyX
10265 (this can be specified in the
10270 In fact, you'll want to, once you finish entering the contents of one slide.
10271 If you've entered more text than can physically fit on a slide, the extra
10272 overflows onto a new slide.
10273 I don't recommend doing this, however, since the overflow slide won't have
10274 any page number on it.
10275 Furthermore, it may interfere with any
10279 you've made to accompany the oversized
10286 \begin_layout Standard
10295 environments work the same way as the
10300 They both create an
10301 \begin_inset Quotes eld
10305 \begin_inset Quotes erd
10308 followed by a label [
10309 \begin_inset Quotes eld
10313 \begin_inset Quotes erd
10317 \begin_inset Quotes eld
10321 \begin_inset Quotes erd
10325 The color is a stunning magenta instead of blue, and the
10326 \begin_inset Quotes eld
10330 \begin_inset Quotes erd
10333 will look different, in style and in length.
10334 The label fonts of all three also differ from one another.
10337 \begin_layout Standard
10342 , if the contents of a
10350 exceed the physical size of a slide or sheet of paper, the extra will overflow
10352 Again, you should avoid this.
10353 It defeats the whole purpose of
10364 \begin_layout Subsubsection
10374 \begin_layout Standard
10379 is a slide that sits atop another slide.
10380 Perhaps you wish to discuss a figure on the main
10384 before displaying the text associated with it.
10385 One way to accomplish this is tape a flap of dark paper over the part of
10390 you want to display later.
10391 This method fails, however, if you wish to overlap one graph with another,
10393 You would then have to fumble while speaking to align the two separate,
10398 s to align the two graphs.
10403 environment in both cases makes life much easier.
10406 \begin_layout Standard
10411 receives the page number of its
10412 \begin_inset Quotes eld
10416 \begin_inset Quotes erd
10424 \begin_inset Quotes eld
10432 \begin_inset Quotes erd
10439 \begin_layout Plain Layout
10440 Presumably, mutliple
10445 \begin_inset Quotes eld
10453 \begin_inset Quotes erd
10457 \begin_inset Quotes eld
10465 \begin_inset Quotes erd
10469 \begin_inset Quotes eld
10477 \begin_inset Quotes erd
10481 \begin_inset space ~
10484 appended to the page number of the parent
10494 Clearly, you want the contents of both the
10502 to each fit on a single physical slide! You should probably consider an
10508 \begin_inset Quotes eld
10512 \begin_inset Quotes erd
10524 class provides a visual cue for this: the label at the start of an
10528 is shorter than that at the start of a
10533 Lastly, when you generate printable output, you'll find alignment markers
10534 in all four corners of both the
10538 page and its parent
10543 These will assist you in lining up the two physical slides.
10546 \begin_layout Standard
10547 The major problem in overlaying two slides is aligning the contents of the
10548 two transparencies.
10549 How much space should you leave for that graph on the second slide? Worse
10550 still, what if you want a graph and a sentence on second slide, but there
10551 is text on the main transparency that goes in between them? You could try
10552 and insert vertical space of the right size.
10553 The better way is to use
10564 \begin_layout Standard
10565 As their names imply,
10573 are two command-like paragraph environments that make all subsequent text
10574 invisible and visible, respectively.
10576 \begin_inset space ~
10580 \begin_inset CommandInset ref
10582 reference "sec:slideQuirk"
10586 that you don't place anything
10590 these two environments, however.
10595 , it inserts a centered, sky-blue label into the page reading
10596 \begin_inset Quotes eld
10599 <Invisible Text Follows>
10600 \begin_inset Quotes erd
10604 For paragraphs following this label, the parts of the
10612 ; it doesn't matter which] where they would be contain instead blank space.
10616 \begin_layout Standard
10621 , the corresponding centered label is
10622 \begin_inset Quotes eld
10625 <Visible Text Follows>
10626 \begin_inset Quotes erd
10630 Paragraphs following this label behave normally.
10631 Note that the beginning of a new
10643 automatically shuts off an
10648 It's therefore not necessary to use
10659 \begin_layout Standard
10660 By now, it should be obvious how to create overlay transparencies using
10661 the proper combination of
10680 \begin_layout Enumerate
10685 , including everything that will appear on it, whether on the main slide
10693 \begin_layout Enumerate
10694 Before each figure or paragraph that will appear only on the
10703 If necessary, insert a
10707 environment after the
10714 \begin_layout Enumerate
10719 immediately following the
10726 \begin_layout Enumerate
10727 Copy the contents of this
10738 \begin_layout Enumerate
10743 , change all of the
10754 \begin_layout Standard
10756 You've just made an
10763 \begin_layout Standard
10764 There's one problem with the way I've designed the LyX
10768 class: you can't make text in the middle of a paragraph invisible, nor
10769 make text in the middle of an invisible paragraph visible again.
10770 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10774 \begin_layout Plain Layout
10775 The commands of interest are:
10778 \begin_layout Itemize
10783 invisible \SpecialChar \ldots{}
10787 \begin_layout Itemize
10792 visible \SpecialChar \ldots{}
10796 \begin_layout Plain Layout
10797 \SpecialChar \ldots{}
10798 and need to be marked as TeX.
10800 \begin_inset Quotes eld
10804 \begin_inset Quotes erd
10807 you wish to change goes in between the brackets [and after the
10820 If you don't know how to mark text as TeX, see the appropriate section
10833 \begin_layout Subsubsection
10843 \begin_inset CommandInset label
10845 name "sec:slideNote"
10852 \begin_layout Standard
10861 is associated with a
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10878 class provides visual cues.
10883 is shorter than that of a
10887 [yet longer than that of an
10891 ] and, like the label of an
10895 is shockingly magenta.
10896 Additionally, the printed
10900 has the page number of its
10901 \begin_inset Quotes eld
10905 \begin_inset Quotes erd
10913 \begin_inset Quotes eld
10921 \begin_inset Quotes erd
10925 \begin_inset Quotes eld
10933 \begin_inset Quotes erd
10937 \begin_inset Quotes eld
10945 \begin_inset Quotes erd
10949 You can have multiple
10953 s associated with a single
10965 , you'll probably want to break up long
10969 s so that they fit on a single sheet of paper.
10972 \begin_layout Standard
10977 is obvious: it contains anything additional you might want to say about
10983 It could also be used as a sheet of reminders for a particular
10988 In the case of the latter, you might want to make use of time markers.
10994 \begin_inset Quotes eld
10998 \begin_inset Quotes erd
11001 support for time markers, a
11006 So, you'll have to resort to using the LaTeX codes.
11009 \begin_layout Standard
11010 To use time markers, you'll need to specify the extra class option
11011 \begin_inset Quotes eld
11019 \begin_inset Quotes erd
11023 \begin_inset space ~
11027 \begin_inset CommandInset ref
11029 reference "sec:slidesetup"
11034 This option turns on timing marks, which will appear in the lower-left-hand
11040 To set what appears in the time marker, you use the LaTeX commands
11041 \begin_inset Quotes eld
11051 \begin_inset Quotes erd
11055 \begin_inset Quotes eld
11065 \begin_inset Quotes erd
11069 The arguments of both commands are time measured in seconds.
11071 \begin_inset Quotes eld
11081 \begin_inset Quotes erd
11084 sets the time marker to a given time.
11086 \begin_inset Quotes eld
11096 \begin_inset Quotes erd
11099 increments the time marker by the specified amount.
11100 Using time markers and
11104 s in this fashion, you can remind yourself how much time to spend on a particula
11112 \begin_layout Standard
11113 There's one last feature to describe.
11114 Clearly, you'd like to print out all of your
11122 s on transparencies while printing all of your
11139 with which it is associated.
11140 What's a person to do?
11143 \begin_layout Standard
11144 Luckily, there are two LaTeX commands that allow you to select what to print
11146 Both must be placed into the preamble of your document.
11148 \begin_inset Quotes eld
11160 \begin_inset Quotes erd
11163 will cause the output to contain only the
11172 Correspondingly, the command
11173 \begin_inset Quotes eld
11185 \begin_inset Quotes erd
11188 prevents the output of anything but
11193 I'd advise placing both commands in the preamble and initially comment
11195 You can then preview your entire presentation as you write.
11196 When you're done writing, you can then uncomment one of the two to select
11197 what you want to print.
11198 I like to uncomment
11199 \begin_inset Quotes eld
11211 \begin_inset Quotes erd
11214 , print to a file with
11215 \begin_inset Quotes eld
11223 \begin_inset Quotes erd
11226 in its name, comment it back out, then uncomment
11227 \begin_inset Quotes eld
11239 \begin_inset Quotes erd
11243 \begin_inset Quotes eld
11251 \begin_inset Quotes erd
11255 I can then send either file to a printer, loading transparencies or plain
11256 paper as appropriate.
11259 \begin_layout Standard
11260 You can also provide other arguments to the
11261 \begin_inset Quotes eld
11271 \begin_inset Quotes erd
11275 \begin_inset Quotes eld
11285 \begin_inset Quotes erd
11289 See a good LaTeX book for details.
11292 \begin_layout Subsection
11297 Class Template File
11300 \begin_layout Standard
11301 I have also provided a template file,
11302 \begin_inset Quotes eld
11310 \begin_inset Quotes erd
11318 To use it, begin your new presentation with
11323 ile\SpecialChar \menuseparator
11325 \begin_inset space ~
11329 \begin_inset space ~
11339 Your new LyX presentation file will contain an example
11360 additionally contain an example of the use of
11369 Lastly, the preamble will contain:
11372 \begin_layout LyX-Code
11373 % Uncomment to print out only slides and overlays
11376 \begin_layout LyX-Code
11380 \begin_layout LyX-Code
11386 \begin_inset Newline newline
11392 \begin_layout LyX-Code
11393 % Uncomment to print out only notes
11396 \begin_layout LyX-Code
11400 \begin_layout LyX-Code
11408 \begin_layout Standard
11409 One final thing: I created this class to support the LaTeX2e
11410 \begin_inset Quotes eld
11418 \begin_inset Quotes erd
11421 class, one of the built-in LaTeX2e classes.
11422 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11423 built-in slide class.
11424 It's here if you want it or need it.
11425 There exist other LaTeX2e classes for creating presentations, such as the
11431 \begin_inset space ~
11435 \begin_inset CommandInset ref
11437 reference "sec:foiltex"
11442 \begin_inset Quotes eld
11450 \begin_inset Quotes erd
11453 package [present on some TeX distributions].
11454 The latter is not yet supported under LyX.
11458 \begin_layout Plain Layout
11459 Perhaps you can take on the task\SpecialChar \ldots{}
11465 I know nothing about these other classes.
11466 Try them out to see what sort of alternative they provide.
11469 \begin_layout Section
11478 \begin_inset CommandInset label
11487 \begin_layout Standard
11493 \begin_layout Subsection
11497 \begin_layout Standard
11498 This section describes how to use LyX to make slides for overhead projectors.
11499 There are two document classes that can do this: the default slides class
11505 This section documents the latter.
11508 \begin_layout Standard
11509 I'm going to say this again, nice and clear, so that there's no misunderstanding
11513 \begin_layout Standard
11514 \begin_inset VSpace bigskip
11520 \begin_layout Standard
11524 This section documents the class
11525 \begin_inset Quotes eld
11533 \begin_inset Quotes erd
11541 \begin_layout Standard
11542 \begin_inset VSpace bigskip
11548 \begin_layout Standard
11549 If you're looking for the documentation for
11550 \begin_inset Quotes eld
11558 \begin_inset Quotes erd
11561 , check out section
11562 \begin_inset space ~
11566 \begin_inset CommandInset ref
11568 reference "sec:slitex"
11573 If your machine doesn't have the
11578 \begin_inset Quotes eld
11586 \begin_inset Quotes erd
11589 ] installed, you'll probably have to use the default
11593 class, which isn't quite as good as
11598 \begin_layout Standard
11603 class is designed for use with version 2.1 of the
11607 LaTeX class file which is now an integral part of LaTeX2e.
11610 \begin_layout Subsection
11614 \begin_layout Standard
11615 Obviously, to use this document class, you need to select
11616 \begin_inset Quotes eld
11624 \begin_inset Quotes erd
11637 \begin_inset space ~
11643 There are some settings in the
11646 \begin_inset space ~
11651 dialog that you should know about that are specific to this class:
11654 \begin_layout Itemize
11655 Don't change the options
11666 \begin_inset space ~
11672 They're ignored by the
11679 \begin_layout Itemize
11680 The default font size is 20pt with the other options being 17pt, 25pt and
11684 \begin_layout Itemize
11685 The default font is
11693 but all math equations are still typeset in the usual roman font.
11696 \begin_layout Itemize
11701 TeX supports A4 and Letter paper sizes as well as a special size for working
11703 It doesn't support A5, B5, legal or executive paper sizes.
11706 \begin_layout Itemize
11707 Don't bother changing the
11711 settings because they are ignored anyway.
11712 All floats appear where they are defined in the text.
11715 \begin_layout Itemize
11723 setting behaves a bit differently for this class.
11728 TeX provides extensive footer and header capabilities including a user-defined
11731 \begin_inset space ~
11735 \begin_inset CommandInset ref
11737 reference "sec:foilfoot"
11742 The title page is treated differently to all other pages in the document
11751 has the logo centered at the bottom of the page (if one is defined).
11752 The possible page style choices and what they do are as follows:
11756 \begin_layout Labeling
11757 \labelwidthstring MMMMMMM
11764 The final output contains no page numbers, or other headers or footers
11765 (except footnotes of course).
11769 \begin_layout Labeling
11770 \labelwidthstring MMMMMMM
11777 The final output contains page numbers centered at the bottom of the page.
11778 No other headings or footers (other than footnotes).
11781 \begin_layout Labeling
11782 \labelwidthstring MMMMMMM
11787 Page numbers in lower right corner.
11788 Additional headers and footers are also shown.
11789 This is also the default.
11792 \begin_layout Labeling
11793 \labelwidthstring MMMMMMM
11798 Gives you access to the
11802 package although its use with
11806 TeX is discouraged by the writer of the
11810 TeX package because of some potential page layout clashes.
11814 \begin_layout Subsubsection
11818 \begin_layout Standard
11819 The following options may be used in the extra class options in the
11824 ocument\SpecialChar \menuseparator
11834 \begin_layout Labeling
11835 \labelwidthstring MMMMMMx
11840 This sets up the page layout for 7.33in by 11in paper, which is about the
11841 same aspect ratio as a 35mm slide, making it a bit easier to work with
11845 \begin_layout Labeling
11846 \labelwidthstring MMMMMMx
11851 Places a rule across the page below the header on every page except the
11855 \begin_layout Labeling
11856 \labelwidthstring MMMMMMx
11861 Places a rule across the page above the footer on every page except the
11865 \begin_layout Labeling
11866 \labelwidthstring MMMMMMx
11871 This is automatically set each time you create a new
11880 TeX to use the dvips driver to rotate those pages that are set as landscape
11884 \begin_layout Labeling
11885 \labelwidthstring MMMMMMx
11890 Simply changes the page dimensions to those of a landscape page but doesn't
11892 Thus if you use this option you need to use an external program to rotate
11893 each page or feed your paper through your printer as landscape.
11894 Note that this option effectively reverses the roles of the
11902 environments (don't worry these are described in the next section).
11905 \begin_layout Labeling
11906 \labelwidthstring MMMMMMx
11911 Equation numbers on the left.
11914 \begin_layout Labeling
11915 \labelwidthstring MMMMMMx
11920 Flush-left equations.
11923 \begin_layout Subsection
11924 Supported Environments
11927 \begin_layout Standard
11928 Most of the environments commonly supported in other classes are also supported
11934 There are several additional environments provided by
11938 TeX as well as a couple added by LyX.
11939 The following environments are shared with other classes:
11942 \begin_layout Standard
11946 \begin_layout Plain Layout
11950 begin{multicols}{2}
11958 \begin_layout Itemize
11964 \begin_layout Itemize
11970 \begin_layout Itemize
11976 \begin_layout Itemize
11982 \begin_layout Itemize
11988 \begin_layout Itemize
11994 \begin_layout Itemize
12000 \begin_layout Itemize
12006 \begin_layout Itemize
12012 \begin_layout Itemize
12018 \begin_layout Itemize
12024 \begin_layout Itemize
12030 \begin_layout Itemize
12036 \begin_layout Itemize
12042 \begin_layout Itemize
12048 \begin_layout Itemize
12054 \begin_layout Itemize
12060 \begin_layout Itemize
12066 \begin_layout Standard
12070 \begin_layout Plain Layout
12082 \begin_layout Standard
12083 That is, all the major environments apart from the sectioning environments.
12084 Since foils are essentially self-contained sections, with a title and body,
12089 TeX provides specific commands for starting new foils and these are:
12092 \begin_layout Itemize
12098 \begin_layout Itemize
12104 \begin_layout Standard
12105 LyX also provides slightly modified versions of these two environments called:
12108 \begin_layout Itemize
12114 \begin_layout Itemize
12117 ShortRotatefoilhead
12120 \begin_layout Standard
12121 and the differences will be explained in the next section.
12124 \begin_layout Standard
12125 Since foils are often used in presenting ideas or new theorems and such
12130 TeX also provides a comprehensive box of goodies for presenting them:
12133 \begin_layout Standard
12137 \begin_layout Plain Layout
12141 begin{multicols}{2}
12149 \begin_layout Itemize
12155 \begin_layout Itemize
12161 \begin_layout Itemize
12167 \begin_layout Itemize
12173 \begin_layout Itemize
12179 \begin_layout Itemize
12185 \begin_layout Itemize
12191 \begin_layout Itemize
12197 \begin_layout Itemize
12203 \begin_layout Itemize
12209 \begin_layout Itemize
12215 \begin_layout Standard
12219 \begin_layout Plain Layout
12231 \begin_layout Standard
12232 The starred versions are unnumbered while the unstarred versions are numbered.
12233 There are also two list environments added by LyX and these are:
12236 \begin_layout Itemize
12242 \begin_layout Itemize
12248 \begin_layout Standard
12253 TeX provides some powerful header and footer capabilities that are best
12254 set in the preamble although they may be set at any point in a document.
12255 If you want to change these settings in your document the best place to
12256 do so is at the very top of a foil,
12261 straight after the foilhead.
12264 \begin_layout Standard
12265 For this purpose, the following command styles are provided [
12272 \begin_layout Standard
12276 \begin_layout Plain Layout
12280 begin{multicols}{2}
12288 \begin_layout Itemize
12292 \begin_inset space ~
12298 \begin_layout Itemize
12304 \begin_layout Itemize
12308 \begin_inset space ~
12314 \begin_layout Itemize
12318 \begin_inset space ~
12324 \begin_layout Itemize
12328 \begin_inset space ~
12335 \begin_layout Standard
12336 \begin_inset space ~
12343 \begin_layout Standard
12347 \begin_layout Plain Layout
12359 \begin_layout Standard
12360 There are also a few commands provided by
12364 TeX that aren't directly supported by LyX but I'll tell you what they do
12365 and how to use them in section
12366 \begin_inset space ~
12370 \begin_inset CommandInset ref
12372 reference "sec:unsuppfoils"
12379 \begin_layout Subsection
12380 Building a Set of Foils
12383 \begin_layout Standard
12384 This section will give a simple introduction to using the different environments
12385 to build a set of foils.
12386 If you want to see an example set of foils, take a look at the
12390 file you find in LyX's
12397 \begin_layout Subsubsection
12398 Give It a Title Page
12401 \begin_layout Standard
12402 Unlike other classes that provide
12422 creates the title on a page of its own.
12423 If you leave out the
12427 environment LaTeX will substitute the current date (every time you regenerate
12431 \begin_layout Subsubsection
12435 \begin_layout Standard
12436 As I mentioned earlier, there are four ways of starting a new foil.
12437 For portrait foils you should use
12446 The difference between these two environments is the amount of space between
12447 the title of the foil (the foilhead) and the body of the foil.
12450 \begin_layout Standard
12451 Landscape foils are generated using the
12457 ShortRotatefoilhead
12460 Again the only difference is the spacing between foilhead and body.
12461 Both of the short versions have 0.5 inches less separation between the foilhead
12466 \begin_layout Standard
12467 One problem with the support for landscape foils is the requirement that
12468 you have to use the
12472 driver to generate the PostScript output otherwise the foils won't be rotated.
12473 It is possible to get landscape foils even if you haven't got the
12477 driver provided you can feed your foils sideways through your printer ;-)
12480 \begin_layout Subsubsection
12481 Theorems, Lemmas, Proofs and more
12484 \begin_layout Standard
12485 Due to a small bug in LyX you can't have two of the same type of these environme
12486 nts directly following each other.
12487 They must be separated by something.
12488 If you try, you will just be extending the previous environment as if you
12489 had merged the two environments together.
12490 So, how do you get around this problem? The simplest option is to insert
12491 some text between the two environments or add a
12495 environment between the two with just a
12496 \begin_inset Quotes eld
12504 \begin_inset Quotes erd
12508 This will force LyX to produce two separate environments and hence the
12509 correct LaTeX output.
12510 An example is provided in the example file included with the LyX distribution.
12511 Remember, this problem only occurs if you are trying to place two of the
12512 same type of theorem-like environments one directly after the other.
12515 \begin_layout Subsubsection
12519 \begin_layout Standard
12520 You get all the commonly supported list styles found in other classes as
12521 well as two new ones.
12522 I'll only describe the new ones here.
12523 If you want to find out more about the other list environments check out
12529 If you intend to use itemized lists you might also want to read about the
12533 \begin_inset space ~
12537 \begin_inset space ~
12542 dialog described above in section
12543 \begin_inset space ~
12547 \begin_inset CommandInset ref
12549 reference "sec:bullet"
12556 \begin_layout Standard
12557 The two new list styles,
12565 , are designed to make it easier for you to create lists of do's and don'ts
12566 or right and wrong by providing dedicated environments that use a tick
12567 or a cross as the label of the list.
12568 These lists are in fact dedicated variants of the
12573 They do however require that you have the
12577 packages installed.
12580 \begin_layout Subsubsection
12584 \begin_layout Standard
12589 TeX redefines the floating tables and figures so that they appear exactly
12590 where they are in the text rather than pushing them to the top of the page
12591 or to some user specified location.
12592 In fact if you change the float placement settings they are simply ignored.
12595 \begin_layout Subsubsection
12596 Page Headers and Footers
12597 \begin_inset CommandInset label
12599 name "sec:foilfoot"
12606 \begin_layout Standard
12610 \begin_inset space ~
12619 are two commands used to control the left-footer text string.
12620 The first is meant to allow you to include a graphic logo on your foils
12622 \begin_inset Quotes eld
12630 \begin_inset Quotes erd
12634 While the second is meant to provide a classification for the audience,
12638 \begin_inset space \thinspace{}
12644 \begin_inset space ~
12648 It is empty by default.
12651 \begin_layout Standard
12652 The remaining page corners can be filled by
12655 \begin_inset space ~
12660 (which defaults to page numbers),
12663 \begin_inset space ~
12671 \begin_inset space ~
12679 \begin_layout Subsection
12685 \begin_inset CommandInset label
12687 name "sec:unsuppfoils"
12694 \begin_layout Standard
12695 All the commands mentioned below need to be set in a
12703 within another environment.
12706 \begin_layout Subsubsection
12710 \begin_layout Standard
12711 All lengths are adjusted using the
12734 should be replaced by the name given to the length you want to change and
12739 is the length value.
12740 All lengths should be specified in units of length such as inches (
12752 ) or relative to some document or font-based length such as
12762 \begin_layout Standard
12763 It's possible to change the spacing between a foilhead and the body of the
12764 foil by adjusting the length specified by
12771 For example, to make
12775 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12782 foilheadskip}{-0.5in}
12785 \begin_layout Standard
12786 The spacings around floats can be adjusted by setting these lengths:
12789 \begin_layout Labeling
12790 \labelwidthstring MMMMMMMMMMM
12797 Separation between the text and the top of the float
12800 \begin_layout Labeling
12801 \labelwidthstring MMMMMMMMMMM
12808 Separation between the float and the caption
12811 \begin_layout Labeling
12812 \labelwidthstring MMMMMMMMMMM
12819 Separation between the caption and the following text
12822 \begin_layout Labeling
12823 \labelwidthstring MMMMMMMMMMM
12830 You can make the captions narrower than the surrounding text by adjusting
12832 Best done relative to
12841 \begin_layout Standard
12842 There are also several title page related lengths that you may find useful
12843 if you have a long title or several authors:
12846 \begin_layout Labeling
12847 \labelwidthstring MMMMMMMMMMM
12854 Separation from headers to
12859 \begin_layout Labeling
12860 \labelwidthstring MMMMMMMMMMM
12878 \begin_layout Labeling
12879 \labelwidthstring MMMMMMMMMMM
12893 \begin_layout Labeling
12894 \labelwidthstring MMMMMMMMMMM
12910 \begin_layout Labeling
12911 \labelwidthstring MMMMMMMMMMM
12927 \begin_layout Standard
12928 The last length related command affects all the list environments.
12939 a list environment then all the vertical spacing between the list items
12941 Note that this is a command not a length so it doesn't require
12947 like the stuff mentioned above.
12950 \begin_layout Subsubsection
12951 Headers and Footers
12954 \begin_layout Standard
12967 commands control whether the logo in the
12971 definition appear on a given page.
12978 in the preamble then none of the foils will have the logo on them.
12979 If you don't want the logo on a particular page place the
12985 directly after the foilhead of that page and the
12991 directly after the next foilhead.
12994 \begin_layout Standard
12995 If you decide to use the
12999 page style setting in the
13002 \begin_inset space ~
13007 dialog you should probably add
13017 to your preamble so headers and footers on landscape pages are correctly
13018 placed when rotated.
13019 This is due to some clashes between the page layouts provided by the
13030 \begin_layout Section
13031 Latex8 (IEEE Conference Papers)
13034 \begin_layout Standard
13040 \begin_layout Subsection
13044 \begin_layout Standard
13045 Since this class is specifically for writing submissions to IEEE sponsored
13046 conferences I strongly recommend that you get a copy of their Authors Kit.
13051 package and associated bibliography style file is included in the kit.
13052 The Authors Kit is usually sent out by email once your initial submission
13054 There is a lot of useful information in the Authors Kit explaining formatting
13055 restrictions and so on and I will assume you have read this since that
13056 means I don't have to repeat it all here.
13059 \begin_layout Subsection
13063 \begin_layout Standard
13064 [AR\SpecialChar \@.
13068 \begin_layout Subsection
13069 Supported Environments
13072 \begin_layout Itemize
13078 \begin_layout Itemize
13084 \begin_layout Itemize
13090 \begin_layout Itemize
13096 \begin_layout Itemize
13102 \begin_layout Itemize
13108 \begin_layout Itemize
13114 \begin_layout Itemize
13120 \begin_layout Itemize
13126 \begin_layout Subsection
13127 Differences Between Screen and Paper
13130 \begin_layout Standard
13131 There are slight differences in appearance mainly with the presentation
13132 of section counters.
13133 On screen the trailing period of the section counter is missing but it
13134 will appear in the output so don't let this worry you.
13137 \begin_layout Section
13138 Hollywood (Hollywood spec scripts)
13141 \begin_layout Standard
13147 \begin_layout Subsection
13151 \begin_layout Standard
13152 Getting the format of a Hollywood script right is a
13153 \begin_inset Quotes eld
13157 \begin_inset Quotes erd
13160 It is designed to make the readers focus on content and to be easy and
13161 familiar for the actors to read.
13162 Each page of a script should be one minute of film.
13163 Nothing goes in a script that you cannot see or hear on screen.
13164 The courier 12 pt font should be used throughout.
13168 \begin_layout Subsection
13172 \begin_layout Standard
13173 Speakers' lines should NEVER break in mid-sentence.
13174 If a speaker's lines continue over a page break, repeat the
13178 title followed by (Cont'd).
13181 \begin_layout Subsection
13185 \begin_layout Standard
13190 names as labels then cross-reference the label to insert the name.
13191 The cross-reference dialog will show the current cast of characters.
13192 You can use this to insert the speaker name in narratives also.
13195 \begin_layout Subsection
13196 Paper size and Margins
13199 \begin_layout Standard
13200 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13203 \begin_layout Subsection
13207 \begin_layout Standard
13208 The following environments are available.
13209 You can use hollywood.bind to get the bind keys shown at the right.
13212 \begin_layout Itemize
13216 \begin_inset Newline newline
13221 Used where nothing else works.
13225 \begin_layout Itemize
13231 \begin_inset space \hfill{}
13239 \begin_inset Newline newline
13242 Usually followed by something like
13243 \begin_inset Quotes eld
13246 on Sally waking up.
13247 \begin_inset Quotes erd
13253 \begin_layout Itemize
13257 \begin_inset space \hfill{}
13261 \begin_inset Newline newline
13266 Introduces a new INTERIOR camera set-up.
13267 Always followed by DAY or NIGHT, or something similar to define the lighting
13269 Everthing on this line in CAPS.
13272 \begin_layout Itemize
13276 \begin_inset space \hfill{}
13280 \begin_inset Newline newline
13285 Introduces a new EXTERIOR camera set-up.
13286 Everthing on this line in CAPS.
13289 \begin_layout Itemize
13293 \begin_inset space \hfill{}
13297 \begin_inset Newline newline
13302 The character speaking.
13305 \begin_layout Itemize
13309 \begin_inset space \hfill{}
13313 \begin_inset Newline newline
13318 Instructions to the speaker.
13319 The () are automatically inserted, but only the ( will show in LyX.
13320 Both will be printed.
13323 \begin_layout Itemize
13327 \begin_inset space \hfill{}
13331 \begin_inset Newline newline
13343 \begin_layout Itemize
13347 \begin_inset space \hfill{}
13351 \begin_inset Newline newline
13356 Camera movement instruction.
13358 \begin_inset space \thinspace{}
13362 \begin_inset space ~
13368 \begin_layout Itemize
13372 \begin_inset space \hfill{}
13378 \begin_layout Itemize
13382 \begin_inset space \hfill{}
13388 \begin_layout Itemize
13392 \begin_inset space \hfill{}
13398 \begin_layout Itemize
13402 \begin_inset space \hfill{}
13408 \begin_layout Subsection
13412 \begin_layout Itemize
13413 (O.S) --- off screen
13416 \begin_layout Itemize
13417 (V.0) --- voice over
13420 \begin_layout Itemize
13425 \begin_layout Itemize
13430 \begin_layout Itemize
13431 PAN --- camera movement
13434 \begin_layout Itemize
13435 INSERT --- cut to close-up of
13438 \begin_layout Section
13442 \begin_layout Standard
13448 \begin_layout Subsection
13452 \begin_layout Standard
13453 Broadway is for writing plays.
13454 The format is more decorative than Hollywood, and much less standardized.
13455 This format should be suitable for workshops.
13458 \begin_layout Subsection
13462 \begin_layout Standard
13463 The same as in Hollywood.
13466 \begin_layout Subsection
13470 \begin_layout Standard
13475 names as labels then cross-reference the label to insert the name.
13476 The cross-reference dialog will show the current cast of characters.
13479 \begin_layout Subsection
13480 Paper size and Margins
13483 \begin_layout Standard
13484 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13487 \begin_layout Subsection
13491 \begin_layout Standard
13492 The following environments are available.
13493 You can use broadway.bind to get the bind keys shown at the right.
13496 \begin_layout Itemize
13500 \begin_inset Newline newline
13505 You should not have to use this, but it is here for anything that does not
13509 \begin_layout Itemize
13513 \begin_inset space \hfill{}
13517 \begin_inset Newline newline
13522 Used to describe stage setting and the action.
13523 First use of speaker names in all CAPs.
13526 \begin_layout Itemize
13530 \begin_inset space \hfill{}
13534 \begin_inset Newline newline
13539 Automatically numbered.
13540 On screen it will be arabic, but will print as Roman.
13543 \begin_layout Itemize
13547 \begin_inset space \hfill{}
13551 \begin_inset Newline newline
13561 It is just centered text.
13564 \begin_layout Itemize
13568 \begin_inset space \hfill{}
13572 \begin_inset Newline newline
13577 Not automatically numbered.
13578 You supply the number.
13579 This is because I couldn't figure out how.
13582 \begin_layout Itemize
13586 \begin_inset space \hfill{}
13590 \begin_inset Newline newline
13595 A special case of Narrative to describe the setting and action as the curtain
13599 \begin_layout Itemize
13603 \begin_inset space \hfill{}
13607 \begin_inset Newline newline
13612 The speaker's (actor's) title, centered in all CAPS.
13615 \begin_layout Itemize
13619 \begin_inset space \hfill{}
13623 \begin_inset Newline newline
13628 Instructions to the speaker.
13629 The parentheses are automatically inserted.
13630 The ( will appear on screen, but both will be in the printed play.
13631 This environment is only used within
13638 \begin_layout Itemize
13642 \begin_inset space \hfill{}
13646 \begin_inset Newline newline
13651 What the Speaker says.
13654 \begin_layout Itemize
13658 \begin_inset space \hfill{}
13662 \begin_inset Newline newline
13667 The curtain comes down.
13670 \begin_layout Itemize
13674 \begin_inset space \hfill{}
13680 \begin_layout Itemize
13684 \begin_inset space \hfill{}
13690 \begin_layout Itemize
13694 \begin_inset space \hfill{}
13700 \begin_layout Standard
13704 \begin_layout Section
13708 \begin_layout Standard
13714 \begin_layout Standard
13715 \begin_inset VSpace bigskip
13721 \begin_layout Standard
13726 \begin_inset space ~
13731 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13732 \begin_inset Formula $\beta$
13735 release of May, 1999) class.
13738 \begin_layout Standard
13743 textclass, which works with RevTeX 3.1.
13744 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13745 That means that it doesn't interact very well with LyX, which requires
13746 LaTeX2e, although it has been kludged to work.
13747 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13751 \begin_inset space ~
13756 textclass should also be pretty easy to use.
13759 \begin_layout Standard
13760 These documents are supposed to be used in
13764 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13765 macros, and assume you'll know what to put in the preamble if necessary.
13768 \begin_layout Subsection
13772 \begin_layout Standard
13773 All you need to do is install RevTeX 4, as described in the package's README
13775 The package can be found at The RevTeX 4 Web Site
13776 \begin_inset Flex URL
13779 \begin_layout Plain Layout
13781 http://publish.aps.org/revtex4/
13787 Install it somewhere that LaTeX can see it.
13788 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13789 (i.e., not the directory where you installed the class file.) Then, if you
13790 reconfigure LyX, it will find the class file and let you use the RevTeX4
13794 \begin_layout Standard
13795 Probably the easiest way to get started is either to import a RevTeX 4 document
13803 \begin_inset space ~
13808 template, found in the templates directory.
13811 \begin_layout Subsection
13815 \begin_layout Standard
13816 Optional arguments to
13823 \begin_inset Quotes eld
13827 \begin_inset Quotes erd
13831 \begin_inset Quotes eld
13835 \begin_inset Quotes erd
13845 \begin_inset space ~
13853 \begin_inset space ~
13859 Remember that in RevTeX, at least one optional argument is required!
13862 \begin_layout Standard
13863 Other preamble matter, like
13870 \begin_inset space ~
13880 \begin_inset space ~
13885 dialog, also as usual.
13888 \begin_layout Subsection
13892 \begin_layout Standard
13893 The layouts basically correspond to the commands in RevTeX4.0.
13894 For example, the Email layout corresponds to
13901 Note that (at least as of RevTeX 4.0 Beta), the
13909 layouts are exactly equivalent, so you shouldn't need to use both.
13913 \begin_layout Plain Layout
13914 In case you're curious, both were included so that
13918 would be able to translate both
13938 \begin_layout Subsection
13942 \begin_layout Standard
13943 There are a couple of important unique aspects of RevTeX 4 which might cause
13944 bugs that will be even more confusing in LyX.
13947 \begin_layout Standard
13965 The LyX equivalent is that there is a separate Thanks layout.
13970 write footnotes in the
13974 layout, or weird things may happen.
13975 See the RevTeX 4 documentation for more details.
13978 \begin_layout Standard
13982 \begin_inset space ~
13990 \begin_inset space ~
13999 layouts must be placed
14007 layout and the corresponding
14024 , the LaTeX won't compile.
14027 \begin_layout Subsection
14031 \begin_layout Standard
14032 The main problem with this layout is that you can't use the optional arguments
14033 to layouts like Email and Title.
14034 (The problem is not unique to this layout; you can't use optional arguments
14035 to the Section layouts either.) This means that after you export that file
14036 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14037 need to edit the LaTeX file with a text editor to add the optional arguments
14039 \begin_inset space \thinspace{}
14042 g., the running title for the page headers.
14043 Lacking these layouts makes the
14049 (and the equivalent
14055 ) useless, so the corresponding layouts don't exist, and will have to be
14060 \begin_layout Plain Layout
14065 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14066 has not been updated yet to take advantage of it.
14074 \begin_layout Section
14075 Article (mwart), book (mwbk) and report (mwrep)
14076 \begin_inset OptArg
14079 \begin_layout Plain Layout
14092 \begin_layout Standard
14098 \begin_layout Standard
14099 The LyX document classes
14115 correspond to the LaTeX document classes
14128 They are replacements for the standard document classes
14140 , resp., and fit better to Polish typography conventions in a number of points.
14144 \begin_layout Standard
14148 \begin_layout Itemize
14149 Unnumbered titles (with star, eg.
14154 ) are added into table of contents,
14157 \begin_layout Itemize
14158 Additional page styles:
14162 \begin_layout Description
14163 uheadings header with separated lines,
14166 \begin_layout Description
14167 myheadings custom header, contents headers via commands:
14182 \begin_layout Description
14183 myuheadings custom header with separated lines,
14186 \begin_layout Description
14187 outer page number is placed on outer side of page
14191 \begin_layout Itemize
14196 \begin_layout Description
14197 rmheadings serif titles --- default,
14200 \begin_layout Description
14201 sfheadings sansserif titles,
14204 \begin_layout Description
14205 authortitle on title page first placed is author next title --- default,
14208 \begin_layout Description
14209 titleauthor on title page first placed is title next author,
14212 \begin_layout Description
14213 withmarginpar reserve place on page for margins.
14217 \begin_layout Section
14221 \begin_layout Standard
14227 \begin_layout Standard
14228 Elsevier Science Publishers B.V.
14229 provides a standard LaTeX document class (
14233 ) for submitting articles to their various journals.
14234 The style file can be downloaded directly from their web site:
14235 \begin_inset Flex URL
14238 \begin_layout Plain Layout
14240 http://authors.elsevier.com/
14246 Instructions are supplied along with the class file, which details the
14247 requirements of the publishers.
14248 LyX includes package that allows for the use of this class, by a layout
14249 and a template file.
14250 Installation of the class file is the same as for any other LaTeX package;
14251 instructions are provided in the Elsevier documentation.
14254 \begin_layout Standard
14264 As the Elsevier class file is based mainly on the standard article class,
14265 most of the normal functionality is provided.
14266 The Elsevier class defines a number of mathematical environments, which
14267 are similar to the AMS environments.
14268 These commands are all described in the Elsevier documentation, and are
14272 \begin_layout Standard
14273 The easiest way to use the Elsevier style is to base documents on the included
14275 It is best not to use options such as fancy headings or the geometry package,
14276 as elements such as these are defined by Elsevier in their style file.
14277 Ideally, no extra packages except those mentioned in the Elsevier documentation
14279 Essentially, Elsevier require as
14280 \begin_inset Quotes eld
14284 \begin_inset Quotes erd
14287 a LaTeX file as possible, as their intention is to take the supplied file
14288 and replace the class file with one for the particular journal to which
14289 the paper has been submitted.
14290 This also means that not too much time should be spent on the formating
14292 When it comes to be published, this will change anyway.
14293 The rest of the usage for this layout is substantially the same as for
14294 the normal article class.
14295 For details of what Elsevier do and don't allow, refer to their documentation.
14298 \begin_layout Section
14302 \begin_layout Standard
14305 Jürgen Spitzmüller
14308 \begin_layout Subsection
14312 \begin_layout Standard
14313 Memoir is a very powerful and constantly evolving class.
14314 It has been designed with regard to fictional and non-fictional literature.
14315 Its aim is to let the user have maximum control over the typesetting of
14317 Memoir is based on the standard book class, but it can also emulate the
14318 article class (see below).
14321 \begin_layout Standard
14322 Peter Wilson, the developer of Memoir, is known as the author of lots of
14323 useful packages in the LaTeX world.
14324 Most of them have been merged with Memoir.
14325 Therefore, it is much easier to layout the table of contents, appendices,
14326 chapter designs and such.
14327 LyX, though, does not support all of these goodies natively.
14328 Some of them might be added to forthcoming releases
14332 \begin_layout Plain Layout
14333 You are invited to send suggestions to
14334 \begin_inset Flex URL
14337 \begin_layout Plain Layout
14339 lyx-devel@lists.lyx.org
14349 , lots will probably never, due to the limitations of LyX's framework.
14350 Of course you can still use all features with the help of some native LaTeX
14355 \begin_layout Plain Layout
14360 \begin_layout Plain Layout
14370 \begin_inset space ~
14374 \begin_inset CommandInset ref
14376 reference "sec:Inserting-TeX-Code"
14386 In this section, we can only list those features which are natively supported
14388 For detailed descriptions (and for the rest of features) we are recommending
14389 to have a look at the detailed manual of the Memoir class
14393 \begin_layout Plain Layout
14398 \begin_layout Plain Layout
14408 \begin_inset Flex URL
14411 \begin_layout Plain Layout
14413 CTAN:/macros/latex/memoir/memman.pdf
14423 , which is not only a user guide for the class, but also both a comprehensive
14424 description on good typesetting and a superb example for good typesetting
14428 \begin_layout Subsection
14429 Basic features and restrictions
14432 \begin_layout Standard
14433 Memoir supports basically all features of the standard book classes.
14434 There are, however, some differences, as follows:
14437 \begin_layout Description
14439 \begin_inset space ~
14442 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14445 \begin_layout Description
14447 \begin_inset space ~
14450 style: The fancy page style is not supported, due to a command clash between
14451 Memoir and the fancyhdr package (they are both defining a command with
14452 the same name, which confuses LaTeX).
14453 Instead, Memoir comes with a bunch of own page styles (see
14455 Layout\SpecialChar \menuseparator
14456 Document\SpecialChar \menuseparator
14458 \begin_inset space ~
14464 If you want to use these for the chapter pages, you have to use the command
14471 in the main text or in preamble (e.
14472 \begin_inset space \thinspace{}
14476 \begin_inset space ~
14483 chapterstyle{companion}
14488 \begin_layout Description
14489 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14490 an optional argument in the standard classes.
14491 With this, you can specify an alternative version of the title for the
14492 table of contents and the headers (for instance, if the title is too long).
14493 In LyX, you can do this via
14495 Insert\SpecialChar \menuseparator
14497 \begin_inset space ~
14502 at the beginning of a chapter/section.
14503 Memoir features a second optional argument and thus separates the table
14504 of contents from the header.
14505 You can define three variants of a title with this: one for the main text,
14506 one for the table of contents, and one for the headers.
14507 Simply insert two optional arguments if you need this feature, the first
14508 one containing the short title for the Table of Contents, the second one
14509 containing an alternative short title for the headers.
14512 \begin_layout Description
14513 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14514 of contents, the list of figures and the list of table start a new page
14516 Memoir does not follow this route.
14517 You have to insert a page break yourself, if you want to have one.
14520 \begin_layout Description
14521 Titlepage: For some unknown reason, Memoir uses pagination on the title
14522 page (in the standard classes, title pages are
14523 \begin_inset Quotes eld
14527 \begin_inset Quotes erd
14531 \begin_inset space \thinspace{}
14535 \begin_inset space ~
14539 If you want an empty title page, type
14543 aliaspagestyle{title}{empty}
14548 \begin_layout Description
14549 Article: With the class option
14555 Layout\SpecialChar \menuseparator
14556 Document\SpecialChar \menuseparator
14558 \begin_inset space ~
14563 ), you can emulate article style.
14564 That is, counters (footnotes, figures, tables etc.) will not be reset on
14565 new chapters, chapters don't start a new page (but are---in contrary to
14567 \begin_inset Quotes eld
14571 \begin_inset Quotes erd
14574 article classes---still allowed), parts, though, use their own page, as
14578 \begin_layout Description
14579 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14580 font commands, which have been used in the old LaTeX version 2.09 (e.
14581 \begin_inset space \thinspace{}
14585 \begin_inset space ~
14601 It produces an error and stops LaTeX whenever such a command appears.
14606 reallows the commands and spits out warnings instead (which does at least
14608 Since a lot of packages and particularly BibTeX style files are still using
14609 those commands, we have decided to use this option by default.
14612 \begin_layout Subsection
14616 \begin_layout Standard
14617 We will only describe the features supported by LyX (which is not much currently
14619 Please consult the Memoir manual
14623 \begin_layout Plain Layout
14628 \begin_layout Plain Layout
14638 \begin_inset Flex URL
14641 \begin_layout Plain Layout
14643 CTAN:/macros/latex/memoir/memman.pdf
14656 \begin_layout Description
14657 Abstract: You may wonder why an abstract is an extra feature.
14658 Well, it is in book class.
14659 Usually books don't have abstracts.
14660 Memoir, however, has.
14661 You can use it wherever and how often you like.
14664 \begin_layout Description
14665 Chapterprecis: You may know this from belletristic: The contents of a chapter
14666 is shortly described below the title and also in the table of contents
14668 \begin_inset space \thinspace{}
14672 \begin_inset space ~
14677 Our hero arrives in Troia; he loses some friends; he finds others
14680 Chapterprecis does exactly this.
14681 It is therefore only sensible below a chapter.
14684 \begin_layout Description
14685 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14686 The epigraph environment provides an elegant way of typesetting such a
14688 The motto itself (text) and its author (source) are divided by a short
14690 Unfortunately, we have to fool LyX a bit here again, since the environment
14691 needs two arguments (text and source).
14692 In this case, we have to use curly brackets (in TeX mode) between the two
14703 <author of the slogan>.
14706 \begin_layout Description
14707 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14708 complex figurative poems).
14709 LyX can only support a few of them.
14710 One is poemtitle, which is a centered title for poems, which will also
14711 be added to the table of contents (verse is the standard environment for
14713 Memoir has some enhanced versions of verse, but you need to use ERT, because
14714 they have to be nested inside regular verse environments, which is not
14715 possible with LyX).
14718 \begin_layout Description
14719 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14722 \begin_layout Chapter
14723 LyX Features needing Extra Software
14726 \begin_layout Section
14730 \begin_layout Standard
14736 \begin_layout Subsection
14740 \begin_layout Standard
14741 When you to have the
14745 program installed, you'll find in the
14752 \begin_inset space ~
14763 \begin_inset CommandInset href
14765 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14772 \begin_layout Standard
14777 package is a program that was written by
14782 in frustration because some constructs in LaTeX are sometimes non-intuitive,
14783 and easy to forget.
14784 The program runs over your LaTeX file and checks the integrity of the file,
14785 and flags some common errors.
14786 In other technical words, it is
14793 \begin_layout Standard
14794 Well, what is a syntax checker doing in LyX which is supposed to produce
14795 correct LaTeX anyways? The answer is simple: Just as
14799 not only checks the
14803 of C programs, but also does
14807 checks for type-errors,
14811 catches some common
14815 errors, in addition to the syntactical ones.
14820 is capable of detecting several common errors, such as
14823 \begin_layout Itemize
14824 Ellipsis detection:
14825 \begin_inset Newline newline
14828 Use \SpecialChar \ldots{}
14832 \begin_layout Itemize
14833 No space in front of/after parenthesis:
14834 \begin_inset Newline newline
14840 \begin_layout Itemize
14841 Enforcement of normal space after common abbreviations:
14842 \begin_inset Newline newline
14847 is too wide spacing.
14850 \begin_layout Itemize
14851 Enforcement of end-of-sentence space when the last sentence ends with a
14853 \begin_inset Newline newline
14857 And this is wrong spacing.
14860 \begin_layout Itemize
14861 Space in front of labels and similar commands:
14862 \begin_inset Newline newline
14865 The label should stick right up to the text to avoid falling to a wrong
14868 \begin_inset CommandInset label
14878 \begin_layout Plain Layout
14879 This footnote is in danger of falling off to a wrong page
14884 The label is separated too much.
14887 \begin_layout Itemize
14888 Space in front of references, instead of hard spaces:
14889 \begin_inset Newline newline
14892 In you are in bad luck, the text will break right between the referenced
14893 text and reference number, and that's a pity.
14895 \begin_inset CommandInset ref
14897 reference "sec:chktex"
14904 \begin_layout Itemize
14906 \begin_inset Quotes eld
14910 \begin_inset Quotes erd
14914 \begin_inset Formula $\times$
14918 \begin_inset Newline newline
14921 2x2 looks cheap compared to
14922 \begin_inset Formula $2\times2$
14928 \begin_layout Standard
14929 and more \SpecialChar \ldots{}
14930 It is an invaluable tool when you are
14931 \begin_inset Quotes eld
14935 \begin_inset Quotes erd
14938 your document before printing, and you should run it right after the obligatory
14939 spelling check, and before you go fine tuning the typesetting.
14942 \begin_layout Subsection
14946 \begin_layout Standard
14947 If you have the program installed, usage is as simple as choosing
14952 ools\SpecialChar \menuseparator
14958 \begin_inset space ~
14964 This will make LyX generate a LaTeX file of your document, start
14968 to check it, and then make LyX insert
14969 \begin_inset Quotes eld
14973 \begin_inset Quotes erd
14976 with the warnings from
14980 , if there were any.
14981 The warnings will be placed close to the point of the mistake, and you
14982 can quickly find them by using the
14987 avigate\SpecialChar \menuseparator
14994 menu item, or the shortcut key
15003 Open the error boxes by clicking on them with the mouse, or use the shortcut
15012 bindings, or the corresponding
15021 Read the warning and correct the mistake, if it is a mistake.
15022 If you have trouble understanding what the warning is about, you can safely
15024 Remember that there is a hidden layer between the document on screen and
15025 the technical details in invoking
15029 , and this gap can make some warnings seem arcane or just right down plain
15033 \begin_layout Standard
15034 This document is an excellent testing bed for the feature, and it should
15035 provide quite a few warnings for you to fiddle with.
15036 Since computers are only so smart, expect most of the warnings to be false
15040 \begin_layout Subsection
15041 How to fine tune it
15044 \begin_layout Standard
15045 Sometimes, you'll find that
15049 makes more noise than suits your mood.
15050 Then you can choose not to use it, wait until your mood changes, or try
15055 to get better along with you.
15056 Another choice in the most desperate situations is to use
15061 iew\SpecialChar \menuseparator
15067 \begin_inset space ~
15071 \begin_inset space ~
15075 \begin_inset space ~
15080 , which will get rid of all warnings instantly.
15083 \begin_layout Standard
15092 very configurable and extensible, you shouldn't expect to solve all problems
15098 Since LyX has to generate a somewhat special LaTeX file to be able to match
15099 the line numbers from the
15107 \begin_layout Plain Layout
15108 You can inspect the specific output from
15114 Edit\SpecialChar \menuseparator
15116 \begin_inset space ~
15120 \begin_inset space ~
15134 to the internal document structure, some of the warnings will not seen
15135 to appear correctly.
15136 There are two things you can do about this:
15139 \begin_layout Itemize
15144 invocation command line in
15160 installation configuration file (usually with the file
15165 See below to learn what warnings can be enabled and disabled on the command
15170 \begin_layout Itemize
15171 Export your document as a raw LaTeX file using
15176 ile\SpecialChar \menuseparator
15181 xport\SpecialChar \menuseparator
15193 Invoked in this way, it can be a hassle to find the corresponding place
15194 in the document inside LyX, but with a little patience, you should be able
15198 \begin_layout Standard
15199 Here follows the warning messages that can be enabled and disabled in
15208 to disable a warning, and
15212 to enable a warning.
15213 The emphasized entries are disabled by default, because the default is
15216 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15221 \begin_layout Standard
15222 Notice that you should only use the options that enable and disable warnings,
15223 because LyX relies on some of the other command line parameters to be set
15224 in a specific way to have a chance to communicate with
15231 \begin_layout Enumerate
15235 Command terminated with space.
15238 \begin_layout Enumerate
15241 Non-breaking space (
15242 \begin_inset Quotes eld
15250 \begin_inset Quotes erd
15253 ) should have been used.
15256 \begin_layout Enumerate
15260 You should enclose the previous parenthesis with
15261 \begin_inset Quotes eld
15269 \begin_inset Quotes erd
15275 \begin_layout Enumerate
15278 Italic correction (
15279 \begin_inset Quotes eld
15289 \begin_inset Quotes erd
15292 ) found in non-italic buffer.
15295 \begin_layout Enumerate
15298 Italic correction (
15299 \begin_inset Quotes eld
15309 \begin_inset Quotes erd
15312 ) found more than once.
15315 \begin_layout Enumerate
15319 No italic correction (
15320 \begin_inset Quotes eld
15330 \begin_inset Quotes erd
15336 \begin_layout Enumerate
15340 \begin_inset Quotes eld
15348 \begin_inset Quotes erd
15352 \begin_inset Quotes eld
15360 \begin_inset Quotes erd
15366 \begin_layout Enumerate
15369 Wrong length of dash may have been used.
15372 \begin_layout Enumerate
15376 \begin_inset Quotes eld
15384 \begin_inset Quotes erd
15388 \begin_inset Quotes eld
15396 \begin_inset Quotes erd
15402 \begin_layout Enumerate
15406 \begin_inset Quotes eld
15414 \begin_inset Quotes erd
15420 \begin_layout Enumerate
15424 \begin_inset Quotes eld
15432 \begin_inset Quotes erd
15435 to achieve an ellipsis.
15438 \begin_layout Enumerate
15441 Inter-word spacing (
15442 \begin_inset Quotes eld
15452 \begin_inset Quotes eld
15455 ) should perhaps be used.
15458 \begin_layout Enumerate
15461 Inter-sentence spacing (
15462 \begin_inset Quotes eld
15472 \begin_inset Quotes erd
15475 ) should perhaps be used.
15478 \begin_layout Enumerate
15481 Could not find argument for command.
15484 \begin_layout Enumerate
15488 \begin_inset Quotes eld
15496 \begin_inset Quotes erd
15502 \begin_layout Enumerate
15505 Math mode still on at end of LaTeX file.
15508 \begin_layout Enumerate
15512 \begin_inset Quotes eld
15520 \begin_inset Quotes erd
15523 doesn't match the number of
15524 \begin_inset Quotes eld
15532 \begin_inset Quotes erd
15538 \begin_layout Enumerate
15541 You should use either
15544 \begin_inset Quotes eld
15552 \begin_inset Quotes erd
15557 as an alternative to
15558 \begin_inset Quotes eld
15566 \begin_inset Quotes erd
15572 \begin_layout Enumerate
15579 " (ASCII 39) instead of "
15586 \begin_layout Enumerate
15589 User-specified pattern found.
15592 \begin_layout Enumerate
15595 This command might not be intended.
15598 \begin_layout Enumerate
15605 \begin_layout Enumerate
15623 \begin_layout Enumerate
15626 Delete this space to maintain correct page references.
15629 \begin_layout Enumerate
15633 You might wish to put this between a pair of
15634 \begin_inset Quotes eld
15642 \begin_inset Quotes erd
15648 \begin_layout Enumerate
15651 You ought to remove spaces in front of punctuation.
15654 \begin_layout Enumerate
15657 Could not execute LaTeX command.
15660 \begin_layout Enumerate
15669 in front of small punctuation.
15672 \begin_layout Enumerate
15680 may look prettier here.
15683 \begin_layout Enumerate
15687 Multiple spaces detected in output.
15690 \begin_layout Enumerate
15693 This text may be ignored.
15696 \begin_layout Enumerate
15702 \begin_inset Quotes eld
15707 to begin quotation, not
15714 \begin_layout Enumerate
15721 to end quotation, not
15724 \begin_inset Quotes eld
15732 \begin_layout Enumerate
15738 \begin_layout Enumerate
15741 You should perhaps use
15742 \begin_inset Quotes eld
15750 \begin_inset Quotes erd
15756 \begin_layout Enumerate
15759 You should put a space in front of/after parenthesis.
15762 \begin_layout Enumerate
15765 You should avoid spaces in front of/after parenthesis.
15768 \begin_layout Enumerate
15772 You should not use punctuation in front of/after quotes.
15775 \begin_layout Enumerate
15778 Double space found.
15781 \begin_layout Enumerate
15784 You should put punctuation outside inner/inside display math mode.
15787 \begin_layout Enumerate
15790 You ought to not use primitive TeX in LaTeX code.
15793 \begin_layout Enumerate
15796 You should remove spaces in front of
15797 \begin_inset Quotes eld
15805 \begin_inset Quotes erd
15811 \begin_layout Enumerate
15814 \begin_inset Quotes eld
15822 \begin_inset Quotes erd
15825 is normally not followed by
15826 \begin_inset Quotes eld
15834 \begin_inset Quotes erd
15840 \begin_layout Standard
15841 In later versions of LyX, we hope to provide a more complete interface to
15842 this tool (and it's smaller cousin
15846 ) to exploit the full power of it.
15847 But it's not exactly useless as it is now: go try it on one of your existing
15848 documents of a certain length and be surprised.
15851 \begin_layout Section
15852 Version Control in LyX
15855 \begin_layout Standard
15858 Lars Gullik Bjønnes,
15865 \begin_layout Subsection
15869 \begin_layout Standard
15870 A friend of mine wanted to try LyX for a group project.
15871 When he didn't find support for version control or file locking, he dropped
15873 This angered me a bit, so I thought that I should at least make support
15874 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
15875 This has now been done.
15876 LyX now supports some of the most basic RCS commands.
15877 If you need to something a bit more sophisticated you will have to do that
15878 manually in an xterm.
15881 \begin_layout Standard
15882 Before you begin to use the version control features in LyX, you should
15884 \begin_inset Quotes eld
15888 \begin_inset Quotes erd
15891 (a man file, read it with
15896 This file describes all the basic features of RCS.
15897 You should especially notice the comment about a RCS directory, and the
15898 notion of a master RCS file (the file ending in
15905 \begin_layout Standard
15906 Later basic CVS/SVN support was added.
15907 You should be familiar with CVS/SVN usage before start using it under LyX.
15908 Most of the log messages are not currently displayed after operations -
15909 you can check them in terminal window if unsure.
15912 \begin_layout Standard
15913 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
15914 package---no guarantees are made for older versions.
15917 \begin_layout Subsection
15918 RCS commands in LyX
15921 \begin_layout Standard
15922 The following sections describe the RCS commands supported by LyX.
15923 You can find them in the
15928 ile\SpecialChar \menuseparator
15934 \begin_inset space ~
15942 \begin_layout Subsubsection
15948 \begin_layout Standard
15949 If your document is not under revision control, this is the only item shown
15951 And if it is under revision control, the
15958 item is not visible.
15962 \begin_layout Standard
15963 This command registers your document with RCS (unless you are under the
15964 directory managed by CVS)\SpecialChar \@.
15965 You are asked interactively to supply an initial
15966 description of the document.
15967 The document is now set in Read-Only mode and you have to
15970 \begin_inset space ~
15974 \begin_inset space ~
15978 \begin_inset space ~
15983 , before making any changes to it.
15984 A document under revision control has a
15985 \begin_inset Quotes eld
15988 [RCS:<version> <locker>]
15989 \begin_inset Quotes erd
15992 item tagged to the filename in the minibuffer.
15995 \begin_layout Standard
15996 RCS command that is run:
15998 ci -q -u -i -t-"<initial description>" <file-name>
16001 \begin_layout Standard
16006 to understand the switches.
16010 \begin_layout Subsubsection
16016 \begin_layout Standard
16017 When you are finished editing a file, you check in your changes.
16018 When you do this, you are asked for a description of the changes.
16019 This is stored in the history log.
16020 The version number is bumped, your changes are applied to the master RCS
16021 file, the document is unlocked and set to Read-Only mode.
16025 \begin_layout Standard
16028 ci -q -u -m"<description>" <file-name>
16031 \begin_layout Subsubsection
16037 \begin_layout Standard
16038 By doing this you lock the document so that only you can edit it.
16039 This will also make the document Read-Write only for you.
16040 You will usually continue editing for a while and when you are finished
16041 you check in your changes.
16042 The status line is changed to reflect that you have locked the file.
16046 \begin_layout Standard
16049 co -q -l <file-name>
16052 \begin_layout Subsubsection
16055 Revert To Repository Version
16058 \begin_layout Standard
16059 This will discard all changes made to the document since the last check
16061 You get a warning before changes are discarded.
16064 \begin_layout Standard
16067 co -f -u<version> <file-name>
16070 \begin_layout Subsubsection
16076 \begin_layout Standard
16077 This makes as if the last check in never happened.
16078 No changes are made to the document loaded into LyX, but the last version
16079 is removed from the master RCS file.
16083 \begin_layout Standard
16086 rcs -o<version> <file-name>
16089 \begin_layout Subsubsection
16095 \begin_layout Standard
16096 This show the complete history of the RCS document.
16101 is shown in a browser.
16109 \begin_layout Subsection
16110 CVS commands in LyX
16113 \begin_layout Standard
16114 CVS is now partially supported by LyX.
16115 You can find the commands in the
16120 ile\SpecialChar \menuseparator
16126 \begin_inset space ~
16134 \begin_layout Subsubsection
16140 \begin_layout Standard
16141 If your document is not under revision control, this is the only item shown
16143 And if it is under revision control, the
16150 item is not visible.
16154 \begin_layout Standard
16155 This command registers in CVS your document ONLY in case you have already
16156 the documents directory under CVS control (in particular
16161 This means you have to checkout the archive by yourself.
16165 \begin_layout Standard
16166 Then you are asked interactively to supply an initial description of the
16168 Don't forget that registered file is not yet commited.
16171 \begin_layout Standard
16172 CVS command that is run:
16175 \begin_inset Quotes erd
16179 \begin_inset Quotes eld
16183 \begin_inset Quotes erd
16189 \begin_layout Standard
16194 to understand the switches.
16198 \begin_layout Subsubsection
16204 \begin_layout Standard
16205 When you are finished editing a file, you commit your changes.
16206 When you do this, you are asked for a description of the changes.
16207 After that changes are commited.
16210 \begin_layout Standard
16213 cvs -q commit -m"<description>" <file-name>
16216 \begin_layout Subsubsection
16219 Revert To Repository Version
16222 \begin_layout Standard
16223 This will discard all changes made to the document since the last check
16225 You get a warning before changes are discarded.
16226 Firstly the file is deleted, secondly CVS update command is run.
16229 \begin_layout Standard
16233 \begin_inset Quotes eld
16237 \begin_inset Quotes erd
16243 \begin_layout Subsubsection
16249 \begin_layout Standard
16250 This show the complete history of the CVS document.
16254 \begin_inset Quotes eld
16258 \begin_inset Quotes erd
16263 is shown in a browser.
16266 \begin_layout Subsection
16267 SVN commands in LyX
16270 \begin_layout Standard
16271 SVN is now partially supported by LyX.
16272 You can find the commands in the
16277 ile\SpecialChar \menuseparator
16283 \begin_inset space ~
16289 Please note that if you use password protected access to repository via
16290 ssh, you will be asked in terminal window.
16293 \begin_layout Subsubsection
16299 \begin_layout Standard
16300 If your document is not under revision control, this is the only item shown
16302 And if it is under revision control, the
16309 item is not visible.
16313 \begin_layout Standard
16314 This command registers in SVN your document ONLY in case you have already
16315 the documents directory under SVN control (in particular
16320 This means you have to checkout the archive by yourself.
16324 \begin_layout Standard
16325 Then you are asked interactively to supply an initial description of the
16327 Don't forget that registered file is not yet commited.
16330 \begin_layout Standard
16331 SVN command that is run:
16334 \begin_inset Quotes eld
16338 \begin_inset Quotes erd
16344 \begin_layout Standard
16349 to understand the switches.
16353 \begin_layout Subsubsection
16359 \begin_layout Standard
16360 When you are finished editing a file, you commit your changes.
16361 When you do this, you are asked for a description of the changes.
16362 After that changes are commited.
16365 \begin_layout Standard
16368 svn commit -q -m"<description>" <file-name>
16371 \begin_layout Subsubsection
16377 \begin_layout Standard
16378 Updates the changes of this file from the repository.
16379 Be sure you understand SVN merging and conflicts resolving before using
16380 this function, because all conflicts has to be done manually by you!
16383 \begin_layout Standard
16387 \begin_inset Quotes eld
16391 \begin_inset Quotes erd
16397 \begin_layout Subsubsection
16400 Revert To Repository Version
16403 \begin_layout Standard
16404 This will discard all changes made to the document since the last check
16406 You get a warning before changes are discarded.
16410 \begin_layout Standard
16414 \begin_inset Quotes eld
16418 \begin_inset Quotes erd
16424 \begin_layout Subsubsection
16430 \begin_layout Standard
16431 This show the complete history of the SVN document.
16435 \begin_inset Quotes eld
16439 \begin_inset Quotes erd
16444 is shown in a browser.
16447 \begin_layout Section
16448 Literate Programming
16451 \begin_layout Standard
16456 (kayvan@sylvan.com)
16460 original documentation written by
16462 Edmar Wienskoski Jr.
16465 (edmar-w-jr@technologist.com)
16468 \begin_layout Subsection
16472 \begin_layout Standard
16473 The main purpose of this documentation is to show you how to use LyX for
16474 literate programming.
16475 Where it is assumed that you are familiar with this programming technique,
16477 \begin_inset Quotes eld
16481 \begin_inset Quotes erd
16485 \begin_inset Quotes eld
16489 \begin_inset Quotes erd
16493 If that is not the case, please follow the web links provided in the following
16495 There is a lot of good documentation out there covering old development
16496 history to the latest tools tips.
16499 \begin_layout Standard
16500 It is also assumed that you are familiar with LyX itself to a point that
16501 you are comfortable changing your LyX preferences, and X resources file.
16502 If that is not the case please refer to other LyX documentation to cover
16503 your specific needs.
16506 \begin_layout Subsection
16507 Literate Programming
16510 \begin_layout Standard
16511 From the Literate Programming FAQ:
16514 \begin_layout Quotation
16515 Literate programming is the combination of documentation and source together
16516 in a fashion suited for reading by human beings.
16517 In fact, literate programs should be enjoyable reading, even inviting!
16518 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16519 and documentation in a single file.
16520 Literate programming tools then parse the file to produce either readable
16521 documentation or compilable source.
16522 The WEB style of literate programming was created by D.E.
16523 Knuth during the development of his TeX typesetting software.
16527 \begin_layout Standard
16528 Another excerpt says:
16531 \begin_layout Quotation
16534 How is literate programming different from verbose commenting?
16537 \begin_layout Quotation
16538 There are three distinguishing characteristics.
16539 In order of importance, they are:
16543 \begin_layout Itemize
16544 flexible order of elaboration
16547 \begin_layout Itemize
16548 automatic support for browsing
16551 \begin_layout Itemize
16552 typeset documentation, especially diagrams and mathematics
16556 \begin_layout Standard
16557 Now that I sparked your curiosity, take a look in the references.
16560 \begin_layout Subsubsection
16564 \begin_layout Standard
16565 The complete Literate Programming FAQ can be found at:
16568 \begin_layout Quote
16569 Literate Programming FAQ
16570 \begin_inset Flex URL
16573 \begin_layout Plain Layout
16575 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16583 \begin_layout Standard
16584 The FAQ lists 23 (twenty three!) different literate programming tools.
16585 Where some are specialized or
16586 \begin_inset Quotes eld
16590 \begin_inset Quotes erd
16593 for particular programming languages, while other have general scope.
16598 for my own use for several reasons:
16601 \begin_layout Itemize
16602 It can generate the documentation either in LaTeX or HTML.
16605 \begin_layout Itemize
16606 It has a open architecture, i.e., it is easy to plug in new filters and to
16607 perform special processing that you may need.
16611 \begin_layout Itemize
16612 There is a good selection of filters available already (the HTML is one
16616 \begin_layout Itemize
16620 \begin_layout Standard
16621 The Noweb web page can be found at:
16624 \begin_layout Quote
16626 \begin_inset Flex URL
16629 \begin_layout Plain Layout
16631 http://www.cs.virginia.edu/~nr/noweb/
16639 \begin_layout Standard
16640 Starting from there you can reach many other interesting links and even
16641 some literate program examples.
16644 \begin_layout Subsection
16645 LyX and Literate Programming
16648 \begin_layout Standard
16649 The LyX support for Literate Programming is provided by using the generic
16650 LyX convertors mechanism.
16651 This support is provided in a
16652 \begin_inset Quotes eld
16656 \begin_inset Quotes erd
16659 way, i.e., you will be able to use this new LyX feature with some other literate
16660 programming tool of your choice by just changing your LyX preferences.
16663 \begin_layout Subsubsection
16664 Generating documents and code (weaving and tangling)
16667 \begin_layout Paragraph
16668 Selecting the document class
16671 \begin_layout Standard
16672 If you have installed Noweb and LyX successfully, whenever you open a new
16673 document or try to change the document class of an existing one, you will
16674 find that there are three new document classes available:
16677 \begin_layout Itemize
16681 \begin_layout Itemize
16685 \begin_layout Itemize
16689 \begin_layout Standard
16690 You must select one of them to create your literate documents from.
16694 \begin_layout Standard
16695 Note that literate documents are not limited to these three classes.
16696 New classes can be generated from other styles like letter or in combination
16697 with other class variations like Article (AMS).
16698 If you have special needs that cannot be covered by one of the existing
16699 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16700 will arrange to insert a new entry, or teach you how to do it.
16704 \begin_layout Plain Layout
16705 It is very simple, it involves the creation of a file with four lines, and
16706 re-running of the auto configuration.
16711 Moreover, if you use a literate tool other than Noweb you may need to create
16712 a new set of document classes for it.
16715 \begin_layout Paragraph
16719 \begin_layout Standard
16720 LyX enables you to write code with a layout named
16728 \begin_layout Plain Layout
16729 The equivalent Noweb term is
16730 \begin_inset Quotes eld
16734 \begin_inset Quotes erd
16738 For historical reasons, I got used to the term
16739 \begin_inset Quotes eld
16743 \begin_inset Quotes erd
16746 introduced by other literate tool named Nuweb, which I used for many years
16747 before rendering myself to Noweb.
16752 Noweb delimits scraps like this:
16755 \begin_layout LyX-Code
16759 \begin_layout LyX-Code
16763 \begin_layout LyX-Code
16767 \begin_layout LyX-Code
16771 \begin_layout LyX-Code
16775 \begin_layout Standard
16776 The problem is that whatever is written in between the << and the
16780 must be taken literally, i.e., LyX should be prevented from making any special
16781 interpretation of what has been written.
16782 This is handled by a special layout named Scrap, that works like a normal
16783 paragraph but has a free spacing capability.
16786 \begin_layout Standard
16787 The down side of the Scrap paragraph layout is that consecutive paragraphs
16788 of code will be spaced with one empty line in the source code and also
16789 in the printed documentation.
16790 The work around is to enter each line of code within a single Scrap, with
16791 a newline (ctrl-return).
16792 The example above will look like this:
16796 \begin_layout Plain Layout
16797 If you have a printed version of this document you will not see any difference
16798 between the previous example and this one.
16806 \begin_layout LyX-Code
16808 \begin_inset Newline newline
16812 \begin_inset Newline newline
16816 \begin_inset Newline newline
16820 \begin_inset Newline newline
16826 \begin_layout Standard
16827 This layout works fine.
16828 The only real inconvenience is that you have to type ctrl-return instead
16833 \begin_layout Plain Layout
16834 It is in my list of
16835 \begin_inset Quotes eld
16839 \begin_inset Quotes erd
16850 \begin_layout Standard
16851 As a special note, you can also use the
16852 \begin_inset Quotes eld
16856 \begin_inset Quotes erd
16859 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16863 \begin_layout LyX-Code
16865 \begin_inset Newline newline
16868 def some_function(args):
16869 \begin_inset Newline newline
16872 "This is the doc string for this function."
16873 \begin_inset Newline newline
16876 print "My args: ", args
16879 \begin_layout LyX-Code
16880 @ %def some_function
16883 \begin_layout Standard
16884 For an example of this usage and the resulting cross-reference output, look
16885 at the Literate python program in
16887 LIBDIR/examples/listerrors.lyx
16889 which should make this all clear.
16892 \begin_layout Paragraph
16893 Generating the documentation
16896 \begin_layout Standard
16897 At this point you already have a new document file with a proper document
16898 class, and with some code and text on it.
16899 How do I print it? The answer is simple, you select
16904 iew\SpecialChar \menuseparator
16912 Just like you would do for a plain document.
16913 No special procedure is required.
16916 \begin_layout Standard
16917 To help orientate you, I will now explain what happens inside LyX:
16920 \begin_layout Enumerate
16923 Update\SpecialChar \menuseparator
16926 menu option is chosen, a LaTeX file is generated.
16931 \begin_layout Standard
16932 If the document is of any literate class the generated file will be named
16933 with an extension name defined by the
16934 \begin_inset Quotes eld
16938 \begin_inset Quotes erd
16941 format (defined in the Preferences panel), otherwise the file will have
16950 \begin_layout Enumerate
16951 Note that the only difference so far is in the name of the file, no special
16952 processing is required by LyX.
16953 Given that you formatted the code using the Scrap layout that, by itself,
16954 takes care of the business.
16957 \begin_layout Enumerate
16958 If the document is of any literate class LyX will then use the internal
16959 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16963 \begin_layout Plain Layout
16964 The converters are defined in the
16966 Tools\SpecialChar \menuseparator
16970 \begin_inset Quotes eld
16974 \begin_inset Quotes erd
16986 manual for general information about converters.
16991 to generate the LaTeX file.
16995 \begin_layout Standard
16996 Otherwise it will just skip this step.
17000 \begin_layout Enumerate
17001 Finally, LaTeX is invoked and the regular post processing continues as in
17005 \begin_layout Standard
17006 Independence from a particular
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17014 is easily achieved by changing the commands that are run by the various
17018 \begin_layout Paragraph
17019 Generating the code
17022 \begin_layout Standard
17023 When the build menu option is chosen or the corresponding button in the
17024 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17025 Next, LyX invokes the
17030 This converter needs to be defined by the user and is not installed by
17031 default, though the Program format is.
17032 This converter (like any other converter) will have two parts:
17035 \begin_layout Enumerate
17036 The converter program itself.
17037 This program performs the conversion from the one format to the other (in
17038 this case, from the Noweb format to the Program pseudo-format).
17041 \begin_layout Enumerate
17042 The error log parser.
17043 This is a program whose sole purpose is to rewrite error messages in a
17044 format that LyX understands.
17045 This makes it possible for LyX to place error boxes in the right places
17046 in the file buffer.
17049 \begin_layout Standard
17050 The first part, the
17051 \begin_inset Quotes eld
17055 \begin_inset Quotes erd
17058 setting, should be set to
17059 \begin_inset Quotes eld
17067 \begin_inset Quotes erd
17071 This basically means that LyX will call
17072 \begin_inset Quotes eld
17076 \begin_inset Quotes erd
17079 (a program or script) with the name of the Noweb file (normally a file
17080 in the LyX temp directory).
17084 \begin_layout Standard
17085 This is an implementation of
17086 \begin_inset Quotes eld
17090 \begin_inset Quotes erd
17093 that you can place in a directory on your path:
17096 \begin_layout LyX-Code
17100 \begin_layout LyX-Code
17104 \begin_layout LyX-Code
17105 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17108 \begin_layout Standard
17109 The next part of the converter setting is the
17110 \begin_inset Quotes eld
17114 \begin_inset Quotes erd
17117 which is to be set to
17118 \begin_inset Quotes eld
17123 parselog=listerrors
17126 \begin_inset Quotes erd
17130 This will run any errors that are generated by the
17131 \begin_inset Quotes eld
17135 \begin_inset Quotes erd
17138 process through the
17139 \begin_inset Quotes eld
17143 \begin_inset Quotes erd
17149 \begin_layout Standard
17150 The converter code looks in
17158 then on the path for the
17159 \begin_inset Quotes eld
17163 \begin_inset Quotes erd
17169 \begin_layout Standard
17170 The build will normally take place in LyX's temporary directory, so the
17171 files produced by the conversion will be in that directory.
17172 LyX will copy out what it regards as the `main' file, but the
17176 conversion may produce several files, and so most of these would then be
17177 deleted when LyX was closed.
17178 The present solution is to use a `copier',
17182 \begin_layout Plain Layout
17191 manual for information on these.
17200 script in its default mode, so that the entire contents of the temporary
17201 directory is copied.
17202 More will get copied than is needed, to be sure, but nothing will be lost.
17203 If, however, you know what extensions the generated files will have, this
17204 can be improved by using the
17213 This option takes a comma-separated list of extensions to copy.
17214 So, for example, if the conversion will generate only files with the extensions
17223 , then the correct definition would be:
17226 \begin_layout LyX-Code
17227 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17230 \begin_layout Standard
17231 The result will be that only files with these two extensions will be copied
17235 \begin_layout Paragraph
17236 Build instructions in the document
17239 \begin_layout Standard
17240 The last piece of the integration between LyX and noweb is the
17241 \begin_inset Quotes eld
17245 \begin_inset Quotes erd
17249 Generally, the instructions for building your program should be embedded
17250 in a scrap of its own.
17252 \begin_inset Quotes eld
17256 \begin_inset Quotes erd
17259 above uses the notangle command to look for this scrap (called
17260 \begin_inset Quotes eld
17264 \begin_inset Quotes erd
17267 ) and runs its contents through
17268 \begin_inset Quotes eld
17272 \begin_inset Quotes erd
17278 \begin_layout Standard
17279 Typically, such a scrap would look something like this:
17282 \begin_layout LyX-Code
17284 \begin_inset Newline newline
17288 \begin_inset Newline newline
17292 \begin_inset Newline newline
17295 if [ -z "${NOWEB_SOURCE}" ]
17296 \begin_inset Newline newline
17300 \begin_inset Newline newline
17303 NOWEB_SOURCE=myfile.nw
17304 \begin_inset Newline newline
17308 \begin_inset Newline newline
17312 code to extract files ...]
17313 \begin_inset Newline newline
17317 code to compile files ...]
17318 \begin_inset Newline newline
17324 \begin_layout Standard
17327 LIBDIR/examples/listerrors.lyx
17331 LIBDIR/examples/Literate.lyx
17333 which implement two versions of the
17334 \begin_inset Quotes eld
17338 \begin_inset Quotes erd
17341 program for some illustrations of how all of these pieces go together or
17344 LIBDIR/examples/noweb2lyx.lyx.
17347 Interestingly, these three files show off the language-indepence of the
17348 LyX literate programming support since they are written in Python, C and
17352 \begin_layout Subsubsection
17356 \begin_layout Standard
17357 All the Literate Programming support is configured by the
17362 ools\SpecialChar \menuseparator
17370 \begin_inset Quotes eld
17374 \begin_inset Quotes erd
17378 The important parts are:
17381 \begin_layout Description
17383 \begin_inset space ~
17387 \begin_inset Quotes eld
17391 \begin_inset Quotes erd
17395 \begin_inset space ~
17398 format Set up via the Formats tab, this is where the Noweb-specific pieces
17408 , the file extension is set to
17413 This tells LyX to create a file with a
17417 extension in the first step of the conversion process.
17420 \begin_layout Description
17422 \begin_inset space ~
17430 \begin_inset space ~
17433 format This is an empty format whose sole purpose is to be the endpoint
17434 of a conversion (which then allows us to set up a converter for it).
17437 \begin_layout Description
17446 This converter performs the
17447 \begin_inset Quotes eld
17451 \begin_inset Quotes erd
17454 of the literate document.
17455 For Noweb, it is set to
17456 \begin_inset Quotes eld
17461 noweave -delay -index $$i > $$o
17464 \begin_inset Quotes erd
17470 \begin_layout Description
17480 \begin_inset Quotes eld
17484 \begin_inset Quotes erd
17488 As stated above, the Converter is set to
17489 \begin_inset Quotes eld
17497 \begin_inset Quotes erd
17500 , with Flags set to
17501 \begin_inset Quotes eld
17506 originaldir,parselog=listerrors
17509 \begin_inset Quotes erd
17515 \begin_layout Subsubsection
17519 \begin_layout Standard
17520 There is also a new function implemented in the LyX server, the
17521 \begin_inset Quotes eld
17524 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17528 \begin_layout Standard
17529 When debugging code with ddd/gdb, it is possible to invoke a text editor
17530 at the current execution position with a single key stroke.
17531 The default ddd configuration for that is shift-ctrl-V.
17532 It happens that you can define the editor command line invocation in ddd
17538 dit\SpecialChar \menuseparator
17543 references\SpecialChar \menuseparator
17550 dialog and changing the "Edit Sources" entry.
17553 \begin_layout Standard
17554 I take advantage of the new created LyX server function and this ddd feature,
17556 \begin_inset Quotes eld
17560 \begin_inset Quotes erd
17566 \begin_layout LyX-Code
17567 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17570 \begin_layout Standard
17571 With this, whenever you are using ddd and find a point in the program that
17572 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17573 ddd you forward this information to LyX through the LyX server and then
17574 the LyX window will show the same file with the cursor at the same position
17575 ddd was pointing to.
17576 No more guessing or long scrolling to locate a point in the program back
17580 \begin_layout Standard
17581 Note however that you must enable the LyX server to get this feature working
17582 (it is disabled by default).
17583 You can enable it in
17595 ) by entering in the
17600 \begin_inset Quotes eld
17605 /home/<your-home-directory>/.lyx/lyxpipe
17608 \begin_inset Quotes erd
17614 \begin_layout Standard
17615 Read the LyX server documentation in the
17617 Customization Manual
17619 for further information.
17622 \begin_layout Subsubsection
17626 \begin_layout Standard
17627 There are six new buttons that can be added to your LyX toolbar.
17628 Five of these buttons are short cuts to layout styles:
17649 The last one is a short cut to the
17650 \begin_inset Quotes eld
17654 \begin_inset Quotes erd
17661 \begin_layout Standard
17662 LyX has a range of buttons that are available for tool bar customization.
17663 In my toolbar I like to combine the six short cuts above with two more:
17671 \SpecialChar \menuseparator
17679 \SpecialChar \menuseparator
17692 iew\SpecialChar \menuseparator
17700 Here is how it looks like:
17703 \begin_layout LyX-Code
17707 \begin_layout LyX-Code
17711 \begin_layout LyX-Code
17712 Icon "layout Standard"
17715 \begin_layout LyX-Code
17716 Icon "layout Section"
17719 \begin_layout LyX-Code
17720 Icon "layout LaTeX"
17723 \begin_layout LyX-Code
17724 Icon "layout LyX-Code"
17727 \begin_layout LyX-Code
17728 Icon "layout Scrap"
17731 \begin_layout LyX-Code
17735 \begin_layout LyX-Code
17739 \begin_layout LyX-Code
17740 Icon "buffer-typeset"
17743 \begin_layout LyX-Code
17744 Icon "build-program"
17747 \begin_layout LyX-Code
17751 \begin_layout LyX-Code
17755 \begin_layout LyX-Code
17759 \begin_layout LyX-Code
17763 \begin_layout LyX-Code
17767 \begin_layout Subsubsection
17768 Colors customization
17771 \begin_layout Standard
17772 There are a number of colors in LyX that can be customized in
17777 One of the things that bothers people is the LaTeX font color.
17778 The default color is red, since the scraps uses LaTeX font, and there is
17779 a lot of scraps in literate documents, you may get tired of seeing everything
17781 You can change it by going to the tabs
17790 \begin_layout Standard
17791 The next thing is the visible presence of the newline character in the screen.
17792 You can choose the color of this particular character and make it blend
17794 I recommend you choosing a color that is close to the background but not
17795 equal, that way you still can see it is there, but it is not bothering
17800 \begin_layout Chapter
17801 Secrets of the LaTeX Masters
17802 \begin_inset CommandInset label
17811 \begin_layout Standard
17812 Though LyX is a powerful tool, it cannot hope to support everything that
17813 can be done with pure TeX/LaTeX.
17814 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17815 as long as you are not afraid to use that
17816 \begin_inset Quotes eld
17820 \begin_inset Quotes erd
17823 button on the toolbar or add things to the LaTeX preamble.
17824 This section lists some tips, tricks, and otherwise cool ideas to give
17825 your document that extra little flair.
17828 Do try this at home
17830 , just start with something a little smaller and less important than your
17834 \begin_layout Standard
17835 Most ideas in this section require less common files in your LaTeX installation.
17836 If you have a system like teTeX, most will already be available.
17837 A few, however, will need to be downloaded from one of the CTAN archives.
17838 Often, there are several ways to do something, or several LaTeX style files
17839 which do the same thing.
17840 We do not endorse one choice over another, we simply claim that we have
17841 done a particular task with a particular file.
17842 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17845 \begin_layout Section
17849 \begin_layout Standard
17852 Lars Gullik Bjønnes
17855 \begin_layout Subsection
17859 \begin_layout Standard
17860 The aim for this chapter
17864 \begin_layout Plain Layout
17865 Editor's note: Lars' original chapter was a masterful description of how
17871 However, it was too long to flow smoothly in this document.
17872 I have therefore chosen to excerpt the most important sections here (sorry,
17873 Lars); you can read the original chapter (and more of the story!) in the
17876 examples/multicol.lyx
17884 is to show how the LaTeX package
17888 can be used in a LyX document.
17889 As LyX doesn't support the
17893 package natively yet, we have to use some small hacks.
17894 By reading this section it should be obvious how to do this.
17897 \begin_layout Subsection
17901 \begin_layout Standard
17906 package allows switching between one and multicolumn format on the same
17908 Footnotes are handled correctly (for the most part), but will be placed
17909 at the bottom of the page and not under each column.
17910 LaTeX's float mechanism, however, is partly disabled in the current implementat
17912 At the moment only page-wide floats can be used within the scope of the
17916 \begin_layout Subsection
17920 \begin_layout Subsubsection
17924 \begin_layout Standard
17925 If you want to have two columns in your text, you have use LaTeX mode to
17930 begin{multicols}{2}
17932 at the point where you want the two column layout to start, and then
17938 where you want it to end.
17942 \begin_layout Standard
17946 \begin_layout Plain Layout
17950 begin{multicols}{2}
17958 \begin_layout Standard
17963 The Adventure of the Empty House
17966 \begin_inset Newline newline
17971 Sir Arthur Conan Doyle
17974 \begin_layout Standard
17977 It was in the spring of the year 1894 that all London was interested, and
17978 the fashionable world dismayed, by the murder of the Honourable Ronald
17979 Adair under most unusual and inexplicable circumstances.
17980 The public has already learned those particulars of the crime which came
17981 out in the police investigation, but a good deal was suppressed upon that
17982 occasion, since the case for the prosecution was so overwhelmingly strong
17983 that it was not necessary to bring forward all the facts.
17984 Only now, at the end of nearly ten years, am I allowed to supply those
17985 missing links which make up the whole of that remarkable chain.
17986 The crime was of interest in itself, but that interest was as nothing to
17987 me compared to the inconceivable sequel, which afforded me the greatest
17988 shock and surprise of any event in my adventurous life.
17989 Even now, after this long interval, I find myself thrilling as I think
17990 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17991 ty which utterly submerged my mind.
17992 Let me say to that public, which has shown some interest in those glimpses
17993 which I have occasionally given them of the thoughts and actions of a very
17994 remarkable man, that they are not to blame me if I have not shared my knowledge
17995 with them, for I should have considered it my first duty to do so, had
17996 I not been barred by a positive prohibition from his own lips, which was
17997 only withdrawn upon the third of last month.
18000 \begin_layout Standard
18004 \begin_layout Plain Layout
18016 \begin_layout Subsubsection
18020 \begin_layout Standard
18021 The same pattern is used when you want more than two columns:
18024 \begin_layout Standard
18028 \begin_layout Plain Layout
18032 begin{multicols}{3}
18040 \begin_layout Standard
18043 It can be imagined that my close intimacy with Sherlock Holmes had interested
18044 me deeply in crime, and that after his disappearance I never failed to
18045 read with care the various problems which came before the public.
18046 And I even attempted, more than once, for my own private satisfaction,
18047 to employ his methods in their solution, though with indifferent success.
18048 There was none, however, which appealed to me like this tragedy of Ronald
18050 As I read the evidence at the inquest, which led up to a verdict of willful
18051 murder against some person or persons unknown, I realized more clearly
18052 than I had ever done the loss which the community had sustained by the
18053 death of Sherlock Holmes.
18054 There were points about this strange business which would, I was sure,
18055 have specially appealed to him, and the efforts of the police would have
18056 been supplemented, or more probably anticipated, by the trained observation
18057 and the alert mind of the first criminal agent in Europe.
18058 All day, as I drove upon my round, I turned over the case in my mind and
18059 found no explanation which appeared to me to be adequate.
18060 At the risk of telling a twice-told tale, I will recapitulate the facts
18061 as they were known to the public at the conclusion of the inquest.
18064 \begin_layout Standard
18068 \begin_layout Plain Layout
18080 \begin_layout Standard
18081 You can have more than 3 columns if you want to, but that might not be very
18082 pleasant for the eye.
18085 \begin_layout Subsubsection
18086 Columns inside columns
18089 \begin_layout Standard
18090 You can even have columns inside columns:
18093 \begin_layout Standard
18097 \begin_layout Plain Layout
18101 begin{multicols}{2}
18109 \begin_layout Standard
18112 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18113 at that time governor of one of the Australian colonies.
18114 Adair's mother had returned from Australia to undergo the operation for
18115 cataract, and she, her son Ronald, and her daughter Hilda were living together
18119 \begin_layout Standard
18123 \begin_layout Plain Layout
18127 begin{multicols}{2}
18135 \begin_layout Standard
18138 The youth moved in the best society--had, so far as was known, no enemies
18139 and no particular vices.
18140 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18141 had been broken off by mutual consent some months before, and there was
18142 no sign that it had left any very profound feeling behind it.
18143 For the rest {sic} the man's life moved in a narrow and conventional circle,
18144 for his habits were quiet and his nature unemotional.
18145 Yet it was upon this easy-going young aristocrat that death came, in most
18146 strange and unexpected form, between the hours of ten and eleven-twenty
18147 on the night of March 30, 1894.
18150 \begin_layout Standard
18154 \begin_layout Plain Layout
18166 \begin_layout Standard
18169 Ronald Adair was fond of cards--playing continually, but never for such
18170 stakes as would hurt him.
18171 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18172 It was shown that, after dinner on the day of his death, he had played
18173 a rubber of whist at the latter club.
18174 He had also played there in the afternoon.
18179 The evidence of those who had played with him-- Mr.
18180 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18181 and that there was a fairly equal fall of the cards.
18182 Adair might have lost five pounds, but not more.
18183 His fortune was a considerable one, and such a loss could not in any way
18185 He had played nearly every day at one club or other, but he was a cautious
18186 player, and usually rose a winner.
18187 It came out in evidence that, in partnership with Colonel Moran, he had
18188 actually won as much as four hundred and twenty pounds in a sitting, some
18189 weeks before, from Godfrey Milner and Lord Balmoral.
18190 So much for his recent history as it came out at the inquest.
18193 \begin_layout Standard
18197 \begin_layout Plain Layout
18209 \begin_layout Standard
18210 Please do read the file
18212 examples/multicol.lyx
18214 for more advanced examples including column and header spacing, vertical
18215 separator lines, and more.
18218 \begin_layout Section
18223 Paragraph Environment
18224 \begin_inset OptArg
18227 \begin_layout Plain Layout
18228 Numbering in Enumerate
18236 \begin_layout Standard
18242 \begin_layout Standard
18243 \begin_inset VSpace bigskip
18249 \begin_layout Standard
18251 The default numbering for the
18255 paragraph environment begins with Arabic numbers and ends with uppercase
18257 Suppose, however, you wanted a different type of numbering scheme.
18258 Here's a quickie example of how to change the numbering scheme:
18261 \begin_layout LyX-Code
18271 \begin_layout LyX-Code
18281 \begin_layout LyX-Code
18291 \begin_layout LyX-Code
18301 \begin_layout Standard
18302 \SpecialChar \ldots{}
18303 which changes the numbering scheme to uppercase Roman numerals, uppercase
18304 letters, Arabic numbers, and lowercase letter.
18307 \begin_layout Standard
18308 Additionally, the previous example also adds a little bit extra to the numbering
18310 For example, the first level label actually looks like:
18311 \begin_inset Quotes eld
18315 \begin_inset Quotes erd
18319 For ease of reading, we'll describe what the numbering schemes look like
18320 using a notation something like this: <
18321 \begin_inset Quotes eld
18325 \begin_inset Quotes erd
18329 \begin_inset space ~
18333 \begin_inset Quotes erd
18337 \begin_inset Quotes erd
18341 \begin_inset space ~
18345 \begin_inset Quotes erd
18349 \begin_inset Quotes erd
18353 \begin_inset space ~
18357 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18368 \begin_layout Standard
18369 As you can see in the example, there is a label command for each nesting
18376 \SpecialChar \ldots{}
18383 , as well as a counter,
18387 \SpecialChar \ldots{}
18393 There are also five
18394 \begin_inset Quotes eld
18398 \begin_inset Quotes erd
18431 , each of which take one counter as an argument.
18432 You can add characters before or after these, but there's no need to add
18436 \begin_layout Standard
18437 You can get really fancy with these.
18441 \begin_layout LyX-Code
18455 \begin_layout LyX-Code
18467 \begin_layout LyX-Code
18477 \begin_layout LyX-Code
18487 \begin_layout Standard
18488 produces the somewhat out of hand numbering scheme: <
18489 \begin_inset Quotes eld
18493 \begin_inset Quotes erd
18497 \begin_inset space ~
18501 \begin_inset Quotes erd
18505 \begin_inset Quotes erd
18509 \begin_inset space ~
18513 \begin_inset Quotes erd
18517 \begin_inset Quotes erd
18521 \begin_inset space ~
18525 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18536 \begin_layout Standard
18540 \begin_layout Section
18544 \begin_layout Standard
18550 \begin_layout Standard
18551 \begin_inset VSpace bigskip
18557 \begin_layout Standard
18562 \begin_layout Plain Layout
18568 tmpfont}{cmr17 scaled 2500}{
18580 \begin_layout Standard
18585 \begin_layout Plain Layout
18596 hose of you who like the style of old books probably also like
18597 \begin_inset Quotes eld
18601 \begin_inset Quotes erd
18604 ---those large capital letters which begin each new chapter or section.
18605 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18606 know some plain TeX!) but does require a lot of work and many iterations,
18607 as you can see by all the ugly TeX-mode stuff at the beginning of this
18611 \begin_layout Standard
18615 \begin_layout Plain Layout
18621 bigdrop{-1em}{3}{ptmri}{T}+
18626 here is a much easier way of doing this, of course.
18635 ) package from CTAN allows a simple way to add such letters to your documents.
18636 Since this package is not a standard part of teTeX, I can't demonstrate
18637 it within this document, but if you copy this paragraph to a new document,
18639 \begin_inset Quotes eld
18649 \begin_inset Quotes erd
18652 and the pluses from the TeX code at the beginning of the paragraph, and
18657 usepackage{dropcaps}
18659 to your LaTeX preamble, you will get a nice Times Roman Italic
18660 \begin_inset Quotes eld
18664 \begin_inset Quotes erd
18667 , whose height is three lines of text and which protrudes 1 em into the
18669 (Make certain you have copied
18670 \begin_inset Quotes eld
18678 \begin_inset Quotes erd
18681 into a directory where TeX can see it.) The first argument is the amount
18682 of indentation; in this case the negative sign moves it into the margin.
18683 The second argument is the height of the letter in number of lines of text.
18684 The third argument is the font name: virtually anything which has a tfm
18685 file should work (wade through the
18687 .../texmf/fonts/tfm
18689 directory for possibilities).
18690 My personal favorite is
18691 \begin_inset Quotes eld
18699 \begin_inset Quotes erd
18702 , a fancy German font specifically designed for dropped capitals.
18703 The fourth argument is the letter (or letters) to be dropped.
18708 package also offers the
18714 command, as well as a slightly simplified
18723 \begin_layout Section
18724 Non-standard Paragraph Shapes
18727 \begin_layout Standard
18733 \begin_layout Standard
18734 \begin_inset VSpace bigskip
18740 \begin_layout Standard
18744 \begin_layout Plain Layout
18756 \begin_layout Standard
18760 \begin_layout Plain Layout
18769 \begin_layout Plain Layout
18783 \begin_layout Standard
18788 \begin_layout Plain Layout
18799 \begin_layout Plain Layout
18808 \begin_layout Plain Layout
18817 \begin_layout Plain Layout
18826 \begin_layout Plain Layout
18835 \begin_layout Plain Layout
18844 \begin_layout Plain Layout
18853 \begin_layout Plain Layout
18862 \begin_layout Plain Layout
18871 \begin_layout Plain Layout
18880 \begin_layout Plain Layout
18889 \begin_layout Plain Layout
18898 \begin_layout Plain Layout
18907 \begin_layout Plain Layout
18916 \begin_layout Plain Layout
18925 \begin_layout Plain Layout
18934 \begin_layout Plain Layout
18943 \begin_layout Plain Layout
18952 \begin_layout Plain Layout
18961 \begin_layout Plain Layout
18967 There are times when the tyranny of rectangular paragraphs must be overthrown.
18968 In such situations, a call to the delightful plain TeX command
18975 As you can see, completely arbitrary shapes can be laid out with a suitable
18976 set of linelength definitions.
18977 While this parshape may look a bit silly and useless, one could conceive
18978 of situations such as finely tuned dropped capitals, word wrapping around
18979 non-rectangular graphics, etc.
18980 which will benefit from such handcrafting.
18983 \begin_layout Standard
18984 \begin_inset VSpace bigskip
18990 \begin_layout Standard
18995 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19002 is the number of lines of text which define the paragraph.
19003 If there turn out to be fewer lines, the shape is truncated; if there are
19004 more, the excess lines have the same dimensions as the last line of the
19014 entries specify the indentation of the line from the left margin, and the
19015 length of the line as measured from that point.
19016 The shape applies only to the current paragraph; everything is reset to
19017 normal for the next paragraph.
19020 \begin_layout Standard
19024 \begin_layout Plain Layout
19036 \begin_layout Section
19040 \begin_layout Standard
19041 As you can see, the examples in this section range from the useful to the
19043 While I don't expect that anyone will ever need the paragraph shape demonstrate
19044 d in the last section, the important point is that you can do almost anything
19045 you want in LyX if you are willing to figure out how to do it in TeX and
19047 TeX is a fantastically powerful typesetting system and all that power is
19048 available to you since LyX uses it as its backend.