1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16 {\usepackage{lmodern}}{}
18 % link all cross references and URLs
20 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, bookmarksopen, bookmarksopenlevel=1,
21 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
22 pdfpagelayout=OneColumn, pdfnewwindow=true,
23 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
24 pdfauthor={LyX Team}, pdftex,
25 pdftitle={LyX's Extended manual},
26 pdfsubject={LyX's extended documentation},
27 pdfkeywords={LyX, Documentation, Extended}]{hyperref}
29 \else % if dvi or ps is produced
31 % link all cross references and URLs in DVI output
32 \usepackage[ps2pdf, colorlinks=true,
33 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue]{hyperref}
35 \fi % end if pdflatex is used
37 % redefine the \LyX macro for PDF bookmarks
38 \def\LyX{\texorpdfstring{%
39 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
51 \font_typewriter default
52 \font_default_family default
58 \paperfontsize default
67 \paperorientation portrait
70 \paragraph_separation indent
72 \quotes_language english
75 \paperpagestyle headings
76 \tracking_changes false
93 \begin_layout Standard
95 Principal maintainer of this file is
100 If you have comments or error corrections, please send them to the LyX
101 Documentation mailing list, <lyx-docs@lists.lyx.org>.
109 \begin_layout Standard
110 \begin_inset CommandInset toc
111 LatexCommand tableofcontents
118 \begin_layout Chapter
122 \begin_layout Standard
125 Extended LyX Features
127 manual, which you are now reading, is essentially Part II of the
129 User's Guide\SpecialChar \@.
132 The reason for splitting this document is simple: the
136 is already huge, and it contains all of the basic features one needs to
137 know in order to prepare most documents.
138 However, the LyX Team has a long-term goal of making LyX extensible through
139 various configuration files and external packages.
140 That means that if you want to support the Fizzwizzle LaTeX package, you
141 can create a layout file for it without having to alter LyX itself.
142 We've already had contributions of several new features this way.
143 This is the place where all of that gets documented.
146 \begin_layout Standard
147 This manual also documents some special features, like fax support, version
148 control, and SGML support, which require additional software to work properly.
149 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
150 spruce up your documents by directly using the powerful features of LaTeX.
155 only WYSIWYM, and will only ever interface to certain LaTeX features.
158 \begin_layout Standard
159 Of course, with all of this extra documentation,
161 Extended LyX Features
163 may itself grow too big for its britches.
164 In that case, you can just call it the
165 \begin_inset Quotes eld
169 \begin_inset Quotes erd
175 \begin_layout Standard
176 If you haven't read the
180 yet, you are definitely in the wrong manual.
185 is the first place to go, since it will direct you to the correct manual,
186 and it also describes the notation and format of all of the manuals.
187 You should also be thoroughly familiar with the
191 and all of the basic features of LyX.
195 \begin_layout Standard
196 In this document, many sections are independent articles contributed by
197 an individual and are noted as such.
198 This person is generally whoever wrote the layout file for the new document
199 class or LaTeX package, or implemented the feature.
200 If there is no mention of an author to a chapter [or chapter sections],
201 that means it was written by the LyX Documentation Team.
204 \begin_layout Standard
205 Since all the topics in this manual depend heavily on LyX's interaction
206 with LaTeX, this first chapter covers the inner workings of LyX and how
207 to direct LyX to generate exactly the LaTeX code you want.
208 It is obviously for more seasoned LyX users.
211 \begin_layout Chapter
215 \begin_layout Section
219 \begin_layout Standard
220 \begin_inset CommandInset label
222 name "sec:lyxandlatex"
226 This chapter is for both TeX-nicians and the LaTeX-curious.
227 In it, we'll explain how LyX and LaTeX work together to produce printable
229 This is the only place in any of the manuals where we assume you know something
233 \begin_layout Standard
234 At one time, we called LyX a
235 \begin_inset Quotes eld
238 WYSIWYM frontend to LaTeX,
239 \begin_inset Quotes erd
242 but that's no longer true.
243 There are frontends to LaTeX out there.
244 They are basically editors with the ability to run LaTeX and mark any errors
245 in the file you're editing.
254 run LaTeX, and it also marks errors in the file, it also does much, much
256 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
257 LyX has also added a few extensions to LaTeX.
258 Try the following sometime: select
260 Export\SpecialChar \menuseparator
270 menu, then look at the preamble of the resulting
275 You'll notice a variety of new macros defined specifically by LyX.
276 These macros are defined automatically, according to the features you use
280 \begin_layout Standard
281 There are several commands that automatically invoke LaTeX.
285 \begin_layout Itemize
291 iew\SpecialChar \menuseparator
298 \begin_layout Itemize
304 iew\SpecialChar \menuseparator
309 pdate\SpecialChar \menuseparator
315 \begin_layout Itemize
323 \SpecialChar \menuseparator
329 \begin_layout Itemize
337 \SpecialChar \menuseparator
343 \begin_layout Standard
344 They will only invoke LaTeX if the file has changed since the last time
349 \begin_layout Standard
350 When you run LaTeX on the file you're editing, LyX performs these steps:
353 \begin_layout Enumerate
354 Convert the document to LaTeX and save to a file with the extension
365 \begin_layout Enumerate
370 file (maybe several times).
373 \begin_layout Enumerate
374 If there are any errors, insert error boxes in the document to mark where
376 These boxes are transient and are not saved along with the document.
379 \begin_layout Standard
380 If you've run LaTeX using
402 , LyX performs two more steps:
405 \begin_layout Itemize
410 to convert the DVI file to PostScript:
414 \begin_layout Itemize
420 , the output file has the extension
425 \begin_layout Itemize
434 , the output file has the extension
442 \begin_layout Itemize
447 or send the PostScript file to the printer.
450 \begin_layout Section
451 \begin_inset Quotes eld
454 Help! LyX generated an unreadable
459 \begin_inset Quotes erd
465 \begin_layout Standard
466 Die-hard LaTeX users will scream and howl this into the night, then declare
467 LyX useless, simply because they didn't RTFM.
470 \begin_layout Standard
471 We're going to set the record straight.
472 LyX produces two kinds of LaTeX files.
473 One is human readable.
474 The other is LyX readable.
475 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
481 file is not human readable.
482 Don't even try to read it.
487 file that you can send to a colleague, select
492 xport\SpecialChar \menuseparator
509 \begin_layout Section
510 Translating LaTeX files into LyX
511 \begin_inset CommandInset label
513 name "sec:Translating-LaTeX-files"
520 \begin_layout Standard
521 You can import a LaTeX file into LyX by using the
526 ile\SpecialChar \menuseparator
531 mport\SpecialChar \menuseparator
539 This will call a program named
543 ---which will create a file
551 ---and then open that file.
554 \begin_layout Standard
559 will translate most legal LaTeX, but not everything.
560 It will leave things it doesn't understand in TeX mode, so after translating
565 , you can look for red text and hand-edit it to look right.
568 \begin_layout Standard
569 If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
571 \begin_inset CommandInset ref
573 reference "sec:latexcodes"
580 \begin_layout Section
581 Inserting LaTeX Code into LyX Documents
582 \begin_inset CommandInset label
584 name "sec:Inserting-LaTeX-Code"
591 \begin_layout Standard
592 \begin_inset CommandInset label
594 name "sec:latexcodes"
598 This is a rather important point: You can always insert LaTeX code into
600 LyX simply cannot, and will probably never be able to, display every possible
602 If ever you need to insert LaTeX commands into your LyX document, you can
603 use the ERT box, which you can insert into your document with
608 nsert\SpecialChar \menuseparator
616 The ERT box comes in three forms: collapsed, open, and inlined.
617 The first two are used just like any other collapsible (foldable) box (such
618 as footnotes), and are useful for significant amounts of LaTeX commands.
620 \begin_inset Quotes eld
624 \begin_inset Quotes erd
627 ERT box displays its content as part of the button, and is useful for very
628 short sections of LaTeX commands.
633 \begin_layout Standard
643 \begin_layout Standard
644 You can switch between all three by right-clicking on the ERT.
645 Note that if you want more than one line of LaTeX commands, you cannot
646 use the inlined mode.
649 \begin_layout Standard
650 Here's an example of inserting LaTeX commands in a LyX document.
651 The code looks like this:
654 \begin_layout LyX-Code
663 This is an example for a minipage environment.
666 can put nearly everything in it, even (non-floating)
709 \begin_layout LyX-Code
713 \begin_layout Standard
714 The ERT box containing this text is directly after this paragraph.
715 Those of you reading the manual online will only see a bunch of funky text
717 Those reading a printed version of the manuals will see the actual results:
720 \begin_layout Standard
724 \begin_layout Standard
731 \begin_layout Standard
738 \begin_layout Standard
740 This is an example for a minipage environment.
741 You can put nearly everything in it, even (non-floating) figures and tables.
745 \begin_layout Standard
752 \begin_layout Standard
757 \begin_layout Standard
764 \begin_layout Standard
771 \begin_layout Standard
778 \begin_layout Standard
784 \begin_layout Standard
791 \begin_layout Standard
798 \begin_layout Standard
805 \begin_layout Standard
817 \begin_layout Standard
818 In addition to these two methods, you can also create a separate file containing
819 some complex LaTeX structure.
825 nsert\SpecialChar \menuseparator
833 to include your file (you should select the type
838 We recommend that you only do this if you have a
847 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
851 \begin_layout Standard
852 There are a few last notes to emphasize:
855 \begin_layout Itemize
856 Inside of LyX, LaTeX code appears
861 \begin_layout Itemize
866 check if your LaTeX code is correct.
869 \begin_layout Itemize
870 Beware reinventing the wheel.
873 \begin_layout Standard
874 That last note refers to two things.
875 First, LyX does have quite a few features tucked into it, and more are
877 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
878 feature before you go off merrily coding LaTeX.
879 Second, there are numerous LaTeX packages out there to do all sorts of
880 things, from labels to envelopes to fancy multipage tables.
881 Check out a CTAN site for details (see Section
882 \begin_inset Quotes eld
886 \begin_inset Quotes erd
897 \begin_layout Standard
902 : I seem to do this an awful lot.
903 Sat down and merrily began coding something to print out labels, only to
904 learn that there were already 2 different LaTeX packages to do this.
905 Worse yet --- I had them already!
913 \begin_layout Standard
914 If you do need to do some wild and fancy things within your document, be
915 sure to check out a good LaTeX book for assistance.
916 There are a number of them listed in the bibliography of the
923 \begin_layout Standard
924 There are a number of LaTeX commands which have to be placed before the
925 beginning of the actual text.
926 They go into the preamble, and this is explained in the next section.
929 \begin_layout Section
930 LyX and the LaTeX Preamble
933 \begin_layout Subsection
934 About the LaTeX Preamble
937 \begin_layout Standard
938 \begin_inset CommandInset label
944 If you already know LaTeX, there is no need to explain here what the preamble
946 If you don't, the following will give you some ideas --- we recommend again
947 that you consult a LaTeX book for further information.
948 In any case, you should read the points below, because they explain what
949 you can do and what you don't need to do in the LaTeX preamble of a LyX
953 \begin_layout Standard
954 The LaTeX preamble comes at the very beginning of a document,
962 \begin_layout Itemize
963 declare the document class.
964 LyX already does this for you.
968 \begin_layout Standard
969 If you're a seasoned LaTeX-nician, and you have some custom document class
970 you want to use, check out the
974 for information on how to make LyX interface to it.
975 Be sure to submit your efforts to the LyX Team for inclusion in future
980 \begin_layout Itemize
981 declare the usage of packages.
982 LaTeX packages provide special commands, which are only available within
983 a document when the package has been declared in the preamble.
984 For example, the package
988 forces all paragraphs to be indented.
989 There are other packages for labels, envelopes, margins, etc.
993 \begin_layout Itemize
994 set counters, variables, lengths and widths.
995 There are several LaTeX counters and variables which
999 be set globally from within the preamble in order to have the desired effect.
1000 [There are other variables which you can set and reset inside the document,
1001 too.] Margins are a good example of something which must be set in the preamble.
1002 Another example is the label format for lists.
1003 You can actually set these just about anywhere, but it's best to do it
1004 just once, inside the preamble.
1007 \begin_layout Itemize
1008 declare user defined commands [with
1020 ], mostly abbreviations for LaTeX commands which appear very often inside
1022 Although the preamble is a good place to declare such commands, they
1026 be declared anywhere else [but
1030 they are used for the first time, of course\SpecialChar \ldots{}
1032 This can be useful if there is a lot of raw LaTeX code in your document,
1033 which normally should not be the case.
1036 \begin_layout Standard
1037 LyX adds its own set of definitions to the preamble of the
1042 This makes LaTeX files generated by LyX portable.
1045 \begin_layout Subsection
1046 Changing the Preamble
1049 \begin_layout Standard
1050 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1051 can't change them without patching LyX itself.
1052 You can, however, add your own stuff to the preamble.
1053 There are two ways to do this:
1056 \begin_layout Enumerate
1083 \SpecialChar \menuseparator
1091 dialog, depending on your frontend.
1092 Note that the LyX keybindings will not work in this dialog, alas.
1095 \begin_layout Enumerate
1096 Use the preamble contents you've added as your default template (see
1097 \begin_inset Quotes eld
1101 \begin_inset Quotes erd
1108 ), so that it will be the default preamble for any file you create.
1111 \begin_layout Standard
1112 LyX adds anything in the
1119 dialog to its own built-in preamble.
1120 Before adding your own declarations in the preamble, you should make sure
1121 that LyX doesn't already support what you want to do (remember what we
1122 said about reinventing the wheel?).
1125 make sure your preamble code is correct
1128 LyX doesn't check it.
1131 \begin_layout Subsection
1135 \begin_layout Standard
1136 Here are some examples of what you can add to a preamble, and what they
1140 \begin_layout Subsubsection
1144 \begin_layout Standard
1145 There are two variables under LaTeX that control page position:
1158 Their names should be self-explanatory.
1159 These variables are useful if you think for a moment about computer labels.
1160 Sometimes, the size of a print medium and the area of the medium that you
1161 can actually print on aren't the same.
1177 \begin_layout Standard
1178 The default values for
1190 are both 0 pt.,\InsetSpace ~
1193 the page isn't shifted.
1196 \begin_layout Standard
1197 Unfortunately, some DVI drivers always seem to shift the page.
1198 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1199 If you're using LyX on a system that you don't personally maintain, and
1200 your sysadmin is a doofus,
1213 Suppose you're left and top margins are always 0.5 inches too big.
1214 You can add this to the preamble:
1217 \begin_layout LyX-Code
1225 \begin_layout LyX-Code
1233 \begin_layout Standard
1234 \SpecialChar \ldots{}
1235 and your margins should now be correct.
1238 \begin_layout Subsubsection
1242 \begin_layout Standard
1243 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1244 There's a rather nice package, available at your nearest CTAN archive,
1245 for printing sheets of labels, called
1250 Now, your system may not have this package installed by default.
1251 We leave that up to you to check.
1252 You'll also want to read the documentation for it; we're not going to do
1254 Since this is an example, however, we'll give you an example of how you
1258 \begin_layout Standard
1259 First, make sure you're using the
1264 Next, you need to put the following in your preamble:
1267 \begin_layout LyX-Code
1273 \begin_layout LyX-Code
1279 \begin_layout LyX-Code
1285 \begin_layout LyX-Code
1291 \begin_layout LyX-Code
1297 \begin_layout LyX-Code
1303 \begin_layout LyX-Code
1309 \begin_layout Standard
1310 This sets things up for Avery® label sheets, stock #5360.
1311 You're now ready to print labels, but you'll need to insert LaTeX code,
1312 placing the commands
1324 around each label text.
1325 This and other special features of
1329 are explained in its documentation.
1332 \begin_layout Standard
1333 Someday, someone may write a LyX layout file to support this package directly.
1334 Maybe that someone is you.
1337 \begin_layout Subsubsection
1338 Example #3: Paragraph Indentation
1341 \begin_layout Standard
1342 Americans are trained to indent the first line of
1347 As with all of their other weird quirks, most Americans will whine and
1348 moan until they can have their way and indent the first line of all paragraphs.
1352 \begin_layout Standard
1357 : This was written by an American ---
1361 ! It's my perception of my fellow countrymen.
1362 Tough if you don't like it.
1371 \begin_layout Standard
1372 Of course, this behavior isn't standard typography.
1373 In books, you typically only indent the first line of a paragraph
1377 it follows another one.
1378 The idea behind indenting the first line of a paragraph is to distinguish
1379 neighboring paragraphs from one another.
1380 If there is no previous paragraph, for example, it follows a figure, or
1381 is the first paragraph in a section, then there is no special indentation.
1385 \begin_layout Standard
1386 If you're a typical American, though, you don't care about such esoteric
1387 things; you want your indentation! Add this to the preamble:
1390 \begin_layout LyX-Code
1393 usepackage{indentfirst}
1396 \begin_layout Standard
1397 If your TeX distribution isn't a braindead one, you'll have this package,
1398 and all of your paragraphs will get the indentation you think they deserve.
1401 \begin_layout Subsubsection
1402 Example #4: This Document
1405 \begin_layout Standard
1406 You can also check out the preamble of this document to get an idea of some
1407 of the advanced things you can do.
1408 You'll probably need to make the
1413 reamble\SpecialChar \ldots{}
1416 dialog full-screen to see most of it.
1417 Also, there are more examples and an assortment of LaTeX
1418 \begin_inset Quotes eld
1422 \begin_inset Quotes erd
1425 given in Chapter\InsetSpace ~
1427 \begin_inset CommandInset ref
1429 reference "cha:secrets"
1437 \begin_layout Section
1438 LyX and LaTeX Errors
1441 \begin_layout Standard
1442 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1444 It then uses the log-file from the LaTeX run to do a post-mortem.
1445 As we stated earlier in the chapter, LyX generates two kinds of
1449 files, one of which it uses to locate errors in the document.
1450 If there was an error someplace, LyX will put a box with the word
1451 \begin_inset Quotes eld
1455 \begin_inset Quotes erd
1458 at the appropriate place in the document.
1462 \begin_layout Standard
1463 LyX will occasionally misguess where the error was.
1464 This will typically happen with tables, figures, math, and the preamble.
1469 It will also display a message alerting you to the fact that there were
1473 \begin_layout Standard
1474 You can navigate through the errors by using
1490 \begin_inset Quotes eld
1494 \begin_inset Quotes erd
1497 the error-boxes and view the error message LaTeX produced by clicking on
1501 \begin_layout Standard
1502 Some folks also like to look at the log file directly, accessible from
1507 ocument\SpecialChar \menuseparator
1517 There are some fairly common error messages and warnings.
1518 We'll cover those here.
1519 You should look at a good LaTeX book for a complete listing.
1522 \begin_layout Itemize
1523 \begin_inset Quotes eld
1531 \begin_inset Quotes eld
1538 \begin_layout Standard
1539 Anything beginning with these word is a warning message for the purpose
1541 \begin_inset Quotes eld
1545 \begin_inset Quotes erd
1548 the LaTeX code itself.
1549 You'll get messages like this if you added or changed cross-references
1550 or bibliography entries, in which case, LaTeX is trying to tell you that
1551 you need to make another run.
1554 \begin_layout Standard
1555 You can by-and-large ignore these.
1559 \begin_layout Itemize
1560 \begin_inset Quotes eld
1568 \begin_inset Quotes erd
1575 \begin_layout Standard
1576 Another warning message, this time about fonts which LaTeX couldn't find.
1577 The rest of the message will often say something about a replacement font
1581 \begin_layout Standard
1582 You can safely ignore these.
1586 \begin_layout Itemize
1587 \begin_inset Quotes eld
1597 \begin_inset Quotes erd
1604 \begin_layout Standard
1610 They are warning you about lines that were too long and run past the right
1612 Almost always, this is unnoticeable in the final output.
1613 Or, only one or two characters extend past the margin.
1614 LaTeX seems to generate at least one of these messages for just about any
1618 \begin_layout Standard
1619 You can ignore these stupid messages.
1620 Your eyes will tell you if there's a problem with something that's too
1621 wide; just look at the output.
1625 \begin_layout Itemize
1626 \begin_inset Quotes eld
1636 \begin_inset Quotes erd
1643 \begin_layout Standard
1644 Not quite as common as its cousin.
1645 LaTeX seems to like to print lines that are a bit too wide as opposed to
1646 ones that are a bit too narrow.
1647 We have no idea why.
1650 \begin_layout Standard
1651 You can ignore these, too.
1655 \begin_layout Itemize
1656 \begin_inset Quotes eld
1666 \begin_inset Quotes erd
1670 \begin_inset Quotes eld
1680 \begin_inset Quotes erd
1687 \begin_layout Standard
1688 Warnings about troubles breaking the page.
1689 Once again, just look at the output.
1690 Your eyes will tell you where something has gone wrong.
1694 \begin_layout Itemize
1695 \begin_inset Quotes eld
1701 \begin_inset Quotes els
1705 \begin_inset Quotes ers
1711 \begin_inset Quotes erd
1718 \begin_layout Standard
1720 \begin_inset Quotes eld
1724 \begin_inset Quotes erd
1727 isn't installed on this system.
1728 This usually appears because some package your document needs isn't installed.
1729 If you didn't touch the preamble or didn't use the
1735 command, then one of the packages LyX tried to load is missing.
1741 elp\SpecialChar \menuseparator
1748 , to get a list of packages that LyX knows about.
1749 This file is updated whenever you reconfigure LyX (using
1756 \SpecialChar \menuseparator
1761 ) and tells you which packages have been detected and what they do.
1764 \begin_layout Standard
1775 command, and the package in question isn't installed, you'll need to install
1780 \begin_layout Itemize
1781 \begin_inset Quotes eld
1786 LaTeX Error: Unknown option
1789 \begin_inset Quotes erd
1796 \begin_layout Standard
1797 Error messages beginning with this are trying to tell you that you specified
1798 a bad or undefined option to a package.
1799 Check the package's documentation.
1803 \begin_layout Itemize
1804 \begin_inset Quotes eld
1809 Undefined control sequence
1812 \begin_inset Quotes erd
1819 \begin_layout Standard
1820 If you've inserted LaTeX code into your document, but made a typo, you'll
1822 You may have forgotten to load a package.
1823 In any case, this error message usually means that you used an undefined
1828 \begin_layout Standard
1829 There are other error and warning messages.
1830 Some are self-explanatory.
1831 These are usually LaTeX messages.
1832 Others are downright cryptic.
1833 These are actually TeX error messages, and we really have
1837 what they mean or how to decipher them.
1840 \begin_layout Standard
1841 There's a general sequence you should follow if you get error messages:
1844 \begin_layout Enumerate
1845 Look at the LaTeX code you inserted for typos.
1848 \begin_layout Enumerate
1849 If there are no typos, check and see that you used the command(s) correctly.
1852 \begin_layout Enumerate
1853 If you get a bunch of error boxes piled up at the very top of the document,
1854 it means that there are errors in the preamble.
1855 Start debugging your preamble.
1858 \begin_layout Enumerate
1859 If you didn't add anything to the preamble and didn't add any LaTeX code
1860 to the document, the first suspect is your LaTeX distribution itself.
1861 Check for missing packages and install them.
1864 \begin_layout Enumerate
1865 Okay, so there are no missing packages.
1866 Did you use any of the fine-tuning options in LyX? Specifically, did you
1871 any of them, like trying to manually insert lots of
1873 Protected\InsetSpace ~
1884 s? Did you try to kludge something together with these instead of using
1885 the appropriate paragraph environment?
1888 \begin_layout Enumerate
1889 All right, you didn't use any of the fine-tuning options, you played by
1891 Did you try to pull a fancy maneuver? Did you do something funky inside
1892 a table or an equation, like inserting a graphic into a table cell?
1895 \begin_layout Enumerate
1896 Do you have long sections of text where LaTeX cannot find a place to break
1897 a line? By default, LaTeX is rather strict about how much extra inter-word
1898 spacing it will add in order to break a line.
1899 Preferably, you should rework the paragraph to avoid the problem.
1900 If this isn't an option, you can wrap your text in
1906 to make LaTeX's line breaking more, well, sloppy.
1909 \begin_layout Enumerate
1910 Did you go overboard with the nesting? LyX (currently) doesn't check to
1911 make sure you're in the limits for nesting environments.
1912 If you nested a bunch of environments to the
1913 \begin_inset Formula $17^{\mathrm{th}}$
1916 level, that's the problem.
1919 \begin_layout Enumerate
1920 Okay, you didn't get any error messages, but your output looks whacked.
1921 If you have a table or figure that's too wide or long for the page, you
1926 \begin_layout Enumerate
1927 rescale the figure so it fits.
1930 \begin_layout Enumerate
1931 trim down the table so it fits.
1934 \begin_layout Standard
1935 If something else is wrong with the output, and you didn't try to pull anything
1936 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1940 \begin_layout Standard
1941 If all this doesn't help --- well, then
1945 you might have found a bug in LyX\SpecialChar \ldots{}
1949 \begin_layout Chapter
1953 \begin_layout Section
1954 Preparing a Bibliography with BibTeX
1955 \begin_inset CommandInset label
1957 name "sec:Preparing-a-Bibliography"
1964 \begin_layout Standard
1971 Jürgen Spitzmüller
1974 \begin_layout Standard
1975 \begin_inset VSpace bigskip
1981 \begin_layout Standard
1983 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1986 e.\InsetSpace \thinspace{}
1990 setting up your own bibliographic databases),
1994 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1996 LaTeX: A Document Preparation System
1998 , particularly Appendix B.
1999 The rest of this discussion assumes you have created a correct bibliography
2000 file, that you have all relevant environment variables set correctly (esp.
2013 ), and that if sufficiently desperate, you could create and
2014 \begin_inset Quotes eld
2018 \begin_inset Quotes erd
2021 a LaTeX file with a BibTeX database.
2025 \begin_layout Standard
2026 For those who don't know what BibTeX is, it is a system for creating a large
2027 database of your most used journal references.
2028 For all future articles you write, you only need to include this standard
2029 database and reference the appropriate key to each reference.
2030 Even if you write only a few papers with handful of references each, it
2031 is well worth your time to examine BibTeX and decide whether it will be
2035 \begin_layout Standard
2036 To use BibTeX with LyX, first read the
2040 where it describes how to insert citations.
2041 The basic mechanism for inserting BibTeX references is the same.
2042 Then, at the very end of your document, select
2044 Insert\SpecialChar \menuseparator
2049 TOC\SpecialChar \menuseparator
2053 In the resulting dialog, fill out the dialog boxes as follows:
2056 \begin_layout Description
2057 Database: enter the name of your
2070 For searching multiple
2074 files, just enter them in the desired order, separated by commas.
2078 \begin_layout Description
2079 Style: enter the name of your BibTeX style file *without* the
2084 The default style is
2088 (which should be included in your LaTeX distribution, so you don't have
2089 to worry about creating it).
2092 \begin_layout Standard
2093 For each citation, assuming that the source is in the
2102 nsert\SpecialChar \menuseparator
2109 at the correct location in the text, and enter the appropriate reference
2111 Nothing else is required; when invoking
2116 iew\SpecialChar \menuseparator
2123 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2124 including multiple invocations of LaTeX.
2128 \begin_layout Subsection
2129 Alternative Citation Styles
2132 \begin_layout Standard
2133 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2134 g.\InsetSpace \space{}
2136 \begin_inset Quotes eld
2140 \begin_inset Quotes erd
2143 ) to refer to a cited work.
2144 However, in many scientific disciplines, other citation styles are in use.
2145 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2146 g.\InsetSpace \space{}
2148 \begin_inset Quotes eld
2152 \begin_inset Quotes erd
2156 LyX supports two packages that provide this style,
2165 Both packages have their own pros and cons, which cannot be listed in detail.
2166 If you only want to have simple author-year (or author-numerical) style
2167 or if you want to use one of the countless style files for natbib, than
2172 package is probably your choice.
2173 If you need special features like short title references, ibidem etc., you
2174 might consider the fairly new
2181 \begin_layout Standard
2182 The handling of both packages in LyX is basically the same.
2188 ocument\SpecialChar \menuseparator
2199 pane (with the xforms frontend: the
2213 With both packages, you will get some extra features in the citation dialog
2214 and you can select the style of the reference (
2215 \begin_inset Quotes eld
2219 \begin_inset Quotes erd
2223 \begin_inset Quotes eld
2227 \begin_inset Quotes erd
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2239 \begin_inset Quotes eld
2243 \begin_inset Quotes erd
2247 Note that both packages need specifically designed style files (they both
2248 ship their own, while there are lots of additional style files and even
2249 an interactive style file builder
2253 \begin_layout Standard
2255 \begin_inset Flex URL
2258 \begin_layout Standard
2260 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2277 \begin_layout Subsection
2278 Sectionated Bibliographies
2279 \begin_inset CommandInset label
2281 name "sub:Sectionated-Bibliographies"
2288 \begin_layout Standard
2289 Sometimes you might need to divide your bibliography into several sections.
2290 If you are, for instance, a historian, the possibility to separate sources
2291 and scientific works is most likely a
2292 \begin_inset Quotes eld
2296 \begin_inset Quotes erd
2300 Unfortunately, BibTeX itself does not allow you to do this.
2301 The good news is, though: With the help of some LaTeX packages, BibTeX
2302 can be extended to fit your historical needs.
2305 \begin_layout Standard
2306 As of version 1.4, LyX provides native support for one of these packages,
2315 \begin_layout Standard
2317 \begin_inset Flex URL
2320 \begin_layout Standard
2322 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2332 The advantage of this package (compared to other packages like
2336 ) is that you don't need to define new citation commands.
2337 Instead, you need to prepare different bibliographic databases which include
2338 the entries for the different sections of the bibliography.
2339 For example: If you want to divide your bibliography into the sections
2341 \begin_inset Quotes eld
2345 \begin_inset Quotes erd
2349 \begin_inset Quotes eld
2353 \begin_inset Quotes erd
2356 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2357 g.\InsetSpace \space{}
2370 \begin_layout Standard
2376 ocument\SpecialChar \menuseparator
2387 pane (with the xforms frontend: the
2394 Sectionated\InsetSpace ~
2398 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2400 \begin_inset CommandInset ref
2402 reference "sec:Preparing-a-Bibliography"
2406 ), one for each section of your bibliography.
2407 Returning to our example: Insert a BibTeX reference for the database
2411 and a second one for the database
2416 You are free to use the same or different styles for each section.
2417 Additionally, you can chose if the bibliography section should contain
2419 \begin_inset Quotes eld
2422 all cited references
2423 \begin_inset Quotes erd
2426 of the specified database(s) (which is the default),
2427 \begin_inset Quotes eld
2430 all uncited references
2431 \begin_inset Quotes erd
2435 \begin_inset Quotes eld
2439 \begin_inset Quotes erd
2443 This might be useful if you would like to separate your bibliography into
2445 \begin_inset Quotes eld
2449 \begin_inset Quotes erd
2453 \begin_inset Quotes eld
2457 \begin_inset Quotes erd
2461 \begin_inset Quotes eld
2465 \begin_inset Quotes erd
2469 The titles for the sections can be added as ordinary sections or subsections.
2474 removes the bibliography title, you have manually re-add that, too (as
2475 a chapter* or section*, for instance).
2478 \begin_layout Subsection
2479 Multiple Bibliographies
2482 \begin_layout Standard
2483 Multiple bibliographies, e.\InsetSpace \thinspace{}
2484 g.\InsetSpace \space{}
2485 a bibliography for each section or chapter of
2486 the document, are not supported by BibTeX itself.
2491 package, which is used for the creation of sectionated bibliographies in
2492 LyX (cf.\InsetSpace ~
2493 section\InsetSpace ~
2495 \begin_inset CommandInset ref
2497 reference "sub:Sectionated-Bibliographies"
2501 ), provides an easy way to solve this task, if you are willing to use some
2502 LaTeX-Code (ERT, cf.\InsetSpace ~
2503 section\InsetSpace ~
2505 \begin_inset CommandInset ref
2507 reference "sec:Inserting-LaTeX-Code"
2515 \begin_layout Standard
2516 An alternative approach is to use the
2524 package, respectively.
2532 \begin_layout Standard
2538 ocument\SpecialChar \menuseparator
2549 pane (with the xforms frontend: the
2556 Sectionated\InsetSpace ~
2560 In the document, you have to enclose the sections, which shall contain
2561 their own bibliography (including the BibTeX reference itself), between
2574 (those commands have to be inserted as ERT).
2575 The bibliography will contain all references which have been cited in the
2577 N.\InsetSpace \thinspace{}
2578 B.: If you are using this approach, then
2582 citation reference has to be inside some btUnit.
2583 Also, the btUnits cannot be nested.
2586 \begin_layout Standard
2590 \begin_layout Section
2594 \begin_layout Subsection
2598 \begin_layout Standard
2599 When you are working on a large file with many sections, it is often convenient
2600 to break up the document into several files, or perhaps you have something
2601 where a table may change from time to time, but the preceding text does
2603 In these cases, you should seriously consider using multipart documents.
2604 For example, scientific papers often have five major sections: the introduction
2605 , observations, results, discussion, and conclusion.
2606 Each of these could be its own separate LyX file, with one
2607 \begin_inset Quotes eld
2611 \begin_inset Quotes erd
2614 file which contains the title, authors, abstract, references, etc., plus
2615 the five included files.
2616 It is important to note that each of these files is a full LyX file which
2617 can be formatted and printed on its own, as well as included in a master
2619 Each of these files must have the same document class, however--- don't
2620 attempt to mix book classes with article classes.
2621 You may also include LaTeX files; however, these files must not have their
2627 everything up to and including the
2639 line must be deleted) or else errors will be generated when you try to
2643 \begin_layout Standard
2644 LyX allows you to include files quite easily with
2649 nsert\SpecialChar \menuseparator
2658 When you click on this selection a small box is inserted into the file
2659 at the current cursor location.
2660 Clicking on the box raises a dialog which allows you to select the file
2661 to be included, and the method of its inclusion.
2665 \begin_layout Standard
2666 The file selection box should by now be obvious.
2667 The three inclusion methods are
2668 \begin_inset Quotes eld
2672 \begin_inset Quotes erd
2676 \begin_inset Quotes eld
2680 \begin_inset Quotes erd
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 The difference between
2693 \begin_inset Quotes eld
2697 \begin_inset Quotes erd
2701 \begin_inset Quotes eld
2705 \begin_inset Quotes erd
2708 is really only meaningful to LaTeXperts, but the practical difference is
2709 that files which are
2710 \begin_inset Quotes eld
2714 \begin_inset Quotes erd
2717 are typeset beginning on a new page, while files which are
2718 \begin_inset Quotes eld
2722 \begin_inset Quotes erd
2725 are typeset starting on the current page.
2726 Perhaps the labeling in LyX will be changed someday to reflect this.
2729 \begin_layout Standard
2730 Generally, the master file is converted into a full LaTeX file before typesettin
2731 g, while the included files are converted to LaTeX files which do not have
2732 all the preamble information.
2742 button prevents this conversion.
2745 \begin_layout Standard
2747 \begin_inset Quotes eld
2751 \begin_inset Quotes erd
2754 included file allows you to include a file typeset exactly as it appears
2755 in the file, i.e.\InsetSpace ~
2756 verbatim mode, with the characters set in a fixed-width
2758 Normally, spaces in this file are invisible, though two consecutive spaces
2759 are conserved, unlike LyX's normal treatment of spaces.
2760 However, setting the
2770 checkbox typesets a mark to unambiguously define the presence of a space.
2774 \begin_layout Subsection
2775 Cross-References Between Files
2778 \begin_layout Standard
2779 It is possible to set up cross-references between the different files.
2780 First, open all the files in question: let's call them A and B in a two
2781 file example, where B is included in A.
2782 Let's say you insert a label in A, then want to reference it in B.
2783 Open the cross-reference dialog in whilst in document B, and you can select
2785 \begin_inset Quotes eld
2789 \begin_inset Quotes erd
2795 \begin_layout Section
2796 Fancy Headers and Footers
2799 \begin_layout Standard
2800 The default page layout is rather plain; for an article document class,
2801 all you get is a centered page number at the bottom of the page.
2802 This document is the book class, so it appears to be a bit fancier, but
2803 to really put on a show, you need to set the document page style to
2804 \begin_inset Quotes eld
2808 \begin_inset Quotes erd
2811 , as mentioned in the
2817 This section describes the LaTeX codes you need to insert in your LaTeX
2818 preamble or the text in order to get the desired effects.
2821 \begin_layout Standard
2822 The page header is divided into three fields, not surprisingly labeled
2823 \begin_inset Quotes eld
2827 \begin_inset Quotes erd
2831 \begin_inset Quotes eld
2835 \begin_inset Quotes erd
2839 \begin_inset Quotes eld
2843 \begin_inset Quotes erd
2847 The footer is also divided into these three fields.
2848 The LaTeX commands to set these fields in the simplest manner are
2873 Suppose you wish to put your name in the upper left hand corner of each
2875 Simply insert the following command in the preamble:
2878 \begin_layout Standard
2887 \begin_layout Standard
2888 You will now see your name in the upper left.
2889 If a field has a default entry that you would like to get rid of (often
2890 the page number appears in the central footer, simply include a command
2891 with a blank argument, e.\InsetSpace \thinspace{}
2895 \begin_layout Standard
2903 \begin_layout Standard
2904 Let's get really fancy: lets put the section number with the word
2905 \begin_inset Quotes eld
2909 \begin_inset Quotes erd
2912 (e.\InsetSpace \thinspace{}
2914 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
2916 Page 4) in the upper
2917 right, your name in the lower left, and the date in the lower right.
2918 The following commands should now appear in the preamble:
2921 \begin_layout Standard
2931 \begin_layout Standard
2939 \begin_layout Standard
2949 \begin_layout Standard
2958 \begin_layout Standard
2966 \begin_layout Standard
2976 \begin_layout Standard
2989 access LaTeX's section and page counters, and so print out the current
2990 section and page numbers.
2997 simply prints out today's date.
3000 \begin_layout Standard
3001 The thicknesses of the horizontal rules drawn beneath the header and above
3002 the footer can also be modified.
3003 If you don't want one of the headers, set its thickness to 0.
3004 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3005 Use the commands, e.\InsetSpace \thinspace{}
3013 headrulewidth}{0.4pt}
3021 footrulewidth}{0.4pt}
3023 to set the thicknesses.
3026 \begin_layout Standard
3027 You can switch the header/footer settings on and off for individual pages
3032 thispagestyle{empty}
3038 thispagestyle{plain}
3044 thispagestyle{fancy}
3047 Simply insert them in the text on the page you want changed and mark them
3049 In fact, title pages are marked as plain by default, while following pages
3050 are marked fancy when using the global fancy setting.
3053 \begin_layout Standard
3054 There are more complex commands which will let you insert things in the
3055 upper left on odd numbered pages, etc., but I will refer you to the
3059 package documentation for more descriptions.
3060 For example, if you have a teTeX installation, look for
3062 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3068 \begin_layout Standard
3069 As a final example, it is possible to include an Encapsulated PostScript
3070 file in the header or footer.
3071 Suppose you want to put a company logo in the upper lefthand corner.
3072 You might try something like
3075 \begin_layout Standard
3084 includegraphics{logo.eps}}}
3087 \begin_layout Standard
3089 (you may need to preface this with
3093 usepackage{graphics}
3095 if you don't include EPS files elsewhere in your document).
3098 \begin_layout Section
3099 Itemize Bullet Selection
3100 \begin_inset CommandInset label
3109 \begin_layout Standard
3115 \begin_layout Subsection
3119 \begin_layout Standard
3120 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3121 Using this dialog you can easily specify what bullet shape to use at each
3122 level of an itemized list.
3123 These settings are document-wide so you won't be able to specify different
3124 sets of bullets for different paragraphs
3128 \begin_layout Standard
3129 Well, actually you can but you'll have to do it by hand.
3137 \begin_layout Subsection
3141 \begin_layout Standard
3142 Open the dialog by selecting the
3147 ocument\SpecialChar \menuseparator
3154 menu item and then select the
3164 \begin_layout Standard
3165 The dialog provides you with a table of bullet shapes.
3166 A column of buttons on the left of the table provides access to the six
3167 different panels of bullet shapes.
3168 The row of buttons across the top is used to select which bullet depth
3170 A text entry under the table shows the currently selected bullet shape's
3171 LaTeX equivalent and this can be edited if desired.
3172 If you do modify the text you will also need to specify any needed packages
3173 in the LaTeX preamble.
3176 \begin_layout Standard
3177 The six panels are divided up by the packages they require.
3178 The following table shows the mappings from button name to LaTeX packages.
3181 \begin_layout Standard
3183 \begin_inset Tabular
3184 <lyxtabular version="3" rows="7" columns="2">
3186 <column alignment="center" valignment="top" leftline="true" width="0pt">
3187 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3188 <row topline="true" bottomline="true">
3189 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3192 \begin_layout Standard
3207 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3210 \begin_layout Standard
3226 <row topline="true">
3227 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3230 \begin_layout Standard
3245 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3248 \begin_layout Standard
3263 <row topline="true">
3264 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3267 \begin_layout Standard
3282 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3285 \begin_layout Standard
3301 <row topline="true">
3302 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3305 \begin_layout Standard
3320 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3323 \begin_layout Standard
3339 <row topline="true">
3340 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3343 \begin_layout Standard
3358 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3361 \begin_layout Standard
3377 <row topline="true">
3378 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3381 \begin_layout Standard
3396 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3399 \begin_layout Standard
3415 <row topline="true" bottomline="true">
3416 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3419 \begin_layout Standard
3434 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3437 \begin_layout Standard
3460 \begin_layout Standard
3461 LyX doesn't stop you using bullets from packages you don't have.
3462 If you get errors from LaTeX when you try to view or print the file then
3463 its likely you are missing a package.
3464 LyX doesn't restrict your use since you may be editing locally and exporting
3468 \begin_layout Subsection
3472 \begin_layout Standard
3473 Select which bullet depth you want to change then select the bullet shape
3475 Any changes will not be visible in LyX, but are visible when viewing the
3476 document using xdvi or ghostview.
3479 \begin_layout Standard
3480 You can reset a bullet shape to the default simply by clicking your right
3481 mouse button on the appropriate bullet depth button.
3484 \begin_layout Standard
3489 want to have multiple sets of paragraphs with different sets of bullets
3490 in each then you're going to have to get your hands dirty.
3491 The itemize bullet selection dialog can help though because it provides
3492 you with the LaTeX code for a wide range of bullet shapes.
3493 To make your own custom paragraphs you have the following options:
3496 \begin_layout Standard
3500 \begin_layout Standard
3516 \begin_layout Standard
3520 \begin_layout Standard
3542 \begin_layout Itemize
3543 Use the LaTeX command
3549 to specify a new bullet shape for a given depth.
3550 You'll also need to save the current bullet shape so you can restore it
3552 In this itemized list the following LaTeX code was used to change the bullet
3553 used for the first depth.
3585 Note that the itemize depth is specified in Roman numerals as part of the
3595 \begin_layout Itemize
3599 \begin_layout Standard
3612 Specify each individual entry by starting each item with the bullet shape
3613 enclosed in square brackets and set as TeX.
3614 For example, this item was started with
3627 \begin_layout Standard
3631 \begin_layout Standard
3647 \begin_layout Standard
3648 You'll also need to revert the labelitem back to its previous setting for
3649 the global bullet shape settings to remain in effect.
3650 The way used here was:
3663 \begin_layout Chapter
3664 Special Document Classes
3667 \begin_layout Section
3668 \begin_inset CommandInset label
3670 name "sec:AMS-LaTeX"
3677 \begin_layout Standard
3680 David Johnson; updated by Richard Heck
3683 \begin_layout Standard
3684 \begin_inset VSpace bigskip
3690 \begin_layout Standard
3692 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3693 papers to be submitted to American Mathematical Society publications.
3694 The layouts are not tailored to a specific journal, but easily can be.
3695 You should refer to the AMS documentation for specific instructions for
3696 each journal (usually it will entail only changing a single line in the
3698 That documentation is available on the Web at
3699 \begin_inset Flex URL
3702 \begin_layout Standard
3710 \begin_inset Flex URL
3713 \begin_layout Standard
3715 ftp://ftp.ams.org/pub/tex/amslatex/
3721 These layouts are appropriate, and useful, for any mathematical writing.
3725 \begin_layout Standard
3726 There are two basic AMS LaTeX layouts:
3729 \begin_layout Enumerate
3730 amsart: The standard AMS article format.
3733 \begin_layout Enumerate
3734 amsbook: the standard AMS book (really, monograph) format.
3738 \begin_layout Standard
3739 These layouts themselves contain only the minimum necessary to use the AMS
3741 They do not, in particular, contain any of the `theorem' environments used
3742 for setting theorems, lemmas, and the like.
3743 These are contained, instead, in the
3744 \begin_inset Flex CharStyle:Code
3747 \begin_layout Standard
3753 module, which you will need to load separately when you selected one of
3755 Less commonly used environments are in the
3756 \begin_inset Flex CharStyle:Code
3759 \begin_layout Standard
3760 Theorems (AMS-Extended)
3769 \begin_layout Standard
3770 By default, theorems and the like are numbered consecutively throughout
3771 the document, but this may be modified by loading the module
3772 \begin_inset Flex CharStyle:Code
3775 \begin_layout Standard
3776 Theorems (Order by Section)
3781 or, if you are using
3782 \begin_inset Flex CharStyle:Code
3785 \begin_layout Standard
3792 \begin_inset Flex CharStyle:Code
3795 \begin_layout Standard
3796 Theorems (Order by Chapter)
3802 These will number the results as
3803 \begin_inset Formula $n.m$
3806 , where the first number refers to the section (or chapter) and the second
3807 refers to the total number of results so far in that section (or chapter).
3808 Many environments are also available unnumbered.
3809 These are indicated by an asterisk at the end.
3810 If you happen to want
3814 unnumbered results, the the module
3815 \begin_inset Flex CharStyle:Code
3818 \begin_layout Standard
3824 provides that option.
3827 \begin_layout Standard
3828 Note that these modules do not
3832 to be used with the AMS classes.
3833 It is perfectly possible to use the
3834 \begin_inset Flex CharStyle:Code
3837 \begin_layout Standard
3843 module, and the others mentioned, with other classes, such as
3844 \begin_inset Flex CharStyle:Code
3847 \begin_layout Standard
3854 \begin_inset Flex CharStyle:Code
3857 \begin_layout Standard
3864 \begin_inset Flex CharStyle:Code
3867 \begin_layout Standard
3876 \begin_layout Subsection
3877 What these layouts provide
3880 \begin_layout Standard
3881 There is a long list of included environments provided by these layouts.
3882 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3883 variety of `theorem' environments.
3884 However, the AMS recommends the environments that are available in LyX.
3888 \begin_layout Standard
3889 The following environments---as well as the standard environments, such
3891 \begin_inset Flex CharStyle:Noun
3894 \begin_layout Standard
3901 \begin_inset Flex CharStyle:Noun
3904 \begin_layout Standard
3911 \begin_inset Flex CharStyle:Noun
3914 \begin_layout Standard
3921 \begin_inset Flex CharStyle:Noun
3924 \begin_layout Standard
3931 \begin_inset Flex CharStyle:Noun
3934 \begin_layout Standard
3941 \begin_inset Flex CharStyle:Code
3944 \begin_layout Standard
3951 \begin_inset Flex CharStyle:Code
3954 \begin_layout Standard
3963 \begin_layout Description
3964 Address This should be the author's permanent address.
3967 \begin_layout Description
3968 Current\InsetSpace ~
3969 Address This should be the author's temporary address at the time
3970 of submission, if different from the Address.
3973 \begin_layout Description
3974 Email Author's e-mail address
3977 \begin_layout Description
3978 URL Author's Web address, if desired.
3981 \begin_layout Description
3982 Keywords Key words or phrases used to identify specific topics discussed
3986 \begin_layout Description
3987 Subjectclass These refer to the AMS Subject Classifications, published and
3990 Mathematical Reviews
3993 These are also available online at the AMS cites listed above.
3996 \begin_layout Description
4000 \begin_layout Description
4004 \begin_layout Description
4008 \begin_layout Standard
4009 The following environments are provided by both the
4010 \begin_inset Flex CharStyle:Code
4013 \begin_layout Standard
4020 \begin_inset Flex CharStyle:Code
4023 \begin_layout Standard
4029 modules, in the latter case in both starred (unnumbered) and unstarred
4030 (numbered) versions.
4031 These same environments are provided only in the starred versions by the
4033 \begin_inset Flex CharStyle:Code
4036 \begin_layout Standard
4045 \begin_layout Theorem
4046 This is typically used for the statements of major results.
4050 \begin_layout Corollary*
4051 This is used for statements which follow fairly directly from previous statement
4053 Again, these can be major results.
4058 These are smaller results needed to prove other statements.
4061 \begin_layout Proposition
4062 These are less major results which (hopefully) add to the general theory
4066 \begin_layout Conjecture
4067 These are statements provided without justification, which the author does
4068 not know how to prove, but which seem to be true (to the author, at least).
4071 \begin_layout Definition*
4072 Guess what this is for.
4073 The font is different for this environment than for the previous ones.
4077 \begin_layout Example*
4078 Used for examples illustrating proven results.
4081 \begin_layout Problem
4082 It's not really known what this is for.
4083 You should figure it out.
4086 \begin_layout Exercise*
4087 Write a description for this one.
4090 \begin_layout Remark
4091 This environment is also a type of theorem, usually a lesser sort of observation.
4094 \begin_layout Claim*
4095 Often used in the course of giving a proof of a larger result.
4099 Generally, these are used to break up long arguments, using specific instances
4105 The numbering scheme for cases is on its own, not together with other numbered
4111 At the end of this environment , a QED symbol (usually a square, but it
4112 can vary with different styles) is placed.
4113 If you want to have other environments within this one---for example, Case
4114 environments---and have the QED symbol appear only after them, then the
4115 other environments need to be nested within the proof environment.
4117 \begin_inset CommandInset ref
4119 reference "sec:Nesting"
4127 for information on nesting.
4130 \begin_layout Standard
4131 And these are provided by
4132 \begin_inset Flex CharStyle:Code
4135 \begin_layout Standard
4136 Theorems (AMS-Extended)
4144 \begin_layout Criterion*
4145 A required condition.
4148 \begin_layout Algorithm*
4149 A general procedure to be used.
4152 \begin_layout Axiom*
4153 This is a property or statement taken as true within the system being discussed.
4156 \begin_layout Condition*
4157 Sometimes used to state a condition assumed within the present context of
4162 Similar to a Remark.
4165 \begin_layout Notation*
4166 Used for the explanation of, yes, notation.
4169 \begin_layout Summary
4170 Do we really need to tell you?
4173 \begin_layout Acknowledgement*
4177 \begin_layout Conclusion*
4178 Sometimes used at the end of a long train of argument.
4182 Used in a way similar to Proposition, though perhaps lower on the scale.
4185 \begin_layout Standard
4186 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4188 They need to be available on your system in order to use these environments.
4191 \begin_layout Section
4195 \begin_layout Standard
4200 can be used to type letters according to German conventions.
4201 A template file is included in
4203 .../lyx/share/templates
4205 for you to use as a starting point.
4208 \begin_layout Section
4212 \begin_layout Standard
4217 provides an alternative to the standard
4222 It provides similar functionality, but you might prefer this layout with
4223 sans serif sections, headings, and more.
4226 \begin_layout Section
4230 \begin_layout Standard
4236 \begin_layout Subsection
4240 \begin_layout Standard
4241 This section describes how LyX can be used to write articles for submission
4242 to the scientific journal
4244 Astronomy and Astrophysics
4246 (www.edpsciences.fr/aa/
4247 \begin_inset Flex URL
4250 \begin_layout Standard
4252 http://www.edpsciences.fr/aa/
4257 ) using Version 5.01 of the document class
4262 This package can be downloaded from the ftp site
4265 \begin_layout Standard
4266 \begin_inset VSpace medskip
4272 \begin_layout Standard
4274 \begin_inset Flex URL
4277 \begin_layout Standard
4279 ftp://ftp.edpsciences.org/pub/aa/readme.html
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4295 A manual comes together with that package, and this text is not meant to
4296 replace the original manual but merely a short guide how to realize the
4297 correct form of your paper.
4301 \begin_layout Standard
4302 Please note that the publisher of the journal was changed from Springer
4303 to EDP Sciences starting January 1, 2001.
4304 That change implicated also some slight changes of the style files, namely
4305 the removal of the thesaurus command.
4306 The LyX class aa supports the newest version of these style files, V 5.01.
4307 If you have an older version installed, please upgrade.
4308 For compatibility, the old (version 4) layout has been kept as
4313 Please refer to the comments in
4315 LyXDir/layouts/aapaper.layout
4320 \begin_layout Subsection
4324 \begin_layout Standard
4325 It is recommended you start from the example template distributed with LyX.
4326 If you are not using a template, note the following settings:
4329 \begin_layout Itemize
4339 ocument\SpecialChar \menuseparator
4346 dialog (OK, that one was obvious).
4349 \begin_layout Itemize
4350 Don't change the option
4360 The whole layout is done by the macros, you shouldn't change anything.
4363 \begin_layout Subsection
4367 \begin_layout Standard
4368 First thing to enter is the header information.
4369 It consists of seven entries, of which some are optional.
4373 \begin_layout Itemize
4381 \begin_layout Itemize
4389 \begin_layout Itemize
4397 \begin_layout Itemize
4405 \begin_layout Itemize
4410 : [optional] if more than one author: whom to contact for offprint requests.
4413 \begin_layout Itemize
4418 : [optional] mail address for contacts.
4421 \begin_layout Itemize
4429 Received: <date>; Accepted <date>
4432 \begin_layout Standard
4433 There is no need to issue the
4439 command, this is done automatically by LyX when the header is finished.
4440 Although the order of the single header entries doesn't matter it is advised
4441 to keep the above sequence, just to get the best optics and meets the layout
4442 of the real document.
4445 \begin_layout Standard
4446 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4451 \begin_layout Standard
4460 to state your present address, just use the standard footnote via
4465 nsert\SpecialChar \menuseparator
4473 LyX will automagically use the term
4482 \begin_layout Standard
4483 In addition to these topics, the macros use three additional LaTeX commands
4484 that have no counterpart in LyX:
4487 \begin_layout Itemize
4494 to separate different names for more than one author and institute, respectivel
4498 \begin_layout Itemize
4505 to mark corresponding author/institute pairs.
4506 The institutes are numbered sequentially as they appear in the
4510 field, so you have to put a marker to each author.
4513 \begin_layout Itemize
4520 to supply an email address for fast contact.
4523 \begin_layout Standard
4524 In all cases, the appropriate command has to be entered in LyX and marked
4530 \begin_layout Subsection
4534 \begin_layout Standard
4535 The abstract should immediately follow the header block.
4536 With version 5 the abstract environment was changed to a command, and there
4537 is now a resctriction to only one paragraph.
4538 In addition, it should contain an entry with the keywords.
4539 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4546 by hand and mark it as LaTeX code.
4547 Refer to the example paper.
4550 \begin_layout Subsection
4551 Supported environments
4554 \begin_layout Standard
4555 The A&A paper layout supports the following environments for structuring
4559 \begin_layout Itemize
4565 \begin_layout Itemize
4571 \begin_layout Itemize
4577 \begin_layout Itemize
4583 \begin_layout Itemize
4589 \begin_layout Itemize
4595 \begin_layout Itemize
4601 \begin_layout Itemize
4607 \begin_layout Itemize
4613 \begin_layout Itemize
4619 \begin_layout Itemize
4625 \begin_layout Itemize
4631 \begin_layout Subsection
4632 Commands not supported by LyX
4635 \begin_layout Standard
4636 Some commands are not yet supported by the
4641 Some have already been mentioned.
4642 For the sake of completeness, they are listed all together here:
4645 \begin_layout Itemize
4653 \begin_layout Itemize
4661 \begin_layout Itemize
4669 \begin_layout Itemize
4677 \begin_layout Itemize
4685 \begin_layout Itemize
4693 \begin_layout Itemize
4701 \begin_layout Itemize
4709 \begin_layout Standard
4710 If you want to use any of these commands, you have to enter them yourself.
4713 Do not forget to mark them as LaTeX code!
4716 \begin_layout Subsection
4717 Figure and Table Floats
4720 \begin_layout Standard
4721 LyX provides support for the necessary float environments
4723 figure, figure*, table
4729 , therefore we won't tell much about it here.
4736 Just remember that tables should be left-aligned.
4737 For that, select the table and change the alignment in
4742 dit\SpecialChar \menuseparator
4747 aragraph\InsetSpace ~
4751 \begin_layout Standard
4752 There is only one special thing: the figures with caption besides the figure.
4753 To create such a figure, you have to do the following:
4756 \begin_layout Enumerate
4757 Create a wide figure float:
4762 nsert\SpecialChar \menuseparator
4767 t\SpecialChar \menuseparator
4770 , then right click in the figure and select
4781 \begin_layout Enumerate
4782 Enter your caption text.
4785 \begin_layout Enumerate
4790 to move the cursor above the caption.
4793 \begin_layout Enumerate
4797 \begin_layout Enumerate
4798 Position the cursor behind the figure and insert a horizontal fill:
4803 nsert\SpecialChar \menuseparator
4811 \SpecialChar \menuseparator
4814 orizontal\InsetSpace ~
4820 \begin_layout Enumerate
4821 Switch to LaTeX mode:
4829 \begin_layout Enumerate
4839 Do not close the brace!
4842 \begin_layout Enumerate
4843 Position the cursor behind the caption text, switch to LaTeX mode and insert
4856 \begin_layout Standard
4857 Also, refer to the figures in the example paper.
4860 \begin_layout Subsection
4864 \begin_layout Standard
4865 For submission, the paper has to be formated in a special double-spacing
4867 For this purpose, you have to give the option
4871 to the documentclass.
4872 This must be done using the extra class options field in the
4877 ocument\SpecialChar \menuseparator
4885 Just enter the string
4892 \begin_layout Subsection
4896 \begin_layout Standard
4901 directory contains an example paper written with LyX.
4902 It is the example paper from the original macro package, translated to
4904 Use it for inspiration, and compare the original LaTeX code with LyX way
4908 \begin_layout Section
4912 \begin_layout Standard
4918 \begin_layout Subsection
4922 \begin_layout Standard
4923 AASTeX is a set of macros produced by the American Astronomical Society
4924 to facilitate electronic manuscript submission to the three journals they
4925 publish: the Astrophysical Journal (including the Letters and Supplement),
4926 the Astronomical Journal, and the Publications of the Astronomical Society
4928 LyX has proven to be an excellent tool for generating these documents,
4929 especially given its equation, citation, and figure handling capabilities.
4930 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4931 is the version described here, or higher.
4932 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4933 incompatible with LyX.
4934 The AASTeX package may be downloaded from the AASTeX Web site
4937 \begin_layout Standard
4938 \begin_inset VSpace medskip
4944 \begin_layout Standard
4946 \begin_inset Flex URL
4949 \begin_layout Standard
4951 http://www.journals.uchicago.edu/AAS/AASTeX
4959 \begin_layout Standard
4960 \begin_inset VSpace medskip
4966 \begin_layout Standard
4967 A complete user guide is contained in that package and you should familiarize
4968 yourself with it thoroughly before embarking on writing a paper in LyX.
4969 LyX will not reduce the need to figure out all the AASTeX commands, it
4970 will only reduce the drudgery of typing everything in.
4971 It is your responsibility to ensure that the final exported LaTeX document
4972 conforms completely to the requirements of the journal to which you are
4973 submitting your paper.
4976 \begin_layout Subsection
4977 Starting a New Paper
4980 \begin_layout Standard
4981 I strongly suggest that you start with the AASTeX template file.
4987 ile\SpecialChar \menuseparator
4997 , enter the new file name, then choose the
5002 This will show the most common fields found in a manuscript.
5003 Simply overwrite the existing text (including the brackets,
5007 ) with the correct information.
5008 Many of the AASTeX commands and environments can be implemented directly
5009 in LyX, but some cannot: most noticeably
5021 , which should stick out like a sore thumb if you actually just opened the
5023 For commands such as these, the LaTeX code must be entered directly and
5025 Such commands are referred to as ERT, or Evil Red Text.
5026 I tried to minimize the amount of ERT needed in an AASTeX document, but
5027 there is still a bit more required than any of us would like.
5030 \begin_layout Subsection
5031 Finishing Your Paper
5034 \begin_layout Standard
5035 When the paper is finished to your satisfaction and previews/prints correctly,
5037 \begin_inset Quotes eld
5041 \begin_inset Quotes erd
5044 actions which need to be done before you submit it to the journals.
5048 \begin_layout Enumerate
5049 Export your paper as a LaTeX file (
5054 ile\SpecialChar \menuseparator
5059 xport\SpecialChar \menuseparator
5070 \begin_layout Enumerate
5075 file with your favorite text editor
5079 \begin_layout Enumerate
5080 remove the comment lines before the
5089 \begin_layout Enumerate
5094 usepackage...{fontenc}
5096 line if it appears (usually just after
5111 \begin_layout Enumerate
5112 remove everything between (and including) the
5124 commands, except for any commands you specifically put into the LaTeX preamble
5125 (which should appear immediately after the
5126 \begin_inset Quotes eld
5129 User specified LaTeX commands
5130 \begin_inset Quotes erd
5141 \begin_layout Enumerate
5142 Run the resulting file through LaTeX to make sure it still processes correctly.
5145 \begin_layout Enumerate
5146 Reread the journal requirements to make sure your filenames and formats
5150 \begin_layout Enumerate
5154 \begin_layout Subsection
5155 Comments On Specific Commands
5158 \begin_layout Standard
5159 I will not describe the detailed usage of the individual AASTeX commands:
5160 the AASTeX User Guide (
5164 ) gives a good description of each.
5165 Thus it's probably easiest for me to go down the list as found in the guide
5166 and offer comments where necessary.
5167 So let's begin \SpecialChar \ldots{}
5171 \begin_layout Subsubsection
5172 Things that work as expected
5175 \begin_layout Standard
5179 \begin_layout Standard
5191 \begin_layout Standard
5192 Because they work as you might expect, I simply list them and the section
5293 begin{thebibliography}
5301 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5302 graphicx figure commands (2.14.1),
5326 (2.15.4, amongst other places),
5353 \begin_layout Standard
5354 The following style options also work correctly:
5375 Simply put them in the
5381 Layout\SpecialChar \menuseparator
5387 \begin_layout Standard
5391 \begin_layout Standard
5403 \begin_layout Subsubsection
5404 Things that work, but require more comment
5407 \begin_layout Standard
5408 The following items work, but require a little more discussion:
5411 \begin_layout Itemize
5412 These items are reserved for use by the journal editors, but you can put
5413 them into the LaTeX preamble if you feel compelled to do so:
5446 \begin_layout Itemize
5447 These items may be placed in the LaTeX preamble, and are included as blanks
5448 in the template file:
5469 \begin_layout Itemize
5476 (2.3) -- can only be used
5477 \begin_inset Quotes eld
5481 \begin_inset Quotes erd
5484 , not in the middle of a paragraph.
5485 Use ERT if you need to embed it.
5488 \begin_layout Itemize
5495 (2.3) -- will have extra {} after it.
5496 This should not cause an error.
5499 \begin_layout Itemize
5506 (2.6) -- can only be used
5507 \begin_inset Quotes eld
5511 \begin_inset Quotes erd
5514 , not in the middle of a paragraph.
5515 Use ERT if you need to embed it.
5518 \begin_layout Itemize
5525 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5529 \begin_layout Itemize
5536 (2.8) -- same as for
5543 \begin_layout Itemize
5550 (2.9) -- will have extra {} after it.
5551 This should not cause an error.
5554 \begin_layout Itemize
5561 (2.11) -- will have extra {} after it.
5562 This should not cause an error.
5565 \begin_layout Itemize
5572 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5573 at the beginning of the text and selecting
5575 Insert\SpecialChar \menuseparator
5580 \begin_inset Quotes eld
5584 \begin_inset Quotes erd
5587 inserts an optional argument of the type needed by
5594 Hopefully it will be renamed someday.
5597 \begin_layout Itemize
5610 for the catalog ID optional parameter
5613 \begin_layout Itemize
5626 for the catalog ID optional parameter
5629 \begin_layout Subsubsection
5630 Things not implemented, use ERT
5633 \begin_layout Standard
5637 \begin_layout Standard
5649 \begin_layout Standard
5672 setcounter{equation}
5674 (2.12), Journal name abbreviations (2.13.4),
5710 (2.15.4, insert it as the first element in the lefthand cell after where
5712 Don't use any of LyX's rules in the table),
5724 (2.15.5), much of Misc (2.17, except
5775 \begin_layout Standard
5779 \begin_layout Standard
5791 \begin_layout Subsubsection
5792 Things that cannot be implemented
5795 \begin_layout Standard
5796 \SpecialChar \ldots{}
5797 at least in any meaningful sort of way, so I suggest ignoring them.
5798 They are the references environment (2.13.3), and the deluxetable environment
5800 If you really, really need to use deluxetable, I suggest editing it in
5801 a separate file with a text editor, then using
5806 nsert\SpecialChar \menuseparator
5814 to include it in your LyX document.
5819 file to see an example of this.
5822 \begin_layout Subsection
5823 FAQs, Tips, Tricks, and Other Ruminations
5826 \begin_layout Subsubsection
5827 Getting LyX and AASTeX to cooperate
5830 \begin_layout Standard
5831 It can be a bit tricky to get LyX to recognize a new layout and document
5833 When all else fails, do this:
5836 \begin_layout Enumerate
5837 Make certain that LaTeX can find AASTeX.
5838 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5839 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5846 \begin_layout Enumerate
5858 \begin_layout Enumerate
5864 ools\SpecialChar \menuseparator
5871 in LyX, then restart LyX.
5874 \begin_layout Enumerate
5875 Open a regular new file, not from a template.
5876 Does AASTeX appear in the class list in
5881 ocument\SpecialChar \menuseparator
5891 \begin_layout Standard
5892 If you get a warning from an existing AASTeX document about not being able
5893 to find the AASTeX layout or a message about
5894 \begin_inset Quotes eld
5897 You should not mix title layouts with normal ones
5898 \begin_inset Quotes erd
5901 , things haven't been installed correctly.
5904 \begin_layout Subsubsection
5905 LaTeX error processing a table
5908 \begin_layout Standard
5909 LyX, by default, attempts to center the table caption/title.
5910 This seems to produce a bad interaction in AASTeX so you should click somewhere
5911 in the caption/title, then select
5916 dit\SpecialChar \menuseparator
5921 aragraph\InsetSpace ~
5936 This took care of it for me.
5939 \begin_layout Subsubsection
5941 \begin_inset CommandInset label
5950 \begin_layout Standard
5951 A couple of things: 1) I have noticed some funny spacing in the reference
5952 entries in the text.
5953 When you enter the bibliography item data, make sure their is
5957 space between the last author and the parenthesis setting off the year;
5960 e.\InsetSpace \thinspace{}
5973 2) Entering the references at all is not obvious.
5974 The easiest thing is to start typing your first reference at the end of
5975 the document, then mark it as type
5980 That will put a small gray box in front of what you just typed.
5981 Click on the box to fill in the rest of the information.
5982 For new references, go to the end of an existing reference and press return.
5983 That will create a new line with its own box, etc.
5986 \begin_layout Subsubsection
5990 \begin_layout Standard
5991 Even though AASTeX provides its own figure commands (
5997 , for example), I much prefer LaTeX's standard figure commands (with the
6006 commands as ERT into a Figure Float box if you desire, but I never
6007 have much luck getting the layout right.
6008 With the standard graphics, LyX will insert a
6012 usepackage{graphicx}
6014 command into the LaTeX preamble and handle the figures in the standard
6015 LaTeX2e way, interspersing the figures in the text.
6016 I believe ApJ accepts figures exactly this way now; AJ might still use
6018 \begin_inset Quotes eld
6021 stack everything at the end
6022 \begin_inset Quotes erd
6028 \begin_layout Subsubsection
6029 Things I could have done, but didn't
6032 \begin_layout Standard
6034 \begin_inset Quotes eld
6038 \begin_inset Quotes erd
6041 things I could have implemented, but chose not to.
6042 For instance, I saw no point in double-spacing the text in the LyX window,
6043 even though it is double-spaced in the paper manuscript.
6044 Also, I chose not to make separate layouts for the preprint and preprint2
6046 Since I assume you will spend most of your time in the plain manuscript
6047 mode anyway, I decided not to chew up more disk space with this.
6051 \begin_layout Subsection
6055 \begin_layout Standard
6056 Your mileage may vary.
6057 I've now had papers published by both ApJ and AJ that have had 98% of the
6058 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6060 I have had no trouble with the submission process, and I'm sure the journals
6061 were never aware that there might be a difference.
6062 So, go forth and publish!
6065 \begin_layout Section
6069 \begin_layout Standard
6072 Panayotis Papasotiriou
6075 \begin_layout Subsection
6079 \begin_layout Standard
6080 The ijmpc package is a set of macros that facilitates electronic manuscript
6083 International Journal of Modern Physics C
6086 Similarly, the ijmpd package is for creating manuscripts to be submitted
6089 International Journal of Modern Physics D
6092 Both journals are published by World Scientific.
6093 The corresponding document classes are named
6102 These files, together with instructions for the authors, can be downloaded
6104 \begin_inset Flex URL
6107 \begin_layout Standard
6109 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6115 \begin_inset Flex URL
6118 \begin_layout Standard
6120 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6126 Both packages are modified versions of the standard
6127 \begin_inset Quotes eld
6131 \begin_inset Quotes erd
6134 package, and they are almost (but not exactly) identical.
6135 Most of their features are supported by LyX.
6136 I have used LyX successfully to write articles submitted to both journals
6137 without any problem.
6140 \begin_layout Subsection
6144 \begin_layout Standard
6145 As usual, the easiest way to write a paper is to start with a template.
6151 ile\SpecialChar \menuseparator
6170 This will give an (almost) empty document that includes the most common
6171 fields found in a manuscript.
6172 Simply overwrite the existing text (including the brackets,
6177 You should keep in mind the following remarks.
6180 \begin_layout Enumerate
6181 LyX won't let you change the font size and the page style of the document,
6182 because such modifications are not allowed by both packages.
6185 \begin_layout Enumerate
6186 The language of the document should not be changed.
6187 Before previewing your paper, be sure that the babel package is not used.
6188 To do this, click on
6193 ools\SpecialChar \menuseparator
6211 checkbox in the language settings, and click on
6222 , if you wish to make this change permanent).
6225 \begin_layout Enumerate
6227 \begin_inset Quotes eld
6231 \begin_inset Quotes erd
6234 style must be used to define keywords.
6237 \begin_layout Enumerate
6238 The ijmpc package provides a style named
6239 \begin_inset Quotes eld
6242 Classification Codes
6243 \begin_inset Quotes erd
6246 , which can be used to define classification codes, such as PACS numbers.
6247 Note that this facility is not supported by the ijmpd package.
6250 \begin_layout Enumerate
6251 Several new environments are available:
6252 \begin_inset Quotes eld
6256 \begin_inset Quotes erd
6260 \begin_inset Quotes eld
6264 \begin_inset Quotes erd
6268 \begin_inset Quotes eld
6272 \begin_inset Quotes erd
6276 \begin_inset Quotes eld
6280 \begin_inset Quotes erd
6284 \begin_inset Quotes eld
6288 \begin_inset Quotes erd
6292 \begin_inset Quotes eld
6296 \begin_inset Quotes erd
6300 \begin_inset Quotes eld
6304 \begin_inset Quotes erd
6308 \begin_inset Quotes eld
6312 \begin_inset Quotes erd
6316 \begin_inset Quotes eld
6320 \begin_inset Quotes erd
6324 \begin_inset Quotes eld
6328 \begin_inset Quotes erd
6332 \begin_inset Quotes eld
6336 \begin_inset Quotes erd
6340 \begin_inset Quotes eld
6344 \begin_inset Quotes erd
6348 \begin_inset Quotes eld
6352 \begin_inset Quotes erd
6356 \begin_inset Quotes eld
6360 \begin_inset Quotes erd
6364 Their use is more or less obvious.
6365 LyX supports all these environments; it will use the proper label, text
6366 style, and numbering scheme for each of them.
6369 \begin_layout Enumerate
6370 Both packages use basic citations; the natbib package should not be used.
6371 In LyX, citation references are shown as usual; in the output, citations
6372 are shown as superscripts.
6373 If you want to use a citation as normal text, you should use the
6377 command, e.\InsetSpace \thinspace{}
6379 \begin_inset Quotes eld
6382 See Ref.\InsetSpace ~
6390 \begin_inset Quotes erd
6396 \begin_layout Enumerate
6398 \begin_inset Quotes eld
6402 \begin_inset Quotes erd
6405 section in both packages.
6406 To put acknowledgments, just use the
6407 \begin_inset Quotes eld
6411 \begin_inset Quotes erd
6417 \begin_layout Enumerate
6418 Appendices may be added to the paper,
6422 the Acknowledgments and
6427 LyX provides a special environment, called
6428 \begin_inset Quotes eld
6432 \begin_inset Quotes erd
6435 which marks the beginning of the appendices.
6436 This environment should be left blank; it just sends a LaTeX command, but
6437 nothing is really printed.
6439 \begin_inset Quotes eld
6443 \begin_inset Quotes erd
6446 is printed with blue letters, as a signal that all sections after that
6447 point are appendices.
6448 To write an appendix, use the
6449 \begin_inset Quotes eld
6453 \begin_inset Quotes erd
6457 LyX will number each appendix with capital letters, as required by both
6460 \begin_inset Quotes eld
6464 \begin_inset Quotes erd
6471 be present before the first appendix; if not, all appendices will be numbered
6472 as normal sections in the output.
6475 \begin_layout Enumerate
6476 The ijmpc and the ijmpd packages use the
6480 command to implement table captions.
6481 As a result, a table created by LyX is printed correctly, but its caption
6483 However, you can use some ERT to overpass this problem, so that captions
6484 are printed as expected.
6485 To do so, create a float table as usual, remove the caption, and replace
6496 (sic); you must also the ERT
6500 immediately after the tabular material.
6501 Study the example table included in the template files to see how this
6502 trick is implemented.
6503 Alternatively, If you need table captions, you should implement the whole
6508 file, then include this file to the LyX document (
6513 nsert\SpecialChar \menuseparator
6518 \SpecialChar \menuseparator
6527 Details on how to create a table float can be found in the files
6535 , included in the corresponding packages.
6538 \begin_layout Subsection
6539 Preparing a paper for submission
6542 \begin_layout Standard
6543 Before you submit your paper you must export the LyX document as a LaTeX
6549 ile\SpecialChar \menuseparator
6554 xport\SpecialChar \menuseparator
6569 \begin_layout Standard
6570 Actually you have the choice between LaTeX (plain) and pdflatex.
6571 If you intend to use pdflatex to prepare the paper, you should use the
6572 pdflatex option so that included graphics are converted to PDF format,
6573 ready for use by pdflatex.
6578 , then make the following changes to the resulting
6585 \begin_layout Enumerate
6586 Remove the comment lines before the
6595 \begin_layout Enumerate
6596 Remove everything between (and including) the
6608 commands, except for any commands you specifically put into the LaTeX preamble.
6611 \begin_layout Standard
6616 file should be saved and processed through LaTeX as many times as necessary.
6617 You may also want to check the resulting
6624 \begin_layout Subsection
6628 \begin_layout Standard
6629 The use of ERT is reduced to two commands, which must be placed at the top
6631 If you started writing your paper by using the
6639 template, the ERT needed is already in its place; you usually don't need
6641 You may only modify the first ERT to specify the information printed to
6642 the top of odd and even pages (authors' names and short paper's title,
6644 This ERT must have the form
6648 markboth{Authors' Names}{Short Paper's Title}
6653 \begin_layout Section
6657 \begin_layout Standard
6663 \begin_layout Subsection
6667 \begin_layout Standard
6668 The iopart package provides a document class to create electronic manuscript
6669 submission to the journals published by the Institute of Physics.
6670 Instructions for the authors how to create a paper using the iopart class
6671 can be downloaded together with the iopart package from the site
6672 \begin_inset Flex URL
6675 \begin_layout Standard
6677 ftp://ftp.iop.org/pub/journals/latex2e
6685 \begin_layout Subsection
6689 \begin_layout Standard
6690 The easiest way to write a paper is to start with the file
6694 that is available in LyX's examples files folder.
6695 Open this file, save it under a new name, and start writing.
6696 The example file explains how to use the special text environments.
6697 Here are the most important advices:
6700 \begin_layout Itemize
6701 To be able to compile your document to a PDF, PS, or DVI, assure that the
6704 Use AMS math package
6706 in the document settings under
6713 \begin_layout Itemize
6716 The title environment defines the kind of your paper.
6717 So use one of the following environments for the title:
6721 \begin_layout Itemize
6730 \begin_layout Itemize
6739 \begin_layout Itemize
6745 for a Topical review
6748 \begin_layout Itemize
6757 \begin_layout Itemize
6766 \begin_layout Itemize
6772 for a Paper (same as Title)
6775 \begin_layout Itemize
6781 for a Preliminary communication
6784 \begin_layout Itemize
6790 for a Rapid communication
6793 \begin_layout Itemize
6799 for a Letter to the editor
6803 \begin_layout Itemize
6806 All title environments except of
6810 can have an optional short title.
6813 \begin_layout Itemize
6814 There is a general title environment
6818 which is not directly supported by the LyX.
6819 This can be used as ERT when your document doesn't fit into one of the
6823 \begin_layout Standard
6824 For more informations like hints for special table and formula formatting,
6825 look at the IOP author guidelines.
6828 \begin_layout Section
6832 \begin_layout Standard
6835 Panayotis Papasotiriou
6838 \begin_layout Subsection
6842 \begin_layout Standard
6843 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6844 that facilitates electronic manuscript submission to the journals they
6846 Most known of them (at least in my domain of interest) are
6848 Astrophysics and Space Science
6854 , but there are many others (see a complete list at
6855 \begin_inset Flex URL
6858 \begin_layout Standard
6860 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6866 The Kluwer package may be downloaded from the site
6867 \begin_inset Flex URL
6870 \begin_layout Standard
6872 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6878 A complete user guide is contained in that package (but it can also be
6879 downloaded separately).
6882 \begin_layout Standard
6883 LyX supports many features of the package but not everything.
6884 However, the ERT needed is reduced to some
6885 \begin_inset Quotes eld
6889 \begin_inset Quotes erd
6892 commands of the package (see\InsetSpace ~
6894 \begin_inset CommandInset ref
6896 reference "subsec:kluwer_peculiarities"
6901 I have recently used LyX to write an article submitted to the
6903 Astrophysics and Space Science
6905 without any problem.
6908 \begin_layout Subsection
6912 \begin_layout Standard
6913 The easiest way to write a paper is to start with the Kluwer template file.
6916 File\SpecialChar \menuseparator
6931 This will give an (almost) empty document that includes the most common
6932 fields found in a manuscript and a short description of their use.
6933 As in most templates, simply overwrite the existing text (including the
6938 ) with the correct information.
6941 \begin_layout Subsection
6942 Preparing a paper for submission
6945 \begin_layout Standard
6946 As in the AASTeX package, before you submit your paper to a journal you
6948 \begin_inset Quotes eld
6952 \begin_inset Quotes erd
6958 \begin_layout Enumerate
6959 Export your paper as a LaTeX file.
6960 To do this, click on
6965 ile\SpecialChar \menuseparator
6970 xport\SpecialChar \menuseparator
6981 \begin_layout Enumerate
6986 file with a text editor and make the following changes
6990 \begin_layout Enumerate
6991 remove the comment lines before the
7000 \begin_layout Enumerate
7001 remove everything between (and including) the
7013 commands, except for any commands you specifically put into the LaTeX preamble.
7016 \begin_layout Standard
7025 \begin_layout Enumerate
7030 file through LaTeX as many times as necessary (usually up to three).
7033 \begin_layout Enumerate
7038 document using, e.\InsetSpace \thinspace{}
7043 , and check if everything is OK (it should, if you didn't make any mistake).
7046 \begin_layout Subsection
7047 \begin_inset Quotes eld
7051 \begin_inset Quotes erd
7054 of the Kluwer package
7055 \begin_inset CommandInset label
7057 name "subsec:kluwer_peculiarities"
7064 \begin_layout Standard
7065 The Kluwer package has the following
7066 \begin_inset Quotes eld
7070 \begin_inset Quotes erd
7076 \begin_layout Enumerate
7077 It is possible to write multiple articles in the same LaTeX file
7081 \begin_layout Standard
7082 I can't imagine any good reason to do this.
7088 Each article must be included in the environment
7089 \begin_inset Quotes eld
7093 \begin_inset Quotes erd
7097 Unfortunately, this environment cannot be omitted, even if you write just
7099 Therefore, each article starts with the command
7105 and, obviously, ends with the command
7112 Although this can be implemented in LyX, I didn't included it, since it
7113 looks ugly and can confuse the novice user.
7114 Therefore, you need to enter them directly and mark them as LaTeX code
7116 \begin_inset Quotes eld
7120 \begin_inset Quotes erd
7126 \begin_layout Enumerate
7127 Information given at the beginning of the article (i.e., title, subtitle,
7128 author, institution, running title, running author, abstract and keywords)
7129 must be included in an environment called
7130 \begin_inset Quotes eld
7134 \begin_inset Quotes erd
7138 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
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
7263 , resp.\InsetSpace ~
7264 of the Koma-Script family.
7265 They are replacements for the standard document classes
7281 , resp., and fit better to European typography conventions in a number of
7285 \begin_layout Itemize
7286 Standard character size is 11pt in
7288 article (koma-script)
7292 report (koma-script)
7300 letter (koma-script)
7305 \begin_layout Itemize
7306 Headings, labels of the description environment, and a number of elements
7309 letter (koma-script)
7311 document class are set in a bold sans serif font.
7315 \begin_layout Standard
7316 There is a big difference between the bold sans serif old cm fonts and new
7317 ec fonts, especially in the appearance of headings.
7318 In comparison, the ec bold sans serif fonts look a bit thin.
7319 Here the LaTeX package
7327 helps to produce the
7328 \begin_inset Quotes eld
7332 \begin_inset Quotes erd
7335 appearance when using the ec fonts.
7340 The numbering of chapter headings is made in the same way as the numbering
7341 of section headings, that is without the extra line
7342 \begin_inset Quotes eld
7345 Chapter\SpecialChar \ldots{}
7347 \begin_inset Quotes erd
7351 In addition, the appearance of the headings can be modified by using a
7352 number of options (in LyX to be entered in the field
7366 ayout\SpecialChar \menuseparator
7374 A detailed German description of these options can be found in the Koma-Script
7382 \begin_layout Itemize
7383 The main means in the Koma-Script document classes to design the type area
7392 (in LyX to be entered in the extra class options field in the dialog
7397 ocument\SpecialChar \menuseparator
7405 They make a clearer modification of page margins possible as do the options
7411 ocument\SpecialChar \menuseparator
7419 A detailed German description of these and other type area options can
7420 be found in the Koma-Script documentation
7427 \begin_layout Itemize
7428 The LaTeX document classes of the Koma-Script family define a number of
7429 additional commands.
7430 Those part of it which makes sense in LyX is implemented in corresponding
7434 \begin_layout Standard
7435 A detailed German description of the LaTeX document classes of the Koma-Script
7436 family can be found in the Koma-Script documentation
7444 \begin_layout Standard
7445 There is an English translation
7449 , but it is not a complete one.
7454 The following sections describe only those aspects, which are relevant
7458 \begin_layout Subsection
7459 article (koma-script), report (koma-script), and book (koma-script)
7462 \begin_layout Standard
7463 The document classes
7465 article (koma-script)
7469 report (koma-script)
7479 are implemented in the layout files
7492 They contain all the paragraph types of the corresponding standard document
7505 , resp., partly modified, with the exception of the LyX specific
7509 -type, which is replaced by the new
7513 -type having the same functionality.
7518 -Type there is a number of new paragraph types added.
7525 letter (koma-script)
7530 \begin_layout Itemize
7539 : are equivalents to
7547 , resp., additionally inserting an entry in the table of contents.
7556 are not contained in
7558 article (koma-script)
7563 \begin_layout Itemize
7580 , resp., additionally clearing running heads.
7587 article (koma-script)
7593 \begin_layout Standard
7606 report (koma-script)
7608 , but since this is identical to
7612 , is has not been implemented in LyX.
7620 \begin_layout Itemize
7625 : generates a heading directly above the following paragraph in the standard
7626 character size without affecting the structure of the document.
7629 \begin_layout Itemize
7638 are special captions which respect the different space settings needed
7639 for captions placed above or below an element (if you follow strict typographic
7640 rules, you might want to place table captions always above the table).
7641 You can also use the class option
7658 You need at least Koma-Script version 2.8q to use this.
7661 \begin_layout Itemize
7666 : can be used to set a bonmot, e.
7670 \begin_layout Standard
7683 \begin_layout Standard
7692 at the beginning of a chapter.
7693 If you use the optional argument (
7698 nsert\SpecialChar \menuseparator
7702 ), you can insert the dictum's author there.
7703 Dictum and author are separated by a line.
7704 You need at least Koma-Script version 2.8q to use this.
7711 article (koma-script)
7716 \begin_layout Standard
7717 The following types, together with the standard types
7729 , form the title area of the document.
7730 They must be entered ahead of the first
7731 \begin_inset Quotes eld
7735 \begin_inset Quotes erd
7742 \begin_layout Standard
7743 The corresponding LaTeX commands must appear before the
7754 When such a type is used more than once, the latter usage overwrites the
7755 former one, that means, for every type only the latest usage is valid.
7756 The order of the different types however has, like
7768 , no effect on the appearance of the produced document.
7771 \begin_layout Itemize
7776 : produces a centered paragraph above the ordinary title (
7788 ) for the subject of the document.
7791 \begin_layout Itemize
7796 : produces a centered paragraph below the ordinary title (
7808 ) for the publishers' name.
7811 \begin_layout Itemize
7818 report (koma-script)
7824 produces a centered paragraph on its own page behind the title page, or
7827 article (koma-script)
7829 produces a centered paragraph below the ordinary title (
7848 \begin_layout Itemize
7853 : produces a left aligned paragraph above the ordinary title (
7869 ) for a document`s head.
7872 \begin_layout Itemize
7877 : produces in a double-sided print in
7879 report (koma-script)
7885 a left-aligned paragraph at the top of the title page`s back or has no
7886 effect in a single-sided print or in
7888 article (koma-script)
7893 \begin_layout Itemize
7898 : produces in a double-sided print in
7900 report (koma-script)
7906 a left-aligned paragraph at the bottom of the title page`s back or has
7907 no effect in a single-sided print or in
7909 article (koma-script)
7914 \begin_layout Itemize
7919 : produces a special
7920 \begin_inset Quotes eld
7924 \begin_inset Quotes erd
7927 page ahead of the actual document containing a paragraph without special
7931 \begin_layout Standard
7932 The layout files for the document classes
7934 article (koma-script)
7938 report (koma-script)
7949 This is thought of as a place to define your own types.
7954 in your personal layout directory and edit the file!
7957 \begin_layout Subsection
7958 letter (koma-script)
7961 \begin_layout Standard
7965 \begin_layout Standard
7977 \begin_layout Standard
7981 letter (koma-script)
7983 is implemented in the layout file
7988 It contains all the paragraph types of the corresponding standard document
7993 , partly modified, with the exception of the LyX specific types
8005 type, which is replaced by the new
8010 In addition, it contains, in contrast to the standard document class, the
8028 Furthermore, there are a number of new letter specific types.
8031 \begin_layout Standard
8035 \begin_layout Standard
8047 \begin_layout Standard
8048 The appearance of the letter produced by this document class can be controlled
8049 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8053 \begin_layout Standard
8054 For example, the standard appearance of the letter`s heading, consisting
8055 of name and address, is quite self-willed.
8057 \begin_inset Quotes eld
8061 \begin_inset Quotes erd
8064 heading is produced by the following LaTeX commands in the preamble:
8067 \begin_layout LyX-Code
8077 \begin_layout LyX-Code
8093 \begin_layout LyX-Code
8103 \begin_layout LyX-Code
8123 A detailed German description of such LaTeX commands can be found in the
8124 Koma-Script documentation
8129 With it, the letter's author can produce his personal letter layout.
8132 \begin_layout Standard
8141 define the beginning of the letter and must be used in every letter.
8142 To emphasize them in the LyX document class, they are marked with the letter
8151 , resp.\InsetSpace ~
8153 It is possible to write any number of letters in one file.
8158 type produces a new letter using the same addressee and a
8162 type produces a new addressee.
8179 are ordinary paragraph types and can also be used several times in one
8180 and the same letter.
8183 \begin_layout Itemize
8188 : produces a paragraph for the addressee and implicitly defines the beginning
8192 \begin_layout Itemize
8197 : produces a paragraph for the form of address and implicitly produces a
8201 \begin_layout Itemize
8206 : produces a paragraph for a close.
8209 \begin_layout Itemize
8214 : produces a paragraph for a postscript.
8217 \begin_layout Itemize
8222 : produces a paragraph for a distribution list.
8225 \begin_layout Itemize
8230 : produces a paragraph for enclosures.
8233 \begin_layout Standard
8274 are input types provided with a label to enter information, which will
8275 be processed by the document class.
8279 \begin_layout Standard
8280 It could be seen as a matter of inconsequence, that the types
8288 described above are not such input types as well.
8289 Because of the special meaning of those types, however, I have implemented
8290 them as ordinary paragraph types with a one letter mark in the left margin.
8291 Moreover, it would affect my feeling of symmetry, if the
8299 type had such a serious different appearance.
8304 The types must be used ahead of the corresponding
8311 \begin_layout Standard
8312 An implementation of these types in a WYSIWYG fashion does not seem to make
8313 sense, because the real appearance of the produced letter does not only
8314 depend on the usage of the particular type, but also on other factors.
8315 For example, a signature entered in the
8319 type will in the standard behavior appear in the produced letter only,
8320 when in the same letter also a
8325 The entered value of the
8329 type will in the standard behavior not appear in the produced letter at
8331 The possibility to design the letter`s heading freely is already indicated
8332 in a footnote above.
8335 \begin_layout Standard
8336 The input types can also be used as empty paragraphs.
8337 This makes sense e.\InsetSpace \thinspace{}
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.
8721 \begin_layout Standard
8734 \begin_layout Standard
8743 you can write several letters per document).
8744 New elements are sender's
8760 and the possibility to use a
8769 nsert\SpecialChar \menuseparator
8779 \begin_layout Standard
8780 The biggest improvement is, though, that the letter's layout is configurable
8781 at almost any needs.
8782 This can be done via the preamble or with a special style file (Letter
8783 Class Option, extension
8787 ), that will be read in as a class option.
8791 \begin_layout Standard
8792 The KOMA package comes with some default
8797 There is, for instance, a
8801 file that follows german typesetting rules, or a
8805 that provides the default layout of the old
8810 The latter can be loaded with the class option
8819 ayout\SpecialChar \menuseparator
8824 ocument\SpecialChar \menuseparator
8836 template that is included in LyX for examples.
8837 A detailed description is to be found in the Koma-Script documentation
8845 \begin_layout Subsection
8849 \begin_layout Standard
8850 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8854 \begin_layout Itemize
8855 The chapter number of a
8859 type appears on a line of its own above the chapter heading instead of
8860 appearing in the same line ahead of it.
8861 The cause for that is the LyX internal behavior for the labeltype
8868 \begin_layout Itemize
8869 The headings of the types
8878 \begin_inset Quotes eld
8882 \begin_inset Quotes erd
8885 LaTeX table of contents, but not in the LyX table of contents (
8890 ocument\SpecialChar \menuseparator
8902 \begin_layout Itemize
8907 document class appear in a skip separation mode, not indented.
8908 This is the standard behavior, no special LaTeX commands are needed for
8915 ocument\SpecialChar \menuseparator
8922 dialog the corresponding radio button indicates
8938 value always has the effect that extra LaTeX commands are inserted in the
8939 document to produce the gap, which is not what is wanted in this case.
8942 \begin_layout Section
8950 \begin_layout Standard
8956 \begin_layout Subsection
8960 \begin_layout Standard
8961 These are the layout files for some of the journal formats used by Springer
8962 Verlag and listed on
8963 \begin_inset Flex URL
8966 \begin_layout Standard
8968 http://www.springer.de/author/tex/help-journals.html
8973 , where you should also go to fetch the class files (yes, these are LaTeX2e
8975 It is a modular system: the things common to all journals are implemented
8980 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8985 for Journal of Geodesy) can include.
8988 \begin_layout Standard
8989 This means that implementing support for any other Springer journal on this
8990 list is as simple as writing your own
8998 file following the outline given in
9006 \begin_layout Standard
9007 It is reasonably well tested only for the Journal of Geodesy.
9016 come with the standard LyX distribution.
9017 Install the relevant class file (downloaded from Springer) in a proper
9018 directory, reconfigure LaTeX (in the teTeX case by running
9022 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9023 LyX and it should work.
9026 \begin_layout Subsection
9030 \begin_layout Standard
9031 A large number of theorem-like styles ---
9037 \SpecialChar \ldots{}
9043 \begin_layout Standard
9046 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9047 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9050 See the Springer class file documentation for details.
9053 \begin_layout Subsection
9057 \begin_layout Itemize
9069 \begin_layout Itemize
9072 Probability Theory and Related Fields
9078 --- Jean-Marc Lasgouttes
9081 \begin_layout Standard
9082 Add your own, it isn't so hard!
9085 \begin_layout Subsection
9089 \begin_layout Standard
9090 These files are partly based on the older
9094 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9100 layout, are now defunct.
9101 Jean-Marc Lasgouttes helped out big in making me find my way around the
9102 LyX layout file mechanism.
9105 \begin_layout Subsection
9109 \begin_layout Standard
9111 But probably less than in the old hacked-LaTeX
9118 \begin_layout Standard
9119 Limitations e.\InsetSpace \thinspace{}
9120 g.: does not display the number for theorem-like layouts, just
9124 \begin_layout Section
9132 \begin_layout Standard
9138 \begin_layout Subsection
9142 \begin_layout Standard
9143 These are the layout files for some of the journals of the American Geophysical
9145 It is assumed that you have both the AGU's own class files and AGUplus
9146 installed (everything to be found at
9147 \begin_inset Flex URL
9150 \begin_layout Standard
9152 ftp://ftp.agu.org/journals/latex/journals
9160 \begin_layout Subsection
9164 \begin_layout Standard
9174 They are still called this in the LyX GUI, though their LaTeX equivalents
9175 in the AGU classes are
9186 \begin_layout Standard
9187 Newly defined styles are
9224 These are mostly manuscript attributes and defined in the AGU class documentati
9228 \begin_layout Standard
9229 I suspect this is still badly incomplete.
9232 \begin_layout Subsection
9236 \begin_layout Standard
9253 \begin_layout Subsection
9257 \begin_layout Itemize
9260 Journal of Geophysical Research
9269 \begin_layout Standard
9270 Add your own, it isn't so hard! Look at the
9281 \begin_layout Subsection
9282 Bugs and things to remember
9285 \begin_layout Standard
9286 In order to use the new layouts, you must remember to do the following for
9290 \begin_layout Enumerate
9296 This can be done in the
9298 layout\SpecialChar \menuseparator
9303 document\SpecialChar \menuseparator
9307 (AGU articles are always in English, right? So
9314 \begin_layout Enumerate
9324 (Yes, this is a bug.)
9327 \begin_layout Enumerate
9328 Make sure you use the
9332 bibliography style, by entering
9336 into the second field of the BibTeX inset.
9337 None of the standard styles will do.
9340 \begin_layout Section
9348 \begin_layout Standard
9354 \begin_layout Subsection
9358 \begin_layout Standard
9359 This is the layout file for the European Geophysical Society journals.
9364 can be downloaded from the web site of the EGS under
9365 \begin_inset Flex URL
9368 \begin_layout Standard
9378 \begin_layout Subsection
9382 \begin_layout Standard
9385 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9393 The current layout file is unfortunately very unmodular and would benefit
9394 from using the various
9401 \begin_layout Section
9407 \begin_inset CommandInset label
9416 \begin_layout Standard
9424 \begin_layout Subsection
9428 \begin_layout Standard
9429 This section describes how to use LyX to make slides for overhead projectors.
9430 There are two document classes that can do this: the default slides class
9436 This section documents the former.
9439 \begin_layout Standard
9440 I'm going to say this again, nice and clear, so that there's no misunderstanding
9444 \begin_layout Standard
9445 \begin_inset VSpace bigskip
9451 \begin_layout Standard
9455 This section documents the class
9456 \begin_inset Quotes eld
9464 \begin_inset Quotes erd
9472 \begin_layout Standard
9473 \begin_inset VSpace bigskip
9479 \begin_layout Standard
9480 If you're looking for the documentation for
9481 \begin_inset Quotes eld
9489 \begin_inset Quotes erd
9492 , check out section\InsetSpace ~
9494 \begin_inset CommandInset ref
9496 reference "sec:foiltex"
9506 \begin_inset Quotes eld
9514 \begin_inset Quotes erd
9517 ] is actually somewhat better than the default
9525 \begin_layout Standard
9526 \SpecialChar \ldots{}
9527 or so I've been told repeatedly by its advocates.
9528 Having never used it, I have no idea if this claim is true or not.
9533 which this section documents.
9536 \begin_layout Standard
9537 This class is the LaTeX2e improvement of the old
9542 Every LaTeX2e distribution includes this class [which I'll just refer to
9544 \begin_inset Quotes eld
9552 \begin_inset Quotes erd
9555 from now on], so you're bound to have it.
9556 As I noted earlier, there are other classes, such as
9560 , which also produce slides for overhead projectors and do a better job
9562 However, there are some things which
9566 can do which the others can't, such as generate overlays.
9567 Read on to learn more!
9570 \begin_layout Subsection
9572 \begin_inset CommandInset label
9574 name "sec:slidesetup"
9581 \begin_layout Standard
9582 Obviously, to use this document class, you need to select
9583 \begin_inset Quotes eld
9591 \begin_inset Quotes erd
9594 from the class list in the
9599 ocument\SpecialChar \menuseparator
9607 There are some other special things you should know about this class:
9610 \begin_layout Itemize
9611 Don't bother changing the options
9616 They're not supported by the
9623 \begin_layout Itemize
9632 behaves a bit differently for this class.
9633 The possible choices and what they do are as follows:
9637 \begin_layout Description
9642 The final output contains page numbers in the lower right corner.
9645 \begin_layout Description
9654 , but also prints out any time markers you've put in.
9655 This is the default.
9658 \begin_layout Description
9663 The final output contains no page numbers, time markers, or alignment markers.
9667 \begin_layout Itemize
9672 class has an extra option:
9678 \begin_inset Quotes eld
9686 \begin_inset Quotes erd
9689 in the extra class options.
9693 \begin_layout Standard
9694 Using this options allows you to add time markers to
9699 See section\InsetSpace ~
9701 \begin_inset CommandInset ref
9703 reference "sec:slideNote"
9711 \begin_layout Standard
9712 You can also use the template file
9713 \begin_inset Quotes eld
9721 \begin_inset Quotes erd
9724 to automatically set up a document to use the
9733 ile\SpecialChar \menuseparator
9742 to open your new document].
9743 The template file also contains some examples of the special paragraph
9744 environments used by this class.
9745 I'll describe those next.
9748 \begin_layout Subsection
9749 Paragraph Environments
9752 \begin_layout Subsubsection
9753 Supported Environments
9756 \begin_layout Standard
9757 The first thing you'll notice when you start up a new
9761 document is the font size and type: it's the equivalent of the size
9762 \begin_inset Quotes eld
9770 \begin_inset Quotes erd
9779 This is also what's used in the output.
9781 \begin_inset Quotes eld
9785 \begin_inset Quotes erd
9788 to remind you that this is a slide.
9789 Your final slides will use a larger font; ergo, you'll have less space.
9790 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9793 \begin_layout Standard
9794 The next thing that becomes obvious is the changes to the paragraph environment
9795 pull-down box [at the far-left end of the toolbar].
9796 Most of the paragraph environments you're used to seeing are missing.
9797 There are also five new ones.
9802 class itself only supports certain paragraph environments:
9805 \begin_layout Itemize
9811 \begin_layout Itemize
9817 \begin_layout Itemize
9823 \begin_layout Itemize
9829 \begin_layout Itemize
9835 \begin_layout Itemize
9841 \begin_layout Itemize
9847 \begin_layout Itemize
9853 \begin_layout Itemize
9859 \begin_layout Itemize
9865 \begin_layout Itemize
9871 \begin_layout Standard
9872 All of the other standard environments, including the section-heading environmen
9873 ts, aren't used in the
9880 \begin_layout Standard
9881 On the other hand, you'll notice the following new environments:
9884 \begin_layout Itemize
9890 \begin_layout Itemize
9896 \begin_layout Itemize
9902 \begin_layout Itemize
9908 \begin_layout Itemize
9914 \begin_layout Standard
9915 These five are kind of quirky, due to a
9916 \begin_inset Quotes eld
9920 \begin_inset Quotes erd
9924 You see, LyX doesn't permit you to nest any other paragraph environment
9925 into an empty environment.
9926 Now, that's fine and dandy, but it means that you wouldn't be able to start
9927 a slide with anything except plain text.
9928 To deal with this, I've performed a little
9929 \begin_inset Quotes eld
9933 \begin_inset Quotes erd
9939 \begin_layout Subsubsection
9940 Quirks of the New Environments
9941 \begin_inset CommandInset label
9943 name "sec:slideQuirk"
9950 \begin_layout Standard
9951 All five of the new paragraph environments are somewhat quirky due to inherent
9952 limitiations in the current version of LyX.
9953 As I just mentioned, LyX forbids environments that begin with another environme
9955 To get around this, the
9959 environment isn't a paragraph environment as described in the
9967 \begin_layout Standard
9981 \begin_inset Quotes eld
9984 pseudo-environments.
9985 \begin_inset Quotes erd
9988 They look like a section heading or a
9989 \begin_inset Quotes eld
9997 \begin_inset Quotes erd
10000 but really begin a [and, if necessary, end the previous] paragraph environment.
10010 \begin_inset Quotes eld
10014 \begin_inset Quotes erd
10017 These two perform some action.
10020 \begin_layout Standard
10021 A common feature of all five environments,
10041 , is a rather long-ish label.
10042 The text following this label --- ordinarily the contents of the paragraph
10043 environment --- is utterly irrelevant for
10064 LyX completely ignores it.
10065 In fact, you can leave these five environments completely empty.
10069 \begin_layout Standard
10074 to put any text after the rather long-ish label, you might want to.
10075 This could be a short description of the contents of the
10080 In that case, enter in your descriptive comment and hit
10084 as you normally would.
10087 \begin_layout Standard
10088 If, on the other hand, you don't want to enter in any descriptive text,
10089 you'll hit another LyX quirk.
10090 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10091 environment until you put something in the old one.
10095 \begin_layout Itemize
10096 Start entering the text that will
10124 \begin_layout Itemize
10125 Now move to the beginning of that paragraph.
10129 \begin_layout Itemize
10138 \begin_layout Itemize
10139 Finally, change this new, empty paragraph to a
10163 \begin_layout Standard
10164 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10168 \begin_layout Subsection
10169 Making a Presentation with
10182 \begin_layout Subsubsection
10190 \begin_layout Standard
10191 If you're expecting this section to teach you how to actually make a presentatio
10192 n, you'll be sorely disappointed.
10193 Naturally, I'll describe all of the ways the
10197 class can assist you in preparing the materials for a presentation.
10198 Filling in the contents, however, is up to you.
10203 the LyX philosophy.]
10206 \begin_layout Standard
10211 environment [in the manner described in section\InsetSpace ~
10213 \begin_inset CommandInset ref
10215 reference "sec:slideQuirk"
10219 ] tells LyX to begin a new slide [duh].
10220 The label for this environment/
10221 \begin_inset Quotes erd
10225 \begin_inset Quotes erd
10229 \begin_inset Quotes eld
10233 \begin_inset Quotes erd
10236 in cool blue, followed by the label,
10237 \begin_inset Quotes eld
10241 \begin_inset Quotes erd
10245 Any text or paragraph environments that follow this one go on the new slide.
10249 \begin_layout Standard
10250 Slides are probably the only time you'll need to forcibly end pages in LyX
10251 (this can be specified in the
10256 In fact, you'll want to, once you finish entering the contents of one slide.
10257 If you've entered more text than can physically fit on a slide, the extra
10258 overflows onto a new slide.
10259 I don't recommend doing this, however, since the overflow slide won't have
10260 any page number on it.
10261 Furthermore, it may interfere with any
10265 you've made to accompany the oversized
10272 \begin_layout Standard
10281 environments work the same way as the
10286 They both create an
10287 \begin_inset Quotes eld
10291 \begin_inset Quotes erd
10294 followed by a label [
10295 \begin_inset Quotes eld
10299 \begin_inset Quotes erd
10303 \begin_inset Quotes eld
10307 \begin_inset Quotes erd
10311 The color is a stunning magenta instead of blue, and the
10312 \begin_inset Quotes eld
10316 \begin_inset Quotes erd
10319 will look different, in style and in length.
10320 The label fonts of all three also differ from one another.
10323 \begin_layout Standard
10328 , if the contents of a
10336 exceed the physical size of a slide or sheet of paper, the extra will overflow
10338 Again, you should avoid this.
10339 It defeats the whole purpose of
10350 \begin_layout Subsubsection
10360 \begin_layout Standard
10365 is a slide that sits atop another slide.
10366 Perhaps you wish to discuss a figure on the main
10370 before displaying the text associated with it.
10371 One way to accomplish this is tape a flap of dark paper over the part of
10376 you want to display later.
10377 This method fails, however, if you wish to overlap one graph with another,
10379 You would then have to fumble while speaking to align the two separate,
10384 s to align the two graphs.
10389 environment in both cases makes life much easier.
10392 \begin_layout Standard
10397 receives the page number of its
10398 \begin_inset Quotes eld
10402 \begin_inset Quotes erd
10410 \begin_inset Quotes eld
10418 \begin_inset Quotes erd
10425 \begin_layout Standard
10426 Presumably, mutliple
10431 \begin_inset Quotes eld
10439 \begin_inset Quotes erd
10443 \begin_inset Quotes eld
10451 \begin_inset Quotes erd
10455 \begin_inset Quotes eld
10463 \begin_inset Quotes erd
10466 , etc.\InsetSpace ~
10467 appended to the page number of the parent
10477 Clearly, you want the contents of both the
10485 to each fit on a single physical slide! You should probably consider an
10491 \begin_inset Quotes eld
10495 \begin_inset Quotes erd
10507 class provides a visual cue for this: the label at the start of an
10511 is shorter than that at the start of a
10516 Lastly, when you generate printable output, you'll find alignment markers
10517 in all four corners of both the
10521 page and its parent
10526 These will assist you in lining up the two physical slides.
10529 \begin_layout Standard
10530 The major problem in overlaying two slides is aligning the contents of the
10531 two transparencies.
10532 How much space should you leave for that graph on the second slide? Worse
10533 still, what if you want a graph and a sentence on second slide, but there
10534 is text on the main transparency that goes in between them? You could try
10535 and insert vertical space of the right size.
10536 The better way is to use
10547 \begin_layout Standard
10548 As their names imply,
10556 are two command-like paragraph environments that make all subsequent text
10557 invisible and visible, respectively.
10558 Note from section\InsetSpace ~
10560 \begin_inset CommandInset ref
10562 reference "sec:slideQuirk"
10566 that you don't place anything
10570 these two environments, however.
10575 , it inserts a centered, sky-blue label into the page reading
10576 \begin_inset Quotes eld
10579 <Invisible Text Follows>
10580 \begin_inset Quotes erd
10584 For paragraphs following this label, the parts of the
10592 ; it doesn't matter which] where they would be contain instead blank space.
10596 \begin_layout Standard
10601 , the corresponding centered label is
10602 \begin_inset Quotes eld
10605 <Visible Text Follows>
10606 \begin_inset Quotes erd
10610 Paragraphs following this label behave normally.
10611 Note that the beginning of a new
10623 automatically shuts off an
10628 It's therefore not necessary to use
10639 \begin_layout Standard
10640 By now, it should be obvious how to create overlay transparencies using
10641 the proper combination of
10660 \begin_layout Enumerate
10665 , including everything that will appear on it, whether on the main slide
10673 \begin_layout Enumerate
10674 Before each figure or paragraph that will appear only on the
10683 If necessary, insert a
10687 environment after the
10694 \begin_layout Enumerate
10699 immediately following the
10706 \begin_layout Enumerate
10707 Copy the contents of this
10718 \begin_layout Enumerate
10723 , change all of the
10734 \begin_layout Standard
10736 You've just made an
10743 \begin_layout Standard
10744 There's one problem with the way I've designed the LyX
10748 class: you can't make text in the middle of a paragraph invisible, nor
10749 make text in the middle of an invisible paragraph visible again.
10750 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10754 \begin_layout Standard
10755 The commands of interest are:
10758 \begin_layout Itemize
10763 invisible \SpecialChar \ldots{}
10767 \begin_layout Itemize
10772 visible \SpecialChar \ldots{}
10776 \begin_layout Standard
10777 \SpecialChar \ldots{}
10778 and need to be marked as TeX.
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10787 you wish to change goes in between the brackets [and after the
10800 If you don't know how to mark text as TeX, see the appropriate section
10813 \begin_layout Subsubsection
10823 \begin_inset CommandInset label
10825 name "sec:slideNote"
10832 \begin_layout Standard
10841 is associated with a
10842 \begin_inset Quotes eld
10846 \begin_inset Quotes erd
10858 class provides visual cues.
10863 is shorter than that of a
10867 [yet longer than that of an
10871 ] and, like the label of an
10875 is shockingly magenta.
10876 Additionally, the printed
10880 has the page number of its
10881 \begin_inset Quotes eld
10885 \begin_inset Quotes erd
10893 \begin_inset Quotes eld
10901 \begin_inset Quotes erd
10905 \begin_inset Quotes eld
10913 \begin_inset Quotes erd
10917 \begin_inset Quotes eld
10925 \begin_inset Quotes erd
10929 You can have multiple
10933 s associated with a single
10945 , you'll probably want to break up long
10949 s so that they fit on a single sheet of paper.
10952 \begin_layout Standard
10957 is obvious: it contains anything additional you might want to say about
10963 It could also be used as a sheet of reminders for a particular
10968 In the case of the latter, you might want to make use of time markers.
10974 \begin_inset Quotes eld
10978 \begin_inset Quotes erd
10981 support for time markers, a
10986 So, you'll have to resort to using the LaTeX codes.
10989 \begin_layout Standard
10990 To use time markers, you'll need to specify the extra class option
10991 \begin_inset Quotes eld
10999 \begin_inset Quotes erd
11002 [see section\InsetSpace ~
11004 \begin_inset CommandInset ref
11006 reference "sec:slidesetup"
11011 This option turns on timing marks, which will appear in the lower-left-hand
11017 To set what appears in the time marker, you use the LaTeX commands
11018 \begin_inset Quotes eld
11028 \begin_inset Quotes erd
11032 \begin_inset Quotes eld
11042 \begin_inset Quotes erd
11046 The arguments of both commands are time measured in seconds.
11048 \begin_inset Quotes eld
11058 \begin_inset Quotes erd
11061 sets the time marker to a given time.
11063 \begin_inset Quotes eld
11073 \begin_inset Quotes erd
11076 increments the time marker by the specified amount.
11077 Using time markers and
11081 s in this fashion, you can remind yourself how much time to spend on a particula
11089 \begin_layout Standard
11090 There's one last feature to describe.
11091 Clearly, you'd like to print out all of your
11099 s on transparencies while printing all of your
11116 with which it is associated.
11117 What's a person to do?
11120 \begin_layout Standard
11121 Luckily, there are two LaTeX commands that allow you to select what to print
11123 Both must be placed into the preamble of your document.
11125 \begin_inset Quotes eld
11137 \begin_inset Quotes erd
11140 will cause the output to contain only the
11149 Correspondingly, the command
11150 \begin_inset Quotes eld
11162 \begin_inset Quotes erd
11165 prevents the output of anything but
11170 I'd advise placing both commands in the preamble and initially comment
11172 You can then preview your entire presentation as you write.
11173 When you're done writing, you can then uncomment one of the two to select
11174 what you want to print.
11175 I like to uncomment
11176 \begin_inset Quotes eld
11188 \begin_inset Quotes erd
11191 , print to a file with
11192 \begin_inset Quotes eld
11200 \begin_inset Quotes erd
11203 in its name, comment it back out, then uncomment
11204 \begin_inset Quotes eld
11216 \begin_inset Quotes erd
11220 \begin_inset Quotes eld
11228 \begin_inset Quotes erd
11232 I can then send either file to a printer, loading transparencies or plain
11233 paper as appropriate.
11236 \begin_layout Standard
11237 You can also provide other arguments to the
11238 \begin_inset Quotes eld
11248 \begin_inset Quotes erd
11252 \begin_inset Quotes eld
11262 \begin_inset Quotes erd
11266 See a good LaTeX book for details.
11269 \begin_layout Subsection
11274 Class Template File
11277 \begin_layout Standard
11278 I have also provided a template file,
11279 \begin_inset Quotes eld
11287 \begin_inset Quotes erd
11295 To use it, begin your new presentation with
11300 ile\SpecialChar \menuseparator
11310 Your new LyX presentation file will contain an example
11331 additionally contain an example of the use of
11340 Lastly, the preamble will contain:
11343 \begin_layout LyX-Code
11344 % Uncomment to print out only slides and overlays
11347 \begin_layout LyX-Code
11351 \begin_layout LyX-Code
11361 \begin_layout LyX-Code
11362 % Uncomment to print out only notes
11365 \begin_layout LyX-Code
11369 \begin_layout LyX-Code
11377 \begin_layout Standard
11378 One final thing: I created this class to support the LaTeX2e
11379 \begin_inset Quotes eld
11387 \begin_inset Quotes erd
11390 class, one of the built-in LaTeX2e classes.
11391 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11392 built-in slide class.
11393 It's here if you want it or need it.
11394 There exist other LaTeX2e classes for creating presentations, such as the
11399 class [see section\InsetSpace ~
11401 \begin_inset CommandInset ref
11403 reference "sec:foiltex"
11408 \begin_inset Quotes eld
11416 \begin_inset Quotes erd
11419 package [present on some TeX distributions].
11420 The latter is not yet supported under LyX.
11424 \begin_layout Standard
11425 Perhaps you can take on the task\SpecialChar \ldots{}
11431 I know nothing about these other classes.
11432 Try them out to see what sort of alternative they provide.
11435 \begin_layout Section
11444 \begin_inset CommandInset label
11453 \begin_layout Standard
11459 \begin_layout Subsection
11463 \begin_layout Standard
11464 This section describes how to use LyX to make slides for overhead projectors.
11465 There are two document classes that can do this: the default slides class
11471 This section documents the latter.
11474 \begin_layout Standard
11475 I'm going to say this again, nice and clear, so that there's no misunderstanding
11479 \begin_layout Standard
11480 \begin_inset VSpace bigskip
11486 \begin_layout Standard
11490 This section documents the class
11491 \begin_inset Quotes eld
11499 \begin_inset Quotes erd
11507 \begin_layout Standard
11508 \begin_inset VSpace bigskip
11514 \begin_layout Standard
11515 If you're looking for the documentation for
11516 \begin_inset Quotes eld
11524 \begin_inset Quotes erd
11527 , check out section\InsetSpace ~
11529 \begin_inset CommandInset ref
11531 reference "sec:slitex"
11536 If your machine doesn't have the
11541 \begin_inset Quotes eld
11549 \begin_inset Quotes erd
11552 ] installed, you'll probably have to use the default
11556 class, which isn't quite as good as
11561 \begin_layout Standard
11566 class is designed for use with version 2.1 of the
11570 LaTeX class file which is now an integral part of LaTeX2e.
11573 \begin_layout Subsection
11577 \begin_layout Standard
11578 Obviously, to use this document class, you need to select
11579 \begin_inset Quotes eld
11587 \begin_inset Quotes erd
11599 Document\InsetSpace ~
11603 There are some settings in the
11605 Document\InsetSpace ~
11608 dialog that you should know about that are specific to this class:
11611 \begin_layout Itemize
11612 Don't change the options
11622 Document\InsetSpace ~
11626 They're ignored by the
11633 \begin_layout Itemize
11634 The default font size is 20pt with the other options being 17pt, 25pt and
11638 \begin_layout Itemize
11639 The default font is
11647 but all math equations are still typeset in the usual roman font.
11650 \begin_layout Itemize
11655 TeX supports A4 and Letter paper sizes as well as a special size for working
11657 It doesn't support A5, B5, legal or executive paper sizes.
11660 \begin_layout Itemize
11661 Don't bother changing the
11665 settings because they are ignored anyway.
11666 All floats appear where they are defined in the text.
11669 \begin_layout Itemize
11677 setting behaves a bit differently for this class.
11682 TeX provides extensive footer and header capabilities including a user-defined
11684 See section\InsetSpace ~
11686 \begin_inset CommandInset ref
11688 reference "sec:foilfoot"
11693 The title page is treated differently to all other pages in the document
11702 has the logo centered at the bottom of the page (if one is defined).
11703 The possible page style choices and what they do are as follows:
11708 \labelwidthstring MMMMMMM
11715 The final output contains no page numbers, or other headers or footers
11716 (except footnotes of course).
11721 \labelwidthstring MMMMMMM
11728 The final output contains page numbers centered at the bottom of the page.
11729 No other headings or footers (other than footnotes).
11733 \labelwidthstring MMMMMMM
11738 Page numbers in lower right corner.
11739 Additional headers and footers are also shown.
11740 This is also the default.
11744 \labelwidthstring MMMMMMM
11749 Gives you access to the
11753 package although its use with
11757 TeX is discouraged by the writer of the
11761 TeX package because of some potential page layout clashes.
11765 \begin_layout Subsubsection
11769 \begin_layout Standard
11770 The following options may be used in the extra class options in the
11775 ocument\SpecialChar \menuseparator
11786 \labelwidthstring MMMMMMx
11791 This sets up the page layout for 7.33in by 11in paper, which is about the
11792 same aspect ratio as a 35mm slide, making it a bit easier to work with
11797 \labelwidthstring MMMMMMx
11802 Places a rule across the page below the header on every page except the
11807 \labelwidthstring MMMMMMx
11812 Places a rule across the page above the footer on every page except the
11817 \labelwidthstring MMMMMMx
11822 This is automatically set each time you create a new
11831 TeX to use the dvips driver to rotate those pages that are set as landscape
11836 \labelwidthstring MMMMMMx
11841 Simply changes the page dimensions to those of a landscape page but doesn't
11843 Thus if you use this option you need to use an external program to rotate
11844 each page or feed your paper through your printer as landscape.
11845 Note that this option effectively reverses the roles of the
11853 environments (don't worry these are described in the next section).
11857 \labelwidthstring MMMMMMx
11862 Equation numbers on the left.
11866 \labelwidthstring MMMMMMx
11871 Flush-left equations.
11874 \begin_layout Subsection
11875 Supported Environments
11878 \begin_layout Standard
11879 Most of the environments commonly supported in other classes are also supported
11885 There are several additional environments provided by
11889 TeX as well as a couple added by LyX.
11890 The following environments are shared with other classes:
11893 \begin_layout Standard
11897 \begin_layout Standard
11901 begin{multicols}{2}
11909 \begin_layout Itemize
11915 \begin_layout Itemize
11921 \begin_layout Itemize
11927 \begin_layout Itemize
11933 \begin_layout Itemize
11939 \begin_layout Itemize
11945 \begin_layout Itemize
11951 \begin_layout Itemize
11957 \begin_layout Itemize
11963 \begin_layout Itemize
11969 \begin_layout Itemize
11975 \begin_layout Itemize
11981 \begin_layout Itemize
11987 \begin_layout Itemize
11993 \begin_layout Itemize
11999 \begin_layout Itemize
12005 \begin_layout Itemize
12011 \begin_layout Itemize
12017 \begin_layout Standard
12021 \begin_layout Standard
12033 \begin_layout Standard
12034 That is, all the major environments apart from the sectioning environments.
12035 Since foils are essentially self-contained sections, with a title and body,
12040 TeX provides specific commands for starting new foils and these are:
12043 \begin_layout Itemize
12049 \begin_layout Itemize
12055 \begin_layout Standard
12056 LyX also provides slightly modified versions of these two environments called:
12059 \begin_layout Itemize
12065 \begin_layout Itemize
12068 ShortRotatefoilhead
12071 \begin_layout Standard
12072 and the differences will be explained in the next section.
12075 \begin_layout Standard
12076 Since foils are often used in presenting ideas or new theorems and such
12081 TeX also provides a comprehensive box of goodies for presenting them:
12084 \begin_layout Standard
12088 \begin_layout Standard
12092 begin{multicols}{2}
12100 \begin_layout Itemize
12106 \begin_layout Itemize
12112 \begin_layout Itemize
12118 \begin_layout Itemize
12124 \begin_layout Itemize
12130 \begin_layout Itemize
12136 \begin_layout Itemize
12142 \begin_layout Itemize
12148 \begin_layout Itemize
12154 \begin_layout Itemize
12160 \begin_layout Itemize
12166 \begin_layout Standard
12170 \begin_layout Standard
12182 \begin_layout Standard
12183 The starred versions are unnumbered while the unstarred versions are numbered.
12184 There are also two list environments added by LyX and these are:
12187 \begin_layout Itemize
12193 \begin_layout Itemize
12199 \begin_layout Standard
12204 TeX provides some powerful header and footer capabilities that are best
12205 set in the preamble although they may be set at any point in a document.
12206 If you want to change these settings in your document the best place to
12207 do so is at the very top of a foil,
12212 straight after the foilhead.
12215 \begin_layout Standard
12216 For this purpose, the following command styles are provided [
12223 \begin_layout Standard
12227 \begin_layout Standard
12231 begin{multicols}{2}
12239 \begin_layout Itemize
12246 \begin_layout Itemize
12252 \begin_layout Itemize
12259 \begin_layout Itemize
12266 \begin_layout Itemize
12274 \begin_layout Standard
12280 \begin_layout Standard
12284 \begin_layout Standard
12296 \begin_layout Standard
12297 There are also a few commands provided by
12301 TeX that aren't directly supported by LyX but I'll tell you what they do
12302 and how to use them in section\InsetSpace ~
12304 \begin_inset CommandInset ref
12306 reference "sec:unsuppfoils"
12313 \begin_layout Subsection
12314 Building a Set of Foils
12317 \begin_layout Standard
12318 This section will give a simple introduction to using the different environments
12319 to build a set of foils.
12320 If you want to see an example set of foils take a look at the
12324 file accessible from the
12329 ile\SpecialChar \menuseparator
12334 pen\SpecialChar \ldots{}
12345 \begin_layout Subsubsection
12346 Give It a Title Page
12349 \begin_layout Standard
12350 Unlike other classes that provide
12370 creates the title on a page of its own.
12371 If you leave out the
12375 environment LaTeX will substitute the current date (every time you regenerate
12379 \begin_layout Subsubsection
12383 \begin_layout Standard
12384 As I mentioned earlier, there are four ways of starting a new foil.
12385 For portrait foils you should use
12394 The difference between these two environments is the amount of space between
12395 the title of the foil (the foilhead) and the body of the foil.
12398 \begin_layout Standard
12399 Landscape foils are generated using the
12405 ShortRotatefoilhead
12408 Again the only difference is the spacing between foilhead and body.
12409 Both of the short versions have 0.5 inches less separation between the foilhead
12414 \begin_layout Standard
12415 One problem with the support for landscape foils is the requirement that
12416 you have to use the
12420 driver to generate the PostScript output otherwise the foils won't be rotated.
12421 It is possible to get landscape foils even if you haven't got the
12425 driver provided you can feed your foils sideways through your printer ;-)
12428 \begin_layout Subsubsection
12429 Theorems, Lemmas, Proofs and more
12432 \begin_layout Standard
12433 Due to a small bug in LyX you can't have two of the same type of these environme
12434 nts directly following each other.
12435 They must be separated by something.
12436 If you try, you will just be extending the previous environment as if you
12437 had merged the two environments together.
12438 So, how do you get around this problem? The simplest option is to insert
12439 some text between the two environments or add a
12443 environment between the two with just a
12444 \begin_inset Quotes eld
12452 \begin_inset Quotes erd
12456 This will force LyX to produce two separate environments and hence the
12457 correct LaTeX output.
12458 An example is provided in the example file included with the LyX distribution.
12459 Remember, this problem only occurs if you are trying to place two of the
12460 same type of theorem-like environments one directly after the other.
12463 \begin_layout Subsubsection
12467 \begin_layout Standard
12468 You get all the commonly supported list styles found in other classes as
12469 well as two new ones.
12470 I'll only describe the new ones here.
12471 If you want to find out more about the other list environments check out
12477 If you intend to use itemized lists you might also want to read about the
12480 Itemize\InsetSpace ~
12481 Bullet\InsetSpace ~
12484 dialog described above in section\InsetSpace ~
12486 \begin_inset CommandInset ref
12488 reference "sec:bullet"
12495 \begin_layout Standard
12496 The two new list styles,
12504 , are designed to make it easier for you to create lists of do's and don'ts
12505 or right and wrong by providing dedicated environments that use a tick
12506 or a cross as the label of the list.
12507 These lists are in fact dedicated variants of the
12512 They do however require that you have the
12516 packages installed.
12519 \begin_layout Subsubsection
12523 \begin_layout Standard
12528 TeX redefines the floating tables and figures so that they appear exactly
12529 where they are in the text rather than pushing them to the top of the page
12530 or to some user specified location.
12531 In fact if you change the float placement settings they are simply ignored.
12534 \begin_layout Subsubsection
12535 Page Headers and Footers
12536 \begin_inset CommandInset label
12538 name "sec:foilfoot"
12545 \begin_layout Standard
12555 are two commands used to control the left-footer text string.
12556 The first is meant to allow you to include a graphic logo on your foils
12558 \begin_inset Quotes eld
12566 \begin_inset Quotes erd
12570 While the second is meant to provide a classification for the audience,
12573 e.\InsetSpace \thinspace{}
12578 It is empty by default.
12581 \begin_layout Standard
12582 The remaining page corners can be filled by
12587 (which defaults to page numbers),
12600 \begin_layout Subsection
12606 \begin_inset CommandInset label
12608 name "sec:unsuppfoils"
12615 \begin_layout Standard
12616 All the commands mentioned below need to be set in a
12624 within another environment.
12627 \begin_layout Subsubsection
12631 \begin_layout Standard
12632 All lengths are adjusted using the
12655 should be replaced by the name given to the length you want to change and
12660 is the length value.
12661 All lengths should be specified in units of length such as inches (
12673 ) or relative to some document or font-based length such as
12683 \begin_layout Standard
12684 It's possible to change the spacing between a foilhead and the body of the
12685 foil by adjusting the length specified by
12692 For example, to make
12696 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12703 foilheadskip}{-0.5in}
12706 \begin_layout Standard
12707 The spacings around floats can be adjusted by setting these lengths:
12711 \labelwidthstring MMMMMMMMMMM
12718 Separation between the text and the top of the float
12722 \labelwidthstring MMMMMMMMMMM
12729 Separation between the float and the caption
12733 \labelwidthstring MMMMMMMMMMM
12740 Separation between the caption and the following text
12744 \labelwidthstring MMMMMMMMMMM
12751 You can make the captions narrower than the surrounding text by adjusting
12753 Best done relative to
12762 \begin_layout Standard
12763 There are also several title page related lengths that you may find useful
12764 if you have a long title or several authors:
12768 \labelwidthstring MMMMMMMMMMM
12775 Separation from headers to
12781 \labelwidthstring MMMMMMMMMMM
12800 \labelwidthstring MMMMMMMMMMM
12815 \labelwidthstring MMMMMMMMMMM
12832 \labelwidthstring MMMMMMMMMMM
12848 \begin_layout Standard
12849 The last length related command affects all the list environments.
12860 a list environment then all the vertical spacing between the list items
12862 Note that this is a command not a length so it doesn't require
12868 like the stuff mentioned above.
12871 \begin_layout Subsubsection
12872 Headers and Footers
12875 \begin_layout Standard
12888 commands control whether the logo in the
12892 definition appear on a given page.
12899 in the preamble then none of the foils will have the logo on them.
12900 If you don't want the logo on a particular page place the
12906 directly after the foilhead of that page and the
12912 directly after the next foilhead.
12915 \begin_layout Standard
12916 If you decide to use the
12920 page style setting in the
12922 Document\InsetSpace ~
12925 dialog you should probably add
12935 to your preamble so headers and footers on landscape pages are correctly
12936 placed when rotated.
12937 This is due to some clashes between the page layouts provided by the
12948 \begin_layout Section
12949 Latex8 (IEEE Conference Papers)
12952 \begin_layout Standard
12958 \begin_layout Subsection
12962 \begin_layout Standard
12963 Since this class is specifically for writing submissions to IEEE sponsored
12964 conferences I strongly recommend that you get a copy of their Authors Kit.
12969 package and associated bibliography style file is included in the kit.
12970 The Authors Kit is usually sent out by email once your initial submission
12972 There is a lot of useful information in the Authors Kit explaining formatting
12973 restrictions and so on and I will assume you have read this since that
12974 means I don't have to repeat it all here.
12977 \begin_layout Subsection
12981 \begin_layout Standard
12982 [AR\SpecialChar \@.
12986 \begin_layout Subsection
12987 Supported Environments
12990 \begin_layout Itemize
12996 \begin_layout Itemize
13002 \begin_layout Itemize
13008 \begin_layout Itemize
13014 \begin_layout Itemize
13020 \begin_layout Itemize
13026 \begin_layout Itemize
13032 \begin_layout Itemize
13038 \begin_layout Itemize
13044 \begin_layout Subsection
13045 Differences Between Screen and Paper
13048 \begin_layout Standard
13049 There are slight differences in appearance mainly with the presentation
13050 of section counters.
13051 On screen the trailing period of the section counter is missing but it
13052 will appear in the output so don't let this worry you.
13055 \begin_layout Section
13056 Hollywood (Hollywood spec scripts)
13059 \begin_layout Standard
13065 \begin_layout Subsection
13069 \begin_layout Standard
13070 Getting the format of a Hollywood script right is a
13071 \begin_inset Quotes eld
13075 \begin_inset Quotes erd
13078 It is designed to make the readers focus on content and to be easy and
13079 familiar for the actors to read.
13080 Each page of a script should be one minute of film.
13081 Nothing goes in a script that you cannot see or hear on screen.
13082 The courier 12 pt font should be used throughout.
13086 \begin_layout Subsection
13090 \begin_layout Standard
13091 Speakers' lines should NEVER break in mid-sentence.
13092 If a speaker's lines continue over a page break, repeat the
13096 title followed by (Cont'd).
13099 \begin_layout Subsection
13103 \begin_layout Standard
13108 names as labels then cross-reference the label to insert the name.
13109 The cross-reference dialog will show the current cast of characters.
13110 You can use this to insert the speaker name in narratives also.
13113 \begin_layout Subsection
13114 Paper size and Margins
13117 \begin_layout Standard
13118 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13121 \begin_layout Subsection
13125 \begin_layout Standard
13126 The following environments are available.
13127 You can use hollywood.bind to get the bind keys shown at the right.
13130 \begin_layout Itemize
13137 Used where nothing else works.
13141 \begin_layout Itemize
13154 Usually followed by something like
13155 \begin_inset Quotes eld
13158 on Sally waking up.
13159 \begin_inset Quotes erd
13165 \begin_layout Itemize
13174 Introduces a new INTERIOR camera set-up.
13175 Always followed by DAY or NIGHT, or something similar to define the lighting
13177 Everthing on this line in CAPS.
13180 \begin_layout Itemize
13189 Introduces a new EXTERIOR camera set-up.
13190 Everthing on this line in CAPS.
13193 \begin_layout Itemize
13202 The character speaking.
13205 \begin_layout Itemize
13214 Instructions to the speaker.
13215 The () are automatically inserted, but only the ( will show in LyX.
13216 Both will be printed.
13219 \begin_layout Itemize
13235 \begin_layout Itemize
13244 Camera movement instruction.
13245 e.\InsetSpace \thinspace{}
13250 \begin_layout Itemize
13258 \begin_layout Itemize
13266 \begin_layout Itemize
13274 \begin_layout Itemize
13282 \begin_layout Subsection
13286 \begin_layout Itemize
13287 (O.S) --- off screen
13290 \begin_layout Itemize
13291 (V.0) --- voice over
13294 \begin_layout Itemize
13299 \begin_layout Itemize
13304 \begin_layout Itemize
13305 PAN --- camera movement
13308 \begin_layout Itemize
13309 INSERT --- cut to close-up of
13312 \begin_layout Section
13316 \begin_layout Standard
13322 \begin_layout Subsection
13326 \begin_layout Standard
13327 Broadway is for writing plays.
13328 The format is more decorative than Hollywood, and much less standardized.
13329 This format should be suitable for workshops.
13332 \begin_layout Subsection
13336 \begin_layout Standard
13337 The same as in Hollywood.
13340 \begin_layout Subsection
13344 \begin_layout Standard
13349 names as labels then cross-reference the label to insert the name.
13350 The cross-reference dialog will show the current cast of characters.
13353 \begin_layout Subsection
13354 Paper size and Margins
13357 \begin_layout Standard
13358 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13361 \begin_layout Subsection
13365 \begin_layout Standard
13366 The following environments are available.
13367 You can use broadway.bind to get the bind keys shown at the right.
13370 \begin_layout Itemize
13377 You should not have to use this, but it is here for anything that does not
13381 \begin_layout Itemize
13390 Used to describe stage setting and the action.
13391 First use of speaker names in all CAPs.
13394 \begin_layout Itemize
13403 Automatically numbered.
13404 On screen it will be arabic, but will print as Roman.
13407 \begin_layout Itemize
13421 It is just centered text.
13424 \begin_layout Itemize
13433 Not automatically numbered.
13434 You supply the number.
13435 This is because I couldn't figure out how.
13438 \begin_layout Itemize
13447 A special case of Narrative to describe the setting and action as the curtain
13451 \begin_layout Itemize
13460 The speaker's (actor's) title, centered in all CAPS.
13463 \begin_layout Itemize
13472 Instructions to the speaker.
13473 The parentheses are automatically inserted.
13474 The ( will appear on screen, but both will be in the printed play.
13475 This environment is only used within
13482 \begin_layout Itemize
13491 What the Speaker says.
13494 \begin_layout Itemize
13503 The curtain comes down.
13506 \begin_layout Itemize
13514 \begin_layout Itemize
13522 \begin_layout Itemize
13530 \begin_layout Standard
13534 \begin_layout Section
13538 \begin_layout Standard
13544 \begin_layout Standard
13545 \begin_inset VSpace bigskip
13551 \begin_layout Standard
13555 Revtex\InsetSpace ~
13558 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13559 \begin_inset Formula $\beta$
13562 release of May, 1999) class.
13565 \begin_layout Standard
13570 textclass, which works with RevTeX 3.1.
13571 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13572 That means that it doesn't interact very well with LyX, which requires
13573 LaTeX2e, although it has been kludged to work.
13574 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13577 RevTeX\InsetSpace ~
13580 textclass should also be pretty easy to use.
13583 \begin_layout Standard
13584 These documents are supposed to be used in
13588 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13589 macros, and assume you'll know what to put in the preamble if necessary.
13592 \begin_layout Subsection
13596 \begin_layout Standard
13597 All you need to do is install RevTeX 4, as described in the package's README
13599 The package can be found at The RevTeX 4 Web Site
13600 \begin_inset Flex URL
13603 \begin_layout Standard
13605 http://publish.aps.org/revtex4/
13611 Install it somewhere that LaTeX can see it.
13612 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13613 (i.e., not the directory where you installed the class file.) Then, if you
13614 reconfigure LyX, it will find the class file and let you use the RevTeX4
13618 \begin_layout Standard
13619 Probably the easiest way to get started is either to import a RevTeX 4 document
13626 Revtex\InsetSpace ~
13629 template, found in the templates directory.
13632 \begin_layout Subsection
13636 \begin_layout Standard
13637 Optional arguments to
13644 \begin_inset Quotes eld
13648 \begin_inset Quotes erd
13652 \begin_inset Quotes eld
13656 \begin_inset Quotes erd
13670 Document\InsetSpace ~
13674 Remember that in RevTeX, at least one optional argument is required!
13677 \begin_layout Standard
13678 Other preamble matter, like
13694 dialog, also as usual.
13697 \begin_layout Subsection
13701 \begin_layout Standard
13702 The layouts basically correspond to the commands in RevTeX4.0.
13703 For example, the Email layout corresponds to
13710 Note that (at least as of RevTeX 4.0 Beta), the
13718 layouts are exactly equivalent, so you shouldn't need to use both.
13722 \begin_layout Standard
13723 In case you're curious, both were included so that
13727 would be able to translate both
13747 \begin_layout Subsection
13751 \begin_layout Standard
13752 There are a couple of important unique aspects of RevTeX 4 which might cause
13753 bugs that will be even more confusing in LyX.
13756 \begin_layout Standard
13774 The LyX equivalent is that there is a separate Thanks layout.
13779 write footnotes in the
13783 layout, or weird things may happen.
13784 See the RevTeX 4 documentation for more details.
13787 \begin_layout Standard
13790 Author\InsetSpace ~
13795 Author\InsetSpace ~
13802 layouts must be placed
13810 layout and the corresponding
13827 , the LaTeX won't compile.
13830 \begin_layout Subsection
13834 \begin_layout Standard
13835 The main problem with this layout is that you can't use the optional arguments
13836 to layouts like Email and Title.
13837 (The problem is not unique to this layout; you can't use optional arguments
13838 to the Section layouts either.) This means that after you export that file
13839 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13840 need to edit the LaTeX file with a text editor to add the optional arguments
13841 to set, e.\InsetSpace \thinspace{}
13842 g., the running title for the page headers.
13843 Lacking these layouts makes the
13849 (and the equivalent
13855 ) useless, so the corresponding layouts don't exist, and will have to be
13860 \begin_layout Standard
13865 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13866 has not been updated yet to take advantage of it.
13874 \begin_layout Section
13875 Article (mwart), book (mwbk) and report (mwrep)
13876 \begin_inset OptArg
13879 \begin_layout Standard
13892 \begin_layout Standard
13898 \begin_layout Standard
13899 The LyX document classes
13915 correspond to the LaTeX document classes
13928 They are replacements for the standard document classes
13940 , resp., and fit better to Polish typography conventions in a number of points.
13944 \begin_layout Standard
13948 \begin_layout Itemize
13949 Unnumbered titles (with star, eg.
13954 ) are added into table of contents,
13957 \begin_layout Itemize
13958 Additional page styles:
13962 \begin_layout Description
13963 uheadings header with separated lines,
13966 \begin_layout Description
13967 myheadings custom header, contents headers via commands:
13982 \begin_layout Description
13983 myuheadings custom header with separated lines,
13986 \begin_layout Description
13987 outer page number is placed on outer side of page
13991 \begin_layout Itemize
13996 \begin_layout Description
13997 rmheadings serif titles --- default,
14000 \begin_layout Description
14001 sfheadings sansserif titles,
14004 \begin_layout Description
14005 authortitle on title page first placed is author next title --- default,
14008 \begin_layout Description
14009 titleauthor on title page first placed is title next author,
14012 \begin_layout Description
14013 withmarginpar reserve place on page for margins.
14017 \begin_layout Section
14021 \begin_layout Standard
14027 \begin_layout Standard
14028 Elsevier Science Publishers B.V.
14029 provides a standard LaTeX document class (
14033 ) for submitting articles to their various journals.
14034 The style file can be downloaded directly from their web site:
14035 \begin_inset Flex URL
14038 \begin_layout Standard
14040 http://authors.elsevier.com/
14046 Instructions are supplied along with the class file, which details the
14047 requirements of the publishers.
14048 LyX includes package that allows for the use of this class, by a layout
14049 and a template file.
14050 Installation of the class file is the same as for any other LaTeX package;
14051 instructions are provided in the Elsevier documentation.
14054 \begin_layout Standard
14064 As the Elsevier class file is based mainly on the standard article class,
14065 most of the normal functionality is provided.
14066 The Elsevier class defines a number of mathematical environments, which
14067 are similar to the AMS environments.
14068 These commands are all described in the Elsevier documentation, and are
14072 \begin_layout Standard
14073 The easiest way to use the Elsevier style is to base documents on the included
14075 It is best not to use options such as fancy headings or the geometry package,
14076 as elements such as these are defined by Elsevier in their style file.
14077 Ideally, no extra packages except those mentioned in the Elsevier documentation
14079 Essentially, Elsevier require as
14080 \begin_inset Quotes eld
14084 \begin_inset Quotes erd
14091 \begin_layout Standard
14100 file as possible, as their intention is to take the supplied file and replace
14101 the class file with one for the particular journal to which the paper has
14103 This also means that not too much time should be spent on the formating
14105 When it comes to be published, this will change anyway.
14106 The rest of the usage for this layout is substantially the same as for
14107 the normal article class.
14108 For details of what Elsevier do and don't allow, refer to their documentation.
14111 \begin_layout Section
14115 \begin_layout Standard
14118 Jürgen Spitzmüller
14121 \begin_layout Subsection
14125 \begin_layout Standard
14126 Memoir is a very powerful and constantly evolving class.
14127 It has been designed with regard to fictional and non-fictional literature.
14128 Its aim is to let the user have maximum control over the typesetting of
14130 Memoir is based on the standard book class, but it can also emulate the
14131 article class (see below).
14134 \begin_layout Standard
14135 Peter Wilson, the developer of Memoir, is known as the author of lots of
14136 useful packages in the LaTeX world.
14137 Most of them have been merged with Memoir.
14138 Therefore, it is much easier to layout the table of contents, appendices,
14139 chapter designs and such.
14140 LyX, though, does not support all of these goodies natively.
14141 Some of them might be added to forthcoming releases
14145 \begin_layout Standard
14146 You are invited to send suggestions to
14147 \begin_inset Flex URL
14150 \begin_layout Standard
14152 lyx-devel@lists.lyx.org
14162 , lots will probably never, due to the limitations of LyX's framework.
14163 Of course you can still use all features with the help of some native LaTeX
14168 \begin_layout Standard
14173 \begin_layout Standard
14182 section\InsetSpace ~
14184 \begin_inset CommandInset ref
14186 reference "sec:Inserting-LaTeX-Code"
14196 In this section, we can only list those features which are natively supported
14198 For detailed descriptions (and for the rest of features) we are recommending
14199 to have a look at the detailed manual of the Memoir class
14203 \begin_layout Standard
14208 \begin_layout Standard
14218 \begin_inset Flex URL
14221 \begin_layout Standard
14223 CTAN:/macros/latex/memoir/memman.pdf
14233 , which is not only a user guide for the class, but also both a comprehensive
14234 description on good typesetting and a superb example for good typesetting
14238 \begin_layout Subsection
14239 Basic features and restrictions
14242 \begin_layout Standard
14243 Memoir supports basically all features of the standard book classes.
14244 There are, however, some differences, as follows:
14247 \begin_layout Description
14249 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14253 \begin_layout Description
14255 style: The fancy page style is not supported, due to a command clash
14256 between Memoir and the fancyhdr package (they are both defining a command
14257 with the same name, which confuses LaTeX).
14258 Instead, Memoir comes with a bunch of own page styles (see
14260 Layout\SpecialChar \menuseparator
14261 Document\SpecialChar \menuseparator
14266 If you want to use these for the chapter pages, you have to use the command
14273 in the main text or in preamble (e.
14277 \begin_layout Standard
14290 \begin_layout Standard
14303 chapterstyle{companion}
14308 \begin_layout Description
14309 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14310 an optional argument in the standard classes.
14311 With this, you can specify an alternative version of the title for the
14312 table of contents and the headers (for instance, if the title is too long).
14313 In LyX, you can do this via
14315 Insert\SpecialChar \menuseparator
14319 at the beginning of a chapter/section.
14320 Memoir features a second optional argument and thus separates the table
14321 of contents from the header.
14322 You can define three variants of a title with this: one for the main text,
14323 one for the table of contents, and one for the headers.
14324 Simply insert two optional arguments if you need this feature, the first
14325 one containing the short title for the Table of Contents, the second one
14326 containing an alternative short title for the headers.
14329 \begin_layout Description
14330 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14331 of contents, the list of figures and the list of table start a new page
14333 Memoir does not follow this route.
14334 You have to insert a page break yourself, if you want to have one.
14337 \begin_layout Description
14338 Titlepage: For some unknown reason, Memoir uses pagination on the title
14339 page (in the standard classes, title pages are
14340 \begin_inset Quotes eld
14344 \begin_inset Quotes erd
14351 \begin_layout Standard
14364 \begin_layout Standard
14374 If you want an empty title page, type
14378 aliaspagestyle{title}{empty}
14383 \begin_layout Description
14384 Article: With the class option
14390 Layout\SpecialChar \menuseparator
14391 Document\SpecialChar \menuseparator
14395 ), you can emulate article style.
14396 That is, counters (footnotes, figures, tables etc.) will not be reset on
14397 new chapters, chapters don't start a new page (but are---in contrary to
14399 \begin_inset Quotes eld
14403 \begin_inset Quotes erd
14406 article classes---still allowed), parts, though, use their own page, as
14410 \begin_layout Description
14411 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14412 font commands, which have been used in the old LaTeX version 2.09 (e.
14416 \begin_layout Standard
14429 \begin_layout Standard
14451 It produces an error and stops LaTeX whenever such a command appears.
14456 reallows the commands and spits out warnings instead (which does at least
14458 Since a lot of packages and particularly BibTeX style files are still using
14459 those commands, we have decided to use this option by default.
14462 \begin_layout Subsection
14466 \begin_layout Standard
14467 We will only describe the features supported by LyX (which is not much currently
14469 Please consult the Memoir manual
14473 \begin_layout Standard
14478 \begin_layout Standard
14488 \begin_inset Flex URL
14491 \begin_layout Standard
14493 CTAN:/macros/latex/memoir/memman.pdf
14506 \begin_layout Description
14507 Abstract: You may wonder why an abstract is an extra feature.
14508 Well, it is in book class.
14509 Usually books don't have abstracts.
14510 Memoir, however, has.
14511 You can use it wherever and how often you like.
14514 \begin_layout Description
14515 Chapterprecis: You may know this from belletristic: The contents of a chapter
14516 is shortly described below the title and also in the table of contents
14521 \begin_layout Standard
14534 \begin_layout Standard
14545 Our hero arrives in Troia; he loses some friends; he finds others
14548 Chapterprecis does exactly this.
14549 It is therefore only sensible below a chapter.
14552 \begin_layout Description
14553 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14554 The epigraph environment provides an elegant way of typesetting such a
14556 The motto itself (text) and its author (source) are divided by a short
14558 Unfortunately, we have to fool LyX a bit here again, since the environment
14559 needs two arguments (text and source).
14560 In this case, we have to use curly brackets (in TeX mode) between the two
14571 <author of the slogan>.
14574 \begin_layout Description
14575 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14576 complex figurative poems).
14577 LyX can only support a few of them.
14578 One is poemtitle, which is a centered title for poems, which will also
14579 be added to the table of contents (verse is the standard environment for
14581 Memoir has some enhanced versions of verse, but you need to use ERT, because
14582 they have to be nested inside regular verse environments, which is not
14583 possible with LyX).
14586 \begin_layout Description
14587 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14590 \begin_layout Chapter
14591 Importing and Exporting Alternate File Formats
14592 \begin_inset OptArg
14595 \begin_layout Standard
14596 Importing and Exporting
14604 \begin_layout Section
14608 \begin_layout Standard
14609 Importing and exporting LyX documents from/to other formats has been touched
14615 Here we describe more of the gory details needed to understand just what
14616 is going on when you click on the
14621 ile\SpecialChar \menuseparator
14633 ile\SpecialChar \menuseparator
14644 \begin_layout Section
14645 Importing Other Formats
14648 \begin_layout Subsection
14652 \begin_layout Standard
14653 Translating from LaTeX into LyX is performed by a converter program called
14659 Although it is a standalone program which can be called from the command
14660 line, LyX will call it automatically when a LaTeX document is imported.
14661 See section\InsetSpace ~
14663 \begin_inset CommandInset ref
14665 reference "sec:Translating-LaTeX-files"
14669 for a complete description.
14672 \begin_layout Subsection
14676 \begin_layout Standard
14677 When importing plain ASCII text, there are two methods of reading the file.
14679 \begin_inset Quotes eld
14683 \begin_inset Quotes erd
14686 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14689 \begin_inset Quotes eld
14693 \begin_inset Quotes erd
14696 assumes that consecutive lines separated by only a single linebreak form
14697 a single paragraph.
14698 Successive linebreaks with no intervening text are thus assumed to be paragraph
14702 \begin_layout Subsection
14706 \begin_layout Standard
14709 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14712 \begin_layout Section
14713 Exporting Other Formats
14716 \begin_layout Standard
14717 The output formats listed here in the following are also explained concerning
14718 possible graphics formats in the
14725 \begin_layout Subsection
14729 \begin_layout Standard
14730 LyX generates two types of LaTeX files: stripped down versions for the normal
14735 , etc.) which one normally never sees
14739 \begin_layout Standard
14740 The resulting file is a perfectly valid LaTeX file, though the preamble
14741 might look a bit strange since it includes some definitions used by LyX
14742 which wouldn't show up in most human-written files.
14747 , and human readable forms which are suitable for exchanging with your colleague
14749 The only settable option for the translation is the line length of the
14751 The default is 65 characters, but it can be set in
14758 \SpecialChar \menuseparator
14779 \begin_layout Subsection
14780 Device Independent Files
14783 \begin_layout Standard
14784 Device Independent files (DVI files) are produced by running LaTeX on your
14786 There are no user settable options.
14789 \begin_layout Subsection
14793 \begin_layout Standard
14794 The next step in the conversion chain is converting a DVI file into Postscript.
14802 \SpecialChar \menuseparator
14810 \SpecialChar \menuseparator
14819 or, if you need more control on the result,
14826 \SpecialChar \menuseparator
14835 If you use the later, note that it is possible to configure, in
14842 \SpecialChar \menuseparator
14850 , the options passed to the dvips program to achieve different effects.
14853 \begin_layout Subsection
14857 \begin_layout Standard
14858 Exporting as ASCII attempts to preserve the
14859 \begin_inset Quotes eld
14863 \begin_inset Quotes erd
14866 of the document as well as possible, but things like centering and indentation
14867 are thrown out; paragraphs are separated by blank lines.
14868 Section numbering and cross-references are done correctly, so the resulting
14869 text files is remarkably readable.
14870 The only changeable option is the length of lines, as for LaTeX output.
14873 \begin_layout Subsection
14877 \begin_layout Standard
14878 LyX documents can be converted to hypertext markup, usually by converting
14879 to LaTeX first, then converting that to HTML\SpecialChar \@.
14881 \begin_inset Formula $\rightarrow$
14884 HTML converters are currently known to LyX:
14901 Though they are autodetected, you can overide the selection in preferences.
14902 You can also include further command line options in this dialog.
14906 \begin_layout Subsection
14910 \begin_layout Standard
14918 \begin_layout Standard
14919 \begin_inset VSpace bigskip
14925 \begin_layout Standard
14926 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14927 any version of LyX is to save the document as a Postscript file, then run
14933 Starting with version 1.1.6, the menu item
14937 will do all this for you.
14938 There are some issues with fonts that you need to pay attention to: see
14939 Section\InsetSpace ~
14941 \begin_inset CommandInset ref
14943 reference "sec:badfonts"
14948 Also, as of version 1.1.6, there is a better method that will generate much
14949 more sophisticated files.
14952 \begin_layout Subsubsection
14956 \begin_layout Standard
14957 With pdfLaTeX you cannot use pstricks.
14958 On the other hand, with pdfLaTeX it is possible to insert directly images
14959 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14962 \begin_layout Subsubsection
14963 Why does the text look so bad when viewed with Acrobat Reader?
14964 \begin_inset CommandInset label
14966 name "sec:badfonts"
14971 \begin_inset OptArg
14974 \begin_layout Standard
14975 Bad Fonts in Acrobat Reader
14983 \begin_layout Standard
14984 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14985 When creating a PDF from the LyX file, you need to use outline font instead
14986 of the default bitmap fonts (in fact, you should also use outline fonts
14987 for Postscript files).
14988 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14989 (Computer Modern) fonts.
14990 pdfLaTeX uses these font by default.
14991 Dvips doesn't use these fonts by default, so to make it use them, add the
14992 following to lines to your
14999 \begin_layout LyX-Code
15003 \begin_layout LyX-Code
15007 \begin_layout Standard
15008 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15010 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15011 fonts, for which there are no Type1 version.
15012 The solution is to use the ae package which emulates T1 coded fonts using
15013 the standard CM fonts.
15014 This is done by adding
15018 usepackage{ae,aecompl}
15020 to the preamble of the LyX file.
15021 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
15024 they are taken from the EC fonts.
15025 Therefore you get these glyphs as bitmaps.
15028 \begin_layout Standard
15029 Note: LyX uses by default the T1 font encoding.
15030 If you wish to use the default font encoding (this is not recommended,
15031 unless you only write English documents), clear the field
15039 in preferences (tabs
15051 \begin_layout Standard
15052 An alternate option is to use the standard Postscript fonts instead of the
15053 Computer Modern fonts.
15054 To do that, you need to select
15058 as the global font in the document layout dialog.
15059 When using the Postscript fonts, the result PDF file is smaller as the
15060 fonts are not saved into the file.
15061 Furthermore, the Postscript fonts include all T1 glyphs.
15062 On the other hand, the Postscript fonts have no bold symbol font, so poor
15063 man's bold must be used (see Section\InsetSpace ~
15065 \begin_inset CommandInset ref
15067 reference "sec:pdfbold"
15072 The Postscript fonts also look different from the Computer Modern fonts.
15075 \begin_layout Standard
15076 To sum up, both the Computer Modern and the Postscript fonts gives good
15077 results (with few exceptions).
15078 The decision of which one to use is a matter of taste.
15081 \begin_layout Subsubsection
15084 boldsymbol{} command work when I use pslatex?
15085 \begin_inset CommandInset label
15092 \begin_inset OptArg
15095 \begin_layout Standard
15112 \begin_layout Standard
15113 The Postscript fonts do not have a bold symbol font.
15114 The solution is to use the
15120 (poor man's bold) command.
15123 \begin_layout Standard
15124 It is possible to redefine the
15139 \begin_layout LyX-Code
15149 \begin_layout Standard
15153 \begin_layout Subsubsection
15154 Is it possible to do write LaTeX-code which is processed only when running
15156 \begin_inset OptArg
15159 \begin_layout Standard
15160 Conditionals with pdfLaTeX
15168 \begin_layout Standard
15169 Yes you can do this with the
15174 Here is an example:
15177 \begin_layout LyX-Code
15181 \begin_layout LyX-Code
15187 \begin_layout LyX-Code
15193 \begin_layout LyX-Code
15196 pdfinfo { /Author (your name and e-mail address)
15199 \begin_layout LyX-Code
15200 /Title (official title -- i.e., title element)
15203 \begin_layout LyX-Code
15204 /Subject (one line description of the document)
15207 \begin_layout LyX-Code
15211 \begin_layout LyX-Code
15214 pdfcatalog { /PageMode (/UseNone)
15217 \begin_layout LyX-Code
15218 % /OpenAction (fitbh)
15221 \begin_layout LyX-Code
15225 \begin_layout LyX-Code
15228 usepackage[pdftex]{hyperref}
15231 \begin_layout LyX-Code
15237 \begin_layout LyX-Code
15240 usepackage[ps2pdf]{hyperref}
15243 \begin_layout LyX-Code
15249 \begin_layout Subsubsection
15250 How can I make URLs clickable?
15253 \begin_layout Standard
15254 See the references here:
15257 \begin_layout Standard
15258 \begin_inset Flex URL
15261 \begin_layout Standard
15263 http://wiki.lyx.org/pmwiki.php/FAQ/PDF
15271 \begin_layout Subsection
15275 \begin_layout Standard
15276 Custom exports are possible if you have some particularly weird format you
15277 wish to convert to, assuming you have the relevant converter, of course.
15282 file can be chosen in the
15287 ile\SpecialChar \menuseparator
15292 xport\SpecialChar \menuseparator
15299 dialog; LyX will automatically convert the file to this point, then feed
15300 it to your custom converter.
15301 The possible values are all formats that LyX can produce from its own documents.
15305 \begin_layout Standard
15306 The converter command is also specified in the dialog.
15307 It should be a completely qualified command line which uses the variable
15312 to specify the name of the file.
15313 If this variable is not given, then the file will be sent to the standard
15314 input of your command.
15315 You may have to apply a bit of ingenuity to escape this sequence correctly
15316 so that it is compatible with your shell.
15320 \begin_layout Standard
15321 While it is not possible to save this command using the
15325 dialog, you can manually edit your
15332 \begin_layout LyX-Code
15335 custom_export_command "mycommand $$FName"
15338 \begin_layout Chapter
15339 LyX Features needing Extra Software
15342 \begin_layout Section
15346 \begin_layout Standard
15352 \begin_layout Subsection
15356 \begin_layout Standard
15364 menu, you'll find a
15373 This feature requires you to have the
15377 program installed, and is grayed out if you don't have it.
15378 You can get it from your nearest CTAN mirror, or over the Web from
15379 \begin_inset Flex URL
15382 \begin_layout Standard
15384 http://www.ifi.uio.no/~jensthi/chktex/
15392 \begin_layout Standard
15397 package is a program that was written by
15402 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15403 and easy to forget.
15404 The program runs over your LaTeX file and checks the integrity of the file,
15405 and flags some common errors.
15406 In other technical words, it is
15413 \begin_layout Standard
15414 Well, what is a syntax checker doing in LyX which is supposed to produce
15415 correct LaTeX anyways? The answer is simple: Just as
15419 not only checks the
15423 of C programs, but also does
15427 checks for type-errors,
15431 catches some common
15435 errors, in addition to the syntactical ones.
15440 is capable of detecting several common errors, such as
15443 \begin_layout Itemize
15444 Ellipsis detection:
15446 Use \SpecialChar \ldots{}
15450 \begin_layout Itemize
15451 No space in front of/after parenthesis:
15456 \begin_layout Itemize
15457 Enforcement of normal space after common abbreviations:
15461 is too wide spacing.
15464 \begin_layout Itemize
15465 Enforcement of end-of-sentence space when the last sentence ends with a
15469 And this is wrong spacing.
15472 \begin_layout Itemize
15473 Space in front of labels and similar commands:
15475 The label should stick right
15476 up to the text to avoid falling to a wrong page.
15478 \begin_inset CommandInset label
15488 \begin_layout Standard
15489 This footnote is in danger of falling off to a wrong page
15494 The label is separated too much.
15497 \begin_layout Itemize
15498 Space in front of references, instead of hard spaces:
15500 In you are in bad luck,
15501 the text will break right between the referenced text and reference number,
15504 \begin_inset CommandInset ref
15506 reference "sec:chktex"
15513 \begin_layout Itemize
15515 \begin_inset Quotes eld
15519 \begin_inset Quotes erd
15523 \begin_inset Formula $\times$
15528 2x2 looks cheap compared to
15529 \begin_inset Formula $2\times2$
15535 \begin_layout Standard
15536 and more \SpecialChar \ldots{}
15537 It is an invaluable tool when you are
15538 \begin_inset Quotes eld
15542 \begin_inset Quotes erd
15545 your document before printing, and you should run it right after the obligatory
15546 spelling check, and before you go fine tuning the typesetting.
15549 \begin_layout Subsection
15553 \begin_layout Standard
15554 If you have the program installed, usage is as simple as choosing
15559 ools\SpecialChar \menuseparator
15568 This will make LyX generate a LaTeX file of your document, start
15572 to check it, and then make LyX insert
15573 \begin_inset Quotes eld
15577 \begin_inset Quotes erd
15580 with the warnings from
15584 , if there were any.
15585 The warnings will be placed close to the point of the mistake, and you
15586 can quickly find them by using the
15591 avigate\SpecialChar \menuseparator
15598 menu item, or the shortcut key
15607 Open the error boxes by clicking on them with the mouse, or use the shortcut
15616 bindings, or the corresponding
15625 Read the warning and correct the mistake, if it is a mistake.
15626 If you have trouble understanding what the warning is about, you can safely
15628 Remember that there is a hidden layer between the document on screen and
15629 the technical details in invoking
15633 , and this gap can make some warnings seem arcane or just right down plain
15637 \begin_layout Standard
15638 This document is an excellent testing bed for the feature, and it should
15639 provide quite a few warnings for you to fiddle with.
15640 Since computers are only so smart, expect most of the warnings to be false
15644 \begin_layout Subsection
15645 How to fine tune it
15648 \begin_layout Standard
15649 Sometimes, you'll find that
15653 makes more noise than suits your mood.
15654 Then you can choose not to use it, wait until your mood changes, or try
15659 to get better along with you.
15660 Another choice in the most desperate situations is to use
15665 iew\SpecialChar \menuseparator
15675 , which will get rid of all warnings instantly.
15678 \begin_layout Standard
15687 very configurable and extensible, you shouldn't expect to solve all problems
15693 Since LyX has to generate a somewhat special LaTeX file to be able to match
15694 the line numbers from the
15702 \begin_layout Standard
15703 You can inspect the specific output from
15709 Edit\SpecialChar \menuseparator
15723 to the internal document structure, some of the warnings will not seen
15724 to appear correctly.
15725 There are two things you can do about this:
15728 \begin_layout Itemize
15733 invocation command line in
15749 installation configuration file (usually with the file
15754 See below to learn what warnings can be enabled and disabled on the command
15759 \begin_layout Itemize
15760 Export your document as a raw LaTeX file using
15765 ile\SpecialChar \menuseparator
15770 xport\SpecialChar \menuseparator
15782 Invoked in this way, it can be a hassle to find the corresponding place
15783 in the document inside LyX, but with a little patience, you should be able
15787 \begin_layout Standard
15788 Here follows the warning messages that can be enabled and disabled in
15797 to disable a warning, and
15801 to enable a warning.
15802 The emphasized entries are disabled by default, because the default is
15805 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15810 \begin_layout Standard
15811 Notice that you should only use the options that enable and disable warnings,
15812 because LyX relies on some of the other command line parameters to be set
15813 in a specific way to have a chance to communicate with
15820 \begin_layout Enumerate
15824 Command terminated with space.
15827 \begin_layout Enumerate
15830 Non-breaking space (
15831 \begin_inset Quotes eld
15839 \begin_inset Quotes erd
15842 ) should have been used.
15845 \begin_layout Enumerate
15849 You should enclose the previous parenthesis with
15850 \begin_inset Quotes eld
15858 \begin_inset Quotes erd
15864 \begin_layout Enumerate
15867 Italic correction (
15868 \begin_inset Quotes eld
15878 \begin_inset Quotes erd
15881 ) found in non-italic buffer.
15884 \begin_layout Enumerate
15887 Italic correction (
15888 \begin_inset Quotes eld
15898 \begin_inset Quotes erd
15901 ) found more than once.
15904 \begin_layout Enumerate
15908 No italic correction (
15909 \begin_inset Quotes eld
15919 \begin_inset Quotes erd
15925 \begin_layout Enumerate
15929 \begin_inset Quotes eld
15937 \begin_inset Quotes erd
15941 \begin_inset Quotes eld
15949 \begin_inset Quotes erd
15955 \begin_layout Enumerate
15958 Wrong length of dash may have been used.
15961 \begin_layout Enumerate
15965 \begin_inset Quotes eld
15973 \begin_inset Quotes erd
15977 \begin_inset Quotes eld
15985 \begin_inset Quotes erd
15991 \begin_layout Enumerate
15995 \begin_inset Quotes eld
16003 \begin_inset Quotes erd
16009 \begin_layout Enumerate
16013 \begin_inset Quotes eld
16021 \begin_inset Quotes erd
16024 to achieve an ellipsis.
16027 \begin_layout Enumerate
16030 Inter-word spacing (
16031 \begin_inset Quotes eld
16041 \begin_inset Quotes eld
16044 ) should perhaps be used.
16047 \begin_layout Enumerate
16050 Inter-sentence spacing (
16051 \begin_inset Quotes eld
16061 \begin_inset Quotes erd
16064 ) should perhaps be used.
16067 \begin_layout Enumerate
16070 Could not find argument for command.
16073 \begin_layout Enumerate
16077 \begin_inset Quotes eld
16085 \begin_inset Quotes erd
16091 \begin_layout Enumerate
16094 Math mode still on at end of LaTeX file.
16097 \begin_layout Enumerate
16101 \begin_inset Quotes eld
16109 \begin_inset Quotes erd
16112 doesn't match the number of
16113 \begin_inset Quotes eld
16121 \begin_inset Quotes erd
16127 \begin_layout Enumerate
16130 You should use either
16133 \begin_inset Quotes eld
16141 \begin_inset Quotes erd
16146 as an alternative to
16147 \begin_inset Quotes eld
16155 \begin_inset Quotes erd
16161 \begin_layout Enumerate
16168 " (ASCII 39) instead of "
16175 \begin_layout Enumerate
16178 User-specified pattern found.
16181 \begin_layout Enumerate
16184 This command might not be intended.
16187 \begin_layout Enumerate
16194 \begin_layout Enumerate
16212 \begin_layout Enumerate
16215 Delete this space to maintain correct page references.
16218 \begin_layout Enumerate
16222 You might wish to put this between a pair of
16223 \begin_inset Quotes eld
16231 \begin_inset Quotes erd
16237 \begin_layout Enumerate
16240 You ought to remove spaces in front of punctuation.
16243 \begin_layout Enumerate
16246 Could not execute LaTeX command.
16249 \begin_layout Enumerate
16258 in front of small punctuation.
16261 \begin_layout Enumerate
16269 may look prettier here.
16272 \begin_layout Enumerate
16276 Multiple spaces detected in output.
16279 \begin_layout Enumerate
16282 This text may be ignored.
16285 \begin_layout Enumerate
16291 \begin_inset Quotes eld
16296 to begin quotation, not
16303 \begin_layout Enumerate
16310 to end quotation, not
16313 \begin_inset Quotes eld
16321 \begin_layout Enumerate
16327 \begin_layout Enumerate
16330 You should perhaps use
16331 \begin_inset Quotes eld
16339 \begin_inset Quotes erd
16345 \begin_layout Enumerate
16348 You should put a space in front of/after parenthesis.
16351 \begin_layout Enumerate
16354 You should avoid spaces in front of/after parenthesis.
16357 \begin_layout Enumerate
16361 You should not use punctuation in front of/after quotes.
16364 \begin_layout Enumerate
16367 Double space found.
16370 \begin_layout Enumerate
16373 You should put punctuation outside inner/inside display math mode.
16376 \begin_layout Enumerate
16379 You ought to not use primitive TeX in LaTeX code.
16382 \begin_layout Enumerate
16385 You should remove spaces in front of
16386 \begin_inset Quotes eld
16394 \begin_inset Quotes erd
16400 \begin_layout Enumerate
16403 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16414 is normally not followed by
16415 \begin_inset Quotes eld
16423 \begin_inset Quotes erd
16429 \begin_layout Standard
16430 In later versions of LyX, we hope to provide a more complete interface to
16431 this tool (and it's smaller cousin
16435 ) to exploit the full power of it.
16436 But it's not exactly useless as it is now: go try it on one of your existing
16437 documents of a certain length and be surprised.
16440 \begin_layout Section
16441 Version Control in LyX
16444 \begin_layout Standard
16447 Lars Gullik Bjønnes
16450 \begin_layout Subsection
16454 \begin_layout Standard
16455 A friend of mine wanted to try LyX for a group project.
16456 When he didn't find support for version control or file locking, he dropped
16458 This angered me a bit, so I thought that I should at least make support
16459 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16460 This has now been done.
16461 LyX now supports some of the most basic RCS commands.
16462 If you need to something a bit more sophisticated you will have to do that
16463 manually in an xterm.
16466 \begin_layout Standard
16467 Before you begin to use the version control features in LyX, you should
16469 \begin_inset Quotes eld
16473 \begin_inset Quotes erd
16476 (a man file, read it with
16481 This file describes all the basic features of RCS.
16482 You should especially notice the comment about a RCS directory, and the
16483 notion of a master RCS file (the file ending in
16490 \begin_layout Standard
16491 The implementation in LyX assumes a recent version of the GNU RCS package---no
16492 guarantees are made for older versions.
16495 \begin_layout Subsection
16496 RCS commands in LyX
16499 \begin_layout Standard
16500 The following sections describe the RCS commands supported by LyX.
16501 You can find them in the
16506 ile\SpecialChar \menuseparator
16511 ersion\InsetSpace ~
16517 \begin_layout Subsubsection
16523 \begin_layout Standard
16524 If your document is not under revision control, this is the only item shown
16526 And if it is under revision control, the
16533 item is grayed out.
16537 \begin_layout Standard
16538 This command registers your document with RCS\SpecialChar \@.
16539 You are asked interactively
16540 to supply an initial description of the document.
16541 The document is now set in Read-Only mode and you have to
16548 , before making any changes to it.
16549 A document under revision control has a
16550 \begin_inset Quotes eld
16553 [RCS:<version> <locker>]
16554 \begin_inset Quotes erd
16557 item tagged to the filename in the minibuffer.
16560 \begin_layout Standard
16561 RCS command that is run:
16563 ci -q -u -i -t-"<initial description>" <file-name>
16566 \begin_layout Standard
16571 to understand the switches.
16575 \begin_layout Subsubsection
16581 \begin_layout Standard
16582 When you are finished editing a file, you check in your changes.
16583 When you do this, you are asked for a description of the changes.
16584 This is stored in the history log.
16585 The version number is bumped, your changes are applied to the master RCS
16586 file, the document is unlocked and set to Read-Only mode.
16590 \begin_layout Standard
16593 ci -q -u -m"<description>" <file-name>
16596 \begin_layout Subsubsection
16602 \begin_layout Standard
16603 By doing this you lock the document so that only you can edit it.
16604 This will also make the document Read-Write only for you.
16605 You will usually continue editing for a while and when you are finished
16606 you check in your changes.
16607 The status line is changed to reflect that you have locked the file.
16611 \begin_layout Standard
16614 co -q -l <file-name>
16617 \begin_layout Subsubsection
16620 Revert To Last Version
16623 \begin_layout Standard
16624 This will discard all changes made to the document since the last check
16626 You get a warning before changes are discarded.
16629 \begin_layout Standard
16632 co -f -u<version> <file-name>
16635 \begin_layout Subsubsection
16641 \begin_layout Standard
16642 This makes as if the last check in never happened.
16643 No changes are made to the document loaded into LyX, but the last version
16644 is removed from the master RCS file.
16648 \begin_layout Standard
16651 rcs -o<version> <file-name>
16654 \begin_layout Subsubsection
16660 \begin_layout Standard
16661 This show the complete history of the RCS document.
16666 is shown in a browser.
16674 \begin_layout Section
16675 Literate Programming
16678 \begin_layout Standard
16683 (kayvan@sylvan.com)
16687 original documentation written by
16689 Edmar Wienskoski Jr.
16692 (edmar-w-jr@technologist.com)
16695 \begin_layout Subsection
16699 \begin_layout Standard
16700 The main purpose of this documentation is to show you how to use LyX for
16701 literate programming.
16702 Where it is assumed that you are familiar with this programming technique,
16704 \begin_inset Quotes eld
16708 \begin_inset Quotes erd
16712 \begin_inset Quotes eld
16716 \begin_inset Quotes erd
16720 If that is not the case, please follow the web links provided in the following
16722 There is a lot of good documentation out there covering old development
16723 history to the latest tools tips.
16726 \begin_layout Standard
16727 It is also assumed that you are familiar with LyX itself to a point that
16728 you are comfortable changing your LyX preferences, and X resources file.
16729 If that is not the case please refer to other LyX documentation to cover
16730 your specific needs.
16733 \begin_layout Subsection
16734 Literate Programming
16737 \begin_layout Standard
16738 From the Literate Programming FAQ:
16741 \begin_layout Quotation
16742 Literate programming is the combination of documentation and source together
16743 in a fashion suited for reading by human beings.
16744 In fact, literate programs should be enjoyable reading, even inviting!
16745 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16746 and documentation in a single file.
16747 Literate programming tools then parse the file to produce either readable
16748 documentation or compilable source.
16749 The WEB style of literate programming was created by D.E.
16750 Knuth during the development of his TeX typesetting software.
16754 \begin_layout Standard
16755 Another excerpt says:
16758 \begin_layout Quotation
16761 How is literate programming different from verbose commenting?
16764 \begin_layout Quotation
16765 There are three distinguishing characteristics.
16766 In order of importance, they are:
16770 \begin_layout Itemize
16771 flexible order of elaboration
16774 \begin_layout Itemize
16775 automatic support for browsing
16778 \begin_layout Itemize
16779 typeset documentation, especially diagrams and mathematics
16783 \begin_layout Standard
16784 Now that I sparked your curiosity, take a look in the references.
16787 \begin_layout Subsubsection
16791 \begin_layout Standard
16792 The complete Literate Programming FAQ can be found at:
16795 \begin_layout Quote
16796 Literate Programming FAQ
16797 \begin_inset Flex URL
16800 \begin_layout Standard
16802 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16810 \begin_layout Standard
16811 The FAQ lists 23 (twenty three!) different literate programming tools.
16812 Where some are specialized or
16813 \begin_inset Quotes eld
16817 \begin_inset Quotes erd
16820 for particular programming languages, while other have general scope.
16825 for my own use for several reasons:
16828 \begin_layout Itemize
16829 It can generate the documentation either in LaTeX or HTML.
16832 \begin_layout Itemize
16833 It has a open architecture, i.e., it is easy to plug in new filters and to
16834 perform special processing that you may need.
16838 \begin_layout Itemize
16839 There is a good selection of filters available already (the HTML is one
16843 \begin_layout Itemize
16847 \begin_layout Standard
16848 The Noweb web page can be found at:
16851 \begin_layout Quote
16853 \begin_inset Flex URL
16856 \begin_layout Standard
16858 http://www.cs.virginia.edu/~nr/noweb/
16866 \begin_layout Standard
16867 Starting from there you can reach many other interesting links and even
16868 some literate program examples.
16871 \begin_layout Subsection
16872 \begin_inset CommandInset label
16874 name "sub:LyX-and-Literate"
16878 LyX and Literate Programming
16881 \begin_layout Standard
16882 The LyX support for Literate Programming is provided by using the generic
16883 LyX convertors mechanism.
16884 This support is provided in a
16885 \begin_inset Quotes eld
16889 \begin_inset Quotes erd
16892 way, i.e., you will be able to use this new LyX feature with some other literate
16893 programming tool of your choice by just changing your LyX preferences.
16896 \begin_layout Subsubsection
16897 Generating documents and code (weaving and tangling)
16900 \begin_layout Paragraph
16901 Selecting the document class
16904 \begin_layout Standard
16905 If you have installed Noweb and LyX successfully, whenever you open a new
16906 document or try to change the document class of an existing one, you will
16907 find that there are three new document classes available:
16910 \begin_layout Itemize
16914 \begin_layout Itemize
16918 \begin_layout Itemize
16922 \begin_layout Standard
16923 You must select one of them to create your literate documents from.
16927 \begin_layout Standard
16928 Note that literate documents are not limited to these three classes.
16929 New classes can be generated from other styles like letter or in combination
16930 with other class variations like Article (AMS).
16931 If you have special needs that cannot be covered by one of the existing
16932 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16933 will arrange to insert a new entry, or teach you how to do it.
16937 \begin_layout Standard
16938 It is very simple, it involves the creation of a file with four lines, and
16939 re-running of the auto configuration.
16944 Moreover, if you use a literate tool other than Noweb you may need to create
16945 a new set of document classes for it.
16948 \begin_layout Paragraph
16952 \begin_layout Standard
16953 LyX enables you to write code with a layout named
16961 \begin_layout Standard
16962 The equivalent Noweb term is
16963 \begin_inset Quotes eld
16967 \begin_inset Quotes erd
16971 For historical reasons, I got used to the term
16972 \begin_inset Quotes eld
16976 \begin_inset Quotes erd
16979 introduced by other literate tool named Nuweb, which I used for many years
16980 before rendering myself to Noweb.
16985 Noweb delimits scraps like this:
16988 \begin_layout LyX-Code
16992 \begin_layout LyX-Code
16996 \begin_layout LyX-Code
17000 \begin_layout LyX-Code
17004 \begin_layout LyX-Code
17008 \begin_layout Standard
17009 The problem is that whatever is written in between the << and the
17013 must be taken literally, i.e., LyX should be prevented from making any special
17014 interpretation of what has been written.
17015 This is handled by a special layout named Scrap, that works like a normal
17016 paragraph but has a free spacing capability.
17019 \begin_layout Standard
17020 The down side of the Scrap paragraph layout is that consecutive paragraphs
17021 of code will be spaced with one empty line in the source code and also
17022 in the printed documentation.
17023 The work around is to enter each line of code within a single Scrap, with
17024 a newline (ctrl-return).
17025 The example above will look like this:
17029 \begin_layout Standard
17030 If you have a printed version of this document you will not see any difference
17031 between the previous example and this one.
17039 \begin_layout LyX-Code
17051 \begin_layout Standard
17052 This layout works fine.
17053 The only real inconvenience is that you have to type ctrl-return instead
17058 \begin_layout Standard
17059 It is in my list of
17060 \begin_inset Quotes eld
17064 \begin_inset Quotes erd
17075 \begin_layout Standard
17076 As a special note, you can also use the
17077 \begin_inset Quotes eld
17081 \begin_inset Quotes erd
17084 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17088 \begin_layout LyX-Code
17091 def some_function(args):
17093 "This is the doc string for this
17096 print "My args: ", args
17099 \begin_layout LyX-Code
17100 @ %def some_function
17103 \begin_layout Standard
17104 For an example of this usage and the resulting cross-reference output, look
17105 at the Literate python program in
17107 LIBDIR/examples/listerrors.lyx
17109 which should make this all clear.
17112 \begin_layout Paragraph
17113 Generating the documentation
17116 \begin_layout Standard
17117 At this point you already have a new document file with a proper document
17118 class, and with some code and text on it.
17119 How do I print it? The answer is simple, you select
17124 iew\SpecialChar \menuseparator
17132 Just like you would do for a plain document.
17133 No special procedure is required.
17136 \begin_layout Standard
17137 To help orientate you, I will now explain what happens inside LyX:
17140 \begin_layout Enumerate
17146 pdate\SpecialChar \menuseparator
17153 menu option is chosen, a LaTeX file is generated.
17158 \begin_layout Standard
17159 If the document is of any literate class the generated file will be named
17160 with an extension name defined by the
17161 \begin_inset Quotes eld
17165 \begin_inset Quotes erd
17168 format (defined in the Preferences panel), otherwise the file will have
17177 \begin_layout Enumerate
17178 Note that the only difference so far is in the name of the file, no special
17179 processing is required by LyX.
17180 Given that you formatted the code using the Scrap layout that, by itself,
17181 takes care of the business.
17184 \begin_layout Enumerate
17185 If the document is of any literate class LyX will then use the internal
17186 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17190 \begin_layout Standard
17191 The converters are defined in the
17196 ools\SpecialChar \menuseparator
17204 \begin_inset Quotes eld
17208 \begin_inset Quotes erd
17213 \begin_inset CommandInset ref
17215 reference "sub:converters"
17223 manual for general information about converters.
17228 to generate the LaTeX file.
17232 \begin_layout Standard
17233 Otherwise it will just skip this step.
17237 \begin_layout Enumerate
17238 Finally, LaTeX is invoked and the regular post processing continues as in
17242 \begin_layout Standard
17243 Independence from a particular
17244 \begin_inset Quotes eld
17248 \begin_inset Quotes erd
17251 is easily achieved by changing the commands that are run by the various
17255 \begin_layout Paragraph
17256 Generating the code
17259 \begin_layout Standard
17260 When the build menu option is chosen or the corresponding button in the
17261 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17262 Next, LyX invokes the
17267 This converter needs to be defined by the user and is not installed by
17268 default, though the Program format is.
17269 This converter (like any other converter) will have two parts:
17272 \begin_layout Enumerate
17273 The converter program itself.
17274 This program performs the conversion from the one format to the other (in
17275 this case, from the Noweb format to the Program pseudo-format).
17278 \begin_layout Enumerate
17279 The error log parser.
17280 This is a program whose sole purpose is to rewrite error messages in a
17281 format that LyX understands.
17282 This makes it possible for LyX to place error boxes in the right places
17283 in the file buffer.
17286 \begin_layout Standard
17287 The first part, the
17288 \begin_inset Quotes eld
17292 \begin_inset Quotes erd
17295 setting, should be set to
17296 \begin_inset Quotes eld
17304 \begin_inset Quotes erd
17308 This basically means that LyX will call
17309 \begin_inset Quotes eld
17313 \begin_inset Quotes erd
17316 (a program or script) with the name of the Noweb file (normally a file
17317 in the LyX temp directory).
17321 \begin_layout Standard
17322 This is an implementation of
17323 \begin_inset Quotes eld
17327 \begin_inset Quotes erd
17330 that you can place in a directory on your path:
17333 \begin_layout LyX-Code
17337 \begin_layout LyX-Code
17341 \begin_layout LyX-Code
17342 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17345 \begin_layout Standard
17346 The next part of the converter setting is the
17347 \begin_inset Quotes eld
17351 \begin_inset Quotes erd
17354 which is to be set to
17355 \begin_inset Quotes eld
17360 parselog=listerrors
17363 \begin_inset Quotes erd
17367 This will run any errors that are generated by the
17368 \begin_inset Quotes eld
17372 \begin_inset Quotes erd
17375 process through the
17376 \begin_inset Quotes eld
17380 \begin_inset Quotes erd
17386 \begin_layout Standard
17387 The converter code looks in
17395 then on the path for the
17396 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17406 \begin_layout Standard
17407 The build will normally take place in LyX's temporary directory, so the
17408 files produced by the conversion will be in that directory.
17409 LyX will copy out what it regards as the `main' file, but the
17413 conversion may produce several files, and so most of these would then be
17414 deleted when LyX was closed.
17415 The present solution is to use a `copier',
17419 \begin_layout Standard
17421 \begin_inset CommandInset ref
17423 reference "sec:converters-etc"
17431 manual for information on these.
17440 script in its default mode, so that the entire contents of the temporary
17441 directory is copied.
17442 More will get copied than is needed, to be sure, but nothing will be lost.
17443 If, however, you know what extensions the generated files will have, this
17444 can be improved by using the
17453 This option takes a comma-separated list of extensions to copy.
17454 So, for example, if the conversion will generate only files with the extensions
17463 , then the correct definition would be:
17466 \begin_layout LyX-Code
17467 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17470 \begin_layout Standard
17471 The result will be that only files with these two extensions will be copied
17475 \begin_layout Paragraph
17476 Build instructions in the document
17479 \begin_layout Standard
17480 The last piece of the integration between LyX and noweb is the
17481 \begin_inset Quotes eld
17485 \begin_inset Quotes erd
17489 Generally, the instructions for building your program should be embedded
17490 in a scrap of its own.
17492 \begin_inset Quotes eld
17496 \begin_inset Quotes erd
17499 above uses the notangle command to look for this scrap (called
17500 \begin_inset Quotes eld
17504 \begin_inset Quotes erd
17507 ) and runs its contents through
17508 \begin_inset Quotes eld
17512 \begin_inset Quotes erd
17518 \begin_layout Standard
17519 Typically, such a scrap would look something like this:
17522 \begin_layout LyX-Code
17529 if [ -z "${NOWEB_SOURCE}" ]
17533 NOWEB_SOURCE=myfile.nw
17539 code to extract files ...]
17542 code to compile files ...]
17547 \begin_layout Standard
17550 LIBDIR/examples/listerrors.lyx
17554 LIBDIR/examples/Literate.lyx
17556 which implement two versions of the
17557 \begin_inset Quotes eld
17561 \begin_inset Quotes erd
17564 program for some illustrations of how all of these pieces go together or
17567 LIBDIR/examples/noweb2lyx.lyx.
17570 Interestingly, these three files show off the language-indepence of the
17571 LyX literate programming support since they are written in Python, C and
17575 \begin_layout Subsubsection
17579 \begin_layout Standard
17580 All the Literate Programming support is configured by the
17585 ools\SpecialChar \menuseparator
17593 \begin_inset Quotes eld
17597 \begin_inset Quotes erd
17601 The important parts are:
17604 \begin_layout Description
17607 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17615 format Set up via the Formats tab, this is where the Noweb-specific pieces
17625 , the file extension is set to
17630 This tells LyX to create a file with a
17634 extension in the first step of the conversion process.
17637 \begin_layout Description
17644 format This is an empty format whose sole purpose is to be the endpoint
17645 of a conversion (which then allows us to set up a converter for it).
17648 \begin_layout Description
17657 This converter performs the
17658 \begin_inset Quotes eld
17662 \begin_inset Quotes erd
17665 of the literate document.
17666 For Noweb, it is set to
17667 \begin_inset Quotes eld
17672 noweave -delay -index $$i > $$o
17675 \begin_inset Quotes erd
17681 \begin_layout Description
17691 \begin_inset Quotes eld
17695 \begin_inset Quotes erd
17699 As stated above, the Converter is set to
17700 \begin_inset Quotes eld
17708 \begin_inset Quotes erd
17711 , with Flags set to
17712 \begin_inset Quotes eld
17717 originaldir,parselog=listerrors
17720 \begin_inset Quotes erd
17726 \begin_layout Subsubsection
17730 \begin_layout Standard
17731 There is also a new function implemented in the LyX server, the
17732 \begin_inset Quotes eld
17735 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17739 \begin_layout Standard
17740 When debugging code with ddd/gdb, it is possible to invoke a text editor
17741 at the current execution position with a single key stroke.
17742 The default ddd configuration for that is shift-ctrl-V.
17743 It happens that you can define the editor command line invocation in ddd
17749 dit\SpecialChar \menuseparator
17754 references\SpecialChar \menuseparator
17761 dialog and changing the "Edit Sources" entry.
17764 \begin_layout Standard
17765 I take advantage of the new created LyX server function and this ddd feature,
17767 \begin_inset Quotes eld
17771 \begin_inset Quotes erd
17777 \begin_layout LyX-Code
17778 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17781 \begin_layout Standard
17782 With this, whenever you are using ddd and find a point in the program that
17783 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17784 ddd you forward this information to LyX through the LyX server and then
17785 the LyX window will show the same file with the cursor at the same position
17786 ddd was pointing to.
17787 No more guessing or long scrolling to locate a point in the program back
17791 \begin_layout Standard
17792 Note however that you must enable the LyX server to get this feature working
17793 (it is disabled by default).
17794 You can enable it in
17806 ) by entering in the
17811 \begin_inset Quotes eld
17816 /home/<your-home-directory>/.lyx/lyxpipe
17819 \begin_inset Quotes erd
17825 \begin_layout Standard
17826 Read the LyX server documentation in the
17828 Customization Manual
17830 for further information.
17833 \begin_layout Subsubsection
17837 \begin_layout Standard
17838 There are six new buttons that can be added to your LyX toolbar.
17839 Five of these buttons are short cuts to layout styles:
17860 The last one is a short cut to the
17861 \begin_inset Quotes eld
17865 \begin_inset Quotes erd
17872 \begin_layout Standard
17873 LyX has a range of buttons that are available for tool bar customization.
17874 In my toolbar I like to combine the six short cuts above with two more:
17882 \SpecialChar \menuseparator
17890 \SpecialChar \menuseparator
17903 iew\SpecialChar \menuseparator
17911 Here is how it looks like:
17914 \begin_layout LyX-Code
17918 \begin_layout LyX-Code
17922 \begin_layout LyX-Code
17923 Icon "layout Standard"
17926 \begin_layout LyX-Code
17927 Icon "layout Section"
17930 \begin_layout LyX-Code
17931 Icon "layout LaTeX"
17934 \begin_layout LyX-Code
17935 Icon "layout LyX-Code"
17938 \begin_layout LyX-Code
17939 Icon "layout Scrap"
17942 \begin_layout LyX-Code
17946 \begin_layout LyX-Code
17950 \begin_layout LyX-Code
17951 Icon "buffer-typeset"
17954 \begin_layout LyX-Code
17955 Icon "build-program"
17958 \begin_layout LyX-Code
17962 \begin_layout LyX-Code
17966 \begin_layout LyX-Code
17970 \begin_layout LyX-Code
17974 \begin_layout LyX-Code
17978 \begin_layout Subsubsection
17979 Colors customization
17982 \begin_layout Standard
17983 There are a number of colors in LyX that can be customized in
17988 One of the things that bothers people is the LaTeX font color.
17989 The default color is red, since the scraps uses LaTeX font, and there is
17990 a lot of scraps in literate documents, you may get tired of seeing everything
17992 You can change it by going to the tabs
18001 \begin_layout Standard
18002 The next thing is the visible presence of the newline character in the screen.
18003 You can choose the color of this particular character and make it blend
18005 I recommend you choosing a color that is close to the background but not
18006 equal, that way you still can see it is there, but it is not bothering
18011 \begin_layout Chapter
18012 Secrets of the LaTeX Masters
18013 \begin_inset CommandInset label
18022 \begin_layout Standard
18023 Though LyX is a powerful tool, it cannot hope to support everything that
18024 can be done with pure TeX/LaTeX.
18025 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18026 as long as you are not afraid to use that
18027 \begin_inset Quotes eld
18031 \begin_inset Quotes erd
18034 button on the toolbar or add things to the LaTeX preamble.
18035 This section lists some tips, tricks, and otherwise cool ideas to give
18036 your document that extra little flair.
18039 Do try this at home
18041 , just start with something a little smaller and less important than your
18045 \begin_layout Standard
18046 Most ideas in this section require less common files in your LaTeX installation.
18047 If you have a system like teTeX, most will already be available.
18048 A few, however, will need to be downloaded from one of the CTAN archives.
18049 Often, there are several ways to do something, or several LaTeX style files
18050 which do the same thing.
18051 We do not endorse one choice over another, we simply claim that we have
18052 done a particular task with a particular file.
18053 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18056 \begin_layout Section
18060 \begin_layout Standard
18063 Lars Gullik Bjønnes
18066 \begin_layout Subsection
18070 \begin_layout Standard
18071 The aim for this chapter
18075 \begin_layout Standard
18076 Editor's note: Lars' original chapter was a masterful description of how
18082 However, it was too long to flow smoothly in this document.
18083 I have therefore chosen to excerpt the most important sections here (sorry,
18084 Lars); you can read the original chapter (and more of the story!) in the
18087 examples/multicol.lyx
18095 is to show how the LaTeX package
18099 can be used in a LyX document.
18100 As LyX doesn't support the
18104 package natively yet, we have to use some small hacks.
18105 By reading this section it should be obvious how to do this.
18108 \begin_layout Subsection
18112 \begin_layout Standard
18117 package allows switching between one and multicolumn format on the same
18119 Footnotes are handled correctly (for the most part), but will be placed
18120 at the bottom of the page and not under each column.
18121 LaTeX's float mechanism, however, is partly disabled in the current implementat
18123 At the moment only page-wide floats can be used within the scope of the
18127 \begin_layout Subsection
18131 \begin_layout Subsubsection
18135 \begin_layout Standard
18136 If you want to have two columns in your text, you have use LaTeX mode to
18141 begin{multicols}{2}
18143 at the point where you want the two column layout to start, and then
18149 where you want it to end.
18153 \begin_layout Standard
18157 \begin_layout Standard
18161 begin{multicols}{2}
18169 \begin_layout Standard
18174 The Adventure of the Empty House
18180 Sir Arthur Conan Doyle
18183 \begin_layout Standard
18186 It was in the spring of the year 1894 that all London was interested, and
18187 the fashionable world dismayed, by the murder of the Honourable Ronald
18188 Adair under most unusual and inexplicable circumstances.
18189 The public has already learned those particulars of the crime which came
18190 out in the police investigation, but a good deal was suppressed upon that
18191 occasion, since the case for the prosecution was so overwhelmingly strong
18192 that it was not necessary to bring forward all the facts.
18193 Only now, at the end of nearly ten years, am I allowed to supply those
18194 missing links which make up the whole of that remarkable chain.
18195 The crime was of interest in itself, but that interest was as nothing to
18196 me compared to the inconceivable sequel, which afforded me the greatest
18197 shock and surprise of any event in my adventurous life.
18198 Even now, after this long interval, I find myself thrilling as I think
18199 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18200 ty which utterly submerged my mind.
18201 Let me say to that public, which has shown some interest in those glimpses
18202 which I have occasionally given them of the thoughts and actions of a very
18203 remarkable man, that they are not to blame me if I have not shared my knowledge
18204 with them, for I should have considered it my first duty to do so, had
18205 I not been barred by a positive prohibition from his own lips, which was
18206 only withdrawn upon the third of last month.
18209 \begin_layout Standard
18213 \begin_layout Standard
18225 \begin_layout Subsubsection
18229 \begin_layout Standard
18230 The same pattern is used when you want more than two columns:
18233 \begin_layout Standard
18237 \begin_layout Standard
18241 begin{multicols}{3}
18249 \begin_layout Standard
18252 It can be imagined that my close intimacy with Sherlock Holmes had interested
18253 me deeply in crime, and that after his disappearance I never failed to
18254 read with care the various problems which came before the public.
18255 And I even attempted, more than once, for my own private satisfaction,
18256 to employ his methods in their solution, though with indifferent success.
18257 There was none, however, which appealed to me like this tragedy of Ronald
18259 As I read the evidence at the inquest, which led up to a verdict of willful
18260 murder against some person or persons unknown, I realized more clearly
18261 than I had ever done the loss which the community had sustained by the
18262 death of Sherlock Holmes.
18263 There were points about this strange business which would, I was sure,
18264 have specially appealed to him, and the efforts of the police would have
18265 been supplemented, or more probably anticipated, by the trained observation
18266 and the alert mind of the first criminal agent in Europe.
18267 All day, as I drove upon my round, I turned over the case in my mind and
18268 found no explanation which appeared to me to be adequate.
18269 At the risk of telling a twice-told tale, I will recapitulate the facts
18270 as they were known to the public at the conclusion of the inquest.
18273 \begin_layout Standard
18277 \begin_layout Standard
18289 \begin_layout Standard
18290 You can have more than 3 columns if you want to, but that might not be very
18291 pleasant for the eye.
18294 \begin_layout Subsubsection
18295 Columns inside columns
18298 \begin_layout Standard
18299 You can even have columns inside columns:
18302 \begin_layout Standard
18306 \begin_layout Standard
18310 begin{multicols}{2}
18318 \begin_layout Standard
18321 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18322 at that time governor of one of the Australian colonies.
18323 Adair's mother had returned from Australia to undergo the operation for
18324 cataract, and she, her son Ronald, and her daughter Hilda were living together
18328 \begin_layout Standard
18332 \begin_layout Standard
18336 begin{multicols}{2}
18344 \begin_layout Standard
18347 The youth moved in the best society--had, so far as was known, no enemies
18348 and no particular vices.
18349 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18350 had been broken off by mutual consent some months before, and there was
18351 no sign that it had left any very profound feeling behind it.
18352 For the rest {sic} the man's life moved in a narrow and conventional circle,
18353 for his habits were quiet and his nature unemotional.
18354 Yet it was upon this easy-going young aristocrat that death came, in most
18355 strange and unexpected form, between the hours of ten and eleven-twenty
18356 on the night of March 30, 1894.
18359 \begin_layout Standard
18363 \begin_layout Standard
18375 \begin_layout Standard
18378 Ronald Adair was fond of cards--playing continually, but never for such
18379 stakes as would hurt him.
18380 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18381 It was shown that, after dinner on the day of his death, he had played
18382 a rubber of whist at the latter club.
18383 He had also played there in the afternoon.
18388 The evidence of those who had played with him-- Mr.
18389 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18390 and that there was a fairly equal fall of the cards.
18391 Adair might have lost five pounds, but not more.
18392 His fortune was a considerable one, and such a loss could not in any way
18394 He had played nearly every day at one club or other, but he was a cautious
18395 player, and usually rose a winner.
18396 It came out in evidence that, in partnership with Colonel Moran, he had
18397 actually won as much as four hundred and twenty pounds in a sitting, some
18398 weeks before, from Godfrey Milner and Lord Balmoral.
18399 So much for his recent history as it came out at the inquest.
18402 \begin_layout Standard
18406 \begin_layout Standard
18418 \begin_layout Standard
18419 Please do read the file
18421 examples/multicol.lyx
18423 for more advanced examples including column and header spacing, vertical
18424 separator lines, and more.
18427 \begin_layout Section
18432 Paragraph Environment
18433 \begin_inset OptArg
18436 \begin_layout Standard
18437 Numbering in Enumerate
18445 \begin_layout Standard
18451 \begin_layout Standard
18452 \begin_inset VSpace bigskip
18458 \begin_layout Standard
18460 The default numbering for the
18464 paragraph environment begins with Arabic numbers and ends with uppercase
18466 Suppose, however, you wanted a different type of numbering scheme.
18467 Here's a quickie example of how to change the numbering scheme:
18470 \begin_layout LyX-Code
18480 \begin_layout LyX-Code
18490 \begin_layout LyX-Code
18500 \begin_layout LyX-Code
18510 \begin_layout Standard
18511 \SpecialChar \ldots{}
18512 which changes the numbering scheme to uppercase Roman numerals, uppercase
18513 letters, Arabic numbers, and lowercase letter.
18516 \begin_layout Standard
18517 Additionally, the previous example also adds a little bit extra to the numbering
18519 For example, the first level label actually looks like:
18520 \begin_inset Quotes eld
18524 \begin_inset Quotes erd
18528 For ease of reading, we'll describe what the numbering schemes look like
18529 using a notation something like this: <
18530 \begin_inset Quotes eld
18534 \begin_inset Quotes erd
18539 \begin_inset Quotes erd
18543 \begin_inset Quotes erd
18548 \begin_inset Quotes erd
18552 \begin_inset Quotes erd
18557 \begin_inset Quotes eld
18561 \begin_inset Quotes erd
18568 \begin_layout Standard
18569 As you can see in the example, there is a label command for each nesting
18576 \SpecialChar \ldots{}
18583 , as well as a counter,
18587 \SpecialChar \ldots{}
18593 There are also five
18594 \begin_inset Quotes eld
18598 \begin_inset Quotes erd
18631 , each of which take one counter as an argument.
18632 You can add characters before or after these, but there's no need to add
18636 \begin_layout Standard
18637 You can get really fancy with these.
18641 \begin_layout LyX-Code
18655 \begin_layout LyX-Code
18667 \begin_layout LyX-Code
18677 \begin_layout LyX-Code
18687 \begin_layout Standard
18688 produces the somewhat out of hand numbering scheme: <
18689 \begin_inset Quotes eld
18693 \begin_inset Quotes erd
18698 \begin_inset Quotes erd
18702 \begin_inset Quotes erd
18707 \begin_inset Quotes erd
18711 \begin_inset Quotes erd
18716 \begin_inset Quotes eld
18720 \begin_inset Quotes erd
18727 \begin_layout Standard
18731 \begin_layout Section
18735 \begin_layout Standard
18741 \begin_layout Standard
18742 \begin_inset VSpace bigskip
18748 \begin_layout Standard
18753 \begin_layout Standard
18759 tmpfont}{cmr17 scaled 2500}{
18771 \begin_layout Standard
18776 \begin_layout Standard
18787 hose of you who like the style of old books probably also like
18788 \begin_inset Quotes eld
18792 \begin_inset Quotes erd
18795 ---those large capital letters which begin each new chapter or section.
18796 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18797 know some plain TeX!) but does require a lot of work and many iterations,
18798 as you can see by all the ugly TeX-mode stuff at the beginning of this
18802 \begin_layout Standard
18806 \begin_layout Standard
18812 bigdrop{-1em}{3}{ptmri}{T}+
18817 here is a much easier way of doing this, of course.
18826 ) package from CTAN allows a simple way to add such letters to your documents.
18827 Since this package is not a standard part of teTeX, I can't demonstrate
18828 it within this document, but if you copy this paragraph to a new document,
18830 \begin_inset Quotes eld
18840 \begin_inset Quotes erd
18843 and the pluses from the TeX code at the beginning of the paragraph, and
18848 usepackage{dropcaps}
18850 to your LaTeX preamble, you will get a nice Times Roman Italic
18851 \begin_inset Quotes eld
18855 \begin_inset Quotes erd
18858 , whose height is three lines of text and which protrudes 1 em into the
18860 (Make certain you have copied
18861 \begin_inset Quotes eld
18869 \begin_inset Quotes erd
18872 into a directory where TeX can see it.) The first argument is the amount
18873 of indentation; in this case the negative sign moves it into the margin.
18874 The second argument is the height of the letter in number of lines of text.
18875 The third argument is the font name: virtually anything which has a tfm
18876 file should work (wade through the
18878 .../texmf/fonts/tfm
18880 directory for possibilities).
18881 My personal favorite is
18882 \begin_inset Quotes eld
18890 \begin_inset Quotes erd
18893 , a fancy German font specifically designed for dropped capitals.
18894 The fourth argument is the letter (or letters) to be dropped.
18899 package also offers the
18905 command, as well as a slightly simplified
18914 \begin_layout Section
18915 Non-standard Paragraph Shapes
18918 \begin_layout Standard
18924 \begin_layout Standard
18925 \begin_inset VSpace bigskip
18931 \begin_layout Standard
18935 \begin_layout Standard
18947 \begin_layout Standard
18951 \begin_layout Standard
18960 \begin_layout Standard
18974 \begin_layout Standard
18979 \begin_layout Standard
18990 \begin_layout Standard
18999 \begin_layout Standard
19008 \begin_layout Standard
19017 \begin_layout Standard
19026 \begin_layout Standard
19035 \begin_layout Standard
19044 \begin_layout Standard
19053 \begin_layout Standard
19062 \begin_layout Standard
19071 \begin_layout Standard
19080 \begin_layout Standard
19089 \begin_layout Standard
19098 \begin_layout Standard
19107 \begin_layout Standard
19116 \begin_layout Standard
19125 \begin_layout Standard
19134 \begin_layout Standard
19143 \begin_layout Standard
19152 \begin_layout Standard
19158 There are times when the tyranny of rectangular paragraphs must be overthrown.
19159 In such situations, a call to the delightful plain TeX command
19166 As you can see, completely arbitrary shapes can be laid out with a suitable
19167 set of linelength definitions.
19168 While this parshape may look a bit silly and useless, one could conceive
19169 of situations such as finely tuned dropped capitals, word wrapping around
19170 non-rectangular graphics, etc.
19171 which will benefit from such handcrafting.
19174 \begin_layout Standard
19175 \begin_inset VSpace bigskip
19181 \begin_layout Standard
19186 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19193 is the number of lines of text which define the paragraph.
19194 If there turn out to be fewer lines, the shape is truncated; if there are
19195 more, the excess lines have the same dimensions as the last line of the
19205 entries specify the indentation of the line from the left margin, and the
19206 length of the line as measured from that point.
19207 The shape applies only to the current paragraph; everything is reset to
19208 normal for the next paragraph.
19211 \begin_layout Standard
19215 \begin_layout Standard
19227 \begin_layout Section
19231 \begin_layout Standard
19232 As you can see, the examples in this section range from the useful to the
19234 While I don't expect that anyone will ever need the paragraph shape demonstrate
19235 d in the last section, the important point is that you can do almost anything
19236 you want in LyX if you are willing to figure out how to do it in TeX and
19238 TeX is a fantastically powerful typesetting system and all that power is
19239 available to you since LyX uses it as its backend.