1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
6 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
12 \paperfontsize default
19 \use_numerical_citations 0
20 \paperorientation portrait
23 \paragraph_separation indent
25 \quotes_language english
29 \paperpagestyle headings
42 Principal maintainer of this file is
47 If you have comments or error corrections, please send them to the LyX
48 Documentation mailing list, <lyx-docs@lists.lyx.org>.
55 \begin_inset LatexCommand \tableofcontents{}
69 manual, which you are now reading, is essentially Part II of the
71 User's Guide\SpecialChar \@.
74 The reason for splitting this document is simple: the
78 is already huge, and it contains all of the basic features one needs to
79 know in order to prepare most documents.
80 However, the LyX Team has a long-term goal of making LyX extensible through
81 various configuration files and external packages.
82 That means that if you want to support the Fizzwizzle LaTeX package, you
83 can create a layout file for it without having to alter LyX itself.
84 We've already had contributions of several new features this way.
85 This is the place where all of that gets documented.
88 This manual also documents some special features, like fax support, version
89 control, and SGML support, which require additional software to work properly.
90 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
91 spruce up your documents by directly using the powerful features of LaTeX.
96 only WYSIWYM, and will only ever interface to certain LaTeX features.
99 Of course, with all of this extra documentation,
101 Extended LyX Features
103 may itself grow too big for its britches.
104 In that case, you can just call it the
105 \begin_inset Quotes eld
109 \begin_inset Quotes erd
115 If you haven't read the
119 yet, you are definitely in the wrong manual.
124 is the first place to go, since it will direct you to the correct manual,
125 and it also describes the notation and format of all of the manuals.
126 You should also be thoroughly familiar with the
130 and all of the basic features of LyX.
134 In this document, many sections are independent articles contributed by
135 an individual and are noted as such.
136 This person is generally whoever wrote the layout file for the new document
137 class or LaTeX package, or implemented the feature.
138 If there is no mention of an author to a chapter [or chapter sections],
139 that means it was written by the LyX Documentation Team.
142 Since all the topics in this manual depend heavily on LyX's interaction
143 with LaTeX, this first chapter covers
147 the inner workings of LyX and how to direct LyX to generate exactly the
149 It is obviously for more seasoned LyX users.
159 \begin_inset LatexCommand \label{sec:lyxandlatex}
163 This chapter is for both TeX-nicians and the LaTeX-curious.
164 In it, we'll explain how LyX and LaTeX work together to produce printable
166 This is the only place in any of the manuals where we assume you know something
170 At one time, we called LyX a
171 \begin_inset Quotes eld
174 WYSIWYM frontend to LaTeX,
175 \begin_inset Quotes erd
178 but that's no longer true.
179 There are frontends to LaTeX out there.
180 They are basically editors with the ability to run LaTeX and mark any errors
181 in the file you're editing.
190 run LaTeX, and it also marks errors in the file, it also does much, much
192 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
193 LyX has also added a few extensions to LaTeX.
194 Try the following sometime: select
196 Export\SpecialChar \menuseparator
206 menu, then look at the preamble of the resulting
211 You'll notice a variety of new macros defined specifically by LyX.
212 These macros are defined automatically, according to the features you use
216 There are several commands that automatically invoke LaTeX.
225 iew\SpecialChar \menuseparator
237 iew\SpecialChar \menuseparator
242 pdate\SpecialChar \menuseparator
255 \SpecialChar \menuseparator
268 \SpecialChar \menuseparator
274 They will only invoke LaTeX if the file has changed since the last time
279 When you run LaTeX on the file you're editing, LyX performs these steps:
282 Convert the document to LaTeX and save to a file with the extension
297 file (maybe several times).
300 If there are any errors, insert error boxes in the document to mark where
302 These boxes are transient and are not saved along with the document.
305 If you've run LaTeX using
327 , LyX performs two more steps:
334 to convert the Dvi file to PostScript®:
343 , the output file has the extension
356 , the output file has the extension
368 or send the PostScript® file to the printer.
372 \begin_inset Quotes eld
375 Help! LyX generated an unreadable
380 \begin_inset Quotes erd
386 Die-hard LaTeX users will scream and howl this into the night, then declare
387 LyX useless, simply because they didn't RTFM.
390 We're going to set the record straight.
391 LyX produces two kinds of LaTeX files.
392 One is human readable.
393 The other is LyX readable.
394 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
400 file is not human readable.
401 Don't even try to read it.
406 file that you can send to a colleague, select
411 xport\SpecialChar \menuseparator
428 Translating LaTeX files into LyX
431 You can import a LaTeX file into LyX by using the
436 ile\SpecialChar \menuseparator
441 mport\SpecialChar \menuseparator
449 This will call a Perl script named
453 ---which will create a file
461 ---and then open that file.
462 If the translation doesn't work, you can try calling
466 from the command line, possibly using fancier options.
473 will translate most legal LaTeX, but not everything.
474 It will leave things it doesn't understand in TeX mode, so after translating
479 , you can look for red text and hand-edit it to look right.
486 has its own section in the
490 manual (as well as a Unix manpage equivalent), which you should read to
491 find out about what LaTeX isn't supported, bugs (and how to get around
492 them), and how to use the various options.
499 to work, or you just want to put a piece of LaTeX code into a LyX file,
501 \begin_inset LatexCommand \ref{sec:latexcodes}
508 Inserting LaTeX Code into LyX Documents
509 \begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
517 \begin_inset LatexCommand \label{sec:latexcodes}
521 This is a rather important point: You can always insert LaTeX code into
523 LyX simply cannot, and will probably never be able to, display every possible
525 If ever you need to insert LaTeX commands into your LyX document, you can
526 use the ERT box, which you can insert into your document with
531 nsert\SpecialChar \menuseparator
539 The ERT box comes in three forms: collapsed, open, and inlined.
540 The first two are used just like any other collapsable (foldable) box (such
541 as footnotes), and are useful for significant amounts of LaTeX commands.
543 \begin_inset Quotes eld
547 \begin_inset Quotes erd
550 ERT box displays its content as part of the button, and is useful for very
551 short sections of LaTeX commands.
563 You can switch between all three by right-clicking on the ERT.
564 Note that if you want more than one line of LaTeX commands, you cannot
565 use the inlined mode.
568 Here's an example of inserting LaTeX commands in a LyX document.
569 The code looks like this:
580 This is an example for a minipage environment.
583 can put nearly everything in it, even (non-floating)
628 The ERT box containing this text is directly after this paragraph.
629 Those of you reading the manual online will only see a bunch of funky text
631 Those reading a printed version of the manuals will see the actual results:
647 This is an example for a minipage environment. You can put nearly everything in it, even (non-floating) figures and tables.
689 In addition to these two methods, you can also create a separate file containing
690 some complex LaTeX structure.
696 nsert\SpecialChar \menuseparator
704 to include your file (you should select the type
709 We recommend that you only do this if you have a
718 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
722 There are a few last notes to emphasize:
725 Inside of LyX, LaTeX code appears
734 check if your LaTeX code is correct.
737 Beware reinventing the wheel.
740 That last note refers to two things.
741 First, LyX does have quite a few features tucked into it, and more are
743 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
744 feature before you go off merrily coding LaTeX.
745 Second, there are numerous LaTeX packages out there to do all sorts of
746 things, from labels to envelopes to fancy multipage tables.
747 Check out a CTAN site for details (see Section
748 \begin_inset Quotes eld
752 \begin_inset Quotes erd
769 : I seem to do this an awful lot.
770 Sat down and merrily began coding something to print out labels, only to
771 learn that there were already 2 different LaTeX packages to do this.
772 Worse yet --- I had them already!
778 If you do need to do some wild and fancy things within your document, be
779 sure to check out a good LaTeX book for assistance.
780 There are a number of them listed in the bibliography of the
787 There are a number of LaTeX commands which have to be placed before the
788 beginning of the actual text.
789 They go into the preamble, and this is explained in the next section.
792 LyX and the LaTeX Preamble
795 About the LaTeX Preamble
799 \begin_inset LatexCommand \label{sec:preamble}
803 If you already know LaTeX, there is no need to explain here what the preamble
805 If you don't, the following will give you some ideas --- we recommend again
806 that you consult a LaTeX book for further information.
807 In any case, you should read the points below, because they explain what
808 you can do and what you don't need to do in the LaTeX preamble of a LyX
812 The LaTeX preamble comes at the very beginning of a document,
820 declare the document class.
821 LyX already does this for you.
825 If you're a seasoned LaTeX-nician, and you have some custom document class
826 you want to use, check out the
830 for information on how to make LyX interface to it.
831 Be sure to submit your efforts to the LyX Team for inclusion in future
836 declare the usage of packages.
837 LaTeX packages provide special commands, which are only available within
838 a document when the package has been declared in the preamble.
847 forces all paragraphs to be indented.
848 There are other packages for labels, envelopes, margins, etc.
852 set counters, variables, lengths and widths.
853 There are several LaTeX counters and variables which
857 be set globally from within the preamble in order to have the desired effect.
858 [There are other variables which you can set and reset inside the document,
859 too.] Margins are a good example of something which must be set in the preamble.
860 Another example is the label format for lists.
861 You can actually set these just about anywhere, but it's best to do it
862 just once, inside the preamble.
865 declare user defined commands [with
877 ], mostly abbreviations for LaTeX commands which appear very often inside
879 Although the preamble is a good place to declare such commands, they
883 be declared anywhere else [but
887 they are used for the first time, of course\SpecialChar \ldots{}
889 This can be useful if there is a lot of raw LaTeX code in your document,
890 which normally should not be the case.
893 LyX adds its own set of definitions to the preamble of the
898 This makes LaTeX files generated by LyX portable.
901 Changing the Preamble
904 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
905 can't change them without patching LyX itself.
906 You can, however, add your own stuff to the preamble.
907 There are two ways to do this:
936 \SpecialChar \menuseparator
944 dialog, depending on your frontend.
945 Note that the LyX keybindings will not work in this dialog, alas.
948 Use the preamble contents you've added as your default template (see
949 \begin_inset Quotes eld
953 \begin_inset Quotes erd
960 ), so that it will be the default preamble for any file you create.
963 LyX adds anything in the
970 dialog to its own built-in preamble.
971 Before adding your own declarations in the preamble, you should make sure
972 that LyX doesn't already support what you want to do (remember what we
973 said about reinventing the wheel?).
976 make sure your preamble code is correct
979 LyX doesn't check it.
985 Here are some examples of what you can add to a preamble, and what they
987 \layout Subsubsection
992 There are two variables under LaTeX that control page position:
1005 Their names should be self-explanatory.
1006 These variables are useful if you think for a moment about computer labels.
1007 Sometimes, the size of a print medium and the area of the medium that you
1008 can actually print on aren't the same.
1024 The default values for
1036 are both 0 pt.,\SpecialChar ~
1039 the page isn't shifted.
1042 Unfortunately, some DVI drivers always seem to shift the page.
1043 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1044 If you're using LyX on a system that you don't personally maintain, and
1045 your sysadmin is a doofus,
1058 Suppose you're left and top margins are always 0.5 inches too big.
1059 You can add this to the preamble:
1076 \SpecialChar \ldots{}
1077 and your margins should now be correct.
1078 \layout Subsubsection
1083 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1084 There's a rather nice package, available at your nearest CTAN archive,
1085 for printing sheets of labels, called
1090 Now, your system may not have this package installed by default.
1091 We leave that up to you to check.
1092 You'll also want to read the documentation for it; we're not going to do
1094 Since this is an example, however, we'll give you an example of how you
1098 First, make sure you're using the
1103 Next, you need to put the following in your preamble:
1141 This sets things up for Avery® label sheets, stock #5360.
1142 You're now ready to print labels, but you'll need to insert LaTeX code,
1143 placing the commands
1155 around each label text.
1156 This and other special features of
1160 are explained in its documentation.
1163 Someday, someone may write a LyX layout file to support this package directly.
1164 Maybe that someone is you.
1165 \layout Subsubsection
1167 Example #3: Paragraph Indentation
1170 Americans are trained to indent the first line of
1175 As with all of their other weird quirks, most Americans will whine and
1176 moan until they can have their way and indent the first line of all paragraphs.
1186 : This was written by an American ---
1190 ! It's my perception of my fellow countrymen.
1191 Tough if you don't like it.
1198 Of course, this behavior isn't standard typography.
1199 In books, you typically only indent the first line of a paragraph
1203 it follows another one.
1204 The idea behind indenting the first line of a paragraph is to distinguish
1205 neighboring paragraphs from one another.
1206 If there is no previous paragraph, for example, it follows a figure, or
1207 is the first paragraph in a section, then there is no special indentation.
1211 If you're a typical American, though, you don't care about such esoteric
1212 things; you want your indentation! Add this to the preamble:
1217 usepackage{indentfirst}
1220 If your TeX distribution isn't a braindead one, you'll have this package,
1221 and all of your paragraphs will get the indentation you think they deserve.
1222 \layout Subsubsection
1224 Example #4: This Document
1227 You can also check out the preamble of this document to get an idea of some
1228 of the advanced things you can do.
1229 You'll probably need to make the
1234 reamble\SpecialChar \ldots{}
1237 dialog full-screen to see most of it.
1238 Also, there are more examples and an assortment of LaTeX
1239 \begin_inset Quotes eld
1243 \begin_inset Quotes erd
1246 given in Chapter\SpecialChar ~
1248 \begin_inset LatexCommand \ref{cha:secrets}
1256 LyX and LaTeX Errors
1259 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1261 It then uses the log-file from the LaTeX run to do a post-mortem.
1262 As we stated earlier in the chapter, LyX generates two kinds of
1266 files, one of which it uses to locate errors in the document.
1267 If there was an error someplace, LyX will put a box with the word
1268 \begin_inset Quotes eld
1272 \begin_inset Quotes erd
1275 at the appropriate place in the document.
1281 LyX will occasionally misguess where the error was.
1282 This will typically happen with tables, figures, math, and the preamble.
1285 It will also display a message alerting you to the fact that there were
1289 You can navigate through the errors by using
1305 \begin_inset Quotes eld
1309 \begin_inset Quotes erd
1312 the error-boxes and view the error message LaTeX produced by clicking on
1316 Some folks also like to look at the log file directly, accessible from
1322 ocument\SpecialChar \menuseparator
1332 There are some fairly common error messages and warnings.
1333 We'll cover those here.
1334 You should look at a good LaTeX book for a complete listing.
1338 \begin_inset Quotes eld
1346 \begin_inset Quotes eld
1353 Anything beginning with these word is a warning message for the purpose
1355 \begin_inset Quotes eld
1359 \begin_inset Quotes erd
1362 the LaTeX code itself.
1363 You'll get messages like this if you added or changed cross-references
1364 or bibliography entries, in which case, LaTeX is trying to tell you that
1365 you need to make another run.
1368 You can by-and-large ignore these.
1373 \begin_inset Quotes eld
1381 \begin_inset Quotes erd
1388 Another warning message, this time about fonts which LaTeX couldn't find.
1389 The rest of the message will often say something about a replacement font
1393 You can safely ignore these.
1398 \begin_inset Quotes eld
1408 \begin_inset Quotes erd
1420 They are warning you about lines that were too long and run past the right
1422 Almost always, this is unnoticeable in the final output.
1423 Or, only one or two characters extend past the margin.
1424 LaTeX seems to generate at least one of these messages for just about any
1428 You can ignore these stupid messages.
1429 Your eyes will tell you if there's a problem with something that's too
1430 wide; just look at the output.
1435 \begin_inset Quotes eld
1445 \begin_inset Quotes erd
1452 Not quite as common as its cousin.
1453 LaTeX seems to like to print lines that are a bit too wide as opposed to
1454 ones that are a bit too narrow.
1455 We have no idea why.
1458 You can ignore these, too.
1463 \begin_inset Quotes eld
1473 \begin_inset Quotes erd
1477 \begin_inset Quotes eld
1487 \begin_inset Quotes erd
1494 Warnings about troubles breaking the page.
1495 Once again, just look at the output.
1496 Your eyes will tell you where something has gone wrong.
1501 \begin_inset Quotes eld
1507 \begin_inset Quotes els
1511 \begin_inset Quotes ers
1517 \begin_inset Quotes erd
1525 \begin_inset Quotes eld
1529 \begin_inset Quotes erd
1532 isn't installed on this system.
1533 This usually appears because some package your document needs isn't installed.
1534 If you didn't touch the preamble or didn't use the
1540 command, then one of the packages LyX tried to load is missing.
1546 elp\SpecialChar \menuseparator
1553 , to get a list of packages that LyX knows about.
1554 This file is updated whenever you reconfigure LyX (using
1561 \SpecialChar \menuseparator
1566 ) and tells you which packages have been detected and what they do.
1579 command, and the package in question isn't installed, you'll need to install
1585 \begin_inset Quotes eld
1590 LaTeX Error: Unknown option
1593 \begin_inset Quotes erd
1600 Error messages beginning with this are trying to tell you that you specified
1601 a bad or undefined option to a package.
1602 Check the package's documentation.
1607 \begin_inset Quotes eld
1612 Undefined control sequence
1615 \begin_inset Quotes erd
1622 If you've inserted LaTeX code into your document, but made a typo, you'll
1624 You may have forgotten to load a package.
1625 In any case, this error message usually means that you used an undefined
1630 There are other error and warning messages.
1631 Some are self-explanatory.
1632 These are usually LaTeX messages.
1633 Others are downright cryptic.
1634 These are actually TeX error messages, and we really have
1638 what they mean or how to decipher them.
1641 There's a general sequence you should follow if you get error messages:
1644 Look at the LaTeX code you inserted for typos.
1647 If there are no typos, check and see that you used the command(s) correctly.
1650 If you get a bunch of error boxes piled up at the very top of the document,
1651 it means that there are errors in the preamble.
1652 Start debugging your preamble.
1655 If you didn't add anything to the preamble and didn't add any LaTeX code
1656 to the document, the first suspect is your LaTeX distribution itself.
1657 Check for missing packages and install them.
1660 Okay, so there are no missing packages.
1661 Did you use any of the fine-tuning options in LyX? Specifically, did you
1666 any of them, like trying to manually insert lots of
1668 Protected\SpecialChar ~
1679 s? Did you try to kludge something together with these instead of using
1680 the appropriate paragraph environment?
1683 All right, you didn't use any of the fine-tuning options, you played by
1685 Did you try to pull a fancy maneuver? Did you do something funky inside
1686 a table or an equation, like inserting a graphic into a table cell?
1689 Do you have long sections of text where LaTeX cannot find a place to break
1690 a line? By default, LaTeX is rather strict about how much extra inter-word
1691 spacing it will add in order to break a line.
1692 Preferrably, you should rework the paragraph to avoid the problem.
1693 If this isn't an option, you can wrap your text in
1699 to make LaTeX's line breaking more, well, sloppy.
1702 Did you go overboard with the nesting? LyX (currently) doesn't check to
1703 make sure you're in the limits for nesting environments.
1704 If you nested a bunch of environments to the
1705 \begin_inset Formula $17^{\mathrm{th}}$
1708 level, that's the problem.
1711 Okay, you didn't get any error messages, but your output looks whacked.
1712 If you have a table or figure that's too wide or long for the page, you
1717 rescale the figure so it fits.
1720 trim down the table so it fits.
1723 If something else is wrong with the output, and you didn't try to pull anything
1724 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1728 If all this doesn't help --- well, then
1732 you might have found a bug in LyX\SpecialChar \ldots{}
1739 Preparing a Bibliography with BibTeX
1741 \added_space_bottom bigskip
1747 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1753 setting up your own bibliographic databases),
1757 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1759 LaTeX: A Document Preparation System
1761 , particularly Appendix B.
1762 The rest of this discussion assumes you have created a correct bibliography
1763 file, that you have all relevant environment variables set correctly (esp.
1776 ), and that if sufficiently desperate, you could create and
1777 \begin_inset Quotes eld
1781 \begin_inset Quotes erd
1784 a LaTeX file with a BibTeX database.
1788 For those who don't know what BibTeX is, it is a system for creating a large
1789 database of your most used journal references.
1790 For all future articles you write, you only need to include this standard
1791 database and reference the appropriate key to each reference.
1792 Even if you write only a few papers with handful of references each, it
1793 is well worth your time to examine BibTeX and decide whether it will be
1797 To use BibTeX with LyX, first read the
1801 where it describes how to insert citations.
1802 The basic mechanism for inserting BibTeX references is the same.
1803 Then, at the very end of your document, select
1805 Insert\SpecialChar \menuseparator
1810 TOC\SpecialChar \menuseparator
1814 In the resulting dialog, fill out the dialog boxes as follows:
1817 Database: enter the name of your
1830 For searching multiple
1834 files, just enter them in the desired order, separated by commas.
1838 Style: enter the name of your BibTeX style file *without* the
1843 The default style is
1847 (which should be included in your LaTeX distribution, so you don't have
1848 to worry about creating it).
1851 For each citation, assuming that the source is in the
1860 nsert\SpecialChar \menuseparator
1867 at the correct location in the text, and enter the appropriate reference
1869 Nothing else is required; when invoking
1874 iew\SpecialChar \menuseparator
1881 , for example, you should see that BibTex and LaTeX are invoked as needed,
1882 including multiple invocations of LaTeX.
1889 A good index is one of the hardest things to make in a lengthy document,
1890 but LyX helps make things a bit simpler by interfacing to the
1894 program which is found in most recent LaTeX distributions.
1895 Inserting an index and marking words to include in it works much the same
1896 way as preparing a bibliography as mentioned in the last section.
1899 First, go to the end of your file and select
1904 nsert\SpecialChar \menuseparator
1915 C\SpecialChar \menuseparator
1928 Then, for each word you would like to include in the index, go to the end
1929 of that word and click on
1934 nsert\SpecialChar \menuseparator
1947 This will insert a tag showing the word as it will appear in the index.
1948 That's all there is to it; LyX will automatically call
1952 for you and create the index itself.
1953 The text in the dialog available from right-clicking on the index button
1954 accepts LaTeX, so you'll need to be careful to avoid using any special
1956 On the positive side, you can use the advanced options - have a look at
1957 the documentation which comes with your LaTeX distribution to find out
1958 how to do things like
1959 \begin_inset Quotes eld
1963 \begin_inset Quotes erd
1969 Be careful not to put spaces between the word in the text and the index
1970 marker; apparently the wrong page number can be produced if this happens.
1979 When you are working on a large file with many sections, it is often convenient
1980 to break up the document into several files, or perhaps you have something
1981 where a table may change from time to time, but the preceding text does
1983 In these cases, you should seriously consider using multipart documents.
1984 For example, scientific papers often have five major sections: the introduction
1985 , observations, results, discussion, and conclusion.
1986 Each of these could be its own separate LyX file, with one
1987 \begin_inset Quotes eld
1991 \begin_inset Quotes erd
1994 file which contains the title, authors, abstract, references, etc., plus
1995 the five included files.
1996 It is important to note that each of these files is a full LyX file which
1997 can be formatted and printed on its own, as well as included in a master
1999 Each of these files must have the same document class, however--- don't
2000 attempt to mix book classes with article classes.
2001 You may also include LaTeX files; however, these files must not have their
2007 everything up to and including the
2019 line must be deleted) or else errors will be generated when you try to
2023 LyX allows you to include files quite easily with
2028 nsert\SpecialChar \menuseparator
2037 When you click on this selection a small box is inserted into the file
2038 at the current cursor location.
2039 Clicking on the box raises a dialog which allows you to select the file
2040 to be included, and the method of its inclusion.
2044 The file selection box should by now be obvious.
2045 The three inclusion methods are
2046 \begin_inset Quotes eld
2050 \begin_inset Quotes erd
2054 \begin_inset Quotes eld
2058 \begin_inset Quotes erd
2062 \begin_inset Quotes eld
2066 \begin_inset Quotes erd
2070 The difference between
2071 \begin_inset Quotes eld
2075 \begin_inset Quotes erd
2079 \begin_inset Quotes eld
2083 \begin_inset Quotes erd
2086 is really only meaningful to LaTeXperts, but the practical difference is
2087 that files which are
2088 \begin_inset Quotes eld
2092 \begin_inset Quotes erd
2095 are typeset beginning on a new page, while files which are
2096 \begin_inset Quotes eld
2100 \begin_inset Quotes erd
2103 are typeset starting on the current page.
2104 Perhaps the labeling in LyX will be changed someday to reflect this.
2107 Generally, the master file is converted into a full LaTeX file before typesettin
2108 g, while the included files are converted to LaTeX files which do not have
2109 all the preamble information.
2119 button prevents this conversion.
2123 \begin_inset Quotes eld
2127 \begin_inset Quotes erd
2130 included file allows you to include a file typeset exactly as it appears
2131 in the file, i.e.\SpecialChar ~
2132 verbatim mode, with the characters set in a fixed-width
2134 Normally, spaces in this file are invisible, though two consecutive spaces
2135 are conserved, unlike LyX's normal treatment of spaces.
2136 However, setting the
2142 spaces\SpecialChar ~
2146 checkbox typesets a mark to unambiguously define the presence of a space.
2152 Cross-References Between Files
2155 It is possible to set up cross-references between the different files.
2156 First, open all the files in question: let's call them A and B in a two
2157 file example, where B is included in A.
2158 Let's say you insert a label in A, then want to reference it in B.
2159 Open the cross-reference dialog in whilst in document B, and you can select
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2178 is needed by LyX to be able to output algorithm floats.
2179 These are useful in placing short algorithms across page breaks and support
2180 an index of algorithms too.
2190 is used by LyX when you select ``subfigure'' in the graphics dialog and
2191 enter the subfigure caption.
2192 Several figures marked in this way can be packed into a single float with
2193 individual sub-captions.
2196 Fancy Headers and Footers
2199 The default page layout is rather plain; for an article document class,
2200 all you get is a centered page number at the bottom of the page.
2201 This document is the book class, so it appears to be a bit fancier, but
2202 to really put on a show, you need to set the document page style to
2203 \begin_inset Quotes eld
2207 \begin_inset Quotes erd
2210 , as mentioned in the
2216 This section describes the LaTeX codes you need to insert in your LaTeX
2217 preamble or the text in order to get the desired effects.
2220 The page header is divided into three fields, not surprisingly labeled
2221 \begin_inset Quotes eld
2225 \begin_inset Quotes erd
2229 \begin_inset Quotes eld
2233 \begin_inset Quotes erd
2237 \begin_inset Quotes eld
2241 \begin_inset Quotes erd
2245 The footer is also divided into these three fields.
2246 The LaTeX commands to set these fields in the simplest manner are
2271 Suppose you wish to put your name in the upper left hand corner of each
2273 Simply insert the following command in the preamble:
2284 You will now see your name in the upper left.
2285 If a field has a default entry that you would like to get rid of (often
2286 the page number appears in the central footer, simply include a command
2287 with a blank argument, e.g.
2297 Let's get really fancy: lets put the section number with the word
2298 \begin_inset Quotes eld
2302 \begin_inset Quotes erd
2306 Section 3) in the upper left, the page number (e.g.
2307 Page 4) in the upper right, your name in the lower left, and the date in
2309 The following commands should now appear in the preamble:
2373 access LaTeX's section and page counters, and so print out the current
2374 section and page numbers.
2381 simply prints out today's date.
2384 The thicknesses of the horizontal rules drawn beneath the header and above
2385 the footer can also be modified.
2386 If you don't want one of the headers, set its thickness to 0.
2387 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2388 Use the commands, e.g.
2395 headrulewidth}{0.4pt}
2403 footrulewidth}{0.4pt}
2405 to set the thicknesses.
2408 You can switch the header/footer settings on and off for individual pages
2413 thispagestyle{empty}
2419 thispagestyle{plain}
2425 thispagestyle{fancy}
2428 Simply insert them in the text on the page you want changed and mark them
2430 In fact, title pages are marked as plain by default, while following pages
2431 are marked fancy when using the global fancy setting.
2434 There are more complex commands which will let you insert things in the
2435 upper left on odd numbered pages, etc., but I will refer you to the
2439 package documentation for more descriptions.
2440 For example, if you have a teTeX installation, look for
2442 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2448 As a final example, it is possible to include an Encapsulated PostScript®
2449 file in the header or footer.
2450 Suppose you want to put a company logo in the upper lefthand corner.
2451 You might try something like
2462 includegraphics{logo.eps}}}
2465 (you may need to preface this with
2469 usepackage{graphics}
2471 if you don't include EPS files elsewhere in your document).
2477 LaTeX provides a mechanism to produce essentially a page within a page,
2479 Within a minipage, all the usual rules of indentation, line wrapping, etc.\SpecialChar ~
2481 LyX also provides some of the minipage capability.
2484 Minipages in LyX have their own collapsable box; insert one via
2489 nsert\SpecialChar \menuseparator
2497 Right-clicking on the box allows you to alter the minipage's width and
2498 alignment within the page.
2499 Warning: if the minipage is too long to fit on a page, it is truncated,
2500 not wrapped onto the next page.
2503 If you place two minipages side-by-side, you can use
2508 nsert\SpecialChar \menuseparator
2513 pecial\SpecialChar ~
2516 to insert a special instruction known in the LaTeX world as an
2520 to put a maximum amount of space between them; it forces one minipage to
2521 the left edge, the other to the right edge.
2522 The examples below show the difference.
2526 \begin_inset Minipage
2535 This is a minipage which does not use hfill.
2536 This is the second sentence of a minipage which does not use hfill.
2543 \begin_inset Minipage
2552 This is a second minipage which does not use hfill.
2553 This is the second sentence of a second minipage which does not use hfill.
2558 \added_space_top medskip \added_space_bottom medskip
2559 Here is some normal text to separate the two examples.
2563 \begin_inset Minipage
2572 This is a minipage which does use hfill.
2573 This is the second sentence of a minipage which does use hfill.
2579 \begin_inset Minipage
2588 This is a second minipage which does use hfill.
2589 This is the second sentence of a second minipage which does use hfill.
2595 Wrapping Text Around Figures
2596 \begin_inset LatexCommand \label{sec:floatflt}
2604 \begin_inset Wrap figure
2612 \begin_inset Graphics
2623 This is a wrapped figure, and this is the brilliant caption that describes
2630 A very frequently asked question is whether text can be made to
2631 \begin_inset Quotes eld
2635 \begin_inset Quotes erd
2638 around figures so that a figure occupies some fraction of the column width
2639 and text fills the rest.
2640 If you have the LaTeX package
2644 installed (you can find out about it in the
2648 manual) you can do this.
2651 At the right is a figure of a mobius strip---you should have already seen
2657 To wrap the text like this insert a wrap box via
2662 nsert\SpecialChar \menuseparator
2667 ts\SpecialChar \menuseparator
2673 Note: this package is very fragile! For example, having a figure too close
2674 to the bottom of the page will mess things up, as will having two figures
2676 Use this package sparingly and do read the documentation that came with
2677 it (which will also tell you how to wrap text around tables).
2683 While the standard table layout will suffice in 99% of all tables you generate,
2684 occasionally you will run into one which requires a bit of extra tweaking.
2685 The table dialog which appears on a right-click of a table allows these
2687 It will give you access to some extra column alignment parameters.
2688 A little bit of LaTeX background is useful here: when you set up a table
2689 in LaTeX, each column is given an alignment type.
2690 For example, you would give it
2691 \begin_inset Quotes eld
2699 \begin_inset Quotes erd
2703 \begin_inset Quotes eld
2711 \begin_inset Quotes erd
2715 \begin_inset Quotes eld
2723 \begin_inset Quotes erd
2726 for left-aligned, centered, and right-aligned columns respectively (which
2727 appear as the left/center/right radio buttons in LyX).
2729 \begin_inset Quotes eld
2737 \begin_inset Quotes erd
2740 , which will make a column of a specified width (the width box in LyX),
2741 and will wrap text within that box.
2743 \begin_inset Quotes eld
2751 \begin_inset Quotes erd
2754 (vertical bar) which rather than making a column will make a vertical rule
2755 at that point; this manifests itself in LyX as the
2756 \begin_inset Quotes eld
2760 \begin_inset Quotes erd
2764 Finally, there is a type
2765 \begin_inset Quotes eld
2773 \begin_inset Quotes erd
2776 , which allows you to use whatever is enclosed in the accompanying braces
2777 as the column separator, including a null argument.
2778 The reasons for doing this may not be obvious, but they can be very powerful.
2779 They are best demonstrated by example.
2782 Removing Extra Column Space
2785 Here is a standard table:
2789 \begin_inset Tabular
2790 <lyxtabular version="3" rows="3" columns="2">
2792 <column alignment="left" valignment="top" width="0pt">
2793 <column alignment="left" valignment="top" leftline="true" width="0pt">
2794 <row bottomline="true">
2795 <cell alignment="left" valignment="top" topline="true" usebox="none">
2812 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2831 <cell alignment="left" valignment="top" topline="true" usebox="none">
2848 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2867 <cell alignment="center" valignment="top" topline="true" usebox="none">
2884 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2909 Notice that the horizontal rule extends a bit past the text on both sides.
2910 If you wanted the line to end even with the text, we can put a null separator
2911 on the ends to get rid of the bit of extra space LaTeX adds by default.
2912 Here is the example:
2916 \begin_inset Tabular
2917 <lyxtabular version="3" rows="3" columns="2">
2919 <column alignment="left" valignment="top" width="0pt" special="@{} l">
2920 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
2921 <row bottomline="true">
2922 <cell alignment="left" valignment="top" topline="true" usebox="none">
2939 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2958 <cell alignment="left" valignment="top" topline="true" usebox="none">
2975 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2994 <cell alignment="center" valignment="top" topline="true" usebox="none">
3011 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3036 In this case, the column specifier for the left column was set to
3037 \begin_inset Quotes eld
3045 \begin_inset Quotes erd
3048 , while the right column was set to
3049 \begin_inset Quotes eld
3057 \begin_inset Quotes erd
3060 , in order to put the null characters on the edges.
3064 Changing the Column Separator Character
3067 Now suppose you really wanted, for reasons that are completely opaque, to
3069 \begin_inset Formula $\sqrt{\pi}$
3072 with some space around it for the column separator.
3073 Simply turn off the vertical border, then set the right column specifier
3075 \begin_inset Quotes eld
3087 \begin_inset Quotes erd
3091 You could now make a table like this:
3095 \begin_inset Tabular
3096 <lyxtabular version="3" rows="3" columns="2">
3098 <column alignment="left" valignment="top" width="0pt">
3099 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3100 <row bottomline="true">
3101 <cell alignment="left" valignment="top" topline="true" usebox="none">
3118 <cell alignment="left" valignment="top" topline="true" usebox="none">
3137 <cell alignment="left" valignment="top" topline="true" usebox="none">
3154 <cell alignment="center" valignment="top" topline="true" usebox="none">
3173 <cell alignment="center" valignment="top" topline="true" usebox="none">
3190 <cell alignment="center" valignment="top" topline="true" usebox="none">
3215 Making a Decimal Point Aligned Column
3218 Okay, that last example was very silly, but here is one that is not.
3219 Suppose you want to make a table that has a column which is aligned on
3221 A standard LaTeX trick to do this is to set the whole number part in a
3222 right-aligned column, use a decimal point for the column separator, then
3223 set the fractional part as a left-aligned column.
3224 A variation on this is to include the decimal point explicitly with the
3225 whole part, then use just a null separator in between.
3226 The latter variation is demonstrated here:
3230 \begin_inset Tabular
3231 <lyxtabular version="3" rows="5" columns="3">
3233 <column alignment="center" valignment="top" width="0pt">
3234 <column alignment="right" valignment="top" leftline="true" width="0pt">
3235 <column alignment="center" valignment="top" width="0pt" special="@{} l">
3236 <row bottomline="true">
3237 <cell alignment="center" valignment="top" topline="true" usebox="none">
3254 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
3271 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
3280 <cell alignment="center" valignment="top" topline="true" usebox="none">
3295 \begin_inset Formula $\pi$
3301 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
3318 <cell alignment="center" valignment="top" topline="true" usebox="none">
3337 <cell alignment="center" valignment="top" topline="true" usebox="none">
3352 \begin_inset Formula $\pi^{\pi}$
3358 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3375 <cell alignment="center" valignment="top" topline="true" usebox="none">
3394 <cell alignment="center" valignment="top" topline="true" usebox="none">
3409 \begin_inset Formula $(\pi^{\pi})^{\pi}$
3415 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3432 <cell alignment="center" valignment="top" topline="true" usebox="none">
3441 <cell alignment="center" valignment="top" topline="true" usebox="none">
3456 \begin_inset Formula $\pi^{\pi^{\pi}}$
3462 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3479 <cell alignment="center" valignment="top" topline="true" usebox="none">
3494 \begin_inset Formula $\times10^{18}$
3508 Though it appears a bit funny in LyX, on paper it will produce what appears
3509 to be a 2-column table in which the right column is aligned on the decimal
3510 point and the header appears to be centered over it.
3513 Perhaps it is best if I described just what I did: first, create a 3
3514 \begin_inset Formula $\times$
3517 3 table and remove all the borders.
3518 Then re-add a bottom border to the top row, and a right border to the first
3520 Type in the values for the first column and set its alignment to
3542 and set that column's alignment to
3558 \begin_inset Formula $\times10^{18}$
3563 and set the extra column alignment to
3568 Finally type in the word
3572 in the middle column, highlight it and the blank entry to its right, and
3585 A Better Decimal-Alignment Solution
3588 An alternative way to have decimal alignment in tables is through the
3593 Add the following to the LateX preamble:
3603 newcolumntype{d}[1]{D{.}{.}{#1}}
3606 To have a column decimally aligned, enter in the
3608 Special Column Alignment
3614 dialog the following:
3617 d{number of decimals of the data}
3620 To create extra column space just increase the number of decimals in
3625 Setting the multicolumn attribute for a single cell makes it insensitive
3626 to the decimal alignment which comes in handy as well.
3627 A drawback of this method is that math mode is not allowed in a column
3628 with decimal alignment except if the multicolumn attribute is set.
3631 This method offers the same flexibility as the
3636 One could, for example, change the alignment separator, and have different
3637 alignment separators for different columns by defining multiple column
3638 types in the preamble.
3639 The syntax is as follows:
3642 D{inputsep}{outputsep}{decimal places}
3645 The interested reader is directed towards the
3649 package documentation for more details.
3652 Itemize Bullet Selection
3653 \begin_inset LatexCommand \label{sec:bullet}
3668 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3669 Using this dialog you can easily specify what bullet shape to use at each
3670 level of an itemized list.
3671 These settings are document-wide so you won't be able to specify different
3672 sets of bullets for different paragraphs
3678 Well, actually you can but you'll have to do it by hand.
3687 Open the dialog by selecting the
3692 ocument\SpecialChar \menuseparator
3699 menu item and then select the
3709 The dialog provides you with a table of bullet shapes.
3710 A column of buttons on the left of the table provides access to the six
3711 different panels of bullet shapes.
3712 The row of buttons across the top is used to select which bullet depth
3714 A text entry under the table shows the currently selected bullet shape's
3715 LaTeX equivalent and this can be edited if desired.
3716 If you do modify the text you will also need to specify any needed packages
3717 in the LaTeX preamble.
3720 The six panels are divided up by the packages they require.
3721 The following table shows the mappings from button name to LaTeX packages.
3725 \begin_inset Tabular
3726 <lyxtabular version="3" rows="7" columns="2">
3728 <column alignment="center" valignment="top" leftline="true" width="0pt">
3729 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3730 <row topline="true" bottomline="true">
3731 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3748 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3766 <row topline="true">
3767 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3784 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3801 <row topline="true">
3802 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3819 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3837 <row topline="true">
3838 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3855 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3873 <row topline="true">
3874 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3891 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3909 <row topline="true">
3910 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3927 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3945 <row topline="true" bottomline="true">
3946 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3963 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3988 LyX doesn't stop you using bullets from packages you don't have.
3989 If you get errors from LaTeX when you try to view or print the file then
3990 its likely you are missing a package.
3991 LyX doesn't restrict your use since you may be editing locally and exporting
3998 Select which bullet depth you want to change then select the bullet shape
4004 Any changes will not be visible in LyX, but are visible when viewing the
4005 document using xdvi or ghostview.
4008 You can reset a bullet shape to the default simply by clicking your right
4009 mouse button on the appropriate bullet depth button.
4016 want to have multiple sets of paragraphs with different sets of bullets
4017 in each then you're going to have to get your hands dirty.
4018 The itemize bullet selection dialog can help though because it provides
4019 you with the LaTeX code for a wide range of bullet shapes.
4020 To make your own custom paragraphs you have the following options:
4063 Use the LaTeX command
4069 to specify a new bullet shape for a given depth.
4070 You'll also need to save the current bullet shape so you can restore it
4072 In this itemized list the following LaTeX code was used to change the bullet
4073 used for the first depth.
4105 Note that the itemize depth is specified in Roman numerals as part of the
4129 Specify each individual entry by starting each item with the bullet shape
4130 enclosed in square brackets and set as TeX.
4131 For example, this item was started with
4161 You'll also need to revert the labelitem back to its previous setting for
4162 the global bullet shape settings to remain in effect.
4163 The way used here was:
4176 Special Document Classes
4186 \added_space_top bigskip \noindent
4187 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4188 papers to be submitted to American Mathematical Society publications.
4189 The layouts are not tailored to a specific journal, but easily can be.
4190 You should refer to the AMS documentation for specific instructions for
4191 each journal (usually it will entail only changing a single line in the
4193 That documentation is available on the Web at
4194 \begin_inset LatexCommand \url{http://www.ams.org}
4199 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
4203 .These layouts are appropriate, and useful, for any mathematical writing.
4204 There are currently 4 distinct AMS LaTeX layouts:
4207 amsart: The standard AMS-article format.
4208 All results and similar statements are numbered as
4209 \begin_inset Formula $(n.m)$
4212 , where the first number refers to the section, and the second refers to
4213 the total number of results (Theorems, Corollaries, Propositions, Definitions
4214 and Remarks, etc.) in that section.
4215 There are also many (but not all) environments available unnumbered, which
4216 is occasionally needed.
4217 Unnumbered environments indicated by an asterisk at the end.
4220 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4221 with no reference to the section number.
4222 There are also many (but not all) environments available unnumbered, which
4223 is occasionally needed.
4224 Unnumbered environments indicated by an asterisk at the end.
4227 amsart-plain: This one is even more terse, since all the environments are
4231 amsbook: the standard AMS book (really, monograph) format.
4232 Numbering is similar to the amsart layout, except that all numbering is
4234 \begin_inset Formula $(n.m.p)$
4237 , where the first number refers to the chapter, the second to the section,
4238 and the third is the number of the results (Theorems, Corollaries, Propositions
4239 , Definitions and Remarks, etc.) in that section.
4240 There are also many (but not all) environments available unnumbered, which
4241 is occasionally needed.
4242 Unnumbered environments indicated by an asterisk at the end.
4245 Any AMS LyX file can be converted to either of the numbering schemes by
4246 simply changing the document class in the
4251 ocument\SpecialChar \menuseparator
4262 What these layouts provide
4265 There is a long list of included environments provided by these layouts.
4266 Most mathematical papers or books will set as special statements most of
4267 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4268 variety of such declarations.
4269 However, the AMS recommends the environments that are available in LyX.
4270 The list of environments (not counting the standard environments such as
4273 sections, bibliography, title, author, date
4278 Theorem This is typically used for the statements of major results.
4280 \begin_inset Quotes eld
4288 \begin_inset Quotes erd
4291 appears in bold type, along with an automatically-determined number (an
4296 , is also available).
4297 The text is italicized.
4300 Corollary This is used for statements which follow fairly directly from
4301 previous statements.
4302 Again, these can be major results.
4310 Lemma These are smaller results needed to prove other statements.
4313 Proposition These are less major results which (hopefully) add to the general
4314 theory being discussed.
4317 Conjecture These are statements provided without justification, which the
4318 author does not know how to prove, but which seem to be true (to the author,
4322 Criterion A required condition.
4325 Algorithm A general procedure to be used.
4328 Axiom This is a property or statement taken as true within the system being
4332 Definition Guess what this is for.
4333 The font, both on-screen and in the output, is different for this environment
4334 than for the previous ones.
4336 \begin_inset Quotes eld
4340 \begin_inset Quotes erd
4343 ) is still set in boldface, along with the number, if any, but the rest
4347 Example Typeset similarly to Definition.
4359 Remark This environment is also a new type of theorem.
4360 This is set with the word Remark in italics, and the rest upright.
4363 Note Set similarly to the Remark environment.
4378 Case Generally, these are used to break up long arguments, using specific
4379 instances of some condition.
4380 The numbering scheme for cases is on its own, not together with other numbered
4392 \begin_inset Quotes eld
4400 \begin_inset Quotes erd
4403 is set in italics, but the rest is set upright.
4404 At the end of this environment (other environments can be nested within
4405 this one, of course) a QED symbol (usually a square, but it can vary with
4406 different styles) is placed.
4409 Address This should be the author's permanent address.
4412 Current\SpecialChar ~
4413 Address This should be the author's temporary address at the time
4414 of submission, if different from the Address.
4417 Email Author's e-mail address
4420 URL Author's Web address, if desired.
4423 Keywords Key words or phrases used to identify specific topics discussed
4427 Subjectclass These refer to the AMS Subject Classifications, published and
4430 Mathematical Reviews
4433 These are also available online at the AMS cites listed above.
4445 In addition, these environments automatically provide the AMS LaTeX and
4447 They need to be available on your system in order to use these environments.
4457 can be used to type letters according to German conventions.
4458 A template file is included in
4460 .../lyx/share/templates
4462 for you to use as a starting point.
4472 provides an alternative to the standard
4477 It provides similar functionality, but you might prefer this layout with
4478 sans serif sections, headings, and more.
4492 This section describes how LyX can be used to write articles for submission
4493 to the scientific journal
4495 Astronomy and Astrophysics
4498 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
4510 Version 5.01 of the document class
4515 This package can be downloaded from the ftp site
4517 \added_space_top medskip \added_space_bottom medskip \align center
4519 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
4526 A manual comes together with that package, and this text is not meant to
4527 replace the original manual but merely a short guide how to realize the
4528 correct form of your paper.
4532 Please note that the publisher of the journal was changed from Springer
4533 to EDP Sciences starting January 1, 2001.
4534 That change implicated also some slight changes of the style files, namely
4535 the removal of the thesaurus command.
4536 The LyX class aa supports the newest version of these style files, V 5.01.
4537 If you have an older version installed, please upgrade.
4538 For compatibility, the old (version 4) layout has been kept as
4543 Please refer to the comments in
4545 LyXDir/layouts/aapaper.layout
4553 It is recommended you start from the example template distributed with LyX.
4554 If you are not using a template, note the following settings:
4566 ocument\SpecialChar \menuseparator
4573 dialog (OK, that one was obvious).
4576 Don't change the option
4586 The whole layout is done by the macros, you shouldn't change anything.
4592 First thing to enter is the header information.
4593 It consists of seven entries, of which some are optional.
4629 : [optional] if more than one author: whom to contact for offprint requests.
4636 : [optional] mail address for contacts.
4646 Received: <date>; Accepted <date>
4649 There is no need to issue the
4655 command, this is done automatically by LyX when the header is finished.
4656 Although the order of the single header entries doesn't matter it is advised
4657 to keep the above sequence, just to get the best optics and meets the layout
4658 of the real document.
4661 If you want to place footnotes in the header block, e.g.
4671 to state your present address, just use the standard footnote via
4676 nsert\SpecialChar \menuseparator
4684 LyX will automagically use the term
4693 In addition to these topics, the macros use three additional LaTeX commands
4694 that have no counterpart in LyX:
4703 to separate different names for more than one author and institute, respectivel
4713 to mark corresponding author/institute pairs.
4714 The institutes are numbered sequentially as they appear in the
4718 field, so you have to put a marker to each author.
4727 to supply an email address for fast contact.
4730 In all cases, the appropriate command has to be entered in LyX an marked
4739 The abstract should immediately follow the header block.
4740 With version 5 the abstract environment was changed to a command, and there
4741 is now a resctriction to only one paragraph.
4742 In addition, it should contain an entry with the keywords.
4743 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4750 by hand and mark it as LaTeX code.
4751 Refer to the example paper.
4754 Supported environments
4757 The A&A paper layout supports the following environments for structuring
4821 Commands not supported by LyX
4824 Some commands are not yet supported by the
4829 Some have already been mentioned.
4830 For the sake of completeness, they are listed all together here:
4889 If you want to use any of these commands, you have to enter them yourself.
4892 Do not forget to mark them as LaTeX code!
4895 Figure and Table Floats
4898 LyX provides support for the necessary float environments
4900 figure, figure*, table
4906 , therefore we won't tell much about it here.
4909 User's\SpecialChar ~
4913 Just remember that tables should be left-aligned.
4914 For that, select the table and change the alignment in
4919 dit\SpecialChar \menuseparator
4924 aragraph\SpecialChar ~
4932 only one special thing: the figures with caption besides the figure.
4933 To create such a figure, you have to do the following:
4936 Create a wide figure float:
4941 nsert\SpecialChar \menuseparator
4946 t\SpecialChar \menuseparator
4949 , then right click in the figure and select
4961 Enter your caption text.
4968 to move the cursor above the caption.
4974 Position the cursor behind the figure and insert a horizontal fill:
4979 nsert\SpecialChar \menuseparator
4984 pecial\SpecialChar ~
4987 \SpecialChar \menuseparator
4990 orizontal\SpecialChar ~
4996 Switch to LaTeX mode:
5013 Do not close the brace!
5016 Position the cursor behind the caption text, switch to LaTeX mode and insert
5027 Also, refer to the figures in the example paper.
5033 For submission, the paper has to be formated in a special double-spacing
5035 For this purpose, you have to give the option
5039 to the documentclass.
5040 This must be done using the extra class options field in the
5045 ocument\SpecialChar \menuseparator
5053 Just enter the string
5067 directory contains an example paper written with LyX.
5068 It is the example paper from the original macro package, translated to
5070 Use it for inspiration, and compare the original LaTeX code with LyX way
5085 AASTeX is a set of macros produced by the American Astronomical Society
5086 to facilitate electronic manuscript submission to the three journals they
5087 publish: the Astrophysical Journal (including the Letters and Supplement),
5088 the Astronomical Journal, and the Publications of the Astronomical Society
5090 LyX requires version 5.0 (or higher) of these macros.
5091 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5092 incompatible with LyX.
5093 The AASTeX package may be downloaded from the AAS's ftp site
5095 \added_space_top medskip \added_space_bottom medskip \align center
5097 \begin_inset LatexCommand \url{ftp://ftp.aas.org/pubs}
5104 A complete user guide is contained in that package and you should familiarize
5105 yourself with it thoroughly before embarking on writing a paper in LyX.
5106 LyX will not reduce the need to figure out all the AASTeX commands, it
5107 will only reduce the drudgery of typing everything in.
5108 It is your responsibility to ensure that the final exported LaTeX document
5109 conforms completely to the requirements of the journal to which you are
5110 submitting your paper.
5113 Starting a New Paper
5116 I strongly suggest that you start with the AASTeX template file.
5122 ile\SpecialChar \menuseparator
5129 , enter the new file name, then choose the
5134 This will show the most common fields found in a manuscript.
5135 Simply overwrite the existing text (including the brackets,
5139 ) with the correct information.
5140 Many of the AASTeX commands and environments can be implemented directly
5141 in LyX, but some cannot: most noticeably
5153 , which should stick out like a sore thumb if you actually just opened the
5155 For commands such as these, the LaTeX code must be entered directly and
5157 Such commands are referred to as ERT, or Evil Red Text.
5158 I tried to minimize the amount of ERT needed in an AASTeX document, but
5159 there is still more required than any of us would like.
5162 Finishing Your Paper
5165 When the paper is finished to your satisfaction and previews/prints correctly,
5167 \begin_inset Quotes eld
5171 \begin_inset Quotes erd
5174 actions which need to be done before you submit it to the journals.
5178 Export your paper as a LaTeX file (
5183 ile\SpecialChar \menuseparator
5188 xport\SpecialChar \menuseparator
5203 file with your favorite text editor
5207 remove the comment lines before the
5220 usepackage...{fontenc}
5222 line if it appears (usually just after
5237 remove everything between (and including) the
5249 commands, except for any commands you specifically put into the LaTeX preamble
5250 (which should appear immediately after the
5251 \begin_inset Quotes eld
5254 User specified LaTeX commands
5255 \begin_inset Quotes erd
5271 commands and replace
5272 \begin_inset Quotes eld
5280 \begin_inset Quotes erd
5283 with the correct, real file name.
5292 commands, if necessary (see section\SpecialChar ~
5294 \begin_inset LatexCommand \ref{cite}
5302 Run the resulting file through LaTeX to make sure it still processes correctly.
5305 Reread the journal requirements to make sure your filenames and formats
5312 Comments On Specific Commands
5315 I will not describe the detailed usage of the individual AASTeX commands:
5316 the AASTeX User Guide (
5320 ) gives a good description of each.
5321 Thus it's probably easiest for me to go down the list as found in the guide
5322 and offer comments where necessary.
5323 So let's begin \SpecialChar \ldots{}
5325 \layout Subsubsection
5327 Things that work as expected
5343 Because they work as you might expect, I simply list them and the section
5438 begin{thebibliography}
5470 (2.14.4, amongst other places),
5497 The following style options also work correctly:
5520 Layout\SpecialChar \menuseparator
5537 \layout Subsubsection
5539 Things that work, but require more comment
5542 The following items work, but require a little more discussion:
5545 These items are reserved for use by the journal editors, but you can put
5546 them into the LaTeX preamble if you feel compelled to do so:
5579 These items may be placed in the LaTeX preamble, and are included as blanks
5580 in the template file:
5607 (2.3) -- can only be used
5608 \begin_inset Quotes eld
5612 \begin_inset Quotes erd
5615 , not in the middle of a paragraph.
5616 Use ERT if you need to embed it.
5625 (2.3) -- will have extra {} after it.
5626 This should not cause an error.
5635 (2.6) -- can only be used
5636 \begin_inset Quotes eld
5640 \begin_inset Quotes erd
5643 , not in the middle of a paragraph.
5644 Use ERT if you need to embed it.
5653 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5663 (2.8) -- same as for
5676 (2.9) -- will have extra {} after it.
5677 This should not cause an error.
5686 (2.10) -- will have extra {} after it.
5687 This should not cause an error.
5696 (2.13.2) -- you will have to edit the optional argument by hand in the final
5698 \layout Subsubsection
5700 Things not implemented, use ERT
5738 setcounter{equation}
5752 (2.12), Journal name abbreviations (2.12.4),
5788 (2.14.4, insert it as the first element in the lefthand cell after where
5790 Don't use any of LyX's rules in the table),
5802 (2.14.5), most everything in Misc (2.15, except
5852 \layout Subsubsection
5854 Things that cannot be implemented
5857 \SpecialChar \ldots{}
5858 at least in any meaningful sort of way, so I suggest ignoring them.
5859 They are the references environment (2.12.3), and the deluxetable environment
5861 If you really, really need to use deluxetable, I suggest editing it in
5862 a separate file with a text editor, then using
5867 nsert\SpecialChar \menuseparator
5875 to include it in your LyX document.
5880 file to see an example of this.
5883 FAQs, Tips, Tricks, and Other Ruminations
5884 \layout Subsubsection
5886 Getting LyX and AASTeX to cooperate
5889 It can be a bit tricky to get LyX to recognize a new layout and document
5891 When all else fails, do this:
5894 Make certain that LaTeX can find AASTeX.
5895 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5896 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5909 /usr/.../share/lyx/layouts
5923 ools\SpecialChar \menuseparator
5930 in LyX, then restart LyX.
5933 Open a regular new file, not from a template.
5934 Does AASTeX appear in the class list in
5939 ocument\SpecialChar \menuseparator
5949 If you get a warning from an existing AASTeX document about not being able
5950 to find the AASTeX layout or a message about
5951 \begin_inset Quotes eld
5954 You should not mix title layouts with normal ones
5955 \begin_inset Quotes erd
5958 , things haven't been installed correctly.
5959 \layout Subsubsection
5961 LaTeX error processing a table
5964 LyX, by default, attempts to center the table caption/title.
5965 This seems to produce a bad interaction in AASTeX so you should click somewhere
5966 in the caption/title, then select
5971 dit\SpecialChar \menuseparator
5976 aragraph\SpecialChar ~
5991 This took care of it for me.
5992 \layout Subsubsection
5995 \begin_inset LatexCommand \label{cite}
6002 A few things: 1) I have noticed some funny spacing in the reference entries
6004 When you enter the bibliography item data, make sure their is
6008 space between the last author and the parenthesis setting off the year;
6023 2) I am really unhappy that I can't make
6035 more automatic, but that would require changes to the LyX source code.
6036 For now you can do one of two things: a) enter all your citations using
6039 Insert\SpecialChar \menuseparator
6042 mechanism; at least you can take advantage of the automatic insertions.
6043 Then edit the exported LaTeX file by hand changing the
6049 entries to the appropriate
6061 commands before you submit it (
6067 is currently equivalent to
6073 , so you wouldn't necessarily have to change those).
6074 Or b) you can simply enter all your citations as ERT using the same key
6075 for the argument that you used in the bibliography dialog,
6087 Neither choice is pleasant, but until LyX's citation mechanism understands
6092 , we'll have to put up with it.
6093 3) Entering the references at all is not obvious.
6094 The easiest thing is to start typing your first reference at the end of
6095 the document, then mark it as type
6100 That will put a small gray box in front of what you just typed.
6101 Click on the box to fill in the rest of the information.
6102 For new references, go to the end of an existing reference and press return.
6103 That will create a new line with its own box, etc.
6104 \layout Subsubsection
6109 With all due respect to Chris Biemesderfer and the others who have helped
6110 to write the AASTeX package, the figure handling mechanism smells really
6128 commands as ERT into a Figure Float box, but I never have much luck getting
6130 My advice would be to avoid all EPS inclusions in the manuscript you submit
6131 to the journal, but then use the standard LyX EPS file inclusion mechanism
6132 when you want to make your nicer looking preprints.
6137 usepackage{graphics}
6139 command into the LaTeX preamble and handle the figures in the standard
6141 Anyone who attempts to print your AASTeX 5.0 manuscript must have a LaTeX2e
6142 installation anyway, so why not take advantage of the infinitely better
6143 graphics handling mechanism? If they complain about LaTeX2e or the graphics
6144 package, point out that it appears in the second edition of Lamport (1994),
6145 so it was time to upgrade many years ago.
6146 \layout Subsubsection
6148 Things I could have done, but didn't
6152 \begin_inset Quotes eld
6156 \begin_inset Quotes erd
6159 things I could have implemented, but chose not to.
6160 For instance, I saw no point in double-spacing the text in the LyX window,
6161 even though it is double-spaced in the paper manuscript.
6162 Also, I chose not to make separate layouts for the preprint and preprint2
6164 Since I assume you will spend most of your time in the plain manuscript
6165 mode anyway, I decided not to chew up more disk space with this.
6166 If you feel strongly that I should make such layouts, I will adhere to
6167 the spirit of the rules laid out by the Mudgeeraba Creek Emu-Riding and
6168 Boomerang-Throwing Association:
6172 \begin_inset Quotes eld
6175 Decisions of the judges will be final unless shouted down by a really overwhelmi
6176 ng majority of the crowd present.
6177 Abusive and obscene language may not be used by contestants when addressing
6178 members of the judging panel, or, conversely, by members of the judging
6179 panel when addressing contestants (unless struck by a boomerang).
6180 \begin_inset Quotes erd
6189 To mangle the infamous quote by Donald Knuth about a computer algorithm,
6191 \begin_inset Quotes eld
6194 I have only proved this to be correct, I have not actually tried it.
6195 \begin_inset Quotes erd
6198 I believe following the above procedures will produce an acceptable AASTeX
6199 document, but as of this update (Jan 25, 2000), I have not yet submitted
6201 Hopefully in the next few months \SpecialChar \ldots{}
6210 Panayotis Papasotiriou
6216 The ijmpd package is a set of macros that facilitates electronic manuscript
6219 International Journal of Modern Physics D
6221 published by World Scientific.
6222 The name of the document class is
6227 This file, together with instructions for the authors, can be downloaded
6229 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
6234 The ijmpd package is a modified version of the standard
6235 \begin_inset Quotes eld
6239 \begin_inset Quotes erd
6243 Most of its features are supported by LyX.
6244 I have recently used LyX successfully to write an article submitted to
6247 International Journal of Modern Physics D
6255 As usual, the easiest way to write a paper is to start with a template.
6261 ile\SpecialChar \menuseparator
6273 This will give an (almost) empty document that includes the most common
6274 fields found in a manuscript.
6275 Simply overwrite the existing text (including the brackets,
6279 ) with the correct information.
6280 You should keep in mind the following remarks.
6283 LyX won't let you change the font size and the page style of the document,
6284 because the ijmpd package does not allow such modifications.
6287 The ijmpd package requires that the language of the document should not
6289 Before previewing your paper, be sure that the babel package is not used.
6290 To do this, click on
6295 ools\SpecialChar \menuseparator
6309 checkbox in the language settings, and click on
6320 , if you wish to make this change permanent).
6323 Two new environments, named
6324 \begin_inset Quotes eld
6328 \begin_inset Quotes erd
6332 \begin_inset Quotes eld
6336 \begin_inset Quotes erd
6339 are available (their use is obvious).
6342 Appendices may be added to the paper.
6343 LyX offers a special environment, called
6344 \begin_inset Quotes eld
6348 \begin_inset Quotes erd
6351 which marks the beginning of the appendix.
6352 An appendix can contain normal sections, subsections, or subsubsections.
6355 The ijmpd package implements table captions quite differently than LyX does.
6356 As a result, a table created by LyX is printed correctly, but its caption
6358 If you need table captions, you should implement the whole table float
6363 file, then include this file to the LyX document (
6368 nsert\SpecialChar \menuseparator
6377 Details on how to create an ijmpd table float can be found in the file
6382 , which is included in the ijmpd package.
6385 Preparing a paper for submission
6388 Before you submit your paper you must export the LyX document as a LaTeX
6394 ile\SpecialChar \menuseparator
6399 xport\SpecialChar \menuseparator
6406 ), then make the following changes to the resulting
6413 Remove the comment lines before the
6422 Remove everything between (and including) the
6434 commands, except for any commands you specifically put into the LaTeX preamble.
6441 file should be saved and processed through LaTeX as many times as necessary.
6442 You may also want to check the resulting
6452 The use of ERT is optional, and is reduced to three commands, which affect
6453 the look of the page.
6454 If you started writing your paper by using the
6458 template, the ERT needed is already in its place; you usually don't need
6460 You may only change the first ERT to specify the information printed to
6461 the top of odd and even pages (authors' names and short paper's title,
6463 This ERT must have the form
6467 markboth{Authors' Names}{Short Paper's Title}
6477 Panayotis Papasotiriou
6483 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6484 that facilitates electronic manuscript submission to the journals they
6486 Most known of them (at least in my domain of interest) are
6488 Astrophysics and Space Science
6494 , but there are many others (see a complete list at
6495 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
6500 The Kluwer package may be downloaded from the site
6501 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
6506 A complete user guide is contained in that package (but it can also be
6507 downloaded separately).
6510 LyX supports many features of the package but not everything.
6511 However, the ERT needed is reduced to some
6512 \begin_inset Quotes eld
6516 \begin_inset Quotes erd
6519 commands of the package (see\SpecialChar ~
6521 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
6526 I have recently used LyX to write an article submitted to the
6528 Astrophysics and Space Science
6530 without any problem.
6536 The easiest way to write a paper is to start with the Kluwer template file.
6539 File\SpecialChar \menuseparator
6551 This will give an (almost) empty document that includes the most common
6552 fields found in a manuscript and a short description of their use.
6553 As in most templates, simply overwrite the existing text (including the
6558 ) with the correct information.
6561 Preparing a paper for submission
6564 As in the AASTeX package, before you submit your paper to a journal you
6566 \begin_inset Quotes eld
6570 \begin_inset Quotes erd
6576 Export your paper as a LaTeX file.
6577 To do this, click on
6582 ile\SpecialChar \menuseparator
6587 xport\SpecialChar \menuseparator
6602 file with a text editor and make the following changes
6606 remove the comment lines before the
6615 remove everything between (and including) the
6627 commands, except for any commands you specifically put into the LaTeX preamble.
6642 file through LaTeX as many times as necessary (usually up to three).
6649 document using, e.g.,
6653 , and check if everything is ok (it should, if you didn't make any mistake).
6657 \begin_inset Quotes eld
6661 \begin_inset Quotes erd
6664 of the Kluwer package
6665 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
6672 The Kluwer package has the following
6673 \begin_inset Quotes eld
6677 \begin_inset Quotes erd
6683 It is possible to write multiple articles in the same LaTeX file
6689 I can't imagine any good reason to do this.
6693 Each article must be included in the environment
6694 \begin_inset Quotes eld
6698 \begin_inset Quotes erd
6702 Unfortunately, this environment cannot be omitted, even if you write just
6704 Therefore, each article starts with the command
6710 and, obviously, ends with the command
6717 Although this can be implemented in LyX, I didn't included it, since it
6718 looks ugly and can confuse the novice user.
6719 Therefore, you need to enter them directly and mark them as LaTeX code
6721 \begin_inset Quotes eld
6725 \begin_inset Quotes erd
6731 Information given at the beginning of the article (i.e., title, subtitle,
6732 author, institution, running title, running author, abstract and keywords)
6733 must be included in an environment called
6734 \begin_inset Quotes eld
6738 \begin_inset Quotes erd
6742 This is not implemented in LyX, so you must enter title, subtitle etc.
6743 between two ERT lines (
6758 According to the user manual, the label of each bibliography item must be
6786 template takes care of all these
6787 \begin_inset Quotes eld
6791 \begin_inset Quotes erd
6795 If you start a new paper using this template you don't need to do anything
6800 don't delete the ERT included in the template, and
6803 copy the example bibliography item included in the template and modify it
6804 as necessary to enter new bibliography items.
6818 The LyX document classes
6820 article (koma-script)
6824 report (koma-script)
6842 correspond to the LaTeX document classes
6859 of the Koma-Script family.
6860 They are replacements for the standard document classes
6876 , resp., and fit better to European typography conventions in a number of
6880 Standard character size is 11pt in
6882 article (koma-script)
6886 report (koma-script)
6894 letter (koma-script)
6899 Headings, labels of the description environment, and a number of elements
6902 letter (koma-script)
6904 document class are set in a bold sans serif font.
6910 There is a big difference between the bold sans serif old cm fonts and new
6911 ec fonts, especially in the appearance of headings.
6912 In comparison, the ec bold sans serif fonts look a bit thin.
6913 Here the LaTeX package
6920 helps to produce the
6921 \begin_inset Quotes eld
6925 \begin_inset Quotes erd
6928 appearance when using the ec fonts.
6931 The numbering of chapter headings is made in the same way as the numbering
6932 of section headings, that is without the extra line
6933 \begin_inset Quotes eld
6936 Chapter\SpecialChar \ldots{}
6938 \begin_inset Quotes erd
6942 In addition, the appearance of the headings can be modified by using a
6943 number of options (in LyX to be entered in the field
6957 ayout\SpecialChar \menuseparator
6965 A detailed German description of these options can be found in the Koma-Script
6973 The main means in the Koma-Script document classes to design the type area
6982 (in LyX to be entered in the extra class options field in the dialog
6987 ocument\SpecialChar \menuseparator
6995 They make a clearer modification of page margins possible as do the options
7001 ocument\SpecialChar \menuseparator
7009 A detailed German description of these and other type area options can
7010 be found in the Koma-Script documentation
7017 The LaTeX document classes of the Koma-Script family define a number of
7018 additional commands.
7019 Those part of it which makes sense in LyX is implemented in corresponding
7023 A detailed German description of the LaTeX document classes of the Koma-Script
7024 family can be found in the Koma-Script documentation
7034 There is an English translation
7038 , but it is not a complete one.
7041 The following sections describe only those aspects, which are relevant
7045 article (koma-script), report (koma-script), and book (koma-script)
7048 The document classes
7050 article (koma-script)
7054 report (koma-script)
7064 are implemented in the layout files
7077 They contain all the paragraph types of the corresponding standard document
7090 , resp., partly modified, with the exception of the LyX specific
7094 -type, which is replaced by the new
7098 -type having the same functionality.
7103 -Type there is a number of new paragraph types added.
7110 letter (koma-script)
7123 : are equivalents to
7131 , resp., additionally inserting an entry in the table of contents.
7140 are not contained in
7142 article (koma-script)
7163 , resp., additionally clearing running heads.
7170 article (koma-script)
7190 report (koma-script)
7192 , but since this is identical to
7196 , is has not been implemented in LyX.
7206 : generates a heading directly above the following paragraph in the standard
7207 character size without affecting the structure of the document.
7218 are special captions which respect the different space settings needed for
7219 captions placed above or below an element (if you follow strict typographic
7220 rules, you might want to place table captions always above the table).
7221 You can also use the class option
7238 You need at least Koma-Script version 2.8q to use this.
7245 : can be used to set a bonmot, e.
7265 at the beginning of a chapter.
7266 If you use the optional argument (
7271 nsert\SpecialChar \menuseparator
7275 ), you can insert the dictum's author there.
7276 Dictum and author are separated by a line.
7277 You need at least Koma-Script version 2.8q to use this.
7284 article (koma-script)
7289 The following types, together with the standard types
7301 , form the title area of the document.
7302 They must be entered ahead of the first
7303 \begin_inset Quotes eld
7307 \begin_inset Quotes erd
7316 The corresponding LaTeX commands must appear before the
7325 When such a type is used more than once, the latter usage overwrites the
7326 former one, that means, for every type only the latest usage is valid.
7327 The order of the different types however has, like
7339 , no effect on the appearance of the produced document.
7346 : produces a centered paragraph above the ordinary title (
7358 ) for the subject of the document.
7365 : produces a centered paragraph below the ordinary title (
7377 ) for the publishers' name.
7386 report (koma-script)
7392 produces a centered paragraph on its own page behind the title page, or
7395 article (koma-script)
7397 produces a centered paragraph below the ordinary title (
7420 : produces a left aligned paragraph above the ordinary title (
7436 ) for a document`s head.
7443 : produces in a double-sided print in
7445 report (koma-script)
7451 a left-aligned paragraph at the top of the title page`s back or has no
7452 effect in a single-sided print or in
7454 article (koma-script)
7463 : produces in a double-sided print in
7465 report (koma-script)
7471 a left-aligned paragraph at the bottom of the title page`s back or has
7472 no effect in a single-sided print or in
7474 article (koma-script)
7483 : produces a special
7484 \begin_inset Quotes eld
7488 \begin_inset Quotes erd
7491 page ahead of the actual document containing a paragraph without special
7495 The layout files for the document classes
7497 article (koma-script)
7501 report (koma-script)
7512 This is thought of as a place to define your own types.
7517 in your personal layout directory and edit the file!
7520 letter (koma-script)
7538 letter (koma-script)
7540 is implemented in the layout file
7545 It contains all the paragraph types of the corresponding standard document
7550 , partly modified, with the exception of the LyX specific types
7562 type, which is replaced by the new
7567 In addition, it contains, in contrast to the standard document class, the
7585 Furthermore, there are a number of new letter specific types.
7601 The appearance of the letter produced by this document class can be controlled
7602 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7608 For example, the standard appearance of the letter`s heading, consisting
7609 of name and address, is quite self-willed.
7611 \begin_inset Quotes eld
7615 \begin_inset Quotes erd
7618 heading is produced by the following LaTeX commands in the preamble:
7671 A detailed German description of such LaTeX commands can be found in the
7672 Koma-Script documentation
7677 With it, the letter's author can produce his personal letter layout.
7688 define the beginning of the letter and must be used in every letter.
7689 To emphasize them in the LyX document class, they are marked with the letter
7700 It is possible to write any number of letters in one file.
7705 type produces a new letter using the same addressee and a
7709 type produces a new addressee.
7726 are ordinary paragraph types and can also be used several times in one
7727 and the same letter.
7734 : produces a paragraph for the addressee and implicitly defines the beginning
7742 : produces a paragraph for the form of address and implicitly produces a
7750 : produces a paragraph for a close.
7757 : produces a paragraph for a postscript.
7764 : produces a paragraph for a distribution list.
7771 : produces a paragraph for enclosures.
7814 are input types provided with a label to enter information, which will
7815 be processed by the document class.
7821 It could be seen as a matter of inconsequence, that the types
7829 described above are not such input types as well.
7830 Because of the special meaning of those types, however, I have implemented
7831 them as ordinary paragraph types with a one letter mark in the left margin.
7832 Moreover, it would affect my feeling of symmetry, if the
7840 type had such a serious different appearance.
7843 The types must be used ahead of the corresponding
7850 An implementation of these types in a WYSIWYG fashion does not seem to make
7851 sense, because the real appearance of the produced letter does not only
7852 depend on the usage of the particular type, but also on other factors.
7853 For example, a signature entered in the
7857 type will in the standard behavior appear in the produced letter only,
7858 when in the same letter also a
7863 The entered value of the
7867 type will in the standard behavior not appear in the produced letter at
7869 The possibility to design the letter`s heading freely is already indicated
7870 in a footnote above.
7873 The input types can also be used as empty paragraphs.
7874 This makes sense e.\SpecialChar ~
7885 type is not used at all, in the standard behavior the value of the
7889 type is used as signature, whereas if an empty
7893 type is used, no signature value is defined.
7896 By using the input types it is possible to write a letter template, containing
7897 filled input types with your personal dates (name, address, etc.) and empty
7898 input types for other dates you want to enter.
7905 : sender's name, in the standard behavior appears as a centered paragraph
7906 in small caps in the letter`s heading.
7913 : sender's signature, in the standard behavior appears below the
7922 type is used, the value of the
7926 type appears instead.
7933 : sender's address, in the standard behavior appears in a centered paragraph
7934 in the letter`s heading below the sender's name.
7941 : sender's telephone number, in the standard behavior only sets the LaTeX
7955 : place of the letter`s making.
7962 : date of the letter`s making.
7971 , in the standard behavior, produce the place and the date in a right-aligned
7972 line below the addressee's field.
7977 type is used, neither place nor date appear, independent of the value of
7987 type is used, the date of the letter `s production is used.
7994 : sender`s back address, in the standard behavior appears above the addressee's
7995 field in a small sans serif font.
8002 : special mail information, in the standard behavior appears underlined
8003 above the addressee's field below the back address.
8010 : additional information, in the standard behavior appears on right side
8011 below the addressee`s field.
8018 : the letter's title, in the standard behavior appears in a big, bold, sans
8019 serif font above the subject.
8026 : the letter's subject, in the standard behavior appears in a bold font
8054 produce a business letter like line above the
8058 line containing the fields
8059 \begin_inset Quotes eld
8063 \begin_inset Quotes erd
8067 \begin_inset Quotes eld
8071 \begin_inset Quotes erd
8075 \begin_inset Quotes eld
8079 \begin_inset Quotes erd
8083 \begin_inset Quotes eld
8087 \begin_inset Quotes erd
8091 \begin_inset Quotes eld
8095 \begin_inset Quotes erd
8099 \begin_inset Quotes eld
8103 \begin_inset Quotes erd
8107 For the date field, the value of the
8113 \begin_inset Quotes eld
8116 business letter types
8117 \begin_inset Quotes erd
8120 is used, the value of the
8124 type however does not appear, but only the LaTeX variable
8131 The ordinary output of place and date in a right-aligned line below the
8132 addressee`s field is suppressed.
8133 The types are implemented as input types provided with a label and must
8134 be used ahead of the corresponding
8176 The new letter class: letter (koma-script v.2)
8181 Jürgen Spitzmüller
8183 \added_space_top medskip \noindent
8184 Koma-Script version 2.8 has introduced a new letter class
8188 which superceeds the now unsupported
8193 It has --- on the LaTeX side --- a completely new interface and is not
8194 compatible with the old class.
8195 Therefore, LyX supports both, though it is recommended to use the new class.
8198 This class covers the same functionality as
8200 letter (koma-script),
8207 (receiver's address, same as
8224 will start a new letter (i.
8244 you can write several letters per document).
8245 New elements are sender's
8261 and the possibility to use a
8270 nsert\SpecialChar \menuseparator
8280 The biggest improvement is, though, that the letter's layout is configurable
8281 at almost any needs.
8282 This can be done via the preamble or with a special style file (Letter
8283 Class Option, extension
8287 ), that will be read in as a class option.
8293 The KOMA package comes with some default
8298 There is, for instance, a
8302 file that follows german typesetting rules, or a
8306 that provides the default layout of the old
8311 The latter can be loaded with the class option
8320 ayout\SpecialChar \menuseparator
8325 ocument\SpecialChar \menuseparator
8335 template that is included in LyX for examples.
8336 A detailed description is to be found in the Koma-Script documentation
8347 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8351 The chapter number of a
8355 type appears on a line of its own above the chapter heading instead of
8356 appearing in the same line ahead of it.
8357 The cause for that is the LyX internal behavior for the labeltype
8364 The headings of the types
8373 \begin_inset Quotes eld
8377 \begin_inset Quotes erd
8380 LaTeX table of contents, but not in the LyX table of contents (
8385 ocument\SpecialChar \menuseparator
8401 document class appear in a skip separation mode, not indented.
8402 This is the standard behavior, no special LaTeX commands are needed for
8409 ocument\SpecialChar \menuseparator
8416 dialog the corresponding radio button indicates
8432 value always has the effect that extra LaTeX commands are inserted in the
8433 document to produce the gap, which is not what is wanted in this case.
8451 These are the layout files for some of the journal formats used by Springer
8452 Verlag and listed on
8453 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
8457 , where you should also go to fetch the class files (yes, these are LaTeX2e
8459 It is a modular system: the things common to all journals are implemented
8464 , which journal-specific layout files (such as, e.g.,
8468 for Journal of Geodesy) can include.
8471 This means that implementing support for any other Springer journal on this
8472 list is as simple as writing your own
8480 file following the outline given in
8488 It is reasonably well tested only for the Journal of Geodesy.
8497 come with the standard LyX distribution.
8498 Install the relevant class file (downloaded from Springer) in a proper
8499 directory, reconfigure LaTeX (in the teTeX case by running
8503 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8504 LyX and it should work.
8510 A large number of theorem-like styles ---
8516 \SpecialChar \ldots{}
8524 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8525 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8528 See the Springer class file documentation for details.
8547 Probability Theory and Related Fields
8553 --- Jean-Marc Lasgouttes
8556 Add your own, it isn't so hard!
8562 These files are partly based on the older
8566 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8572 layout, are now defunct.
8573 Jean-Marc Lasgouttes helped out big in making me find my way around the
8574 LyX layout file mechanism.
8581 But probably less than in the old hacked-LaTeX
8588 Limitations e.g.: does not display the number for theorem-like layouts, just
8607 These are the layout files for some of the journals of the American Geophysical
8609 It is assumed that you have both the AGU's own class files and AGUplus
8610 installed (everything to be found at
8611 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
8630 They are still called this in the LyX GUI, though their LaTeX equivalents
8631 in the AGU classes are
8642 Newly defined styles are
8679 These are mostly manuscript attributes and defined in the AGU class documentati
8683 I suspect this is still badly incomplete.
8710 Journal of Geophysical Research
8719 Add your own, it isn't so hard! Look at the
8730 Bugs and things to remember
8733 In order to use the new layouts, you must remember to do the following for
8742 This can be done in the
8744 layout\SpecialChar \menuseparator
8749 document\SpecialChar \menuseparator
8753 (AGU articles are always in English, right? So
8769 (Yes, this is a bug.)
8772 Make sure you use the
8776 bibliography style, by entering
8780 into the second field of the BibTeX inset.
8781 None of the standard styles will do.
8799 This is the layout file for the European Geophysical Society journals.
8804 can be downloaded from the web site of the EGS under
8805 \begin_inset LatexCommand \url{www.copernicus.org}
8817 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8825 The current layout file is unfortunately very unmodular and would benefit
8826 from using the various
8838 \begin_inset LatexCommand \label{sec:slitex}
8855 This section describes how to use LyX to make slides for overhead projectors.
8856 There are two document classes that can do this: the default slides class
8862 This section documents the former.
8865 I'm going to say this again, nice and clear, so that there's no misunderstanding
8868 \added_space_top bigskip \added_space_bottom bigskip \align center
8871 This section documents the class
8872 \begin_inset Quotes eld
8880 \begin_inset Quotes erd
8888 If you're looking for the documentation for
8889 \begin_inset Quotes eld
8897 \begin_inset Quotes erd
8900 , check out section\SpecialChar ~
8902 \begin_inset LatexCommand \ref{sec:foiltex}
8912 \begin_inset Quotes eld
8920 \begin_inset Quotes erd
8923 ] is actually somewhat better than the default
8933 \SpecialChar \ldots{}
8934 or so I've been told repeatedly by its advocates.
8935 Having never used it, I have no idea if this claim is true or not.
8938 which this section documents.
8941 This class is the LaTeX2e improvement of the old
8946 Every LaTeX2e distribution includes this class [which I'll just refer to
8948 \begin_inset Quotes eld
8956 \begin_inset Quotes erd
8959 from now on], so you're bound to have it.
8960 As I noted earlier, there are other classes, such as
8964 , which also produce slides for overhead projectors and do a better job
8966 However, there are some things which
8970 can do which the others can't, such as generate overlays.
8971 Read on to learn more!
8975 \begin_inset LatexCommand \label{sec:slidesetup}
8982 Obviously, to use this document class, you need to select
8983 \begin_inset Quotes eld
8991 \begin_inset Quotes erd
8994 from the class list in the
8999 ocument\SpecialChar \menuseparator
9007 There are some other special things you should know about this class:
9010 Don't bother changing the options
9015 They're not supported by the
9030 behaves a bit differently for this class.
9031 The possible choices and what they do are as follows:
9039 The final output contains page numbers in the lower right corner.
9050 , but also prints out any time markers you've put in.
9051 This is the default.
9058 The final output contains no page numbers, time markers, or alignment markers.
9066 class has an extra option:
9072 \begin_inset Quotes eld
9080 \begin_inset Quotes erd
9083 in the extra class options.
9087 Using this options allows you to add time markers to
9092 See section\SpecialChar ~
9094 \begin_inset LatexCommand \ref{sec:slideNote}
9102 You can also use the template file
9103 \begin_inset Quotes eld
9111 \begin_inset Quotes erd
9114 to automatically set up a document to use the
9123 ile\SpecialChar \menuseparator
9132 to open your new document].
9133 The template file also contains some examples of the special paragraph
9134 environments used by this class.
9135 I'll describe those next.
9138 Paragraph Environments
9139 \layout Subsubsection
9141 Supported Environments
9144 The first thing you'll notice when you start up a new
9148 document is the font size and type: it's the equivalent of the size
9149 \begin_inset Quotes eld
9157 \begin_inset Quotes erd
9166 This is also what's used in the output.
9168 \begin_inset Quotes eld
9172 \begin_inset Quotes erd
9175 to remind you that this is a slide.
9176 Your final slides will use a larger font; ergo, you'll have less space.
9177 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9180 The next thing that becomes obvious is the changes to the paragraph environment
9181 pull-down box [at the far-left end of the toolbar].
9182 Most of the paragraph environments you're used to seeing are missing.
9183 There are also five new ones.
9188 class itself only supports certain paragraph environments:
9246 All of the other standard environments, including the section-heading environmen
9247 ts, aren't used in the
9254 On the other hand, you'll notice the following new environments:
9282 These five are kind of quirky, due to a
9283 \begin_inset Quotes eld
9287 \begin_inset Quotes erd
9291 You see, LyX doesn't permit you to nest any other paragraph environment
9292 into an empty environment.
9293 Now, that's fine and dandy, but it means that you wouldn't be able to start
9294 a slide with anything except plain text.
9295 To deal with this, I've performed a little
9296 \begin_inset Quotes eld
9300 \begin_inset Quotes erd
9304 \layout Subsubsection
9306 Quirks of the New Environments
9307 \begin_inset LatexCommand \label{sec:slideQuirk}
9314 All five of the new paragraph environments are somewhat quirky due to inherent
9315 limitiations in the current version of LyX.
9316 As I just mentioned, LyX forbids environments that begin with another environme
9318 To get around this, the
9322 environment isn't a paragraph environment as described in the
9343 \begin_inset Quotes eld
9346 pseudo-environments.
9347 \begin_inset Quotes erd
9350 They look like a section heading or a
9351 \begin_inset Quotes eld
9359 \begin_inset Quotes erd
9362 but really begin a [and, if necessary, end the previous] paragraph environment.
9372 \begin_inset Quotes eld
9376 \begin_inset Quotes erd
9379 These two perform some action.
9382 A common feature of all five environments,
9402 , is a rather long-ish label.
9403 The text following this label --- ordinarily the contents of the paragraph
9404 environment --- is utterly irrelevant for
9425 LyX completely ignores it.
9426 In fact, you can leave these five environments completely empty.
9434 to put any text after the rather long-ish label, you might want to.
9435 This could be a short description of the contents of the
9440 In that case, enter in your descriptive comment and hit
9444 as you normally would.
9447 If, on the other hand, you don't want to enter in any descriptive text,
9448 you'll hit another LyX quirk.
9449 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9450 environment until you put something in the old one.
9454 Start entering the text that will
9482 Now move to the beginning of that paragraph.
9494 Finally, change this new, empty paragraph to a
9518 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9522 Making a Presentation with
9533 \layout Subsubsection
9542 If you're expecting this section to teach you how to actually make a presentatio
9543 n, you'll be sorely disappointed.
9544 Naturally, I'll describe all of the ways the
9548 class can assist you in preparing the materials for a presentation.
9549 Filling in the contents, however, is up to you.
9554 the LyX philosophy.]
9561 environment [in the manner described in section\SpecialChar ~
9563 \begin_inset LatexCommand \ref{sec:slideQuirk}
9567 ] tells LyX to begin a new slide [duh].
9568 The label for this environment/
9569 \begin_inset Quotes erd
9573 \begin_inset Quotes erd
9577 \begin_inset Quotes eld
9581 \begin_inset Quotes erd
9584 in cool blue, followed by the label,
9585 \begin_inset Quotes eld
9589 \begin_inset Quotes erd
9593 Any text or paragraph environments that follow this one go on the new slide.
9597 Slides are probably the only time you'll need to forcibly end pages in LyX
9598 (this can be specified in the
9603 In fact, you'll want to, once you finish entering the contents of one slide.
9604 If you've entered more text than can physically fit on a slide, the extra
9605 overflows onto a new slide.
9606 I don't recommend doing this, however, since the overflow slide won't have
9607 any page number on it.
9608 Furthermore, it may interfere with any
9612 you've made to accompany the oversized
9627 environments work the same way as the
9633 \begin_inset Quotes eld
9637 \begin_inset Quotes erd
9640 followed by a label [
9641 \begin_inset Quotes eld
9645 \begin_inset Quotes erd
9649 \begin_inset Quotes eld
9653 \begin_inset Quotes erd
9657 The color is a stunning magenta instead of blue, and the
9658 \begin_inset Quotes eld
9662 \begin_inset Quotes erd
9665 will look different, in style and in length.
9666 The label fonts of all three also differ from one another.
9673 , if the contents of a
9681 exceed the physical size of a slide or sheet of paper, the extra will overflow
9683 Again, you should avoid this.
9684 It defeats the whole purpose of
9693 \layout Subsubsection
9708 is a slide that sits atop another slide.
9709 Perhaps you wish to discuss a figure on the main
9713 before displaying the text associated with it.
9714 One way to accomplish this is tape a flap of dark paper over the part of
9719 you want to display later.
9720 This method fails, however, if you wish to overlap one graph with another,
9722 You would then have to fumble while speaking to align the two separate,
9727 s to align the two graphs.
9732 environment in both cases makes life much easier.
9739 receives the page number of its
9740 \begin_inset Quotes eld
9744 \begin_inset Quotes erd
9752 \begin_inset Quotes eld
9760 \begin_inset Quotes erd
9769 Presumably, mutliple
9774 \begin_inset Quotes eld
9782 \begin_inset Quotes erd
9786 \begin_inset Quotes eld
9794 \begin_inset Quotes erd
9798 \begin_inset Quotes eld
9806 \begin_inset Quotes erd
9809 , etc.\SpecialChar ~
9810 appended to the page number of the parent
9818 Clearly, you want the contents of both the
9826 to each fit on a single physical slide! You should probably consider an
9832 \begin_inset Quotes eld
9836 \begin_inset Quotes erd
9848 class provides a visual cue for this: the label at the start of an
9852 is shorter than that at the start of a
9857 Lastly, when you generate printable output, you'll find alignment markers
9858 in all four corners of both the
9867 These will assist you in lining up the two physical slides.
9870 The major problem in overlaying two slides is aligning the contents of the
9872 How much space should you leave for that graph on the second slide? Worse
9873 still, what if you want a graph and a sentence on second slide, but there
9874 is text on the main transparency that goes in between them? You could try
9875 and insert vertical space of the right size.
9876 The better way is to use
9887 As their names imply,
9895 are two command-like paragraph environments that make all subsequent text
9896 invisible and visible, respectively.
9897 Note from section\SpecialChar ~
9899 \begin_inset LatexCommand \ref{sec:slideQuirk}
9903 that you don't place anything
9907 these two environments, however.
9912 , it inserts a centered, sky-blue label into the page reading
9913 \begin_inset Quotes eld
9916 <Invisible Text Follows>
9917 \begin_inset Quotes erd
9921 For paragraphs following this label, the parts of the
9929 ; it doesn't matter which] where they would be contain instead blank space.
9937 , the corresponding centered label is
9938 \begin_inset Quotes eld
9941 <Visible Text Follows>
9942 \begin_inset Quotes erd
9946 Paragraphs following this label behave normally.
9947 Note that the beginning of a new
9959 automatically shuts off an
9964 It's therefore not necessary to use
9975 By now, it should be obvious how to create overlay transparencies using
9976 the proper combination of
9999 , including everything that will appear on it, whether on the main slide
10007 Before each figure or paragraph that will appear only on the
10016 If necessary, insert a
10020 environment after the
10031 immediately following the
10038 Copy the contents of this
10053 , change all of the
10065 You've just made an
10072 There's one problem with the way I've designed the LyX
10076 class: you can't make text in the middle of a paragraph invisible, nor
10077 make text in the middle of an invisible paragraph visible again.
10078 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10084 The commands of interest are:
10091 invisible \SpecialChar \ldots{}
10099 visible \SpecialChar \ldots{}
10103 \SpecialChar \ldots{}
10104 and need to be marked as TeX.
10106 \begin_inset Quotes eld
10110 \begin_inset Quotes erd
10113 you wish to change goes in between the brackets [and after the
10126 If you don't know how to mark text as TeX, see the apprpriate section of
10135 \layout Subsubsection
10146 \begin_inset LatexCommand \label{sec:slideNote}
10161 is associated with a
10162 \begin_inset Quotes eld
10166 \begin_inset Quotes erd
10178 class provides visual cues.
10183 is shorter than that of a
10187 [yet longer than that of an
10191 ] and, like the label of an
10195 is shockingly magenta.
10196 Additionally, the printed
10200 has the page number of its
10201 \begin_inset Quotes eld
10205 \begin_inset Quotes erd
10213 \begin_inset Quotes eld
10221 \begin_inset Quotes erd
10225 \begin_inset Quotes eld
10233 \begin_inset Quotes erd
10237 \begin_inset Quotes eld
10245 \begin_inset Quotes erd
10249 You can have multiple
10253 s associated with a single
10265 , you'll probably want to break up long
10269 s so that they fit on a single sheet of paper.
10276 is obvious: it contains anything additional you might want to say about
10282 It could also be used as a sheet of reminders for a particular
10287 In the case of the latter, you might want to make use of time markers.
10293 \begin_inset Quotes eld
10297 \begin_inset Quotes erd
10300 support for time markers, a
10305 So, you'll have to resort to using the LaTeX codes.
10308 To use time markers, you'll need to specify the extra class option
10309 \begin_inset Quotes eld
10317 \begin_inset Quotes erd
10320 [see section\SpecialChar ~
10322 \begin_inset LatexCommand \ref{sec:slidesetup}
10327 This option turns on timing marks, which will appear in the lower-left-hand
10333 To set what appears in the time marker, you use the LaTeX commands
10334 \begin_inset Quotes eld
10344 \begin_inset Quotes erd
10348 \begin_inset Quotes eld
10358 \begin_inset Quotes erd
10362 The arguments of both commands are time measured in seconds.
10364 \begin_inset Quotes eld
10374 \begin_inset Quotes erd
10377 sets the time marker to a given time.
10379 \begin_inset Quotes eld
10389 \begin_inset Quotes erd
10392 increments the time marker by the specified amount.
10393 Using time markers and
10397 s in this fashion, you can remind yourself how much time to spend on a particula
10405 There's one last feature to describe.
10406 Clearly, you'd like to print out all of your
10414 s on transparencies while printing all of your
10431 with which it is associated.
10432 What's a person to do?
10435 Luckily, there are two LaTeX commands that allow you to select what to print
10437 Both must be placed into the preamble of your document.
10439 \begin_inset Quotes eld
10451 \begin_inset Quotes erd
10454 will cause the output to contain only the
10463 Correspondingly, the command
10464 \begin_inset Quotes eld
10476 \begin_inset Quotes erd
10479 prevents the output of anything but
10484 I'd advise placing both commands in the preamble and initially comment
10486 You can then preview your entire presentation as you write.
10487 When you're done writing, you can then uncomment one of the two to select
10488 what you want to print.
10489 I like to uncomment
10490 \begin_inset Quotes eld
10502 \begin_inset Quotes erd
10505 , print to a file with
10506 \begin_inset Quotes eld
10514 \begin_inset Quotes erd
10517 in its name, comment it back out, then uncomment
10518 \begin_inset Quotes eld
10530 \begin_inset Quotes erd
10534 \begin_inset Quotes eld
10542 \begin_inset Quotes erd
10546 I can then send either file to a printer, loading transparencies or plain
10547 paper as appropriate.
10550 You can also provide other arguments to the
10551 \begin_inset Quotes eld
10561 \begin_inset Quotes erd
10565 \begin_inset Quotes eld
10575 \begin_inset Quotes erd
10579 See a good LaTeX book for details.
10586 Class Template File
10589 I have also provided a template file,
10590 \begin_inset Quotes eld
10598 \begin_inset Quotes erd
10606 To use it, begin your new presentation with
10611 ile\SpecialChar \menuseparator
10621 Your new LyX presentation file will contain an example
10642 additionally contain an example of the use of
10651 Lastly, the preamble will contain:
10654 % Uncomment to print out only slides and overlays
10669 % Uncomment to print out only notes
10682 One final thing: I created this class to support the LaTeX2e
10683 \begin_inset Quotes eld
10691 \begin_inset Quotes erd
10694 class, one of the built-in LaTeX2e classes.
10695 Neither I nor the rest of the LyX Team endorse or oppose the use of this
10696 built-in slide class.
10697 It's here if you want it or need it.
10698 There exist other LaTeX2e classes for creating presentations, such as the
10703 class [see section\SpecialChar ~
10705 \begin_inset LatexCommand \ref{sec:foiltex}
10710 \begin_inset Quotes eld
10718 \begin_inset Quotes erd
10721 package [present on some TeX distributions].
10722 The latter is not yet supported under LyX.
10728 Perhaps you can take on the task\SpecialChar \ldots{}
10732 I know nothing about these other classes.
10733 Try them out to see what sort of alternative they provide.
10744 \begin_inset LatexCommand \label{sec:foiltex}
10759 This section describes how to use LyX to make slides for overhead projectors.
10760 There are two document classes that can do this: the default slides class
10766 This section documents the latter.
10769 I'm going to say this again, nice and clear, so that there's no misunderstanding
10772 \added_space_top bigskip \added_space_bottom bigskip \align center
10775 This section documents the class
10776 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10792 If you're looking for the documentation for
10793 \begin_inset Quotes eld
10801 \begin_inset Quotes erd
10804 , check out section\SpecialChar ~
10806 \begin_inset LatexCommand \ref{sec:slitex}
10811 If your machine doesn't have the
10816 \begin_inset Quotes eld
10824 \begin_inset Quotes erd
10827 ] installed, you'll probably have to use the default
10831 class, which isn't quite as good as
10840 class is designed for use with version 2.1 of the
10844 LaTeX class file which is now an integral part of LaTeX2e.
10850 Obviously, to use this document class, you need to select
10851 \begin_inset Quotes eld
10859 \begin_inset Quotes erd
10871 Document\SpecialChar ~
10875 There are some settings in the
10877 Document\SpecialChar ~
10880 dialog that you should know about that are specific to this class:
10883 Don't change the options
10893 Document\SpecialChar ~
10897 They're ignored by the
10904 The default font size is 20pt with the other options being 17pt, 25pt and
10908 The default font is
10916 but all math equations are still typeset in the usual roman font.
10923 TeX supports A4 and Letter paper sizes as well as a special size for working
10925 It doesn't support A5, B5, legal or executive paper sizes.
10928 Don't bother changing the
10932 settings because they are ignored anyway.
10933 All floats appear where they are defined in the text.
10943 setting behaves a bit differently for this class.
10948 TeX provides extensive footer and header capabilities including a user-defined
10950 See section\SpecialChar ~
10952 \begin_inset LatexCommand \ref{sec:foilfoot}
10957 The title page is treated differently to all other pages in the document
10966 has the logo centered at the bottom of the page (if one is defined).
10967 The possible page style choices and what they do are as follows:
10970 \labelwidthstring MMMMMMM
10978 The final output contains no page numbers, or other headers or footers
10979 (except footnotes of course).
10982 \labelwidthstring MMMMMMM
10990 The final output contains page numbers centered at the bottom of the page.
10991 No other headings or footers (other than footnotes).
10993 \labelwidthstring MMMMMMM
10999 Page numbers in lower right corner.
11000 Additional headers and footers are also shown.
11001 This is also the default.
11003 \labelwidthstring MMMMMMM
11009 Gives you access to the
11013 package although its use with
11017 TeX is discouraged by the writer of the
11021 TeX package because of some potential page layout clashes.
11023 \layout Subsubsection
11028 The following options may be used in the extra class options in the
11033 ocument\SpecialChar \menuseparator
11042 \labelwidthstring MMMMMMx
11048 This sets up the page layout for 7.33in by 11in paper, which is about the
11049 same aspect ratio as a 35mm slide, making it a bit easier to work with
11052 \labelwidthstring MMMMMMx
11058 Places a rule across the page below the header on every page except the
11061 \labelwidthstring MMMMMMx
11067 Places a rule across the page above the footer on every page except the
11070 \labelwidthstring MMMMMMx
11076 This is automatically set each time you create a new
11085 TeX to use the dvips driver to rotate those pages that are set as landscape
11088 \labelwidthstring MMMMMMx
11094 Simply changes the page dimensions to those of a landscape page but doesn't
11096 Thus if you use this option you need to use an external program to rotate
11097 each page or feed your paper through your printer as landscape.
11098 Note that this option effectively reverses the roles of the
11106 environments (don't worry these are described in the next section).
11108 \labelwidthstring MMMMMMx
11114 Equation numbers on the left.
11116 \labelwidthstring MMMMMMx
11122 Flush-left equations.
11125 Supported Environments
11128 Most of the environments commonly supported in other classes are also supported
11134 There are several additional environments provided by
11138 TeX as well as a couple added by LyX.
11139 The following environments are shared with other classes:
11149 begin{multicols}{2}
11258 That is, all the major environments apart from the sectioning environments.
11259 Since foils are essentially self-contained sections, with a title and body,
11264 TeX provides specific commands for starting new foils and these are:
11277 LyX also provides slightly modified versions of these two environments called:
11287 ShortRotatefoilhead
11290 and the differences will be explained in the next section.
11293 Since foils are often used in presenting ideas or new theorems and such
11298 TeX also provides a comprehensive box of goodies for presenting them:
11308 begin{multicols}{2}
11382 The starred versions are unnumbered while the unstarred versions are numbered.
11383 There are also two list environments added by LyX and these are:
11400 TeX provides some powerful header and footer capabilities that are best
11401 set in the preamble although they may be set at any point in a document.
11402 If you want to change these settings in your document the best place to
11403 do so is at the very top of a foil,
11408 straight after the foilhead.
11411 For this purpose, the following command styles are provided [
11425 begin{multicols}{2}
11444 Right\SpecialChar ~
11450 Right\SpecialChar ~
11479 There are also a few commands provided by
11483 TeX that aren't directly supported by LyX but I'll tell you what they do
11484 and how to use them in section\SpecialChar ~
11486 \begin_inset LatexCommand \ref{sec:unsuppfoils}
11493 Building a Set of Foils
11496 This section will give a simple introduction to using the different environments
11497 to build a set of foils.
11498 If you want to see an example set of foils take a look at the
11502 file accessible from the
11507 ile\SpecialChar \menuseparator
11512 pen\SpecialChar \ldots{}
11521 \layout Subsubsection
11523 Give It a Title Page
11526 Unlike other classes that provide
11546 creates the title on a page of its own.
11547 If you leave out the
11551 environment LaTeX will substitute the current date (every time you regenerate
11553 \layout Subsubsection
11558 As I mentioned earlier, there are four ways of starting a new foil.
11559 For portrait foils you should use
11568 The difference between these two environments is the amount of space between
11569 the title of the foil (the foilhead) and the body of the foil.
11572 Landscape foils are generated using the
11578 ShortRotatefoilhead
11581 Again the only difference is the spacing between foilhead and body.
11582 Both of the short versions have 0.5 inches less separation between the foilhead
11587 One problem with the support for landscape foils is the requirement that
11588 you have to use the
11592 driver to generate the PostScript® output otherwise the foils won't be
11594 It is possible to get landscape foils even if you haven't got the
11598 driver provided you can feed your foils sideways through your printer ;-)
11599 \layout Subsubsection
11601 Theorems, Lemmas, Proofs and more
11604 Due to a small bug in LyX you can't have two of the same type of these environme
11605 nts directly following each other.
11606 They must be separated by something.
11607 If you try, you will just be extending the previous environment as if you
11608 had merged the two environments together.
11609 So, how do you get around this problem? The simplest option is to insert
11610 some text between the two environments or add a
11614 environment between the two with just a
11615 \begin_inset Quotes eld
11623 \begin_inset Quotes erd
11627 This will force LyX to produce two separate environments and hence the
11628 correct LaTeX output.
11629 An example is provided in the example file included with the LyX distribution.
11630 Remember, this problem only occurs if you are trying to place two of the
11631 same type of theorem-like environments one directly after the other.
11632 \layout Subsubsection
11637 You get all the commonly supported list styles found in other classes as
11638 well as two new ones.
11639 I'll only describe the new ones here.
11640 If you want to find out more about the other list environments check out
11646 If you intend to use itemized lists you might also want to read about the
11649 Itemize\SpecialChar ~
11650 Bullet\SpecialChar ~
11653 dialog described above in section\SpecialChar ~
11655 \begin_inset LatexCommand \ref{sec:bullet}
11662 The two new list styles,
11670 , are designed to make it easier for you to create lists of do's and don'ts
11671 or right and wrong by providing dedicated environments that use a tick
11672 or a cross as the label of the list.
11673 These lists are in fact dedicated variants of the
11678 They do however require that you have the
11682 packages installed.
11683 \layout Subsubsection
11692 TeX redefines the floating tables and figures so that they appear exactly
11693 where they are in the text rather than pushing them to the top of the page
11694 or to some user specified location.
11695 In fact if you change the float placement settings they are simply ignored.
11696 \layout Subsubsection
11698 Page Headers and Footers
11699 \begin_inset LatexCommand \label{sec:foilfoot}
11715 are two commands used to control the left-footer text string.
11716 The first is meant to allow you to include a graphic logo on your foils
11718 \begin_inset Quotes eld
11726 \begin_inset Quotes erd
11730 While the second is meant to provide a classification for the audience,
11737 It is empty by default.
11740 The remaining page corners can be filled by
11742 Right\SpecialChar ~
11745 (which defaults to page numbers),
11747 Right\SpecialChar ~
11763 \begin_inset LatexCommand \label{sec:unsuppfoils}
11770 All the commands mentioned below need to be set in a
11778 within another environment.
11779 \layout Subsubsection
11784 All lengths are adjusted using the
11807 should be replaced by the name given to the length you want to change and
11812 is the length value.
11813 All lengths should be specified in units of length such as inches (
11825 ) or relative to some document or font-based length such as
11835 It's possible to change the spacing between a foilhead and the body of the
11836 foil by adjusting the length specified by
11843 For example, to make
11847 foilheads 0.5 inches closer to their bodies put the following in the preamble:
11854 foilheadskip}{-0.5in}
11857 The spacings around floats can be adjusted by setting these lengths:
11859 \labelwidthstring MMMMMMMMMMM
11867 Separation between the text and the top of the float
11869 \labelwidthstring MMMMMMMMMMM
11877 Separation between the float and the caption
11879 \labelwidthstring MMMMMMMMMMM
11887 Separation between the caption and the following text
11889 \labelwidthstring MMMMMMMMMMM
11897 You can make the captions narrower than the surrounding text by adjusting
11899 Best done relative to
11908 There are also several title page related lengths that you may find useful
11909 if you have a long title or several authors:
11911 \labelwidthstring MMMMMMMMMMM
11919 Separation from headers to
11923 \labelwidthstring MMMMMMMMMMM
11941 \labelwidthstring MMMMMMMMMMM
11955 \labelwidthstring MMMMMMMMMMM
11971 \labelwidthstring MMMMMMMMMMM
11988 The last length related command affects all the list environments.
11999 a list environment then all the vertical spacing between the list items
12001 Note that this is a command not a length so it doesn't require
12007 like the stuff mentioned above.
12008 \layout Subsubsection
12010 Headers and Footers
12025 commands control whether the logo in the
12029 definition appear on a given page.
12036 in the preamble then none of the foils will have the logo on them.
12037 If you don't want the logo on a particular page place the
12043 directly after the foilhead of that page and the
12049 directly after the next foilhead.
12052 If you decide to use the
12056 page style setting in the
12058 Document\SpecialChar ~
12061 dialog you should probably add
12071 to your preamble so headers and footers on landscape pages are correctly
12072 placed when rotated.
12073 This is due to some clashes between the page layouts provided by the
12084 Latex8 (IEEE Conference Papers)
12095 Since this class is specifically for writing submissions to IEEE sponsored
12096 conferences I strongly recommend that you get a copy of their Authors Kit.
12101 package and associated bibliography style file is included in the kit.
12102 The Authors Kit is usually sent out by email once your initial submission
12104 There is a lot of useful information in the Authors Kit explaining formatting
12105 restrictions and so on and I will assume you have read this since that
12106 means I don't have to repeat it all here.
12112 [AR\SpecialChar \@.
12116 Supported Environments
12164 Differences Between Screen and Paper
12167 There are slight differences in appearance mainly with the presentation
12168 of section counters.
12169 On screen the trailing period of the section counter is missing but it
12170 will appear in the output so don't let this worry you.
12173 Hollywood (Hollywood spec scripts)
12184 Getting the format of a Hollywood script right is a
12185 \begin_inset Quotes eld
12189 \begin_inset Quotes erd
12192 It is designed to make the readers focus on content and to be easy and
12193 familiar for the actors to read.
12194 Each page of a script should be one minute of film.
12195 Nothing goes in a script that you cannot see or hear on screen.
12196 The courier 12 pt font should be used throughout.
12203 Speakers' lines should NEVER break in mid-sentence.
12204 If a speaker's lines continue over a page break, repeat the
12208 title followed by (Cont'd).
12218 names as labels then cross-reference the label to insert the name.
12219 The cross-reference dialog will show the current cast of characters.
12220 You can use this to insert the speaker name in narratives also.
12223 Paper size and Margins
12226 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12232 The following environments are available.
12233 You can use hollywood.bind to get the bind keys shown at the right.
12242 Used where nothing else works.
12258 Usually followed by something like
12259 \begin_inset Quotes eld
12262 on Sally waking up.
12263 \begin_inset Quotes erd
12277 Introduces a new INTERIOR camera set-up.
12278 Always followed by DAY or NIGHT, or something similar to define the lighting
12280 Everthing on this line in CAPS.
12291 Introduces a new EXTERIOR camera set-up.
12292 Everthing on this line in CAPS.
12303 The character speaking.
12314 Instructions to the speaker.
12315 The () are automatically inserted, but only the ( will show in LyX.
12316 Both will be printed.
12342 Camera movement instruction.
12378 (O.S) --- off screen
12381 (V.0) --- voice over
12392 PAN --- camera movement
12395 INSERT --- cut to close-up of
12409 Broadway is for writing plays.
12410 The format is more decorative than Hollywood, and much less standardized.
12411 This format should be suitable for workshops.
12417 The same as in Hollywood.
12427 names as labels then cross-reference the label to insert the name.
12428 The cross-reference dialog will show the current cast of characters.
12431 Paper size and Margins
12434 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12440 The following environments are available.
12441 You can use broadway.bind to get the bind keys shown at the right.
12450 You should not have to use this, but it is here for anything that does not
12462 Used to describe stage setting and the action.
12463 First use of speaker names in all CAPs.
12474 Automatically numbered.
12475 On screen it will be arabic, but will print as Roman.
12491 It is just centered text.
12502 Not automatically numbered.
12503 You supply the number.
12504 This is because I couldn't figure out how.
12515 A special case of Narrative to describe the setting and action as the curtain
12527 The speaker's (actor's) title, centered in all CAPS.
12538 Instructions to the speaker.
12539 The parentheses are automatically inserted.
12540 The ( will appear on screen, but both will be in the printed play.
12541 This environment is only used within
12556 What the Speaker says.
12567 The curtain comes down.
12601 \added_space_top bigskip \noindent
12604 Revtex\SpecialChar ~
12607 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12608 \begin_inset Formula $\beta$
12611 release of May, 1999) class.
12618 textclass, which works with RevTeX 3.1.
12619 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12620 That means that it doesn't interact very well with LyX, which requires
12621 LaTeX2e, although it has been kludged to work.
12622 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
12625 RevTeX\SpecialChar ~
12628 textclass should also be pretty easy to use.
12631 These documents are supposed to be used in
12635 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
12636 macros, and assume you'll know what to put in the preamble if necessary.
12642 All you need to do is install RevTeX 4, as described in the package's README
12644 the package can be found at
12645 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
12650 Install it somewhere that LaTeX can see it.
12651 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
12652 (i.e., not the directory where you installed the class file.) Then, if you
12653 reconfigure LyX, it will find the class file and let you use the RevTeX4
12657 Probably the easiest way to get started is either to import a RevTeX 4 document
12664 Revtex\SpecialChar ~
12667 template, found in the templates directory.
12673 Optional arguments to
12680 \begin_inset Quotes eld
12684 \begin_inset Quotes erd
12688 \begin_inset Quotes eld
12692 \begin_inset Quotes erd
12706 Document\SpecialChar ~
12710 Remember that in RevTeX, at least one optional argument is required!
12713 Other preamble matter, like
12722 Latex\SpecialChar ~
12725 dialog, also as usual.
12731 The layouts basically correspond to the commands in RevTeX4.0.
12732 For example, the Email layout corresponds to
12739 Note that (at least as of RevTeX 4.0 Beta), the
12747 layouts are exactly equivalent, so you shouldn't need to use both.
12753 In case you're curious, both were included so that
12757 would be able to translate both
12778 There are a couple of important unique aspects of RevTeX 4 which might cause
12779 bugs that will be even more confusing in LyX.
12799 The LyX equivalent is that there is a separate Thanks layout.
12804 write footnotes in the
12808 layout, or weird things may happen.
12809 See the RevTeX 4 documentation for more details.
12814 Author\SpecialChar ~
12819 Author\SpecialChar ~
12826 layouts must be placed
12834 layout and the corresponding
12851 , the LaTeX won't compile.
12857 The main problem with this layout is that you can't use the optional arguments
12858 to layouts like Email and Title.
12859 (The problem is not unique to this layout; you can't use optional arguments
12860 to the Section layouts either.) This means that after you export that file
12861 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
12862 need to edit the LaTeX file with a text editor to add the optional arguments
12863 to set, e.g., the running title for the page headers.
12864 Lacking these layouts makes the
12870 (and the equivalent
12876 ) useless, so the corresponding layouts don't exist, and will have to be
12887 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
12888 has not been updated yet to take advantage of it.
12894 Article (mwart), book (mwbk) and report (mwrep)
12895 \begin_inset OptArg
12915 The LyX document classes
12931 correspond to the LaTeX document classes
12944 They are replacements for the standard document classes
12956 , resp., and fit better to Polish typography conventions in a number of points.
12963 Unnumbered titles (with star, eg.
12968 ) are added into table of contents,
12971 Additional page styles:
12973 \layout Description
12975 uheadings header with separated lines,
12976 \layout Description
12978 myheadings custom header, contents headers via commands:
12991 \layout Description
12993 myuheadings custom header with separated lines,
12994 \layout Description
12996 outer page number is placed on outer side of page
13002 \layout Description
13004 rmheadings serif titles --- default,
13005 \layout Description
13007 sfheadings sansserif titles,
13008 \layout Description
13010 authortitle on title page first placed is author next title --- default,
13011 \layout Description
13013 titleauthor on title page first placed is title next author,
13014 \layout Description
13016 withmarginpar reserve place on page for margins.
13028 Elsevier Science Publishers B.V.
13029 provides a standard LaTeX document class (
13033 ) for submitting articles to their various journals.
13034 The style file can be downloaded directly from their web site:
13035 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
13040 Instructions are supplied along with the class file, which details the
13041 requirements of the publishers.
13042 LyX includes package that allows for the use of this class, by a layout
13043 and a template file.
13044 Installation of the class file is the same as for any other LaTeX package;
13045 instructions are provided in the Elsevier documentation.
13057 As the Elsevier class file is based mainly on the standard article class,
13058 most of the normal functionality is provided.
13059 The Elsevier class defines a number of mathematical environments, which
13060 are similar to the AMS environments.
13061 These commands are all described in the Elsevier documentation, and are
13065 The easiest way to use the Elsevier style is to base documents on the included
13067 It is best not to use options such as fancy headings or the geometry package,
13068 as elements such as these are defined by Elsevier in their style file.
13069 Ideally, no extra packages except those mentioned in the Elsevier documentation
13071 Essentially, Elsevier require as
13072 \begin_inset Quotes eld
13076 \begin_inset Quotes erd
13089 file as possible, as their intention is to take the supplied file and replace
13090 the class file with one for the particular journal to which the paper has
13092 This also means that not too much time should be spent on the formating
13094 When it comes to be published, this will change anyway.
13095 The rest of the usage for this layout is substantially the same as for
13096 the normal article class.
13097 For details of what Elsevier do and don't allow, refer to their documentation.
13105 Jürgen Spitzmüller
13111 Memoir is a very powerful and constantly evolving class.
13112 It has been designed with regard to fictional and non-fictional literature.
13113 Its aim is to let the user have maximum control over the typesetting of
13115 Memoir is based on the standard book class, but it can also emulate the
13116 article class (see below).
13119 Peter Wilson, the developer of Memoir, is known as the author of lots of
13120 useful packages in the LaTeX world.
13121 Most of them have been merged with Memoir.
13122 Therefore, it is much easier to layout the table of contents, appendices,
13123 chapter designs and such.
13124 LyX, though, does not support all of these goodies natively.
13125 Some of them might be added to forthcoming releases
13131 You are invited to send suggestions to
13132 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
13139 , lots will probably never, due to the limitations of LyX's framework.
13140 Of course you can still use all features with the help of some native LaTeX
13157 section\SpecialChar ~
13159 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
13167 In this section, we can only list those features which are natively supported
13169 For detailed descriptions (and for the rest of features) we are recommending
13170 to have a look at the detailed manual of the Memoir class
13187 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
13194 , which is not only a user guide for the class, but also both a comprehensive
13195 description on good typesetting and a superb example for good typesetting
13199 Basic features and restrictions
13202 Memoir supports basically all features of the standard book classes.
13203 There are, however, some differences, as follows:
13204 \layout Description
13207 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
13209 \layout Description
13212 style: The fancy page style is not supported, due to a command clash
13213 between Memoir and the fancyhdr package (they are both defining a command
13214 with the same name, which confuses LaTeX).
13215 Instead, Memoir comes with a bunch of own page styles (see
13217 Layout\SpecialChar \menuseparator
13218 Document\SpecialChar \menuseparator
13223 If you want to use these for the chapter pages, you have to use the command
13230 in the main text or in preamble (e.
13254 chapterstyle{companion}
13257 \layout Description
13259 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13260 an optional argument in the standard classes.
13261 With this, you can specify an alternative version of the title for the
13262 table of contents and the headers (for instance, if the title is too long).
13263 In LyX, you can do this via
13265 Insert\SpecialChar \menuseparator
13266 Short\SpecialChar ~
13269 at the beginning of a chapter/section.
13270 Memoir features a second optional argument and thus separates the table
13271 of contents from the header.
13272 You can define three variants of a title with this: one for the main text,
13273 one for the table of contents, and one for the headers.
13274 Unfortunately, LyX does not support two optional arguments yet.
13275 But you can fool it.
13276 Just insert a pair of brackets in ERT-Mode (
13280 ) between the first and the second argument.
13283 <short title for the toc>
13291 <short title for the headers>
13293 in the Short Title inset (where
13298 \layout Description
13300 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13301 of contents, the list of figures and the list of table start a new page
13303 Memoir does not follow this route.
13304 You have to insert a page break yourself, if you want to have one.
13305 \layout Description
13307 Titlepage: For some unknown reason, Memoir uses pagination on the title
13308 page (in the standard classes, title pages are
13309 \begin_inset Quotes eld
13313 \begin_inset Quotes erd
13337 If you want an empty title page, type
13341 aliaspagestyle{title}{empty}
13344 \layout Description
13346 Article: With the class option
13352 Layout\SpecialChar \menuseparator
13353 Document\SpecialChar \menuseparator
13354 Extra\SpecialChar ~
13357 ), you can emulate article style.
13358 That is, counters (footnotes, figures, tables etc.) will not be reset on
13359 new chapters, chapters don't start a new page (but are---in contrary to
13361 \begin_inset Quotes eld
13365 \begin_inset Quotes erd
13368 article classes---still allowed), parts, though, use their own page, as
13370 \layout Description
13372 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13373 font commands, which have been used in the old LaTeX version 2.09 (e.
13406 It produces an error and stops LaTeX whenever such a command appears.
13411 reallows the commands and spits out warnings instead (which does at least
13413 Since a lot of packages and particularly BibTeX style files are still using
13414 those commands, we have decided to use this option by default.
13420 We will only describe the features supported by LyX (which is not much currently
13422 Please consult the Memoir manual
13439 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
13447 \layout Description
13449 Abstract: You may wonder why an abstract is an extra feature.
13450 Well, it is in book class.
13451 Usually books don't have abstracts.
13452 Memoir, however, has.
13453 You can use it whereever and how often you like.
13454 \layout Description
13456 Chapterprecis: You may know this from belletristic: The contents of a chapter
13457 is shortly described below the title and also in the table of contents
13480 Our hero arrives in Troia; he loses some friends; he finds others
13483 Chapterprecis does exactly this.
13484 It is therefore only sensible below a chapter.
13485 \layout Description
13487 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13488 The epigraph environment provides an elegant way of typesetting such a
13490 The motto itself (text) and its author (source) are divided by a short
13492 Unfortunately, we have to fool LyX a bit here again, since the environment
13493 needs two arguments (text and source).
13494 In this case, we have to use curly brackets (in TeX mode) between the two
13505 <author of the slogan>.
13506 \layout Description
13508 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13509 complex figurative poems).
13510 Lyx can only support a few of them.
13511 One is poemtitle, which is a centered title for poems, which will also
13512 be added to the table of contents (verse is the standard environment for
13514 Memoir has some enhanced versions of verse, but you need to use ERT, because
13515 they have to be nested inside regular verse environments, which is not
13516 possible with LyX).
13517 \layout Description
13519 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13522 Importing and Exporting Alternate File Formats
13523 \begin_inset OptArg
13528 Importing and Exporting
13537 Importing and exporting LyX documents from/to other formats has been touched
13543 Here we describe more of the gory details needed to understand just what
13544 is going on when you click on the
13549 ile\SpecialChar \menuseparator
13561 ile\SpecialChar \menuseparator
13572 Importing Other Formats
13578 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
13579 Although it is a standalone program which can be called from the command
13580 line, LyX will call it automatically when a LaTeX document is imported.
13581 See section\SpecialChar ~
13583 \begin_inset LatexCommand \ref{sec:reLyX}
13587 for a complete description.
13588 There are no user tunable parameters for reLyX within LyX.
13594 When importing plain ASCII text, there are two methods of reading the file.
13596 \begin_inset Quotes eld
13600 \begin_inset Quotes erd
13603 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
13606 \begin_inset Quotes eld
13610 \begin_inset Quotes erd
13613 assumes that consecutive lines separated by only a single linebreak form
13614 a single paragraph.
13615 Successive linebreaks with no intervening text are thus assumed to be paragraph
13624 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
13627 Exporting Other Formats
13633 LyX generates two types of LaTeX files: stripped down versions for the normal
13638 , etc.) which one normally never sees
13644 The resulting file is a perfectly valid LaTeX file, though the preamble
13645 might look a bit strange since it includes some definitions used by LyX
13646 which wouldn't show up in most human-written files.
13649 , and human readable forms which are suitable for exchanging with your colleague
13651 The only settable option for the translation is the line length of the
13653 The default is 65 characters, but it can be set in
13660 \SpecialChar \menuseparator
13681 Device Independent Files
13684 Device Independent files (DVI files) are produced by running LaTeX on your
13686 There are no user settable options.
13692 The next step in the conversion chain is converting a DVI file into Postscript®.
13700 \SpecialChar \menuseparator
13708 \SpecialChar \menuseparator
13717 or, if you need more control on the result,
13724 \SpecialChar \menuseparator
13733 If you use the later, note that it is possible to configure, in
13740 \SpecialChar \menuseparator
13748 , the options passed to the dvips program to achieve different effects.
13754 Exporting as ASCII attempts to preserve the
13755 \begin_inset Quotes eld
13759 \begin_inset Quotes erd
13762 of the document as well as possible, but things like centering and indentation
13763 are thrown out; paragraphs are separated by blank lines.
13764 Section numbering and cross-references are done correctly, so the resulting
13765 text files is remarkably readable.
13766 The only changeable option is the length of lines, as for LaTeX output.
13772 LyX documents can be converted to hypertext markup, usually by converting
13773 to LaTeX first, then converting that to HTML\SpecialChar \@.
13775 \begin_inset Formula $\rightarrow$
13778 HTML converters are currently known to LyX:
13791 Though they are autodetected, you can overide the selection in preferences.
13792 You can also include further command line options in this dialog.
13798 \added_space_bottom bigskip
13806 The fastest way to generate a basic PDF file (no tags, links, etc.) with
13807 any version of LyX is to save the document as a Postscript® file, then
13813 Starting with version 1.1.6, the menu item
13817 will do all this for you.
13818 There are some issues with fonts that you need to pay attention to: see
13819 Section\SpecialChar ~
13821 \begin_inset LatexCommand \ref{sec:badfonts}
13826 Also, as of version 1.1.6, there is a better method that will generate much
13827 more sophisticated files.
13828 \layout Subsubsection
13833 With pdfLaTeX you need to convert your eps figures to PDF (see Section\SpecialChar ~
13835 \begin_inset LatexCommand \ref{sec:pdfeps}
13839 ), and you cannot use pstricks.
13840 On the other hand, with pdfLaTeX it is possible to insert directly images
13841 in JPEG or PNG format, use TrueType fonts, and more.
13842 \layout Subsubsection
13844 Why does the text look so bad when viewed with Acrobat Reader?
13845 \begin_inset LatexCommand \label{sec:badfonts}
13850 \begin_inset OptArg
13855 Bad Fonts in Acrobat Reader
13861 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
13862 When creating a PDF from the LyX file, you need to use outline font instead
13863 of the default bitmap fonts (in fact, you should also use outline fonts
13864 for Postscript files).
13865 Recent LaTeX distributions come with Postscript® Type 1 version of the
13866 standard (Computer Modern) fonts.
13867 pdfLaTeX uses these font by default.
13868 Dvips doesn't use these fonts by default, so to make it use them, add the
13869 following to lines to your
13882 If the default LaTeX font encoding (OT1) is used, nothing else need to be
13884 However, if the T1 font encoding is used, then LaTeX uses the newer EC
13885 fonts, for which there are no Type1 version.
13886 The solution is to use the ae package which emulates T1 coded fonts using
13887 the standard CM fonts.
13888 This is done by adding
13892 usepackage{ae,aecompl}
13894 to the preamble of the LyX file.
13895 However, some glyphs are missing from the CM fonts (e.g.
13896 eth, thorn), and they are taken from the EC fonts.
13897 Therefore you get these glyphs as bitmaps.
13900 Note: LyX uses by default the T1 font encoding.
13901 If you wish to use the default font encoding (this is not recommended,
13902 unless you only write English documents), clear the field
13910 in preferences (tabs
13922 An alternate option is to use the standard Postscript® fonts instead of
13923 the Computer Modern fonts.
13924 To do that, you need to select
13928 as the global font in the document layout dialog.
13929 When using the Postscript® fonts, the result PDF file is smaller as the
13930 fonts are not saved into the file.
13931 Furthermore, the Postscript® fonts include all T1 glyphs.
13932 On the other hand, the Postscript® fonts have no bold symbol font, so poor
13933 man's bold must be used (see Section\SpecialChar ~
13935 \begin_inset LatexCommand \ref{sec:pdfbold}
13940 The Postscript® fonts also look different from the Computer Modern fonts.
13943 To sum up, both the Computer Modern and the Postscript® fonts gives good
13944 results (with few exceptions).
13945 The decision of which one to use is a matter of taste.
13946 \layout Subsubsection
13950 boldsymbol{} command work when I use pslatex?
13951 \begin_inset LatexCommand \label{sec:pdfbold}
13956 \begin_inset OptArg
13975 The Postscript® fonts do not have a bold symbol font.
13976 The solution is to use the
13982 (poor man's bold) command.
13985 It is possible to redefine the
14010 \layout Subsubsection
14012 Is it possible to do write latex code which is processed only when running
14014 \begin_inset OptArg
14019 Conditionals with pdfLaTeX
14026 Here is an example:
14074 pdfinfo { /Author (your name and e-mail address)
14077 /Title (official title -- i.e., title element)
14080 /Subject (one line description of the document)
14088 pdfcatalog { /PageMode (/UseNone)
14091 % /OpenAction (fitbh)
14099 usepackage[pdftex]{hyperref}
14109 usepackage[ps2pdf]{hyperref}
14115 \layout Subsubsection
14117 How can I make URLs clickable ?
14120 See the references here :
14124 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
14134 Custom exports are possible if you have some particularly weird format you
14135 wish to convert to, assuming you have the relevant converter, of course.
14140 file can be chosen in the
14145 ile\SpecialChar \menuseparator
14150 xport\SpecialChar \menuseparator
14157 dialog; LyX will automatically convert the file to this point, then feed
14158 it to your custom converter.
14159 The possible values are all formats that LyX can produce from its own documents.
14163 The converter command is also specified in the dialog.It should be a completely
14164 qualified command line which uses the variable
14168 to specify the name of the file.
14169 If this variable is not given, then the file will be sent to the standard
14170 input of your command.
14171 You may have to apply a bit of ingenuity to escape this sequence correctly
14172 so that it is compatible with your shell.
14176 While it is not possible to save this command using the
14180 dialog, you can manually edit your
14189 custom_export_command "mycommand $$FName"
14192 The Complete reLyX Description
14193 \begin_inset LatexCommand \label{sec:reLyX}
14203 The simplest way to use reLyX is via the
14208 ile\SpecialChar \menuseparator
14216 That runs reLyX on the given file and loads the resulting file into LyX.
14217 You should try that first, and call it from the command line only if you
14218 need to use more complicated options.
14337 \layout Description
14344 By default, when reLyX sees a
14350 command, it creates a file of textclass
14351 \begin_inset Quotes eld
14355 \begin_inset Quotes erd
14358 and reads the LyX layout file for that class.
14363 to declare a different textclass (and read a different layout file).
14364 \layout Description
14371 By default, reLyX gives sparse output and deletes the temporary files which
14372 were created during translation.
14377 flag will create much more output (both to stdout and stderr) and leave
14378 the temporary files around.
14379 \layout Description
14386 reLyX will not run if the
14390 file it would generate already exists Use the
14394 option (carefully) to clobber any existing files.
14395 \layout Description
14402 Print out usage information and quit
14403 \layout Description
14410 With this option, all temporary files and LyX output files (for the given
14411 input file, for any included files, or for any file fragments given with
14416 option) will be put into
14421 Otherwise, for each file
14425 , the temporary files and the LyX output file will be created in
14430 This can be useful if a file includes files from other directories which
14431 you want to consolidate in one directory, or if you don't have write permission
14432 on the directory the LaTeX files are in.
14433 \layout Description
14440 The input files are LaTeX fragments, with no preamble matter or
14447 This option requires the
14451 option, since there are no
14457 commands in the files reLyX is translating.
14458 When using this option, you can translate more than one file, as long as
14459 all files are the same class.
14460 The LyX file created by reLyX can be included in an existing LyX file using
14466 nsert\SpecialChar \menuseparator
14471 \SpecialChar \menuseparator
14480 \layout Description
14486 Regular environments (see the Section\SpecialChar ~
14488 \begin_inset LatexCommand \ref{sub:relyx-syntax}
14493 If you give more than one environment, separate them with commas (not
14495 You'll probably need to quote the environment list, especially if it has
14496 asterisk environments (foo*) in it.
14497 If you use this command often, considering creating a personal syntax file.
14498 \layout Description
14505 Input (one or more quoted, comma-separated) syntax files to read in addition
14507 (see the section Section\SpecialChar ~
14509 \begin_inset LatexCommand \ref{sub:relyx-syntax}
14517 \layout Subsubsection
14522 reLyX will create a LyX file
14526 from the LaTeX file
14554 does not exist and does not have one of these suffixes, reLyX will try
14560 (This is similar to the behavior of LaTeX.)
14563 The purpose of reLyX is to translate
14568 If your LaTeX file doesn't compile---or if you do weird things, like redefining
14569 standard LaTeX commands---it may choke.
14570 LaTeX209 will often be translated correctly, but it's not guaranteed.
14573 reLyX has some bugs and lacks a few features.
14574 However, its main goals are:
14577 Get through a well-behaved LaTeX2e file without crashing
14580 Translate a lot of that file.
14583 Localize the parts that can't be translated and copy them in TeX mode
14586 It achieves these main goals pretty well on most files.
14589 There are many improvements that can and will be made to reLyX in the future.
14590 However, we wanted to get reLyX out there early on, to make it easier for
14591 new LyX users to read in their existing LaTeX files.
14592 \layout Subsubsection
14597 Here's a more lengthy description of what you should do to translate a LaTeX
14605 reLyX will inform you of its progress and give any warnings to stderr, so
14606 if you don't want any output at all, try (in csh)
14607 \begin_inset Quotes eld
14612 reLyX foo.tex >& /dev/null
14615 \begin_inset Quotes erd
14619 \begin_inset Quotes eld
14631 \begin_inset Quotes erd
14635 You should NOT redirect standard output to
14644 Run LyX on the resulting .lyx file.
14648 In theory, most of the file will have been translated, and anything that's
14649 untranslatable will be highlighted in red (TeX mode).
14650 In theory, LyX will be able to read in the file, and to create printed
14651 documents from it, because all that untranslated red stuff will be passed
14652 directly back to LaTeX, which LyX uses as a backend.
14653 Unfortunately, reality doesn't always reflect theory.
14654 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\SpecialChar ~
14656 \begin_inset LatexCommand \ref{sub:relyx-bugs}
14668 Change things that are in ERT boxes (TeX code) by hand in LyX.
14672 As mentioned above, you should be able to print out the LyX file even without
14674 However, changing a command in TeX mode to the corresponding LyX object
14675 will allow you to take advantage of LyX's WYSIWYM editing.
14678 reLyX is not guaranteed to create a LyX file which generates exactly the
14679 same output as the LaTeX file, but it should come close.
14680 reLyX will generally err on the side of translating less to ensure that
14681 dvi or ps files are accurate, even though this leads to more
14682 \begin_inset Quotes eld
14686 \begin_inset Quotes erd
14693 PROOFREAD THE DOCUMENT!!
14697 I'm sure you were planning on doing this anyway, but it's particularly important
14698 after translating a LaTeX document.
14699 reLyX is, at least now, better at
14700 \begin_inset Quotes eld
14704 \begin_inset Quotes erd
14707 (translating the whole document) than
14708 \begin_inset Quotes eld
14712 \begin_inset Quotes erd
14715 (translating every little detail).
14716 For example, you may see extra spaces or deleted spaces.
14717 Space handling has improved, but it's not perfect.
14719 \layout Subsubsection
14721 What reLyX Can Handle
14724 reLyX understands many LaTeX commands.
14728 regular text, including mini-commands like ~, '',
14740 , as well as accented characters like
14746 , and the special cases ?` and !`
14749 title commands like
14773 and the abstract environment
14776 heading commands like
14782 including starred commands (
14828 environments, and their
14835 Also, well-behaved nested lists
14838 cross-referencing commands:
14876 font-changing commands including
14894 , and corresponding commands to change family, size, series, and shape
14923 \begin_inset Quotes erd
14933 \begin_inset Quotes erd
14943 environment, and commands that go inside it like
14978 commands within them
14991 command, as well as BibTeX's
15006 miscellaneous commands:
15035 documentclass-specific environments (and some commands) which can be translated
15039 arguments to certain untranslatable commands (e.g.
15049 Some of this support may not be 100% yet.
15050 See below for details
15053 reLyX copies math (almost) verbatim from your LaTeX file.
15054 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
15055 by LyX should work just fine.
15056 A few math commands which are not supported by LyX will be replaced with
15057 their equivalents, e.g.,
15077 reLyX will also copy any preamble commands (i.e., anything before
15083 ) verbatim, so fancy stuff you've got in your preamble should be conserved
15084 in dvi and printed documents, although it will not of course show up in
15086 Check the preamble to make sure.
15087 \layout Subsubsection
15089 What reLyX Can't Handle --- But it's OK
15153 reLyX is careful to copy
15157 in this case, including comments and whitespace.
15160 some unknown (e.g., user-defined) environments and commands
15163 reLyX copies unknown commands, along with their arguments, verbatim into
15171 where it doesn't recognize the
15172 \begin_inset Quotes eld
15176 \begin_inset Quotes erd
15179 environment, it will copy verbatim until it sees
15185 (unless you use the
15190 Hopefully, then, most of these unknown commands won't cause reLyX to break;
15191 they'll merely require you to do some editing once you've loaded the file
15193 That should be less painful than editing either the
15201 file using a text editor.
15202 \layout Subsubsection
15204 What reLyX Handles Badly --- a.\SpecialChar ~
15208 \begin_inset LatexCommand \label{sub:relyx-bugs}
15215 Since reLyX is relatively new, it's got a number of problems.
15216 As it matures, these bugs will be squished.
15217 A number of bugs and missing features can be found listed on the LyX bug
15219 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
15226 If reLyX is choking on something, or LyX can't read it after reLyX translates
15227 it, the best thing to do is to put
15233 before the offending text, and
15241 \begin_inset Quotes eld
15245 \begin_inset Quotes erd
15249 reLyX will copy this block exactly, in TeX mode.
15250 Then edit the resulting LyX file, and translate the unknown stuff by hand.
15255 environment is magical; the
15267 commands will not be put into the LyX file.
15271 \begin_inset Quotes eld
15275 \begin_inset Quotes erd
15278 copying of unknown environments and commands isn't quite exact.
15279 Specifically, newlines and comments may be lost.
15280 This will yield ugly LyX, but in almost all cases the output will be the
15282 However, certain parts of the file will be copied perfectly, including
15283 whitespace and comments.
15284 This includes: the LaTeX preamble,
15294 commands, and skip blocks.
15297 reLyX translates only a few options to the
15304 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
15305 landscape, and [one|two]column.) Other options are placed in the extra class
15306 options field in the
15311 ocument\SpecialChar \menuseparator
15322 More importantly, reLyX doesn't translate
15328 commands, margin commands,
15334 s, or, in fact, anything else from the preamble.
15335 It simply copies them into the LaTeX preamble.
15336 If you have margin commands in your preamble, then the LyX file will generate
15338 However, these margins will override any margins you set in the LyX
15345 \SpecialChar \menuseparator
15351 So you should remove the options from the preamble to be safe.
15352 The same goes for setting your language with babel,
15368 The foil class has a couple bugs.
15369 reLyX may do weird things with optional arguments to
15376 Also, it may handle
15382 incorrectly (although the stuff in the environment should translate normally).
15385 reLyX is hopefully rather robust.
15386 As mentioned above, it may not translate your file perfectly, but it shouldn't
15388 If it does crash---and the problem is not one of those mentioned above
15393 file---see Section\SpecialChar ~
15395 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
15400 \layout Subsubsection
15402 What LyX Can't Handle
15405 LyX itself is missing a couple features, such that even if reLyX translates
15406 things perfectly, LyX may still have trouble reading it.
15407 If you really need these features, you can export your final document as
15408 LaTeX, and put them back in.
15413 for more details on these bugs.
15416 For a number of commands, LyX does not support the optional argument.
15429 (and other sectioning commands), and
15438 reLyX will automatically discard the optional arguments with a warning
15440 LyX also ignores the width argument for the
15447 Centering (or right or left justifying) works on full paragraphs.
15450 LyX support for tables isn't perfect.
15451 For complicated tables, use a
15452 \begin_inset Quotes eld
15456 \begin_inset Quotes erd
15459 block, so that they will be copied in TeX mode.
15462 The LyX math editor can't handle the AMS-LaTeX math environments align,
15464 So those environments will be copied in TeX mode.
15469 environments to the exactly equivalent displaymath, and then they will
15470 be translated correctly.
15479 \begin_inset Quotes eld
15483 \begin_inset Quotes erd
15487 \begin_inset Quotes eld
15491 \begin_inset Quotes erd
15494 foo.tex > foo.debug
15497 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
15507 block, it will translate the stuff within the block, but copy the
15519 commands in TeX mode.
15520 Finally, I'm going to keep the temporary files around (they will also
15521 be in my/dir/) and output lots of debugging information into the file foo.debug.
15525 \layout Subsubsection
15528 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
15535 If reLyX is crashing or otherwise acting strangely---in ways other than
15536 those described in Section\SpecialChar ~
15538 \begin_inset LatexCommand \ref{sub:relyx-bugs}
15542 or the bug tracker---then please run reLyX
15547 That will allow you to figure out where in the reLyXing process it crashed.
15548 That, in turn, will allow you to write a better bug report, which will
15549 allow the developers to fix it more quickly and easily.
15552 Bug reports should be sent to the LyX developers' mailing list.
15553 Its address is currently
15555 lyx-devel@lists.lyx.org
15558 If you are running reLyX on a huge file, please do not send all of the
15559 output in your bug report.
15560 Just include the last ten or twenty lines of output, along with the piece
15561 of the LaTeX file it crashed on.
15562 Or, even better, attach a small but complete file which causes the same
15563 problem as your original file.
15564 \layout Subsubsection
15566 Implementation Details:
15569 reLyX makes several
15570 \begin_inset Quotes eld
15574 \begin_inset Quotes erd
15577 in order to translate a TeX file.
15578 On each pass, it creates one or two files.
15579 \layout Description
15585 Before doing anything, read the syntax file (or files).
15586 \layout Description
15592 Split preamble (anything before a
15598 command) off the rest of the file.
15599 It saves the two pieces in separate files.
15600 This is necessary because there may be very strange stuff in a preamble.
15601 It also ignores anything after the
15607 , on the assumption that it isn't LaTeX.
15608 \layout Description
15614 Translate the preamble.
15615 Currently, that just means translating the
15621 command and copying the rest exactly into the LyX preamble.
15625 Once you know what class the document is, read the LyX layout file for that
15628 \layout Description
15635 \begin_inset Quotes eld
15639 \begin_inset Quotes erd
15642 the TeX file, generating slightly stricter LaTeX.
15651 to the equivalent but clearer
15656 Removing optional arguments that LyX can't handle (e.g., from
15678 This is necessary because LyX always writes out the non-local forms anyway.
15679 This should very rarely make a difference.
15681 \layout Description
15687 Translate LaTeX text, commands, and environments to LyX.
15688 \layout Description
15694 Put the two pieces back together, and do some final tweaking, to generate
15710 commands, reLyX will loop back to the beginning and translate those.
15711 It assumes that the included files are the same class as the main file,
15712 and that they have no preamble matter.
15719 command in the preamble of a file, the command will be copied exactly into
15720 the LaTeX preamble portion of the LyX file, so the included file won't
15721 be translated.) So when translating included files, it skips passes 0 and
15725 If reLyX doesn't find a file you wanted to include, it will give a warning,
15726 but will continue to translate any files it does find.
15727 \layout Subsubsection
15732 reLyX reads a LyX layout file to know how to handle LaTeX environments and
15733 commands which get translated to LyX layouts.
15734 This file will include all
15735 \begin_inset Quotes eld
15739 \begin_inset Quotes erd
15742 non-math environments (i.e., including quote and itemize, but not tabular,
15743 minipage, and some other fancy environments), and commands like
15756 If you want to reLyX a class that doesn't have an existing layout file,
15757 then you'll have to create a layout file.
15758 But you have to do this anyway, in order to LyX the file, since LyX depends
15759 on layout files to know how to display and process its files.
15760 Check the LyX documentation for help with this task (which can be hard
15761 or easy, depending on the class you want to create a layout file for.) If
15762 your class is quite similar to a class that has a layout file, then consider
15768 \layout Subsubsection
15771 \begin_inset LatexCommand \label{sub:relyx-syntax}
15778 reLyX always reads at least one syntax file, called the default syntax file.
15779 reLyX will read your personal syntax file if it exists; otherwise it will
15780 read the system-wide file.
15781 reLyX will read additional syntax files if you specify them with the
15786 (These extra files should have the same format as the default file, but
15787 will tend to be shorter, since they only have to specify extra commands
15788 not found in the default file.) A syntax file tells reLyX a few things.
15791 First, it describes the syntax of each command, that is, how many required
15792 arguments and how many optional arguments the command takes.
15793 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
15794 it doesn't know how to translate.
15795 The syntax file simply has a command, followed by braces or brackets describing
15796 its arguments in the correct order.
15797 For example, a syntax file entry
15809 command takes an optional argument followed by a required one, while the
15822 command takes no arguments at all.
15823 When reLyX encounters a token that it doesn't know how to translate into
15824 LyX, it will copy the token---along with the correct number of arguments---exac
15826 If the token is not in the syntax file, then reLyX just copies as many
15827 arguments as it finds.
15828 This means that it may copy too much.
15829 But since the user can specify additional syntax files, that shouldn't
15833 Some commands that cannot be translated to LyX, like
15839 , have as one of their arguments regular LaTeX text.
15841 \begin_inset Quotes eld
15845 \begin_inset Quotes erd
15848 is put into an argument of an (untranslatable) command in the syntax file,
15849 then reLyX will translate that argument instead of copying it verbatim.
15850 So, for example, the default syntax file has
15854 raisebox{}[][]{translate}
15857 This means that the
15863 command and the first argument (and optional arguments if they exist) are
15864 copied in TeX mode, but the last argument (which may contain math, complicated
15865 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
15867 \begin_inset Quotes eld
15871 \begin_inset Quotes erd
15874 on optional arguments.
15877 User-defined syntax files are allowed to define new commands and their syntax,
15878 or override the number of arguments for a command given in the default
15880 (E.g., if you're using a style that gives an extra argument to some command...)
15881 However, this will only be useful for commands copied in TeX mode.
15882 Commands which are actually translated by reLyX (like
15888 ) have their argument syntax hard-coded.
15889 The hard-coded commands are identified in the default syntax file.
15892 Second, the syntax file describes any
15893 \begin_inset Quotes eld
15896 regular environments
15897 \begin_inset Quotes erd
15901 Usually, an entire unknown environment will be copied in TeX mode.
15902 If you define a regular environment
15903 \begin_inset Quotes eld
15907 \begin_inset Quotes erd
15910 , though, then only the
15922 commands will be copied in TeX mode; the text within the environment will
15923 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
15924 copied into TeX mode.
15925 Don't try to declare
15933 as regular environments, as the text within those environments will confuse
15934 reLyX; use this capability for new environments you create that have plain
15935 text or math or simple commands in them.
15936 You also can't declare unknown math environments (like
15940 ) as regular environments, either, since the LyX math editor won't understand
15942 The names of regular environments appear, whitespace-separated, between
15955 statements in the syntax file.
15956 (If you have a regular environment which you won't use very often, you
15961 option rather than writing a syntax file.)
15964 Third, the syntax file describes a math translation table.
15965 The LyX math editor doesn't support a few commands.
15970 is supported, but the equivalent
15977 Put any commands you'd like translate between
15991 \begin_inset Quotes eld
16003 \begin_inset Quotes erd
16012 in math mode will be converted to
16013 \begin_inset Quotes eld
16023 \begin_inset Quotes erd
16030 (in cases where a token made up of a backslash and a non-letter is translated
16031 to something with letters at the end, a space is added by reLyX.
16033 \begin_inset Quotes eld
16043 \begin_inset Quotes erd
16046 is correctly translated to
16047 \begin_inset Quotes eld
16057 \begin_inset Quotes erd
16061 \layout Subsubsection
16066 You need Perl version 5.002 or later to run reLyX.
16067 <plug> If you don't have Perl, you should get it anyway (at
16068 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
16072 ), because it's a really useful tool for pretty much anything.
16079 reLyX should always explain why it crashes, if it crashes.
16080 Some diagnostics may be very technical, though, if they come from the guts
16082 reLyX gives much more information while running if you use the
16086 option, but you shouldn't need that unless something goes wrong.
16089 When it's finished, reLyX will tell you if it finished successfully or died
16096 Always keep a copy of your original LaTeX files either under a different
16097 name or in a different directory.
16098 There are a couple ways in which using LyX could lead to overwriting the
16099 original LaTeX file.
16114 and want to re-export it, note that it will overwrite the original
16123 ask you if you want to overwrite it.)
16126 If you have chosen not to use a temporary directory in the preferences,
16127 then LyX will create its temporary files in your current directory, which
16128 means your LaTeX original may be overwritten (without a warning from LyX)
16130 \begin_inset Quotes eld
16134 \begin_inset Quotes erd
16137 or print the LyX document.
16141 \layout Description
16146 MY_LYXDIR/layouts/*.layout
16152 User's personal layout files for document classes
16153 \layout Description
16158 MY_LYXDIR/reLyX/syntax.default
16164 User's personal syntax file
16165 \layout Description
16170 LIBDIR/layouts/*.layout
16176 System-wide layout files for document classes
16177 \layout Description
16182 LIBDIR/reLyX/syntax.default
16188 System-wide LaTeX syntax file
16195 is the system-wide LyX directory, usually something like
16197 /usr/local/share/lyx/
16204 is your personal LyX directory, something like
16208 in your home directory.
16209 You can see their actual values in the
16214 elp\SpecialChar \menuseparator
16215 About\SpecialChar ~
16241 Copyright (c) 1998--9
16247 karger@voth.chem.utah.edu
16259 wrote the original CleanTeX pass.
16276 David Suarez de Lis
16279 Other contributors:
16284 Jean-Marc Lasgouttes
16286 worked on the wrapper script and offered lots of bug reports, advice, and
16287 feature suggestions.
16302 Various members of the LyX developers' and users' lists provided bug reports
16303 and feature suggestions.
16306 reLyX uses a modified version the Perl TeX parser
16316 ilya@math.ohio-state.edu
16318 ), available on CPAN.
16321 LyX Features needing Extra Software
16324 Using LyX with SGML-Tools (aka LinuxDoc)
16335 LinuxDoc is a document class available in LyX if you have the
16340 You can use it to produce documents in the so-called Standardized General
16341 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
16343 That is obviously helpful if you are contributing to that project.
16344 You can use the SGML format with the
16348 package of scripts and programs (to produce other formats, including Latex,
16349 HTML, plain text, man pages and\SpecialChar \ldots{}
16351 You may therefore prefer to use this document class if you want to write
16352 something that can be easily translated into other formats.
16355 You will find that LinuxDoc has fewer layout options than the other text
16357 This is mainly so that the translations into other formats have a chance
16358 of making some sense.
16359 In this section we describe:
16362 how to setup and use a document in LinuxDoc
16365 how to use the tags in LinuxDoc to layout your document
16368 how to use the SGML packages to produce the various formats
16371 how to sort out some problems.
16374 Preparing and using a LinuxDoc document
16375 \layout Subsubsection
16380 You start by selecting the LinuxDoc class using the
16385 ocument\SpecialChar \menuseparator
16397 Then you will find that there are fewer paragraph environments than for
16398 most other classes.
16399 You can see them on the pull down box on the left of the tool bar.
16400 How to use them is described in section\SpecialChar ~
16402 \begin_inset LatexCommand \ref{sec:sgmlparas}
16413 enter a title for the document, followed by an author, marking each with
16414 the appropriate paragraph environment.
16415 If you don't do this, you will get errors when you try to print the file.
16416 You can then enter the date and an abstract.
16417 The document proper must start with a Section paragraph environment rather
16418 than any standard layout.
16421 After that you can prepare a document as usual using the available range
16422 of paragraph environments.
16423 See section\SpecialChar ~
16425 \begin_inset LatexCommand \ref{sec:sgmlparas}
16429 for the full list and their uses.
16430 \layout Subsubsection
16432 Output from LinuxDoc
16435 You can print and save these documents in the normal way.
16436 To use the other features of the SGML package you need to save your document
16437 as LinuxDoc; this is a version in which the document is translated into
16438 the basic sgml tags.
16445 ile\SpecialChar \menuseparator
16450 xport\SpecialChar \menuseparator
16458 You will get a file with the same name and a
16462 extension rather than a
16469 \begin_inset LatexCommand \ref{sec:sgmloperate}
16473 on how you than make use of this file.
16476 Using the paragraph environments in LinuxDoc
16477 \layout Subsubsection
16479 The Structure of a LinuxDoc Document
16482 There is a formal structure for LinuxDoc which limits how you can place
16484 There are two parts to all documents:
16485 \layout Description
16487 Header: this is everything up to the first time you insert a Section layout
16489 It can include title, author, date, abstract and ToC.
16490 You must include the first two.
16491 \layout Description
16493 Body: from the beginning of the first section onwards.
16494 All other tags are allowed.
16496 \layout Subsubsection
16498 The LinuxDoc Paragraph Environments
16502 \begin_inset LatexCommand \label{sec:sgmlparas}
16506 Here is a list of all the tags you will find listed on the layout bar in
16507 the order they come there, with some comments where the purpose or use
16515 works as described in [cross reference]
16522 : This will appear at the top left of the document when printed, above a
16523 heavy horizontal rule, although you will not see this on the LyX screen.
16528 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
16530 all do what you would expect and in the usual order.
16531 Whether they are numbered or not is controlled by the
16533 Section\SpecialChar ~
16534 number\SpecialChar ~
16538 You cannot get the equivalent number free versions in any other way; there
16550 As usual this produces a numbered and indented list as described in the
16562 Again much the same as in the other classes: see the
16573 : As explained in the
16578 Remember that if you want the bold element at the start of a description
16579 to be more than one word then you need to put protected spaces between
16593 Code: similar to the Lyx-Code
16602 : Anything you mark with this will appear on the left of the heading of
16603 the document, under the heavy rule.
16610 Anything you mark with this will appear on the right of the heading under
16612 You do not have to make this a date.
16613 Any text can be entered, e.\SpecialChar ~
16622 : You can use this to produce a free standing paragraph after the author
16623 and date, and before the first section.
16624 You are only allowed one such paragraph.
16635 This needs checking ---
16657 I have not yet checked this ---
16663 \layout Subsubsection
16665 Other document features
16668 You can also use the
16672 menu to set fonts or to emphasis words.
16673 You can also use the table of contents as usual; see the corresponding
16679 Although you will find some some other features on the menus e.\SpecialChar ~
16681 inserting footnotes.
16682 There is some doubt about whether these will work correctly.
16692 Again still checking to see whether this is my system
16698 \layout Subsubsection
16700 Cross references and HTML
16707 menu you will find two new options relating to the inclusion of URL addresses.
16708 If you use either option you will find some highlighted TeX code inserted
16709 into your document in three separate blocks with spaces available between.
16710 The blocks will be:
16744 You insert a full HTML tag between the first and second blocks.
16746 \begin_inset LatexCommand \url{http://any.address}
16750 or other valid tags such as
16751 \begin_inset LatexCommand \url{mailto:me@my.address}
16763 insert some description between the second and third blocks.
16764 The differences are:
16771 both the HTML tag and the description will appear in the document
16779 only the description appears in the printed version
16782 Using the LinuxDoc Sgml scripts
16788 This section is completely outdated.
16795 \begin_inset LatexCommand \label{sec:sgmloperate}
16799 You can use LinuxDoc as a text class without any additional scripts or programs,
16800 but there is not much point in doing this.
16801 All you will get is a document that looks like a
16803 Linux Documentation Project Howto
16809 To do the document translation you need to get and install the
16811 sgml-tools-1.0.x.tar.gz
16814 \begin_inset Formula $x\geq3$
16819 the SGML-Tools WWW Page
16827 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
16836 Alternatively, you can go to the
16846 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
16847 has not yet been made available at
16860 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
16873 sgml-tools-1.0.x.tar.gz
16875 contains everything that you need to write SGML documents and convert them
16876 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
16880 This package was renamed from
16882 linuxdoc-sgml-1.5.tar.gz
16887 Follow the instructions in that package on how to install it and how to
16889 All this has to be done outside of LyX, before you can use the
16894 ile\SpecialChar \menuseparator
16899 xport\SpecialChar \menuseparator
16906 Troubleshooting LinuxDoc
16909 When you print or preview a LinuxDoc document some checking is done of the
16910 tags before LaTeX is run.
16911 Some errors are trapped here, especially those concerning the structure
16913 LyX may produce an error message, but not leave an error box in the document
16915 You may have to look at the files directly to discover what is wrong.
16916 Most problems seem to come from the use of options that are not fully available
16938 menu, you'll find a
16947 This feature requires you to have the
16951 program installed, and is grayed out if you don't have it.
16952 You can get it from your nearest CTAN mirror, or over the Web from
16953 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
16964 package is a program that was written by
16969 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16970 and easy to forget.
16971 The program runs over your LaTeX file and checks the integrity of the file,
16972 and flags some common errors.
16973 In other technical words, it is
16980 Well, what is a syntax checker doing in LyX which is supposed to produce
16981 correct LaTeX anyways? The answer is simple: Just as
16985 not only checks the
16989 of C programs, but also does
16993 checks for type-errors,
16997 catches some common
17001 errors, in addition to the syntactical ones.
17006 is capable of detecting several common errors, such as
17009 Ellipsis detection:
17011 Use \SpecialChar \ldots{}
17015 No space in front of/after parenthesis:
17020 Enforcement of normal space after common abbreviations:
17024 is too wide spacing.
17027 Enforcement of end-of-sentence space when the last sentence ends with a
17031 And this is wrong spacing.
17034 Space in front of labels and similar commands:
17036 The label should stick right up to the text to avoid falling to a wrong
17039 \begin_inset LatexCommand \label{sec:chktex}
17049 This footnote is in danger of falling off to a wrong page
17052 The label is separated too much.
17055 Space in front of references, instead of hard spaces:
17057 In you are in bad luck, the text will break right between the referenced
17058 text and reference number, and that's a pity.
17060 \begin_inset LatexCommand \ref{sec:chktex}
17068 \begin_inset Quotes eld
17072 \begin_inset Quotes erd
17076 \begin_inset Formula $\times$
17081 2x2 looks cheap compared to
17082 \begin_inset Formula $2\times2$
17088 and more \SpecialChar \ldots{}
17089 It is an invaluable tool when you are
17090 \begin_inset Quotes eld
17094 \begin_inset Quotes erd
17097 your document before printing, and you should run it right after the obligatory
17098 spelling check, and before you go fine tuning the typesetting.
17104 If you have the program installed, usage is as simple as choosing
17109 ools\SpecialChar \menuseparator
17118 This will make LyX generate a LaTeX file of your document, start
17122 to check it, and then make LyX insert
17123 \begin_inset Quotes eld
17127 \begin_inset Quotes erd
17130 with the warnings from
17134 , if there were any.
17135 The warnings will be placed close to the point of the mistake, and you
17136 can quickly find them by using the
17141 avigate\SpecialChar \menuseparator
17148 menu item, or the shortcut key
17157 Open the error boxes by clicking on them with the mouse, or use the shortcut
17166 bindings, or the corresponding
17175 Read the warning and correct the mistake, if it is a mistake.
17176 If you have trouble understanding what the warning is about, you can safely
17178 Remember that there is a hidden layer between the document on screen and
17179 the technical details in invoking
17183 , and this gap can make some warnings seem arcane or just right down plain
17187 This document is an excellent testing bed for the feature, and it should
17188 provide quite a few warnings for you to fiddle with.
17189 Since computers are only so smart, expect most of the warnings to be false
17193 How to fine tune it
17196 Sometimes, you'll find that
17200 makes more noise than suits your mood.
17201 Then you can choose not to use it, wait until your mood changes, or try
17206 to get better along with you.
17207 Another choice in the most desperate situations is to use
17212 iew\SpecialChar \menuseparator
17217 emove\SpecialChar ~
17219 Error\SpecialChar ~
17222 , which will get rid of all warnings instantly.
17233 very configurable and extensible, you shouldn't expect to solve all problems
17239 Since LyX has to generate a somewhat special LaTeX file to be able to match
17240 the line numbers from the
17250 You can inspect the specific output from
17256 Edit\SpecialChar \menuseparator
17258 LaTeX\SpecialChar ~
17268 to the internal document structure, some of the warnings will not seen
17269 to appear correctly.
17270 There are two things you can do about this:
17277 invocation command line in
17293 installation configuration file (usually with the file
17295 /usr/local/share/chktexrc
17298 See below to learn what warnings can be enabled and disabled on the command
17303 Export your document as a raw LaTeX file using
17308 ile\SpecialChar \menuseparator
17313 xport\SpecialChar \menuseparator
17325 Invoked in this way, it can be a hassle to find the corresponding place
17326 in the document inside LyX, but with a little patience, you should be able
17330 Here follows the warning messages that can be enabled and disabled in
17339 to disable a warning, and
17343 to enable a warning.
17344 The emphasized entries are disabled by default, because the default is
17347 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17352 Notice that you should only use the options that enable and disable warnings,
17353 because LyX relies on some of the other command line parameters to be set
17354 in a specific way to have a chance to communicate with
17364 Command terminated with space.
17369 Non-breaking space (
17370 \begin_inset Quotes eld
17378 \begin_inset Quotes erd
17381 ) should have been used.
17387 You should enclose the previous parenthesis with
17388 \begin_inset Quotes eld
17396 \begin_inset Quotes erd
17404 Italic correction (
17405 \begin_inset Quotes eld
17415 \begin_inset Quotes erd
17418 ) found in non-italic buffer.
17423 Italic correction (
17424 \begin_inset Quotes eld
17434 \begin_inset Quotes erd
17437 ) found more than once.
17443 No italic correction (
17444 \begin_inset Quotes eld
17454 \begin_inset Quotes erd
17463 \begin_inset Quotes eld
17471 \begin_inset Quotes erd
17475 \begin_inset Quotes eld
17483 \begin_inset Quotes erd
17491 Wrong length of dash may have been used.
17498 \begin_inset Quotes eld
17506 \begin_inset Quotes erd
17510 \begin_inset Quotes eld
17518 \begin_inset Quotes erd
17527 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17544 \begin_inset Quotes eld
17552 \begin_inset Quotes erd
17555 to achieve an ellipsis.
17560 Inter-word spacing (
17561 \begin_inset Quotes eld
17571 \begin_inset Quotes eld
17574 ) should perhaps be used.
17579 Inter-sentence spacing (
17580 \begin_inset Quotes eld
17590 \begin_inset Quotes erd
17593 ) should perhaps be used.
17598 Could not find argument for command.
17604 \begin_inset Quotes eld
17612 \begin_inset Quotes erd
17620 Math mode still on at end of LaTeX file.
17626 \begin_inset Quotes eld
17634 \begin_inset Quotes erd
17637 doesn't match the number of
17638 \begin_inset Quotes eld
17646 \begin_inset Quotes erd
17654 You should use either
17657 \begin_inset Quotes eld
17665 \begin_inset Quotes erd
17670 as an alternative to
17671 \begin_inset Quotes eld
17679 \begin_inset Quotes erd
17691 " (ASCII 39) instead of "
17700 User-specified pattern found.
17705 This command might not be intended.
17733 Delete this space to maintain correct page references.
17739 You might wish to put this between a pair of
17740 \begin_inset Quotes eld
17748 \begin_inset Quotes erd
17756 You ought to remove spaces in front of punctuation.
17761 Could not execute LaTeX command.
17772 in front of small punctuation.
17782 may look prettier here.
17788 Multiple spaces detected in output.
17793 This text may be ignored.
17801 \begin_inset Quotes eld
17806 to begin quotation, not
17819 to end quotation, not
17822 \begin_inset Quotes eld
17837 You should perhaps use
17838 \begin_inset Quotes eld
17846 \begin_inset Quotes erd
17854 You should put a space in front of/after parenthesis.
17859 You should avoid spaces in front of/after parenthesis.
17865 You should not use punctuation in front of/after quotes.
17870 Double space found.
17875 You should put punctuation outside inner/inside display math mode.
17880 You ought to not use primitive TeX in LaTeX code.
17885 You should remove spaces in front of
17886 \begin_inset Quotes eld
17894 \begin_inset Quotes erd
17903 \begin_inset Quotes eld
17911 \begin_inset Quotes erd
17914 is normally not followed by
17915 \begin_inset Quotes eld
17923 \begin_inset Quotes erd
17929 In later versions of LyX, we hope to provide a more complete interface to
17930 this tool (and it's smaller cousin
17934 ) to exploit the full power of it.
17935 But it's not exactly useless as it is now: go try it on one of your existing
17936 documents of a certain length and be surprised.
17939 Version Control in LyX
17944 Lars Gullik Bjønnes
17950 A friend of mine wanted to try LyX for a group project.
17951 When he didn't find support for version control or file locking, he dropped
17953 This angered me a bit, so I thought that I should at least make support
17954 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17955 This has now been done.
17956 LyX now supports some of the most basic RCS commands.
17957 If you need to something a bit more sophisticated you will have to do that
17958 manually in an xterm.
17961 Before you begin to use the version control features in LyX, you should
17963 \begin_inset Quotes eld
17967 \begin_inset Quotes erd
17970 (a man file, read it with
17975 This file describes all the basic features of RCS.
17976 You should especially notice the comment about a RCS directory, and the
17977 notion of a master RCS file (the file ending in
17984 The implementation in LyX assumes a recent version of the GNU RCS package---no
17985 guarantees are made for older versions.
17988 RCS commands in LyX
17991 The following sections describe the RCS commands supported by LyX.
17992 You can find them in the
17997 ile\SpecialChar \menuseparator
18002 ersion\SpecialChar ~
18006 \layout Subsubsection
18013 If your document is not under revision control, this is the only item shown
18015 And if it is under revision control, the
18022 item is grayed out.
18026 This command registers your document with RCS\SpecialChar \@.
18027 You are asked interactively
18028 to supply an initial description of the document.
18029 The document is now set in Read-Only mode and you have to
18031 Check\SpecialChar ~
18036 , before making any changes to it.
18037 A document under revision control has a
18038 \begin_inset Quotes eld
18041 [RCS:<version> <locker>]
18042 \begin_inset Quotes erd
18045 item tagged to the filename in the minibuffer.
18048 RCS command that is run:
18050 ci -q -u -i -t-"<initial description>" <file-name>
18057 to understand the switches.
18059 \layout Subsubsection
18066 When you are finished editing a file, you check in your changes.
18067 When you do this, you are asked for a description of the changes.
18068 This is stored in the history log.
18069 The version number is bumped, your changes are applied to the master RCS
18070 file, the document is unlocked and set to Read-Only mode.
18076 ci -q -u -m"<description>" <file-name>
18077 \layout Subsubsection
18084 By doing this you lock the document so that only you can edit it.
18085 This will also make the document Read-Write only for you.
18086 You will usually continue editing for a while and when you are finished
18087 you check in your changes.
18088 The status line is changed to reflect that you have locked the file.
18094 co -q -l <file-name>
18095 \layout Subsubsection
18099 Revert To Last Version
18102 This will discard all changes made to the document since the last check
18104 You get a warning before changes are discarded.
18109 co -f -u<version> <file-name>
18110 \layout Subsubsection
18117 This makes as if the last check in never happened.
18118 No changes are made to the document loaded into LyX, but the last version
18119 is removed from the master RCS file.
18125 rcs -o<version> <file-name>
18126 \layout Subsubsection
18133 This show the complete history of the RCS document.
18138 is shown in a browser.
18146 Literate Programming
18153 (kayvan@sylvan.com)
18157 original documentation written by
18159 Edmar Wienskoski Jr.
18162 (edmar-w-jr@technologist.com)
18168 The main purpose of this documentation is to show you how to use LyX for
18169 literate programming.
18170 Where it is assumed that you are familiar with this programming technique,
18172 \begin_inset Quotes eld
18176 \begin_inset Quotes erd
18180 \begin_inset Quotes eld
18184 \begin_inset Quotes erd
18188 If that is not the case, please follow the web links provided in the following
18190 There is a lot of good documentation out there covering old development
18191 history to the latest tools tips.
18194 It is also assumed that you are familiar with LyX itself to a point that
18195 you are comfortable changing your LyX preferences, and X resources file.
18196 If that is not the case please refer to other LyX documentation to cover
18197 your specific needs.
18200 Literate Programming
18203 From the Literate Programming FAQ:
18206 Literate programming is the combination of documentation and source together
18207 in a fashion suited for reading by human beings.
18208 In fact, literate programs should be enjoyable reading, even inviting!
18209 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18210 and documentation in a single file.
18211 Literate programming tools then parse the file to produce either readable
18212 documentation or compilable source.
18213 The WEB style of literate programming was created by D.E.
18214 Knuth during the development of his TeX typesetting software.
18218 Another excerpt says:
18223 How is literate programming different from verbose commenting?
18226 There are three distinguishing characteristics.
18227 In order of importance, they are:
18231 flexible order of elaboration
18234 automatic support for browsing
18237 typeset documentation, especially diagrams and mathematics
18241 Now that I sparked your curiosity, take a look in the references.
18242 \layout Subsubsection
18247 The complete Literate Programming FAQ can be found at:
18251 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
18258 The FAQ lists 23 (twenty three!) different literate programming tools.
18259 Where some are specialized or
18260 \begin_inset Quotes eld
18264 \begin_inset Quotes erd
18267 for particular programming languages, while other have general scope.
18272 for my own use for several reasons:
18275 It can generate the documentation either in latex or html.
18278 It has a open architecture, i.e., it is easy to plug in new filters and to
18279 perform special processing that you may need.
18283 There is a good selection of filters available already (the html is one
18290 The Noweb web page can be found at:
18294 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
18301 Starting from there you can reach many other interesting links and even
18302 some literate program examples.
18305 LyX and Literate Programming
18308 The LyX support for Literate Programming is provided by using the generic
18309 LyX convertors mechanism.
18310 This support is provided in a
18311 \begin_inset Quotes eld
18315 \begin_inset Quotes erd
18318 way, i.e., you will be able to use this new LyX feature with some other literate
18319 programming tool of your choice by just changing your LyX preferences.
18320 \layout Subsubsection
18322 Generating documents and code (weaving and tangling)
18325 Selecting the document class
18328 If you have installed Noweb and LyX successfully, whenever you open a new
18329 document or try to change the document class of an existing one, you will
18330 find that there are three new document classes available:
18342 You must select one of them to create your literate documents from.
18346 Note that literate documents are not limited to these three classes.
18347 New classes can be generated from other styles like letter or in combination
18348 with other class variations like Article (AMS).
18349 If you have special needs that cannot be covered by one of the existing
18350 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
18351 will arrange to insert a new entry, or teach you how to do it.
18357 It is very simple, it involves the creation of a file with four lines, and
18358 re-running of the auto configuration.
18361 Moreover, if you use a literate tool other than Noweb you may need to create
18362 a new set of document classes for it.
18368 LyX enables you to write code with a layout named
18378 The equivalent Noweb term is
18379 \begin_inset Quotes eld
18383 \begin_inset Quotes erd
18387 For historical reasons, I got used to the term
18388 \begin_inset Quotes eld
18392 \begin_inset Quotes erd
18395 introduced by other literate tool named Nuweb, which I used for many years
18396 before rendering myself to Noweb.
18399 Noweb delimits scraps like this:
18417 The problem is that whatever is written in between the << and the
18421 must be taken literally, i.e., LyX should be prevented from making any special
18422 interpretation of what has been written.
18423 This is handled by a special layout named Scrap, that works like a normal
18424 paragraph but has a free spacing capability.
18427 The down side of the Scrap paragraph layout is that consecutive paragraphs
18428 of code will be spaced with one empty line in the source code and also
18429 in the printed documentation.
18430 The work around is to enter each line of code within a single Scrap, with
18431 a newline (ctrl-return).
18432 The example above will look like this:
18438 If you have a printed version of this document you will not see any difference
18439 between the previous example and this one.
18456 This layout works fine.
18457 The only real inconvenience is that you have to type ctrl-return instead
18464 It is in my list of
18465 \begin_inset Quotes eld
18469 \begin_inset Quotes erd
18478 As a special note, you can also use the
18479 \begin_inset Quotes eld
18483 \begin_inset Quotes erd
18486 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18492 def some_function(args):
18494 "This is the doc string for this function."
18496 print "My args: ", args
18499 @ %def some_function
18502 For an example of this usage and the resulting cross-reference output, look
18503 at the Literate python program in
18505 LIBDIR/examples/listerrors.lyx
18507 which should make this all clear.
18510 Generating the documentation
18513 At this point you already have a new document file with a proper document
18514 class, and with some code and text on it.
18515 How do I print it? The answer is simple, you select
18520 iew\SpecialChar \menuseparator
18528 Just like you would do for a plain document.
18529 No special procedure is required.
18532 To help orientate you, I will now explain what happens inside LyX:
18540 pdate\SpecialChar \menuseparator
18547 menu option is chosen, a latex file is generated.
18552 If the document is of any literate class the generated file will be named
18553 with an extension name defined by the
18554 \begin_inset Quotes eld
18558 \begin_inset Quotes erd
18561 format (defined in the Preferences panel), otherwise the file will have
18570 Note that the only difference so far is in the name of the file, no special
18571 processing is required by LyX.
18572 Given that you formatted the code using the Scrap layout that, by itself,
18573 takes care of the business.
18576 If the document is of any literate class LyX will then use the internal
18577 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18583 The converters are defined in the
18588 ools\SpecialChar \menuseparator
18596 \begin_inset Quotes eld
18600 \begin_inset Quotes erd
18606 to generate the LaTeX file.
18610 Otherwise it will just skip this step.
18614 Finally, LaTeX is invoked and the regular post processing continues as in
18618 Independence from a particular
18619 \begin_inset Quotes eld
18623 \begin_inset Quotes erd
18626 is easily achieved by changing the commands that are run by the various
18630 Generating the code
18633 When the build menu option is chosen or the corresponding button in the
18634 toolbar is pressed, a latex file is generated just like step 1 above.
18635 Next, LyX invokes the
18640 Typically, this converter (like any other converter), has two parts:
18643 The converter program itself.
18644 This program performs the conversion from the one format to the other (in
18645 this case, from the Noweb format to the Program pseudo-format).
18648 The error log parser.
18649 This is a program whose sole purpose is to rewrite error messages in a
18650 format that LyX understands.
18651 This makes it possible for LyX to place error boxes in the right places
18652 in the file buffer.
18655 The first part, the
18656 \begin_inset Quotes eld
18660 \begin_inset Quotes erd
18663 setting, should be set to
18664 \begin_inset Quotes eld
18672 \begin_inset Quotes erd
18676 This basically means that LyX will call
18677 \begin_inset Quotes eld
18681 \begin_inset Quotes erd
18684 (a program or script) with the name of the Noweb file (generally a file
18685 in the LyX temp directory).
18689 This is an implementation of
18690 \begin_inset Quotes eld
18694 \begin_inset Quotes erd
18697 that you can place in a directory on your path:
18706 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18709 The next part of the converter setting is the
18710 \begin_inset Quotes eld
18714 \begin_inset Quotes erd
18717 which is to be set to
18718 \begin_inset Quotes eld
18723 originaldir,parselog=listerrors
18726 \begin_inset Quotes erd
18730 This will run any errors that are generated by the
18731 \begin_inset Quotes eld
18735 \begin_inset Quotes erd
18738 process through the
18739 \begin_inset Quotes eld
18743 \begin_inset Quotes erd
18749 The converter code looks in
18757 then on the path for the
18758 \begin_inset Quotes eld
18762 \begin_inset Quotes erd
18768 Build instructions in the document
18771 The last piece of the integration between LyX and noweb is the
18772 \begin_inset Quotes eld
18776 \begin_inset Quotes erd
18780 Generally, the instructions for building your program should be embedded
18781 in a scrap of its own.
18783 \begin_inset Quotes eld
18787 \begin_inset Quotes erd
18790 above uses the notangle command to look for this scrap (called
18791 \begin_inset Quotes eld
18795 \begin_inset Quotes erd
18798 ) and runs its contents through
18799 \begin_inset Quotes eld
18803 \begin_inset Quotes erd
18809 Typically, such a scrap would look something like this:
18818 if [ -z "${NOWEB_SOURCE}" ]
18822 NOWEB_SOURCE=myfile.nw
18827 code to extract files ...]
18830 code to compile files ...]
18837 LIBDIR/examples/listerrors.lyx
18841 LIBDIR/examples/Literate.lyx
18843 which implement two versions of the
18844 \begin_inset Quotes eld
18848 \begin_inset Quotes erd
18851 program for some illustrations of how all of these pieces go together or
18854 LIBDIR/examples/noweb2lyx.lyx.
18857 Interestingly, these three files show off the language-indepence of the
18858 LyX literate programming support since they are written in Python, C and
18860 \layout Subsubsection
18865 All the Literate Programming support is configured by the
18870 ools\SpecialChar \menuseparator
18878 \begin_inset Quotes eld
18882 \begin_inset Quotes erd
18886 The important parts are:
18887 \layout Description
18891 \begin_inset Quotes eld
18895 \begin_inset Quotes erd
18899 format Set up via the Formats tab, this is where the Noweb-specific pieces
18909 , the file extension is set to
18914 This tells LyX to create a file with a
18918 extension in the first step of the conversion process.
18919 \layout Description
18927 format This is an empty format whose sole purpose is to be the endpoint
18928 of a conversion (which then allows us to set up a converter for it).
18929 \layout Description
18939 This converter performs the
18940 \begin_inset Quotes eld
18944 \begin_inset Quotes erd
18947 of the literate document.
18948 For Noweb, it is set to
18949 \begin_inset Quotes eld
18954 noweave -delay -index $$i > $$o
18957 \begin_inset Quotes erd
18961 \layout Description
18972 \begin_inset Quotes eld
18976 \begin_inset Quotes erd
18980 As stated above, the Converter is set to
18981 \begin_inset Quotes eld
18989 \begin_inset Quotes erd
18992 , with Flags set to
18993 \begin_inset Quotes eld
18998 originaldir,parselog=listerrors
19001 \begin_inset Quotes erd
19005 \layout Subsubsection
19010 There is also a new function implemented in the LyX server, the
19011 \begin_inset Quotes eld
19014 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19018 When debugging code with ddd/gdb, it is possible to invoke a text editor
19019 at the current execution position with a single key stroke.
19020 The default ddd configuration for that is shift-ctrl-V.
19021 It happens that you can define the editor command line invocation in ddd
19028 dit\SpecialChar \menuseparator
19033 references\SpecialChar \menuseparator
19040 dialog and changing the "Edit Sources" entry.
19043 I take advantage of the new created LyX server function and this ddd feature,
19045 \begin_inset Quotes eld
19049 \begin_inset Quotes erd
19055 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
19058 With this, whenever you are using ddd and find a point in the program that
19059 you want to edit, you just press shift-ctrl-V (in the ddd window), and
19060 ddd you forward this information to LyX through the LyX server and then
19061 the LyX window will show the same file with the cursor at the same position
19062 ddd was pointing to.
19063 No more guessing or long scrolling to locate a point in the program back
19067 Note however that you must enable the LyX server to get this feature working
19068 (it is disabled by default).
19069 You can enable it in
19081 ) by entering in the
19086 \begin_inset Quotes eld
19091 /home/<your-home-directory>/.lyx/lyxpipe
19094 \begin_inset Quotes erd
19100 Read the LyX server documentation in the
19102 Customization Manual
19104 for further information.
19105 \layout Subsubsection
19110 There are six new buttons that can be added to your LyX toolbar.
19111 Five of these buttons are short cuts to layout styles:
19132 The last one is a short cut to the
19133 \begin_inset Quotes eld
19137 \begin_inset Quotes erd
19144 LyX has a range of buttons that are available for tool bar customization.
19145 In my toolbar I like to combine the six short cuts above with two more:
19153 \SpecialChar \menuseparator
19161 \SpecialChar \menuseparator
19174 iew\SpecialChar \menuseparator
19182 Here is how it looks like:
19191 Icon "layout Standard"
19194 Icon "layout Section"
19197 Icon "layout LaTeX"
19200 Icon "layout LyX-Code"
19203 Icon "layout Scrap"
19212 Icon "buffer-typeset"
19215 Icon "build-program"
19231 \layout Subsubsection
19233 Colors customization
19236 There are a number of colors in LyX that can be customized in
19241 One of the things that bothers people is the LaTeX font color.
19242 The default color is red, since the scraps uses LaTeX font, and there is
19243 a lot of scraps in literate documents, you may get tired of seeing everything
19245 You can change it by going to the tabs
19254 The next thing is the visible presence of the newline character in the screen.
19255 You can choose the color of this particular character and make it blend
19257 I recommend you choosing a color that is close to the background but not
19258 equal, that way you still can see it is there, but it is not bothering
19263 Secrets of the LaTeX Masters
19264 \begin_inset LatexCommand \label{cha:secrets}
19271 Though LyX is a powerful tool, it cannot hope to support everything that
19272 can be done with pure TeX/LaTeX.
19273 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
19274 as long as you are not afraid to use that
19275 \begin_inset Quotes eld
19279 \begin_inset Quotes erd
19282 button on the toolbar or add things to the LaTeX preamble.
19283 This section lists some tips, tricks, and otherwise cool ideas to give
19284 your document that extra little flair.
19287 Do try this at home
19289 , just start with something a little smaller and less important than your
19293 Most ideas in this section require less common files in your LaTeX installation.
19294 If you have a system like teTeX, most will already be available.
19295 A few, however, will need to be downloaded from one of the CTAN archives.
19296 Often, there are several ways to do something, or several LaTeX style files
19297 which do the same thing.
19298 We do not endorse one choice over another, we simply claim that we have
19299 done a particular task with a particular file.
19300 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19303 Tricks for Footnotes and Margin Notes
19314 LyX cannot yet take care of setting the footnote numbering back to 1 after
19315 each section in the
19316 \begin_inset Quotes eld
19324 \begin_inset Quotes erd
19329 document class or changing the counter style.
19330 You'll need to insert LaTeX commands like the following to achieve that:
19340 setcounter{footnote}{0}
19347 setcounter{footnote}{0}
19349 will set the counter back to 1
19355 The counter has been set back to 1.
19361 The following command will change the numbering to small letters.
19362 Take a look at the next footnote in your xdvi or ghostview
19382 This is an example for a footnote with alphabetic numbering.
19400 The next command sets the counter style back to default, i.e.
19423 to set the counter--style back to LyX's default, i.e.
19478 and others as counter styles.
19479 Just replace the LaTeX command in the above example and rerun TeX to see
19480 what those styles can do.
19487 Here are two examples of neat things you can do to margin notes using LaTeX
19491 The following command will make a vertical line appear alongside your text---gre
19493 \begin_inset Quotes eld
19497 \begin_inset Quotes erd
19506 rule[-10mm]{30mm}{5mm}}
19519 rule[-10mm]{30mm}{5mm}}
19525 Check your dvi- or ghostview-output to see what the
19531 command does to the following margin note.
19545 \begin_inset Marginal
19563 Lars Gullik Bjønnes
19569 The aim for this chapter
19575 Editor's note: Lars' original chapter was a masterful description of how
19581 However, it was too long to flow smoothly in this document.
19582 I have therefore chosen to excerpt the most important sections here (sorry,
19583 Lars); you can read the original chapter (and more of the story!) in the
19586 examples/multicol.lyx
19592 is to show how the LaTeX package
19596 can be used in a LyX document.
19597 As LyX doesn't support the
19601 package natively yet, we have to use some small hacks.
19602 By reading this section it should be obvious how to do this.
19612 package allows switching between one and multicolumn format on the same
19614 Footnotes are handled correctly (for the most part), but will be placed
19615 at the bottom of the page and not under each column.
19616 LaTeX's float mechanism, however, is partly disabled in the current implementat
19618 At the moment only page-wide floats can be used within the scope of the
19623 \layout Subsubsection
19628 If you want to have two columns in your text, you have use LaTeX mode to
19633 begin{multicols}{2}
19635 at the point where you want the two column layout to start, and then
19641 where you want it to end.
19652 begin{multicols}{2}
19661 The Adventure of the Empty House
19667 Sir Arthur Conan Doyle
19672 It was in the spring of the year 1894 that all London was interested, and
19673 the fashionable world dismayed, by the murder of the Honourable Ronald
19674 Adair under most unusual and inexplicable circumstances.
19675 The public has already learned those particulars of the crime which came
19676 out in the police investigation, but a good deal was suppressed upon that
19677 occasion, since the case for the prosecution was so overwhelmingly strong
19678 that it was not necessary to bring forward all the facts.
19679 Only now, at the end of nearly ten years, am I allowed to supply those
19680 missing links which make up the whole of that remarkable chain.
19681 The crime was of interest in itself, but that interest was as nothing to
19682 me compared to the inconceivable sequel, which afforded me the greatest
19683 shock and surprise of any event in my adventurous life.
19684 Even now, after this long interval, I find myself thrilling as I think
19685 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19686 ty which utterly submerged my mind.
19687 Let me say to that public, which has shown some interest in those glimpses
19688 which I have occasionally given them of the thoughts and actions of a very
19689 remarkable man, that they are not to blame me if I have not shared my knowledge
19690 with them, for I should have considered it my first duty to do so, had
19691 I not been barred by a positive prohibition from his own lips, which was
19692 only withdrawn upon the third of last month.
19706 \layout Subsubsection
19711 The same pattern is used when you want more than two columns:
19721 begin{multicols}{3}
19729 It can be imagined that my close intimacy with Sherlock Holmes had interested
19730 me deeply in crime, and that after his disappearance I never failed to
19731 read with care the various problems which came before the public.
19732 And I even attempted, more than once, for my own private satisfaction,
19733 to employ his methods in their solution, though with indifferent success.
19734 There was none, however, which appealed to me like this tragedy of Ronald
19736 As I read the evidence at the inquest, which led up to a verdict of willful
19737 murder against some person or persons unknown, I realized more clearly
19738 than I had ever done the loss which the community had sustained by the
19739 death of Sherlock Holmes.
19740 There were points about this strange business which would, I was sure,
19741 have specially appealed to him, and the efforts of the police would have
19742 been supplemented, or more probably anticipated, by the trained observation
19743 and the alert mind of the first criminal agent in Europe.
19744 All day, as I drove upon my round, I turned over the case in my mind and
19745 found no explanation which appeared to me to be adequate.
19746 At the risk of telling a twice-told tale, I will recapitulate the facts
19747 as they were known to the public at the conclusion of the inquest.
19763 You can have have more than 3 columns if you want to, but that might not
19764 be very pleasant for the eye.
19765 \layout Subsubsection
19767 Columns inside columns
19770 You can even have columns inside columns:
19780 begin{multicols}{2}
19788 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19789 at that time governor of one of the Australian colonies.
19790 Adair's mother had returned from Australia to undergo the operation for
19791 cataract, and she, her son Ronald, and her daughter Hilda were living together
19802 begin{multicols}{2}
19810 The youth moved in the best society--had, so far as was known, no enemies
19811 and no particular vices.
19812 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19813 had been broken off by mutual consent some months before, and there was
19814 no sign that it had left any very profound feeling behind it.
19815 For the rest {sic} the man's life moved in a narrow and conventional circle,
19816 for his habits were quiet and his nature unemotional.
19817 Yet it was upon this easy-going young aristocrat that death came, in most
19818 strange and unexpected form, between the hours of ten and eleven-twenty
19819 on the night of March 30, 1894.
19837 Ronald Adair was fond of cards--playing continually, but never for such
19838 stakes as would hurt him.
19839 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19840 It was shown that, after dinner on the day of his death, he had played
19841 a rubber of whist at the latter club.
19842 He had also played there in the afternoon.
19847 The evidence of those who had played with him-- Mr.
19848 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19849 and that there was a fairly equal fall of the cards.
19850 Adair might have lost five pounds, but not more.
19851 His fortune was a considerable one, and such a loss could not in any way
19853 He had played nearly every day at one club or other, but he was a cautious
19854 player, and usually rose a winner.
19855 It came out in evidence that, in partnership with Colonel Moran, he had
19856 actually won as much as four hundred and twenty pounds in a sitting, some
19857 weeks before, from Godfrey Milner and Lord Balmoral.
19858 So much for his recent history as it came out at the inquest.
19874 Please do read the file
19876 examples/multicol.lyx
19878 for more advanced examples including column and header spacing, vertical
19879 separator lines, and more.
19886 Paragraph Environment
19887 \begin_inset OptArg
19892 Numbering in Enumerate
19897 \added_space_bottom bigskip
19903 The default numbering for the
19907 paragraph environment begins with Arabic numbers and ends with uppercase
19909 Suppose, however, you wanted a different type of numbering scheme.
19910 Here's a quickie example of how to change the numbering scheme:
19949 \SpecialChar \ldots{}
19950 which changes the numbering scheme to uppercase Roman numerals, uppercase
19951 letters, Arabic numbers, and lowercase letter.
19954 Additionally, the previous example also adds a little bit extra to the numbering
19956 For example, the first level label actually looks like:
19957 \begin_inset Quotes eld
19961 \begin_inset Quotes erd
19965 For ease of reading, we'll describe what the numbering schemes look like
19966 using a notation something like this: <
19967 \begin_inset Quotes eld
19971 \begin_inset Quotes erd
19976 \begin_inset Quotes erd
19980 \begin_inset Quotes erd
19985 \begin_inset Quotes erd
19989 \begin_inset Quotes erd
19994 \begin_inset Quotes eld
19998 \begin_inset Quotes erd
20005 As you can see in the example, there is a label command for each nesting
20012 \SpecialChar \ldots{}
20019 , as well as a counter,
20023 \SpecialChar \ldots{}
20029 There are also five
20030 \begin_inset Quotes eld
20034 \begin_inset Quotes erd
20067 , each of which take one counter as an argument.
20068 You can add characters before or after these, but there's no need to add
20072 You can get really fancy with these.
20118 produces the somewhat out of hand numbering scheme: <
20119 \begin_inset Quotes eld
20123 \begin_inset Quotes erd
20128 \begin_inset Quotes erd
20132 \begin_inset Quotes erd
20137 \begin_inset Quotes erd
20141 \begin_inset Quotes erd
20146 \begin_inset Quotes eld
20150 \begin_inset Quotes erd
20157 Extra Space Between Table Rows
20159 \added_space_bottom bigskip
20165 LaTeX allows you to put a bit of extra space between rows in a table by
20166 giving an optional argument to the end-of-row specifier (
20175 LyX has not yet implemented this in a formal way, so here are two dirty
20176 little tricks to do the same job.
20180 The first is the more formal, but longwinded way to do it.
20181 In the LaTeX preamble, add the following command definition:
20190 extratablespace}[1]{
20194 This command takes a single argument---the amount of space you would like
20196 Insert the command in the first column of the row
20200 where you would like the space to appear.
20201 Here is an example (I've removed all the borders using
20206 ayout\SpecialChar \menuseparator
20216 \begin_inset Tabular
20217 <lyxtabular version="3" rows="4" columns="3">
20219 <column alignment="center" valignment="top" width="0pt">
20220 <column alignment="center" valignment="top" width="0pt">
20221 <column alignment="center" valignment="top" width="0pt">
20223 <cell alignment="center" valignment="top" topline="true" usebox="none">
20240 <cell alignment="center" valignment="top" topline="true" usebox="none">
20257 <cell alignment="center" valignment="top" topline="true" usebox="none">
20276 <cell alignment="center" valignment="top" topline="true" usebox="none">
20283 <cell alignment="center" valignment="top" topline="true" usebox="none">
20300 <cell alignment="center" valignment="top" topline="true" usebox="none">
20319 <cell alignment="center" valignment="top" topline="true" usebox="none">
20340 extratablespace{2ex}
20346 <cell alignment="center" valignment="top" topline="true" usebox="none">
20363 <cell alignment="center" valignment="top" topline="true" usebox="none">
20382 <cell alignment="center" valignment="top" topline="true" usebox="none">
20389 <cell alignment="center" valignment="top" topline="true" usebox="none">
20406 <cell alignment="center" valignment="top" topline="true" usebox="none">
20431 The second method is faster, but will make typographers and TeXperts all
20432 over the world groan.
20433 Simply put an end of row specifier with optional argument at the same spot.
20434 No fancy definitions are needed as in the above example, but there will
20435 be more space inserted than you specified because you essentially added
20436 a blank row plus the extra space.
20437 If the space added is too much, simply use a negative number, like so:
20441 \begin_inset Tabular
20442 <lyxtabular version="3" rows="4" columns="3">
20444 <column alignment="center" valignment="top" width="0pt">
20445 <column alignment="center" valignment="top" width="0pt">
20446 <column alignment="center" valignment="top" width="0pt">
20448 <cell alignment="center" valignment="top" topline="true" usebox="none">
20465 <cell alignment="center" valignment="top" topline="true" usebox="none">
20482 <cell alignment="center" valignment="top" topline="true" usebox="none">
20501 <cell alignment="center" valignment="top" topline="true" usebox="none">
20508 <cell alignment="center" valignment="top" topline="true" usebox="none">
20525 <cell alignment="center" valignment="top" topline="true" usebox="none">
20544 <cell alignment="center" valignment="top" topline="true" usebox="none">
20573 <cell alignment="center" valignment="top" topline="true" usebox="none">
20590 <cell alignment="center" valignment="top" topline="true" usebox="none">
20609 <cell alignment="center" valignment="top" topline="true" usebox="none">
20616 <cell alignment="center" valignment="top" topline="true" usebox="none">
20633 <cell alignment="center" valignment="top" topline="true" usebox="none">
20658 It's short, sweet, and gets the job done quickly, even if it is really ugly.
20659 You may put away the rotten vegetables now! I promise I won't suggest anything
20665 \added_space_bottom bigskip
20680 tmpfont}{cmr17 scaled 2500}{
20702 hose of you who like the style of old books probably also like
20703 \begin_inset Quotes eld
20707 \begin_inset Quotes erd
20710 ---those large capital letters which begin each new chapter or section.
20711 Implementing them with plain LyX/LaTeX is straightforward (assuming you
20712 know some plain TeX!) but does require a lot of work and many iterations,
20713 as you can see by all the ugly TeX-mode stuff at the beginning of this
20726 bigdrop{-1em}{3}{ptmri}{T}+
20729 here is a much easier way of doing this, of course.
20738 ) package from CTAN allows a simple way to add such letters to your documents.
20739 Since this package is not a standard part of teTeX, I can't demonstrate
20740 it within this document, but if you copy this paragraph to a new document,
20742 \begin_inset Quotes eld
20752 \begin_inset Quotes erd
20755 and the pluses from the TeX code at the beginning of the paragraph, and
20760 usepackage{dropcaps}
20762 to your LaTeX preamble, you will get a nice Times Roman Italic
20763 \begin_inset Quotes eld
20767 \begin_inset Quotes erd
20770 , whose height is three lines of text and which protrudes 1 em into the
20772 (Make certain you have copied
20773 \begin_inset Quotes eld
20781 \begin_inset Quotes erd
20784 into a directory where TeX can see it.) The first argument is the amount
20785 of indentation; in this case the negative sign moves it into the margin.
20786 The second argument is the height of the letter in number of lines of text.
20787 The third argument is the font name: virtually anything which has a tfm
20788 file should work (wade through the
20790 .../texmf/fonts/tfm
20792 directory for possibilities).
20793 My personal favorite is
20794 \begin_inset Quotes eld
20802 \begin_inset Quotes erd
20805 , a fancy German font specifically designed for dropped capitals.
20806 The fourth argument is the letter (or letters) to be dropped.
20811 package also offers the
20817 command, as well as a slightly simplified
20826 Non-standard Paragraph Shapes
20828 \added_space_bottom bigskip
20992 There are times when the tyranny of rectangular paragraphs must be overthrown.
20993 In such situations, a call to the delightful plain TeX command
21000 As you can see, completely arbitrary shapes can be laid out with a suitable
21001 set of linelength definitions.
21002 While this parshape may look a bit silly and useless, one could conceive
21003 of situations such as finely tuned dropped capitals, word wrapping around
21004 non-rectangular graphics, etc.
21005 which will benefit from such handcrafting.
21007 \added_space_top bigskip
21012 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21019 is the number of lines of text which define the paragraph.
21020 If there turn out to be fewer lines, the shape is truncated; if there are
21021 more, the excess lines have the same dimensions as the last line of the
21031 entries specify the indentation of the line from the left margin, and the
21032 length of the line as measured from that point.
21033 The shape applies only to the current paragraph; everything is reset to
21034 normal for the next paragraph.
21053 As you can see, the examples in this section range from the useful to the
21055 While I don't expect that anyone will ever need the paragraph shape demonstrate
21056 d in the last section, the important point is that you can do almost anything
21057 you want in LyX if you are willing to figure out how to do it in TeX and
21059 TeX is a fantastically powerful typesetting system and all that power is
21060 available to you since LyX uses it as its backend.