1 #LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 \paperfontsize default
21 \paperorientation portrait
24 \paragraph_separation indent
26 \quotes_language english
30 \paperpagestyle headings
31 \tracking_changes false
48 \begin_layout Standard
50 Principal maintainer of this file is
55 If you have comments or error corrections, please send them to the LyX
56 Documentation mailing list, <lyx-docs@lists.lyx.org>.
64 \begin_layout Standard
67 \begin_inset LatexCommand \tableofcontents{}
79 \begin_layout Standard
85 manual, which you are now reading, is essentially Part II of the
87 User's Guide\SpecialChar \@.
90 The reason for splitting this document is simple: the
94 is already huge, and it contains all of the basic features one needs to
95 know in order to prepare most documents.
96 However, the LyX Team has a long-term goal of making LyX extensible through
97 various configuration files and external packages.
98 That means that if you want to support the Fizzwizzle LaTeX package, you
99 can create a layout file for it without having to alter LyX itself.
100 We've already had contributions of several new features this way.
101 This is the place where all of that gets documented.
104 \begin_layout Standard
106 This manual also documents some special features, like fax support, version
107 control, and SGML support, which require additional software to work properly.
108 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
109 spruce up your documents by directly using the powerful features of LaTeX.
114 only WYSIWYM, and will only ever interface to certain LaTeX features.
117 \begin_layout Standard
119 Of course, with all of this extra documentation,
121 Extended LyX Features
123 may itself grow too big for its britches.
124 In that case, you can just call it the
125 \begin_inset Quotes eld
129 \begin_inset Quotes erd
135 \begin_layout Standard
137 If you haven't read the
141 yet, you are definitely in the wrong manual.
146 is the first place to go, since it will direct you to the correct manual,
147 and it also describes the notation and format of all of the manuals.
148 You should also be thoroughly familiar with the
152 and all of the basic features of LyX.
156 \begin_layout Standard
158 In this document, many sections are independent articles contributed by
159 an individual and are noted as such.
160 This person is generally whoever wrote the layout file for the new document
161 class or LaTeX package, or implemented the feature.
162 If there is no mention of an author to a chapter [or chapter sections],
163 that means it was written by the LyX Documentation Team.
166 \begin_layout Standard
168 Since all the topics in this manual depend heavily on LyX's interaction
169 with LaTeX, this first chapter covers
173 the inner workings of LyX and how to direct LyX to generate exactly the
175 It is obviously for more seasoned LyX users.
178 \begin_layout Chapter
183 \begin_layout Section
188 \begin_layout Standard
191 \begin_inset LatexCommand \label{sec:lyxandlatex}
195 This chapter is for both TeX-nicians and the LaTeX-curious.
196 In it, we'll explain how LyX and LaTeX work together to produce printable
198 This is the only place in any of the manuals where we assume you know something
202 \begin_layout Standard
204 At one time, we called LyX a
205 \begin_inset Quotes eld
208 WYSIWYM frontend to LaTeX,
209 \begin_inset Quotes erd
212 but that's no longer true.
213 There are frontends to LaTeX out there.
214 They are basically editors with the ability to run LaTeX and mark any errors
215 in the file you're editing.
224 run LaTeX, and it also marks errors in the file, it also does much, much
226 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
227 LyX has also added a few extensions to LaTeX.
228 Try the following sometime: select
230 Export\SpecialChar \menuseparator
240 menu, then look at the preamble of the resulting
245 You'll notice a variety of new macros defined specifically by LyX.
246 These macros are defined automatically, according to the features you use
250 \begin_layout Standard
252 There are several commands that automatically invoke LaTeX.
256 \begin_layout Itemize
263 iew\SpecialChar \menuseparator
270 \begin_layout Itemize
277 iew\SpecialChar \menuseparator
282 pdate\SpecialChar \menuseparator
288 \begin_layout Itemize
297 \SpecialChar \menuseparator
303 \begin_layout Itemize
312 \SpecialChar \menuseparator
318 \begin_layout Standard
320 They will only invoke LaTeX if the file has changed since the last time
325 \begin_layout Standard
327 When you run LaTeX on the file you're editing, LyX performs these steps:
330 \begin_layout Enumerate
332 Convert the document to LaTeX and save to a file with the extension
343 \begin_layout Enumerate
349 file (maybe several times).
352 \begin_layout Enumerate
354 If there are any errors, insert error boxes in the document to mark where
356 These boxes are transient and are not saved along with the document.
359 \begin_layout Standard
361 If you've run LaTeX using
383 , LyX performs two more steps:
386 \begin_layout Itemize
392 to convert the Dvi file to PostScript®:
396 \begin_layout Itemize
403 , the output file has the extension
408 \begin_layout Itemize
418 , the output file has the extension
425 \begin_layout Itemize
431 or send the PostScript® file to the printer.
434 \begin_layout Section
437 \begin_inset Quotes eld
440 Help! LyX generated an unreadable
445 \begin_inset Quotes erd
451 \begin_layout Standard
453 Die-hard LaTeX users will scream and howl this into the night, then declare
454 LyX useless, simply because they didn't RTFM.
457 \begin_layout Standard
459 We're going to set the record straight.
460 LyX produces two kinds of LaTeX files.
461 One is human readable.
462 The other is LyX readable.
463 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
469 file is not human readable.
470 Don't even try to read it.
475 file that you can send to a colleague, select
480 xport\SpecialChar \menuseparator
497 \begin_layout Section
499 Translating LaTeX files into LyX
502 \begin_layout Standard
504 You can import a LaTeX file into LyX by using the
509 ile\SpecialChar \menuseparator
514 mport\SpecialChar \menuseparator
522 This will call a Perl script named
526 ---which will create a file
534 ---and then open that file.
535 If the translation doesn't work, you can try calling
539 from the command line, possibly using fancier options.
542 \begin_layout Standard
548 will translate most legal LaTeX, but not everything.
549 It will leave things it doesn't understand in TeX mode, so after translating
554 , you can look for red text and hand-edit it to look right.
557 \begin_layout Standard
563 has its own section in the
567 manual (as well as a Unix manpage equivalent), which you should read to
568 find out about what LaTeX isn't supported, bugs (and how to get around
569 them), and how to use the various options.
572 \begin_layout Standard
578 to work, or you just want to put a piece of LaTeX code into a LyX file,
580 \begin_inset LatexCommand \ref{sec:latexcodes}
587 \begin_layout Section
589 Inserting LaTeX Code into LyX Documents
590 \begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
597 \begin_layout Standard
600 \begin_inset LatexCommand \label{sec:latexcodes}
604 This is a rather important point: You can always insert LaTeX code into
606 LyX simply cannot, and will probably never be able to, display every possible
608 If ever you need to insert LaTeX commands into your LyX document, you can
609 use the ERT box, which you can insert into your document with
614 nsert\SpecialChar \menuseparator
622 The ERT box comes in three forms: collapsed, open, and inlined.
623 The first two are used just like any other collapsable (foldable) box (such
624 as footnotes), and are useful for significant amounts of LaTeX commands.
626 \begin_inset Quotes eld
630 \begin_inset Quotes erd
633 ERT box displays its content as part of the button, and is useful for very
634 short sections of LaTeX commands.
639 \begin_layout Standard
648 \begin_layout Standard
650 You can switch between all three by right-clicking on the ERT.
651 Note that if you want more than one line of LaTeX commands, you cannot
652 use the inlined mode.
655 \begin_layout Standard
657 Here's an example of inserting LaTeX commands in a LyX document.
658 The code looks like this:
661 \begin_layout LyX-Code
671 This is an example for a minipage environment.
674 can put nearly everything in it, even (non-floating)
717 \begin_layout LyX-Code
721 \begin_layout Standard
723 The ERT box containing this text is directly after this paragraph.
724 Those of you reading the manual online will only see a bunch of funky text
726 Those reading a printed version of the manuals will see the actual results:
729 \begin_layout Standard
735 \begin_layout Standard
741 \begin_layout Standard
747 \begin_layout Standard
748 This is an example for a minipage environment. You can put nearly everything in it, even (non-floating) figures and tables.
751 \begin_layout Standard
757 \begin_layout Standard
761 \begin_layout Standard
767 \begin_layout Standard
773 \begin_layout Standard
779 \begin_layout Standard
783 \begin_layout Standard
789 \begin_layout Standard
795 \begin_layout Standard
801 \begin_layout Standard
812 \begin_layout Standard
814 In addition to these two methods, you can also create a separate file containing
815 some complex LaTeX structure.
821 nsert\SpecialChar \menuseparator
829 to include your file (you should select the type
834 We recommend that you only do this if you have a
843 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
847 \begin_layout Standard
849 There are a few last notes to emphasize:
852 \begin_layout Itemize
854 Inside of LyX, LaTeX code appears
859 \begin_layout Itemize
865 check if your LaTeX code is correct.
868 \begin_layout Itemize
870 Beware reinventing the wheel.
873 \begin_layout Standard
875 That last note refers to two things.
876 First, LyX does have quite a few features tucked into it, and more are
878 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
879 feature before you go off merrily coding LaTeX.
880 Second, there are numerous LaTeX packages out there to do all sorts of
881 things, from labels to envelopes to fancy multipage tables.
882 Check out a CTAN site for details (see Section
883 \begin_inset Quotes eld
887 \begin_inset Quotes erd
898 \begin_layout Standard
904 : I seem to do this an awful lot.
905 Sat down and merrily began coding something to print out labels, only to
906 learn that there were already 2 different LaTeX packages to do this.
907 Worse yet --- I had them already!
915 \begin_layout Standard
917 If you do need to do some wild and fancy things within your document, be
918 sure to check out a good LaTeX book for assistance.
919 There are a number of them listed in the bibliography of the
926 \begin_layout Standard
928 There are a number of LaTeX commands which have to be placed before the
929 beginning of the actual text.
930 They go into the preamble, and this is explained in the next section.
933 \begin_layout Section
935 LyX and the LaTeX Preamble
938 \begin_layout Subsection
940 About the LaTeX Preamble
943 \begin_layout Standard
946 \begin_inset LatexCommand \label{sec:preamble}
950 If you already know LaTeX, there is no need to explain here what the preamble
952 If you don't, the following will give you some ideas --- we recommend again
953 that you consult a LaTeX book for further information.
954 In any case, you should read the points below, because they explain what
955 you can do and what you don't need to do in the LaTeX preamble of a LyX
959 \begin_layout Standard
961 The LaTeX preamble comes at the very beginning of a document,
969 \begin_layout Itemize
971 declare the document class.
972 LyX already does this for you.
976 \begin_layout Standard
978 If you're a seasoned LaTeX-nician, and you have some custom document class
979 you want to use, check out the
983 for information on how to make LyX interface to it.
984 Be sure to submit your efforts to the LyX Team for inclusion in future
988 \begin_layout Itemize
990 declare the usage of packages.
991 LaTeX packages provide special commands, which are only available within
992 a document when the package has been declared in the preamble.
1001 forces all paragraphs to be indented.
1002 There are other packages for labels, envelopes, margins, etc.
1006 \begin_layout Itemize
1008 set counters, variables, lengths and widths.
1009 There are several LaTeX counters and variables which
1013 be set globally from within the preamble in order to have the desired effect.
1014 [There are other variables which you can set and reset inside the document,
1015 too.] Margins are a good example of something which must be set in the preamble.
1016 Another example is the label format for lists.
1017 You can actually set these just about anywhere, but it's best to do it
1018 just once, inside the preamble.
1021 \begin_layout Itemize
1023 declare user defined commands [with
1035 ], mostly abbreviations for LaTeX commands which appear very often inside
1037 Although the preamble is a good place to declare such commands, they
1041 be declared anywhere else [but
1045 they are used for the first time, of course\SpecialChar \ldots{}
1047 This can be useful if there is a lot of raw LaTeX code in your document,
1048 which normally should not be the case.
1051 \begin_layout Standard
1053 LyX adds its own set of definitions to the preamble of the
1058 This makes LaTeX files generated by LyX portable.
1061 \begin_layout Subsection
1063 Changing the Preamble
1066 \begin_layout Standard
1068 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1069 can't change them without patching LyX itself.
1070 You can, however, add your own stuff to the preamble.
1071 There are two ways to do this:
1074 \begin_layout Enumerate
1102 \SpecialChar \menuseparator
1110 dialog, depending on your frontend.
1111 Note that the LyX keybindings will not work in this dialog, alas.
1114 \begin_layout Enumerate
1116 Use the preamble contents you've added as your default template (see
1117 \begin_inset Quotes eld
1121 \begin_inset Quotes erd
1128 ), so that it will be the default preamble for any file you create.
1131 \begin_layout Standard
1133 LyX adds anything in the
1140 dialog to its own built-in preamble.
1141 Before adding your own declarations in the preamble, you should make sure
1142 that LyX doesn't already support what you want to do (remember what we
1143 said about reinventing the wheel?).
1146 make sure your preamble code is correct
1149 LyX doesn't check it.
1152 \begin_layout Subsection
1157 \begin_layout Standard
1159 Here are some examples of what you can add to a preamble, and what they
1163 \begin_layout Subsubsection
1168 \begin_layout Standard
1170 There are two variables under LaTeX that control page position:
1183 Their names should be self-explanatory.
1184 These variables are useful if you think for a moment about computer labels.
1185 Sometimes, the size of a print medium and the area of the medium that you
1186 can actually print on aren't the same.
1202 \begin_layout Standard
1204 The default values for
1216 are both 0 pt.,\InsetSpace ~
1219 the page isn't shifted.
1222 \begin_layout Standard
1224 Unfortunately, some DVI drivers always seem to shift the page.
1225 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1226 If you're using LyX on a system that you don't personally maintain, and
1227 your sysadmin is a doofus,
1240 Suppose you're left and top margins are always 0.5 inches too big.
1241 You can add this to the preamble:
1244 \begin_layout LyX-Code
1253 \begin_layout LyX-Code
1262 \begin_layout Standard
1264 \SpecialChar \ldots{}
1265 and your margins should now be correct.
1268 \begin_layout Subsubsection
1273 \begin_layout Standard
1275 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1276 There's a rather nice package, available at your nearest CTAN archive,
1277 for printing sheets of labels, called
1282 Now, your system may not have this package installed by default.
1283 We leave that up to you to check.
1284 You'll also want to read the documentation for it; we're not going to do
1286 Since this is an example, however, we'll give you an example of how you
1290 \begin_layout Standard
1292 First, make sure you're using the
1297 Next, you need to put the following in your preamble:
1300 \begin_layout LyX-Code
1307 \begin_layout LyX-Code
1314 \begin_layout LyX-Code
1321 \begin_layout LyX-Code
1328 \begin_layout LyX-Code
1335 \begin_layout LyX-Code
1342 \begin_layout LyX-Code
1349 \begin_layout Standard
1351 This sets things up for Avery® label sheets, stock #5360.
1352 You're now ready to print labels, but you'll need to insert LaTeX code,
1353 placing the commands
1365 around each label text.
1366 This and other special features of
1370 are explained in its documentation.
1373 \begin_layout Standard
1375 Someday, someone may write a LyX layout file to support this package directly.
1376 Maybe that someone is you.
1379 \begin_layout Subsubsection
1381 Example #3: Paragraph Indentation
1384 \begin_layout Standard
1386 Americans are trained to indent the first line of
1391 As with all of their other weird quirks, most Americans will whine and
1392 moan until they can have their way and indent the first line of all paragraphs.
1396 \begin_layout Standard
1402 : This was written by an American ---
1406 ! It's my perception of my fellow countrymen.
1407 Tough if you don't like it.
1416 \begin_layout Standard
1418 Of course, this behavior isn't standard typography.
1419 In books, you typically only indent the first line of a paragraph
1423 it follows another one.
1424 The idea behind indenting the first line of a paragraph is to distinguish
1425 neighboring paragraphs from one another.
1426 If there is no previous paragraph, for example, it follows a figure, or
1427 is the first paragraph in a section, then there is no special indentation.
1431 \begin_layout Standard
1433 If you're a typical American, though, you don't care about such esoteric
1434 things; you want your indentation! Add this to the preamble:
1437 \begin_layout LyX-Code
1441 usepackage{indentfirst}
1444 \begin_layout Standard
1446 If your TeX distribution isn't a braindead one, you'll have this package,
1447 and all of your paragraphs will get the indentation you think they deserve.
1450 \begin_layout Subsubsection
1452 Example #4: This Document
1455 \begin_layout Standard
1457 You can also check out the preamble of this document to get an idea of some
1458 of the advanced things you can do.
1459 You'll probably need to make the
1464 reamble\SpecialChar \ldots{}
1467 dialog full-screen to see most of it.
1468 Also, there are more examples and an assortment of LaTeX
1469 \begin_inset Quotes eld
1473 \begin_inset Quotes erd
1476 given in Chapter\InsetSpace ~
1478 \begin_inset LatexCommand \ref{cha:secrets}
1486 \begin_layout Section
1488 LyX and LaTeX Errors
1491 \begin_layout Standard
1493 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1495 It then uses the log-file from the LaTeX run to do a post-mortem.
1496 As we stated earlier in the chapter, LyX generates two kinds of
1500 files, one of which it uses to locate errors in the document.
1501 If there was an error someplace, LyX will put a box with the word
1502 \begin_inset Quotes eld
1506 \begin_inset Quotes erd
1509 at the appropriate place in the document.
1513 \begin_layout Standard
1515 LyX will occasionally misguess where the error was.
1516 This will typically happen with tables, figures, math, and the preamble.
1521 It will also display a message alerting you to the fact that there were
1525 \begin_layout Standard
1527 You can navigate through the errors by using
1543 \begin_inset Quotes eld
1547 \begin_inset Quotes erd
1550 the error-boxes and view the error message LaTeX produced by clicking on
1554 \begin_layout Standard
1556 Some folks also like to look at the log file directly, accessible from
1562 ocument\SpecialChar \menuseparator
1572 There are some fairly common error messages and warnings.
1573 We'll cover those here.
1574 You should look at a good LaTeX book for a complete listing.
1577 \begin_layout Itemize
1580 \begin_inset Quotes eld
1588 \begin_inset Quotes eld
1595 \begin_layout Standard
1597 Anything beginning with these word is a warning message for the purpose
1599 \begin_inset Quotes eld
1603 \begin_inset Quotes erd
1606 the LaTeX code itself.
1607 You'll get messages like this if you added or changed cross-references
1608 or bibliography entries, in which case, LaTeX is trying to tell you that
1609 you need to make another run.
1612 \begin_layout Standard
1614 You can by-and-large ignore these.
1617 \begin_layout Itemize
1620 \begin_inset Quotes eld
1628 \begin_inset Quotes erd
1635 \begin_layout Standard
1637 Another warning message, this time about fonts which LaTeX couldn't find.
1638 The rest of the message will often say something about a replacement font
1642 \begin_layout Standard
1644 You can safely ignore these.
1647 \begin_layout Itemize
1650 \begin_inset Quotes eld
1660 \begin_inset Quotes erd
1667 \begin_layout Standard
1674 They are warning you about lines that were too long and run past the right
1676 Almost always, this is unnoticeable in the final output.
1677 Or, only one or two characters extend past the margin.
1678 LaTeX seems to generate at least one of these messages for just about any
1682 \begin_layout Standard
1684 You can ignore these stupid messages.
1685 Your eyes will tell you if there's a problem with something that's too
1686 wide; just look at the output.
1689 \begin_layout Itemize
1692 \begin_inset Quotes eld
1702 \begin_inset Quotes erd
1709 \begin_layout Standard
1711 Not quite as common as its cousin.
1712 LaTeX seems to like to print lines that are a bit too wide as opposed to
1713 ones that are a bit too narrow.
1714 We have no idea why.
1717 \begin_layout Standard
1719 You can ignore these, too.
1722 \begin_layout Itemize
1725 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1739 \begin_inset Quotes eld
1749 \begin_inset Quotes erd
1756 \begin_layout Standard
1758 Warnings about troubles breaking the page.
1759 Once again, just look at the output.
1760 Your eyes will tell you where something has gone wrong.
1763 \begin_layout Itemize
1766 \begin_inset Quotes eld
1772 \begin_inset Quotes els
1776 \begin_inset Quotes ers
1782 \begin_inset Quotes erd
1789 \begin_layout Standard
1792 \begin_inset Quotes eld
1796 \begin_inset Quotes erd
1799 isn't installed on this system.
1800 This usually appears because some package your document needs isn't installed.
1801 If you didn't touch the preamble or didn't use the
1807 command, then one of the packages LyX tried to load is missing.
1813 elp\SpecialChar \menuseparator
1820 , to get a list of packages that LyX knows about.
1821 This file is updated whenever you reconfigure LyX (using
1828 \SpecialChar \menuseparator
1833 ) and tells you which packages have been detected and what they do.
1836 \begin_layout Standard
1848 command, and the package in question isn't installed, you'll need to install
1852 \begin_layout Itemize
1855 \begin_inset Quotes eld
1860 LaTeX Error: Unknown option
1863 \begin_inset Quotes erd
1870 \begin_layout Standard
1872 Error messages beginning with this are trying to tell you that you specified
1873 a bad or undefined option to a package.
1874 Check the package's documentation.
1877 \begin_layout Itemize
1880 \begin_inset Quotes eld
1885 Undefined control sequence
1888 \begin_inset Quotes erd
1895 \begin_layout Standard
1897 If you've inserted LaTeX code into your document, but made a typo, you'll
1899 You may have forgotten to load a package.
1900 In any case, this error message usually means that you used an undefined
1904 \begin_layout Standard
1906 There are other error and warning messages.
1907 Some are self-explanatory.
1908 These are usually LaTeX messages.
1909 Others are downright cryptic.
1910 These are actually TeX error messages, and we really have
1914 what they mean or how to decipher them.
1917 \begin_layout Standard
1919 There's a general sequence you should follow if you get error messages:
1922 \begin_layout Enumerate
1924 Look at the LaTeX code you inserted for typos.
1927 \begin_layout Enumerate
1929 If there are no typos, check and see that you used the command(s) correctly.
1932 \begin_layout Enumerate
1934 If you get a bunch of error boxes piled up at the very top of the document,
1935 it means that there are errors in the preamble.
1936 Start debugging your preamble.
1939 \begin_layout Enumerate
1941 If you didn't add anything to the preamble and didn't add any LaTeX code
1942 to the document, the first suspect is your LaTeX distribution itself.
1943 Check for missing packages and install them.
1946 \begin_layout Enumerate
1948 Okay, so there are no missing packages.
1949 Did you use any of the fine-tuning options in LyX? Specifically, did you
1954 any of them, like trying to manually insert lots of
1956 Protected\InsetSpace ~
1967 s? Did you try to kludge something together with these instead of using
1968 the appropriate paragraph environment?
1971 \begin_layout Enumerate
1973 All right, you didn't use any of the fine-tuning options, you played by
1975 Did you try to pull a fancy maneuver? Did you do something funky inside
1976 a table or an equation, like inserting a graphic into a table cell?
1979 \begin_layout Enumerate
1981 Do you have long sections of text where LaTeX cannot find a place to break
1982 a line? By default, LaTeX is rather strict about how much extra inter-word
1983 spacing it will add in order to break a line.
1984 Preferrably, you should rework the paragraph to avoid the problem.
1985 If this isn't an option, you can wrap your text in
1991 to make LaTeX's line breaking more, well, sloppy.
1994 \begin_layout Enumerate
1996 Did you go overboard with the nesting? LyX (currently) doesn't check to
1997 make sure you're in the limits for nesting environments.
1998 If you nested a bunch of environments to the
1999 \begin_inset Formula $17^{\mathrm{th}}$
2002 level, that's the problem.
2005 \begin_layout Enumerate
2007 Okay, you didn't get any error messages, but your output looks whacked.
2008 If you have a table or figure that's too wide or long for the page, you
2013 \begin_layout Enumerate
2015 rescale the figure so it fits.
2018 \begin_layout Enumerate
2020 trim down the table so it fits.
2023 \begin_layout Standard
2025 If something else is wrong with the output, and you didn't try to pull anything
2026 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2029 \begin_layout Standard
2031 If all this doesn't help --- well, then
2035 you might have found a bug in LyX\SpecialChar \ldots{}
2039 \begin_layout Chapter
2044 \begin_layout Section
2046 Preparing a Bibliography with BibTeX
2049 \begin_layout Standard
2056 \begin_layout Standard
2059 \begin_inset VSpace bigskip
2066 \begin_layout Standard
2068 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
2074 setting up your own bibliographic databases),
2078 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2080 LaTeX: A Document Preparation System
2082 , particularly Appendix B.
2083 The rest of this discussion assumes you have created a correct bibliography
2084 file, that you have all relevant environment variables set correctly (esp.
2097 ), and that if sufficiently desperate, you could create and
2098 \begin_inset Quotes eld
2102 \begin_inset Quotes erd
2105 a LaTeX file with a BibTeX database.
2109 \begin_layout Standard
2111 For those who don't know what BibTeX is, it is a system for creating a large
2112 database of your most used journal references.
2113 For all future articles you write, you only need to include this standard
2114 database and reference the appropriate key to each reference.
2115 Even if you write only a few papers with handful of references each, it
2116 is well worth your time to examine BibTeX and decide whether it will be
2120 \begin_layout Standard
2122 To use BibTeX with LyX, first read the
2126 where it describes how to insert citations.
2127 The basic mechanism for inserting BibTeX references is the same.
2128 Then, at the very end of your document, select
2130 Insert\SpecialChar \menuseparator
2135 TOC\SpecialChar \menuseparator
2139 In the resulting dialog, fill out the dialog boxes as follows:
2142 \begin_layout Description
2144 Database: enter the name of your
2157 For searching multiple
2161 files, just enter them in the desired order, separated by commas.
2165 \begin_layout Description
2167 Style: enter the name of your BibTeX style file *without* the
2172 The default style is
2176 (which should be included in your LaTeX distribution, so you don't have
2177 to worry about creating it).
2180 \begin_layout Standard
2182 For each citation, assuming that the source is in the
2191 nsert\SpecialChar \menuseparator
2198 at the correct location in the text, and enter the appropriate reference
2200 Nothing else is required; when invoking
2205 iew\SpecialChar \menuseparator
2212 , for example, you should see that BibTex and LaTeX are invoked as needed,
2213 including multiple invocations of LaTeX.
2217 \begin_layout Section
2222 \begin_layout Standard
2224 A good index is one of the hardest things to make in a lengthy document,
2225 but LyX helps make things a bit simpler by interfacing to the
2229 program which is found in most recent LaTeX distributions.
2230 Inserting an index and marking words to include in it works much the same
2231 way as preparing a bibliography as mentioned in the last section.
2234 \begin_layout Standard
2236 First, go to the end of your file and select
2241 nsert\SpecialChar \menuseparator
2252 C\SpecialChar \menuseparator
2265 Then, for each word you would like to include in the index, go to the end
2266 of that word and click on
2271 nsert\SpecialChar \menuseparator
2284 This will insert a tag showing the word as it will appear in the index.
2285 That's all there is to it; LyX will automatically call
2289 for you and create the index itself.
2290 The text in the dialog available from right-clicking on the index button
2291 accepts LaTeX, so you'll need to be careful to avoid using any special
2293 On the positive side, you can use the advanced options - have a look at
2294 the documentation which comes with your LaTeX distribution to find out
2295 how to do things like
2296 \begin_inset Quotes eld
2300 \begin_inset Quotes erd
2306 \begin_layout Standard
2308 Be careful not to put spaces between the word in the text and the index
2309 marker; apparently the wrong page number can be produced if this happens.
2312 \begin_layout Section
2317 \begin_layout Subsection
2322 \begin_layout Standard
2324 When you are working on a large file with many sections, it is often convenient
2325 to break up the document into several files, or perhaps you have something
2326 where a table may change from time to time, but the preceding text does
2328 In these cases, you should seriously consider using multipart documents.
2329 For example, scientific papers often have five major sections: the introduction
2330 , observations, results, discussion, and conclusion.
2331 Each of these could be its own separate LyX file, with one
2332 \begin_inset Quotes eld
2336 \begin_inset Quotes erd
2339 file which contains the title, authors, abstract, references, etc., plus
2340 the five included files.
2341 It is important to note that each of these files is a full LyX file which
2342 can be formatted and printed on its own, as well as included in a master
2344 Each of these files must have the same document class, however--- don't
2345 attempt to mix book classes with article classes.
2346 You may also include LaTeX files; however, these files must not have their
2352 everything up to and including the
2364 line must be deleted) or else errors will be generated when you try to
2368 \begin_layout Standard
2370 LyX allows you to include files quite easily with
2375 nsert\SpecialChar \menuseparator
2384 When you click on this selection a small box is inserted into the file
2385 at the current cursor location.
2386 Clicking on the box raises a dialog which allows you to select the file
2387 to be included, and the method of its inclusion.
2391 \begin_layout Standard
2393 The file selection box should by now be obvious.
2394 The three inclusion methods are
2395 \begin_inset Quotes eld
2399 \begin_inset Quotes erd
2403 \begin_inset Quotes eld
2407 \begin_inset Quotes erd
2411 \begin_inset Quotes eld
2415 \begin_inset Quotes erd
2419 The difference between
2420 \begin_inset Quotes eld
2424 \begin_inset Quotes erd
2428 \begin_inset Quotes eld
2432 \begin_inset Quotes erd
2435 is really only meaningful to LaTeXperts, but the practical difference is
2436 that files which are
2437 \begin_inset Quotes eld
2441 \begin_inset Quotes erd
2444 are typeset beginning on a new page, while files which are
2445 \begin_inset Quotes eld
2449 \begin_inset Quotes erd
2452 are typeset starting on the current page.
2453 Perhaps the labeling in LyX will be changed someday to reflect this.
2456 \begin_layout Standard
2458 Generally, the master file is converted into a full LaTeX file before typesettin
2459 g, while the included files are converted to LaTeX files which do not have
2460 all the preamble information.
2470 button prevents this conversion.
2473 \begin_layout Standard
2476 \begin_inset Quotes eld
2480 \begin_inset Quotes erd
2483 included file allows you to include a file typeset exactly as it appears
2484 in the file, i.e.\InsetSpace ~
2485 verbatim mode, with the characters set in a fixed-width
2487 Normally, spaces in this file are invisible, though two consecutive spaces
2488 are conserved, unlike LyX's normal treatment of spaces.
2489 However, setting the
2499 checkbox typesets a mark to unambiguously define the presence of a space.
2505 \begin_layout Subsection
2507 Cross-References Between Files
2510 \begin_layout Standard
2512 It is possible to set up cross-references between the different files.
2513 First, open all the files in question: let's call them A and B in a two
2514 file example, where B is included in A.
2515 Let's say you insert a label in A, then want to reference it in B.
2516 Open the cross-reference dialog in whilst in document B, and you can select
2518 \begin_inset Quotes eld
2522 \begin_inset Quotes erd
2528 \begin_layout Section
2533 \begin_layout Standard
2539 is needed by LyX to be able to output algorithm floats.
2540 These are useful in placing short algorithms across page breaks and support
2541 an index of algorithms too.
2544 \begin_layout Section
2549 \begin_layout Standard
2555 is used by LyX when you select ``subfigure'' in the graphics dialog and
2556 enter the subfigure caption.
2557 Several figures marked in this way can be packed into a single float with
2558 individual sub-captions.
2561 \begin_layout Section
2563 Fancy Headers and Footers
2566 \begin_layout Standard
2568 The default page layout is rather plain; for an article document class,
2569 all you get is a centered page number at the bottom of the page.
2570 This document is the book class, so it appears to be a bit fancier, but
2571 to really put on a show, you need to set the document page style to
2572 \begin_inset Quotes eld
2576 \begin_inset Quotes erd
2579 , as mentioned in the
2585 This section describes the LaTeX codes you need to insert in your LaTeX
2586 preamble or the text in order to get the desired effects.
2589 \begin_layout Standard
2591 The page header is divided into three fields, not surprisingly labeled
2592 \begin_inset Quotes eld
2596 \begin_inset Quotes erd
2600 \begin_inset Quotes eld
2604 \begin_inset Quotes erd
2608 \begin_inset Quotes eld
2612 \begin_inset Quotes erd
2616 The footer is also divided into these three fields.
2617 The LaTeX commands to set these fields in the simplest manner are
2642 Suppose you wish to put your name in the upper left hand corner of each
2644 Simply insert the following command in the preamble:
2647 \begin_layout Standard
2657 \begin_layout Standard
2659 You will now see your name in the upper left.
2660 If a field has a default entry that you would like to get rid of (often
2661 the page number appears in the central footer, simply include a command
2662 with a blank argument, e.g.
2665 \begin_layout Standard
2674 \begin_layout Standard
2676 Let's get really fancy: lets put the section number with the word
2677 \begin_inset Quotes eld
2681 \begin_inset Quotes erd
2685 Section 3) in the upper left, the page number (e.g.
2686 Page 4) in the upper right, your name in the lower left, and the date in
2688 The following commands should now appear in the preamble:
2691 \begin_layout Standard
2702 \begin_layout Standard
2711 \begin_layout Standard
2722 \begin_layout Standard
2732 \begin_layout Standard
2741 \begin_layout Standard
2752 \begin_layout Standard
2766 access LaTeX's section and page counters, and so print out the current
2767 section and page numbers.
2774 simply prints out today's date.
2777 \begin_layout Standard
2779 The thicknesses of the horizontal rules drawn beneath the header and above
2780 the footer can also be modified.
2781 If you don't want one of the headers, set its thickness to 0.
2782 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2783 Use the commands, e.g.
2790 headrulewidth}{0.4pt}
2798 footrulewidth}{0.4pt}
2800 to set the thicknesses.
2803 \begin_layout Standard
2805 You can switch the header/footer settings on and off for individual pages
2810 thispagestyle{empty}
2816 thispagestyle{plain}
2822 thispagestyle{fancy}
2825 Simply insert them in the text on the page you want changed and mark them
2827 In fact, title pages are marked as plain by default, while following pages
2828 are marked fancy when using the global fancy setting.
2831 \begin_layout Standard
2833 There are more complex commands which will let you insert things in the
2834 upper left on odd numbered pages, etc., but I will refer you to the
2838 package documentation for more descriptions.
2839 For example, if you have a teTeX installation, look for
2841 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2847 \begin_layout Standard
2849 As a final example, it is possible to include an Encapsulated PostScript®
2850 file in the header or footer.
2851 Suppose you want to put a company logo in the upper lefthand corner.
2852 You might try something like
2855 \begin_layout Standard
2865 includegraphics{logo.eps}}}
2868 \begin_layout Standard
2870 (you may need to preface this with
2874 usepackage{graphics}
2876 if you don't include EPS files elsewhere in your document).
2879 \begin_layout Section
2884 \begin_layout Standard
2886 LaTeX provides a mechanism to produce essentially a page within a page,
2888 Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
2890 LyX also provides some of the minipage capability.
2893 \begin_layout Standard
2895 Minipages in LyX have their own collapsable box; insert one via
2900 nsert\SpecialChar \menuseparator
2908 Right-clicking on the box allows you to alter the minipage's width and
2909 alignment within the page.
2910 Warning: if the minipage is too long to fit on a page, it is truncated,
2911 not wrapped onto the next page.
2914 \begin_layout Standard
2916 If you place two minipages side-by-side, you can use
2921 nsert\SpecialChar \menuseparator
2929 to insert a special instruction known in the LaTeX world as an
2933 to put a maximum amount of space between them; it forces one minipage to
2934 the left edge, the other to the right edge.
2935 The examples below show the difference.
2938 \begin_layout Standard
2941 \begin_inset Box Frameless
2950 height_special "totalheight"
2953 \begin_layout Standard
2955 This is a minipage which does not use hfill.
2956 This is the second sentence of a minipage which does not use hfill.
2964 \begin_layout Standard
2967 \begin_inset Box Frameless
2976 height_special "totalheight"
2979 \begin_layout Standard
2981 This is a second minipage which does not use hfill.
2982 This is the second sentence of a second minipage which does not use hfill.
2991 \begin_layout Standard
2994 \begin_inset VSpace medskip
3000 \begin_layout Standard
3002 Here is some normal text to separate the two examples.
3005 \begin_layout Standard
3008 \begin_inset VSpace medskip
3015 \begin_layout Standard
3018 \begin_inset Box Frameless
3027 height_special "totalheight"
3030 \begin_layout Standard
3032 This is a minipage which does use hfill.
3033 This is the second sentence of a minipage which does use hfill.
3041 \begin_inset Box Frameless
3050 height_special "totalheight"
3053 \begin_layout Standard
3055 This is a second minipage which does use hfill.
3056 This is the second sentence of a second minipage which does use hfill.
3064 \begin_layout Section
3066 Wrapping Text Around Figures
3067 \begin_inset LatexCommand \label{sec:floatflt}
3074 \begin_layout Standard
3077 \begin_inset Wrap figure
3082 \begin_layout Standard
3085 \begin_inset Graphics
3096 \begin_layout Caption
3098 This is a wrapped figure, and this is the brilliant caption that describes
3107 \begin_layout Standard
3109 A very frequently asked question is whether text can be made to
3110 \begin_inset Quotes eld
3114 \begin_inset Quotes erd
3117 around figures so that a figure occupies some fraction of the column width
3118 and text fills the rest.
3119 If you have the LaTeX package
3123 installed (you can find out about it in the
3127 manual) you can do this.
3130 \begin_layout Standard
3132 At the right is a figure of a mobius strip---you should have already seen
3138 To wrap the text like this insert a wrap box via
3143 nsert\SpecialChar \menuseparator
3148 ts\SpecialChar \menuseparator
3154 \begin_layout Standard
3156 Note: this package is very fragile! For example, having a figure too close
3157 to the bottom of the page will mess things up, as will having two figures
3159 Use this package sparingly and do read the documentation that came with
3160 it (which will also tell you how to wrap text around tables).
3163 \begin_layout Section
3168 \begin_layout Standard
3170 While the standard table layout will suffice in 99% of all tables you generate,
3171 occasionally you will run into one which requires a bit of extra tweaking.
3172 The table dialog which appears on a right-click of a table allows these
3174 It will give you access to some extra column alignment parameters.
3175 A little bit of LaTeX background is useful here: when you set up a table
3176 in LaTeX, each column is given an alignment type.
3177 For example, you would give it
3178 \begin_inset Quotes eld
3186 \begin_inset Quotes erd
3190 \begin_inset Quotes eld
3198 \begin_inset Quotes erd
3202 \begin_inset Quotes eld
3210 \begin_inset Quotes erd
3213 for left-aligned, centered, and right-aligned columns respectively (which
3214 appear as the left/center/right radio buttons in LyX).
3216 \begin_inset Quotes eld
3224 \begin_inset Quotes erd
3227 , which will make a column of a specified width (the width box in LyX),
3228 and will wrap text within that box.
3230 \begin_inset Quotes eld
3238 \begin_inset Quotes erd
3241 (vertical bar) which rather than making a column will make a vertical rule
3242 at that point; this manifests itself in LyX as the
3243 \begin_inset Quotes eld
3247 \begin_inset Quotes erd
3251 Finally, there is a type
3252 \begin_inset Quotes eld
3260 \begin_inset Quotes erd
3263 , which allows you to use whatever is enclosed in the accompanying braces
3264 as the column separator, including a null argument.
3265 The reasons for doing this may not be obvious, but they can be very powerful.
3266 They are best demonstrated by example.
3269 \begin_layout Subsection
3271 Removing Extra Column Space
3274 \begin_layout Standard
3276 Here is a standard table:
3279 \begin_layout Standard
3282 \begin_inset Tabular
3283 <lyxtabular version="3" rows="3" columns="2">
3285 <column alignment="left" valignment="top" width="0pt">
3286 <column alignment="left" valignment="top" leftline="true" width="0pt">
3287 <row bottomline="true">
3288 <cell alignment="left" valignment="top" topline="true" usebox="none">
3291 \begin_layout Standard
3307 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3310 \begin_layout Standard
3328 <cell alignment="left" valignment="top" topline="true" usebox="none">
3331 \begin_layout Standard
3347 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3350 \begin_layout Standard
3368 <cell alignment="center" valignment="top" topline="true" usebox="none">
3371 \begin_layout Standard
3387 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3390 \begin_layout Standard
3414 \begin_layout Standard
3416 Notice that the horizontal rule extends a bit past the text on both sides.
3417 If you wanted the line to end even with the text, we can put a null separator
3418 on the ends to get rid of the bit of extra space LaTeX adds by default.
3419 Here is the example:
3422 \begin_layout Standard
3425 \begin_inset Tabular
3426 <lyxtabular version="3" rows="3" columns="2">
3428 <column alignment="left" valignment="top" width="0pt" special="@{} l">
3429 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
3430 <row bottomline="true">
3431 <cell alignment="left" valignment="top" topline="true" usebox="none">
3434 \begin_layout Standard
3450 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3453 \begin_layout Standard
3471 <cell alignment="left" valignment="top" topline="true" usebox="none">
3474 \begin_layout Standard
3490 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3493 \begin_layout Standard
3511 <cell alignment="center" valignment="top" topline="true" usebox="none">
3514 \begin_layout Standard
3530 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3533 \begin_layout Standard
3557 \begin_layout Standard
3559 In this case, the column specifier for the left column was set to
3560 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 , while the right column was set to
3572 \begin_inset Quotes eld
3580 \begin_inset Quotes erd
3583 , in order to put the null characters on the edges.
3587 \begin_layout Subsection
3589 Changing the Column Separator Character
3592 \begin_layout Standard
3594 Now suppose you really wanted, for reasons that are completely opaque, to
3596 \begin_inset Formula $\sqrt{\pi}$
3599 with some space around it for the column separator.
3600 Simply turn off the vertical border, then set the right column specifier
3602 \begin_inset Quotes eld
3614 \begin_inset Quotes erd
3618 You could now make a table like this:
3621 \begin_layout Standard
3624 \begin_inset Tabular
3625 <lyxtabular version="3" rows="3" columns="2">
3627 <column alignment="left" valignment="top" width="0pt">
3628 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3629 <row bottomline="true">
3630 <cell alignment="left" valignment="top" topline="true" usebox="none">
3633 \begin_layout Standard
3649 <cell alignment="left" valignment="top" topline="true" usebox="none">
3652 \begin_layout Standard
3670 <cell alignment="left" valignment="top" topline="true" usebox="none">
3673 \begin_layout Standard
3689 <cell alignment="center" valignment="top" topline="true" usebox="none">
3692 \begin_layout Standard
3710 <cell alignment="center" valignment="top" topline="true" usebox="none">
3713 \begin_layout Standard
3729 <cell alignment="center" valignment="top" topline="true" usebox="none">
3732 \begin_layout Standard
3756 \begin_layout Subsection
3758 Making a Decimal Point Aligned Column
3761 \begin_layout Standard
3763 Okay, that last example was very silly, but here is one that is not.
3764 Suppose you want to make a table that has a column which is aligned on
3766 A standard LaTeX trick to do this is to set the whole number part in a
3767 right-aligned column, use a decimal point for the column separator, then
3768 set the fractional part as a left-aligned column.
3769 A variation on this is to include the decimal point explicitly with the
3770 whole part, then use just a null separator in between.
3771 The latter variation is demonstrated here:
3774 \begin_layout Standard
3777 \begin_inset Tabular
3778 <lyxtabular version="3" rows="5" columns="3">
3780 <column alignment="center" valignment="top" width="0pt">
3781 <column alignment="right" valignment="top" leftline="true" width="0pt">
3782 <column alignment="center" valignment="top" width="0pt" special="@{} l">
3783 <row bottomline="true">
3784 <cell alignment="center" valignment="top" topline="true" usebox="none">
3787 \begin_layout Standard
3803 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
3806 \begin_layout Standard
3822 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
3825 \begin_layout Standard
3833 <cell alignment="center" valignment="top" topline="true" usebox="none">
3836 \begin_layout Standard
3848 \begin_inset Formula $\pi$
3856 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
3859 \begin_layout Standard
3875 <cell alignment="center" valignment="top" topline="true" usebox="none">
3878 \begin_layout Standard
3896 <cell alignment="center" valignment="top" topline="true" usebox="none">
3899 \begin_layout Standard
3911 \begin_inset Formula $\pi^{\pi}$
3919 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3922 \begin_layout Standard
3938 <cell alignment="center" valignment="top" topline="true" usebox="none">
3941 \begin_layout Standard
3959 <cell alignment="center" valignment="top" topline="true" usebox="none">
3962 \begin_layout Standard
3974 \begin_inset Formula $(\pi^{\pi})^{\pi}$
3982 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3985 \begin_layout Standard
4001 <cell alignment="center" valignment="top" topline="true" usebox="none">
4004 \begin_layout Standard
4012 <cell alignment="center" valignment="top" topline="true" usebox="none">
4015 \begin_layout Standard
4027 \begin_inset Formula $\pi^{\pi^{\pi}}$
4035 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4038 \begin_layout Standard
4054 <cell alignment="center" valignment="top" topline="true" usebox="none">
4057 \begin_layout Standard
4069 \begin_inset Formula $\times10^{18}$
4085 \begin_layout Standard
4087 Though it appears a bit funny in LyX, on paper it will produce what appears
4088 to be a 2-column table in which the right column is aligned on the decimal
4089 point and the header appears to be centered over it.
4092 \begin_layout Standard
4094 Perhaps it is best if I described just what I did: first, create a 3
4095 \begin_inset Formula $\times$
4098 3 table and remove all the borders.
4099 Then re-add a bottom border to the top row, and a right border to the first
4101 Type in the values for the first column and set its alignment to
4123 and set that column's alignment to
4139 \begin_inset Formula $\times10^{18}$
4144 and set the extra column alignment to
4149 Finally type in the word
4153 in the middle column, highlight it and the blank entry to its right, and
4166 \begin_layout Subsection
4168 A Better Decimal-Alignment Solution
4171 \begin_layout Standard
4173 An alternative way to have decimal alignment in tables is through the
4178 Add the following to the LateX preamble:
4181 \begin_layout LyX-Code
4188 \begin_layout LyX-Code
4192 newcolumntype{d}[1]{D{.}{.}{#1}}
4195 \begin_layout Standard
4197 To have a column decimally aligned, enter in the
4199 Special Column Alignment
4205 dialog the following:
4208 \begin_layout LyX-Code
4210 d{number of decimals of the data}
4213 \begin_layout Standard
4215 To create extra column space just increase the number of decimals in
4220 Setting the multicolumn attribute for a single cell makes it insensitive
4221 to the decimal alignment which comes in handy as well.
4222 A drawback of this method is that math mode is not allowed in a column
4223 with decimal alignment except if the multicolumn attribute is set.
4226 \begin_layout Standard
4228 This method offers the same flexibility as the
4233 One could, for example, change the alignment separator, and have different
4234 alignment separators for different columns by defining multiple column
4235 types in the preamble.
4236 The syntax is as follows:
4239 \begin_layout LyX-Code
4241 D{inputsep}{outputsep}{decimal places}
4244 \begin_layout Standard
4246 The interested reader is directed towards the
4250 package documentation for more details.
4253 \begin_layout Section
4255 Itemize Bullet Selection
4256 \begin_inset LatexCommand \label{sec:bullet}
4263 \begin_layout Standard
4270 \begin_layout Subsection
4275 \begin_layout Standard
4277 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4278 Using this dialog you can easily specify what bullet shape to use at each
4279 level of an itemized list.
4280 These settings are document-wide so you won't be able to specify different
4281 sets of bullets for different paragraphs
4285 \begin_layout Standard
4287 Well, actually you can but you'll have to do it by hand.
4295 \begin_layout Subsection
4300 \begin_layout Standard
4302 Open the dialog by selecting the
4307 ocument\SpecialChar \menuseparator
4314 menu item and then select the
4324 \begin_layout Standard
4326 The dialog provides you with a table of bullet shapes.
4327 A column of buttons on the left of the table provides access to the six
4328 different panels of bullet shapes.
4329 The row of buttons across the top is used to select which bullet depth
4331 A text entry under the table shows the currently selected bullet shape's
4332 LaTeX equivalent and this can be edited if desired.
4333 If you do modify the text you will also need to specify any needed packages
4334 in the LaTeX preamble.
4337 \begin_layout Standard
4339 The six panels are divided up by the packages they require.
4340 The following table shows the mappings from button name to LaTeX packages.
4343 \begin_layout Standard
4346 \begin_inset Tabular
4347 <lyxtabular version="3" rows="7" columns="2">
4349 <column alignment="center" valignment="top" leftline="true" width="0pt">
4350 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4351 <row topline="true" bottomline="true">
4352 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4355 \begin_layout Standard
4371 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4374 \begin_layout Standard
4391 <row topline="true">
4392 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4395 \begin_layout Standard
4411 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4414 \begin_layout Standard
4430 <row topline="true">
4431 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4434 \begin_layout Standard
4450 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4453 \begin_layout Standard
4470 <row topline="true">
4471 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4474 \begin_layout Standard
4490 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4493 \begin_layout Standard
4510 <row topline="true">
4511 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4514 \begin_layout Standard
4530 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4533 \begin_layout Standard
4550 <row topline="true">
4551 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4554 \begin_layout Standard
4570 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4573 \begin_layout Standard
4590 <row topline="true" bottomline="true">
4591 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4594 \begin_layout Standard
4610 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4613 \begin_layout Standard
4637 \begin_layout Standard
4639 LyX doesn't stop you using bullets from packages you don't have.
4640 If you get errors from LaTeX when you try to view or print the file then
4641 its likely you are missing a package.
4642 LyX doesn't restrict your use since you may be editing locally and exporting
4646 \begin_layout Subsection
4651 \begin_layout Standard
4653 Select which bullet depth you want to change then select the bullet shape
4659 Any changes will not be visible in LyX, but are visible when viewing the
4660 document using xdvi or ghostview.
4663 \begin_layout Standard
4665 You can reset a bullet shape to the default simply by clicking your right
4666 mouse button on the appropriate bullet depth button.
4669 \begin_layout Standard
4675 want to have multiple sets of paragraphs with different sets of bullets
4676 in each then you're going to have to get your hands dirty.
4677 The itemize bullet selection dialog can help though because it provides
4678 you with the LaTeX code for a wide range of bullet shapes.
4679 To make your own custom paragraphs you have the following options:
4682 \begin_layout Standard
4688 \begin_layout Standard
4703 \begin_layout Standard
4709 \begin_layout Standard
4730 \begin_layout Itemize
4732 Use the LaTeX command
4738 to specify a new bullet shape for a given depth.
4739 You'll also need to save the current bullet shape so you can restore it
4741 In this itemized list the following LaTeX code was used to change the bullet
4742 used for the first depth.
4774 Note that the itemize depth is specified in Roman numerals as part of the
4784 \begin_layout Itemize
4790 \begin_layout Standard
4802 Specify each individual entry by starting each item with the bullet shape
4803 enclosed in square brackets and set as TeX.
4804 For example, this item was started with
4817 \begin_layout Standard
4823 \begin_layout Standard
4838 \begin_layout Standard
4840 You'll also need to revert the labelitem back to its previous setting for
4841 the global bullet shape settings to remain in effect.
4842 The way used here was:
4855 \begin_layout Chapter
4857 Special Document Classes
4860 \begin_layout Section
4865 \begin_layout Standard
4873 \begin_layout Standard
4876 \begin_inset VSpace bigskip
4882 \begin_layout Standard
4884 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4885 papers to be submitted to American Mathematical Society publications.
4886 The layouts are not tailored to a specific journal, but easily can be.
4887 You should refer to the AMS documentation for specific instructions for
4888 each journal (usually it will entail only changing a single line in the
4890 That documentation is available on the Web at
4891 \begin_inset LatexCommand \url{http://www.ams.org}
4896 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
4900 .These layouts are appropriate, and useful, for any mathematical writing.
4901 There are currently 4 distinct AMS LaTeX layouts:
4904 \begin_layout Enumerate
4906 amsart: The standard AMS-article format.
4907 All results and similar statements are numbered as
4908 \begin_inset Formula $(n.m)$
4911 , where the first number refers to the section, and the second refers to
4912 the total number of results (Theorems, Corollaries, Propositions, Definitions
4913 and Remarks, etc.) in that section.
4914 There are also many (but not all) environments available unnumbered, which
4915 is occasionally needed.
4916 Unnumbered environments indicated by an asterisk at the end.
4919 \begin_layout Enumerate
4921 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4922 with no reference to the section number.
4923 There are also many (but not all) environments available unnumbered, which
4924 is occasionally needed.
4925 Unnumbered environments indicated by an asterisk at the end.
4928 \begin_layout Enumerate
4930 amsart-plain: This one is even more terse, since all the environments are
4934 \begin_layout Enumerate
4936 amsbook: the standard AMS book (really, monograph) format.
4937 Numbering is similar to the amsart layout, except that all numbering is
4939 \begin_inset Formula $(n.m.p)$
4942 , where the first number refers to the chapter, the second to the section,
4943 and the third is the number of the results (Theorems, Corollaries, Propositions
4944 , Definitions and Remarks, etc.) in that section.
4945 There are also many (but not all) environments available unnumbered, which
4946 is occasionally needed.
4947 Unnumbered environments indicated by an asterisk at the end.
4950 \begin_layout Standard
4952 Any AMS LyX file can be converted to either of the numbering schemes by
4953 simply changing the document class in the
4958 ocument\SpecialChar \menuseparator
4969 \begin_layout Subsection
4971 What these layouts provide
4974 \begin_layout Standard
4976 There is a long list of included environments provided by these layouts.
4977 Most mathematical papers or books will set as special statements most of
4978 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4979 variety of such declarations.
4980 However, the AMS recommends the environments that are available in LyX.
4981 The list of environments (not counting the standard environments such as
4984 sections, bibliography, title, author, date
4989 \begin_layout Description
4991 Theorem This is typically used for the statements of major results.
4993 \begin_inset Quotes eld
5001 \begin_inset Quotes erd
5004 appears in bold type, along with an automatically-determined number (an
5009 , is also available).
5010 The text is italicized.
5013 \begin_layout Description
5015 Corollary This is used for statements which follow fairly directly from
5016 previous statements.
5017 Again, these can be major results.
5025 \begin_layout Description
5027 Lemma These are smaller results needed to prove other statements.
5030 \begin_layout Description
5032 Proposition These are less major results which (hopefully) add to the general
5033 theory being discussed.
5036 \begin_layout Description
5038 Conjecture These are statements provided without justification, which the
5039 author does not know how to prove, but which seem to be true (to the author,
5043 \begin_layout Description
5045 Criterion A required condition.
5048 \begin_layout Description
5050 Algorithm A general procedure to be used.
5053 \begin_layout Description
5055 Axiom This is a property or statement taken as true within the system being
5059 \begin_layout Description
5061 Definition Guess what this is for.
5062 The font, both on-screen and in the output, is different for this environment
5063 than for the previous ones.
5065 \begin_inset Quotes eld
5069 \begin_inset Quotes erd
5072 ) is still set in boldface, along with the number, if any, but the rest
5076 \begin_layout Description
5078 Example Typeset similarly to Definition.
5081 \begin_layout Description
5086 \begin_layout Description
5091 \begin_layout Description
5096 \begin_layout Description
5098 Remark This environment is also a new type of theorem.
5099 This is set with the word Remark in italics, and the rest upright.
5102 \begin_layout Description
5104 Note Set similarly to the Remark environment.
5107 \begin_layout Description
5112 \begin_layout Description
5117 \begin_layout Description
5122 \begin_layout Description
5127 \begin_layout Description
5129 Case Generally, these are used to break up long arguments, using specific
5130 instances of some condition.
5131 The numbering scheme for cases is on its own, not together with other numbered
5136 \begin_layout Description
5141 \begin_layout Description
5146 \begin_layout Description
5149 \begin_inset Quotes eld
5157 \begin_inset Quotes erd
5160 is set in italics, but the rest is set upright.
5161 At the end of this environment (other environments can be nested within
5162 this one, of course) a QED symbol (usually a square, but it can vary with
5163 different styles) is placed.
5166 \begin_layout Description
5168 Address This should be the author's permanent address.
5171 \begin_layout Description
5173 Current\InsetSpace ~
5174 Address This should be the author's temporary address at the time
5175 of submission, if different from the Address.
5178 \begin_layout Description
5180 Email Author's e-mail address
5183 \begin_layout Description
5185 URL Author's Web address, if desired.
5188 \begin_layout Description
5190 Keywords Key words or phrases used to identify specific topics discussed
5194 \begin_layout Description
5196 Subjectclass These refer to the AMS Subject Classifications, published and
5199 Mathematical Reviews
5202 These are also available online at the AMS cites listed above.
5205 \begin_layout Description
5210 \begin_layout Description
5215 \begin_layout Description
5220 \begin_layout Standard
5222 In addition, these environments automatically provide the AMS LaTeX and
5224 They need to be available on your system in order to use these environments.
5227 \begin_layout Section
5232 \begin_layout Standard
5238 can be used to type letters according to German conventions.
5239 A template file is included in
5241 .../lyx/share/templates
5243 for you to use as a starting point.
5246 \begin_layout Section
5251 \begin_layout Standard
5257 provides an alternative to the standard
5262 It provides similar functionality, but you might prefer this layout with
5263 sans serif sections, headings, and more.
5266 \begin_layout Section
5271 \begin_layout Standard
5278 \begin_layout Subsection
5283 \begin_layout Standard
5285 This section describes how LyX can be used to write articles for submission
5286 to the scientific journal
5288 Astronomy and Astrophysics
5291 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5303 Version 5.01 of the document class
5308 This package can be downloaded from the ftp site
5312 \begin_layout Standard
5315 \begin_inset VSpace medskip
5321 \begin_layout Standard
5324 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5331 \begin_layout Standard
5334 \begin_inset VSpace medskip
5341 \begin_layout Standard
5343 A manual comes together with that package, and this text is not meant to
5344 replace the original manual but merely a short guide how to realize the
5345 correct form of your paper.
5349 \begin_layout Standard
5351 Please note that the publisher of the journal was changed from Springer
5352 to EDP Sciences starting January 1, 2001.
5353 That change implicated also some slight changes of the style files, namely
5354 the removal of the thesaurus command.
5355 The LyX class aa supports the newest version of these style files, V 5.01.
5356 If you have an older version installed, please upgrade.
5357 For compatibility, the old (version 4) layout has been kept as
5362 Please refer to the comments in
5364 LyXDir/layouts/aapaper.layout
5369 \begin_layout Subsection
5374 \begin_layout Standard
5376 It is recommended you start from the example template distributed with LyX.
5377 If you are not using a template, note the following settings:
5380 \begin_layout Itemize
5391 ocument\SpecialChar \menuseparator
5398 dialog (OK, that one was obvious).
5401 \begin_layout Itemize
5403 Don't change the option
5413 The whole layout is done by the macros, you shouldn't change anything.
5416 \begin_layout Subsection
5421 \begin_layout Standard
5423 First thing to enter is the header information.
5424 It consists of seven entries, of which some are optional.
5428 \begin_layout Itemize
5437 \begin_layout Itemize
5446 \begin_layout Itemize
5455 \begin_layout Itemize
5464 \begin_layout Itemize
5470 : [optional] if more than one author: whom to contact for offprint requests.
5473 \begin_layout Itemize
5479 : [optional] mail address for contacts.
5482 \begin_layout Itemize
5491 Received: <date>; Accepted <date>
5494 \begin_layout Standard
5496 There is no need to issue the
5502 command, this is done automatically by LyX when the header is finished.
5503 Although the order of the single header entries doesn't matter it is advised
5504 to keep the above sequence, just to get the best optics and meets the layout
5505 of the real document.
5508 \begin_layout Standard
5510 If you want to place footnotes in the header block, e.g.
5514 \begin_layout Standard
5522 to state your present address, just use the standard footnote via
5527 nsert\SpecialChar \menuseparator
5535 LyX will automagically use the term
5544 \begin_layout Standard
5546 In addition to these topics, the macros use three additional LaTeX commands
5547 that have no counterpart in LyX:
5550 \begin_layout Itemize
5558 to separate different names for more than one author and institute, respectivel
5562 \begin_layout Itemize
5570 to mark corresponding author/institute pairs.
5571 The institutes are numbered sequentially as they appear in the
5575 field, so you have to put a marker to each author.
5578 \begin_layout Itemize
5586 to supply an email address for fast contact.
5589 \begin_layout Standard
5591 In all cases, the appropriate command has to be entered in LyX an marked
5597 \begin_layout Subsection
5602 \begin_layout Standard
5604 The abstract should immediately follow the header block.
5605 With version 5 the abstract environment was changed to a command, and there
5606 is now a resctriction to only one paragraph.
5607 In addition, it should contain an entry with the keywords.
5608 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5615 by hand and mark it as LaTeX code.
5616 Refer to the example paper.
5619 \begin_layout Subsection
5621 Supported environments
5624 \begin_layout Standard
5626 The A&A paper layout supports the following environments for structuring
5630 \begin_layout Itemize
5637 \begin_layout Itemize
5644 \begin_layout Itemize
5651 \begin_layout Itemize
5658 \begin_layout Itemize
5665 \begin_layout Itemize
5672 \begin_layout Itemize
5679 \begin_layout Itemize
5686 \begin_layout Itemize
5693 \begin_layout Itemize
5700 \begin_layout Itemize
5707 \begin_layout Itemize
5714 \begin_layout Subsection
5716 Commands not supported by LyX
5719 \begin_layout Standard
5721 Some commands are not yet supported by the
5726 Some have already been mentioned.
5727 For the sake of completeness, they are listed all together here:
5730 \begin_layout Itemize
5739 \begin_layout Itemize
5748 \begin_layout Itemize
5757 \begin_layout Itemize
5766 \begin_layout Itemize
5775 \begin_layout Itemize
5784 \begin_layout Itemize
5793 \begin_layout Itemize
5802 \begin_layout Standard
5804 If you want to use any of these commands, you have to enter them yourself.
5807 Do not forget to mark them as LaTeX code!
5810 \begin_layout Subsection
5812 Figure and Table Floats
5815 \begin_layout Standard
5817 LyX provides support for the necessary float environments
5819 figure, figure*, table
5825 , therefore we won't tell much about it here.
5832 Just remember that tables should be left-aligned.
5833 For that, select the table and change the alignment in
5838 dit\SpecialChar \menuseparator
5843 aragraph\InsetSpace ~
5847 \begin_layout Standard
5853 only one special thing: the figures with caption besides the figure.
5854 To create such a figure, you have to do the following:
5857 \begin_layout Enumerate
5859 Create a wide figure float:
5864 nsert\SpecialChar \menuseparator
5869 t\SpecialChar \menuseparator
5872 , then right click in the figure and select
5884 \begin_layout Enumerate
5886 Enter your caption text.
5889 \begin_layout Enumerate
5895 to move the cursor above the caption.
5898 \begin_layout Enumerate
5903 \begin_layout Enumerate
5905 Position the cursor behind the figure and insert a horizontal fill:
5910 nsert\SpecialChar \menuseparator
5918 \SpecialChar \menuseparator
5921 orizontal\InsetSpace ~
5927 \begin_layout Enumerate
5929 Switch to LaTeX mode:
5937 \begin_layout Enumerate
5948 Do not close the brace!
5951 \begin_layout Enumerate
5953 Position the cursor behind the caption text, switch to LaTeX mode and insert
5964 \begin_layout Standard
5966 Also, refer to the figures in the example paper.
5969 \begin_layout Subsection
5974 \begin_layout Standard
5976 For submission, the paper has to be formated in a special double-spacing
5978 For this purpose, you have to give the option
5982 to the documentclass.
5983 This must be done using the extra class options field in the
5988 ocument\SpecialChar \menuseparator
5996 Just enter the string
6003 \begin_layout Subsection
6008 \begin_layout Standard
6014 directory contains an example paper written with LyX.
6015 It is the example paper from the original macro package, translated to
6017 Use it for inspiration, and compare the original LaTeX code with LyX way
6021 \begin_layout Section
6026 \begin_layout Standard
6033 \begin_layout Subsection
6038 \begin_layout Standard
6040 AASTeX is a set of macros produced by the American Astronomical Society
6041 to facilitate electronic manuscript submission to the three journals they
6042 publish: the Astrophysical Journal (including the Letters and Supplement),
6043 the Astronomical Journal, and the Publications of the Astronomical Society
6045 LyX has proven to be an excellent tool for generating these documents,
6046 especially given its equation, citation, and figure handling capabilities.
6047 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6048 is the version described here, or higher.
6049 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6050 incompatible with LyX.
6051 The AASTeX package may be downloaded from the AASTeX Web site
6055 \begin_layout Standard
6058 \begin_inset VSpace medskip
6064 \begin_layout Standard
6067 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6074 \begin_layout Standard
6077 \begin_inset VSpace medskip
6084 \begin_layout Standard
6086 A complete user guide is contained in that package and you should familiarize
6087 yourself with it thoroughly before embarking on writing a paper in LyX.
6088 LyX will not reduce the need to figure out all the AASTeX commands, it
6089 will only reduce the drudgery of typing everything in.
6090 It is your responsibility to ensure that the final exported LaTeX document
6091 conforms completely to the requirements of the journal to which you are
6092 submitting your paper.
6095 \begin_layout Subsection
6097 Starting a New Paper
6100 \begin_layout Standard
6102 I strongly suggest that you start with the AASTeX template file.
6108 ile\SpecialChar \menuseparator
6115 , enter the new file name, then choose the
6120 This will show the most common fields found in a manuscript.
6121 Simply overwrite the existing text (including the brackets,
6125 ) with the correct information.
6126 Many of the AASTeX commands and environments can be implemented directly
6127 in LyX, but some cannot: most noticeably
6139 , which should stick out like a sore thumb if you actually just opened the
6141 For commands such as these, the LaTeX code must be entered directly and
6143 Such commands are referred to as ERT, or Evil Red Text.
6144 I tried to minimize the amount of ERT needed in an AASTeX document, but
6145 there is still a bit more required than any of us would like.
6148 \begin_layout Subsection
6150 Finishing Your Paper
6153 \begin_layout Standard
6155 When the paper is finished to your satisfaction and previews/prints correctly,
6157 \begin_inset Quotes eld
6161 \begin_inset Quotes erd
6164 actions which need to be done before you submit it to the journals.
6168 \begin_layout Enumerate
6170 Export your paper as a LaTeX file (
6175 ile\SpecialChar \menuseparator
6180 xport\SpecialChar \menuseparator
6191 \begin_layout Enumerate
6197 file with your favorite text editor
6201 \begin_layout Enumerate
6203 remove the comment lines before the
6212 \begin_layout Enumerate
6218 usepackage...{fontenc}
6220 line if it appears (usually just after
6235 \begin_layout Enumerate
6237 remove everything between (and including) the
6249 commands, except for any commands you specifically put into the LaTeX preamble
6250 (which should appear immediately after the
6251 \begin_inset Quotes eld
6254 User specified LaTeX commands
6255 \begin_inset Quotes erd
6265 \begin_layout Enumerate
6267 Run the resulting file through LaTeX to make sure it still processes correctly.
6270 \begin_layout Enumerate
6272 Reread the journal requirements to make sure your filenames and formats
6276 \begin_layout Enumerate
6281 \begin_layout Subsection
6283 Comments On Specific Commands
6286 \begin_layout Standard
6288 I will not describe the detailed usage of the individual AASTeX commands:
6289 the AASTeX User Guide (
6293 ) gives a good description of each.
6294 Thus it's probably easiest for me to go down the list as found in the guide
6295 and offer comments where necessary.
6296 So let's begin \SpecialChar \ldots{}
6300 \begin_layout Subsubsection
6302 Things that work as expected
6305 \begin_layout Standard
6311 \begin_layout Standard
6322 \begin_layout Standard
6324 Because they work as you might expect, I simply list them and the section
6425 begin{thebibliography}
6433 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6434 graphicx figure commands (2.14.1),
6458 (2.15.4, amongst other places),
6485 \begin_layout Standard
6487 The following style options also work correctly:
6508 Simply put them in the
6514 Layout\SpecialChar \menuseparator
6520 \begin_layout Standard
6526 \begin_layout Standard
6537 \begin_layout Subsubsection
6539 Things that work, but require more comment
6542 \begin_layout Standard
6544 The following items work, but require a little more discussion:
6547 \begin_layout Itemize
6549 These items are reserved for use by the journal editors, but you can put
6550 them into the LaTeX preamble if you feel compelled to do so:
6583 \begin_layout Itemize
6585 These items may be placed in the LaTeX preamble, and are included as blanks
6586 in the template file:
6607 \begin_layout Itemize
6615 (2.3) -- can only be used
6616 \begin_inset Quotes eld
6620 \begin_inset Quotes erd
6623 , not in the middle of a paragraph.
6624 Use ERT if you need to embed it.
6627 \begin_layout Itemize
6635 (2.3) -- will have extra {} after it.
6636 This should not cause an error.
6639 \begin_layout Itemize
6647 (2.6) -- can only be used
6648 \begin_inset Quotes eld
6652 \begin_inset Quotes erd
6655 , not in the middle of a paragraph.
6656 Use ERT if you need to embed it.
6659 \begin_layout Itemize
6667 (2.8) -- can't insert a cross-reference tag, you must type the tag name
6671 \begin_layout Itemize
6679 (2.8) -- same as for
6686 \begin_layout Itemize
6694 (2.9) -- will have extra {} after it.
6695 This should not cause an error.
6698 \begin_layout Itemize
6706 (2.11) -- will have extra {} after it.
6707 This should not cause an error.
6710 \begin_layout Itemize
6718 (2.14.2) -- you can insert an optional filename argument by placing the cursor
6719 at the beginning of the text and selecting
6721 Insert\SpecialChar \menuseparator
6726 \begin_inset Quotes eld
6730 \begin_inset Quotes erd
6733 inserts an optional argument of the type needed by
6740 Hopefully it will be renamed someday.
6743 \begin_layout Itemize
6757 for the catalog ID optional parameter
6760 \begin_layout Itemize
6774 for the catalog ID optional parameter
6777 \begin_layout Subsubsection
6779 Things not implemented, use ERT
6782 \begin_layout Standard
6788 \begin_layout Standard
6799 \begin_layout Standard
6823 setcounter{equation}
6825 (2.12), Journal name abbreviations (2.13.4),
6861 (2.15.4, insert it as the first element in the lefthand cell after where
6863 Don't use any of LyX's rules in the table),
6875 (2.15.5), much of Misc (2.17, except
6926 \begin_layout Standard
6932 \begin_layout Standard
6943 \begin_layout Subsubsection
6945 Things that cannot be implemented
6948 \begin_layout Standard
6950 \SpecialChar \ldots{}
6951 at least in any meaningful sort of way, so I suggest ignoring them.
6952 They are the references environment (2.13.3), and the deluxetable environment
6954 If you really, really need to use deluxetable, I suggest editing it in
6955 a separate file with a text editor, then using
6960 nsert\SpecialChar \menuseparator
6968 to include it in your LyX document.
6973 file to see an example of this.
6976 \begin_layout Subsection
6978 FAQs, Tips, Tricks, and Other Ruminations
6981 \begin_layout Subsubsection
6983 Getting LyX and AASTeX to cooperate
6986 \begin_layout Standard
6988 It can be a bit tricky to get LyX to recognize a new layout and document
6990 When all else fails, do this:
6993 \begin_layout Enumerate
6995 Make certain that LaTeX can find AASTeX.
6996 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6997 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7004 \begin_layout Enumerate
7012 /usr/.../share/lyx/layouts
7021 \begin_layout Enumerate
7028 ools\SpecialChar \menuseparator
7035 in LyX, then restart LyX.
7038 \begin_layout Enumerate
7040 Open a regular new file, not from a template.
7041 Does AASTeX appear in the class list in
7046 ocument\SpecialChar \menuseparator
7056 \begin_layout Standard
7058 If you get a warning from an existing AASTeX document about not being able
7059 to find the AASTeX layout or a message about
7060 \begin_inset Quotes eld
7063 You should not mix title layouts with normal ones
7064 \begin_inset Quotes erd
7067 , things haven't been installed correctly.
7070 \begin_layout Subsubsection
7072 LaTeX error processing a table
7075 \begin_layout Standard
7077 LyX, by default, attempts to center the table caption/title.
7078 This seems to produce a bad interaction in AASTeX so you should click somewhere
7079 in the caption/title, then select
7084 dit\SpecialChar \menuseparator
7089 aragraph\InsetSpace ~
7104 This took care of it for me.
7107 \begin_layout Subsubsection
7110 \begin_inset LatexCommand \label{cite}
7117 \begin_layout Standard
7119 A couple of things: 1) I have noticed some funny spacing in the reference
7120 entries in the text.
7121 When you enter the bibliography item data, make sure their is
7125 space between the last author and the parenthesis setting off the year;
7140 2) Entering the references at all is not obvious.
7141 The easiest thing is to start typing your first reference at the end of
7142 the document, then mark it as type
7147 That will put a small gray box in front of what you just typed.
7148 Click on the box to fill in the rest of the information.
7149 For new references, go to the end of an existing reference and press return.
7150 That will create a new line with its own box, etc.
7153 \begin_layout Subsubsection
7158 \begin_layout Standard
7160 Even though AASTeX provides its own figure commands (
7166 , for example), I much prefer LaTeX's standard figure commands (with the
7175 commands as ERT into a Figure Float box if you desire, but I never
7176 have much luck getting the layout right.
7177 With the standard graphics, LyX will insert a
7181 usepackage{graphicx}
7183 command into the LaTeX preamble and handle the figures in the standard
7184 LaTeX2e way, interspersing the figures in the text.
7185 I believe ApJ accepts figures exactly this way now; AJ might still use
7187 \begin_inset Quotes eld
7190 stack everything at the end
7191 \begin_inset Quotes erd
7197 \begin_layout Subsubsection
7199 Things I could have done, but didn't
7202 \begin_layout Standard
7205 \begin_inset Quotes eld
7209 \begin_inset Quotes erd
7212 things I could have implemented, but chose not to.
7213 For instance, I saw no point in double-spacing the text in the LyX window,
7214 even though it is double-spaced in the paper manuscript.
7215 Also, I chose not to make separate layouts for the preprint and preprint2
7217 Since I assume you will spend most of your time in the plain manuscript
7218 mode anyway, I decided not to chew up more disk space with this.
7222 \begin_layout Subsection
7227 \begin_layout Standard
7229 Your mileage may vary.
7230 I've now had papers published by both ApJ and AJ that have had 98% of the
7231 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7233 I have had no trouble with the submission process, and I'm sure the journals
7234 were never aware that there might be a difference.
7235 So, go forth and publish!
7238 \begin_layout Section
7243 \begin_layout Standard
7247 Panayotis Papasotiriou
7250 \begin_layout Subsection
7255 \begin_layout Standard
7257 The ijmpd package is a set of macros that facilitates electronic manuscript
7260 International Journal of Modern Physics D
7262 published by World Scientific.
7263 The name of the document class is
7268 This file, together with instructions for the authors, can be downloaded
7270 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7275 The ijmpd package is a modified version of the standard
7276 \begin_inset Quotes eld
7280 \begin_inset Quotes erd
7284 Most of its features are supported by LyX.
7285 I have recently used LyX successfully to write an article submitted to
7288 International Journal of Modern Physics D
7293 \begin_layout Subsection
7298 \begin_layout Standard
7300 As usual, the easiest way to write a paper is to start with a template.
7306 ile\SpecialChar \menuseparator
7318 This will give an (almost) empty document that includes the most common
7319 fields found in a manuscript.
7320 Simply overwrite the existing text (including the brackets,
7324 ) with the correct information.
7325 You should keep in mind the following remarks.
7328 \begin_layout Enumerate
7330 LyX won't let you change the font size and the page style of the document,
7331 because the ijmpd package does not allow such modifications.
7334 \begin_layout Enumerate
7336 The ijmpd package requires that the language of the document should not
7338 Before previewing your paper, be sure that the babel package is not used.
7339 To do this, click on
7344 ools\SpecialChar \menuseparator
7358 checkbox in the language settings, and click on
7369 , if you wish to make this change permanent).
7372 \begin_layout Enumerate
7374 Two new environments, named
7375 \begin_inset Quotes eld
7379 \begin_inset Quotes erd
7383 \begin_inset Quotes eld
7387 \begin_inset Quotes erd
7390 are available (their use is obvious).
7393 \begin_layout Enumerate
7395 Appendices may be added to the paper.
7396 LyX offers a special environment, called
7397 \begin_inset Quotes eld
7401 \begin_inset Quotes erd
7404 which marks the beginning of the appendix.
7405 An appendix can contain normal sections, subsections, or subsubsections.
7408 \begin_layout Enumerate
7410 The ijmpd package implements table captions quite differently than LyX does.
7411 As a result, a table created by LyX is printed correctly, but its caption
7413 If you need table captions, you should implement the whole table float
7418 file, then include this file to the LyX document (
7423 nsert\SpecialChar \menuseparator
7432 Details on how to create an ijmpd table float can be found in the file
7437 , which is included in the ijmpd package.
7440 \begin_layout Subsection
7442 Preparing a paper for submission
7445 \begin_layout Standard
7447 Before you submit your paper you must export the LyX document as a LaTeX
7453 ile\SpecialChar \menuseparator
7458 xport\SpecialChar \menuseparator
7465 ), then make the following changes to the resulting
7472 \begin_layout Enumerate
7474 Remove the comment lines before the
7483 \begin_layout Enumerate
7485 Remove everything between (and including) the
7497 commands, except for any commands you specifically put into the LaTeX preamble.
7500 \begin_layout Standard
7506 file should be saved and processed through LaTeX as many times as necessary.
7507 You may also want to check the resulting
7514 \begin_layout Subsection
7519 \begin_layout Standard
7521 The use of ERT is optional, and is reduced to three commands, which affect
7522 the look of the page.
7523 If you started writing your paper by using the
7527 template, the ERT needed is already in its place; you usually don't need
7529 You may only change the first ERT to specify the information printed to
7530 the top of odd and even pages (authors' names and short paper's title,
7532 This ERT must have the form
7536 markboth{Authors' Names}{Short Paper's Title}
7541 \begin_layout Section
7546 \begin_layout Standard
7550 Panayotis Papasotiriou
7553 \begin_layout Subsection
7558 \begin_layout Standard
7560 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7561 that facilitates electronic manuscript submission to the journals they
7563 Most known of them (at least in my domain of interest) are
7565 Astrophysics and Space Science
7571 , but there are many others (see a complete list at
7572 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
7577 The Kluwer package may be downloaded from the site
7578 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
7583 A complete user guide is contained in that package (but it can also be
7584 downloaded separately).
7587 \begin_layout Standard
7589 LyX supports many features of the package but not everything.
7590 However, the ERT needed is reduced to some
7591 \begin_inset Quotes eld
7595 \begin_inset Quotes erd
7598 commands of the package (see\InsetSpace ~
7600 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
7605 I have recently used LyX to write an article submitted to the
7607 Astrophysics and Space Science
7609 without any problem.
7612 \begin_layout Subsection
7617 \begin_layout Standard
7619 The easiest way to write a paper is to start with the Kluwer template file.
7622 File\SpecialChar \menuseparator
7634 This will give an (almost) empty document that includes the most common
7635 fields found in a manuscript and a short description of their use.
7636 As in most templates, simply overwrite the existing text (including the
7641 ) with the correct information.
7644 \begin_layout Subsection
7646 Preparing a paper for submission
7649 \begin_layout Standard
7651 As in the AASTeX package, before you submit your paper to a journal you
7653 \begin_inset Quotes eld
7657 \begin_inset Quotes erd
7663 \begin_layout Enumerate
7665 Export your paper as a LaTeX file.
7666 To do this, click on
7671 ile\SpecialChar \menuseparator
7676 xport\SpecialChar \menuseparator
7687 \begin_layout Enumerate
7693 file with a text editor and make the following changes
7697 \begin_layout Enumerate
7699 remove the comment lines before the
7708 \begin_layout Enumerate
7710 remove everything between (and including) the
7722 commands, except for any commands you specifically put into the LaTeX preamble.
7725 \begin_layout Standard
7734 \begin_layout Enumerate
7740 file through LaTeX as many times as necessary (usually up to three).
7743 \begin_layout Enumerate
7749 document using, e.g.,
7753 , and check if everything is ok (it should, if you didn't make any mistake).
7756 \begin_layout Subsection
7759 \begin_inset Quotes eld
7763 \begin_inset Quotes erd
7766 of the Kluwer package
7767 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
7774 \begin_layout Standard
7776 The Kluwer package has the following
7777 \begin_inset Quotes eld
7781 \begin_inset Quotes erd
7787 \begin_layout Enumerate
7789 It is possible to write multiple articles in the same LaTeX file
7793 \begin_layout Standard
7795 I can't imagine any good reason to do this.
7801 Each article must be included in the environment
7802 \begin_inset Quotes eld
7806 \begin_inset Quotes erd
7810 Unfortunately, this environment cannot be omitted, even if you write just
7812 Therefore, each article starts with the command
7818 and, obviously, ends with the command
7825 Although this can be implemented in LyX, I didn't included it, since it
7826 looks ugly and can confuse the novice user.
7827 Therefore, you need to enter them directly and mark them as LaTeX code
7829 \begin_inset Quotes eld
7833 \begin_inset Quotes erd
7839 \begin_layout Enumerate
7841 Information given at the beginning of the article (i.e., title, subtitle,
7842 author, institution, running title, running author, abstract and keywords)
7843 must be included in an environment called
7844 \begin_inset Quotes eld
7848 \begin_inset Quotes erd
7852 This is not implemented in LyX, so you must enter title, subtitle etc.
7853 between two ERT lines (
7868 \begin_layout Enumerate
7870 According to the user manual, the label of each bibliography item must be
7894 \begin_layout Standard
7900 template takes care of all these
7901 \begin_inset Quotes eld
7905 \begin_inset Quotes erd
7909 If you start a new paper using this template you don't need to do anything
7914 \begin_layout Enumerate
7916 don't delete the ERT included in the template, and
7919 \begin_layout Enumerate
7921 copy the example bibliography item included in the template and modify it
7922 as necessary to enter new bibliography items.
7925 \begin_layout Section
7930 \begin_layout Standard
7937 \begin_layout Subsection
7942 \begin_layout Standard
7944 The LyX document classes
7946 article (koma-script)
7950 report (koma-script)
7968 correspond to the LaTeX document classes
7985 of the Koma-Script family.
7986 They are replacements for the standard document classes
8002 , resp., and fit better to European typography conventions in a number of
8006 \begin_layout Itemize
8008 Standard character size is 11pt in
8010 article (koma-script)
8014 report (koma-script)
8022 letter (koma-script)
8027 \begin_layout Itemize
8029 Headings, labels of the description environment, and a number of elements
8032 letter (koma-script)
8034 document class are set in a bold sans serif font.
8038 \begin_layout Standard
8040 There is a big difference between the bold sans serif old cm fonts and new
8041 ec fonts, especially in the appearance of headings.
8042 In comparison, the ec bold sans serif fonts look a bit thin.
8043 Here the LaTeX package
8050 helps to produce the
8051 \begin_inset Quotes eld
8055 \begin_inset Quotes erd
8058 appearance when using the ec fonts.
8063 The numbering of chapter headings is made in the same way as the numbering
8064 of section headings, that is without the extra line
8065 \begin_inset Quotes eld
8068 Chapter\SpecialChar \ldots{}
8070 \begin_inset Quotes erd
8074 In addition, the appearance of the headings can be modified by using a
8075 number of options (in LyX to be entered in the field
8089 ayout\SpecialChar \menuseparator
8097 A detailed German description of these options can be found in the Koma-Script
8105 \begin_layout Itemize
8107 The main means in the Koma-Script document classes to design the type area
8116 (in LyX to be entered in the extra class options field in the dialog
8121 ocument\SpecialChar \menuseparator
8129 They make a clearer modification of page margins possible as do the options
8135 ocument\SpecialChar \menuseparator
8143 A detailed German description of these and other type area options can
8144 be found in the Koma-Script documentation
8151 \begin_layout Itemize
8153 The LaTeX document classes of the Koma-Script family define a number of
8154 additional commands.
8155 Those part of it which makes sense in LyX is implemented in corresponding
8159 \begin_layout Standard
8161 A detailed German description of the LaTeX document classes of the Koma-Script
8162 family can be found in the Koma-Script documentation
8170 \begin_layout Standard
8172 There is an English translation
8176 , but it is not a complete one.
8181 The following sections describe only those aspects, which are relevant
8185 \begin_layout Subsection
8187 article (koma-script), report (koma-script), and book (koma-script)
8190 \begin_layout Standard
8192 The document classes
8194 article (koma-script)
8198 report (koma-script)
8208 are implemented in the layout files
8221 They contain all the paragraph types of the corresponding standard document
8234 , resp., partly modified, with the exception of the LyX specific
8238 -type, which is replaced by the new
8242 -type having the same functionality.
8247 -Type there is a number of new paragraph types added.
8254 letter (koma-script)
8259 \begin_layout Itemize
8269 : are equivalents to
8277 , resp., additionally inserting an entry in the table of contents.
8286 are not contained in
8288 article (koma-script)
8293 \begin_layout Itemize
8311 , resp., additionally clearing running heads.
8318 article (koma-script)
8324 \begin_layout Standard
8338 report (koma-script)
8340 , but since this is identical to
8344 , is has not been implemented in LyX.
8352 \begin_layout Itemize
8358 : generates a heading directly above the following paragraph in the standard
8359 character size without affecting the structure of the document.
8362 \begin_layout Itemize
8372 are special captions which respect the different space settings needed for
8373 captions placed above or below an element (if you follow strict typographic
8374 rules, you might want to place table captions always above the table).
8375 You can also use the class option
8392 You need at least Koma-Script version 2.8q to use this.
8395 \begin_layout Itemize
8401 : can be used to set a bonmot, e.
8405 \begin_layout Standard
8417 \begin_layout Standard
8425 at the beginning of a chapter.
8426 If you use the optional argument (
8431 nsert\SpecialChar \menuseparator
8435 ), you can insert the dictum's author there.
8436 Dictum and author are separated by a line.
8437 You need at least Koma-Script version 2.8q to use this.
8444 article (koma-script)
8449 \begin_layout Standard
8451 The following types, together with the standard types
8463 , form the title area of the document.
8464 They must be entered ahead of the first
8465 \begin_inset Quotes eld
8469 \begin_inset Quotes erd
8476 \begin_layout Standard
8478 The corresponding LaTeX commands must appear before the
8489 When such a type is used more than once, the latter usage overwrites the
8490 former one, that means, for every type only the latest usage is valid.
8491 The order of the different types however has, like
8503 , no effect on the appearance of the produced document.
8506 \begin_layout Itemize
8512 : produces a centered paragraph above the ordinary title (
8524 ) for the subject of the document.
8527 \begin_layout Itemize
8533 : produces a centered paragraph below the ordinary title (
8545 ) for the publishers' name.
8548 \begin_layout Itemize
8556 report (koma-script)
8562 produces a centered paragraph on its own page behind the title page, or
8565 article (koma-script)
8567 produces a centered paragraph below the ordinary title (
8586 \begin_layout Itemize
8592 : produces a left aligned paragraph above the ordinary title (
8608 ) for a document`s head.
8611 \begin_layout Itemize
8617 : produces in a double-sided print in
8619 report (koma-script)
8625 a left-aligned paragraph at the top of the title page`s back or has no
8626 effect in a single-sided print or in
8628 article (koma-script)
8633 \begin_layout Itemize
8639 : produces in a double-sided print in
8641 report (koma-script)
8647 a left-aligned paragraph at the bottom of the title page`s back or has
8648 no effect in a single-sided print or in
8650 article (koma-script)
8655 \begin_layout Itemize
8661 : produces a special
8662 \begin_inset Quotes eld
8666 \begin_inset Quotes erd
8669 page ahead of the actual document containing a paragraph without special
8673 \begin_layout Standard
8675 The layout files for the document classes
8677 article (koma-script)
8681 report (koma-script)
8692 This is thought of as a place to define your own types.
8697 in your personal layout directory and edit the file!
8700 \begin_layout Subsection
8702 letter (koma-script)
8705 \begin_layout Standard
8711 \begin_layout Standard
8722 \begin_layout Standard
8726 letter (koma-script)
8728 is implemented in the layout file
8733 It contains all the paragraph types of the corresponding standard document
8738 , partly modified, with the exception of the LyX specific types
8750 type, which is replaced by the new
8755 In addition, it contains, in contrast to the standard document class, the
8773 Furthermore, there are a number of new letter specific types.
8776 \begin_layout Standard
8782 \begin_layout Standard
8793 \begin_layout Standard
8795 The appearance of the letter produced by this document class can be controlled
8796 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8800 \begin_layout Standard
8802 For example, the standard appearance of the letter`s heading, consisting
8803 of name and address, is quite self-willed.
8805 \begin_inset Quotes eld
8809 \begin_inset Quotes erd
8812 heading is produced by the following LaTeX commands in the preamble:
8815 \begin_layout LyX-Code
8826 \begin_layout LyX-Code
8843 \begin_layout LyX-Code
8854 \begin_layout LyX-Code
8875 A detailed German description of such LaTeX commands can be found in the
8876 Koma-Script documentation
8881 With it, the letter's author can produce his personal letter layout.
8884 \begin_layout Standard
8894 define the beginning of the letter and must be used in every letter.
8895 To emphasize them in the LyX document class, they are marked with the letter
8906 It is possible to write any number of letters in one file.
8911 type produces a new letter using the same addressee and a
8915 type produces a new addressee.
8932 are ordinary paragraph types and can also be used several times in one
8933 and the same letter.
8936 \begin_layout Itemize
8942 : produces a paragraph for the addressee and implicitly defines the beginning
8946 \begin_layout Itemize
8952 : produces a paragraph for the form of address and implicitly produces a
8956 \begin_layout Itemize
8962 : produces a paragraph for a close.
8965 \begin_layout Itemize
8971 : produces a paragraph for a postscript.
8974 \begin_layout Itemize
8980 : produces a paragraph for a distribution list.
8983 \begin_layout Itemize
8989 : produces a paragraph for enclosures.
8992 \begin_layout Standard
9034 are input types provided with a label to enter information, which will
9035 be processed by the document class.
9039 \begin_layout Standard
9041 It could be seen as a matter of inconsequence, that the types
9049 described above are not such input types as well.
9050 Because of the special meaning of those types, however, I have implemented
9051 them as ordinary paragraph types with a one letter mark in the left margin.
9052 Moreover, it would affect my feeling of symmetry, if the
9060 type had such a serious different appearance.
9065 The types must be used ahead of the corresponding
9072 \begin_layout Standard
9074 An implementation of these types in a WYSIWYG fashion does not seem to make
9075 sense, because the real appearance of the produced letter does not only
9076 depend on the usage of the particular type, but also on other factors.
9077 For example, a signature entered in the
9081 type will in the standard behavior appear in the produced letter only,
9082 when in the same letter also a
9087 The entered value of the
9091 type will in the standard behavior not appear in the produced letter at
9093 The possibility to design the letter`s heading freely is already indicated
9094 in a footnote above.
9097 \begin_layout Standard
9099 The input types can also be used as empty paragraphs.
9100 This makes sense e.\InsetSpace ~
9111 type is not used at all, in the standard behavior the value of the
9115 type is used as signature, whereas if an empty
9119 type is used, no signature value is defined.
9122 \begin_layout Standard
9124 By using the input types it is possible to write a letter template, containing
9125 filled input types with your personal dates (name, address, etc.) and empty
9126 input types for other dates you want to enter.
9129 \begin_layout Itemize
9135 : sender's name, in the standard behavior appears as a centered paragraph
9136 in small caps in the letter`s heading.
9139 \begin_layout Itemize
9145 : sender's signature, in the standard behavior appears below the
9154 type is used, the value of the
9158 type appears instead.
9161 \begin_layout Itemize
9167 : sender's address, in the standard behavior appears in a centered paragraph
9168 in the letter`s heading below the sender's name.
9171 \begin_layout Itemize
9177 : sender's telephone number, in the standard behavior only sets the LaTeX
9187 \begin_layout Itemize
9193 : place of the letter`s making.
9196 \begin_layout Itemize
9202 : date of the letter`s making.
9211 , in the standard behavior, produce the place and the date in a right-aligned
9212 line below the addressee's field.
9217 type is used, neither place nor date appear, independent of the value of
9227 type is used, the date of the letter `s production is used.
9230 \begin_layout Itemize
9236 : sender`s back address, in the standard behavior appears above the addressee's
9237 field in a small sans serif font.
9240 \begin_layout Itemize
9246 : special mail information, in the standard behavior appears underlined
9247 above the addressee's field below the back address.
9250 \begin_layout Itemize
9256 : additional information, in the standard behavior appears on right side
9257 below the addressee`s field.
9260 \begin_layout Itemize
9266 : the letter's title, in the standard behavior appears in a big, bold, sans
9267 serif font above the subject.
9270 \begin_layout Itemize
9276 : the letter's subject, in the standard behavior appears in a bold font
9284 \begin_layout Standard
9306 produce a business letter like line above the
9310 line containing the fields
9311 \begin_inset Quotes eld
9315 \begin_inset Quotes erd
9319 \begin_inset Quotes eld
9323 \begin_inset Quotes erd
9327 \begin_inset Quotes eld
9331 \begin_inset Quotes erd
9335 \begin_inset Quotes eld
9339 \begin_inset Quotes erd
9343 \begin_inset Quotes eld
9347 \begin_inset Quotes erd
9351 \begin_inset Quotes eld
9355 \begin_inset Quotes erd
9359 For the date field, the value of the
9365 \begin_inset Quotes eld
9368 business letter types
9369 \begin_inset Quotes erd
9372 is used, the value of the
9376 type however does not appear, but only the LaTeX variable
9383 The ordinary output of place and date in a right-aligned line below the
9384 addressee`s field is suppressed.
9385 The types are implemented as input types provided with a label and must
9386 be used ahead of the corresponding
9393 \begin_layout Itemize
9402 \begin_layout Itemize
9411 \begin_layout Itemize
9420 \begin_layout Itemize
9429 \begin_layout Itemize
9438 \begin_layout Subsection
9440 The new letter class: letter (koma-script v.2)
9443 \begin_layout Standard
9447 Jürgen Spitzmüller
9451 \begin_layout Standard
9454 \begin_inset VSpace medskip
9460 \begin_layout Standard
9462 Koma-Script version 2.8 has introduced a new letter class
9466 which superceeds the now unsupported
9471 It has --- on the LaTeX side --- a completely new interface and is not
9472 compatible with the old class.
9473 Therefore, LyX supports both, though it is recommended to use the new class.
9476 \begin_layout Standard
9478 This class covers the same functionality as
9480 letter (koma-script),
9487 (receiver's address, same as
9504 will start a new letter (i.
9508 \begin_layout Standard
9520 \begin_layout Standard
9528 you can write several letters per document).
9529 New elements are sender's
9545 and the possibility to use a
9554 nsert\SpecialChar \menuseparator
9564 \begin_layout Standard
9566 The biggest improvement is, though, that the letter's layout is configurable
9567 at almost any needs.
9568 This can be done via the preamble or with a special style file (Letter
9569 Class Option, extension
9573 ), that will be read in as a class option.
9577 \begin_layout Standard
9579 The KOMA package comes with some default
9584 There is, for instance, a
9588 file that follows german typesetting rules, or a
9592 that provides the default layout of the old
9597 The latter can be loaded with the class option
9606 ayout\SpecialChar \menuseparator
9611 ocument\SpecialChar \menuseparator
9623 template that is included in LyX for examples.
9624 A detailed description is to be found in the Koma-Script documentation
9632 \begin_layout Subsection
9637 \begin_layout Standard
9639 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9643 \begin_layout Itemize
9645 The chapter number of a
9649 type appears on a line of its own above the chapter heading instead of
9650 appearing in the same line ahead of it.
9651 The cause for that is the LyX internal behavior for the labeltype
9658 \begin_layout Itemize
9660 The headings of the types
9669 \begin_inset Quotes eld
9673 \begin_inset Quotes erd
9676 LaTeX table of contents, but not in the LyX table of contents (
9681 ocument\SpecialChar \menuseparator
9693 \begin_layout Itemize
9699 document class appear in a skip separation mode, not indented.
9700 This is the standard behavior, no special LaTeX commands are needed for
9707 ocument\SpecialChar \menuseparator
9714 dialog the corresponding radio button indicates
9730 value always has the effect that extra LaTeX commands are inserted in the
9731 document to produce the gap, which is not what is wanted in this case.
9734 \begin_layout Section
9743 \begin_layout Standard
9750 \begin_layout Subsection
9755 \begin_layout Standard
9757 These are the layout files for some of the journal formats used by Springer
9758 Verlag and listed on
9759 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
9763 , where you should also go to fetch the class files (yes, these are LaTeX2e
9765 It is a modular system: the things common to all journals are implemented
9770 , which journal-specific layout files (such as, e.g.,
9774 for Journal of Geodesy) can include.
9777 \begin_layout Standard
9779 This means that implementing support for any other Springer journal on this
9780 list is as simple as writing your own
9788 file following the outline given in
9796 \begin_layout Standard
9798 It is reasonably well tested only for the Journal of Geodesy.
9807 come with the standard LyX distribution.
9808 Install the relevant class file (downloaded from Springer) in a proper
9809 directory, reconfigure LaTeX (in the teTeX case by running
9813 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9814 LyX and it should work.
9817 \begin_layout Subsection
9822 \begin_layout Standard
9824 A large number of theorem-like styles ---
9830 \SpecialChar \ldots{}
9836 \begin_layout Standard
9840 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9841 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9844 See the Springer class file documentation for details.
9847 \begin_layout Subsection
9852 \begin_layout Itemize
9865 \begin_layout Itemize
9869 Probability Theory and Related Fields
9875 --- Jean-Marc Lasgouttes
9878 \begin_layout Standard
9880 Add your own, it isn't so hard!
9883 \begin_layout Subsection
9888 \begin_layout Standard
9890 These files are partly based on the older
9894 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9900 layout, are now defunct.
9901 Jean-Marc Lasgouttes helped out big in making me find my way around the
9902 LyX layout file mechanism.
9905 \begin_layout Subsection
9910 \begin_layout Standard
9913 But probably less than in the old hacked-LaTeX
9920 \begin_layout Standard
9922 Limitations e.g.: does not display the number for theorem-like layouts, just
9926 \begin_layout Section
9935 \begin_layout Standard
9942 \begin_layout Subsection
9947 \begin_layout Standard
9949 These are the layout files for some of the journals of the American Geophysical
9951 It is assumed that you have both the AGU's own class files and AGUplus
9952 installed (everything to be found at
9953 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
9960 \begin_layout Subsection
9965 \begin_layout Standard
9976 They are still called this in the LyX GUI, though their LaTeX equivalents
9977 in the AGU classes are
9988 \begin_layout Standard
9990 Newly defined styles are
10027 These are mostly manuscript attributes and defined in the AGU class documentati
10031 \begin_layout Standard
10033 I suspect this is still badly incomplete.
10036 \begin_layout Subsection
10041 \begin_layout Standard
10059 \begin_layout Subsection
10064 \begin_layout Itemize
10068 Journal of Geophysical Research
10077 \begin_layout Standard
10079 Add your own, it isn't so hard! Look at the
10090 \begin_layout Subsection
10092 Bugs and things to remember
10095 \begin_layout Standard
10097 In order to use the new layouts, you must remember to do the following for
10101 \begin_layout Enumerate
10108 This can be done in the
10110 layout\SpecialChar \menuseparator
10115 document\SpecialChar \menuseparator
10119 (AGU articles are always in English, right? So
10123 choose a language.)
10126 \begin_layout Enumerate
10132 into the document's
10137 (Yes, this is a bug.)
10140 \begin_layout Enumerate
10142 Make sure you use the
10146 bibliography style, by entering
10150 into the second field of the BibTeX inset.
10151 None of the standard styles will do.
10154 \begin_layout Section
10163 \begin_layout Standard
10170 \begin_layout Subsection
10175 \begin_layout Standard
10177 This is the layout file for the European Geophysical Society journals.
10182 can be downloaded from the web site of the EGS under
10183 \begin_inset LatexCommand \url{www.copernicus.org}
10190 \begin_layout Subsection
10195 \begin_layout Standard
10199 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10207 The current layout file is unfortunately very unmodular and would benefit
10208 from using the various
10215 \begin_layout Section
10222 \begin_inset LatexCommand \label{sec:slitex}
10229 \begin_layout Standard
10238 \begin_layout Subsection
10243 \begin_layout Standard
10245 This section describes how to use LyX to make slides for overhead projectors.
10246 There are two document classes that can do this: the default slides class
10252 This section documents the former.
10255 \begin_layout Standard
10257 I'm going to say this again, nice and clear, so that there's no misunderstanding
10262 \begin_layout Standard
10265 \begin_inset VSpace bigskip
10271 \begin_layout Standard
10275 This section documents the class
10276 \begin_inset Quotes eld
10284 \begin_inset Quotes erd
10292 \begin_layout Standard
10295 \begin_inset VSpace bigskip
10302 \begin_layout Standard
10304 If you're looking for the documentation for
10305 \begin_inset Quotes eld
10313 \begin_inset Quotes erd
10316 , check out section\InsetSpace ~
10318 \begin_inset LatexCommand \ref{sec:foiltex}
10328 \begin_inset Quotes eld
10336 \begin_inset Quotes erd
10339 ] is actually somewhat better than the default
10347 \begin_layout Standard
10349 \SpecialChar \ldots{}
10350 or so I've been told repeatedly by its advocates.
10351 Having never used it, I have no idea if this claim is true or not.
10356 which this section documents.
10359 \begin_layout Standard
10361 This class is the LaTeX2e improvement of the old
10366 Every LaTeX2e distribution includes this class [which I'll just refer to
10368 \begin_inset Quotes eld
10376 \begin_inset Quotes erd
10379 from now on], so you're bound to have it.
10380 As I noted earlier, there are other classes, such as
10384 , which also produce slides for overhead projectors and do a better job
10386 However, there are some things which
10390 can do which the others can't, such as generate overlays.
10391 Read on to learn more!
10394 \begin_layout Subsection
10397 \begin_inset LatexCommand \label{sec:slidesetup}
10404 \begin_layout Standard
10406 Obviously, to use this document class, you need to select
10407 \begin_inset Quotes eld
10415 \begin_inset Quotes erd
10418 from the class list in the
10423 ocument\SpecialChar \menuseparator
10431 There are some other special things you should know about this class:
10434 \begin_layout Itemize
10436 Don't bother changing the options
10441 They're not supported by the
10448 \begin_layout Itemize
10458 behaves a bit differently for this class.
10459 The possible choices and what they do are as follows:
10463 \begin_layout Description
10469 The final output contains page numbers in the lower right corner.
10472 \begin_layout Description
10482 , but also prints out any time markers you've put in.
10483 This is the default.
10486 \begin_layout Description
10492 The final output contains no page numbers, time markers, or alignment markers.
10495 \begin_layout Itemize
10501 class has an extra option:
10507 \begin_inset Quotes eld
10515 \begin_inset Quotes erd
10518 in the extra class options.
10522 \begin_layout Standard
10524 Using this options allows you to add time markers to
10529 See section\InsetSpace ~
10531 \begin_inset LatexCommand \ref{sec:slideNote}
10538 \begin_layout Standard
10540 You can also use the template file
10541 \begin_inset Quotes eld
10549 \begin_inset Quotes erd
10552 to automatically set up a document to use the
10561 ile\SpecialChar \menuseparator
10570 to open your new document].
10571 The template file also contains some examples of the special paragraph
10572 environments used by this class.
10573 I'll describe those next.
10576 \begin_layout Subsection
10578 Paragraph Environments
10581 \begin_layout Subsubsection
10583 Supported Environments
10586 \begin_layout Standard
10588 The first thing you'll notice when you start up a new
10592 document is the font size and type: it's the equivalent of the size
10593 \begin_inset Quotes eld
10601 \begin_inset Quotes erd
10610 This is also what's used in the output.
10612 \begin_inset Quotes eld
10616 \begin_inset Quotes erd
10619 to remind you that this is a slide.
10620 Your final slides will use a larger font; ergo, you'll have less space.
10621 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10624 \begin_layout Standard
10626 The next thing that becomes obvious is the changes to the paragraph environment
10627 pull-down box [at the far-left end of the toolbar].
10628 Most of the paragraph environments you're used to seeing are missing.
10629 There are also five new ones.
10634 class itself only supports certain paragraph environments:
10637 \begin_layout Itemize
10644 \begin_layout Itemize
10651 \begin_layout Itemize
10658 \begin_layout Itemize
10665 \begin_layout Itemize
10672 \begin_layout Itemize
10679 \begin_layout Itemize
10686 \begin_layout Itemize
10693 \begin_layout Itemize
10700 \begin_layout Itemize
10707 \begin_layout Itemize
10714 \begin_layout Standard
10716 All of the other standard environments, including the section-heading environmen
10717 ts, aren't used in the
10724 \begin_layout Standard
10726 On the other hand, you'll notice the following new environments:
10729 \begin_layout Itemize
10736 \begin_layout Itemize
10743 \begin_layout Itemize
10750 \begin_layout Itemize
10757 \begin_layout Itemize
10764 \begin_layout Standard
10766 These five are kind of quirky, due to a
10767 \begin_inset Quotes eld
10771 \begin_inset Quotes erd
10775 You see, LyX doesn't permit you to nest any other paragraph environment
10776 into an empty environment.
10777 Now, that's fine and dandy, but it means that you wouldn't be able to start
10778 a slide with anything except plain text.
10779 To deal with this, I've performed a little
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10790 \begin_layout Subsubsection
10792 Quirks of the New Environments
10793 \begin_inset LatexCommand \label{sec:slideQuirk}
10800 \begin_layout Standard
10802 All five of the new paragraph environments are somewhat quirky due to inherent
10803 limitiations in the current version of LyX.
10804 As I just mentioned, LyX forbids environments that begin with another environme
10806 To get around this, the
10810 environment isn't a paragraph environment as described in the
10818 \begin_layout Standard
10820 You should consider
10833 \begin_inset Quotes eld
10836 pseudo-environments.
10837 \begin_inset Quotes erd
10840 They look like a section heading or a
10841 \begin_inset Quotes eld
10849 \begin_inset Quotes erd
10852 but really begin a [and, if necessary, end the previous] paragraph environment.
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10869 These two perform some action.
10872 \begin_layout Standard
10874 A common feature of all five environments,
10894 , is a rather long-ish label.
10895 The text following this label --- ordinarily the contents of the paragraph
10896 environment --- is utterly irrelevant for
10917 LyX completely ignores it.
10918 In fact, you can leave these five environments completely empty.
10922 \begin_layout Standard
10928 to put any text after the rather long-ish label, you might want to.
10929 This could be a short description of the contents of the
10934 In that case, enter in your descriptive comment and hit
10938 as you normally would.
10941 \begin_layout Standard
10943 If, on the other hand, you don't want to enter in any descriptive text,
10944 you'll hit another LyX quirk.
10945 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10946 environment until you put something in the old one.
10950 \begin_layout Itemize
10952 Start entering the text that will
10980 \begin_layout Itemize
10982 Now move to the beginning of that paragraph.
10986 \begin_layout Itemize
10996 \begin_layout Itemize
10998 Finally, change this new, empty paragraph to a
11022 \begin_layout Standard
11024 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
11028 \begin_layout Subsection
11030 Making a Presentation with
11043 \begin_layout Subsubsection
11052 \begin_layout Standard
11054 If you're expecting this section to teach you how to actually make a presentatio
11055 n, you'll be sorely disappointed.
11056 Naturally, I'll describe all of the ways the
11060 class can assist you in preparing the materials for a presentation.
11061 Filling in the contents, however, is up to you.
11066 the LyX philosophy.]
11069 \begin_layout Standard
11075 environment [in the manner described in section\InsetSpace ~
11077 \begin_inset LatexCommand \ref{sec:slideQuirk}
11081 ] tells LyX to begin a new slide [duh].
11082 The label for this environment/
11083 \begin_inset Quotes erd
11087 \begin_inset Quotes erd
11091 \begin_inset Quotes eld
11095 \begin_inset Quotes erd
11098 in cool blue, followed by the label,
11099 \begin_inset Quotes eld
11103 \begin_inset Quotes erd
11107 Any text or paragraph environments that follow this one go on the new slide.
11111 \begin_layout Standard
11113 Slides are probably the only time you'll need to forcibly end pages in LyX
11114 (this can be specified in the
11119 In fact, you'll want to, once you finish entering the contents of one slide.
11120 If you've entered more text than can physically fit on a slide, the extra
11121 overflows onto a new slide.
11122 I don't recommend doing this, however, since the overflow slide won't have
11123 any page number on it.
11124 Furthermore, it may interfere with any
11128 you've made to accompany the oversized
11135 \begin_layout Standard
11145 environments work the same way as the
11150 They both create an
11151 \begin_inset Quotes eld
11155 \begin_inset Quotes erd
11158 followed by a label [
11159 \begin_inset Quotes eld
11163 \begin_inset Quotes erd
11167 \begin_inset Quotes eld
11171 \begin_inset Quotes erd
11175 The color is a stunning magenta instead of blue, and the
11176 \begin_inset Quotes eld
11180 \begin_inset Quotes erd
11183 will look different, in style and in length.
11184 The label fonts of all three also differ from one another.
11187 \begin_layout Standard
11193 , if the contents of a
11201 exceed the physical size of a slide or sheet of paper, the extra will overflow
11203 Again, you should avoid this.
11204 It defeats the whole purpose of
11215 \begin_layout Subsubsection
11226 \begin_layout Standard
11232 is a slide that sits atop another slide.
11233 Perhaps you wish to discuss a figure on the main
11237 before displaying the text associated with it.
11238 One way to accomplish this is tape a flap of dark paper over the part of
11243 you want to display later.
11244 This method fails, however, if you wish to overlap one graph with another,
11246 You would then have to fumble while speaking to align the two separate,
11251 s to align the two graphs.
11256 environment in both cases makes life much easier.
11259 \begin_layout Standard
11265 receives the page number of its
11266 \begin_inset Quotes eld
11270 \begin_inset Quotes erd
11278 \begin_inset Quotes eld
11286 \begin_inset Quotes erd
11293 \begin_layout Standard
11295 Presumably, mutliple
11300 \begin_inset Quotes eld
11308 \begin_inset Quotes erd
11312 \begin_inset Quotes eld
11320 \begin_inset Quotes erd
11324 \begin_inset Quotes eld
11332 \begin_inset Quotes erd
11335 , etc.\InsetSpace ~
11336 appended to the page number of the parent
11346 Clearly, you want the contents of both the
11354 to each fit on a single physical slide! You should probably consider an
11360 \begin_inset Quotes eld
11364 \begin_inset Quotes erd
11376 class provides a visual cue for this: the label at the start of an
11380 is shorter than that at the start of a
11385 Lastly, when you generate printable output, you'll find alignment markers
11386 in all four corners of both the
11390 page and its parent
11395 These will assist you in lining up the two physical slides.
11398 \begin_layout Standard
11400 The major problem in overlaying two slides is aligning the contents of the
11401 two transparencies.
11402 How much space should you leave for that graph on the second slide? Worse
11403 still, what if you want a graph and a sentence on second slide, but there
11404 is text on the main transparency that goes in between them? You could try
11405 and insert vertical space of the right size.
11406 The better way is to use
11417 \begin_layout Standard
11419 As their names imply,
11427 are two command-like paragraph environments that make all subsequent text
11428 invisible and visible, respectively.
11429 Note from section\InsetSpace ~
11431 \begin_inset LatexCommand \ref{sec:slideQuirk}
11435 that you don't place anything
11439 these two environments, however.
11444 , it inserts a centered, sky-blue label into the page reading
11445 \begin_inset Quotes eld
11448 <Invisible Text Follows>
11449 \begin_inset Quotes erd
11453 For paragraphs following this label, the parts of the
11461 ; it doesn't matter which] where they would be contain instead blank space.
11465 \begin_layout Standard
11471 , the corresponding centered label is
11472 \begin_inset Quotes eld
11475 <Visible Text Follows>
11476 \begin_inset Quotes erd
11480 Paragraphs following this label behave normally.
11481 Note that the beginning of a new
11493 automatically shuts off an
11498 It's therefore not necessary to use
11509 \begin_layout Standard
11511 By now, it should be obvious how to create overlay transparencies using
11512 the proper combination of
11531 \begin_layout Enumerate
11537 , including everything that will appear on it, whether on the main slide
11545 \begin_layout Enumerate
11547 Before each figure or paragraph that will appear only on the
11556 If necessary, insert a
11560 environment after the
11567 \begin_layout Enumerate
11573 immediately following the
11580 \begin_layout Enumerate
11582 Copy the contents of this
11593 \begin_layout Enumerate
11599 , change all of the
11610 \begin_layout Standard
11613 You've just made an
11620 \begin_layout Standard
11622 There's one problem with the way I've designed the LyX
11626 class: you can't make text in the middle of a paragraph invisible, nor
11627 make text in the middle of an invisible paragraph visible again.
11628 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11632 \begin_layout Standard
11634 The commands of interest are:
11637 \begin_layout Itemize
11643 invisible \SpecialChar \ldots{}
11647 \begin_layout Itemize
11653 visible \SpecialChar \ldots{}
11657 \begin_layout Standard
11659 \SpecialChar \ldots{}
11660 and need to be marked as TeX.
11662 \begin_inset Quotes eld
11666 \begin_inset Quotes erd
11669 you wish to change goes in between the brackets [and after the
11682 If you don't know how to mark text as TeX, see the apprpriate section of
11695 \begin_layout Subsubsection
11706 \begin_inset LatexCommand \label{sec:slideNote}
11713 \begin_layout Standard
11723 is associated with a
11724 \begin_inset Quotes eld
11728 \begin_inset Quotes erd
11740 class provides visual cues.
11745 is shorter than that of a
11749 [yet longer than that of an
11753 ] and, like the label of an
11757 is shockingly magenta.
11758 Additionally, the printed
11762 has the page number of its
11763 \begin_inset Quotes eld
11767 \begin_inset Quotes erd
11775 \begin_inset Quotes eld
11783 \begin_inset Quotes erd
11787 \begin_inset Quotes eld
11795 \begin_inset Quotes erd
11799 \begin_inset Quotes eld
11807 \begin_inset Quotes erd
11811 You can have multiple
11815 s associated with a single
11827 , you'll probably want to break up long
11831 s so that they fit on a single sheet of paper.
11834 \begin_layout Standard
11840 is obvious: it contains anything additional you might want to say about
11846 It could also be used as a sheet of reminders for a particular
11851 In the case of the latter, you might want to make use of time markers.
11857 \begin_inset Quotes eld
11861 \begin_inset Quotes erd
11864 support for time markers, a
11869 So, you'll have to resort to using the LaTeX codes.
11872 \begin_layout Standard
11874 To use time markers, you'll need to specify the extra class option
11875 \begin_inset Quotes eld
11883 \begin_inset Quotes erd
11886 [see section\InsetSpace ~
11888 \begin_inset LatexCommand \ref{sec:slidesetup}
11893 This option turns on timing marks, which will appear in the lower-left-hand
11899 To set what appears in the time marker, you use the LaTeX commands
11900 \begin_inset Quotes eld
11910 \begin_inset Quotes erd
11914 \begin_inset Quotes eld
11924 \begin_inset Quotes erd
11928 The arguments of both commands are time measured in seconds.
11930 \begin_inset Quotes eld
11940 \begin_inset Quotes erd
11943 sets the time marker to a given time.
11945 \begin_inset Quotes eld
11955 \begin_inset Quotes erd
11958 increments the time marker by the specified amount.
11959 Using time markers and
11963 s in this fashion, you can remind yourself how much time to spend on a particula
11971 \begin_layout Standard
11973 There's one last feature to describe.
11974 Clearly, you'd like to print out all of your
11982 s on transparencies while printing all of your
11999 with which it is associated.
12000 What's a person to do?
12003 \begin_layout Standard
12005 Luckily, there are two LaTeX commands that allow you to select what to print
12007 Both must be placed into the preamble of your document.
12009 \begin_inset Quotes eld
12021 \begin_inset Quotes erd
12024 will cause the output to contain only the
12033 Correspondingly, the command
12034 \begin_inset Quotes eld
12046 \begin_inset Quotes erd
12049 prevents the output of anything but
12054 I'd advise placing both commands in the preamble and initially comment
12056 You can then preview your entire presentation as you write.
12057 When you're done writing, you can then uncomment one of the two to select
12058 what you want to print.
12059 I like to uncomment
12060 \begin_inset Quotes eld
12072 \begin_inset Quotes erd
12075 , print to a file with
12076 \begin_inset Quotes eld
12084 \begin_inset Quotes erd
12087 in its name, comment it back out, then uncomment
12088 \begin_inset Quotes eld
12100 \begin_inset Quotes erd
12104 \begin_inset Quotes eld
12112 \begin_inset Quotes erd
12116 I can then send either file to a printer, loading transparencies or plain
12117 paper as appropriate.
12120 \begin_layout Standard
12122 You can also provide other arguments to the
12123 \begin_inset Quotes eld
12133 \begin_inset Quotes erd
12137 \begin_inset Quotes eld
12147 \begin_inset Quotes erd
12151 See a good LaTeX book for details.
12154 \begin_layout Subsection
12160 Class Template File
12163 \begin_layout Standard
12165 I have also provided a template file,
12166 \begin_inset Quotes eld
12174 \begin_inset Quotes erd
12182 To use it, begin your new presentation with
12187 ile\SpecialChar \menuseparator
12197 Your new LyX presentation file will contain an example
12218 additionally contain an example of the use of
12227 Lastly, the preamble will contain:
12230 \begin_layout LyX-Code
12232 % Uncomment to print out only slides and overlays
12235 \begin_layout LyX-Code
12240 \begin_layout LyX-Code
12251 \begin_layout LyX-Code
12253 % Uncomment to print out only notes
12256 \begin_layout LyX-Code
12261 \begin_layout LyX-Code
12270 \begin_layout Standard
12272 One final thing: I created this class to support the LaTeX2e
12273 \begin_inset Quotes eld
12281 \begin_inset Quotes erd
12284 class, one of the built-in LaTeX2e classes.
12285 Neither I nor the rest of the LyX Team endorse or oppose the use of this
12286 built-in slide class.
12287 It's here if you want it or need it.
12288 There exist other LaTeX2e classes for creating presentations, such as the
12293 class [see section\InsetSpace ~
12295 \begin_inset LatexCommand \ref{sec:foiltex}
12300 \begin_inset Quotes eld
12308 \begin_inset Quotes erd
12311 package [present on some TeX distributions].
12312 The latter is not yet supported under LyX.
12316 \begin_layout Standard
12318 Perhaps you can take on the task\SpecialChar \ldots{}
12324 I know nothing about these other classes.
12325 Try them out to see what sort of alternative they provide.
12328 \begin_layout Section
12338 \begin_inset LatexCommand \label{sec:foiltex}
12345 \begin_layout Standard
12352 \begin_layout Subsection
12357 \begin_layout Standard
12359 This section describes how to use LyX to make slides for overhead projectors.
12360 There are two document classes that can do this: the default slides class
12366 This section documents the latter.
12369 \begin_layout Standard
12371 I'm going to say this again, nice and clear, so that there's no misunderstanding
12376 \begin_layout Standard
12379 \begin_inset VSpace bigskip
12385 \begin_layout Standard
12389 This section documents the class
12390 \begin_inset Quotes eld
12398 \begin_inset Quotes erd
12406 \begin_layout Standard
12409 \begin_inset VSpace bigskip
12416 \begin_layout Standard
12418 If you're looking for the documentation for
12419 \begin_inset Quotes eld
12427 \begin_inset Quotes erd
12430 , check out section\InsetSpace ~
12432 \begin_inset LatexCommand \ref{sec:slitex}
12437 If your machine doesn't have the
12442 \begin_inset Quotes eld
12450 \begin_inset Quotes erd
12453 ] installed, you'll probably have to use the default
12457 class, which isn't quite as good as
12462 \begin_layout Standard
12468 class is designed for use with version 2.1 of the
12472 LaTeX class file which is now an integral part of LaTeX2e.
12475 \begin_layout Subsection
12480 \begin_layout Standard
12482 Obviously, to use this document class, you need to select
12483 \begin_inset Quotes eld
12491 \begin_inset Quotes erd
12503 Document\InsetSpace ~
12507 There are some settings in the
12509 Document\InsetSpace ~
12512 dialog that you should know about that are specific to this class:
12515 \begin_layout Itemize
12517 Don't change the options
12527 Document\InsetSpace ~
12531 They're ignored by the
12538 \begin_layout Itemize
12540 The default font size is 20pt with the other options being 17pt, 25pt and
12544 \begin_layout Itemize
12546 The default font is
12554 but all math equations are still typeset in the usual roman font.
12557 \begin_layout Itemize
12563 TeX supports A4 and Letter paper sizes as well as a special size for working
12565 It doesn't support A5, B5, legal or executive paper sizes.
12568 \begin_layout Itemize
12570 Don't bother changing the
12574 settings because they are ignored anyway.
12575 All floats appear where they are defined in the text.
12578 \begin_layout Itemize
12587 setting behaves a bit differently for this class.
12592 TeX provides extensive footer and header capabilities including a user-defined
12594 See section\InsetSpace ~
12596 \begin_inset LatexCommand \ref{sec:foilfoot}
12601 The title page is treated differently to all other pages in the document
12610 has the logo centered at the bottom of the page (if one is defined).
12611 The possible page style choices and what they do are as follows:
12616 \labelwidthstring MMMMMMM
12624 The final output contains no page numbers, or other headers or footers
12625 (except footnotes of course).
12630 \labelwidthstring MMMMMMM
12638 The final output contains page numbers centered at the bottom of the page.
12639 No other headings or footers (other than footnotes).
12643 \labelwidthstring MMMMMMM
12649 Page numbers in lower right corner.
12650 Additional headers and footers are also shown.
12651 This is also the default.
12655 \labelwidthstring MMMMMMM
12661 Gives you access to the
12665 package although its use with
12669 TeX is discouraged by the writer of the
12673 TeX package because of some potential page layout clashes.
12676 \begin_layout Subsubsection
12681 \begin_layout Standard
12683 The following options may be used in the extra class options in the
12688 ocument\SpecialChar \menuseparator
12699 \labelwidthstring MMMMMMx
12705 This sets up the page layout for 7.33in by 11in paper, which is about the
12706 same aspect ratio as a 35mm slide, making it a bit easier to work with
12711 \labelwidthstring MMMMMMx
12717 Places a rule across the page below the header on every page except the
12722 \labelwidthstring MMMMMMx
12728 Places a rule across the page above the footer on every page except the
12733 \labelwidthstring MMMMMMx
12739 This is automatically set each time you create a new
12748 TeX to use the dvips driver to rotate those pages that are set as landscape
12753 \labelwidthstring MMMMMMx
12759 Simply changes the page dimensions to those of a landscape page but doesn't
12761 Thus if you use this option you need to use an external program to rotate
12762 each page or feed your paper through your printer as landscape.
12763 Note that this option effectively reverses the roles of the
12771 environments (don't worry these are described in the next section).
12775 \labelwidthstring MMMMMMx
12781 Equation numbers on the left.
12785 \labelwidthstring MMMMMMx
12791 Flush-left equations.
12794 \begin_layout Subsection
12796 Supported Environments
12799 \begin_layout Standard
12801 Most of the environments commonly supported in other classes are also supported
12807 There are several additional environments provided by
12811 TeX as well as a couple added by LyX.
12812 The following environments are shared with other classes:
12815 \begin_layout Standard
12821 \begin_layout Standard
12824 begin{multicols}{2}
12832 \begin_layout Itemize
12839 \begin_layout Itemize
12846 \begin_layout Itemize
12853 \begin_layout Itemize
12860 \begin_layout Itemize
12867 \begin_layout Itemize
12874 \begin_layout Itemize
12881 \begin_layout Itemize
12888 \begin_layout Itemize
12895 \begin_layout Itemize
12902 \begin_layout Itemize
12909 \begin_layout Itemize
12916 \begin_layout Itemize
12923 \begin_layout Itemize
12930 \begin_layout Itemize
12937 \begin_layout Itemize
12944 \begin_layout Itemize
12951 \begin_layout Itemize
12958 \begin_layout Standard
12964 \begin_layout Standard
12975 \begin_layout Standard
12977 That is, all the major environments apart from the sectioning environments.
12978 Since foils are essentially self-contained sections, with a title and body,
12983 TeX provides specific commands for starting new foils and these are:
12986 \begin_layout Itemize
12993 \begin_layout Itemize
13000 \begin_layout Standard
13002 LyX also provides slightly modified versions of these two environments called:
13005 \begin_layout Itemize
13012 \begin_layout Itemize
13016 ShortRotatefoilhead
13019 \begin_layout Standard
13021 and the differences will be explained in the next section.
13024 \begin_layout Standard
13026 Since foils are often used in presenting ideas or new theorems and such
13031 TeX also provides a comprehensive box of goodies for presenting them:
13034 \begin_layout Standard
13040 \begin_layout Standard
13043 begin{multicols}{2}
13051 \begin_layout Itemize
13058 \begin_layout Itemize
13065 \begin_layout Itemize
13072 \begin_layout Itemize
13079 \begin_layout Itemize
13086 \begin_layout Itemize
13093 \begin_layout Itemize
13100 \begin_layout Itemize
13107 \begin_layout Itemize
13114 \begin_layout Itemize
13121 \begin_layout Itemize
13128 \begin_layout Standard
13134 \begin_layout Standard
13145 \begin_layout Standard
13147 The starred versions are unnumbered while the unstarred versions are numbered.
13148 There are also two list environments added by LyX and these are:
13151 \begin_layout Itemize
13158 \begin_layout Itemize
13165 \begin_layout Standard
13171 TeX provides some powerful header and footer capabilities that are best
13172 set in the preamble although they may be set at any point in a document.
13173 If you want to change these settings in your document the best place to
13174 do so is at the very top of a foil,
13179 straight after the foilhead.
13182 \begin_layout Standard
13184 For this purpose, the following command styles are provided [
13191 \begin_layout Standard
13197 \begin_layout Standard
13200 begin{multicols}{2}
13208 \begin_layout Itemize
13216 \begin_layout Itemize
13223 \begin_layout Itemize
13231 \begin_layout Itemize
13239 \begin_layout Itemize
13248 \begin_layout Standard
13254 \begin_layout Standard
13260 \begin_layout Standard
13271 \begin_layout Standard
13273 There are also a few commands provided by
13277 TeX that aren't directly supported by LyX but I'll tell you what they do
13278 and how to use them in section\InsetSpace ~
13280 \begin_inset LatexCommand \ref{sec:unsuppfoils}
13287 \begin_layout Subsection
13289 Building a Set of Foils
13292 \begin_layout Standard
13294 This section will give a simple introduction to using the different environments
13295 to build a set of foils.
13296 If you want to see an example set of foils take a look at the
13300 file accessible from the
13305 ile\SpecialChar \menuseparator
13310 pen\SpecialChar \ldots{}
13321 \begin_layout Subsubsection
13323 Give It a Title Page
13326 \begin_layout Standard
13328 Unlike other classes that provide
13348 creates the title on a page of its own.
13349 If you leave out the
13353 environment LaTeX will substitute the current date (every time you regenerate
13357 \begin_layout Subsubsection
13362 \begin_layout Standard
13364 As I mentioned earlier, there are four ways of starting a new foil.
13365 For portrait foils you should use
13374 The difference between these two environments is the amount of space between
13375 the title of the foil (the foilhead) and the body of the foil.
13378 \begin_layout Standard
13380 Landscape foils are generated using the
13386 ShortRotatefoilhead
13389 Again the only difference is the spacing between foilhead and body.
13390 Both of the short versions have 0.5 inches less separation between the foilhead
13395 \begin_layout Standard
13397 One problem with the support for landscape foils is the requirement that
13398 you have to use the
13402 driver to generate the PostScript® output otherwise the foils won't be
13404 It is possible to get landscape foils even if you haven't got the
13408 driver provided you can feed your foils sideways through your printer ;-)
13411 \begin_layout Subsubsection
13413 Theorems, Lemmas, Proofs and more
13416 \begin_layout Standard
13418 Due to a small bug in LyX you can't have two of the same type of these environme
13419 nts directly following each other.
13420 They must be separated by something.
13421 If you try, you will just be extending the previous environment as if you
13422 had merged the two environments together.
13423 So, how do you get around this problem? The simplest option is to insert
13424 some text between the two environments or add a
13428 environment between the two with just a
13429 \begin_inset Quotes eld
13437 \begin_inset Quotes erd
13441 This will force LyX to produce two separate environments and hence the
13442 correct LaTeX output.
13443 An example is provided in the example file included with the LyX distribution.
13444 Remember, this problem only occurs if you are trying to place two of the
13445 same type of theorem-like environments one directly after the other.
13448 \begin_layout Subsubsection
13453 \begin_layout Standard
13455 You get all the commonly supported list styles found in other classes as
13456 well as two new ones.
13457 I'll only describe the new ones here.
13458 If you want to find out more about the other list environments check out
13464 If you intend to use itemized lists you might also want to read about the
13467 Itemize\InsetSpace ~
13468 Bullet\InsetSpace ~
13471 dialog described above in section\InsetSpace ~
13473 \begin_inset LatexCommand \ref{sec:bullet}
13480 \begin_layout Standard
13482 The two new list styles,
13490 , are designed to make it easier for you to create lists of do's and don'ts
13491 or right and wrong by providing dedicated environments that use a tick
13492 or a cross as the label of the list.
13493 These lists are in fact dedicated variants of the
13498 They do however require that you have the
13502 packages installed.
13505 \begin_layout Subsubsection
13510 \begin_layout Standard
13516 TeX redefines the floating tables and figures so that they appear exactly
13517 where they are in the text rather than pushing them to the top of the page
13518 or to some user specified location.
13519 In fact if you change the float placement settings they are simply ignored.
13522 \begin_layout Subsubsection
13524 Page Headers and Footers
13525 \begin_inset LatexCommand \label{sec:foilfoot}
13532 \begin_layout Standard
13543 are two commands used to control the left-footer text string.
13544 The first is meant to allow you to include a graphic logo on your foils
13546 \begin_inset Quotes eld
13554 \begin_inset Quotes erd
13558 While the second is meant to provide a classification for the audience,
13565 It is empty by default.
13568 \begin_layout Standard
13570 The remaining page corners can be filled by
13575 (which defaults to page numbers),
13588 \begin_layout Subsection
13595 \begin_inset LatexCommand \label{sec:unsuppfoils}
13602 \begin_layout Standard
13604 All the commands mentioned below need to be set in a
13612 within another environment.
13615 \begin_layout Subsubsection
13620 \begin_layout Standard
13622 All lengths are adjusted using the
13645 should be replaced by the name given to the length you want to change and
13650 is the length value.
13651 All lengths should be specified in units of length such as inches (
13663 ) or relative to some document or font-based length such as
13673 \begin_layout Standard
13675 It's possible to change the spacing between a foilhead and the body of the
13676 foil by adjusting the length specified by
13683 For example, to make
13687 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13694 foilheadskip}{-0.5in}
13697 \begin_layout Standard
13699 The spacings around floats can be adjusted by setting these lengths:
13703 \labelwidthstring MMMMMMMMMMM
13711 Separation between the text and the top of the float
13715 \labelwidthstring MMMMMMMMMMM
13723 Separation between the float and the caption
13727 \labelwidthstring MMMMMMMMMMM
13735 Separation between the caption and the following text
13739 \labelwidthstring MMMMMMMMMMM
13747 You can make the captions narrower than the surrounding text by adjusting
13749 Best done relative to
13758 \begin_layout Standard
13760 There are also several title page related lengths that you may find useful
13761 if you have a long title or several authors:
13765 \labelwidthstring MMMMMMMMMMM
13773 Separation from headers to
13779 \labelwidthstring MMMMMMMMMMM
13799 \labelwidthstring MMMMMMMMMMM
13815 \labelwidthstring MMMMMMMMMMM
13833 \labelwidthstring MMMMMMMMMMM
13850 \begin_layout Standard
13852 The last length related command affects all the list environments.
13863 a list environment then all the vertical spacing between the list items
13865 Note that this is a command not a length so it doesn't require
13871 like the stuff mentioned above.
13874 \begin_layout Subsubsection
13876 Headers and Footers
13879 \begin_layout Standard
13893 commands control whether the logo in the
13897 definition appear on a given page.
13904 in the preamble then none of the foils will have the logo on them.
13905 If you don't want the logo on a particular page place the
13911 directly after the foilhead of that page and the
13917 directly after the next foilhead.
13920 \begin_layout Standard
13922 If you decide to use the
13926 page style setting in the
13928 Document\InsetSpace ~
13931 dialog you should probably add
13941 to your preamble so headers and footers on landscape pages are correctly
13942 placed when rotated.
13943 This is due to some clashes between the page layouts provided by the
13954 \begin_layout Section
13956 Latex8 (IEEE Conference Papers)
13959 \begin_layout Standard
13966 \begin_layout Subsection
13971 \begin_layout Standard
13973 Since this class is specifically for writing submissions to IEEE sponsored
13974 conferences I strongly recommend that you get a copy of their Authors Kit.
13979 package and associated bibliography style file is included in the kit.
13980 The Authors Kit is usually sent out by email once your initial submission
13982 There is a lot of useful information in the Authors Kit explaining formatting
13983 restrictions and so on and I will assume you have read this since that
13984 means I don't have to repeat it all here.
13987 \begin_layout Subsection
13992 \begin_layout Standard
13994 [AR\SpecialChar \@.
13998 \begin_layout Subsection
14000 Supported Environments
14003 \begin_layout Itemize
14010 \begin_layout Itemize
14017 \begin_layout Itemize
14024 \begin_layout Itemize
14031 \begin_layout Itemize
14038 \begin_layout Itemize
14045 \begin_layout Itemize
14052 \begin_layout Itemize
14059 \begin_layout Itemize
14066 \begin_layout Subsection
14068 Differences Between Screen and Paper
14071 \begin_layout Standard
14073 There are slight differences in appearance mainly with the presentation
14074 of section counters.
14075 On screen the trailing period of the section counter is missing but it
14076 will appear in the output so don't let this worry you.
14079 \begin_layout Section
14081 Hollywood (Hollywood spec scripts)
14084 \begin_layout Standard
14091 \begin_layout Subsection
14096 \begin_layout Standard
14098 Getting the format of a Hollywood script right is a
14099 \begin_inset Quotes eld
14103 \begin_inset Quotes erd
14106 It is designed to make the readers focus on content and to be easy and
14107 familiar for the actors to read.
14108 Each page of a script should be one minute of film.
14109 Nothing goes in a script that you cannot see or hear on screen.
14110 The courier 12 pt font should be used throughout.
14114 \begin_layout Subsection
14119 \begin_layout Standard
14121 Speakers' lines should NEVER break in mid-sentence.
14122 If a speaker's lines continue over a page break, repeat the
14126 title followed by (Cont'd).
14129 \begin_layout Subsection
14134 \begin_layout Standard
14140 names as labels then cross-reference the label to insert the name.
14141 The cross-reference dialog will show the current cast of characters.
14142 You can use this to insert the speaker name in narratives also.
14145 \begin_layout Subsection
14147 Paper size and Margins
14150 \begin_layout Standard
14152 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14155 \begin_layout Subsection
14160 \begin_layout Standard
14162 The following environments are available.
14163 You can use hollywood.bind to get the bind keys shown at the right.
14166 \begin_layout Itemize
14174 Used where nothing else works.
14178 \begin_layout Itemize
14192 Usually followed by something like
14193 \begin_inset Quotes eld
14196 on Sally waking up.
14197 \begin_inset Quotes erd
14203 \begin_layout Itemize
14213 Introduces a new INTERIOR camera set-up.
14214 Always followed by DAY or NIGHT, or something similar to define the lighting
14216 Everthing on this line in CAPS.
14219 \begin_layout Itemize
14229 Introduces a new EXTERIOR camera set-up.
14230 Everthing on this line in CAPS.
14233 \begin_layout Itemize
14243 The character speaking.
14246 \begin_layout Itemize
14256 Instructions to the speaker.
14257 The () are automatically inserted, but only the ( will show in LyX.
14258 Both will be printed.
14261 \begin_layout Itemize
14278 \begin_layout Itemize
14288 Camera movement instruction.
14293 \begin_layout Itemize
14302 \begin_layout Itemize
14311 \begin_layout Itemize
14320 \begin_layout Itemize
14329 \begin_layout Subsection
14334 \begin_layout Itemize
14336 (O.S) --- off screen
14339 \begin_layout Itemize
14341 (V.0) --- voice over
14344 \begin_layout Itemize
14350 \begin_layout Itemize
14356 \begin_layout Itemize
14358 PAN --- camera movement
14361 \begin_layout Itemize
14363 INSERT --- cut to close-up of
14366 \begin_layout Section
14371 \begin_layout Standard
14378 \begin_layout Subsection
14383 \begin_layout Standard
14385 Broadway is for writing plays.
14386 The format is more decorative than Hollywood, and much less standardized.
14387 This format should be suitable for workshops.
14390 \begin_layout Subsection
14395 \begin_layout Standard
14397 The same as in Hollywood.
14400 \begin_layout Subsection
14405 \begin_layout Standard
14411 names as labels then cross-reference the label to insert the name.
14412 The cross-reference dialog will show the current cast of characters.
14415 \begin_layout Subsection
14417 Paper size and Margins
14420 \begin_layout Standard
14422 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14425 \begin_layout Subsection
14430 \begin_layout Standard
14432 The following environments are available.
14433 You can use broadway.bind to get the bind keys shown at the right.
14436 \begin_layout Itemize
14444 You should not have to use this, but it is here for anything that does not
14448 \begin_layout Itemize
14458 Used to describe stage setting and the action.
14459 First use of speaker names in all CAPs.
14462 \begin_layout Itemize
14472 Automatically numbered.
14473 On screen it will be arabic, but will print as Roman.
14476 \begin_layout Itemize
14491 It is just centered text.
14494 \begin_layout Itemize
14504 Not automatically numbered.
14505 You supply the number.
14506 This is because I couldn't figure out how.
14509 \begin_layout Itemize
14519 A special case of Narrative to describe the setting and action as the curtain
14523 \begin_layout Itemize
14533 The speaker's (actor's) title, centered in all CAPS.
14536 \begin_layout Itemize
14546 Instructions to the speaker.
14547 The parentheses are automatically inserted.
14548 The ( will appear on screen, but both will be in the printed play.
14549 This environment is only used within
14556 \begin_layout Itemize
14566 What the Speaker says.
14569 \begin_layout Itemize
14579 The curtain comes down.
14582 \begin_layout Itemize
14591 \begin_layout Itemize
14600 \begin_layout Itemize
14609 \begin_layout Standard
14614 \begin_layout Section
14619 \begin_layout Standard
14627 \begin_layout Standard
14630 \begin_inset VSpace bigskip
14636 \begin_layout Standard
14640 Revtex\InsetSpace ~
14643 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14644 \begin_inset Formula $\beta$
14647 release of May, 1999) class.
14650 \begin_layout Standard
14656 textclass, which works with RevTeX 3.1.
14657 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14658 That means that it doesn't interact very well with LyX, which requires
14659 LaTeX2e, although it has been kludged to work.
14660 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14663 RevTeX\InsetSpace ~
14666 textclass should also be pretty easy to use.
14669 \begin_layout Standard
14671 These documents are supposed to be used in
14675 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14676 macros, and assume you'll know what to put in the preamble if necessary.
14679 \begin_layout Subsection
14684 \begin_layout Standard
14686 All you need to do is install RevTeX 4, as described in the package's README
14688 the package can be found at
14689 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14694 Install it somewhere that LaTeX can see it.
14695 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14696 (i.e., not the directory where you installed the class file.) Then, if you
14697 reconfigure LyX, it will find the class file and let you use the RevTeX4
14701 \begin_layout Standard
14703 Probably the easiest way to get started is either to import a RevTeX 4 document
14710 Revtex\InsetSpace ~
14713 template, found in the templates directory.
14716 \begin_layout Subsection
14721 \begin_layout Standard
14723 Optional arguments to
14730 \begin_inset Quotes eld
14734 \begin_inset Quotes erd
14738 \begin_inset Quotes eld
14742 \begin_inset Quotes erd
14756 Document\InsetSpace ~
14760 Remember that in RevTeX, at least one optional argument is required!
14763 \begin_layout Standard
14765 Other preamble matter, like
14777 dialog, also as usual.
14780 \begin_layout Subsection
14785 \begin_layout Standard
14787 The layouts basically correspond to the commands in RevTeX4.0.
14788 For example, the Email layout corresponds to
14795 Note that (at least as of RevTeX 4.0 Beta), the
14803 layouts are exactly equivalent, so you shouldn't need to use both.
14807 \begin_layout Standard
14809 In case you're curious, both were included so that
14813 would be able to translate both
14833 \begin_layout Subsection
14838 \begin_layout Standard
14840 There are a couple of important unique aspects of RevTeX 4 which might cause
14841 bugs that will be even more confusing in LyX.
14844 \begin_layout Standard
14863 The LyX equivalent is that there is a separate Thanks layout.
14868 write footnotes in the
14872 layout, or weird things may happen.
14873 See the RevTeX 4 documentation for more details.
14876 \begin_layout Standard
14880 Author\InsetSpace ~
14885 Author\InsetSpace ~
14892 layouts must be placed
14900 layout and the corresponding
14917 , the LaTeX won't compile.
14920 \begin_layout Subsection
14925 \begin_layout Standard
14927 The main problem with this layout is that you can't use the optional arguments
14928 to layouts like Email and Title.
14929 (The problem is not unique to this layout; you can't use optional arguments
14930 to the Section layouts either.) This means that after you export that file
14931 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14932 need to edit the LaTeX file with a text editor to add the optional arguments
14933 to set, e.g., the running title for the page headers.
14934 Lacking these layouts makes the
14940 (and the equivalent
14946 ) useless, so the corresponding layouts don't exist, and will have to be
14951 \begin_layout Standard
14957 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14958 has not been updated yet to take advantage of it.
14966 \begin_layout Section
14968 Article (mwart), book (mwbk) and report (mwrep)
14969 \begin_inset OptArg
14972 \begin_layout Standard
14986 \begin_layout Standard
14993 \begin_layout Standard
14995 The LyX document classes
15011 correspond to the LaTeX document classes
15024 They are replacements for the standard document classes
15036 , resp., and fit better to Polish typography conventions in a number of points.
15040 \begin_layout Standard
15045 \begin_layout Itemize
15047 Unnumbered titles (with star, eg.
15052 ) are added into table of contents,
15055 \begin_layout Itemize
15057 Additional page styles:
15061 \begin_layout Description
15063 uheadings header with separated lines,
15066 \begin_layout Description
15068 myheadings custom header, contents headers via commands:
15083 \begin_layout Description
15085 myuheadings custom header with separated lines,
15088 \begin_layout Description
15090 outer page number is placed on outer side of page
15093 \begin_layout Itemize
15099 \begin_layout Description
15101 rmheadings serif titles --- default,
15104 \begin_layout Description
15106 sfheadings sansserif titles,
15109 \begin_layout Description
15111 authortitle on title page first placed is author next title --- default,
15114 \begin_layout Description
15116 titleauthor on title page first placed is title next author,
15119 \begin_layout Description
15121 withmarginpar reserve place on page for margins.
15124 \begin_layout Section
15129 \begin_layout Standard
15136 \begin_layout Standard
15138 Elsevier Science Publishers B.V.
15139 provides a standard LaTeX document class (
15143 ) for submitting articles to their various journals.
15144 The style file can be downloaded directly from their web site:
15145 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
15150 Instructions are supplied along with the class file, which details the
15151 requirements of the publishers.
15152 LyX includes package that allows for the use of this class, by a layout
15153 and a template file.
15154 Installation of the class file is the same as for any other LaTeX package;
15155 instructions are provided in the Elsevier documentation.
15158 \begin_layout Standard
15169 As the Elsevier class file is based mainly on the standard article class,
15170 most of the normal functionality is provided.
15171 The Elsevier class defines a number of mathematical environments, which
15172 are similar to the AMS environments.
15173 These commands are all described in the Elsevier documentation, and are
15177 \begin_layout Standard
15179 The easiest way to use the Elsevier style is to base documents on the included
15181 It is best not to use options such as fancy headings or the geometry package,
15182 as elements such as these are defined by Elsevier in their style file.
15183 Ideally, no extra packages except those mentioned in the Elsevier documentation
15185 Essentially, Elsevier require as
15186 \begin_inset Quotes eld
15190 \begin_inset Quotes erd
15197 \begin_layout Standard
15205 file as possible, as their intention is to take the supplied file and replace
15206 the class file with one for the particular journal to which the paper has
15208 This also means that not too much time should be spent on the formating
15210 When it comes to be published, this will change anyway.
15211 The rest of the usage for this layout is substantially the same as for
15212 the normal article class.
15213 For details of what Elsevier do and don't allow, refer to their documentation.
15216 \begin_layout Section
15221 \begin_layout Standard
15225 Jürgen Spitzmüller
15228 \begin_layout Subsection
15233 \begin_layout Standard
15235 Memoir is a very powerful and constantly evolving class.
15236 It has been designed with regard to fictional and non-fictional literature.
15237 Its aim is to let the user have maximum control over the typesetting of
15239 Memoir is based on the standard book class, but it can also emulate the
15240 article class (see below).
15243 \begin_layout Standard
15245 Peter Wilson, the developer of Memoir, is known as the author of lots of
15246 useful packages in the LaTeX world.
15247 Most of them have been merged with Memoir.
15248 Therefore, it is much easier to layout the table of contents, appendices,
15249 chapter designs and such.
15250 LyX, though, does not support all of these goodies natively.
15251 Some of them might be added to forthcoming releases
15255 \begin_layout Standard
15257 You are invited to send suggestions to
15258 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
15267 , lots will probably never, due to the limitations of LyX's framework.
15268 Of course you can still use all features with the help of some native LaTeX
15273 \begin_layout Standard
15279 \begin_layout Standard
15287 section\InsetSpace ~
15289 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
15299 In this section, we can only list those features which are natively supported
15301 For detailed descriptions (and for the rest of features) we are recommending
15302 to have a look at the detailed manual of the Memoir class
15306 \begin_layout Standard
15312 \begin_layout Standard
15321 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15330 , which is not only a user guide for the class, but also both a comprehensive
15331 description on good typesetting and a superb example for good typesetting
15335 \begin_layout Subsection
15337 Basic features and restrictions
15340 \begin_layout Standard
15342 Memoir supports basically all features of the standard book classes.
15343 There are, however, some differences, as follows:
15346 \begin_layout Description
15349 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
15353 \begin_layout Description
15356 style: The fancy page style is not supported, due to a command clash
15357 between Memoir and the fancyhdr package (they are both defining a command
15358 with the same name, which confuses LaTeX).
15359 Instead, Memoir comes with a bunch of own page styles (see
15361 Layout\SpecialChar \menuseparator
15362 Document\SpecialChar \menuseparator
15367 If you want to use these for the chapter pages, you have to use the command
15374 in the main text or in preamble (e.
15378 \begin_layout Standard
15390 \begin_layout Standard
15402 chapterstyle{companion}
15407 \begin_layout Description
15409 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
15410 an optional argument in the standard classes.
15411 With this, you can specify an alternative version of the title for the
15412 table of contents and the headers (for instance, if the title is too long).
15413 In LyX, you can do this via
15415 Insert\SpecialChar \menuseparator
15419 at the beginning of a chapter/section.
15420 Memoir features a second optional argument and thus separates the table
15421 of contents from the header.
15422 You can define three variants of a title with this: one for the main text,
15423 one for the table of contents, and one for the headers.
15424 Simply insert two optional arguments if you need this feature, the first
15425 one containing the short title for the Table of Contents, the second one
15426 containing an alternative short title for the headers.
15429 \begin_layout Description
15431 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15432 of contents, the list of figures and the list of table start a new page
15434 Memoir does not follow this route.
15435 You have to insert a page break yourself, if you want to have one.
15438 \begin_layout Description
15440 Titlepage: For some unknown reason, Memoir uses pagination on the title
15441 page (in the standard classes, title pages are
15442 \begin_inset Quotes eld
15446 \begin_inset Quotes erd
15453 \begin_layout Standard
15465 \begin_layout Standard
15474 If you want an empty title page, type
15478 aliaspagestyle{title}{empty}
15483 \begin_layout Description
15485 Article: With the class option
15491 Layout\SpecialChar \menuseparator
15492 Document\SpecialChar \menuseparator
15496 ), you can emulate article style.
15497 That is, counters (footnotes, figures, tables etc.) will not be reset on
15498 new chapters, chapters don't start a new page (but are---in contrary to
15500 \begin_inset Quotes eld
15504 \begin_inset Quotes erd
15507 article classes---still allowed), parts, though, use their own page, as
15511 \begin_layout Description
15513 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15514 font commands, which have been used in the old LaTeX version 2.09 (e.
15518 \begin_layout Standard
15530 \begin_layout Standard
15551 It produces an error and stops LaTeX whenever such a command appears.
15556 reallows the commands and spits out warnings instead (which does at least
15558 Since a lot of packages and particularly BibTeX style files are still using
15559 those commands, we have decided to use this option by default.
15562 \begin_layout Subsection
15567 \begin_layout Standard
15569 We will only describe the features supported by LyX (which is not much currently
15571 Please consult the Memoir manual
15575 \begin_layout Standard
15581 \begin_layout Standard
15590 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15602 \begin_layout Description
15604 Abstract: You may wonder why an abstract is an extra feature.
15605 Well, it is in book class.
15606 Usually books don't have abstracts.
15607 Memoir, however, has.
15608 You can use it whereever and how often you like.
15611 \begin_layout Description
15613 Chapterprecis: You may know this from belletristic: The contents of a chapter
15614 is shortly described below the title and also in the table of contents
15619 \begin_layout Standard
15631 \begin_layout Standard
15641 Our hero arrives in Troia; he loses some friends; he finds others
15644 Chapterprecis does exactly this.
15645 It is therefore only sensible below a chapter.
15648 \begin_layout Description
15650 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15651 The epigraph environment provides an elegant way of typesetting such a
15653 The motto itself (text) and its author (source) are divided by a short
15655 Unfortunately, we have to fool LyX a bit here again, since the environment
15656 needs two arguments (text and source).
15657 In this case, we have to use curly brackets (in TeX mode) between the two
15668 <author of the slogan>.
15671 \begin_layout Description
15673 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15674 complex figurative poems).
15675 Lyx can only support a few of them.
15676 One is poemtitle, which is a centered title for poems, which will also
15677 be added to the table of contents (verse is the standard environment for
15679 Memoir has some enhanced versions of verse, but you need to use ERT, because
15680 they have to be nested inside regular verse environments, which is not
15681 possible with LyX).
15684 \begin_layout Description
15686 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15689 \begin_layout Chapter
15691 Importing and Exporting Alternate File Formats
15692 \begin_inset OptArg
15695 \begin_layout Standard
15697 Importing and Exporting
15705 \begin_layout Section
15710 \begin_layout Standard
15712 Importing and exporting LyX documents from/to other formats has been touched
15718 Here we describe more of the gory details needed to understand just what
15719 is going on when you click on the
15724 ile\SpecialChar \menuseparator
15736 ile\SpecialChar \menuseparator
15747 \begin_layout Section
15749 Importing Other Formats
15752 \begin_layout Subsection
15757 \begin_layout Standard
15759 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15760 Although it is a standalone program which can be called from the command
15761 line, LyX will call it automatically when a LaTeX document is imported.
15762 See section\InsetSpace ~
15764 \begin_inset LatexCommand \ref{sec:reLyX}
15768 for a complete description.
15769 There are no user tunable parameters for reLyX within LyX.
15772 \begin_layout Subsection
15777 \begin_layout Standard
15779 When importing plain ASCII text, there are two methods of reading the file.
15781 \begin_inset Quotes eld
15785 \begin_inset Quotes erd
15788 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15791 \begin_inset Quotes eld
15795 \begin_inset Quotes erd
15798 assumes that consecutive lines separated by only a single linebreak form
15799 a single paragraph.
15800 Successive linebreaks with no intervening text are thus assumed to be paragraph
15804 \begin_layout Subsection
15809 \begin_layout Standard
15813 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15816 \begin_layout Section
15818 Exporting Other Formats
15821 \begin_layout Subsection
15826 \begin_layout Standard
15828 LyX generates two types of LaTeX files: stripped down versions for the normal
15833 , etc.) which one normally never sees
15837 \begin_layout Standard
15839 The resulting file is a perfectly valid LaTeX file, though the preamble
15840 might look a bit strange since it includes some definitions used by LyX
15841 which wouldn't show up in most human-written files.
15846 , and human readable forms which are suitable for exchanging with your colleague
15848 The only settable option for the translation is the line length of the
15850 The default is 65 characters, but it can be set in
15857 \SpecialChar \menuseparator
15878 \begin_layout Subsection
15880 Device Independent Files
15883 \begin_layout Standard
15885 Device Independent files (DVI files) are produced by running LaTeX on your
15887 There are no user settable options.
15890 \begin_layout Subsection
15895 \begin_layout Standard
15897 The next step in the conversion chain is converting a DVI file into Postscript®.
15905 \SpecialChar \menuseparator
15913 \SpecialChar \menuseparator
15922 or, if you need more control on the result,
15929 \SpecialChar \menuseparator
15938 If you use the later, note that it is possible to configure, in
15945 \SpecialChar \menuseparator
15953 , the options passed to the dvips program to achieve different effects.
15956 \begin_layout Subsection
15961 \begin_layout Standard
15963 Exporting as ASCII attempts to preserve the
15964 \begin_inset Quotes eld
15968 \begin_inset Quotes erd
15971 of the document as well as possible, but things like centering and indentation
15972 are thrown out; paragraphs are separated by blank lines.
15973 Section numbering and cross-references are done correctly, so the resulting
15974 text files is remarkably readable.
15975 The only changeable option is the length of lines, as for LaTeX output.
15978 \begin_layout Subsection
15983 \begin_layout Standard
15985 LyX documents can be converted to hypertext markup, usually by converting
15986 to LaTeX first, then converting that to HTML\SpecialChar \@.
15988 \begin_inset Formula $\rightarrow$
15991 HTML converters are currently known to LyX:
16004 Though they are autodetected, you can overide the selection in preferences.
16005 You can also include further command line options in this dialog.
16009 \begin_layout Subsection
16014 \begin_layout Standard
16023 \begin_layout Standard
16026 \begin_inset VSpace bigskip
16033 \begin_layout Standard
16035 The fastest way to generate a basic PDF file (no tags, links, etc.) with
16036 any version of LyX is to save the document as a Postscript® file, then
16042 Starting with version 1.1.6, the menu item
16046 will do all this for you.
16047 There are some issues with fonts that you need to pay attention to: see
16048 Section\InsetSpace ~
16050 \begin_inset LatexCommand \ref{sec:badfonts}
16055 Also, as of version 1.1.6, there is a better method that will generate much
16056 more sophisticated files.
16059 \begin_layout Subsubsection
16064 \begin_layout Standard
16066 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
16068 \begin_inset LatexCommand \ref{sec:pdfeps}
16072 ), and you cannot use pstricks.
16073 On the other hand, with pdfLaTeX it is possible to insert directly images
16074 in JPEG or PNG format, use TrueType fonts, and more.
16077 \begin_layout Subsubsection
16079 Why does the text look so bad when viewed with Acrobat Reader?
16080 \begin_inset LatexCommand \label{sec:badfonts}
16085 \begin_inset OptArg
16088 \begin_layout Standard
16090 Bad Fonts in Acrobat Reader
16098 \begin_layout Standard
16100 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
16101 When creating a PDF from the LyX file, you need to use outline font instead
16102 of the default bitmap fonts (in fact, you should also use outline fonts
16103 for Postscript files).
16104 Recent LaTeX distributions come with Postscript® Type 1 version of the
16105 standard (Computer Modern) fonts.
16106 pdfLaTeX uses these font by default.
16107 Dvips doesn't use these fonts by default, so to make it use them, add the
16108 following to lines to your
16115 \begin_layout LyX-Code
16120 \begin_layout LyX-Code
16125 \begin_layout Standard
16127 If the default LaTeX font encoding (OT1) is used, nothing else need to be
16129 However, if the T1 font encoding is used, then LaTeX uses the newer EC
16130 fonts, for which there are no Type1 version.
16131 The solution is to use the ae package which emulates T1 coded fonts using
16132 the standard CM fonts.
16133 This is done by adding
16137 usepackage{ae,aecompl}
16139 to the preamble of the LyX file.
16140 However, some glyphs are missing from the CM fonts (e.g.
16141 eth, thorn), and they are taken from the EC fonts.
16142 Therefore you get these glyphs as bitmaps.
16145 \begin_layout Standard
16147 Note: LyX uses by default the T1 font encoding.
16148 If you wish to use the default font encoding (this is not recommended,
16149 unless you only write English documents), clear the field
16157 in preferences (tabs
16169 \begin_layout Standard
16171 An alternate option is to use the standard Postscript® fonts instead of
16172 the Computer Modern fonts.
16173 To do that, you need to select
16177 as the global font in the document layout dialog.
16178 When using the Postscript® fonts, the result PDF file is smaller as the
16179 fonts are not saved into the file.
16180 Furthermore, the Postscript® fonts include all T1 glyphs.
16181 On the other hand, the Postscript® fonts have no bold symbol font, so poor
16182 man's bold must be used (see Section\InsetSpace ~
16184 \begin_inset LatexCommand \ref{sec:pdfbold}
16189 The Postscript® fonts also look different from the Computer Modern fonts.
16192 \begin_layout Standard
16194 To sum up, both the Computer Modern and the Postscript® fonts gives good
16195 results (with few exceptions).
16196 The decision of which one to use is a matter of taste.
16199 \begin_layout Subsubsection
16203 boldsymbol{} command work when I use pslatex?
16204 \begin_inset LatexCommand \label{sec:pdfbold}
16209 \begin_inset OptArg
16212 \begin_layout Standard
16230 \begin_layout Standard
16232 The Postscript® fonts do not have a bold symbol font.
16233 The solution is to use the
16239 (poor man's bold) command.
16242 \begin_layout Standard
16244 It is possible to redefine the
16259 \begin_layout LyX-Code
16270 \begin_layout Standard
16275 \begin_layout Subsubsection
16277 Is it possible to do write latex code which is processed only when running
16279 \begin_inset OptArg
16282 \begin_layout Standard
16284 Conditionals with pdfLaTeX
16292 \begin_layout Standard
16295 Here is an example:
16298 \begin_layout LyX-Code
16307 \begin_layout LyX-Code
16318 \begin_layout LyX-Code
16325 \begin_layout LyX-Code
16332 \begin_layout LyX-Code
16339 \begin_layout LyX-Code
16346 \begin_layout LyX-Code
16350 \begin_layout LyX-Code
16357 \begin_layout LyX-Code
16361 pdfinfo { /Author (your name and e-mail address)
16364 \begin_layout LyX-Code
16366 /Title (official title -- i.e., title element)
16369 \begin_layout LyX-Code
16371 /Subject (one line description of the document)
16374 \begin_layout LyX-Code
16379 \begin_layout LyX-Code
16383 pdfcatalog { /PageMode (/UseNone)
16386 \begin_layout LyX-Code
16388 % /OpenAction (fitbh)
16391 \begin_layout LyX-Code
16396 \begin_layout LyX-Code
16400 usepackage[pdftex]{hyperref}
16403 \begin_layout LyX-Code
16410 \begin_layout LyX-Code
16414 usepackage[ps2pdf]{hyperref}
16417 \begin_layout LyX-Code
16424 \begin_layout Subsubsection
16426 How can I make URLs clickable ?
16429 \begin_layout Standard
16431 See the references here :
16434 \begin_layout Standard
16437 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
16444 \begin_layout Subsection
16449 \begin_layout Standard
16451 Custom exports are possible if you have some particularly weird format you
16452 wish to convert to, assuming you have the relevant converter, of course.
16457 file can be chosen in the
16462 ile\SpecialChar \menuseparator
16467 xport\SpecialChar \menuseparator
16474 dialog; LyX will automatically convert the file to this point, then feed
16475 it to your custom converter.
16476 The possible values are all formats that LyX can produce from its own documents.
16480 \begin_layout Standard
16482 The converter command is also specified in the dialog.It should be a completely
16483 qualified command line which uses the variable
16487 to specify the name of the file.
16488 If this variable is not given, then the file will be sent to the standard
16489 input of your command.
16490 You may have to apply a bit of ingenuity to escape this sequence correctly
16491 so that it is compatible with your shell.
16495 \begin_layout Standard
16497 While it is not possible to save this command using the
16501 dialog, you can manually edit your
16508 \begin_layout LyX-Code
16512 custom_export_command "mycommand $$FName"
16515 \begin_layout Section
16517 The Complete reLyX Description
16518 \begin_inset LatexCommand \label{sec:reLyX}
16525 \begin_layout Subsection
16530 \begin_layout Standard
16532 The simplest way to use reLyX is via the
16537 ile\SpecialChar \menuseparator
16545 That runs reLyX on the given file and loads the resulting file into LyX.
16546 You should try that first, and call it from the command line only if you
16547 need to use more complicated options.
16550 \begin_layout Standard
16603 \begin_layout Standard
16660 \begin_layout Standard
16671 \begin_layout Subsection
16676 \begin_layout Description
16683 By default, when reLyX sees a
16689 command, it creates a file of textclass
16690 \begin_inset Quotes eld
16694 \begin_inset Quotes erd
16697 and reads the LyX layout file for that class.
16702 to declare a different textclass (and read a different layout file).
16705 \begin_layout Description
16712 By default, reLyX gives sparse output and deletes the temporary files which
16713 were created during translation.
16718 flag will create much more output (both to stdout and stderr) and leave
16719 the temporary files around.
16722 \begin_layout Description
16729 reLyX will not run if the
16733 file it would generate already exists Use the
16737 option (carefully) to clobber any existing files.
16740 \begin_layout Description
16747 Print out usage information and quit
16750 \begin_layout Description
16757 With this option, all temporary files and LyX output files (for the given
16758 input file, for any included files, or for any file fragments given with
16763 option) will be put into
16768 Otherwise, for each file
16772 , the temporary files and the LyX output file will be created in
16777 This can be useful if a file includes files from other directories which
16778 you want to consolidate in one directory, or if you don't have write permission
16779 on the directory the LaTeX files are in.
16782 \begin_layout Description
16789 The input files are LaTeX fragments, with no preamble matter or
16796 This option requires the
16800 option, since there are no
16806 commands in the files reLyX is translating.
16807 When using this option, you can translate more than one file, as long as
16808 all files are the same class.
16809 The LyX file created by reLyX can be included in an existing LyX file using
16815 nsert\SpecialChar \menuseparator
16820 \SpecialChar \menuseparator
16831 \begin_layout Description
16837 Regular environments (see the Section\InsetSpace ~
16839 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16844 If you give more than one environment, separate them with commas (not
16846 You'll probably need to quote the environment list, especially if it has
16847 asterisk environments (foo*) in it.
16848 If you use this command often, considering creating a personal syntax file.
16851 \begin_layout Description
16858 Input (one or more quoted, comma-separated) syntax files to read in addition
16860 (see the section Section\InsetSpace ~
16862 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16869 \begin_layout Subsection
16874 \begin_layout Subsubsection
16879 \begin_layout Standard
16881 reLyX will create a LyX file
16885 from the LaTeX file
16896 \begin_layout Standard
16915 does not exist and does not have one of these suffixes, reLyX will try
16921 (This is similar to the behavior of LaTeX.)
16924 \begin_layout Standard
16926 The purpose of reLyX is to translate
16931 If your LaTeX file doesn't compile---or if you do weird things, like redefining
16932 standard LaTeX commands---it may choke.
16933 LaTeX209 will often be translated correctly, but it's not guaranteed.
16936 \begin_layout Standard
16938 reLyX has some bugs and lacks a few features.
16939 However, its main goals are:
16942 \begin_layout Itemize
16944 Get through a well-behaved LaTeX2e file without crashing
16947 \begin_layout Itemize
16949 Translate a lot of that file.
16952 \begin_layout Itemize
16954 Localize the parts that can't be translated and copy them in TeX mode
16957 \begin_layout Standard
16959 It achieves these main goals pretty well on most files.
16962 \begin_layout Standard
16964 There are many improvements that can and will be made to reLyX in the future.
16965 However, we wanted to get reLyX out there early on, to make it easier for
16966 new LyX users to read in their existing LaTeX files.
16969 \begin_layout Subsubsection
16974 \begin_layout Standard
16976 Here's a more lengthy description of what you should do to translate a LaTeX
16980 \begin_layout Itemize
16986 \begin_layout Standard
16988 reLyX will inform you of its progress and give any warnings to stderr, so
16989 if you don't want any output at all, try (in csh)
16990 \begin_inset Quotes eld
16995 reLyX foo.tex >& /dev/null
16998 \begin_inset Quotes erd
17002 \begin_inset Quotes eld
17014 \begin_inset Quotes erd
17018 You should NOT redirect standard output to
17026 \begin_layout Itemize
17028 Run LyX on the resulting .lyx file.
17032 \begin_layout Standard
17034 In theory, most of the file will have been translated, and anything that's
17035 untranslatable will be highlighted in red (TeX mode).
17036 In theory, LyX will be able to read in the file, and to create printed
17037 documents from it, because all that untranslated red stuff will be passed
17038 directly back to LaTeX, which LyX uses as a backend.
17039 Unfortunately, reality doesn't always reflect theory.
17040 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
17042 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17053 \begin_layout Itemize
17055 Change things that are in ERT boxes (TeX code) by hand in LyX.
17059 \begin_layout Standard
17061 As mentioned above, you should be able to print out the LyX file even without
17063 However, changing a command in TeX mode to the corresponding LyX object
17064 will allow you to take advantage of LyX's WYSIWYM editing.
17067 \begin_layout Standard
17069 reLyX is not guaranteed to create a LyX file which generates exactly the
17070 same output as the LaTeX file, but it should come close.
17071 reLyX will generally err on the side of translating less to ensure that
17072 dvi or ps files are accurate, even though this leads to more
17073 \begin_inset Quotes eld
17077 \begin_inset Quotes erd
17083 \begin_layout Itemize
17085 PROOFREAD THE DOCUMENT!!
17089 \begin_layout Standard
17091 I'm sure you were planning on doing this anyway, but it's particularly important
17092 after translating a LaTeX document.
17093 reLyX is, at least now, better at
17094 \begin_inset Quotes eld
17098 \begin_inset Quotes erd
17101 (translating the whole document) than
17102 \begin_inset Quotes eld
17106 \begin_inset Quotes erd
17109 (translating every little detail).
17110 For example, you may see extra spaces or deleted spaces.
17111 Space handling has improved, but it's not perfect.
17114 \begin_layout Subsubsection
17116 What reLyX Can Handle
17119 \begin_layout Standard
17121 reLyX understands many LaTeX commands.
17125 \begin_layout Itemize
17127 regular text, including mini-commands like ~, '',
17139 , as well as accented characters like
17145 , and the special cases ?` and !`
17148 \begin_layout Itemize
17150 title commands like
17174 and the abstract environment
17177 \begin_layout Itemize
17179 heading commands like
17185 including starred commands (
17194 \begin_layout Itemize
17221 \begin_layout Itemize
17235 environments, and their
17242 Also, well-behaved nested lists
17245 \begin_layout Itemize
17247 cross-referencing commands:
17272 \begin_layout Itemize
17287 \begin_layout Itemize
17289 font-changing commands including
17307 , and corresponding commands to change family, size, series, and shape
17310 \begin_layout Itemize
17338 \begin_inset Quotes erd
17348 \begin_inset Quotes erd
17354 \begin_layout Itemize
17360 environment, and commands that go inside it like
17381 \begin_layout Itemize
17397 commands within them
17400 \begin_layout Itemize
17412 command, as well as BibTeX's
17427 \begin_layout Itemize
17429 miscellaneous commands:
17458 \begin_layout Itemize
17460 documentclass-specific environments (and some commands) which can be translated
17464 \begin_layout Itemize
17466 arguments to certain untranslatable commands (e.g.
17476 \begin_layout Standard
17478 Some of this support may not be 100% yet.
17479 See below for details
17482 \begin_layout Standard
17484 reLyX copies math (almost) verbatim from your LaTeX file.
17485 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
17486 by LyX should work just fine.
17487 A few math commands which are not supported by LyX will be replaced with
17488 their equivalents, e.g.,
17508 \begin_layout Standard
17510 reLyX will also copy any preamble commands (i.e., anything before
17516 ) verbatim, so fancy stuff you've got in your preamble should be conserved
17517 in dvi and printed documents, although it will not of course show up in
17519 Check the preamble to make sure.
17522 \begin_layout Subsubsection
17524 What reLyX Can't Handle --- But it's OK
17527 \begin_layout Itemize
17536 \begin_layout Itemize
17541 \begin_layout Itemize
17564 \begin_layout Itemize
17585 \begin_layout Itemize
17598 reLyX is careful to copy
17602 in this case, including comments and whitespace.
17605 \begin_layout Itemize
17607 some unknown (e.g., user-defined) environments and commands
17610 \begin_layout Standard
17612 reLyX copies unknown commands, along with their arguments, verbatim into
17620 where it doesn't recognize the
17621 \begin_inset Quotes eld
17625 \begin_inset Quotes erd
17628 environment, it will copy verbatim until it sees
17634 (unless you use the
17639 Hopefully, then, most of these unknown commands won't cause reLyX to break;
17640 they'll merely require you to do some editing once you've loaded the file
17642 That should be less painful than editing either the
17650 file using a text editor.
17653 \begin_layout Subsubsection
17655 What reLyX Handles Badly --- a.\InsetSpace ~
17659 \begin_inset LatexCommand \label{sub:relyx-bugs}
17666 \begin_layout Standard
17668 Since reLyX is relatively new, it's got a number of problems.
17669 As it matures, these bugs will be squished.
17670 A number of bugs and missing features can be found listed on the LyX bug
17672 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
17679 \begin_layout Standard
17681 If reLyX is choking on something, or LyX can't read it after reLyX translates
17682 it, the best thing to do is to put
17688 before the offending text, and
17696 \begin_inset Quotes eld
17700 \begin_inset Quotes erd
17704 reLyX will copy this block exactly, in TeX mode.
17705 Then edit the resulting LyX file, and translate the unknown stuff by hand.
17710 environment is magical; the
17722 commands will not be put into the LyX file.
17725 \begin_layout Itemize
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17735 copying of unknown environments and commands isn't quite exact.
17736 Specifically, newlines and comments may be lost.
17737 This will yield ugly LyX, but in almost all cases the output will be the
17739 However, certain parts of the file will be copied perfectly, including
17740 whitespace and comments.
17741 This includes: the LaTeX preamble,
17751 commands, and skip blocks.
17754 \begin_layout Itemize
17756 reLyX translates only a few options to the
17763 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17764 landscape, and [one|two]column.) Other options are placed in the extra class
17765 options field in the
17770 ocument\SpecialChar \menuseparator
17781 \begin_layout Standard
17783 More importantly, reLyX doesn't translate
17789 commands, margin commands,
17795 s, or, in fact, anything else from the preamble.
17796 It simply copies them into the LaTeX preamble.
17797 If you have margin commands in your preamble, then the LyX file will generate
17799 However, these margins will override any margins you set in the LyX
17806 \SpecialChar \menuseparator
17812 So you should remove the options from the preamble to be safe.
17813 The same goes for setting your language with babel,
17828 \begin_layout Itemize
17830 The foil class has a couple bugs.
17831 reLyX may do weird things with optional arguments to
17838 Also, it may handle
17844 incorrectly (although the stuff in the environment should translate normally).
17847 \begin_layout Standard
17849 reLyX is hopefully rather robust.
17850 As mentioned above, it may not translate your file perfectly, but it shouldn't
17852 If it does crash---and the problem is not one of those mentioned above
17857 file---see Section\InsetSpace ~
17859 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17866 \begin_layout Subsubsection
17868 What LyX Can't Handle
17871 \begin_layout Standard
17873 LyX itself is missing a couple features, such that even if reLyX translates
17874 things perfectly, LyX may still have trouble reading it.
17875 If you really need these features, you can export your final document as
17876 LaTeX, and put them back in.
17881 for more details on these bugs.
17884 \begin_layout Itemize
17886 For a number of commands, LyX does not support the optional argument.
17899 (and other sectioning commands), and
17908 reLyX will automatically discard the optional arguments with a warning
17910 LyX also ignores the width argument for the
17917 \begin_layout Itemize
17919 Centering (or right or left justifying) works on full paragraphs.
17922 \begin_layout Itemize
17924 LyX support for tables isn't perfect.
17925 For complicated tables, use a
17926 \begin_inset Quotes eld
17930 \begin_inset Quotes erd
17933 block, so that they will be copied in TeX mode.
17936 \begin_layout Itemize
17938 The LyX math editor can't handle the AMS-LaTeX math environments align,
17940 So those environments will be copied in TeX mode.
17945 environments to the exactly equivalent displaymath, and then they will
17946 be translated correctly.
17949 \begin_layout Subsection
17954 \begin_layout Standard
17959 \begin_inset Quotes eld
17963 \begin_inset Quotes erd
17967 \begin_inset Quotes eld
17971 \begin_inset Quotes erd
17974 foo.tex > foo.debug
17977 \begin_layout Standard
17979 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17989 block, it will translate the stuff within the block, but copy the
18001 commands in TeX mode.
18002 Finally, I'm going to keep the temporary files around (they will also
18003 be in my/dir/) and output lots of debugging information into the file foo.debug.
18006 \begin_layout Subsection
18011 \begin_layout Subsubsection
18014 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
18021 \begin_layout Standard
18023 If reLyX is crashing or otherwise acting strangely---in ways other than
18024 those described in Section\InsetSpace ~
18026 \begin_inset LatexCommand \ref{sub:relyx-bugs}
18030 or the bug tracker---then please run reLyX
18035 That will allow you to figure out where in the reLyXing process it crashed.
18036 That, in turn, will allow you to write a better bug report, which will
18037 allow the developers to fix it more quickly and easily.
18040 \begin_layout Standard
18042 Bug reports should be sent to the LyX developers' mailing list.
18043 Its address is currently
18045 lyx-devel@lists.lyx.org
18048 If you are running reLyX on a huge file, please do not send all of the
18049 output in your bug report.
18050 Just include the last ten or twenty lines of output, along with the piece
18051 of the LaTeX file it crashed on.
18052 Or, even better, attach a small but complete file which causes the same
18053 problem as your original file.
18056 \begin_layout Subsubsection
18058 Implementation Details:
18061 \begin_layout Standard
18063 reLyX makes several
18064 \begin_inset Quotes eld
18068 \begin_inset Quotes erd
18071 in order to translate a TeX file.
18072 On each pass, it creates one or two files.
18075 \begin_layout Description
18081 Before doing anything, read the syntax file (or files).
18084 \begin_layout Description
18090 Split preamble (anything before a
18096 command) off the rest of the file.
18097 It saves the two pieces in separate files.
18098 This is necessary because there may be very strange stuff in a preamble.
18099 It also ignores anything after the
18105 , on the assumption that it isn't LaTeX.
18108 \begin_layout Description
18114 Translate the preamble.
18115 Currently, that just means translating the
18121 command and copying the rest exactly into the LyX preamble.
18125 \begin_layout Standard
18127 Once you know what class the document is, read the LyX layout file for that
18131 \begin_layout Description
18138 \begin_inset Quotes eld
18142 \begin_inset Quotes erd
18145 the TeX file, generating slightly stricter LaTeX.
18150 \begin_layout Itemize
18156 to the equivalent but clearer
18161 \begin_layout Itemize
18163 Removing optional arguments that LyX can't handle (e.g., from
18172 \begin_layout Itemize
18187 This is necessary because LyX always writes out the non-local forms anyway.
18188 This should very rarely make a difference.
18191 \begin_layout Description
18197 Translate LaTeX text, commands, and environments to LyX.
18200 \begin_layout Description
18206 Put the two pieces back together, and do some final tweaking, to generate
18210 \begin_layout Standard
18224 commands, reLyX will loop back to the beginning and translate those.
18225 It assumes that the included files are the same class as the main file,
18226 and that they have no preamble matter.
18233 command in the preamble of a file, the command will be copied exactly into
18234 the LaTeX preamble portion of the LyX file, so the included file won't
18235 be translated.) So when translating included files, it skips passes 0 and
18239 \begin_layout Standard
18241 If reLyX doesn't find a file you wanted to include, it will give a warning,
18242 but will continue to translate any files it does find.
18245 \begin_layout Subsubsection
18250 \begin_layout Standard
18252 reLyX reads a LyX layout file to know how to handle LaTeX environments and
18253 commands which get translated to LyX layouts.
18254 This file will include all
18255 \begin_inset Quotes eld
18259 \begin_inset Quotes erd
18262 non-math environments (i.e., including quote and itemize, but not tabular,
18263 minipage, and some other fancy environments), and commands like
18276 If you want to reLyX a class that doesn't have an existing layout file,
18277 then you'll have to create a layout file.
18278 But you have to do this anyway, in order to LyX the file, since LyX depends
18279 on layout files to know how to display and process its files.
18280 Check the LyX documentation for help with this task (which can be hard
18281 or easy, depending on the class you want to create a layout file for.) If
18282 your class is quite similar to a class that has a layout file, then consider
18290 \begin_layout Subsubsection
18293 \begin_inset LatexCommand \label{sub:relyx-syntax}
18300 \begin_layout Standard
18302 reLyX always reads at least one syntax file, called the default syntax file.
18303 reLyX will read your personal syntax file if it exists; otherwise it will
18304 read the system-wide file.
18305 reLyX will read additional syntax files if you specify them with the
18310 (These extra files should have the same format as the default file, but
18311 will tend to be shorter, since they only have to specify extra commands
18312 not found in the default file.) A syntax file tells reLyX a few things.
18315 \begin_layout Standard
18317 First, it describes the syntax of each command, that is, how many required
18318 arguments and how many optional arguments the command takes.
18319 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
18320 it doesn't know how to translate.
18321 The syntax file simply has a command, followed by braces or brackets describing
18322 its arguments in the correct order.
18323 For example, a syntax file entry
18335 command takes an optional argument followed by a required one, while the
18348 command takes no arguments at all.
18349 When reLyX encounters a token that it doesn't know how to translate into
18350 LyX, it will copy the token---along with the correct number of arguments---exac
18352 If the token is not in the syntax file, then reLyX just copies as many
18353 arguments as it finds.
18354 This means that it may copy too much.
18355 But since the user can specify additional syntax files, that shouldn't
18359 \begin_layout Standard
18361 Some commands that cannot be translated to LyX, like
18367 , have as one of their arguments regular LaTeX text.
18369 \begin_inset Quotes eld
18373 \begin_inset Quotes erd
18376 is put into an argument of an (untranslatable) command in the syntax file,
18377 then reLyX will translate that argument instead of copying it verbatim.
18378 So, for example, the default syntax file has
18382 raisebox{}[][]{translate}
18385 This means that the
18391 command and the first argument (and optional arguments if they exist) are
18392 copied in TeX mode, but the last argument (which may contain math, complicated
18393 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
18395 \begin_inset Quotes eld
18399 \begin_inset Quotes erd
18402 on optional arguments.
18405 \begin_layout Standard
18407 User-defined syntax files are allowed to define new commands and their syntax,
18408 or override the number of arguments for a command given in the default
18410 (E.g., if you're using a style that gives an extra argument to some command...)
18411 However, this will only be useful for commands copied in TeX mode.
18412 Commands which are actually translated by reLyX (like
18418 ) have their argument syntax hard-coded.
18419 The hard-coded commands are identified in the default syntax file.
18422 \begin_layout Standard
18424 Second, the syntax file describes any
18425 \begin_inset Quotes eld
18428 regular environments
18429 \begin_inset Quotes erd
18433 Usually, an entire unknown environment will be copied in TeX mode.
18434 If you define a regular environment
18435 \begin_inset Quotes eld
18439 \begin_inset Quotes erd
18442 , though, then only the
18454 commands will be copied in TeX mode; the text within the environment will
18455 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
18456 copied into TeX mode.
18457 Don't try to declare
18465 as regular environments, as the text within those environments will confuse
18466 reLyX; use this capability for new environments you create that have plain
18467 text or math or simple commands in them.
18468 You also can't declare unknown math environments (like
18472 ) as regular environments, either, since the LyX math editor won't understand
18474 The names of regular environments appear, whitespace-separated, between
18487 statements in the syntax file.
18488 (If you have a regular environment which you won't use very often, you
18493 option rather than writing a syntax file.)
18496 \begin_layout Standard
18498 Third, the syntax file describes a math translation table.
18499 The LyX math editor doesn't support a few commands.
18504 is supported, but the equivalent
18511 Put any commands you'd like translate between
18525 \begin_inset Quotes eld
18537 \begin_inset Quotes erd
18546 in math mode will be converted to
18547 \begin_inset Quotes eld
18557 \begin_inset Quotes erd
18564 (in cases where a token made up of a backslash and a non-letter is translated
18565 to something with letters at the end, a space is added by reLyX.
18567 \begin_inset Quotes eld
18577 \begin_inset Quotes erd
18580 is correctly translated to
18581 \begin_inset Quotes eld
18591 \begin_inset Quotes erd
18597 \begin_layout Subsubsection
18602 \begin_layout Standard
18604 You need Perl version 5.002 or later to run reLyX.
18605 <plug> If you don't have Perl, you should get it anyway (at
18606 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
18610 ), because it's a really useful tool for pretty much anything.
18614 \begin_layout Subsection
18619 \begin_layout Standard
18621 reLyX should always explain why it crashes, if it crashes.
18622 Some diagnostics may be very technical, though, if they come from the guts
18624 reLyX gives much more information while running if you use the
18628 option, but you shouldn't need that unless something goes wrong.
18631 \begin_layout Standard
18633 When it's finished, reLyX will tell you if it finished successfully or died
18637 \begin_layout Subsection
18642 \begin_layout Standard
18644 Always keep a copy of your original LaTeX files either under a different
18645 name or in a different directory.
18646 There are a couple ways in which using LyX could lead to overwriting the
18647 original LaTeX file.
18650 \begin_layout Standard
18664 and want to re-export it, note that it will overwrite the original
18673 ask you if you want to overwrite it.)
18676 \begin_layout Standard
18678 If you have chosen not to use a temporary directory in the preferences,
18679 then LyX will create its temporary files in your current directory, which
18680 means your LaTeX original may be overwritten (without a warning from LyX)
18682 \begin_inset Quotes eld
18686 \begin_inset Quotes erd
18689 or print the LyX document.
18692 \begin_layout Subsection
18697 \begin_layout Description
18702 MY_LYXDIR/layouts/*.layout
18708 User's personal layout files for document classes
18711 \begin_layout Description
18716 MY_LYXDIR/reLyX/syntax.default
18722 User's personal syntax file
18725 \begin_layout Description
18730 LIBDIR/layouts/*.layout
18736 System-wide layout files for document classes
18739 \begin_layout Description
18744 LIBDIR/reLyX/syntax.default
18750 System-wide LaTeX syntax file
18753 \begin_layout Standard
18759 is the system-wide LyX directory, usually something like
18761 /usr/local/share/lyx/
18768 is your personal LyX directory, something like
18772 in your home directory.
18773 You can see their actual values in the
18778 elp\SpecialChar \menuseparator
18788 \begin_layout Subsection
18793 \begin_layout Standard
18806 \begin_layout Subsection
18811 \begin_layout Standard
18813 Copyright (c) 1998--9
18819 karger@voth.chem.utah.edu
18824 \begin_layout Standard
18829 \begin_layout Itemize
18835 wrote the original CleanTeX pass.
18838 \begin_layout Itemize
18845 \begin_layout Itemize
18854 \begin_layout Itemize
18858 David Suarez de Lis
18861 \begin_layout Standard
18863 Other contributors:
18866 \begin_layout Itemize
18870 Jean-Marc Lasgouttes
18872 worked on the wrapper script and offered lots of bug reports, advice, and
18873 feature suggestions.
18876 \begin_layout Itemize
18890 \begin_layout Itemize
18892 Various members of the LyX developers' and users' lists provided bug reports
18893 and feature suggestions.
18896 \begin_layout Standard
18898 reLyX uses a modified version the Perl TeX parser
18908 ilya@math.ohio-state.edu
18910 ), available on CPAN.
18913 \begin_layout Chapter
18915 LyX Features needing Extra Software
18918 \begin_layout Section
18920 Using LyX with SGML-Tools (aka LinuxDoc)
18923 \begin_layout Standard
18930 \begin_layout Subsection
18935 \begin_layout Standard
18937 LinuxDoc is a document class available in LyX if you have the
18942 You can use it to produce documents in the so-called Standardized General
18943 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18945 That is obviously helpful if you are contributing to that project.
18946 You can use the SGML format with the
18950 package of scripts and programs (to produce other formats, including Latex,
18951 HTML, plain text, man pages and\SpecialChar \ldots{}
18953 You may therefore prefer to use this document class if you want to write
18954 something that can be easily translated into other formats.
18957 \begin_layout Standard
18959 You will find that LinuxDoc has fewer layout options than the other text
18961 This is mainly so that the translations into other formats have a chance
18962 of making some sense.
18963 In this section we describe:
18966 \begin_layout Itemize
18968 how to setup and use a document in LinuxDoc
18971 \begin_layout Itemize
18973 how to use the tags in LinuxDoc to layout your document
18976 \begin_layout Itemize
18978 how to use the SGML packages to produce the various formats
18981 \begin_layout Itemize
18983 how to sort out some problems.
18986 \begin_layout Subsection
18988 Preparing and using a LinuxDoc document
18991 \begin_layout Subsubsection
18996 \begin_layout Standard
18998 You start by selecting the LinuxDoc class using the
19003 ocument\SpecialChar \menuseparator
19015 Then you will find that there are fewer paragraph environments than for
19016 most other classes.
19017 You can see them on the pull down box on the left of the tool bar.
19018 How to use them is described in section\InsetSpace ~
19020 \begin_inset LatexCommand \ref{sec:sgmlparas}
19027 \begin_layout Standard
19033 enter a title for the document, followed by an author, marking each with
19034 the appropriate paragraph environment.
19035 If you don't do this, you will get errors when you try to print the file.
19036 You can then enter the date and an abstract.
19037 The document proper must start with a Section paragraph environment rather
19038 than any standard layout.
19041 \begin_layout Standard
19043 After that you can prepare a document as usual using the available range
19044 of paragraph environments.
19045 See section\InsetSpace ~
19047 \begin_inset LatexCommand \ref{sec:sgmlparas}
19051 for the full list and their uses.
19054 \begin_layout Subsubsection
19056 Output from LinuxDoc
19059 \begin_layout Standard
19061 You can print and save these documents in the normal way.
19062 To use the other features of the SGML package you need to save your document
19063 as LinuxDoc; this is a version in which the document is translated into
19064 the basic sgml tags.
19071 ile\SpecialChar \menuseparator
19076 xport\SpecialChar \menuseparator
19084 You will get a file with the same name and a
19088 extension rather than a
19095 \begin_inset LatexCommand \ref{sec:sgmloperate}
19099 on how you than make use of this file.
19102 \begin_layout Subsection
19104 Using the paragraph environments in LinuxDoc
19107 \begin_layout Subsubsection
19109 The Structure of a LinuxDoc Document
19112 \begin_layout Standard
19114 There is a formal structure for LinuxDoc which limits how you can place
19116 There are two parts to all documents:
19119 \begin_layout Description
19121 Header: this is everything up to the first time you insert a Section layout
19123 It can include title, author, date, abstract and ToC.
19124 You must include the first two.
19127 \begin_layout Description
19129 Body: from the beginning of the first section onwards.
19130 All other tags are allowed.
19134 \begin_layout Subsubsection
19136 The LinuxDoc Paragraph Environments
19139 \begin_layout Standard
19142 \begin_inset LatexCommand \label{sec:sgmlparas}
19146 Here is a list of all the tags you will find listed on the layout bar in
19147 the order they come there, with some comments where the purpose or use
19151 \begin_layout Itemize
19157 works as described in [cross reference]
19160 \begin_layout Itemize
19166 : This will appear at the top left of the document when printed, above a
19167 heavy horizontal rule, although you will not see this on the LyX screen.
19170 \begin_layout Itemize
19174 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
19176 all do what you would expect and in the usual order.
19177 Whether they are numbered or not is controlled by the
19179 Section\InsetSpace ~
19180 number\InsetSpace ~
19184 You cannot get the equivalent number free versions in any other way; there
19192 \begin_layout Itemize
19198 As usual this produces a numbered and indented list as described in the
19206 \begin_layout Itemize
19212 Again much the same as in the other classes: see the
19219 \begin_layout Itemize
19225 : As explained in the
19230 Remember that if you want the bold element at the start of a description
19231 to be more than one word then you need to put protected spaces between
19236 \begin_layout Itemize
19245 \begin_layout Itemize
19249 Code: similar to the Lyx-Code
19254 \begin_layout Itemize
19260 : Anything you mark with this will appear on the left of the heading of
19261 the document, under the heavy rule.
19264 \begin_layout Itemize
19270 Anything you mark with this will appear on the right of the heading under
19272 You do not have to make this a date.
19273 Any text can be entered, e.\InsetSpace ~
19278 \begin_layout Itemize
19284 : You can use this to produce a free standing paragraph after the author
19285 and date, and before the first section.
19286 You are only allowed one such paragraph.
19290 \begin_layout Standard
19297 This needs checking ---
19307 \begin_layout Itemize
19317 \begin_layout Standard
19323 I have not yet checked this ---
19333 \begin_layout Subsubsection
19335 Other document features
19338 \begin_layout Standard
19340 You can also use the
19344 menu to set fonts or to emphasis words.
19345 You can also use the table of contents as usual; see the corresponding
19351 Although you will find some some other features on the menus e.\InsetSpace ~
19353 inserting footnotes.
19354 There is some doubt about whether these will work correctly.
19358 \begin_layout Standard
19364 Again still checking to see whether this is my system
19374 \begin_layout Subsubsection
19376 Cross references and HTML
19379 \begin_layout Standard
19385 menu you will find two new options relating to the inclusion of URL addresses.
19386 If you use either option you will find some highlighted TeX code inserted
19387 into your document in three separate blocks with spaces available between.
19388 The blocks will be:
19391 \begin_layout Quote
19424 \begin_layout Standard
19426 You insert a full HTML tag between the first and second blocks.
19428 \begin_inset LatexCommand \url{http://any.address}
19432 or other valid tags such as
19433 \begin_inset LatexCommand \url{mailto:me@my.address}
19445 insert some description between the second and third blocks.
19446 The differences are:
19449 \begin_layout Itemize
19455 both the HTML tag and the description will appear in the document
19458 \begin_layout Itemize
19465 only the description appears in the printed version
19468 \begin_layout Subsection
19470 Using the LinuxDoc Sgml scripts
19471 \begin_inset Note Note
19474 \begin_layout Standard
19476 This section is completely outdated.
19484 \begin_layout Standard
19487 \begin_inset LatexCommand \label{sec:sgmloperate}
19491 You can use LinuxDoc as a text class without any additional scripts or programs,
19492 but there is not much point in doing this.
19493 All you will get is a document that looks like a
19495 Linux Documentation Project Howto
19501 To do the document translation you need to get and install the
19503 sgml-tools-1.0.x.tar.gz
19506 \begin_inset Formula $x\geq3$
19511 the SGML-Tools WWW Page
19516 \begin_layout LyX-Code
19521 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
19530 \begin_layout Standard
19532 Alternatively, you can go to the
19540 \begin_layout Standard
19542 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
19543 has not yet been made available at
19555 \begin_layout LyX-Code
19560 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
19567 \begin_layout Standard
19575 sgml-tools-1.0.x.tar.gz
19577 contains everything that you need to write SGML documents and convert them
19578 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
19582 \begin_layout Standard
19584 This package was renamed from
19586 linuxdoc-sgml-1.5.tar.gz
19591 \begin_layout Standard
19593 Follow the instructions in that package on how to install it and how to
19595 All this has to be done outside of LyX, before you can use the
19600 ile\SpecialChar \menuseparator
19605 xport\SpecialChar \menuseparator
19612 \begin_layout Subsection
19614 Troubleshooting LinuxDoc
19617 \begin_layout Standard
19619 When you print or preview a LinuxDoc document some checking is done of the
19620 tags before LaTeX is run.
19621 Some errors are trapped here, especially those concerning the structure
19623 LyX may produce an error message, but not leave an error box in the document
19625 You may have to look at the files directly to discover what is wrong.
19626 Most problems seem to come from the use of options that are not fully available
19630 \begin_layout Section
19635 \begin_layout Standard
19642 \begin_layout Subsection
19647 \begin_layout Standard
19656 menu, you'll find a
19665 This feature requires you to have the
19669 program installed, and is grayed out if you don't have it.
19670 You can get it from your nearest CTAN mirror, or over the Web from
19671 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
19678 \begin_layout Standard
19684 package is a program that was written by
19689 in frustration because some constructs in LaTeX are sometimes non-intuitive,
19690 and easy to forget.
19691 The program runs over your LaTeX file and checks the integrity of the file,
19692 and flags some common errors.
19693 In other technical words, it is
19700 \begin_layout Standard
19702 Well, what is a syntax checker doing in LyX which is supposed to produce
19703 correct LaTeX anyways? The answer is simple: Just as
19707 not only checks the
19711 of C programs, but also does
19715 checks for type-errors,
19719 catches some common
19723 errors, in addition to the syntactical ones.
19728 is capable of detecting several common errors, such as
19731 \begin_layout Itemize
19733 Ellipsis detection:
19735 Use \SpecialChar \ldots{}
19739 \begin_layout Itemize
19741 No space in front of/after parenthesis:
19746 \begin_layout Itemize
19748 Enforcement of normal space after common abbreviations:
19752 is too wide spacing.
19755 \begin_layout Itemize
19757 Enforcement of end-of-sentence space when the last sentence ends with a
19761 And this is wrong spacing.
19764 \begin_layout Itemize
19766 Space in front of labels and similar commands:
19768 The label should stick right up to the text to avoid falling to a wrong
19771 \begin_inset LatexCommand \label{sec:chktex}
19779 \begin_layout Standard
19781 This footnote is in danger of falling off to a wrong page
19786 The label is separated too much.
19789 \begin_layout Itemize
19791 Space in front of references, instead of hard spaces:
19793 In you are in bad luck, the text will break right between the referenced
19794 text and reference number, and that's a pity.
19796 \begin_inset LatexCommand \ref{sec:chktex}
19803 \begin_layout Itemize
19806 \begin_inset Quotes eld
19810 \begin_inset Quotes erd
19814 \begin_inset Formula $\times$
19819 2x2 looks cheap compared to
19820 \begin_inset Formula $2\times2$
19826 \begin_layout Standard
19828 and more \SpecialChar \ldots{}
19829 It is an invaluable tool when you are
19830 \begin_inset Quotes eld
19834 \begin_inset Quotes erd
19837 your document before printing, and you should run it right after the obligatory
19838 spelling check, and before you go fine tuning the typesetting.
19841 \begin_layout Subsection
19846 \begin_layout Standard
19848 If you have the program installed, usage is as simple as choosing
19853 ools\SpecialChar \menuseparator
19862 This will make LyX generate a LaTeX file of your document, start
19866 to check it, and then make LyX insert
19867 \begin_inset Quotes eld
19871 \begin_inset Quotes erd
19874 with the warnings from
19878 , if there were any.
19879 The warnings will be placed close to the point of the mistake, and you
19880 can quickly find them by using the
19885 avigate\SpecialChar \menuseparator
19892 menu item, or the shortcut key
19901 Open the error boxes by clicking on them with the mouse, or use the shortcut
19910 bindings, or the corresponding
19919 Read the warning and correct the mistake, if it is a mistake.
19920 If you have trouble understanding what the warning is about, you can safely
19922 Remember that there is a hidden layer between the document on screen and
19923 the technical details in invoking
19927 , and this gap can make some warnings seem arcane or just right down plain
19931 \begin_layout Standard
19933 This document is an excellent testing bed for the feature, and it should
19934 provide quite a few warnings for you to fiddle with.
19935 Since computers are only so smart, expect most of the warnings to be false
19939 \begin_layout Subsection
19941 How to fine tune it
19944 \begin_layout Standard
19946 Sometimes, you'll find that
19950 makes more noise than suits your mood.
19951 Then you can choose not to use it, wait until your mood changes, or try
19956 to get better along with you.
19957 Another choice in the most desperate situations is to use
19962 iew\SpecialChar \menuseparator
19972 , which will get rid of all warnings instantly.
19975 \begin_layout Standard
19985 very configurable and extensible, you shouldn't expect to solve all problems
19991 Since LyX has to generate a somewhat special LaTeX file to be able to match
19992 the line numbers from the
20000 \begin_layout Standard
20002 You can inspect the specific output from
20008 Edit\SpecialChar \menuseparator
20022 to the internal document structure, some of the warnings will not seen
20023 to appear correctly.
20024 There are two things you can do about this:
20027 \begin_layout Itemize
20033 invocation command line in
20049 installation configuration file (usually with the file
20051 /usr/local/share/chktexrc
20054 See below to learn what warnings can be enabled and disabled on the command
20059 \begin_layout Itemize
20061 Export your document as a raw LaTeX file using
20066 ile\SpecialChar \menuseparator
20071 xport\SpecialChar \menuseparator
20083 Invoked in this way, it can be a hassle to find the corresponding place
20084 in the document inside LyX, but with a little patience, you should be able
20088 \begin_layout Standard
20090 Here follows the warning messages that can be enabled and disabled in
20099 to disable a warning, and
20103 to enable a warning.
20104 The emphasized entries are disabled by default, because the default is
20107 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20112 \begin_layout Standard
20114 Notice that you should only use the options that enable and disable warnings,
20115 because LyX relies on some of the other command line parameters to be set
20116 in a specific way to have a chance to communicate with
20123 \begin_layout Enumerate
20128 Command terminated with space.
20131 \begin_layout Enumerate
20135 Non-breaking space (
20136 \begin_inset Quotes eld
20144 \begin_inset Quotes erd
20147 ) should have been used.
20150 \begin_layout Enumerate
20155 You should enclose the previous parenthesis with
20156 \begin_inset Quotes eld
20164 \begin_inset Quotes erd
20170 \begin_layout Enumerate
20174 Italic correction (
20175 \begin_inset Quotes eld
20185 \begin_inset Quotes erd
20188 ) found in non-italic buffer.
20191 \begin_layout Enumerate
20195 Italic correction (
20196 \begin_inset Quotes eld
20206 \begin_inset Quotes erd
20209 ) found more than once.
20212 \begin_layout Enumerate
20217 No italic correction (
20218 \begin_inset Quotes eld
20228 \begin_inset Quotes erd
20234 \begin_layout Enumerate
20239 \begin_inset Quotes eld
20247 \begin_inset Quotes erd
20251 \begin_inset Quotes eld
20259 \begin_inset Quotes erd
20265 \begin_layout Enumerate
20269 Wrong length of dash may have been used.
20272 \begin_layout Enumerate
20278 \begin_inset Quotes eld
20286 \begin_inset Quotes erd
20290 \begin_inset Quotes eld
20298 \begin_inset Quotes erd
20304 \begin_layout Enumerate
20309 \begin_inset Quotes eld
20317 \begin_inset Quotes erd
20323 \begin_layout Enumerate
20328 \begin_inset Quotes eld
20336 \begin_inset Quotes erd
20339 to achieve an ellipsis.
20342 \begin_layout Enumerate
20346 Inter-word spacing (
20347 \begin_inset Quotes eld
20357 \begin_inset Quotes eld
20360 ) should perhaps be used.
20363 \begin_layout Enumerate
20367 Inter-sentence spacing (
20368 \begin_inset Quotes eld
20378 \begin_inset Quotes erd
20381 ) should perhaps be used.
20384 \begin_layout Enumerate
20388 Could not find argument for command.
20391 \begin_layout Enumerate
20396 \begin_inset Quotes eld
20404 \begin_inset Quotes erd
20410 \begin_layout Enumerate
20414 Math mode still on at end of LaTeX file.
20417 \begin_layout Enumerate
20422 \begin_inset Quotes eld
20430 \begin_inset Quotes erd
20433 doesn't match the number of
20434 \begin_inset Quotes eld
20442 \begin_inset Quotes erd
20448 \begin_layout Enumerate
20452 You should use either
20455 \begin_inset Quotes eld
20463 \begin_inset Quotes erd
20468 as an alternative to
20469 \begin_inset Quotes eld
20477 \begin_inset Quotes erd
20483 \begin_layout Enumerate
20491 " (ASCII 39) instead of "
20498 \begin_layout Enumerate
20502 User-specified pattern found.
20505 \begin_layout Enumerate
20509 This command might not be intended.
20512 \begin_layout Enumerate
20520 \begin_layout Enumerate
20539 \begin_layout Enumerate
20543 Delete this space to maintain correct page references.
20546 \begin_layout Enumerate
20551 You might wish to put this between a pair of
20552 \begin_inset Quotes eld
20560 \begin_inset Quotes erd
20566 \begin_layout Enumerate
20570 You ought to remove spaces in front of punctuation.
20573 \begin_layout Enumerate
20577 Could not execute LaTeX command.
20580 \begin_layout Enumerate
20590 in front of small punctuation.
20593 \begin_layout Enumerate
20602 may look prettier here.
20605 \begin_layout Enumerate
20610 Multiple spaces detected in output.
20613 \begin_layout Enumerate
20617 This text may be ignored.
20620 \begin_layout Enumerate
20627 \begin_inset Quotes eld
20632 to begin quotation, not
20639 \begin_layout Enumerate
20647 to end quotation, not
20650 \begin_inset Quotes eld
20658 \begin_layout Enumerate
20665 \begin_layout Enumerate
20669 You should perhaps use
20670 \begin_inset Quotes eld
20678 \begin_inset Quotes erd
20684 \begin_layout Enumerate
20688 You should put a space in front of/after parenthesis.
20691 \begin_layout Enumerate
20695 You should avoid spaces in front of/after parenthesis.
20698 \begin_layout Enumerate
20703 You should not use punctuation in front of/after quotes.
20706 \begin_layout Enumerate
20710 Double space found.
20713 \begin_layout Enumerate
20717 You should put punctuation outside inner/inside display math mode.
20720 \begin_layout Enumerate
20724 You ought to not use primitive TeX in LaTeX code.
20727 \begin_layout Enumerate
20731 You should remove spaces in front of
20732 \begin_inset Quotes eld
20740 \begin_inset Quotes erd
20746 \begin_layout Enumerate
20751 \begin_inset Quotes eld
20759 \begin_inset Quotes erd
20762 is normally not followed by
20763 \begin_inset Quotes eld
20771 \begin_inset Quotes erd
20777 \begin_layout Standard
20779 In later versions of LyX, we hope to provide a more complete interface to
20780 this tool (and it's smaller cousin
20784 ) to exploit the full power of it.
20785 But it's not exactly useless as it is now: go try it on one of your existing
20786 documents of a certain length and be surprised.
20789 \begin_layout Section
20791 Version Control in LyX
20794 \begin_layout Standard
20798 Lars Gullik Bjønnes
20801 \begin_layout Subsection
20806 \begin_layout Standard
20808 A friend of mine wanted to try LyX for a group project.
20809 When he didn't find support for version control or file locking, he dropped
20811 This angered me a bit, so I thought that I should at least make support
20812 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
20813 This has now been done.
20814 LyX now supports some of the most basic RCS commands.
20815 If you need to something a bit more sophisticated you will have to do that
20816 manually in an xterm.
20819 \begin_layout Standard
20821 Before you begin to use the version control features in LyX, you should
20823 \begin_inset Quotes eld
20827 \begin_inset Quotes erd
20830 (a man file, read it with
20835 This file describes all the basic features of RCS.
20836 You should especially notice the comment about a RCS directory, and the
20837 notion of a master RCS file (the file ending in
20844 \begin_layout Standard
20846 The implementation in LyX assumes a recent version of the GNU RCS package---no
20847 guarantees are made for older versions.
20850 \begin_layout Subsection
20852 RCS commands in LyX
20855 \begin_layout Standard
20857 The following sections describe the RCS commands supported by LyX.
20858 You can find them in the
20863 ile\SpecialChar \menuseparator
20868 ersion\InsetSpace ~
20874 \begin_layout Subsubsection
20881 \begin_layout Standard
20883 If your document is not under revision control, this is the only item shown
20885 And if it is under revision control, the
20892 item is grayed out.
20896 \begin_layout Standard
20898 This command registers your document with RCS\SpecialChar \@.
20899 You are asked interactively
20900 to supply an initial description of the document.
20901 The document is now set in Read-Only mode and you have to
20908 , before making any changes to it.
20909 A document under revision control has a
20910 \begin_inset Quotes eld
20913 [RCS:<version> <locker>]
20914 \begin_inset Quotes erd
20917 item tagged to the filename in the minibuffer.
20920 \begin_layout Standard
20922 RCS command that is run:
20924 ci -q -u -i -t-"<initial description>" <file-name>
20927 \begin_layout Standard
20933 to understand the switches.
20937 \begin_layout Subsubsection
20944 \begin_layout Standard
20946 When you are finished editing a file, you check in your changes.
20947 When you do this, you are asked for a description of the changes.
20948 This is stored in the history log.
20949 The version number is bumped, your changes are applied to the master RCS
20950 file, the document is unlocked and set to Read-Only mode.
20954 \begin_layout Standard
20958 ci -q -u -m"<description>" <file-name>
20961 \begin_layout Subsubsection
20968 \begin_layout Standard
20970 By doing this you lock the document so that only you can edit it.
20971 This will also make the document Read-Write only for you.
20972 You will usually continue editing for a while and when you are finished
20973 you check in your changes.
20974 The status line is changed to reflect that you have locked the file.
20978 \begin_layout Standard
20982 co -q -l <file-name>
20985 \begin_layout Subsubsection
20989 Revert To Last Version
20992 \begin_layout Standard
20994 This will discard all changes made to the document since the last check
20996 You get a warning before changes are discarded.
20999 \begin_layout Standard
21003 co -f -u<version> <file-name>
21006 \begin_layout Subsubsection
21013 \begin_layout Standard
21015 This makes as if the last check in never happened.
21016 No changes are made to the document loaded into LyX, but the last version
21017 is removed from the master RCS file.
21021 \begin_layout Standard
21025 rcs -o<version> <file-name>
21028 \begin_layout Subsubsection
21035 \begin_layout Standard
21037 This show the complete history of the RCS document.
21042 is shown in a browser.
21050 \begin_layout Section
21052 Literate Programming
21055 \begin_layout Standard
21061 (kayvan@sylvan.com)
21065 original documentation written by
21067 Edmar Wienskoski Jr.
21070 (edmar-w-jr@technologist.com)
21073 \begin_layout Subsection
21078 \begin_layout Standard
21080 The main purpose of this documentation is to show you how to use LyX for
21081 literate programming.
21082 Where it is assumed that you are familiar with this programming technique,
21084 \begin_inset Quotes eld
21088 \begin_inset Quotes erd
21092 \begin_inset Quotes eld
21096 \begin_inset Quotes erd
21100 If that is not the case, please follow the web links provided in the following
21102 There is a lot of good documentation out there covering old development
21103 history to the latest tools tips.
21106 \begin_layout Standard
21108 It is also assumed that you are familiar with LyX itself to a point that
21109 you are comfortable changing your LyX preferences, and X resources file.
21110 If that is not the case please refer to other LyX documentation to cover
21111 your specific needs.
21114 \begin_layout Subsection
21116 Literate Programming
21119 \begin_layout Standard
21121 From the Literate Programming FAQ:
21124 \begin_layout Quotation
21126 Literate programming is the combination of documentation and source together
21127 in a fashion suited for reading by human beings.
21128 In fact, literate programs should be enjoyable reading, even inviting!
21129 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21130 and documentation in a single file.
21131 Literate programming tools then parse the file to produce either readable
21132 documentation or compilable source.
21133 The WEB style of literate programming was created by D.E.
21134 Knuth during the development of his TeX typesetting software.
21138 \begin_layout Standard
21140 Another excerpt says:
21143 \begin_layout Quotation
21147 How is literate programming different from verbose commenting?
21150 \begin_layout Quotation
21152 There are three distinguishing characteristics.
21153 In order of importance, they are:
21157 \begin_layout Itemize
21159 flexible order of elaboration
21162 \begin_layout Itemize
21164 automatic support for browsing
21167 \begin_layout Itemize
21169 typeset documentation, especially diagrams and mathematics
21172 \begin_layout Standard
21174 Now that I sparked your curiosity, take a look in the references.
21177 \begin_layout Subsubsection
21182 \begin_layout Standard
21184 The complete Literate Programming FAQ can be found at:
21187 \begin_layout Quote
21190 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
21197 \begin_layout Standard
21199 The FAQ lists 23 (twenty three!) different literate programming tools.
21200 Where some are specialized or
21201 \begin_inset Quotes eld
21205 \begin_inset Quotes erd
21208 for particular programming languages, while other have general scope.
21213 for my own use for several reasons:
21216 \begin_layout Itemize
21218 It can generate the documentation either in latex or html.
21221 \begin_layout Itemize
21223 It has a open architecture, i.e., it is easy to plug in new filters and to
21224 perform special processing that you may need.
21228 \begin_layout Itemize
21230 There is a good selection of filters available already (the html is one
21234 \begin_layout Itemize
21239 \begin_layout Standard
21241 The Noweb web page can be found at:
21244 \begin_layout Quote
21247 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
21254 \begin_layout Standard
21256 Starting from there you can reach many other interesting links and even
21257 some literate program examples.
21260 \begin_layout Subsection
21262 LyX and Literate Programming
21265 \begin_layout Standard
21267 The LyX support for Literate Programming is provided by using the generic
21268 LyX convertors mechanism.
21269 This support is provided in a
21270 \begin_inset Quotes eld
21274 \begin_inset Quotes erd
21277 way, i.e., you will be able to use this new LyX feature with some other literate
21278 programming tool of your choice by just changing your LyX preferences.
21281 \begin_layout Subsubsection
21283 Generating documents and code (weaving and tangling)
21286 \begin_layout Paragraph
21288 Selecting the document class
21291 \begin_layout Standard
21293 If you have installed Noweb and LyX successfully, whenever you open a new
21294 document or try to change the document class of an existing one, you will
21295 find that there are three new document classes available:
21298 \begin_layout Itemize
21303 \begin_layout Itemize
21308 \begin_layout Itemize
21313 \begin_layout Standard
21315 You must select one of them to create your literate documents from.
21319 \begin_layout Standard
21321 Note that literate documents are not limited to these three classes.
21322 New classes can be generated from other styles like letter or in combination
21323 with other class variations like Article (AMS).
21324 If you have special needs that cannot be covered by one of the existing
21325 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21326 will arrange to insert a new entry, or teach you how to do it.
21330 \begin_layout Standard
21332 It is very simple, it involves the creation of a file with four lines, and
21333 re-running of the auto configuration.
21338 Moreover, if you use a literate tool other than Noweb you may need to create
21339 a new set of document classes for it.
21342 \begin_layout Paragraph
21347 \begin_layout Standard
21349 LyX enables you to write code with a layout named
21357 \begin_layout Standard
21359 The equivalent Noweb term is
21360 \begin_inset Quotes eld
21364 \begin_inset Quotes erd
21368 For historical reasons, I got used to the term
21369 \begin_inset Quotes eld
21373 \begin_inset Quotes erd
21376 introduced by other literate tool named Nuweb, which I used for many years
21377 before rendering myself to Noweb.
21382 Noweb delimits scraps like this:
21385 \begin_layout LyX-Code
21390 \begin_layout LyX-Code
21395 \begin_layout LyX-Code
21400 \begin_layout LyX-Code
21405 \begin_layout LyX-Code
21410 \begin_layout Standard
21412 The problem is that whatever is written in between the << and the
21416 must be taken literally, i.e., LyX should be prevented from making any special
21417 interpretation of what has been written.
21418 This is handled by a special layout named Scrap, that works like a normal
21419 paragraph but has a free spacing capability.
21422 \begin_layout Standard
21424 The down side of the Scrap paragraph layout is that consecutive paragraphs
21425 of code will be spaced with one empty line in the source code and also
21426 in the printed documentation.
21427 The work around is to enter each line of code within a single Scrap, with
21428 a newline (ctrl-return).
21429 The example above will look like this:
21433 \begin_layout Standard
21435 If you have a printed version of this document you will not see any difference
21436 between the previous example and this one.
21444 \begin_layout LyX-Code
21457 \begin_layout Standard
21459 This layout works fine.
21460 The only real inconvenience is that you have to type ctrl-return instead
21465 \begin_layout Standard
21467 It is in my list of
21468 \begin_inset Quotes eld
21472 \begin_inset Quotes erd
21483 \begin_layout Standard
21485 As a special note, you can also use the
21486 \begin_inset Quotes eld
21490 \begin_inset Quotes erd
21493 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21497 \begin_layout LyX-Code
21501 def some_function(args):
21503 "This is the doc string for this function."
21505 print "My args: ", args
21508 \begin_layout LyX-Code
21510 @ %def some_function
21513 \begin_layout Standard
21515 For an example of this usage and the resulting cross-reference output, look
21516 at the Literate python program in
21518 LIBDIR/examples/listerrors.lyx
21520 which should make this all clear.
21523 \begin_layout Paragraph
21525 Generating the documentation
21528 \begin_layout Standard
21530 At this point you already have a new document file with a proper document
21531 class, and with some code and text on it.
21532 How do I print it? The answer is simple, you select
21537 iew\SpecialChar \menuseparator
21545 Just like you would do for a plain document.
21546 No special procedure is required.
21549 \begin_layout Standard
21551 To help orientate you, I will now explain what happens inside LyX:
21554 \begin_layout Enumerate
21561 pdate\SpecialChar \menuseparator
21568 menu option is chosen, a latex file is generated.
21573 \begin_layout Standard
21575 If the document is of any literate class the generated file will be named
21576 with an extension name defined by the
21577 \begin_inset Quotes eld
21581 \begin_inset Quotes erd
21584 format (defined in the Preferences panel), otherwise the file will have
21592 \begin_layout Enumerate
21594 Note that the only difference so far is in the name of the file, no special
21595 processing is required by LyX.
21596 Given that you formatted the code using the Scrap layout that, by itself,
21597 takes care of the business.
21600 \begin_layout Enumerate
21602 If the document is of any literate class LyX will then use the internal
21603 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21607 \begin_layout Standard
21609 The converters are defined in the
21614 ools\SpecialChar \menuseparator
21622 \begin_inset Quotes eld
21626 \begin_inset Quotes erd
21634 to generate the LaTeX file.
21638 \begin_layout Standard
21640 Otherwise it will just skip this step.
21643 \begin_layout Enumerate
21645 Finally, LaTeX is invoked and the regular post processing continues as in
21649 \begin_layout Standard
21651 Independence from a particular
21652 \begin_inset Quotes eld
21656 \begin_inset Quotes erd
21659 is easily achieved by changing the commands that are run by the various
21663 \begin_layout Paragraph
21665 Generating the code
21668 \begin_layout Standard
21670 When the build menu option is chosen or the corresponding button in the
21671 toolbar is pressed, a latex file is generated just like step 1 above.
21672 Next, LyX invokes the
21677 Typically, this converter (like any other converter), has two parts:
21680 \begin_layout Enumerate
21682 The converter program itself.
21683 This program performs the conversion from the one format to the other (in
21684 this case, from the Noweb format to the Program pseudo-format).
21687 \begin_layout Enumerate
21689 The error log parser.
21690 This is a program whose sole purpose is to rewrite error messages in a
21691 format that LyX understands.
21692 This makes it possible for LyX to place error boxes in the right places
21693 in the file buffer.
21696 \begin_layout Standard
21698 The first part, the
21699 \begin_inset Quotes eld
21703 \begin_inset Quotes erd
21706 setting, should be set to
21707 \begin_inset Quotes eld
21715 \begin_inset Quotes erd
21719 This basically means that LyX will call
21720 \begin_inset Quotes eld
21724 \begin_inset Quotes erd
21727 (a program or script) with the name of the Noweb file (generally a file
21728 in the LyX temp directory).
21732 \begin_layout Standard
21734 This is an implementation of
21735 \begin_inset Quotes eld
21739 \begin_inset Quotes erd
21742 that you can place in a directory on your path:
21745 \begin_layout LyX-Code
21750 \begin_layout LyX-Code
21755 \begin_layout LyX-Code
21757 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21760 \begin_layout Standard
21762 The next part of the converter setting is the
21763 \begin_inset Quotes eld
21767 \begin_inset Quotes erd
21770 which is to be set to
21771 \begin_inset Quotes eld
21776 originaldir,parselog=listerrors
21779 \begin_inset Quotes erd
21783 This will run any errors that are generated by the
21784 \begin_inset Quotes eld
21788 \begin_inset Quotes erd
21791 process through the
21792 \begin_inset Quotes eld
21796 \begin_inset Quotes erd
21802 \begin_layout Standard
21804 The converter code looks in
21812 then on the path for the
21813 \begin_inset Quotes eld
21817 \begin_inset Quotes erd
21823 \begin_layout Paragraph
21825 Build instructions in the document
21828 \begin_layout Standard
21830 The last piece of the integration between LyX and noweb is the
21831 \begin_inset Quotes eld
21835 \begin_inset Quotes erd
21839 Generally, the instructions for building your program should be embedded
21840 in a scrap of its own.
21842 \begin_inset Quotes eld
21846 \begin_inset Quotes erd
21849 above uses the notangle command to look for this scrap (called
21850 \begin_inset Quotes eld
21854 \begin_inset Quotes erd
21857 ) and runs its contents through
21858 \begin_inset Quotes eld
21862 \begin_inset Quotes erd
21868 \begin_layout Standard
21870 Typically, such a scrap would look something like this:
21873 \begin_layout LyX-Code
21881 if [ -z "${NOWEB_SOURCE}" ]
21885 NOWEB_SOURCE=myfile.nw
21890 code to extract files ...]
21893 code to compile files ...]
21898 \begin_layout Standard
21902 LIBDIR/examples/listerrors.lyx
21906 LIBDIR/examples/Literate.lyx
21908 which implement two versions of the
21909 \begin_inset Quotes eld
21913 \begin_inset Quotes erd
21916 program for some illustrations of how all of these pieces go together or
21919 LIBDIR/examples/noweb2lyx.lyx.
21922 Interestingly, these three files show off the language-indepence of the
21923 LyX literate programming support since they are written in Python, C and
21927 \begin_layout Subsubsection
21932 \begin_layout Standard
21934 All the Literate Programming support is configured by the
21939 ools\SpecialChar \menuseparator
21947 \begin_inset Quotes eld
21951 \begin_inset Quotes erd
21955 The important parts are:
21958 \begin_layout Description
21962 \begin_inset Quotes eld
21966 \begin_inset Quotes erd
21970 format Set up via the Formats tab, this is where the Noweb-specific pieces
21980 , the file extension is set to
21985 This tells LyX to create a file with a
21989 extension in the first step of the conversion process.
21992 \begin_layout Description
22000 format This is an empty format whose sole purpose is to be the endpoint
22001 of a conversion (which then allows us to set up a converter for it).
22004 \begin_layout Description
22014 This converter performs the
22015 \begin_inset Quotes eld
22019 \begin_inset Quotes erd
22022 of the literate document.
22023 For Noweb, it is set to
22024 \begin_inset Quotes eld
22029 noweave -delay -index $$i > $$o
22032 \begin_inset Quotes erd
22038 \begin_layout Description
22049 \begin_inset Quotes eld
22053 \begin_inset Quotes erd
22057 As stated above, the Converter is set to
22058 \begin_inset Quotes eld
22066 \begin_inset Quotes erd
22069 , with Flags set to
22070 \begin_inset Quotes eld
22075 originaldir,parselog=listerrors
22078 \begin_inset Quotes erd
22084 \begin_layout Subsubsection
22089 \begin_layout Standard
22091 There is also a new function implemented in the LyX server, the
22092 \begin_inset Quotes eld
22095 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
22099 \begin_layout Standard
22101 When debugging code with ddd/gdb, it is possible to invoke a text editor
22102 at the current execution position with a single key stroke.
22103 The default ddd configuration for that is shift-ctrl-V.
22104 It happens that you can define the editor command line invocation in ddd
22111 dit\SpecialChar \menuseparator
22116 references\SpecialChar \menuseparator
22123 dialog and changing the "Edit Sources" entry.
22126 \begin_layout Standard
22128 I take advantage of the new created LyX server function and this ddd feature,
22130 \begin_inset Quotes eld
22134 \begin_inset Quotes erd
22140 \begin_layout LyX-Code
22142 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
22145 \begin_layout Standard
22147 With this, whenever you are using ddd and find a point in the program that
22148 you want to edit, you just press shift-ctrl-V (in the ddd window), and
22149 ddd you forward this information to LyX through the LyX server and then
22150 the LyX window will show the same file with the cursor at the same position
22151 ddd was pointing to.
22152 No more guessing or long scrolling to locate a point in the program back
22156 \begin_layout Standard
22158 Note however that you must enable the LyX server to get this feature working
22159 (it is disabled by default).
22160 You can enable it in
22172 ) by entering in the
22177 \begin_inset Quotes eld
22182 /home/<your-home-directory>/.lyx/lyxpipe
22185 \begin_inset Quotes erd
22191 \begin_layout Standard
22193 Read the LyX server documentation in the
22195 Customization Manual
22197 for further information.
22200 \begin_layout Subsubsection
22205 \begin_layout Standard
22207 There are six new buttons that can be added to your LyX toolbar.
22208 Five of these buttons are short cuts to layout styles:
22229 The last one is a short cut to the
22230 \begin_inset Quotes eld
22234 \begin_inset Quotes erd
22241 \begin_layout Standard
22243 LyX has a range of buttons that are available for tool bar customization.
22244 In my toolbar I like to combine the six short cuts above with two more:
22252 \SpecialChar \menuseparator
22260 \SpecialChar \menuseparator
22273 iew\SpecialChar \menuseparator
22281 Here is how it looks like:
22284 \begin_layout LyX-Code
22289 \begin_layout LyX-Code
22294 \begin_layout LyX-Code
22296 Icon "layout Standard"
22299 \begin_layout LyX-Code
22301 Icon "layout Section"
22304 \begin_layout LyX-Code
22306 Icon "layout LaTeX"
22309 \begin_layout LyX-Code
22311 Icon "layout LyX-Code"
22314 \begin_layout LyX-Code
22316 Icon "layout Scrap"
22319 \begin_layout LyX-Code
22324 \begin_layout LyX-Code
22329 \begin_layout LyX-Code
22331 Icon "buffer-typeset"
22334 \begin_layout LyX-Code
22336 Icon "build-program"
22339 \begin_layout LyX-Code
22344 \begin_layout LyX-Code
22349 \begin_layout LyX-Code
22354 \begin_layout LyX-Code
22359 \begin_layout LyX-Code
22364 \begin_layout Subsubsection
22366 Colors customization
22369 \begin_layout Standard
22371 There are a number of colors in LyX that can be customized in
22376 One of the things that bothers people is the LaTeX font color.
22377 The default color is red, since the scraps uses LaTeX font, and there is
22378 a lot of scraps in literate documents, you may get tired of seeing everything
22380 You can change it by going to the tabs
22389 \begin_layout Standard
22391 The next thing is the visible presence of the newline character in the screen.
22392 You can choose the color of this particular character and make it blend
22394 I recommend you choosing a color that is close to the background but not
22395 equal, that way you still can see it is there, but it is not bothering
22400 \begin_layout Chapter
22402 Secrets of the LaTeX Masters
22403 \begin_inset LatexCommand \label{cha:secrets}
22410 \begin_layout Standard
22412 Though LyX is a powerful tool, it cannot hope to support everything that
22413 can be done with pure TeX/LaTeX.
22414 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
22415 as long as you are not afraid to use that
22416 \begin_inset Quotes eld
22420 \begin_inset Quotes erd
22423 button on the toolbar or add things to the LaTeX preamble.
22424 This section lists some tips, tricks, and otherwise cool ideas to give
22425 your document that extra little flair.
22428 Do try this at home
22430 , just start with something a little smaller and less important than your
22434 \begin_layout Standard
22436 Most ideas in this section require less common files in your LaTeX installation.
22437 If you have a system like teTeX, most will already be available.
22438 A few, however, will need to be downloaded from one of the CTAN archives.
22439 Often, there are several ways to do something, or several LaTeX style files
22440 which do the same thing.
22441 We do not endorse one choice over another, we simply claim that we have
22442 done a particular task with a particular file.
22443 Put on your wizard hat, keep an eye out for dragons, and let us begin.
22446 \begin_layout Section
22448 Tricks for Footnotes and Margin Notes
22451 \begin_layout Standard
22458 \begin_layout Subsection
22463 \begin_layout Standard
22465 LyX cannot yet take care of setting the footnote numbering back to 1 after
22466 each section in the
22467 \begin_inset Quotes eld
22475 \begin_inset Quotes erd
22480 document class or changing the counter style.
22481 You'll need to insert LaTeX commands like the following to achieve that:
22484 \begin_layout Standard
22490 \begin_layout Standard
22493 setcounter{footnote}{0}
22502 setcounter{footnote}{0}
22504 will set the counter back to 1
22508 \begin_layout Standard
22510 The counter has been set back to 1.
22518 \begin_layout Standard
22520 The following command will change the numbering to small letters.
22521 Take a look at the next footnote in your xdvi or ghostview
22525 \begin_layout Standard
22541 \begin_layout Standard
22543 This is an example for a footnote with alphabetic numbering.
22563 \begin_layout Standard
22565 The next command sets the counter style back to default, i.e.
22576 \begin_layout Standard
22588 to set the counter--style back to LyX's default, i.e.
22597 \begin_layout Standard
22617 \begin_layout Standard
22649 and others as counter styles.
22650 Just replace the LaTeX command in the above example and rerun TeX to see
22651 what those styles can do.
22655 \begin_layout Subsection
22660 \begin_layout Standard
22662 Here are two examples of neat things you can do to margin notes using LaTeX
22666 \begin_layout Standard
22668 The following command will make a vertical line appear alongside your text---gre
22670 \begin_inset Quotes eld
22674 \begin_inset Quotes erd
22683 rule[-10mm]{30mm}{5mm}}
22691 \begin_layout Standard
22696 rule[-10mm]{30mm}{5mm}}
22704 \begin_layout Standard
22706 Check your dvi- or ghostview-output to see what the
22712 command does to the following margin note.
22715 \begin_layout Standard
22721 \begin_layout Standard
22730 \begin_inset Marginal
22733 \begin_layout Standard
22745 \begin_layout Section
22750 \begin_layout Standard
22754 Lars Gullik Bjønnes
22757 \begin_layout Subsection
22762 \begin_layout Standard
22764 The aim for this chapter
22768 \begin_layout Standard
22770 Editor's note: Lars' original chapter was a masterful description of how
22776 However, it was too long to flow smoothly in this document.
22777 I have therefore chosen to excerpt the most important sections here (sorry,
22778 Lars); you can read the original chapter (and more of the story!) in the
22781 examples/multicol.lyx
22789 is to show how the LaTeX package
22793 can be used in a LyX document.
22794 As LyX doesn't support the
22798 package natively yet, we have to use some small hacks.
22799 By reading this section it should be obvious how to do this.
22802 \begin_layout Subsection
22807 \begin_layout Standard
22813 package allows switching between one and multicolumn format on the same
22815 Footnotes are handled correctly (for the most part), but will be placed
22816 at the bottom of the page and not under each column.
22817 LaTeX's float mechanism, however, is partly disabled in the current implementat
22819 At the moment only page-wide floats can be used within the scope of the
22823 \begin_layout Subsection
22828 \begin_layout Subsubsection
22833 \begin_layout Standard
22835 If you want to have two columns in your text, you have use LaTeX mode to
22840 begin{multicols}{2}
22842 at the point where you want the two column layout to start, and then
22848 where you want it to end.
22852 \begin_layout Standard
22858 \begin_layout Standard
22861 begin{multicols}{2}
22869 \begin_layout Standard
22874 The Adventure of the Empty House
22880 Sir Arthur Conan Doyle
22883 \begin_layout Standard
22887 It was in the spring of the year 1894 that all London was interested, and
22888 the fashionable world dismayed, by the murder of the Honourable Ronald
22889 Adair under most unusual and inexplicable circumstances.
22890 The public has already learned those particulars of the crime which came
22891 out in the police investigation, but a good deal was suppressed upon that
22892 occasion, since the case for the prosecution was so overwhelmingly strong
22893 that it was not necessary to bring forward all the facts.
22894 Only now, at the end of nearly ten years, am I allowed to supply those
22895 missing links which make up the whole of that remarkable chain.
22896 The crime was of interest in itself, but that interest was as nothing to
22897 me compared to the inconceivable sequel, which afforded me the greatest
22898 shock and surprise of any event in my adventurous life.
22899 Even now, after this long interval, I find myself thrilling as I think
22900 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22901 ty which utterly submerged my mind.
22902 Let me say to that public, which has shown some interest in those glimpses
22903 which I have occasionally given them of the thoughts and actions of a very
22904 remarkable man, that they are not to blame me if I have not shared my knowledge
22905 with them, for I should have considered it my first duty to do so, had
22906 I not been barred by a positive prohibition from his own lips, which was
22907 only withdrawn upon the third of last month.
22910 \begin_layout Standard
22916 \begin_layout Standard
22927 \begin_layout Subsubsection
22932 \begin_layout Standard
22934 The same pattern is used when you want more than two columns:
22937 \begin_layout Standard
22943 \begin_layout Standard
22946 begin{multicols}{3}
22954 \begin_layout Standard
22958 It can be imagined that my close intimacy with Sherlock Holmes had interested
22959 me deeply in crime, and that after his disappearance I never failed to
22960 read with care the various problems which came before the public.
22961 And I even attempted, more than once, for my own private satisfaction,
22962 to employ his methods in their solution, though with indifferent success.
22963 There was none, however, which appealed to me like this tragedy of Ronald
22965 As I read the evidence at the inquest, which led up to a verdict of willful
22966 murder against some person or persons unknown, I realized more clearly
22967 than I had ever done the loss which the community had sustained by the
22968 death of Sherlock Holmes.
22969 There were points about this strange business which would, I was sure,
22970 have specially appealed to him, and the efforts of the police would have
22971 been supplemented, or more probably anticipated, by the trained observation
22972 and the alert mind of the first criminal agent in Europe.
22973 All day, as I drove upon my round, I turned over the case in my mind and
22974 found no explanation which appeared to me to be adequate.
22975 At the risk of telling a twice-told tale, I will recapitulate the facts
22976 as they were known to the public at the conclusion of the inquest.
22979 \begin_layout Standard
22985 \begin_layout Standard
22996 \begin_layout Standard
22998 You can have have more than 3 columns if you want to, but that might not
22999 be very pleasant for the eye.
23002 \begin_layout Subsubsection
23004 Columns inside columns
23007 \begin_layout Standard
23009 You can even have columns inside columns:
23012 \begin_layout Standard
23018 \begin_layout Standard
23021 begin{multicols}{2}
23029 \begin_layout Standard
23033 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
23034 at that time governor of one of the Australian colonies.
23035 Adair's mother had returned from Australia to undergo the operation for
23036 cataract, and she, her son Ronald, and her daughter Hilda were living together
23040 \begin_layout Standard
23046 \begin_layout Standard
23049 begin{multicols}{2}
23057 \begin_layout Standard
23061 The youth moved in the best society--had, so far as was known, no enemies
23062 and no particular vices.
23063 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
23064 had been broken off by mutual consent some months before, and there was
23065 no sign that it had left any very profound feeling behind it.
23066 For the rest {sic} the man's life moved in a narrow and conventional circle,
23067 for his habits were quiet and his nature unemotional.
23068 Yet it was upon this easy-going young aristocrat that death came, in most
23069 strange and unexpected form, between the hours of ten and eleven-twenty
23070 on the night of March 30, 1894.
23073 \begin_layout Standard
23079 \begin_layout Standard
23090 \begin_layout Standard
23094 Ronald Adair was fond of cards--playing continually, but never for such
23095 stakes as would hurt him.
23096 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
23097 It was shown that, after dinner on the day of his death, he had played
23098 a rubber of whist at the latter club.
23099 He had also played there in the afternoon.
23104 The evidence of those who had played with him-- Mr.
23105 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
23106 and that there was a fairly equal fall of the cards.
23107 Adair might have lost five pounds, but not more.
23108 His fortune was a considerable one, and such a loss could not in any way
23110 He had played nearly every day at one club or other, but he was a cautious
23111 player, and usually rose a winner.
23112 It came out in evidence that, in partnership with Colonel Moran, he had
23113 actually won as much as four hundred and twenty pounds in a sitting, some
23114 weeks before, from Godfrey Milner and Lord Balmoral.
23115 So much for his recent history as it came out at the inquest.
23118 \begin_layout Standard
23124 \begin_layout Standard
23135 \begin_layout Standard
23137 Please do read the file
23139 examples/multicol.lyx
23141 for more advanced examples including column and header spacing, vertical
23142 separator lines, and more.
23145 \begin_layout Section
23151 Paragraph Environment
23152 \begin_inset OptArg
23155 \begin_layout Standard
23157 Numbering in Enumerate
23165 \begin_layout Standard
23172 \begin_layout Standard
23175 \begin_inset VSpace bigskip
23182 \begin_layout Standard
23184 The default numbering for the
23188 paragraph environment begins with Arabic numbers and ends with uppercase
23190 Suppose, however, you wanted a different type of numbering scheme.
23191 Here's a quickie example of how to change the numbering scheme:
23194 \begin_layout LyX-Code
23205 \begin_layout LyX-Code
23216 \begin_layout LyX-Code
23227 \begin_layout LyX-Code
23238 \begin_layout Standard
23240 \SpecialChar \ldots{}
23241 which changes the numbering scheme to uppercase Roman numerals, uppercase
23242 letters, Arabic numbers, and lowercase letter.
23245 \begin_layout Standard
23247 Additionally, the previous example also adds a little bit extra to the numbering
23249 For example, the first level label actually looks like:
23250 \begin_inset Quotes eld
23254 \begin_inset Quotes erd
23258 For ease of reading, we'll describe what the numbering schemes look like
23259 using a notation something like this: <
23260 \begin_inset Quotes eld
23264 \begin_inset Quotes erd
23269 \begin_inset Quotes erd
23273 \begin_inset Quotes erd
23278 \begin_inset Quotes erd
23282 \begin_inset Quotes erd
23287 \begin_inset Quotes eld
23291 \begin_inset Quotes erd
23298 \begin_layout Standard
23300 As you can see in the example, there is a label command for each nesting
23307 \SpecialChar \ldots{}
23314 , as well as a counter,
23318 \SpecialChar \ldots{}
23324 There are also five
23325 \begin_inset Quotes eld
23329 \begin_inset Quotes erd
23362 , each of which take one counter as an argument.
23363 You can add characters before or after these, but there's no need to add
23367 \begin_layout Standard
23369 You can get really fancy with these.
23373 \begin_layout LyX-Code
23388 \begin_layout LyX-Code
23401 \begin_layout LyX-Code
23412 \begin_layout LyX-Code
23423 \begin_layout Standard
23425 produces the somewhat out of hand numbering scheme: <
23426 \begin_inset Quotes eld
23430 \begin_inset Quotes erd
23435 \begin_inset Quotes erd
23439 \begin_inset Quotes erd
23444 \begin_inset Quotes erd
23448 \begin_inset Quotes erd
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23464 \begin_layout Section
23466 Extra Space Between Table Rows
23469 \begin_layout Standard
23476 \begin_layout Standard
23479 \begin_inset VSpace bigskip
23486 \begin_layout Standard
23488 LaTeX allows you to put a bit of extra space between rows in a table by
23489 giving an optional argument to the end-of-row specifier (
23498 LyX has not yet implemented this in a formal way, so here are two dirty
23499 little tricks to do the same job.
23503 \begin_layout Standard
23505 The first is the more formal, but longwinded way to do it.
23506 In the LaTeX preamble, add the following command definition:
23509 \begin_layout Standard
23517 extratablespace}[1]{
23521 This command takes a single argument---the amount of space you would like
23523 Insert the command in the first column of the row
23527 where you would like the space to appear.
23528 Here is an example (I've removed all the borders using
23533 ayout\SpecialChar \menuseparator
23542 \begin_layout Standard
23545 \begin_inset Tabular
23546 <lyxtabular version="3" rows="4" columns="3">
23548 <column alignment="center" valignment="top" width="0pt">
23549 <column alignment="center" valignment="top" width="0pt">
23550 <column alignment="center" valignment="top" width="0pt">
23552 <cell alignment="center" valignment="top" topline="true" usebox="none">
23555 \begin_layout Standard
23571 <cell alignment="center" valignment="top" topline="true" usebox="none">
23574 \begin_layout Standard
23590 <cell alignment="center" valignment="top" topline="true" usebox="none">
23593 \begin_layout Standard
23611 <cell alignment="center" valignment="top" topline="true" usebox="none">
23614 \begin_layout Standard
23620 <cell alignment="center" valignment="top" topline="true" usebox="none">
23623 \begin_layout Standard
23639 <cell alignment="center" valignment="top" topline="true" usebox="none">
23642 \begin_layout Standard
23660 <cell alignment="center" valignment="top" topline="true" usebox="none">
23663 \begin_layout Standard
23678 \begin_layout Standard
23681 extratablespace{2ex}
23691 <cell alignment="center" valignment="top" topline="true" usebox="none">
23694 \begin_layout Standard
23710 <cell alignment="center" valignment="top" topline="true" usebox="none">
23713 \begin_layout Standard
23731 <cell alignment="center" valignment="top" topline="true" usebox="none">
23734 \begin_layout Standard
23740 <cell alignment="center" valignment="top" topline="true" usebox="none">
23743 \begin_layout Standard
23759 <cell alignment="center" valignment="top" topline="true" usebox="none">
23762 \begin_layout Standard
23786 \begin_layout Standard
23788 The second method is faster, but will make typographers and TeXperts all
23789 over the world groan.
23790 Simply put an end of row specifier with optional argument at the same spot.
23791 No fancy definitions are needed as in the above example, but there will
23792 be more space inserted than you specified because you essentially added
23793 a blank row plus the extra space.
23794 If the space added is too much, simply use a negative number, like so:
23797 \begin_layout Standard
23800 \begin_inset Tabular
23801 <lyxtabular version="3" rows="4" columns="3">
23803 <column alignment="center" valignment="top" width="0pt">
23804 <column alignment="center" valignment="top" width="0pt">
23805 <column alignment="center" valignment="top" width="0pt">
23807 <cell alignment="center" valignment="top" topline="true" usebox="none">
23810 \begin_layout Standard
23826 <cell alignment="center" valignment="top" topline="true" usebox="none">
23829 \begin_layout Standard
23845 <cell alignment="center" valignment="top" topline="true" usebox="none">
23848 \begin_layout Standard
23866 <cell alignment="center" valignment="top" topline="true" usebox="none">
23869 \begin_layout Standard
23875 <cell alignment="center" valignment="top" topline="true" usebox="none">
23878 \begin_layout Standard
23894 <cell alignment="center" valignment="top" topline="true" usebox="none">
23897 \begin_layout Standard
23915 <cell alignment="center" valignment="top" topline="true" usebox="none">
23918 \begin_layout Standard
23933 \begin_layout Standard
23948 <cell alignment="center" valignment="top" topline="true" usebox="none">
23951 \begin_layout Standard
23967 <cell alignment="center" valignment="top" topline="true" usebox="none">
23970 \begin_layout Standard
23988 <cell alignment="center" valignment="top" topline="true" usebox="none">
23991 \begin_layout Standard
23997 <cell alignment="center" valignment="top" topline="true" usebox="none">
24000 \begin_layout Standard
24016 <cell alignment="center" valignment="top" topline="true" usebox="none">
24019 \begin_layout Standard
24043 \begin_layout Standard
24045 It's short, sweet, and gets the job done quickly, even if it is really ugly.
24046 You may put away the rotten vegetables now! I promise I won't suggest anything
24050 \begin_layout Section
24055 \begin_layout Standard
24062 \begin_layout Standard
24065 \begin_inset VSpace bigskip
24072 \begin_layout Standard
24078 \begin_layout Standard
24083 tmpfont}{cmr17 scaled 2500}{
24095 \begin_layout Standard
24101 \begin_layout Standard
24111 hose of you who like the style of old books probably also like
24112 \begin_inset Quotes eld
24116 \begin_inset Quotes erd
24119 ---those large capital letters which begin each new chapter or section.
24120 Implementing them with plain LyX/LaTeX is straightforward (assuming you
24121 know some plain TeX!) but does require a lot of work and many iterations,
24122 as you can see by all the ugly TeX-mode stuff at the beginning of this
24126 \begin_layout Standard
24132 \begin_layout Standard
24137 bigdrop{-1em}{3}{ptmri}{T}+
24142 here is a much easier way of doing this, of course.
24151 ) package from CTAN allows a simple way to add such letters to your documents.
24152 Since this package is not a standard part of teTeX, I can't demonstrate
24153 it within this document, but if you copy this paragraph to a new document,
24155 \begin_inset Quotes eld
24165 \begin_inset Quotes erd
24168 and the pluses from the TeX code at the beginning of the paragraph, and
24173 usepackage{dropcaps}
24175 to your LaTeX preamble, you will get a nice Times Roman Italic
24176 \begin_inset Quotes eld
24180 \begin_inset Quotes erd
24183 , whose height is three lines of text and which protrudes 1 em into the
24185 (Make certain you have copied
24186 \begin_inset Quotes eld
24194 \begin_inset Quotes erd
24197 into a directory where TeX can see it.) The first argument is the amount
24198 of indentation; in this case the negative sign moves it into the margin.
24199 The second argument is the height of the letter in number of lines of text.
24200 The third argument is the font name: virtually anything which has a tfm
24201 file should work (wade through the
24203 .../texmf/fonts/tfm
24205 directory for possibilities).
24206 My personal favorite is
24207 \begin_inset Quotes eld
24215 \begin_inset Quotes erd
24218 , a fancy German font specifically designed for dropped capitals.
24219 The fourth argument is the letter (or letters) to be dropped.
24224 package also offers the
24230 command, as well as a slightly simplified
24239 \begin_layout Section
24241 Non-standard Paragraph Shapes
24244 \begin_layout Standard
24251 \begin_layout Standard
24254 \begin_inset VSpace bigskip
24261 \begin_layout Standard
24267 \begin_layout Standard
24278 \begin_layout Standard
24284 \begin_layout Standard
24292 \begin_layout Standard
24305 \begin_layout Standard
24311 \begin_layout Standard
24321 \begin_layout Standard
24329 \begin_layout Standard
24337 \begin_layout Standard
24345 \begin_layout Standard
24353 \begin_layout Standard
24361 \begin_layout Standard
24369 \begin_layout Standard
24377 \begin_layout Standard
24385 \begin_layout Standard
24393 \begin_layout Standard
24401 \begin_layout Standard
24409 \begin_layout Standard
24417 \begin_layout Standard
24425 \begin_layout Standard
24433 \begin_layout Standard
24441 \begin_layout Standard
24449 \begin_layout Standard
24457 \begin_layout Standard
24465 \begin_layout Standard
24471 There are times when the tyranny of rectangular paragraphs must be overthrown.
24472 In such situations, a call to the delightful plain TeX command
24479 As you can see, completely arbitrary shapes can be laid out with a suitable
24480 set of linelength definitions.
24481 While this parshape may look a bit silly and useless, one could conceive
24482 of situations such as finely tuned dropped capitals, word wrapping around
24483 non-rectangular graphics, etc.
24484 which will benefit from such handcrafting.
24488 \begin_layout Standard
24491 \begin_inset VSpace bigskip
24497 \begin_layout Standard
24503 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
24510 is the number of lines of text which define the paragraph.
24511 If there turn out to be fewer lines, the shape is truncated; if there are
24512 more, the excess lines have the same dimensions as the last line of the
24522 entries specify the indentation of the line from the left margin, and the
24523 length of the line as measured from that point.
24524 The shape applies only to the current paragraph; everything is reset to
24525 normal for the next paragraph.
24528 \begin_layout Standard
24534 \begin_layout Standard
24545 \begin_layout Section
24550 \begin_layout Standard
24552 As you can see, the examples in this section range from the useful to the
24554 While I don't expect that anyone will ever need the paragraph shape demonstrate
24555 d in the last section, the important point is that you can do almost anything
24556 you want in LyX if you are willing to figure out how to do it in TeX and
24558 TeX is a fantastically powerful typesetting system and all that power is
24559 available to you since LyX uses it as its backend.