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 has proven to be an excellent tool for generating these documents,
5091 especially given its equation, citation, and figure handling capabilities.
5092 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5093 is the version described here, or higher.
5094 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5095 incompatible with LyX.
5096 The AASTeX package may be downloaded from the AASTeX Web site
5098 \added_space_top medskip \added_space_bottom medskip \align center
5100 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
5107 A complete user guide is contained in that package and you should familiarize
5108 yourself with it thoroughly before embarking on writing a paper in LyX.
5109 LyX will not reduce the need to figure out all the AASTeX commands, it
5110 will only reduce the drudgery of typing everything in.
5111 It is your responsibility to ensure that the final exported LaTeX document
5112 conforms completely to the requirements of the journal to which you are
5113 submitting your paper.
5116 Starting a New Paper
5119 I strongly suggest that you start with the AASTeX template file.
5125 ile\SpecialChar \menuseparator
5132 , enter the new file name, then choose the
5137 This will show the most common fields found in a manuscript.
5138 Simply overwrite the existing text (including the brackets,
5142 ) with the correct information.
5143 Many of the AASTeX commands and environments can be implemented directly
5144 in LyX, but some cannot: most noticeably
5156 , which should stick out like a sore thumb if you actually just opened the
5158 For commands such as these, the LaTeX code must be entered directly and
5160 Such commands are referred to as ERT, or Evil Red Text.
5161 I tried to minimize the amount of ERT needed in an AASTeX document, but
5162 there is still a bit more required than any of us would like.
5165 Finishing Your Paper
5168 When the paper is finished to your satisfaction and previews/prints correctly,
5170 \begin_inset Quotes eld
5174 \begin_inset Quotes erd
5177 actions which need to be done before you submit it to the journals.
5181 Export your paper as a LaTeX file (
5186 ile\SpecialChar \menuseparator
5191 xport\SpecialChar \menuseparator
5206 file with your favorite text editor
5210 remove the comment lines before the
5223 usepackage...{fontenc}
5225 line if it appears (usually just after
5240 remove everything between (and including) the
5252 commands, except for any commands you specifically put into the LaTeX preamble
5253 (which should appear immediately after the
5254 \begin_inset Quotes eld
5257 User specified LaTeX commands
5258 \begin_inset Quotes erd
5269 Run the resulting file through LaTeX to make sure it still processes correctly.
5272 Reread the journal requirements to make sure your filenames and formats
5279 Comments On Specific Commands
5282 I will not describe the detailed usage of the individual AASTeX commands:
5283 the AASTeX User Guide (
5287 ) gives a good description of each.
5288 Thus it's probably easiest for me to go down the list as found in the guide
5289 and offer comments where necessary.
5290 So let's begin \SpecialChar \ldots{}
5292 \layout Subsubsection
5294 Things that work as expected
5310 Because they work as you might expect, I simply list them and the section
5411 begin{thebibliography}
5419 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5420 graphicx figure commands (2.14.1),
5444 (2.15.4, amongst other places),
5471 The following style options also work correctly:
5492 Simply put them in the
5498 Layout\SpecialChar \menuseparator
5515 \layout Subsubsection
5517 Things that work, but require more comment
5520 The following items work, but require a little more discussion:
5523 These items are reserved for use by the journal editors, but you can put
5524 them into the LaTeX preamble if you feel compelled to do so:
5557 These items may be placed in the LaTeX preamble, and are included as blanks
5558 in the template file:
5585 (2.3) -- can only be used
5586 \begin_inset Quotes eld
5590 \begin_inset Quotes erd
5593 , not in the middle of a paragraph.
5594 Use ERT if you need to embed it.
5603 (2.3) -- will have extra {} after it.
5604 This should not cause an error.
5613 (2.6) -- can only be used
5614 \begin_inset Quotes eld
5618 \begin_inset Quotes erd
5621 , not in the middle of a paragraph.
5622 Use ERT if you need to embed it.
5631 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5641 (2.8) -- same as for
5654 (2.9) -- will have extra {} after it.
5655 This should not cause an error.
5664 (2.11) -- will have extra {} after it.
5665 This should not cause an error.
5674 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5675 at the beginning of the text and selecting
5677 Insert\SpecialChar \menuseparator
5682 \begin_inset Quotes eld
5686 \begin_inset Quotes erd
5689 inserts an optional argument of the type needed by
5696 Hopefully it will be renamed someday.
5711 for the catalog ID optional parameter
5726 for the catalog ID optional parameter
5727 \layout Subsubsection
5729 Things not implemented, use ERT
5767 setcounter{equation}
5769 (2.12), Journal name abbreviations (2.13.4),
5805 (2.15.4, insert it as the first element in the lefthand cell after where
5807 Don't use any of LyX's rules in the table),
5819 (2.15.5), much of Misc (2.17, except
5881 \layout Subsubsection
5883 Things that cannot be implemented
5886 \SpecialChar \ldots{}
5887 at least in any meaningful sort of way, so I suggest ignoring them.
5888 They are the references environment (2.13.3), and the deluxetable environment
5890 If you really, really need to use deluxetable, I suggest editing it in
5891 a separate file with a text editor, then using
5896 nsert\SpecialChar \menuseparator
5904 to include it in your LyX document.
5909 file to see an example of this.
5912 FAQs, Tips, Tricks, and Other Ruminations
5913 \layout Subsubsection
5915 Getting LyX and AASTeX to cooperate
5918 It can be a bit tricky to get LyX to recognize a new layout and document
5920 When all else fails, do this:
5923 Make certain that LaTeX can find AASTeX.
5924 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5925 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5938 /usr/.../share/lyx/layouts
5952 ools\SpecialChar \menuseparator
5959 in LyX, then restart LyX.
5962 Open a regular new file, not from a template.
5963 Does AASTeX appear in the class list in
5968 ocument\SpecialChar \menuseparator
5978 If you get a warning from an existing AASTeX document about not being able
5979 to find the AASTeX layout or a message about
5980 \begin_inset Quotes eld
5983 You should not mix title layouts with normal ones
5984 \begin_inset Quotes erd
5987 , things haven't been installed correctly.
5988 \layout Subsubsection
5990 LaTeX error processing a table
5993 LyX, by default, attempts to center the table caption/title.
5994 This seems to produce a bad interaction in AASTeX so you should click somewhere
5995 in the caption/title, then select
6000 dit\SpecialChar \menuseparator
6005 aragraph\SpecialChar ~
6020 This took care of it for me.
6021 \layout Subsubsection
6024 \begin_inset LatexCommand \label{cite}
6031 A couple of things: 1) I have noticed some funny spacing in the reference
6032 entries in the text.
6033 When you enter the bibliography item data, make sure their is
6037 space between the last author and the parenthesis setting off the year;
6052 2) Entering the references at all is not obvious.
6053 The easiest thing is to start typing your first reference at the end of
6054 the document, then mark it as type
6059 That will put a small gray box in front of what you just typed.
6060 Click on the box to fill in the rest of the information.
6061 For new references, go to the end of an existing reference and press return.
6062 That will create a new line with its own box, etc.
6063 \layout Subsubsection
6068 Even though AASTeX provides its own figure commands (
6074 , for example), I much prefer LaTeX's standard figure commands (with the
6082 , etc.\SpecialChar ~
6083 commands as ERT into a Figure Float box if you desire, but I never
6084 have much luck getting the layout right.
6085 With the standard graphics, LyX will insert a
6089 usepackage{graphicx}
6091 command into the LaTeX preamble and handle the figures in the standard
6092 LaTeX2e way, interspersing the figures in the text.
6093 I believe ApJ accepts figures exactly this way now; AJ might still use
6095 \begin_inset Quotes eld
6098 stack everything at the end
6099 \begin_inset Quotes erd
6103 \layout Subsubsection
6105 Things I could have done, but didn't
6109 \begin_inset Quotes eld
6113 \begin_inset Quotes erd
6116 things I could have implemented, but chose not to.
6117 For instance, I saw no point in double-spacing the text in the LyX window,
6118 even though it is double-spaced in the paper manuscript.
6119 Also, I chose not to make separate layouts for the preprint and preprint2
6121 Since I assume you will spend most of your time in the plain manuscript
6122 mode anyway, I decided not to chew up more disk space with this.
6129 Your mileage may vary.
6130 I've now had papers published by both ApJ and AJ that have had 98% of the
6131 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6133 I have had no trouble with the submission process, and I'm sure the journals
6134 were never aware that there might be a difference.
6135 So, go forth and publish!
6143 Panayotis Papasotiriou
6149 The ijmpd package is a set of macros that facilitates electronic manuscript
6152 International Journal of Modern Physics D
6154 published by World Scientific.
6155 The name of the document class is
6160 This file, together with instructions for the authors, can be downloaded
6162 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
6167 The ijmpd package is a modified version of the standard
6168 \begin_inset Quotes eld
6172 \begin_inset Quotes erd
6176 Most of its features are supported by LyX.
6177 I have recently used LyX successfully to write an article submitted to
6180 International Journal of Modern Physics D
6188 As usual, the easiest way to write a paper is to start with a template.
6194 ile\SpecialChar \menuseparator
6206 This will give an (almost) empty document that includes the most common
6207 fields found in a manuscript.
6208 Simply overwrite the existing text (including the brackets,
6212 ) with the correct information.
6213 You should keep in mind the following remarks.
6216 LyX won't let you change the font size and the page style of the document,
6217 because the ijmpd package does not allow such modifications.
6220 The ijmpd package requires that the language of the document should not
6222 Before previewing your paper, be sure that the babel package is not used.
6223 To do this, click on
6228 ools\SpecialChar \menuseparator
6242 checkbox in the language settings, and click on
6253 , if you wish to make this change permanent).
6256 Two new environments, named
6257 \begin_inset Quotes eld
6261 \begin_inset Quotes erd
6265 \begin_inset Quotes eld
6269 \begin_inset Quotes erd
6272 are available (their use is obvious).
6275 Appendices may be added to the paper.
6276 LyX offers a special environment, called
6277 \begin_inset Quotes eld
6281 \begin_inset Quotes erd
6284 which marks the beginning of the appendix.
6285 An appendix can contain normal sections, subsections, or subsubsections.
6288 The ijmpd package implements table captions quite differently than LyX does.
6289 As a result, a table created by LyX is printed correctly, but its caption
6291 If you need table captions, you should implement the whole table float
6296 file, then include this file to the LyX document (
6301 nsert\SpecialChar \menuseparator
6310 Details on how to create an ijmpd table float can be found in the file
6315 , which is included in the ijmpd package.
6318 Preparing a paper for submission
6321 Before you submit your paper you must export the LyX document as a LaTeX
6327 ile\SpecialChar \menuseparator
6332 xport\SpecialChar \menuseparator
6339 ), then make the following changes to the resulting
6346 Remove the comment lines before the
6355 Remove everything between (and including) the
6367 commands, except for any commands you specifically put into the LaTeX preamble.
6374 file should be saved and processed through LaTeX as many times as necessary.
6375 You may also want to check the resulting
6385 The use of ERT is optional, and is reduced to three commands, which affect
6386 the look of the page.
6387 If you started writing your paper by using the
6391 template, the ERT needed is already in its place; you usually don't need
6393 You may only change the first ERT to specify the information printed to
6394 the top of odd and even pages (authors' names and short paper's title,
6396 This ERT must have the form
6400 markboth{Authors' Names}{Short Paper's Title}
6410 Panayotis Papasotiriou
6416 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6417 that facilitates electronic manuscript submission to the journals they
6419 Most known of them (at least in my domain of interest) are
6421 Astrophysics and Space Science
6427 , but there are many others (see a complete list at
6428 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
6433 The Kluwer package may be downloaded from the site
6434 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
6439 A complete user guide is contained in that package (but it can also be
6440 downloaded separately).
6443 LyX supports many features of the package but not everything.
6444 However, the ERT needed is reduced to some
6445 \begin_inset Quotes eld
6449 \begin_inset Quotes erd
6452 commands of the package (see\SpecialChar ~
6454 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
6459 I have recently used LyX to write an article submitted to the
6461 Astrophysics and Space Science
6463 without any problem.
6469 The easiest way to write a paper is to start with the Kluwer template file.
6472 File\SpecialChar \menuseparator
6484 This will give an (almost) empty document that includes the most common
6485 fields found in a manuscript and a short description of their use.
6486 As in most templates, simply overwrite the existing text (including the
6491 ) with the correct information.
6494 Preparing a paper for submission
6497 As in the AASTeX package, before you submit your paper to a journal you
6499 \begin_inset Quotes eld
6503 \begin_inset Quotes erd
6509 Export your paper as a LaTeX file.
6510 To do this, click on
6515 ile\SpecialChar \menuseparator
6520 xport\SpecialChar \menuseparator
6535 file with a text editor and make the following changes
6539 remove the comment lines before the
6548 remove everything between (and including) the
6560 commands, except for any commands you specifically put into the LaTeX preamble.
6575 file through LaTeX as many times as necessary (usually up to three).
6582 document using, e.g.,
6586 , and check if everything is ok (it should, if you didn't make any mistake).
6590 \begin_inset Quotes eld
6594 \begin_inset Quotes erd
6597 of the Kluwer package
6598 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
6605 The Kluwer package has the following
6606 \begin_inset Quotes eld
6610 \begin_inset Quotes erd
6616 It is possible to write multiple articles in the same LaTeX file
6622 I can't imagine any good reason to do this.
6626 Each article must be included in the environment
6627 \begin_inset Quotes eld
6631 \begin_inset Quotes erd
6635 Unfortunately, this environment cannot be omitted, even if you write just
6637 Therefore, each article starts with the command
6643 and, obviously, ends with the command
6650 Although this can be implemented in LyX, I didn't included it, since it
6651 looks ugly and can confuse the novice user.
6652 Therefore, you need to enter them directly and mark them as LaTeX code
6654 \begin_inset Quotes eld
6658 \begin_inset Quotes erd
6664 Information given at the beginning of the article (i.e., title, subtitle,
6665 author, institution, running title, running author, abstract and keywords)
6666 must be included in an environment called
6667 \begin_inset Quotes eld
6671 \begin_inset Quotes erd
6675 This is not implemented in LyX, so you must enter title, subtitle etc.
6676 between two ERT lines (
6691 According to the user manual, the label of each bibliography item must be
6719 template takes care of all these
6720 \begin_inset Quotes eld
6724 \begin_inset Quotes erd
6728 If you start a new paper using this template you don't need to do anything
6733 don't delete the ERT included in the template, and
6736 copy the example bibliography item included in the template and modify it
6737 as necessary to enter new bibliography items.
6751 The LyX document classes
6753 article (koma-script)
6757 report (koma-script)
6775 correspond to the LaTeX document classes
6792 of the Koma-Script family.
6793 They are replacements for the standard document classes
6809 , resp., and fit better to European typography conventions in a number of
6813 Standard character size is 11pt in
6815 article (koma-script)
6819 report (koma-script)
6827 letter (koma-script)
6832 Headings, labels of the description environment, and a number of elements
6835 letter (koma-script)
6837 document class are set in a bold sans serif font.
6843 There is a big difference between the bold sans serif old cm fonts and new
6844 ec fonts, especially in the appearance of headings.
6845 In comparison, the ec bold sans serif fonts look a bit thin.
6846 Here the LaTeX package
6853 helps to produce the
6854 \begin_inset Quotes eld
6858 \begin_inset Quotes erd
6861 appearance when using the ec fonts.
6864 The numbering of chapter headings is made in the same way as the numbering
6865 of section headings, that is without the extra line
6866 \begin_inset Quotes eld
6869 Chapter\SpecialChar \ldots{}
6871 \begin_inset Quotes erd
6875 In addition, the appearance of the headings can be modified by using a
6876 number of options (in LyX to be entered in the field
6890 ayout\SpecialChar \menuseparator
6898 A detailed German description of these options can be found in the Koma-Script
6906 The main means in the Koma-Script document classes to design the type area
6915 (in LyX to be entered in the extra class options field in the dialog
6920 ocument\SpecialChar \menuseparator
6928 They make a clearer modification of page margins possible as do the options
6934 ocument\SpecialChar \menuseparator
6942 A detailed German description of these and other type area options can
6943 be found in the Koma-Script documentation
6950 The LaTeX document classes of the Koma-Script family define a number of
6951 additional commands.
6952 Those part of it which makes sense in LyX is implemented in corresponding
6956 A detailed German description of the LaTeX document classes of the Koma-Script
6957 family can be found in the Koma-Script documentation
6967 There is an English translation
6971 , but it is not a complete one.
6974 The following sections describe only those aspects, which are relevant
6978 article (koma-script), report (koma-script), and book (koma-script)
6981 The document classes
6983 article (koma-script)
6987 report (koma-script)
6997 are implemented in the layout files
7010 They contain all the paragraph types of the corresponding standard document
7023 , resp., partly modified, with the exception of the LyX specific
7027 -type, which is replaced by the new
7031 -type having the same functionality.
7036 -Type there is a number of new paragraph types added.
7043 letter (koma-script)
7056 : are equivalents to
7064 , resp., additionally inserting an entry in the table of contents.
7073 are not contained in
7075 article (koma-script)
7096 , resp., additionally clearing running heads.
7103 article (koma-script)
7123 report (koma-script)
7125 , but since this is identical to
7129 , is has not been implemented in LyX.
7139 : generates a heading directly above the following paragraph in the standard
7140 character size without affecting the structure of the document.
7151 are special captions which respect the different space settings needed for
7152 captions placed above or below an element (if you follow strict typographic
7153 rules, you might want to place table captions always above the table).
7154 You can also use the class option
7171 You need at least Koma-Script version 2.8q to use this.
7178 : can be used to set a bonmot, e.
7198 at the beginning of a chapter.
7199 If you use the optional argument (
7204 nsert\SpecialChar \menuseparator
7208 ), you can insert the dictum's author there.
7209 Dictum and author are separated by a line.
7210 You need at least Koma-Script version 2.8q to use this.
7217 article (koma-script)
7222 The following types, together with the standard types
7234 , form the title area of the document.
7235 They must be entered ahead of the first
7236 \begin_inset Quotes eld
7240 \begin_inset Quotes erd
7249 The corresponding LaTeX commands must appear before the
7258 When such a type is used more than once, the latter usage overwrites the
7259 former one, that means, for every type only the latest usage is valid.
7260 The order of the different types however has, like
7272 , no effect on the appearance of the produced document.
7279 : produces a centered paragraph above the ordinary title (
7291 ) for the subject of the document.
7298 : produces a centered paragraph below the ordinary title (
7310 ) for the publishers' name.
7319 report (koma-script)
7325 produces a centered paragraph on its own page behind the title page, or
7328 article (koma-script)
7330 produces a centered paragraph below the ordinary title (
7353 : produces a left aligned paragraph above the ordinary title (
7369 ) for a document`s head.
7376 : produces in a double-sided print in
7378 report (koma-script)
7384 a left-aligned paragraph at the top of the title page`s back or has no
7385 effect in a single-sided print or in
7387 article (koma-script)
7396 : produces in a double-sided print in
7398 report (koma-script)
7404 a left-aligned paragraph at the bottom of the title page`s back or has
7405 no effect in a single-sided print or in
7407 article (koma-script)
7416 : produces a special
7417 \begin_inset Quotes eld
7421 \begin_inset Quotes erd
7424 page ahead of the actual document containing a paragraph without special
7428 The layout files for the document classes
7430 article (koma-script)
7434 report (koma-script)
7445 This is thought of as a place to define your own types.
7450 in your personal layout directory and edit the file!
7453 letter (koma-script)
7471 letter (koma-script)
7473 is implemented in the layout file
7478 It contains all the paragraph types of the corresponding standard document
7483 , partly modified, with the exception of the LyX specific types
7495 type, which is replaced by the new
7500 In addition, it contains, in contrast to the standard document class, the
7518 Furthermore, there are a number of new letter specific types.
7534 The appearance of the letter produced by this document class can be controlled
7535 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7541 For example, the standard appearance of the letter`s heading, consisting
7542 of name and address, is quite self-willed.
7544 \begin_inset Quotes eld
7548 \begin_inset Quotes erd
7551 heading is produced by the following LaTeX commands in the preamble:
7604 A detailed German description of such LaTeX commands can be found in the
7605 Koma-Script documentation
7610 With it, the letter's author can produce his personal letter layout.
7621 define the beginning of the letter and must be used in every letter.
7622 To emphasize them in the LyX document class, they are marked with the letter
7633 It is possible to write any number of letters in one file.
7638 type produces a new letter using the same addressee and a
7642 type produces a new addressee.
7659 are ordinary paragraph types and can also be used several times in one
7660 and the same letter.
7667 : produces a paragraph for the addressee and implicitly defines the beginning
7675 : produces a paragraph for the form of address and implicitly produces a
7683 : produces a paragraph for a close.
7690 : produces a paragraph for a postscript.
7697 : produces a paragraph for a distribution list.
7704 : produces a paragraph for enclosures.
7747 are input types provided with a label to enter information, which will
7748 be processed by the document class.
7754 It could be seen as a matter of inconsequence, that the types
7762 described above are not such input types as well.
7763 Because of the special meaning of those types, however, I have implemented
7764 them as ordinary paragraph types with a one letter mark in the left margin.
7765 Moreover, it would affect my feeling of symmetry, if the
7773 type had such a serious different appearance.
7776 The types must be used ahead of the corresponding
7783 An implementation of these types in a WYSIWYG fashion does not seem to make
7784 sense, because the real appearance of the produced letter does not only
7785 depend on the usage of the particular type, but also on other factors.
7786 For example, a signature entered in the
7790 type will in the standard behavior appear in the produced letter only,
7791 when in the same letter also a
7796 The entered value of the
7800 type will in the standard behavior not appear in the produced letter at
7802 The possibility to design the letter`s heading freely is already indicated
7803 in a footnote above.
7806 The input types can also be used as empty paragraphs.
7807 This makes sense e.\SpecialChar ~
7818 type is not used at all, in the standard behavior the value of the
7822 type is used as signature, whereas if an empty
7826 type is used, no signature value is defined.
7829 By using the input types it is possible to write a letter template, containing
7830 filled input types with your personal dates (name, address, etc.) and empty
7831 input types for other dates you want to enter.
7838 : sender's name, in the standard behavior appears as a centered paragraph
7839 in small caps in the letter`s heading.
7846 : sender's signature, in the standard behavior appears below the
7855 type is used, the value of the
7859 type appears instead.
7866 : sender's address, in the standard behavior appears in a centered paragraph
7867 in the letter`s heading below the sender's name.
7874 : sender's telephone number, in the standard behavior only sets the LaTeX
7888 : place of the letter`s making.
7895 : date of the letter`s making.
7904 , in the standard behavior, produce the place and the date in a right-aligned
7905 line below the addressee's field.
7910 type is used, neither place nor date appear, independent of the value of
7920 type is used, the date of the letter `s production is used.
7927 : sender`s back address, in the standard behavior appears above the addressee's
7928 field in a small sans serif font.
7935 : special mail information, in the standard behavior appears underlined
7936 above the addressee's field below the back address.
7943 : additional information, in the standard behavior appears on right side
7944 below the addressee`s field.
7951 : the letter's title, in the standard behavior appears in a big, bold, sans
7952 serif font above the subject.
7959 : the letter's subject, in the standard behavior appears in a bold font
7987 produce a business letter like line above the
7991 line containing the fields
7992 \begin_inset Quotes eld
7996 \begin_inset Quotes erd
8000 \begin_inset Quotes eld
8004 \begin_inset Quotes erd
8008 \begin_inset Quotes eld
8012 \begin_inset Quotes erd
8016 \begin_inset Quotes eld
8020 \begin_inset Quotes erd
8024 \begin_inset Quotes eld
8028 \begin_inset Quotes erd
8032 \begin_inset Quotes eld
8036 \begin_inset Quotes erd
8040 For the date field, the value of the
8046 \begin_inset Quotes eld
8049 business letter types
8050 \begin_inset Quotes erd
8053 is used, the value of the
8057 type however does not appear, but only the LaTeX variable
8064 The ordinary output of place and date in a right-aligned line below the
8065 addressee`s field is suppressed.
8066 The types are implemented as input types provided with a label and must
8067 be used ahead of the corresponding
8109 The new letter class: letter (koma-script v.2)
8114 Jürgen Spitzmüller
8116 \added_space_top medskip \noindent
8117 Koma-Script version 2.8 has introduced a new letter class
8121 which superceeds the now unsupported
8126 It has --- on the LaTeX side --- a completely new interface and is not
8127 compatible with the old class.
8128 Therefore, LyX supports both, though it is recommended to use the new class.
8131 This class covers the same functionality as
8133 letter (koma-script),
8140 (receiver's address, same as
8157 will start a new letter (i.
8177 you can write several letters per document).
8178 New elements are sender's
8194 and the possibility to use a
8203 nsert\SpecialChar \menuseparator
8213 The biggest improvement is, though, that the letter's layout is configurable
8214 at almost any needs.
8215 This can be done via the preamble or with a special style file (Letter
8216 Class Option, extension
8220 ), that will be read in as a class option.
8226 The KOMA package comes with some default
8231 There is, for instance, a
8235 file that follows german typesetting rules, or a
8239 that provides the default layout of the old
8244 The latter can be loaded with the class option
8253 ayout\SpecialChar \menuseparator
8258 ocument\SpecialChar \menuseparator
8268 template that is included in LyX for examples.
8269 A detailed description is to be found in the Koma-Script documentation
8280 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8284 The chapter number of a
8288 type appears on a line of its own above the chapter heading instead of
8289 appearing in the same line ahead of it.
8290 The cause for that is the LyX internal behavior for the labeltype
8297 The headings of the types
8306 \begin_inset Quotes eld
8310 \begin_inset Quotes erd
8313 LaTeX table of contents, but not in the LyX table of contents (
8318 ocument\SpecialChar \menuseparator
8334 document class appear in a skip separation mode, not indented.
8335 This is the standard behavior, no special LaTeX commands are needed for
8342 ocument\SpecialChar \menuseparator
8349 dialog the corresponding radio button indicates
8365 value always has the effect that extra LaTeX commands are inserted in the
8366 document to produce the gap, which is not what is wanted in this case.
8384 These are the layout files for some of the journal formats used by Springer
8385 Verlag and listed on
8386 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
8390 , where you should also go to fetch the class files (yes, these are LaTeX2e
8392 It is a modular system: the things common to all journals are implemented
8397 , which journal-specific layout files (such as, e.g.,
8401 for Journal of Geodesy) can include.
8404 This means that implementing support for any other Springer journal on this
8405 list is as simple as writing your own
8413 file following the outline given in
8421 It is reasonably well tested only for the Journal of Geodesy.
8430 come with the standard LyX distribution.
8431 Install the relevant class file (downloaded from Springer) in a proper
8432 directory, reconfigure LaTeX (in the teTeX case by running
8436 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8437 LyX and it should work.
8443 A large number of theorem-like styles ---
8449 \SpecialChar \ldots{}
8457 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8458 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8461 See the Springer class file documentation for details.
8480 Probability Theory and Related Fields
8486 --- Jean-Marc Lasgouttes
8489 Add your own, it isn't so hard!
8495 These files are partly based on the older
8499 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8505 layout, are now defunct.
8506 Jean-Marc Lasgouttes helped out big in making me find my way around the
8507 LyX layout file mechanism.
8514 But probably less than in the old hacked-LaTeX
8521 Limitations e.g.: does not display the number for theorem-like layouts, just
8540 These are the layout files for some of the journals of the American Geophysical
8542 It is assumed that you have both the AGU's own class files and AGUplus
8543 installed (everything to be found at
8544 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
8563 They are still called this in the LyX GUI, though their LaTeX equivalents
8564 in the AGU classes are
8575 Newly defined styles are
8612 These are mostly manuscript attributes and defined in the AGU class documentati
8616 I suspect this is still badly incomplete.
8643 Journal of Geophysical Research
8652 Add your own, it isn't so hard! Look at the
8663 Bugs and things to remember
8666 In order to use the new layouts, you must remember to do the following for
8675 This can be done in the
8677 layout\SpecialChar \menuseparator
8682 document\SpecialChar \menuseparator
8686 (AGU articles are always in English, right? So
8702 (Yes, this is a bug.)
8705 Make sure you use the
8709 bibliography style, by entering
8713 into the second field of the BibTeX inset.
8714 None of the standard styles will do.
8732 This is the layout file for the European Geophysical Society journals.
8737 can be downloaded from the web site of the EGS under
8738 \begin_inset LatexCommand \url{www.copernicus.org}
8750 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8758 The current layout file is unfortunately very unmodular and would benefit
8759 from using the various
8771 \begin_inset LatexCommand \label{sec:slitex}
8788 This section describes how to use LyX to make slides for overhead projectors.
8789 There are two document classes that can do this: the default slides class
8795 This section documents the former.
8798 I'm going to say this again, nice and clear, so that there's no misunderstanding
8801 \added_space_top bigskip \added_space_bottom bigskip \align center
8804 This section documents the class
8805 \begin_inset Quotes eld
8813 \begin_inset Quotes erd
8821 If you're looking for the documentation for
8822 \begin_inset Quotes eld
8830 \begin_inset Quotes erd
8833 , check out section\SpecialChar ~
8835 \begin_inset LatexCommand \ref{sec:foiltex}
8845 \begin_inset Quotes eld
8853 \begin_inset Quotes erd
8856 ] is actually somewhat better than the default
8866 \SpecialChar \ldots{}
8867 or so I've been told repeatedly by its advocates.
8868 Having never used it, I have no idea if this claim is true or not.
8871 which this section documents.
8874 This class is the LaTeX2e improvement of the old
8879 Every LaTeX2e distribution includes this class [which I'll just refer to
8881 \begin_inset Quotes eld
8889 \begin_inset Quotes erd
8892 from now on], so you're bound to have it.
8893 As I noted earlier, there are other classes, such as
8897 , which also produce slides for overhead projectors and do a better job
8899 However, there are some things which
8903 can do which the others can't, such as generate overlays.
8904 Read on to learn more!
8908 \begin_inset LatexCommand \label{sec:slidesetup}
8915 Obviously, to use this document class, you need to select
8916 \begin_inset Quotes eld
8924 \begin_inset Quotes erd
8927 from the class list in the
8932 ocument\SpecialChar \menuseparator
8940 There are some other special things you should know about this class:
8943 Don't bother changing the options
8948 They're not supported by the
8963 behaves a bit differently for this class.
8964 The possible choices and what they do are as follows:
8972 The final output contains page numbers in the lower right corner.
8983 , but also prints out any time markers you've put in.
8984 This is the default.
8991 The final output contains no page numbers, time markers, or alignment markers.
8999 class has an extra option:
9005 \begin_inset Quotes eld
9013 \begin_inset Quotes erd
9016 in the extra class options.
9020 Using this options allows you to add time markers to
9025 See section\SpecialChar ~
9027 \begin_inset LatexCommand \ref{sec:slideNote}
9035 You can also use the template file
9036 \begin_inset Quotes eld
9044 \begin_inset Quotes erd
9047 to automatically set up a document to use the
9056 ile\SpecialChar \menuseparator
9065 to open your new document].
9066 The template file also contains some examples of the special paragraph
9067 environments used by this class.
9068 I'll describe those next.
9071 Paragraph Environments
9072 \layout Subsubsection
9074 Supported Environments
9077 The first thing you'll notice when you start up a new
9081 document is the font size and type: it's the equivalent of the size
9082 \begin_inset Quotes eld
9090 \begin_inset Quotes erd
9099 This is also what's used in the output.
9101 \begin_inset Quotes eld
9105 \begin_inset Quotes erd
9108 to remind you that this is a slide.
9109 Your final slides will use a larger font; ergo, you'll have less space.
9110 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9113 The next thing that becomes obvious is the changes to the paragraph environment
9114 pull-down box [at the far-left end of the toolbar].
9115 Most of the paragraph environments you're used to seeing are missing.
9116 There are also five new ones.
9121 class itself only supports certain paragraph environments:
9179 All of the other standard environments, including the section-heading environmen
9180 ts, aren't used in the
9187 On the other hand, you'll notice the following new environments:
9215 These five are kind of quirky, due to a
9216 \begin_inset Quotes eld
9220 \begin_inset Quotes erd
9224 You see, LyX doesn't permit you to nest any other paragraph environment
9225 into an empty environment.
9226 Now, that's fine and dandy, but it means that you wouldn't be able to start
9227 a slide with anything except plain text.
9228 To deal with this, I've performed a little
9229 \begin_inset Quotes eld
9233 \begin_inset Quotes erd
9237 \layout Subsubsection
9239 Quirks of the New Environments
9240 \begin_inset LatexCommand \label{sec:slideQuirk}
9247 All five of the new paragraph environments are somewhat quirky due to inherent
9248 limitiations in the current version of LyX.
9249 As I just mentioned, LyX forbids environments that begin with another environme
9251 To get around this, the
9255 environment isn't a paragraph environment as described in the
9276 \begin_inset Quotes eld
9279 pseudo-environments.
9280 \begin_inset Quotes erd
9283 They look like a section heading or a
9284 \begin_inset Quotes eld
9292 \begin_inset Quotes erd
9295 but really begin a [and, if necessary, end the previous] paragraph environment.
9305 \begin_inset Quotes eld
9309 \begin_inset Quotes erd
9312 These two perform some action.
9315 A common feature of all five environments,
9335 , is a rather long-ish label.
9336 The text following this label --- ordinarily the contents of the paragraph
9337 environment --- is utterly irrelevant for
9358 LyX completely ignores it.
9359 In fact, you can leave these five environments completely empty.
9367 to put any text after the rather long-ish label, you might want to.
9368 This could be a short description of the contents of the
9373 In that case, enter in your descriptive comment and hit
9377 as you normally would.
9380 If, on the other hand, you don't want to enter in any descriptive text,
9381 you'll hit another LyX quirk.
9382 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9383 environment until you put something in the old one.
9387 Start entering the text that will
9415 Now move to the beginning of that paragraph.
9427 Finally, change this new, empty paragraph to a
9451 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9455 Making a Presentation with
9466 \layout Subsubsection
9475 If you're expecting this section to teach you how to actually make a presentatio
9476 n, you'll be sorely disappointed.
9477 Naturally, I'll describe all of the ways the
9481 class can assist you in preparing the materials for a presentation.
9482 Filling in the contents, however, is up to you.
9487 the LyX philosophy.]
9494 environment [in the manner described in section\SpecialChar ~
9496 \begin_inset LatexCommand \ref{sec:slideQuirk}
9500 ] tells LyX to begin a new slide [duh].
9501 The label for this environment/
9502 \begin_inset Quotes erd
9506 \begin_inset Quotes erd
9510 \begin_inset Quotes eld
9514 \begin_inset Quotes erd
9517 in cool blue, followed by the label,
9518 \begin_inset Quotes eld
9522 \begin_inset Quotes erd
9526 Any text or paragraph environments that follow this one go on the new slide.
9530 Slides are probably the only time you'll need to forcibly end pages in LyX
9531 (this can be specified in the
9536 In fact, you'll want to, once you finish entering the contents of one slide.
9537 If you've entered more text than can physically fit on a slide, the extra
9538 overflows onto a new slide.
9539 I don't recommend doing this, however, since the overflow slide won't have
9540 any page number on it.
9541 Furthermore, it may interfere with any
9545 you've made to accompany the oversized
9560 environments work the same way as the
9566 \begin_inset Quotes eld
9570 \begin_inset Quotes erd
9573 followed by a label [
9574 \begin_inset Quotes eld
9578 \begin_inset Quotes erd
9582 \begin_inset Quotes eld
9586 \begin_inset Quotes erd
9590 The color is a stunning magenta instead of blue, and the
9591 \begin_inset Quotes eld
9595 \begin_inset Quotes erd
9598 will look different, in style and in length.
9599 The label fonts of all three also differ from one another.
9606 , if the contents of a
9614 exceed the physical size of a slide or sheet of paper, the extra will overflow
9616 Again, you should avoid this.
9617 It defeats the whole purpose of
9626 \layout Subsubsection
9641 is a slide that sits atop another slide.
9642 Perhaps you wish to discuss a figure on the main
9646 before displaying the text associated with it.
9647 One way to accomplish this is tape a flap of dark paper over the part of
9652 you want to display later.
9653 This method fails, however, if you wish to overlap one graph with another,
9655 You would then have to fumble while speaking to align the two separate,
9660 s to align the two graphs.
9665 environment in both cases makes life much easier.
9672 receives the page number of its
9673 \begin_inset Quotes eld
9677 \begin_inset Quotes erd
9685 \begin_inset Quotes eld
9693 \begin_inset Quotes erd
9702 Presumably, mutliple
9707 \begin_inset Quotes eld
9715 \begin_inset Quotes erd
9719 \begin_inset Quotes eld
9727 \begin_inset Quotes erd
9731 \begin_inset Quotes eld
9739 \begin_inset Quotes erd
9742 , etc.\SpecialChar ~
9743 appended to the page number of the parent
9751 Clearly, you want the contents of both the
9759 to each fit on a single physical slide! You should probably consider an
9765 \begin_inset Quotes eld
9769 \begin_inset Quotes erd
9781 class provides a visual cue for this: the label at the start of an
9785 is shorter than that at the start of a
9790 Lastly, when you generate printable output, you'll find alignment markers
9791 in all four corners of both the
9800 These will assist you in lining up the two physical slides.
9803 The major problem in overlaying two slides is aligning the contents of the
9805 How much space should you leave for that graph on the second slide? Worse
9806 still, what if you want a graph and a sentence on second slide, but there
9807 is text on the main transparency that goes in between them? You could try
9808 and insert vertical space of the right size.
9809 The better way is to use
9820 As their names imply,
9828 are two command-like paragraph environments that make all subsequent text
9829 invisible and visible, respectively.
9830 Note from section\SpecialChar ~
9832 \begin_inset LatexCommand \ref{sec:slideQuirk}
9836 that you don't place anything
9840 these two environments, however.
9845 , it inserts a centered, sky-blue label into the page reading
9846 \begin_inset Quotes eld
9849 <Invisible Text Follows>
9850 \begin_inset Quotes erd
9854 For paragraphs following this label, the parts of the
9862 ; it doesn't matter which] where they would be contain instead blank space.
9870 , the corresponding centered label is
9871 \begin_inset Quotes eld
9874 <Visible Text Follows>
9875 \begin_inset Quotes erd
9879 Paragraphs following this label behave normally.
9880 Note that the beginning of a new
9892 automatically shuts off an
9897 It's therefore not necessary to use
9908 By now, it should be obvious how to create overlay transparencies using
9909 the proper combination of
9932 , including everything that will appear on it, whether on the main slide
9940 Before each figure or paragraph that will appear only on the
9949 If necessary, insert a
9953 environment after the
9964 immediately following the
9971 Copy the contents of this
10005 There's one problem with the way I've designed the LyX
10009 class: you can't make text in the middle of a paragraph invisible, nor
10010 make text in the middle of an invisible paragraph visible again.
10011 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10017 The commands of interest are:
10024 invisible \SpecialChar \ldots{}
10032 visible \SpecialChar \ldots{}
10036 \SpecialChar \ldots{}
10037 and need to be marked as TeX.
10039 \begin_inset Quotes eld
10043 \begin_inset Quotes erd
10046 you wish to change goes in between the brackets [and after the
10059 If you don't know how to mark text as TeX, see the apprpriate section of
10068 \layout Subsubsection
10079 \begin_inset LatexCommand \label{sec:slideNote}
10094 is associated with a
10095 \begin_inset Quotes eld
10099 \begin_inset Quotes erd
10111 class provides visual cues.
10116 is shorter than that of a
10120 [yet longer than that of an
10124 ] and, like the label of an
10128 is shockingly magenta.
10129 Additionally, the printed
10133 has the page number of its
10134 \begin_inset Quotes eld
10138 \begin_inset Quotes erd
10146 \begin_inset Quotes eld
10154 \begin_inset Quotes erd
10158 \begin_inset Quotes eld
10166 \begin_inset Quotes erd
10170 \begin_inset Quotes eld
10178 \begin_inset Quotes erd
10182 You can have multiple
10186 s associated with a single
10198 , you'll probably want to break up long
10202 s so that they fit on a single sheet of paper.
10209 is obvious: it contains anything additional you might want to say about
10215 It could also be used as a sheet of reminders for a particular
10220 In the case of the latter, you might want to make use of time markers.
10226 \begin_inset Quotes eld
10230 \begin_inset Quotes erd
10233 support for time markers, a
10238 So, you'll have to resort to using the LaTeX codes.
10241 To use time markers, you'll need to specify the extra class option
10242 \begin_inset Quotes eld
10250 \begin_inset Quotes erd
10253 [see section\SpecialChar ~
10255 \begin_inset LatexCommand \ref{sec:slidesetup}
10260 This option turns on timing marks, which will appear in the lower-left-hand
10266 To set what appears in the time marker, you use the LaTeX commands
10267 \begin_inset Quotes eld
10277 \begin_inset Quotes erd
10281 \begin_inset Quotes eld
10291 \begin_inset Quotes erd
10295 The arguments of both commands are time measured in seconds.
10297 \begin_inset Quotes eld
10307 \begin_inset Quotes erd
10310 sets the time marker to a given time.
10312 \begin_inset Quotes eld
10322 \begin_inset Quotes erd
10325 increments the time marker by the specified amount.
10326 Using time markers and
10330 s in this fashion, you can remind yourself how much time to spend on a particula
10338 There's one last feature to describe.
10339 Clearly, you'd like to print out all of your
10347 s on transparencies while printing all of your
10364 with which it is associated.
10365 What's a person to do?
10368 Luckily, there are two LaTeX commands that allow you to select what to print
10370 Both must be placed into the preamble of your document.
10372 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10387 will cause the output to contain only the
10396 Correspondingly, the command
10397 \begin_inset Quotes eld
10409 \begin_inset Quotes erd
10412 prevents the output of anything but
10417 I'd advise placing both commands in the preamble and initially comment
10419 You can then preview your entire presentation as you write.
10420 When you're done writing, you can then uncomment one of the two to select
10421 what you want to print.
10422 I like to uncomment
10423 \begin_inset Quotes eld
10435 \begin_inset Quotes erd
10438 , print to a file with
10439 \begin_inset Quotes eld
10447 \begin_inset Quotes erd
10450 in its name, comment it back out, then uncomment
10451 \begin_inset Quotes eld
10463 \begin_inset Quotes erd
10467 \begin_inset Quotes eld
10475 \begin_inset Quotes erd
10479 I can then send either file to a printer, loading transparencies or plain
10480 paper as appropriate.
10483 You can also provide other arguments to the
10484 \begin_inset Quotes eld
10494 \begin_inset Quotes erd
10498 \begin_inset Quotes eld
10508 \begin_inset Quotes erd
10512 See a good LaTeX book for details.
10519 Class Template File
10522 I have also provided a template file,
10523 \begin_inset Quotes eld
10531 \begin_inset Quotes erd
10539 To use it, begin your new presentation with
10544 ile\SpecialChar \menuseparator
10554 Your new LyX presentation file will contain an example
10575 additionally contain an example of the use of
10584 Lastly, the preamble will contain:
10587 % Uncomment to print out only slides and overlays
10602 % Uncomment to print out only notes
10615 One final thing: I created this class to support the LaTeX2e
10616 \begin_inset Quotes eld
10624 \begin_inset Quotes erd
10627 class, one of the built-in LaTeX2e classes.
10628 Neither I nor the rest of the LyX Team endorse or oppose the use of this
10629 built-in slide class.
10630 It's here if you want it or need it.
10631 There exist other LaTeX2e classes for creating presentations, such as the
10636 class [see section\SpecialChar ~
10638 \begin_inset LatexCommand \ref{sec:foiltex}
10643 \begin_inset Quotes eld
10651 \begin_inset Quotes erd
10654 package [present on some TeX distributions].
10655 The latter is not yet supported under LyX.
10661 Perhaps you can take on the task\SpecialChar \ldots{}
10665 I know nothing about these other classes.
10666 Try them out to see what sort of alternative they provide.
10677 \begin_inset LatexCommand \label{sec:foiltex}
10692 This section describes how to use LyX to make slides for overhead projectors.
10693 There are two document classes that can do this: the default slides class
10699 This section documents the latter.
10702 I'm going to say this again, nice and clear, so that there's no misunderstanding
10705 \added_space_top bigskip \added_space_bottom bigskip \align center
10708 This section documents the class
10709 \begin_inset Quotes eld
10717 \begin_inset Quotes erd
10725 If you're looking for the documentation for
10726 \begin_inset Quotes eld
10734 \begin_inset Quotes erd
10737 , check out section\SpecialChar ~
10739 \begin_inset LatexCommand \ref{sec:slitex}
10744 If your machine doesn't have the
10749 \begin_inset Quotes eld
10757 \begin_inset Quotes erd
10760 ] installed, you'll probably have to use the default
10764 class, which isn't quite as good as
10773 class is designed for use with version 2.1 of the
10777 LaTeX class file which is now an integral part of LaTeX2e.
10783 Obviously, to use this document class, you need to select
10784 \begin_inset Quotes eld
10792 \begin_inset Quotes erd
10804 Document\SpecialChar ~
10808 There are some settings in the
10810 Document\SpecialChar ~
10813 dialog that you should know about that are specific to this class:
10816 Don't change the options
10826 Document\SpecialChar ~
10830 They're ignored by the
10837 The default font size is 20pt with the other options being 17pt, 25pt and
10841 The default font is
10849 but all math equations are still typeset in the usual roman font.
10856 TeX supports A4 and Letter paper sizes as well as a special size for working
10858 It doesn't support A5, B5, legal or executive paper sizes.
10861 Don't bother changing the
10865 settings because they are ignored anyway.
10866 All floats appear where they are defined in the text.
10876 setting behaves a bit differently for this class.
10881 TeX provides extensive footer and header capabilities including a user-defined
10883 See section\SpecialChar ~
10885 \begin_inset LatexCommand \ref{sec:foilfoot}
10890 The title page is treated differently to all other pages in the document
10899 has the logo centered at the bottom of the page (if one is defined).
10900 The possible page style choices and what they do are as follows:
10903 \labelwidthstring MMMMMMM
10911 The final output contains no page numbers, or other headers or footers
10912 (except footnotes of course).
10915 \labelwidthstring MMMMMMM
10923 The final output contains page numbers centered at the bottom of the page.
10924 No other headings or footers (other than footnotes).
10926 \labelwidthstring MMMMMMM
10932 Page numbers in lower right corner.
10933 Additional headers and footers are also shown.
10934 This is also the default.
10936 \labelwidthstring MMMMMMM
10942 Gives you access to the
10946 package although its use with
10950 TeX is discouraged by the writer of the
10954 TeX package because of some potential page layout clashes.
10956 \layout Subsubsection
10961 The following options may be used in the extra class options in the
10966 ocument\SpecialChar \menuseparator
10975 \labelwidthstring MMMMMMx
10981 This sets up the page layout for 7.33in by 11in paper, which is about the
10982 same aspect ratio as a 35mm slide, making it a bit easier to work with
10985 \labelwidthstring MMMMMMx
10991 Places a rule across the page below the header on every page except the
10994 \labelwidthstring MMMMMMx
11000 Places a rule across the page above the footer on every page except the
11003 \labelwidthstring MMMMMMx
11009 This is automatically set each time you create a new
11018 TeX to use the dvips driver to rotate those pages that are set as landscape
11021 \labelwidthstring MMMMMMx
11027 Simply changes the page dimensions to those of a landscape page but doesn't
11029 Thus if you use this option you need to use an external program to rotate
11030 each page or feed your paper through your printer as landscape.
11031 Note that this option effectively reverses the roles of the
11039 environments (don't worry these are described in the next section).
11041 \labelwidthstring MMMMMMx
11047 Equation numbers on the left.
11049 \labelwidthstring MMMMMMx
11055 Flush-left equations.
11058 Supported Environments
11061 Most of the environments commonly supported in other classes are also supported
11067 There are several additional environments provided by
11071 TeX as well as a couple added by LyX.
11072 The following environments are shared with other classes:
11082 begin{multicols}{2}
11191 That is, all the major environments apart from the sectioning environments.
11192 Since foils are essentially self-contained sections, with a title and body,
11197 TeX provides specific commands for starting new foils and these are:
11210 LyX also provides slightly modified versions of these two environments called:
11220 ShortRotatefoilhead
11223 and the differences will be explained in the next section.
11226 Since foils are often used in presenting ideas or new theorems and such
11231 TeX also provides a comprehensive box of goodies for presenting them:
11241 begin{multicols}{2}
11315 The starred versions are unnumbered while the unstarred versions are numbered.
11316 There are also two list environments added by LyX and these are:
11333 TeX provides some powerful header and footer capabilities that are best
11334 set in the preamble although they may be set at any point in a document.
11335 If you want to change these settings in your document the best place to
11336 do so is at the very top of a foil,
11341 straight after the foilhead.
11344 For this purpose, the following command styles are provided [
11358 begin{multicols}{2}
11377 Right\SpecialChar ~
11383 Right\SpecialChar ~
11412 There are also a few commands provided by
11416 TeX that aren't directly supported by LyX but I'll tell you what they do
11417 and how to use them in section\SpecialChar ~
11419 \begin_inset LatexCommand \ref{sec:unsuppfoils}
11426 Building a Set of Foils
11429 This section will give a simple introduction to using the different environments
11430 to build a set of foils.
11431 If you want to see an example set of foils take a look at the
11435 file accessible from the
11440 ile\SpecialChar \menuseparator
11445 pen\SpecialChar \ldots{}
11454 \layout Subsubsection
11456 Give It a Title Page
11459 Unlike other classes that provide
11479 creates the title on a page of its own.
11480 If you leave out the
11484 environment LaTeX will substitute the current date (every time you regenerate
11486 \layout Subsubsection
11491 As I mentioned earlier, there are four ways of starting a new foil.
11492 For portrait foils you should use
11501 The difference between these two environments is the amount of space between
11502 the title of the foil (the foilhead) and the body of the foil.
11505 Landscape foils are generated using the
11511 ShortRotatefoilhead
11514 Again the only difference is the spacing between foilhead and body.
11515 Both of the short versions have 0.5 inches less separation between the foilhead
11520 One problem with the support for landscape foils is the requirement that
11521 you have to use the
11525 driver to generate the PostScript® output otherwise the foils won't be
11527 It is possible to get landscape foils even if you haven't got the
11531 driver provided you can feed your foils sideways through your printer ;-)
11532 \layout Subsubsection
11534 Theorems, Lemmas, Proofs and more
11537 Due to a small bug in LyX you can't have two of the same type of these environme
11538 nts directly following each other.
11539 They must be separated by something.
11540 If you try, you will just be extending the previous environment as if you
11541 had merged the two environments together.
11542 So, how do you get around this problem? The simplest option is to insert
11543 some text between the two environments or add a
11547 environment between the two with just a
11548 \begin_inset Quotes eld
11556 \begin_inset Quotes erd
11560 This will force LyX to produce two separate environments and hence the
11561 correct LaTeX output.
11562 An example is provided in the example file included with the LyX distribution.
11563 Remember, this problem only occurs if you are trying to place two of the
11564 same type of theorem-like environments one directly after the other.
11565 \layout Subsubsection
11570 You get all the commonly supported list styles found in other classes as
11571 well as two new ones.
11572 I'll only describe the new ones here.
11573 If you want to find out more about the other list environments check out
11579 If you intend to use itemized lists you might also want to read about the
11582 Itemize\SpecialChar ~
11583 Bullet\SpecialChar ~
11586 dialog described above in section\SpecialChar ~
11588 \begin_inset LatexCommand \ref{sec:bullet}
11595 The two new list styles,
11603 , are designed to make it easier for you to create lists of do's and don'ts
11604 or right and wrong by providing dedicated environments that use a tick
11605 or a cross as the label of the list.
11606 These lists are in fact dedicated variants of the
11611 They do however require that you have the
11615 packages installed.
11616 \layout Subsubsection
11625 TeX redefines the floating tables and figures so that they appear exactly
11626 where they are in the text rather than pushing them to the top of the page
11627 or to some user specified location.
11628 In fact if you change the float placement settings they are simply ignored.
11629 \layout Subsubsection
11631 Page Headers and Footers
11632 \begin_inset LatexCommand \label{sec:foilfoot}
11648 are two commands used to control the left-footer text string.
11649 The first is meant to allow you to include a graphic logo on your foils
11651 \begin_inset Quotes eld
11659 \begin_inset Quotes erd
11663 While the second is meant to provide a classification for the audience,
11670 It is empty by default.
11673 The remaining page corners can be filled by
11675 Right\SpecialChar ~
11678 (which defaults to page numbers),
11680 Right\SpecialChar ~
11696 \begin_inset LatexCommand \label{sec:unsuppfoils}
11703 All the commands mentioned below need to be set in a
11711 within another environment.
11712 \layout Subsubsection
11717 All lengths are adjusted using the
11740 should be replaced by the name given to the length you want to change and
11745 is the length value.
11746 All lengths should be specified in units of length such as inches (
11758 ) or relative to some document or font-based length such as
11768 It's possible to change the spacing between a foilhead and the body of the
11769 foil by adjusting the length specified by
11776 For example, to make
11780 foilheads 0.5 inches closer to their bodies put the following in the preamble:
11787 foilheadskip}{-0.5in}
11790 The spacings around floats can be adjusted by setting these lengths:
11792 \labelwidthstring MMMMMMMMMMM
11800 Separation between the text and the top of the float
11802 \labelwidthstring MMMMMMMMMMM
11810 Separation between the float and the caption
11812 \labelwidthstring MMMMMMMMMMM
11820 Separation between the caption and the following text
11822 \labelwidthstring MMMMMMMMMMM
11830 You can make the captions narrower than the surrounding text by adjusting
11832 Best done relative to
11841 There are also several title page related lengths that you may find useful
11842 if you have a long title or several authors:
11844 \labelwidthstring MMMMMMMMMMM
11852 Separation from headers to
11856 \labelwidthstring MMMMMMMMMMM
11874 \labelwidthstring MMMMMMMMMMM
11888 \labelwidthstring MMMMMMMMMMM
11904 \labelwidthstring MMMMMMMMMMM
11921 The last length related command affects all the list environments.
11932 a list environment then all the vertical spacing between the list items
11934 Note that this is a command not a length so it doesn't require
11940 like the stuff mentioned above.
11941 \layout Subsubsection
11943 Headers and Footers
11958 commands control whether the logo in the
11962 definition appear on a given page.
11969 in the preamble then none of the foils will have the logo on them.
11970 If you don't want the logo on a particular page place the
11976 directly after the foilhead of that page and the
11982 directly after the next foilhead.
11985 If you decide to use the
11989 page style setting in the
11991 Document\SpecialChar ~
11994 dialog you should probably add
12004 to your preamble so headers and footers on landscape pages are correctly
12005 placed when rotated.
12006 This is due to some clashes between the page layouts provided by the
12017 Latex8 (IEEE Conference Papers)
12028 Since this class is specifically for writing submissions to IEEE sponsored
12029 conferences I strongly recommend that you get a copy of their Authors Kit.
12034 package and associated bibliography style file is included in the kit.
12035 The Authors Kit is usually sent out by email once your initial submission
12037 There is a lot of useful information in the Authors Kit explaining formatting
12038 restrictions and so on and I will assume you have read this since that
12039 means I don't have to repeat it all here.
12045 [AR\SpecialChar \@.
12049 Supported Environments
12097 Differences Between Screen and Paper
12100 There are slight differences in appearance mainly with the presentation
12101 of section counters.
12102 On screen the trailing period of the section counter is missing but it
12103 will appear in the output so don't let this worry you.
12106 Hollywood (Hollywood spec scripts)
12117 Getting the format of a Hollywood script right is a
12118 \begin_inset Quotes eld
12122 \begin_inset Quotes erd
12125 It is designed to make the readers focus on content and to be easy and
12126 familiar for the actors to read.
12127 Each page of a script should be one minute of film.
12128 Nothing goes in a script that you cannot see or hear on screen.
12129 The courier 12 pt font should be used throughout.
12136 Speakers' lines should NEVER break in mid-sentence.
12137 If a speaker's lines continue over a page break, repeat the
12141 title followed by (Cont'd).
12151 names as labels then cross-reference the label to insert the name.
12152 The cross-reference dialog will show the current cast of characters.
12153 You can use this to insert the speaker name in narratives also.
12156 Paper size and Margins
12159 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12165 The following environments are available.
12166 You can use hollywood.bind to get the bind keys shown at the right.
12175 Used where nothing else works.
12191 Usually followed by something like
12192 \begin_inset Quotes eld
12195 on Sally waking up.
12196 \begin_inset Quotes erd
12210 Introduces a new INTERIOR camera set-up.
12211 Always followed by DAY or NIGHT, or something similar to define the lighting
12213 Everthing on this line in CAPS.
12224 Introduces a new EXTERIOR camera set-up.
12225 Everthing on this line in CAPS.
12236 The character speaking.
12247 Instructions to the speaker.
12248 The () are automatically inserted, but only the ( will show in LyX.
12249 Both will be printed.
12275 Camera movement instruction.
12311 (O.S) --- off screen
12314 (V.0) --- voice over
12325 PAN --- camera movement
12328 INSERT --- cut to close-up of
12342 Broadway is for writing plays.
12343 The format is more decorative than Hollywood, and much less standardized.
12344 This format should be suitable for workshops.
12350 The same as in Hollywood.
12360 names as labels then cross-reference the label to insert the name.
12361 The cross-reference dialog will show the current cast of characters.
12364 Paper size and Margins
12367 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12373 The following environments are available.
12374 You can use broadway.bind to get the bind keys shown at the right.
12383 You should not have to use this, but it is here for anything that does not
12395 Used to describe stage setting and the action.
12396 First use of speaker names in all CAPs.
12407 Automatically numbered.
12408 On screen it will be arabic, but will print as Roman.
12424 It is just centered text.
12435 Not automatically numbered.
12436 You supply the number.
12437 This is because I couldn't figure out how.
12448 A special case of Narrative to describe the setting and action as the curtain
12460 The speaker's (actor's) title, centered in all CAPS.
12471 Instructions to the speaker.
12472 The parentheses are automatically inserted.
12473 The ( will appear on screen, but both will be in the printed play.
12474 This environment is only used within
12489 What the Speaker says.
12500 The curtain comes down.
12534 \added_space_top bigskip \noindent
12537 Revtex\SpecialChar ~
12540 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12541 \begin_inset Formula $\beta$
12544 release of May, 1999) class.
12551 textclass, which works with RevTeX 3.1.
12552 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12553 That means that it doesn't interact very well with LyX, which requires
12554 LaTeX2e, although it has been kludged to work.
12555 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
12558 RevTeX\SpecialChar ~
12561 textclass should also be pretty easy to use.
12564 These documents are supposed to be used in
12568 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
12569 macros, and assume you'll know what to put in the preamble if necessary.
12575 All you need to do is install RevTeX 4, as described in the package's README
12577 the package can be found at
12578 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
12583 Install it somewhere that LaTeX can see it.
12584 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
12585 (i.e., not the directory where you installed the class file.) Then, if you
12586 reconfigure LyX, it will find the class file and let you use the RevTeX4
12590 Probably the easiest way to get started is either to import a RevTeX 4 document
12597 Revtex\SpecialChar ~
12600 template, found in the templates directory.
12606 Optional arguments to
12613 \begin_inset Quotes eld
12617 \begin_inset Quotes erd
12621 \begin_inset Quotes eld
12625 \begin_inset Quotes erd
12639 Document\SpecialChar ~
12643 Remember that in RevTeX, at least one optional argument is required!
12646 Other preamble matter, like
12655 Latex\SpecialChar ~
12658 dialog, also as usual.
12664 The layouts basically correspond to the commands in RevTeX4.0.
12665 For example, the Email layout corresponds to
12672 Note that (at least as of RevTeX 4.0 Beta), the
12680 layouts are exactly equivalent, so you shouldn't need to use both.
12686 In case you're curious, both were included so that
12690 would be able to translate both
12711 There are a couple of important unique aspects of RevTeX 4 which might cause
12712 bugs that will be even more confusing in LyX.
12732 The LyX equivalent is that there is a separate Thanks layout.
12737 write footnotes in the
12741 layout, or weird things may happen.
12742 See the RevTeX 4 documentation for more details.
12747 Author\SpecialChar ~
12752 Author\SpecialChar ~
12759 layouts must be placed
12767 layout and the corresponding
12784 , the LaTeX won't compile.
12790 The main problem with this layout is that you can't use the optional arguments
12791 to layouts like Email and Title.
12792 (The problem is not unique to this layout; you can't use optional arguments
12793 to the Section layouts either.) This means that after you export that file
12794 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
12795 need to edit the LaTeX file with a text editor to add the optional arguments
12796 to set, e.g., the running title for the page headers.
12797 Lacking these layouts makes the
12803 (and the equivalent
12809 ) useless, so the corresponding layouts don't exist, and will have to be
12820 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
12821 has not been updated yet to take advantage of it.
12827 Article (mwart), book (mwbk) and report (mwrep)
12828 \begin_inset OptArg
12848 The LyX document classes
12864 correspond to the LaTeX document classes
12877 They are replacements for the standard document classes
12889 , resp., and fit better to Polish typography conventions in a number of points.
12896 Unnumbered titles (with star, eg.
12901 ) are added into table of contents,
12904 Additional page styles:
12906 \layout Description
12908 uheadings header with separated lines,
12909 \layout Description
12911 myheadings custom header, contents headers via commands:
12924 \layout Description
12926 myuheadings custom header with separated lines,
12927 \layout Description
12929 outer page number is placed on outer side of page
12935 \layout Description
12937 rmheadings serif titles --- default,
12938 \layout Description
12940 sfheadings sansserif titles,
12941 \layout Description
12943 authortitle on title page first placed is author next title --- default,
12944 \layout Description
12946 titleauthor on title page first placed is title next author,
12947 \layout Description
12949 withmarginpar reserve place on page for margins.
12961 Elsevier Science Publishers B.V.
12962 provides a standard LaTeX document class (
12966 ) for submitting articles to their various journals.
12967 The style file can be downloaded directly from their web site:
12968 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
12973 Instructions are supplied along with the class file, which details the
12974 requirements of the publishers.
12975 LyX includes package that allows for the use of this class, by a layout
12976 and a template file.
12977 Installation of the class file is the same as for any other LaTeX package;
12978 instructions are provided in the Elsevier documentation.
12990 As the Elsevier class file is based mainly on the standard article class,
12991 most of the normal functionality is provided.
12992 The Elsevier class defines a number of mathematical environments, which
12993 are similar to the AMS environments.
12994 These commands are all described in the Elsevier documentation, and are
12998 The easiest way to use the Elsevier style is to base documents on the included
13000 It is best not to use options such as fancy headings or the geometry package,
13001 as elements such as these are defined by Elsevier in their style file.
13002 Ideally, no extra packages except those mentioned in the Elsevier documentation
13004 Essentially, Elsevier require as
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13022 file as possible, as their intention is to take the supplied file and replace
13023 the class file with one for the particular journal to which the paper has
13025 This also means that not too much time should be spent on the formating
13027 When it comes to be published, this will change anyway.
13028 The rest of the usage for this layout is substantially the same as for
13029 the normal article class.
13030 For details of what Elsevier do and don't allow, refer to their documentation.
13038 Jürgen Spitzmüller
13044 Memoir is a very powerful and constantly evolving class.
13045 It has been designed with regard to fictional and non-fictional literature.
13046 Its aim is to let the user have maximum control over the typesetting of
13048 Memoir is based on the standard book class, but it can also emulate the
13049 article class (see below).
13052 Peter Wilson, the developer of Memoir, is known as the author of lots of
13053 useful packages in the LaTeX world.
13054 Most of them have been merged with Memoir.
13055 Therefore, it is much easier to layout the table of contents, appendices,
13056 chapter designs and such.
13057 LyX, though, does not support all of these goodies natively.
13058 Some of them might be added to forthcoming releases
13064 You are invited to send suggestions to
13065 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
13072 , lots will probably never, due to the limitations of LyX's framework.
13073 Of course you can still use all features with the help of some native LaTeX
13090 section\SpecialChar ~
13092 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
13100 In this section, we can only list those features which are natively supported
13102 For detailed descriptions (and for the rest of features) we are recommending
13103 to have a look at the detailed manual of the Memoir class
13120 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
13127 , which is not only a user guide for the class, but also both a comprehensive
13128 description on good typesetting and a superb example for good typesetting
13132 Basic features and restrictions
13135 Memoir supports basically all features of the standard book classes.
13136 There are, however, some differences, as follows:
13137 \layout Description
13140 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
13142 \layout Description
13145 style: The fancy page style is not supported, due to a command clash
13146 between Memoir and the fancyhdr package (they are both defining a command
13147 with the same name, which confuses LaTeX).
13148 Instead, Memoir comes with a bunch of own page styles (see
13150 Layout\SpecialChar \menuseparator
13151 Document\SpecialChar \menuseparator
13156 If you want to use these for the chapter pages, you have to use the command
13163 in the main text or in preamble (e.
13187 chapterstyle{companion}
13190 \layout Description
13192 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13193 an optional argument in the standard classes.
13194 With this, you can specify an alternative version of the title for the
13195 table of contents and the headers (for instance, if the title is too long).
13196 In LyX, you can do this via
13198 Insert\SpecialChar \menuseparator
13199 Short\SpecialChar ~
13202 at the beginning of a chapter/section.
13203 Memoir features a second optional argument and thus separates the table
13204 of contents from the header.
13205 You can define three variants of a title with this: one for the main text,
13206 one for the table of contents, and one for the headers.
13207 Simply insert two optional arguments if you need this feature, the first
13208 one containing the short title for the Table of Contents, the second one
13209 containing an alternative short title for the headers.
13210 \layout Description
13212 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13213 of contents, the list of figures and the list of table start a new page
13215 Memoir does not follow this route.
13216 You have to insert a page break yourself, if you want to have one.
13217 \layout Description
13219 Titlepage: For some unknown reason, Memoir uses pagination on the title
13220 page (in the standard classes, title pages are
13221 \begin_inset Quotes eld
13225 \begin_inset Quotes erd
13249 If you want an empty title page, type
13253 aliaspagestyle{title}{empty}
13256 \layout Description
13258 Article: With the class option
13264 Layout\SpecialChar \menuseparator
13265 Document\SpecialChar \menuseparator
13266 Extra\SpecialChar ~
13269 ), you can emulate article style.
13270 That is, counters (footnotes, figures, tables etc.) will not be reset on
13271 new chapters, chapters don't start a new page (but are---in contrary to
13273 \begin_inset Quotes eld
13277 \begin_inset Quotes erd
13280 article classes---still allowed), parts, though, use their own page, as
13282 \layout Description
13284 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13285 font commands, which have been used in the old LaTeX version 2.09 (e.
13318 It produces an error and stops LaTeX whenever such a command appears.
13323 reallows the commands and spits out warnings instead (which does at least
13325 Since a lot of packages and particularly BibTeX style files are still using
13326 those commands, we have decided to use this option by default.
13332 We will only describe the features supported by LyX (which is not much currently
13334 Please consult the Memoir manual
13351 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
13359 \layout Description
13361 Abstract: You may wonder why an abstract is an extra feature.
13362 Well, it is in book class.
13363 Usually books don't have abstracts.
13364 Memoir, however, has.
13365 You can use it whereever and how often you like.
13366 \layout Description
13368 Chapterprecis: You may know this from belletristic: The contents of a chapter
13369 is shortly described below the title and also in the table of contents
13392 Our hero arrives in Troia; he loses some friends; he finds others
13395 Chapterprecis does exactly this.
13396 It is therefore only sensible below a chapter.
13397 \layout Description
13399 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13400 The epigraph environment provides an elegant way of typesetting such a
13402 The motto itself (text) and its author (source) are divided by a short
13404 Unfortunately, we have to fool LyX a bit here again, since the environment
13405 needs two arguments (text and source).
13406 In this case, we have to use curly brackets (in TeX mode) between the two
13417 <author of the slogan>.
13418 \layout Description
13420 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13421 complex figurative poems).
13422 Lyx can only support a few of them.
13423 One is poemtitle, which is a centered title for poems, which will also
13424 be added to the table of contents (verse is the standard environment for
13426 Memoir has some enhanced versions of verse, but you need to use ERT, because
13427 they have to be nested inside regular verse environments, which is not
13428 possible with LyX).
13429 \layout Description
13431 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13434 Importing and Exporting Alternate File Formats
13435 \begin_inset OptArg
13440 Importing and Exporting
13449 Importing and exporting LyX documents from/to other formats has been touched
13455 Here we describe more of the gory details needed to understand just what
13456 is going on when you click on the
13461 ile\SpecialChar \menuseparator
13473 ile\SpecialChar \menuseparator
13484 Importing Other Formats
13490 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
13491 Although it is a standalone program which can be called from the command
13492 line, LyX will call it automatically when a LaTeX document is imported.
13493 See section\SpecialChar ~
13495 \begin_inset LatexCommand \ref{sec:reLyX}
13499 for a complete description.
13500 There are no user tunable parameters for reLyX within LyX.
13506 When importing plain ASCII text, there are two methods of reading the file.
13508 \begin_inset Quotes eld
13512 \begin_inset Quotes erd
13515 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
13518 \begin_inset Quotes eld
13522 \begin_inset Quotes erd
13525 assumes that consecutive lines separated by only a single linebreak form
13526 a single paragraph.
13527 Successive linebreaks with no intervening text are thus assumed to be paragraph
13536 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
13539 Exporting Other Formats
13545 LyX generates two types of LaTeX files: stripped down versions for the normal
13550 , etc.) which one normally never sees
13556 The resulting file is a perfectly valid LaTeX file, though the preamble
13557 might look a bit strange since it includes some definitions used by LyX
13558 which wouldn't show up in most human-written files.
13561 , and human readable forms which are suitable for exchanging with your colleague
13563 The only settable option for the translation is the line length of the
13565 The default is 65 characters, but it can be set in
13572 \SpecialChar \menuseparator
13593 Device Independent Files
13596 Device Independent files (DVI files) are produced by running LaTeX on your
13598 There are no user settable options.
13604 The next step in the conversion chain is converting a DVI file into Postscript®.
13612 \SpecialChar \menuseparator
13620 \SpecialChar \menuseparator
13629 or, if you need more control on the result,
13636 \SpecialChar \menuseparator
13645 If you use the later, note that it is possible to configure, in
13652 \SpecialChar \menuseparator
13660 , the options passed to the dvips program to achieve different effects.
13666 Exporting as ASCII attempts to preserve the
13667 \begin_inset Quotes eld
13671 \begin_inset Quotes erd
13674 of the document as well as possible, but things like centering and indentation
13675 are thrown out; paragraphs are separated by blank lines.
13676 Section numbering and cross-references are done correctly, so the resulting
13677 text files is remarkably readable.
13678 The only changeable option is the length of lines, as for LaTeX output.
13684 LyX documents can be converted to hypertext markup, usually by converting
13685 to LaTeX first, then converting that to HTML\SpecialChar \@.
13687 \begin_inset Formula $\rightarrow$
13690 HTML converters are currently known to LyX:
13703 Though they are autodetected, you can overide the selection in preferences.
13704 You can also include further command line options in this dialog.
13710 \added_space_bottom bigskip
13718 The fastest way to generate a basic PDF file (no tags, links, etc.) with
13719 any version of LyX is to save the document as a Postscript® file, then
13725 Starting with version 1.1.6, the menu item
13729 will do all this for you.
13730 There are some issues with fonts that you need to pay attention to: see
13731 Section\SpecialChar ~
13733 \begin_inset LatexCommand \ref{sec:badfonts}
13738 Also, as of version 1.1.6, there is a better method that will generate much
13739 more sophisticated files.
13740 \layout Subsubsection
13745 With pdfLaTeX you need to convert your eps figures to PDF (see Section\SpecialChar ~
13747 \begin_inset LatexCommand \ref{sec:pdfeps}
13751 ), and you cannot use pstricks.
13752 On the other hand, with pdfLaTeX it is possible to insert directly images
13753 in JPEG or PNG format, use TrueType fonts, and more.
13754 \layout Subsubsection
13756 Why does the text look so bad when viewed with Acrobat Reader?
13757 \begin_inset LatexCommand \label{sec:badfonts}
13762 \begin_inset OptArg
13767 Bad Fonts in Acrobat Reader
13773 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
13774 When creating a PDF from the LyX file, you need to use outline font instead
13775 of the default bitmap fonts (in fact, you should also use outline fonts
13776 for Postscript files).
13777 Recent LaTeX distributions come with Postscript® Type 1 version of the
13778 standard (Computer Modern) fonts.
13779 pdfLaTeX uses these font by default.
13780 Dvips doesn't use these fonts by default, so to make it use them, add the
13781 following to lines to your
13794 If the default LaTeX font encoding (OT1) is used, nothing else need to be
13796 However, if the T1 font encoding is used, then LaTeX uses the newer EC
13797 fonts, for which there are no Type1 version.
13798 The solution is to use the ae package which emulates T1 coded fonts using
13799 the standard CM fonts.
13800 This is done by adding
13804 usepackage{ae,aecompl}
13806 to the preamble of the LyX file.
13807 However, some glyphs are missing from the CM fonts (e.g.
13808 eth, thorn), and they are taken from the EC fonts.
13809 Therefore you get these glyphs as bitmaps.
13812 Note: LyX uses by default the T1 font encoding.
13813 If you wish to use the default font encoding (this is not recommended,
13814 unless you only write English documents), clear the field
13822 in preferences (tabs
13834 An alternate option is to use the standard Postscript® fonts instead of
13835 the Computer Modern fonts.
13836 To do that, you need to select
13840 as the global font in the document layout dialog.
13841 When using the Postscript® fonts, the result PDF file is smaller as the
13842 fonts are not saved into the file.
13843 Furthermore, the Postscript® fonts include all T1 glyphs.
13844 On the other hand, the Postscript® fonts have no bold symbol font, so poor
13845 man's bold must be used (see Section\SpecialChar ~
13847 \begin_inset LatexCommand \ref{sec:pdfbold}
13852 The Postscript® fonts also look different from the Computer Modern fonts.
13855 To sum up, both the Computer Modern and the Postscript® fonts gives good
13856 results (with few exceptions).
13857 The decision of which one to use is a matter of taste.
13858 \layout Subsubsection
13862 boldsymbol{} command work when I use pslatex?
13863 \begin_inset LatexCommand \label{sec:pdfbold}
13868 \begin_inset OptArg
13887 The Postscript® fonts do not have a bold symbol font.
13888 The solution is to use the
13894 (poor man's bold) command.
13897 It is possible to redefine the
13922 \layout Subsubsection
13924 Is it possible to do write latex code which is processed only when running
13926 \begin_inset OptArg
13931 Conditionals with pdfLaTeX
13938 Here is an example:
13986 pdfinfo { /Author (your name and e-mail address)
13989 /Title (official title -- i.e., title element)
13992 /Subject (one line description of the document)
14000 pdfcatalog { /PageMode (/UseNone)
14003 % /OpenAction (fitbh)
14011 usepackage[pdftex]{hyperref}
14021 usepackage[ps2pdf]{hyperref}
14027 \layout Subsubsection
14029 How can I make URLs clickable ?
14032 See the references here :
14036 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
14046 Custom exports are possible if you have some particularly weird format you
14047 wish to convert to, assuming you have the relevant converter, of course.
14052 file can be chosen in the
14057 ile\SpecialChar \menuseparator
14062 xport\SpecialChar \menuseparator
14069 dialog; LyX will automatically convert the file to this point, then feed
14070 it to your custom converter.
14071 The possible values are all formats that LyX can produce from its own documents.
14075 The converter command is also specified in the dialog.It should be a completely
14076 qualified command line which uses the variable
14080 to specify the name of the file.
14081 If this variable is not given, then the file will be sent to the standard
14082 input of your command.
14083 You may have to apply a bit of ingenuity to escape this sequence correctly
14084 so that it is compatible with your shell.
14088 While it is not possible to save this command using the
14092 dialog, you can manually edit your
14101 custom_export_command "mycommand $$FName"
14104 The Complete reLyX Description
14105 \begin_inset LatexCommand \label{sec:reLyX}
14115 The simplest way to use reLyX is via the
14120 ile\SpecialChar \menuseparator
14128 That runs reLyX on the given file and loads the resulting file into LyX.
14129 You should try that first, and call it from the command line only if you
14130 need to use more complicated options.
14249 \layout Description
14256 By default, when reLyX sees a
14262 command, it creates a file of textclass
14263 \begin_inset Quotes eld
14267 \begin_inset Quotes erd
14270 and reads the LyX layout file for that class.
14275 to declare a different textclass (and read a different layout file).
14276 \layout Description
14283 By default, reLyX gives sparse output and deletes the temporary files which
14284 were created during translation.
14289 flag will create much more output (both to stdout and stderr) and leave
14290 the temporary files around.
14291 \layout Description
14298 reLyX will not run if the
14302 file it would generate already exists Use the
14306 option (carefully) to clobber any existing files.
14307 \layout Description
14314 Print out usage information and quit
14315 \layout Description
14322 With this option, all temporary files and LyX output files (for the given
14323 input file, for any included files, or for any file fragments given with
14328 option) will be put into
14333 Otherwise, for each file
14337 , the temporary files and the LyX output file will be created in
14342 This can be useful if a file includes files from other directories which
14343 you want to consolidate in one directory, or if you don't have write permission
14344 on the directory the LaTeX files are in.
14345 \layout Description
14352 The input files are LaTeX fragments, with no preamble matter or
14359 This option requires the
14363 option, since there are no
14369 commands in the files reLyX is translating.
14370 When using this option, you can translate more than one file, as long as
14371 all files are the same class.
14372 The LyX file created by reLyX can be included in an existing LyX file using
14378 nsert\SpecialChar \menuseparator
14383 \SpecialChar \menuseparator
14392 \layout Description
14398 Regular environments (see the Section\SpecialChar ~
14400 \begin_inset LatexCommand \ref{sub:relyx-syntax}
14405 If you give more than one environment, separate them with commas (not
14407 You'll probably need to quote the environment list, especially if it has
14408 asterisk environments (foo*) in it.
14409 If you use this command often, considering creating a personal syntax file.
14410 \layout Description
14417 Input (one or more quoted, comma-separated) syntax files to read in addition
14419 (see the section Section\SpecialChar ~
14421 \begin_inset LatexCommand \ref{sub:relyx-syntax}
14429 \layout Subsubsection
14434 reLyX will create a LyX file
14438 from the LaTeX file
14466 does not exist and does not have one of these suffixes, reLyX will try
14472 (This is similar to the behavior of LaTeX.)
14475 The purpose of reLyX is to translate
14480 If your LaTeX file doesn't compile---or if you do weird things, like redefining
14481 standard LaTeX commands---it may choke.
14482 LaTeX209 will often be translated correctly, but it's not guaranteed.
14485 reLyX has some bugs and lacks a few features.
14486 However, its main goals are:
14489 Get through a well-behaved LaTeX2e file without crashing
14492 Translate a lot of that file.
14495 Localize the parts that can't be translated and copy them in TeX mode
14498 It achieves these main goals pretty well on most files.
14501 There are many improvements that can and will be made to reLyX in the future.
14502 However, we wanted to get reLyX out there early on, to make it easier for
14503 new LyX users to read in their existing LaTeX files.
14504 \layout Subsubsection
14509 Here's a more lengthy description of what you should do to translate a LaTeX
14517 reLyX will inform you of its progress and give any warnings to stderr, so
14518 if you don't want any output at all, try (in csh)
14519 \begin_inset Quotes eld
14524 reLyX foo.tex >& /dev/null
14527 \begin_inset Quotes erd
14531 \begin_inset Quotes eld
14543 \begin_inset Quotes erd
14547 You should NOT redirect standard output to
14556 Run LyX on the resulting .lyx file.
14560 In theory, most of the file will have been translated, and anything that's
14561 untranslatable will be highlighted in red (TeX mode).
14562 In theory, LyX will be able to read in the file, and to create printed
14563 documents from it, because all that untranslated red stuff will be passed
14564 directly back to LaTeX, which LyX uses as a backend.
14565 Unfortunately, reality doesn't always reflect theory.
14566 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\SpecialChar ~
14568 \begin_inset LatexCommand \ref{sub:relyx-bugs}
14580 Change things that are in ERT boxes (TeX code) by hand in LyX.
14584 As mentioned above, you should be able to print out the LyX file even without
14586 However, changing a command in TeX mode to the corresponding LyX object
14587 will allow you to take advantage of LyX's WYSIWYM editing.
14590 reLyX is not guaranteed to create a LyX file which generates exactly the
14591 same output as the LaTeX file, but it should come close.
14592 reLyX will generally err on the side of translating less to ensure that
14593 dvi or ps files are accurate, even though this leads to more
14594 \begin_inset Quotes eld
14598 \begin_inset Quotes erd
14605 PROOFREAD THE DOCUMENT!!
14609 I'm sure you were planning on doing this anyway, but it's particularly important
14610 after translating a LaTeX document.
14611 reLyX is, at least now, better at
14612 \begin_inset Quotes eld
14616 \begin_inset Quotes erd
14619 (translating the whole document) than
14620 \begin_inset Quotes eld
14624 \begin_inset Quotes erd
14627 (translating every little detail).
14628 For example, you may see extra spaces or deleted spaces.
14629 Space handling has improved, but it's not perfect.
14631 \layout Subsubsection
14633 What reLyX Can Handle
14636 reLyX understands many LaTeX commands.
14640 regular text, including mini-commands like ~, '',
14652 , as well as accented characters like
14658 , and the special cases ?` and !`
14661 title commands like
14685 and the abstract environment
14688 heading commands like
14694 including starred commands (
14740 environments, and their
14747 Also, well-behaved nested lists
14750 cross-referencing commands:
14788 font-changing commands including
14806 , and corresponding commands to change family, size, series, and shape
14835 \begin_inset Quotes erd
14845 \begin_inset Quotes erd
14855 environment, and commands that go inside it like
14890 commands within them
14903 command, as well as BibTeX's
14918 miscellaneous commands:
14947 documentclass-specific environments (and some commands) which can be translated
14951 arguments to certain untranslatable commands (e.g.
14961 Some of this support may not be 100% yet.
14962 See below for details
14965 reLyX copies math (almost) verbatim from your LaTeX file.
14966 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
14967 by LyX should work just fine.
14968 A few math commands which are not supported by LyX will be replaced with
14969 their equivalents, e.g.,
14989 reLyX will also copy any preamble commands (i.e., anything before
14995 ) verbatim, so fancy stuff you've got in your preamble should be conserved
14996 in dvi and printed documents, although it will not of course show up in
14998 Check the preamble to make sure.
14999 \layout Subsubsection
15001 What reLyX Can't Handle --- But it's OK
15065 reLyX is careful to copy
15069 in this case, including comments and whitespace.
15072 some unknown (e.g., user-defined) environments and commands
15075 reLyX copies unknown commands, along with their arguments, verbatim into
15083 where it doesn't recognize the
15084 \begin_inset Quotes eld
15088 \begin_inset Quotes erd
15091 environment, it will copy verbatim until it sees
15097 (unless you use the
15102 Hopefully, then, most of these unknown commands won't cause reLyX to break;
15103 they'll merely require you to do some editing once you've loaded the file
15105 That should be less painful than editing either the
15113 file using a text editor.
15114 \layout Subsubsection
15116 What reLyX Handles Badly --- a.\SpecialChar ~
15120 \begin_inset LatexCommand \label{sub:relyx-bugs}
15127 Since reLyX is relatively new, it's got a number of problems.
15128 As it matures, these bugs will be squished.
15129 A number of bugs and missing features can be found listed on the LyX bug
15131 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
15138 If reLyX is choking on something, or LyX can't read it after reLyX translates
15139 it, the best thing to do is to put
15145 before the offending text, and
15153 \begin_inset Quotes eld
15157 \begin_inset Quotes erd
15161 reLyX will copy this block exactly, in TeX mode.
15162 Then edit the resulting LyX file, and translate the unknown stuff by hand.
15167 environment is magical; the
15179 commands will not be put into the LyX file.
15183 \begin_inset Quotes eld
15187 \begin_inset Quotes erd
15190 copying of unknown environments and commands isn't quite exact.
15191 Specifically, newlines and comments may be lost.
15192 This will yield ugly LyX, but in almost all cases the output will be the
15194 However, certain parts of the file will be copied perfectly, including
15195 whitespace and comments.
15196 This includes: the LaTeX preamble,
15206 commands, and skip blocks.
15209 reLyX translates only a few options to the
15216 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
15217 landscape, and [one|two]column.) Other options are placed in the extra class
15218 options field in the
15223 ocument\SpecialChar \menuseparator
15234 More importantly, reLyX doesn't translate
15240 commands, margin commands,
15246 s, or, in fact, anything else from the preamble.
15247 It simply copies them into the LaTeX preamble.
15248 If you have margin commands in your preamble, then the LyX file will generate
15250 However, these margins will override any margins you set in the LyX
15257 \SpecialChar \menuseparator
15263 So you should remove the options from the preamble to be safe.
15264 The same goes for setting your language with babel,
15280 The foil class has a couple bugs.
15281 reLyX may do weird things with optional arguments to
15288 Also, it may handle
15294 incorrectly (although the stuff in the environment should translate normally).
15297 reLyX is hopefully rather robust.
15298 As mentioned above, it may not translate your file perfectly, but it shouldn't
15300 If it does crash---and the problem is not one of those mentioned above
15305 file---see Section\SpecialChar ~
15307 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
15312 \layout Subsubsection
15314 What LyX Can't Handle
15317 LyX itself is missing a couple features, such that even if reLyX translates
15318 things perfectly, LyX may still have trouble reading it.
15319 If you really need these features, you can export your final document as
15320 LaTeX, and put them back in.
15325 for more details on these bugs.
15328 For a number of commands, LyX does not support the optional argument.
15341 (and other sectioning commands), and
15350 reLyX will automatically discard the optional arguments with a warning
15352 LyX also ignores the width argument for the
15359 Centering (or right or left justifying) works on full paragraphs.
15362 LyX support for tables isn't perfect.
15363 For complicated tables, use a
15364 \begin_inset Quotes eld
15368 \begin_inset Quotes erd
15371 block, so that they will be copied in TeX mode.
15374 The LyX math editor can't handle the AMS-LaTeX math environments align,
15376 So those environments will be copied in TeX mode.
15381 environments to the exactly equivalent displaymath, and then they will
15382 be translated correctly.
15391 \begin_inset Quotes eld
15395 \begin_inset Quotes erd
15399 \begin_inset Quotes eld
15403 \begin_inset Quotes erd
15406 foo.tex > foo.debug
15409 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
15419 block, it will translate the stuff within the block, but copy the
15431 commands in TeX mode.
15432 Finally, I'm going to keep the temporary files around (they will also
15433 be in my/dir/) and output lots of debugging information into the file foo.debug.
15437 \layout Subsubsection
15440 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
15447 If reLyX is crashing or otherwise acting strangely---in ways other than
15448 those described in Section\SpecialChar ~
15450 \begin_inset LatexCommand \ref{sub:relyx-bugs}
15454 or the bug tracker---then please run reLyX
15459 That will allow you to figure out where in the reLyXing process it crashed.
15460 That, in turn, will allow you to write a better bug report, which will
15461 allow the developers to fix it more quickly and easily.
15464 Bug reports should be sent to the LyX developers' mailing list.
15465 Its address is currently
15467 lyx-devel@lists.lyx.org
15470 If you are running reLyX on a huge file, please do not send all of the
15471 output in your bug report.
15472 Just include the last ten or twenty lines of output, along with the piece
15473 of the LaTeX file it crashed on.
15474 Or, even better, attach a small but complete file which causes the same
15475 problem as your original file.
15476 \layout Subsubsection
15478 Implementation Details:
15481 reLyX makes several
15482 \begin_inset Quotes eld
15486 \begin_inset Quotes erd
15489 in order to translate a TeX file.
15490 On each pass, it creates one or two files.
15491 \layout Description
15497 Before doing anything, read the syntax file (or files).
15498 \layout Description
15504 Split preamble (anything before a
15510 command) off the rest of the file.
15511 It saves the two pieces in separate files.
15512 This is necessary because there may be very strange stuff in a preamble.
15513 It also ignores anything after the
15519 , on the assumption that it isn't LaTeX.
15520 \layout Description
15526 Translate the preamble.
15527 Currently, that just means translating the
15533 command and copying the rest exactly into the LyX preamble.
15537 Once you know what class the document is, read the LyX layout file for that
15540 \layout Description
15547 \begin_inset Quotes eld
15551 \begin_inset Quotes erd
15554 the TeX file, generating slightly stricter LaTeX.
15563 to the equivalent but clearer
15568 Removing optional arguments that LyX can't handle (e.g., from
15590 This is necessary because LyX always writes out the non-local forms anyway.
15591 This should very rarely make a difference.
15593 \layout Description
15599 Translate LaTeX text, commands, and environments to LyX.
15600 \layout Description
15606 Put the two pieces back together, and do some final tweaking, to generate
15622 commands, reLyX will loop back to the beginning and translate those.
15623 It assumes that the included files are the same class as the main file,
15624 and that they have no preamble matter.
15631 command in the preamble of a file, the command will be copied exactly into
15632 the LaTeX preamble portion of the LyX file, so the included file won't
15633 be translated.) So when translating included files, it skips passes 0 and
15637 If reLyX doesn't find a file you wanted to include, it will give a warning,
15638 but will continue to translate any files it does find.
15639 \layout Subsubsection
15644 reLyX reads a LyX layout file to know how to handle LaTeX environments and
15645 commands which get translated to LyX layouts.
15646 This file will include all
15647 \begin_inset Quotes eld
15651 \begin_inset Quotes erd
15654 non-math environments (i.e., including quote and itemize, but not tabular,
15655 minipage, and some other fancy environments), and commands like
15668 If you want to reLyX a class that doesn't have an existing layout file,
15669 then you'll have to create a layout file.
15670 But you have to do this anyway, in order to LyX the file, since LyX depends
15671 on layout files to know how to display and process its files.
15672 Check the LyX documentation for help with this task (which can be hard
15673 or easy, depending on the class you want to create a layout file for.) If
15674 your class is quite similar to a class that has a layout file, then consider
15680 \layout Subsubsection
15683 \begin_inset LatexCommand \label{sub:relyx-syntax}
15690 reLyX always reads at least one syntax file, called the default syntax file.
15691 reLyX will read your personal syntax file if it exists; otherwise it will
15692 read the system-wide file.
15693 reLyX will read additional syntax files if you specify them with the
15698 (These extra files should have the same format as the default file, but
15699 will tend to be shorter, since they only have to specify extra commands
15700 not found in the default file.) A syntax file tells reLyX a few things.
15703 First, it describes the syntax of each command, that is, how many required
15704 arguments and how many optional arguments the command takes.
15705 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
15706 it doesn't know how to translate.
15707 The syntax file simply has a command, followed by braces or brackets describing
15708 its arguments in the correct order.
15709 For example, a syntax file entry
15721 command takes an optional argument followed by a required one, while the
15734 command takes no arguments at all.
15735 When reLyX encounters a token that it doesn't know how to translate into
15736 LyX, it will copy the token---along with the correct number of arguments---exac
15738 If the token is not in the syntax file, then reLyX just copies as many
15739 arguments as it finds.
15740 This means that it may copy too much.
15741 But since the user can specify additional syntax files, that shouldn't
15745 Some commands that cannot be translated to LyX, like
15751 , have as one of their arguments regular LaTeX text.
15753 \begin_inset Quotes eld
15757 \begin_inset Quotes erd
15760 is put into an argument of an (untranslatable) command in the syntax file,
15761 then reLyX will translate that argument instead of copying it verbatim.
15762 So, for example, the default syntax file has
15766 raisebox{}[][]{translate}
15769 This means that the
15775 command and the first argument (and optional arguments if they exist) are
15776 copied in TeX mode, but the last argument (which may contain math, complicated
15777 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
15779 \begin_inset Quotes eld
15783 \begin_inset Quotes erd
15786 on optional arguments.
15789 User-defined syntax files are allowed to define new commands and their syntax,
15790 or override the number of arguments for a command given in the default
15792 (E.g., if you're using a style that gives an extra argument to some command...)
15793 However, this will only be useful for commands copied in TeX mode.
15794 Commands which are actually translated by reLyX (like
15800 ) have their argument syntax hard-coded.
15801 The hard-coded commands are identified in the default syntax file.
15804 Second, the syntax file describes any
15805 \begin_inset Quotes eld
15808 regular environments
15809 \begin_inset Quotes erd
15813 Usually, an entire unknown environment will be copied in TeX mode.
15814 If you define a regular environment
15815 \begin_inset Quotes eld
15819 \begin_inset Quotes erd
15822 , though, then only the
15834 commands will be copied in TeX mode; the text within the environment will
15835 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
15836 copied into TeX mode.
15837 Don't try to declare
15845 as regular environments, as the text within those environments will confuse
15846 reLyX; use this capability for new environments you create that have plain
15847 text or math or simple commands in them.
15848 You also can't declare unknown math environments (like
15852 ) as regular environments, either, since the LyX math editor won't understand
15854 The names of regular environments appear, whitespace-separated, between
15867 statements in the syntax file.
15868 (If you have a regular environment which you won't use very often, you
15873 option rather than writing a syntax file.)
15876 Third, the syntax file describes a math translation table.
15877 The LyX math editor doesn't support a few commands.
15882 is supported, but the equivalent
15889 Put any commands you'd like translate between
15903 \begin_inset Quotes eld
15915 \begin_inset Quotes erd
15924 in math mode will be converted to
15925 \begin_inset Quotes eld
15935 \begin_inset Quotes erd
15942 (in cases where a token made up of a backslash and a non-letter is translated
15943 to something with letters at the end, a space is added by reLyX.
15945 \begin_inset Quotes eld
15955 \begin_inset Quotes erd
15958 is correctly translated to
15959 \begin_inset Quotes eld
15969 \begin_inset Quotes erd
15973 \layout Subsubsection
15978 You need Perl version 5.002 or later to run reLyX.
15979 <plug> If you don't have Perl, you should get it anyway (at
15980 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
15984 ), because it's a really useful tool for pretty much anything.
15991 reLyX should always explain why it crashes, if it crashes.
15992 Some diagnostics may be very technical, though, if they come from the guts
15994 reLyX gives much more information while running if you use the
15998 option, but you shouldn't need that unless something goes wrong.
16001 When it's finished, reLyX will tell you if it finished successfully or died
16008 Always keep a copy of your original LaTeX files either under a different
16009 name or in a different directory.
16010 There are a couple ways in which using LyX could lead to overwriting the
16011 original LaTeX file.
16026 and want to re-export it, note that it will overwrite the original
16035 ask you if you want to overwrite it.)
16038 If you have chosen not to use a temporary directory in the preferences,
16039 then LyX will create its temporary files in your current directory, which
16040 means your LaTeX original may be overwritten (without a warning from LyX)
16042 \begin_inset Quotes eld
16046 \begin_inset Quotes erd
16049 or print the LyX document.
16053 \layout Description
16058 MY_LYXDIR/layouts/*.layout
16064 User's personal layout files for document classes
16065 \layout Description
16070 MY_LYXDIR/reLyX/syntax.default
16076 User's personal syntax file
16077 \layout Description
16082 LIBDIR/layouts/*.layout
16088 System-wide layout files for document classes
16089 \layout Description
16094 LIBDIR/reLyX/syntax.default
16100 System-wide LaTeX syntax file
16107 is the system-wide LyX directory, usually something like
16109 /usr/local/share/lyx/
16116 is your personal LyX directory, something like
16120 in your home directory.
16121 You can see their actual values in the
16126 elp\SpecialChar \menuseparator
16127 About\SpecialChar ~
16153 Copyright (c) 1998--9
16159 karger@voth.chem.utah.edu
16171 wrote the original CleanTeX pass.
16188 David Suarez de Lis
16191 Other contributors:
16196 Jean-Marc Lasgouttes
16198 worked on the wrapper script and offered lots of bug reports, advice, and
16199 feature suggestions.
16214 Various members of the LyX developers' and users' lists provided bug reports
16215 and feature suggestions.
16218 reLyX uses a modified version the Perl TeX parser
16228 ilya@math.ohio-state.edu
16230 ), available on CPAN.
16233 LyX Features needing Extra Software
16236 Using LyX with SGML-Tools (aka LinuxDoc)
16247 LinuxDoc is a document class available in LyX if you have the
16252 You can use it to produce documents in the so-called Standardized General
16253 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
16255 That is obviously helpful if you are contributing to that project.
16256 You can use the SGML format with the
16260 package of scripts and programs (to produce other formats, including Latex,
16261 HTML, plain text, man pages and\SpecialChar \ldots{}
16263 You may therefore prefer to use this document class if you want to write
16264 something that can be easily translated into other formats.
16267 You will find that LinuxDoc has fewer layout options than the other text
16269 This is mainly so that the translations into other formats have a chance
16270 of making some sense.
16271 In this section we describe:
16274 how to setup and use a document in LinuxDoc
16277 how to use the tags in LinuxDoc to layout your document
16280 how to use the SGML packages to produce the various formats
16283 how to sort out some problems.
16286 Preparing and using a LinuxDoc document
16287 \layout Subsubsection
16292 You start by selecting the LinuxDoc class using the
16297 ocument\SpecialChar \menuseparator
16309 Then you will find that there are fewer paragraph environments than for
16310 most other classes.
16311 You can see them on the pull down box on the left of the tool bar.
16312 How to use them is described in section\SpecialChar ~
16314 \begin_inset LatexCommand \ref{sec:sgmlparas}
16325 enter a title for the document, followed by an author, marking each with
16326 the appropriate paragraph environment.
16327 If you don't do this, you will get errors when you try to print the file.
16328 You can then enter the date and an abstract.
16329 The document proper must start with a Section paragraph environment rather
16330 than any standard layout.
16333 After that you can prepare a document as usual using the available range
16334 of paragraph environments.
16335 See section\SpecialChar ~
16337 \begin_inset LatexCommand \ref{sec:sgmlparas}
16341 for the full list and their uses.
16342 \layout Subsubsection
16344 Output from LinuxDoc
16347 You can print and save these documents in the normal way.
16348 To use the other features of the SGML package you need to save your document
16349 as LinuxDoc; this is a version in which the document is translated into
16350 the basic sgml tags.
16357 ile\SpecialChar \menuseparator
16362 xport\SpecialChar \menuseparator
16370 You will get a file with the same name and a
16374 extension rather than a
16381 \begin_inset LatexCommand \ref{sec:sgmloperate}
16385 on how you than make use of this file.
16388 Using the paragraph environments in LinuxDoc
16389 \layout Subsubsection
16391 The Structure of a LinuxDoc Document
16394 There is a formal structure for LinuxDoc which limits how you can place
16396 There are two parts to all documents:
16397 \layout Description
16399 Header: this is everything up to the first time you insert a Section layout
16401 It can include title, author, date, abstract and ToC.
16402 You must include the first two.
16403 \layout Description
16405 Body: from the beginning of the first section onwards.
16406 All other tags are allowed.
16408 \layout Subsubsection
16410 The LinuxDoc Paragraph Environments
16414 \begin_inset LatexCommand \label{sec:sgmlparas}
16418 Here is a list of all the tags you will find listed on the layout bar in
16419 the order they come there, with some comments where the purpose or use
16427 works as described in [cross reference]
16434 : This will appear at the top left of the document when printed, above a
16435 heavy horizontal rule, although you will not see this on the LyX screen.
16440 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
16442 all do what you would expect and in the usual order.
16443 Whether they are numbered or not is controlled by the
16445 Section\SpecialChar ~
16446 number\SpecialChar ~
16450 You cannot get the equivalent number free versions in any other way; there
16462 As usual this produces a numbered and indented list as described in the
16474 Again much the same as in the other classes: see the
16485 : As explained in the
16490 Remember that if you want the bold element at the start of a description
16491 to be more than one word then you need to put protected spaces between
16505 Code: similar to the Lyx-Code
16514 : Anything you mark with this will appear on the left of the heading of
16515 the document, under the heavy rule.
16522 Anything you mark with this will appear on the right of the heading under
16524 You do not have to make this a date.
16525 Any text can be entered, e.\SpecialChar ~
16534 : You can use this to produce a free standing paragraph after the author
16535 and date, and before the first section.
16536 You are only allowed one such paragraph.
16547 This needs checking ---
16569 I have not yet checked this ---
16575 \layout Subsubsection
16577 Other document features
16580 You can also use the
16584 menu to set fonts or to emphasis words.
16585 You can also use the table of contents as usual; see the corresponding
16591 Although you will find some some other features on the menus e.\SpecialChar ~
16593 inserting footnotes.
16594 There is some doubt about whether these will work correctly.
16604 Again still checking to see whether this is my system
16610 \layout Subsubsection
16612 Cross references and HTML
16619 menu you will find two new options relating to the inclusion of URL addresses.
16620 If you use either option you will find some highlighted TeX code inserted
16621 into your document in three separate blocks with spaces available between.
16622 The blocks will be:
16656 You insert a full HTML tag between the first and second blocks.
16658 \begin_inset LatexCommand \url{http://any.address}
16662 or other valid tags such as
16663 \begin_inset LatexCommand \url{mailto:me@my.address}
16675 insert some description between the second and third blocks.
16676 The differences are:
16683 both the HTML tag and the description will appear in the document
16691 only the description appears in the printed version
16694 Using the LinuxDoc Sgml scripts
16700 This section is completely outdated.
16707 \begin_inset LatexCommand \label{sec:sgmloperate}
16711 You can use LinuxDoc as a text class without any additional scripts or programs,
16712 but there is not much point in doing this.
16713 All you will get is a document that looks like a
16715 Linux Documentation Project Howto
16721 To do the document translation you need to get and install the
16723 sgml-tools-1.0.x.tar.gz
16726 \begin_inset Formula $x\geq3$
16731 the SGML-Tools WWW Page
16739 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
16748 Alternatively, you can go to the
16758 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
16759 has not yet been made available at
16772 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
16785 sgml-tools-1.0.x.tar.gz
16787 contains everything that you need to write SGML documents and convert them
16788 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
16792 This package was renamed from
16794 linuxdoc-sgml-1.5.tar.gz
16799 Follow the instructions in that package on how to install it and how to
16801 All this has to be done outside of LyX, before you can use the
16806 ile\SpecialChar \menuseparator
16811 xport\SpecialChar \menuseparator
16818 Troubleshooting LinuxDoc
16821 When you print or preview a LinuxDoc document some checking is done of the
16822 tags before LaTeX is run.
16823 Some errors are trapped here, especially those concerning the structure
16825 LyX may produce an error message, but not leave an error box in the document
16827 You may have to look at the files directly to discover what is wrong.
16828 Most problems seem to come from the use of options that are not fully available
16850 menu, you'll find a
16859 This feature requires you to have the
16863 program installed, and is grayed out if you don't have it.
16864 You can get it from your nearest CTAN mirror, or over the Web from
16865 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
16876 package is a program that was written by
16881 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16882 and easy to forget.
16883 The program runs over your LaTeX file and checks the integrity of the file,
16884 and flags some common errors.
16885 In other technical words, it is
16892 Well, what is a syntax checker doing in LyX which is supposed to produce
16893 correct LaTeX anyways? The answer is simple: Just as
16897 not only checks the
16901 of C programs, but also does
16905 checks for type-errors,
16909 catches some common
16913 errors, in addition to the syntactical ones.
16918 is capable of detecting several common errors, such as
16921 Ellipsis detection:
16923 Use \SpecialChar \ldots{}
16927 No space in front of/after parenthesis:
16932 Enforcement of normal space after common abbreviations:
16936 is too wide spacing.
16939 Enforcement of end-of-sentence space when the last sentence ends with a
16943 And this is wrong spacing.
16946 Space in front of labels and similar commands:
16948 The label should stick right up to the text to avoid falling to a wrong
16951 \begin_inset LatexCommand \label{sec:chktex}
16961 This footnote is in danger of falling off to a wrong page
16964 The label is separated too much.
16967 Space in front of references, instead of hard spaces:
16969 In you are in bad luck, the text will break right between the referenced
16970 text and reference number, and that's a pity.
16972 \begin_inset LatexCommand \ref{sec:chktex}
16980 \begin_inset Quotes eld
16984 \begin_inset Quotes erd
16988 \begin_inset Formula $\times$
16993 2x2 looks cheap compared to
16994 \begin_inset Formula $2\times2$
17000 and more \SpecialChar \ldots{}
17001 It is an invaluable tool when you are
17002 \begin_inset Quotes eld
17006 \begin_inset Quotes erd
17009 your document before printing, and you should run it right after the obligatory
17010 spelling check, and before you go fine tuning the typesetting.
17016 If you have the program installed, usage is as simple as choosing
17021 ools\SpecialChar \menuseparator
17030 This will make LyX generate a LaTeX file of your document, start
17034 to check it, and then make LyX insert
17035 \begin_inset Quotes eld
17039 \begin_inset Quotes erd
17042 with the warnings from
17046 , if there were any.
17047 The warnings will be placed close to the point of the mistake, and you
17048 can quickly find them by using the
17053 avigate\SpecialChar \menuseparator
17060 menu item, or the shortcut key
17069 Open the error boxes by clicking on them with the mouse, or use the shortcut
17078 bindings, or the corresponding
17087 Read the warning and correct the mistake, if it is a mistake.
17088 If you have trouble understanding what the warning is about, you can safely
17090 Remember that there is a hidden layer between the document on screen and
17091 the technical details in invoking
17095 , and this gap can make some warnings seem arcane or just right down plain
17099 This document is an excellent testing bed for the feature, and it should
17100 provide quite a few warnings for you to fiddle with.
17101 Since computers are only so smart, expect most of the warnings to be false
17105 How to fine tune it
17108 Sometimes, you'll find that
17112 makes more noise than suits your mood.
17113 Then you can choose not to use it, wait until your mood changes, or try
17118 to get better along with you.
17119 Another choice in the most desperate situations is to use
17124 iew\SpecialChar \menuseparator
17129 emove\SpecialChar ~
17131 Error\SpecialChar ~
17134 , which will get rid of all warnings instantly.
17145 very configurable and extensible, you shouldn't expect to solve all problems
17151 Since LyX has to generate a somewhat special LaTeX file to be able to match
17152 the line numbers from the
17162 You can inspect the specific output from
17168 Edit\SpecialChar \menuseparator
17170 LaTeX\SpecialChar ~
17180 to the internal document structure, some of the warnings will not seen
17181 to appear correctly.
17182 There are two things you can do about this:
17189 invocation command line in
17205 installation configuration file (usually with the file
17207 /usr/local/share/chktexrc
17210 See below to learn what warnings can be enabled and disabled on the command
17215 Export your document as a raw LaTeX file using
17220 ile\SpecialChar \menuseparator
17225 xport\SpecialChar \menuseparator
17237 Invoked in this way, it can be a hassle to find the corresponding place
17238 in the document inside LyX, but with a little patience, you should be able
17242 Here follows the warning messages that can be enabled and disabled in
17251 to disable a warning, and
17255 to enable a warning.
17256 The emphasized entries are disabled by default, because the default is
17259 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17264 Notice that you should only use the options that enable and disable warnings,
17265 because LyX relies on some of the other command line parameters to be set
17266 in a specific way to have a chance to communicate with
17276 Command terminated with space.
17281 Non-breaking space (
17282 \begin_inset Quotes eld
17290 \begin_inset Quotes erd
17293 ) should have been used.
17299 You should enclose the previous parenthesis with
17300 \begin_inset Quotes eld
17308 \begin_inset Quotes erd
17316 Italic correction (
17317 \begin_inset Quotes eld
17327 \begin_inset Quotes erd
17330 ) found in non-italic buffer.
17335 Italic correction (
17336 \begin_inset Quotes eld
17346 \begin_inset Quotes erd
17349 ) found more than once.
17355 No italic correction (
17356 \begin_inset Quotes eld
17366 \begin_inset Quotes erd
17375 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17387 \begin_inset Quotes eld
17395 \begin_inset Quotes erd
17403 Wrong length of dash may have been used.
17410 \begin_inset Quotes eld
17418 \begin_inset Quotes erd
17422 \begin_inset Quotes eld
17430 \begin_inset Quotes erd
17439 \begin_inset Quotes eld
17447 \begin_inset Quotes erd
17456 \begin_inset Quotes eld
17464 \begin_inset Quotes erd
17467 to achieve an ellipsis.
17472 Inter-word spacing (
17473 \begin_inset Quotes eld
17483 \begin_inset Quotes eld
17486 ) should perhaps be used.
17491 Inter-sentence spacing (
17492 \begin_inset Quotes eld
17502 \begin_inset Quotes erd
17505 ) should perhaps be used.
17510 Could not find argument for command.
17516 \begin_inset Quotes eld
17524 \begin_inset Quotes erd
17532 Math mode still on at end of LaTeX file.
17538 \begin_inset Quotes eld
17546 \begin_inset Quotes erd
17549 doesn't match the number of
17550 \begin_inset Quotes eld
17558 \begin_inset Quotes erd
17566 You should use either
17569 \begin_inset Quotes eld
17577 \begin_inset Quotes erd
17582 as an alternative to
17583 \begin_inset Quotes eld
17591 \begin_inset Quotes erd
17603 " (ASCII 39) instead of "
17612 User-specified pattern found.
17617 This command might not be intended.
17645 Delete this space to maintain correct page references.
17651 You might wish to put this between a pair of
17652 \begin_inset Quotes eld
17660 \begin_inset Quotes erd
17668 You ought to remove spaces in front of punctuation.
17673 Could not execute LaTeX command.
17684 in front of small punctuation.
17694 may look prettier here.
17700 Multiple spaces detected in output.
17705 This text may be ignored.
17713 \begin_inset Quotes eld
17718 to begin quotation, not
17731 to end quotation, not
17734 \begin_inset Quotes eld
17749 You should perhaps use
17750 \begin_inset Quotes eld
17758 \begin_inset Quotes erd
17766 You should put a space in front of/after parenthesis.
17771 You should avoid spaces in front of/after parenthesis.
17777 You should not use punctuation in front of/after quotes.
17782 Double space found.
17787 You should put punctuation outside inner/inside display math mode.
17792 You ought to not use primitive TeX in LaTeX code.
17797 You should remove spaces in front of
17798 \begin_inset Quotes eld
17806 \begin_inset Quotes erd
17815 \begin_inset Quotes eld
17823 \begin_inset Quotes erd
17826 is normally not followed by
17827 \begin_inset Quotes eld
17835 \begin_inset Quotes erd
17841 In later versions of LyX, we hope to provide a more complete interface to
17842 this tool (and it's smaller cousin
17846 ) to exploit the full power of it.
17847 But it's not exactly useless as it is now: go try it on one of your existing
17848 documents of a certain length and be surprised.
17851 Version Control in LyX
17856 Lars Gullik Bjønnes
17862 A friend of mine wanted to try LyX for a group project.
17863 When he didn't find support for version control or file locking, he dropped
17865 This angered me a bit, so I thought that I should at least make support
17866 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17867 This has now been done.
17868 LyX now supports some of the most basic RCS commands.
17869 If you need to something a bit more sophisticated you will have to do that
17870 manually in an xterm.
17873 Before you begin to use the version control features in LyX, you should
17875 \begin_inset Quotes eld
17879 \begin_inset Quotes erd
17882 (a man file, read it with
17887 This file describes all the basic features of RCS.
17888 You should especially notice the comment about a RCS directory, and the
17889 notion of a master RCS file (the file ending in
17896 The implementation in LyX assumes a recent version of the GNU RCS package---no
17897 guarantees are made for older versions.
17900 RCS commands in LyX
17903 The following sections describe the RCS commands supported by LyX.
17904 You can find them in the
17909 ile\SpecialChar \menuseparator
17914 ersion\SpecialChar ~
17918 \layout Subsubsection
17925 If your document is not under revision control, this is the only item shown
17927 And if it is under revision control, the
17934 item is grayed out.
17938 This command registers your document with RCS\SpecialChar \@.
17939 You are asked interactively
17940 to supply an initial description of the document.
17941 The document is now set in Read-Only mode and you have to
17943 Check\SpecialChar ~
17948 , before making any changes to it.
17949 A document under revision control has a
17950 \begin_inset Quotes eld
17953 [RCS:<version> <locker>]
17954 \begin_inset Quotes erd
17957 item tagged to the filename in the minibuffer.
17960 RCS command that is run:
17962 ci -q -u -i -t-"<initial description>" <file-name>
17969 to understand the switches.
17971 \layout Subsubsection
17978 When you are finished editing a file, you check in your changes.
17979 When you do this, you are asked for a description of the changes.
17980 This is stored in the history log.
17981 The version number is bumped, your changes are applied to the master RCS
17982 file, the document is unlocked and set to Read-Only mode.
17988 ci -q -u -m"<description>" <file-name>
17989 \layout Subsubsection
17996 By doing this you lock the document so that only you can edit it.
17997 This will also make the document Read-Write only for you.
17998 You will usually continue editing for a while and when you are finished
17999 you check in your changes.
18000 The status line is changed to reflect that you have locked the file.
18006 co -q -l <file-name>
18007 \layout Subsubsection
18011 Revert To Last Version
18014 This will discard all changes made to the document since the last check
18016 You get a warning before changes are discarded.
18021 co -f -u<version> <file-name>
18022 \layout Subsubsection
18029 This makes as if the last check in never happened.
18030 No changes are made to the document loaded into LyX, but the last version
18031 is removed from the master RCS file.
18037 rcs -o<version> <file-name>
18038 \layout Subsubsection
18045 This show the complete history of the RCS document.
18050 is shown in a browser.
18058 Literate Programming
18065 (kayvan@sylvan.com)
18069 original documentation written by
18071 Edmar Wienskoski Jr.
18074 (edmar-w-jr@technologist.com)
18080 The main purpose of this documentation is to show you how to use LyX for
18081 literate programming.
18082 Where it is assumed that you are familiar with this programming technique,
18084 \begin_inset Quotes eld
18088 \begin_inset Quotes erd
18092 \begin_inset Quotes eld
18096 \begin_inset Quotes erd
18100 If that is not the case, please follow the web links provided in the following
18102 There is a lot of good documentation out there covering old development
18103 history to the latest tools tips.
18106 It is also assumed that you are familiar with LyX itself to a point that
18107 you are comfortable changing your LyX preferences, and X resources file.
18108 If that is not the case please refer to other LyX documentation to cover
18109 your specific needs.
18112 Literate Programming
18115 From the Literate Programming FAQ:
18118 Literate programming is the combination of documentation and source together
18119 in a fashion suited for reading by human beings.
18120 In fact, literate programs should be enjoyable reading, even inviting!
18121 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18122 and documentation in a single file.
18123 Literate programming tools then parse the file to produce either readable
18124 documentation or compilable source.
18125 The WEB style of literate programming was created by D.E.
18126 Knuth during the development of his TeX typesetting software.
18130 Another excerpt says:
18135 How is literate programming different from verbose commenting?
18138 There are three distinguishing characteristics.
18139 In order of importance, they are:
18143 flexible order of elaboration
18146 automatic support for browsing
18149 typeset documentation, especially diagrams and mathematics
18153 Now that I sparked your curiosity, take a look in the references.
18154 \layout Subsubsection
18159 The complete Literate Programming FAQ can be found at:
18163 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
18170 The FAQ lists 23 (twenty three!) different literate programming tools.
18171 Where some are specialized or
18172 \begin_inset Quotes eld
18176 \begin_inset Quotes erd
18179 for particular programming languages, while other have general scope.
18184 for my own use for several reasons:
18187 It can generate the documentation either in latex or html.
18190 It has a open architecture, i.e., it is easy to plug in new filters and to
18191 perform special processing that you may need.
18195 There is a good selection of filters available already (the html is one
18202 The Noweb web page can be found at:
18206 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
18213 Starting from there you can reach many other interesting links and even
18214 some literate program examples.
18217 LyX and Literate Programming
18220 The LyX support for Literate Programming is provided by using the generic
18221 LyX convertors mechanism.
18222 This support is provided in a
18223 \begin_inset Quotes eld
18227 \begin_inset Quotes erd
18230 way, i.e., you will be able to use this new LyX feature with some other literate
18231 programming tool of your choice by just changing your LyX preferences.
18232 \layout Subsubsection
18234 Generating documents and code (weaving and tangling)
18237 Selecting the document class
18240 If you have installed Noweb and LyX successfully, whenever you open a new
18241 document or try to change the document class of an existing one, you will
18242 find that there are three new document classes available:
18254 You must select one of them to create your literate documents from.
18258 Note that literate documents are not limited to these three classes.
18259 New classes can be generated from other styles like letter or in combination
18260 with other class variations like Article (AMS).
18261 If you have special needs that cannot be covered by one of the existing
18262 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
18263 will arrange to insert a new entry, or teach you how to do it.
18269 It is very simple, it involves the creation of a file with four lines, and
18270 re-running of the auto configuration.
18273 Moreover, if you use a literate tool other than Noweb you may need to create
18274 a new set of document classes for it.
18280 LyX enables you to write code with a layout named
18290 The equivalent Noweb term is
18291 \begin_inset Quotes eld
18295 \begin_inset Quotes erd
18299 For historical reasons, I got used to the term
18300 \begin_inset Quotes eld
18304 \begin_inset Quotes erd
18307 introduced by other literate tool named Nuweb, which I used for many years
18308 before rendering myself to Noweb.
18311 Noweb delimits scraps like this:
18329 The problem is that whatever is written in between the << and the
18333 must be taken literally, i.e., LyX should be prevented from making any special
18334 interpretation of what has been written.
18335 This is handled by a special layout named Scrap, that works like a normal
18336 paragraph but has a free spacing capability.
18339 The down side of the Scrap paragraph layout is that consecutive paragraphs
18340 of code will be spaced with one empty line in the source code and also
18341 in the printed documentation.
18342 The work around is to enter each line of code within a single Scrap, with
18343 a newline (ctrl-return).
18344 The example above will look like this:
18350 If you have a printed version of this document you will not see any difference
18351 between the previous example and this one.
18368 This layout works fine.
18369 The only real inconvenience is that you have to type ctrl-return instead
18376 It is in my list of
18377 \begin_inset Quotes eld
18381 \begin_inset Quotes erd
18390 As a special note, you can also use the
18391 \begin_inset Quotes eld
18395 \begin_inset Quotes erd
18398 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18404 def some_function(args):
18406 "This is the doc string for this function."
18408 print "My args: ", args
18411 @ %def some_function
18414 For an example of this usage and the resulting cross-reference output, look
18415 at the Literate python program in
18417 LIBDIR/examples/listerrors.lyx
18419 which should make this all clear.
18422 Generating the documentation
18425 At this point you already have a new document file with a proper document
18426 class, and with some code and text on it.
18427 How do I print it? The answer is simple, you select
18432 iew\SpecialChar \menuseparator
18440 Just like you would do for a plain document.
18441 No special procedure is required.
18444 To help orientate you, I will now explain what happens inside LyX:
18452 pdate\SpecialChar \menuseparator
18459 menu option is chosen, a latex file is generated.
18464 If the document is of any literate class the generated file will be named
18465 with an extension name defined by the
18466 \begin_inset Quotes eld
18470 \begin_inset Quotes erd
18473 format (defined in the Preferences panel), otherwise the file will have
18482 Note that the only difference so far is in the name of the file, no special
18483 processing is required by LyX.
18484 Given that you formatted the code using the Scrap layout that, by itself,
18485 takes care of the business.
18488 If the document is of any literate class LyX will then use the internal
18489 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18495 The converters are defined in the
18500 ools\SpecialChar \menuseparator
18508 \begin_inset Quotes eld
18512 \begin_inset Quotes erd
18518 to generate the LaTeX file.
18522 Otherwise it will just skip this step.
18526 Finally, LaTeX is invoked and the regular post processing continues as in
18530 Independence from a particular
18531 \begin_inset Quotes eld
18535 \begin_inset Quotes erd
18538 is easily achieved by changing the commands that are run by the various
18542 Generating the code
18545 When the build menu option is chosen or the corresponding button in the
18546 toolbar is pressed, a latex file is generated just like step 1 above.
18547 Next, LyX invokes the
18552 Typically, this converter (like any other converter), has two parts:
18555 The converter program itself.
18556 This program performs the conversion from the one format to the other (in
18557 this case, from the Noweb format to the Program pseudo-format).
18560 The error log parser.
18561 This is a program whose sole purpose is to rewrite error messages in a
18562 format that LyX understands.
18563 This makes it possible for LyX to place error boxes in the right places
18564 in the file buffer.
18567 The first part, the
18568 \begin_inset Quotes eld
18572 \begin_inset Quotes erd
18575 setting, should be set to
18576 \begin_inset Quotes eld
18584 \begin_inset Quotes erd
18588 This basically means that LyX will call
18589 \begin_inset Quotes eld
18593 \begin_inset Quotes erd
18596 (a program or script) with the name of the Noweb file (generally a file
18597 in the LyX temp directory).
18601 This is an implementation of
18602 \begin_inset Quotes eld
18606 \begin_inset Quotes erd
18609 that you can place in a directory on your path:
18618 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18621 The next part of the converter setting is the
18622 \begin_inset Quotes eld
18626 \begin_inset Quotes erd
18629 which is to be set to
18630 \begin_inset Quotes eld
18635 originaldir,parselog=listerrors
18638 \begin_inset Quotes erd
18642 This will run any errors that are generated by the
18643 \begin_inset Quotes eld
18647 \begin_inset Quotes erd
18650 process through the
18651 \begin_inset Quotes eld
18655 \begin_inset Quotes erd
18661 The converter code looks in
18669 then on the path for the
18670 \begin_inset Quotes eld
18674 \begin_inset Quotes erd
18680 Build instructions in the document
18683 The last piece of the integration between LyX and noweb is the
18684 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18692 Generally, the instructions for building your program should be embedded
18693 in a scrap of its own.
18695 \begin_inset Quotes eld
18699 \begin_inset Quotes erd
18702 above uses the notangle command to look for this scrap (called
18703 \begin_inset Quotes eld
18707 \begin_inset Quotes erd
18710 ) and runs its contents through
18711 \begin_inset Quotes eld
18715 \begin_inset Quotes erd
18721 Typically, such a scrap would look something like this:
18730 if [ -z "${NOWEB_SOURCE}" ]
18734 NOWEB_SOURCE=myfile.nw
18739 code to extract files ...]
18742 code to compile files ...]
18749 LIBDIR/examples/listerrors.lyx
18753 LIBDIR/examples/Literate.lyx
18755 which implement two versions of the
18756 \begin_inset Quotes eld
18760 \begin_inset Quotes erd
18763 program for some illustrations of how all of these pieces go together or
18766 LIBDIR/examples/noweb2lyx.lyx.
18769 Interestingly, these three files show off the language-indepence of the
18770 LyX literate programming support since they are written in Python, C and
18772 \layout Subsubsection
18777 All the Literate Programming support is configured by the
18782 ools\SpecialChar \menuseparator
18790 \begin_inset Quotes eld
18794 \begin_inset Quotes erd
18798 The important parts are:
18799 \layout Description
18803 \begin_inset Quotes eld
18807 \begin_inset Quotes erd
18811 format Set up via the Formats tab, this is where the Noweb-specific pieces
18821 , the file extension is set to
18826 This tells LyX to create a file with a
18830 extension in the first step of the conversion process.
18831 \layout Description
18839 format This is an empty format whose sole purpose is to be the endpoint
18840 of a conversion (which then allows us to set up a converter for it).
18841 \layout Description
18851 This converter performs the
18852 \begin_inset Quotes eld
18856 \begin_inset Quotes erd
18859 of the literate document.
18860 For Noweb, it is set to
18861 \begin_inset Quotes eld
18866 noweave -delay -index $$i > $$o
18869 \begin_inset Quotes erd
18873 \layout Description
18884 \begin_inset Quotes eld
18888 \begin_inset Quotes erd
18892 As stated above, the Converter is set to
18893 \begin_inset Quotes eld
18901 \begin_inset Quotes erd
18904 , with Flags set to
18905 \begin_inset Quotes eld
18910 originaldir,parselog=listerrors
18913 \begin_inset Quotes erd
18917 \layout Subsubsection
18922 There is also a new function implemented in the LyX server, the
18923 \begin_inset Quotes eld
18926 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18930 When debugging code with ddd/gdb, it is possible to invoke a text editor
18931 at the current execution position with a single key stroke.
18932 The default ddd configuration for that is shift-ctrl-V.
18933 It happens that you can define the editor command line invocation in ddd
18940 dit\SpecialChar \menuseparator
18945 references\SpecialChar \menuseparator
18952 dialog and changing the "Edit Sources" entry.
18955 I take advantage of the new created LyX server function and this ddd feature,
18957 \begin_inset Quotes eld
18961 \begin_inset Quotes erd
18967 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18970 With this, whenever you are using ddd and find a point in the program that
18971 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18972 ddd you forward this information to LyX through the LyX server and then
18973 the LyX window will show the same file with the cursor at the same position
18974 ddd was pointing to.
18975 No more guessing or long scrolling to locate a point in the program back
18979 Note however that you must enable the LyX server to get this feature working
18980 (it is disabled by default).
18981 You can enable it in
18993 ) by entering in the
18998 \begin_inset Quotes eld
19003 /home/<your-home-directory>/.lyx/lyxpipe
19006 \begin_inset Quotes erd
19012 Read the LyX server documentation in the
19014 Customization Manual
19016 for further information.
19017 \layout Subsubsection
19022 There are six new buttons that can be added to your LyX toolbar.
19023 Five of these buttons are short cuts to layout styles:
19044 The last one is a short cut to the
19045 \begin_inset Quotes eld
19049 \begin_inset Quotes erd
19056 LyX has a range of buttons that are available for tool bar customization.
19057 In my toolbar I like to combine the six short cuts above with two more:
19065 \SpecialChar \menuseparator
19073 \SpecialChar \menuseparator
19086 iew\SpecialChar \menuseparator
19094 Here is how it looks like:
19103 Icon "layout Standard"
19106 Icon "layout Section"
19109 Icon "layout LaTeX"
19112 Icon "layout LyX-Code"
19115 Icon "layout Scrap"
19124 Icon "buffer-typeset"
19127 Icon "build-program"
19143 \layout Subsubsection
19145 Colors customization
19148 There are a number of colors in LyX that can be customized in
19153 One of the things that bothers people is the LaTeX font color.
19154 The default color is red, since the scraps uses LaTeX font, and there is
19155 a lot of scraps in literate documents, you may get tired of seeing everything
19157 You can change it by going to the tabs
19166 The next thing is the visible presence of the newline character in the screen.
19167 You can choose the color of this particular character and make it blend
19169 I recommend you choosing a color that is close to the background but not
19170 equal, that way you still can see it is there, but it is not bothering
19175 Secrets of the LaTeX Masters
19176 \begin_inset LatexCommand \label{cha:secrets}
19183 Though LyX is a powerful tool, it cannot hope to support everything that
19184 can be done with pure TeX/LaTeX.
19185 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
19186 as long as you are not afraid to use that
19187 \begin_inset Quotes eld
19191 \begin_inset Quotes erd
19194 button on the toolbar or add things to the LaTeX preamble.
19195 This section lists some tips, tricks, and otherwise cool ideas to give
19196 your document that extra little flair.
19199 Do try this at home
19201 , just start with something a little smaller and less important than your
19205 Most ideas in this section require less common files in your LaTeX installation.
19206 If you have a system like teTeX, most will already be available.
19207 A few, however, will need to be downloaded from one of the CTAN archives.
19208 Often, there are several ways to do something, or several LaTeX style files
19209 which do the same thing.
19210 We do not endorse one choice over another, we simply claim that we have
19211 done a particular task with a particular file.
19212 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19215 Tricks for Footnotes and Margin Notes
19226 LyX cannot yet take care of setting the footnote numbering back to 1 after
19227 each section in the
19228 \begin_inset Quotes eld
19236 \begin_inset Quotes erd
19241 document class or changing the counter style.
19242 You'll need to insert LaTeX commands like the following to achieve that:
19252 setcounter{footnote}{0}
19259 setcounter{footnote}{0}
19261 will set the counter back to 1
19267 The counter has been set back to 1.
19273 The following command will change the numbering to small letters.
19274 Take a look at the next footnote in your xdvi or ghostview
19294 This is an example for a footnote with alphabetic numbering.
19312 The next command sets the counter style back to default, i.e.
19335 to set the counter--style back to LyX's default, i.e.
19390 and others as counter styles.
19391 Just replace the LaTeX command in the above example and rerun TeX to see
19392 what those styles can do.
19399 Here are two examples of neat things you can do to margin notes using LaTeX
19403 The following command will make a vertical line appear alongside your text---gre
19405 \begin_inset Quotes eld
19409 \begin_inset Quotes erd
19418 rule[-10mm]{30mm}{5mm}}
19431 rule[-10mm]{30mm}{5mm}}
19437 Check your dvi- or ghostview-output to see what the
19443 command does to the following margin note.
19457 \begin_inset Marginal
19475 Lars Gullik Bjønnes
19481 The aim for this chapter
19487 Editor's note: Lars' original chapter was a masterful description of how
19493 However, it was too long to flow smoothly in this document.
19494 I have therefore chosen to excerpt the most important sections here (sorry,
19495 Lars); you can read the original chapter (and more of the story!) in the
19498 examples/multicol.lyx
19504 is to show how the LaTeX package
19508 can be used in a LyX document.
19509 As LyX doesn't support the
19513 package natively yet, we have to use some small hacks.
19514 By reading this section it should be obvious how to do this.
19524 package allows switching between one and multicolumn format on the same
19526 Footnotes are handled correctly (for the most part), but will be placed
19527 at the bottom of the page and not under each column.
19528 LaTeX's float mechanism, however, is partly disabled in the current implementat
19530 At the moment only page-wide floats can be used within the scope of the
19535 \layout Subsubsection
19540 If you want to have two columns in your text, you have use LaTeX mode to
19545 begin{multicols}{2}
19547 at the point where you want the two column layout to start, and then
19553 where you want it to end.
19564 begin{multicols}{2}
19573 The Adventure of the Empty House
19579 Sir Arthur Conan Doyle
19584 It was in the spring of the year 1894 that all London was interested, and
19585 the fashionable world dismayed, by the murder of the Honourable Ronald
19586 Adair under most unusual and inexplicable circumstances.
19587 The public has already learned those particulars of the crime which came
19588 out in the police investigation, but a good deal was suppressed upon that
19589 occasion, since the case for the prosecution was so overwhelmingly strong
19590 that it was not necessary to bring forward all the facts.
19591 Only now, at the end of nearly ten years, am I allowed to supply those
19592 missing links which make up the whole of that remarkable chain.
19593 The crime was of interest in itself, but that interest was as nothing to
19594 me compared to the inconceivable sequel, which afforded me the greatest
19595 shock and surprise of any event in my adventurous life.
19596 Even now, after this long interval, I find myself thrilling as I think
19597 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19598 ty which utterly submerged my mind.
19599 Let me say to that public, which has shown some interest in those glimpses
19600 which I have occasionally given them of the thoughts and actions of a very
19601 remarkable man, that they are not to blame me if I have not shared my knowledge
19602 with them, for I should have considered it my first duty to do so, had
19603 I not been barred by a positive prohibition from his own lips, which was
19604 only withdrawn upon the third of last month.
19618 \layout Subsubsection
19623 The same pattern is used when you want more than two columns:
19633 begin{multicols}{3}
19641 It can be imagined that my close intimacy with Sherlock Holmes had interested
19642 me deeply in crime, and that after his disappearance I never failed to
19643 read with care the various problems which came before the public.
19644 And I even attempted, more than once, for my own private satisfaction,
19645 to employ his methods in their solution, though with indifferent success.
19646 There was none, however, which appealed to me like this tragedy of Ronald
19648 As I read the evidence at the inquest, which led up to a verdict of willful
19649 murder against some person or persons unknown, I realized more clearly
19650 than I had ever done the loss which the community had sustained by the
19651 death of Sherlock Holmes.
19652 There were points about this strange business which would, I was sure,
19653 have specially appealed to him, and the efforts of the police would have
19654 been supplemented, or more probably anticipated, by the trained observation
19655 and the alert mind of the first criminal agent in Europe.
19656 All day, as I drove upon my round, I turned over the case in my mind and
19657 found no explanation which appeared to me to be adequate.
19658 At the risk of telling a twice-told tale, I will recapitulate the facts
19659 as they were known to the public at the conclusion of the inquest.
19675 You can have have more than 3 columns if you want to, but that might not
19676 be very pleasant for the eye.
19677 \layout Subsubsection
19679 Columns inside columns
19682 You can even have columns inside columns:
19692 begin{multicols}{2}
19700 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19701 at that time governor of one of the Australian colonies.
19702 Adair's mother had returned from Australia to undergo the operation for
19703 cataract, and she, her son Ronald, and her daughter Hilda were living together
19714 begin{multicols}{2}
19722 The youth moved in the best society--had, so far as was known, no enemies
19723 and no particular vices.
19724 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19725 had been broken off by mutual consent some months before, and there was
19726 no sign that it had left any very profound feeling behind it.
19727 For the rest {sic} the man's life moved in a narrow and conventional circle,
19728 for his habits were quiet and his nature unemotional.
19729 Yet it was upon this easy-going young aristocrat that death came, in most
19730 strange and unexpected form, between the hours of ten and eleven-twenty
19731 on the night of March 30, 1894.
19749 Ronald Adair was fond of cards--playing continually, but never for such
19750 stakes as would hurt him.
19751 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19752 It was shown that, after dinner on the day of his death, he had played
19753 a rubber of whist at the latter club.
19754 He had also played there in the afternoon.
19759 The evidence of those who had played with him-- Mr.
19760 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19761 and that there was a fairly equal fall of the cards.
19762 Adair might have lost five pounds, but not more.
19763 His fortune was a considerable one, and such a loss could not in any way
19765 He had played nearly every day at one club or other, but he was a cautious
19766 player, and usually rose a winner.
19767 It came out in evidence that, in partnership with Colonel Moran, he had
19768 actually won as much as four hundred and twenty pounds in a sitting, some
19769 weeks before, from Godfrey Milner and Lord Balmoral.
19770 So much for his recent history as it came out at the inquest.
19786 Please do read the file
19788 examples/multicol.lyx
19790 for more advanced examples including column and header spacing, vertical
19791 separator lines, and more.
19798 Paragraph Environment
19799 \begin_inset OptArg
19804 Numbering in Enumerate
19809 \added_space_bottom bigskip
19815 The default numbering for the
19819 paragraph environment begins with Arabic numbers and ends with uppercase
19821 Suppose, however, you wanted a different type of numbering scheme.
19822 Here's a quickie example of how to change the numbering scheme:
19861 \SpecialChar \ldots{}
19862 which changes the numbering scheme to uppercase Roman numerals, uppercase
19863 letters, Arabic numbers, and lowercase letter.
19866 Additionally, the previous example also adds a little bit extra to the numbering
19868 For example, the first level label actually looks like:
19869 \begin_inset Quotes eld
19873 \begin_inset Quotes erd
19877 For ease of reading, we'll describe what the numbering schemes look like
19878 using a notation something like this: <
19879 \begin_inset Quotes eld
19883 \begin_inset Quotes erd
19888 \begin_inset Quotes erd
19892 \begin_inset Quotes erd
19897 \begin_inset Quotes erd
19901 \begin_inset Quotes erd
19906 \begin_inset Quotes eld
19910 \begin_inset Quotes erd
19917 As you can see in the example, there is a label command for each nesting
19924 \SpecialChar \ldots{}
19931 , as well as a counter,
19935 \SpecialChar \ldots{}
19941 There are also five
19942 \begin_inset Quotes eld
19946 \begin_inset Quotes erd
19979 , each of which take one counter as an argument.
19980 You can add characters before or after these, but there's no need to add
19984 You can get really fancy with these.
20030 produces the somewhat out of hand numbering scheme: <
20031 \begin_inset Quotes eld
20035 \begin_inset Quotes erd
20040 \begin_inset Quotes erd
20044 \begin_inset Quotes erd
20049 \begin_inset Quotes erd
20053 \begin_inset Quotes erd
20058 \begin_inset Quotes eld
20062 \begin_inset Quotes erd
20069 Extra Space Between Table Rows
20071 \added_space_bottom bigskip
20077 LaTeX allows you to put a bit of extra space between rows in a table by
20078 giving an optional argument to the end-of-row specifier (
20087 LyX has not yet implemented this in a formal way, so here are two dirty
20088 little tricks to do the same job.
20092 The first is the more formal, but longwinded way to do it.
20093 In the LaTeX preamble, add the following command definition:
20102 extratablespace}[1]{
20106 This command takes a single argument---the amount of space you would like
20108 Insert the command in the first column of the row
20112 where you would like the space to appear.
20113 Here is an example (I've removed all the borders using
20118 ayout\SpecialChar \menuseparator
20128 \begin_inset Tabular
20129 <lyxtabular version="3" rows="4" columns="3">
20131 <column alignment="center" valignment="top" width="0pt">
20132 <column alignment="center" valignment="top" width="0pt">
20133 <column alignment="center" valignment="top" width="0pt">
20135 <cell alignment="center" valignment="top" topline="true" usebox="none">
20152 <cell alignment="center" valignment="top" topline="true" usebox="none">
20169 <cell alignment="center" valignment="top" topline="true" usebox="none">
20188 <cell alignment="center" valignment="top" topline="true" usebox="none">
20195 <cell alignment="center" valignment="top" topline="true" usebox="none">
20212 <cell alignment="center" valignment="top" topline="true" usebox="none">
20231 <cell alignment="center" valignment="top" topline="true" usebox="none">
20252 extratablespace{2ex}
20258 <cell alignment="center" valignment="top" topline="true" usebox="none">
20275 <cell alignment="center" valignment="top" topline="true" usebox="none">
20294 <cell alignment="center" valignment="top" topline="true" usebox="none">
20301 <cell alignment="center" valignment="top" topline="true" usebox="none">
20318 <cell alignment="center" valignment="top" topline="true" usebox="none">
20343 The second method is faster, but will make typographers and TeXperts all
20344 over the world groan.
20345 Simply put an end of row specifier with optional argument at the same spot.
20346 No fancy definitions are needed as in the above example, but there will
20347 be more space inserted than you specified because you essentially added
20348 a blank row plus the extra space.
20349 If the space added is too much, simply use a negative number, like so:
20353 \begin_inset Tabular
20354 <lyxtabular version="3" rows="4" columns="3">
20356 <column alignment="center" valignment="top" width="0pt">
20357 <column alignment="center" valignment="top" width="0pt">
20358 <column alignment="center" valignment="top" width="0pt">
20360 <cell alignment="center" valignment="top" topline="true" usebox="none">
20377 <cell alignment="center" valignment="top" topline="true" usebox="none">
20394 <cell alignment="center" valignment="top" topline="true" usebox="none">
20413 <cell alignment="center" valignment="top" topline="true" usebox="none">
20420 <cell alignment="center" valignment="top" topline="true" usebox="none">
20437 <cell alignment="center" valignment="top" topline="true" usebox="none">
20456 <cell alignment="center" valignment="top" topline="true" usebox="none">
20485 <cell alignment="center" valignment="top" topline="true" usebox="none">
20502 <cell alignment="center" valignment="top" topline="true" usebox="none">
20521 <cell alignment="center" valignment="top" topline="true" usebox="none">
20528 <cell alignment="center" valignment="top" topline="true" usebox="none">
20545 <cell alignment="center" valignment="top" topline="true" usebox="none">
20570 It's short, sweet, and gets the job done quickly, even if it is really ugly.
20571 You may put away the rotten vegetables now! I promise I won't suggest anything
20577 \added_space_bottom bigskip
20592 tmpfont}{cmr17 scaled 2500}{
20614 hose of you who like the style of old books probably also like
20615 \begin_inset Quotes eld
20619 \begin_inset Quotes erd
20622 ---those large capital letters which begin each new chapter or section.
20623 Implementing them with plain LyX/LaTeX is straightforward (assuming you
20624 know some plain TeX!) but does require a lot of work and many iterations,
20625 as you can see by all the ugly TeX-mode stuff at the beginning of this
20638 bigdrop{-1em}{3}{ptmri}{T}+
20641 here is a much easier way of doing this, of course.
20650 ) package from CTAN allows a simple way to add such letters to your documents.
20651 Since this package is not a standard part of teTeX, I can't demonstrate
20652 it within this document, but if you copy this paragraph to a new document,
20654 \begin_inset Quotes eld
20664 \begin_inset Quotes erd
20667 and the pluses from the TeX code at the beginning of the paragraph, and
20672 usepackage{dropcaps}
20674 to your LaTeX preamble, you will get a nice Times Roman Italic
20675 \begin_inset Quotes eld
20679 \begin_inset Quotes erd
20682 , whose height is three lines of text and which protrudes 1 em into the
20684 (Make certain you have copied
20685 \begin_inset Quotes eld
20693 \begin_inset Quotes erd
20696 into a directory where TeX can see it.) The first argument is the amount
20697 of indentation; in this case the negative sign moves it into the margin.
20698 The second argument is the height of the letter in number of lines of text.
20699 The third argument is the font name: virtually anything which has a tfm
20700 file should work (wade through the
20702 .../texmf/fonts/tfm
20704 directory for possibilities).
20705 My personal favorite is
20706 \begin_inset Quotes eld
20714 \begin_inset Quotes erd
20717 , a fancy German font specifically designed for dropped capitals.
20718 The fourth argument is the letter (or letters) to be dropped.
20723 package also offers the
20729 command, as well as a slightly simplified
20738 Non-standard Paragraph Shapes
20740 \added_space_bottom bigskip
20904 There are times when the tyranny of rectangular paragraphs must be overthrown.
20905 In such situations, a call to the delightful plain TeX command
20912 As you can see, completely arbitrary shapes can be laid out with a suitable
20913 set of linelength definitions.
20914 While this parshape may look a bit silly and useless, one could conceive
20915 of situations such as finely tuned dropped capitals, word wrapping around
20916 non-rectangular graphics, etc.
20917 which will benefit from such handcrafting.
20919 \added_space_top bigskip
20924 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20931 is the number of lines of text which define the paragraph.
20932 If there turn out to be fewer lines, the shape is truncated; if there are
20933 more, the excess lines have the same dimensions as the last line of the
20943 entries specify the indentation of the line from the left margin, and the
20944 length of the line as measured from that point.
20945 The shape applies only to the current paragraph; everything is reset to
20946 normal for the next paragraph.
20965 As you can see, the examples in this section range from the useful to the
20967 While I don't expect that anyone will ever need the paragraph shape demonstrate
20968 d in the last section, the important point is that you can do almost anything
20969 you want in LyX if you are willing to figure out how to do it in TeX and
20971 TeX is a fantastically powerful typesetting system and all that power is
20972 available to you since LyX uses it as its backend.