1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16 {\usepackage{lmodern}} % if it exists
18 \usepackage[scaled=0.92]{helvet}
21 } % end if it exists not
23 % link all cross references and URLs
25 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, bookmarksopen, bookmarksopenlevel=1,
26 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
27 pdfpagelayout=OneColumn, pdfnewwindow=true,
28 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
29 pdfauthor={LyX Team}, pdftex,
30 pdftitle={LyX's Extended manual},
31 pdfsubject={LyX's extended documentation},
32 pdfkeywords={LyX, Documentation, Extended}]{hyperref}
34 \else % if dvi or ps is produced
36 % link all cross references and URLs in DVI output
37 \usepackage[ps2pdf, colorlinks=true,
38 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue]{hyperref}
40 \fi % end if pdflatex is used
42 % redefine the \LyX macro for PDF bookmarks
43 \def\LyX{\texorpdfstring{%
44 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
56 \font_typewriter default
57 \font_default_family default
63 \paperfontsize default
72 \paperorientation portrait
75 \paragraph_separation indent
77 \quotes_language english
80 \paperpagestyle headings
81 \tracking_changes false
98 \begin_layout Standard
100 Principal maintainer of this file is
105 If you have comments or error corrections, please send them to the LyX
106 Documentation mailing list, <lyx-docs@lists.lyx.org>.
114 \begin_layout Standard
115 \begin_inset CommandInset toc
116 LatexCommand tableofcontents
123 \begin_layout Chapter
127 \begin_layout Standard
130 Extended LyX Features
132 manual, which you are now reading, is essentially Part II of the
134 User's Guide\SpecialChar \@.
137 The reason for splitting this document is simple: the
141 is already huge, and it contains all of the basic features one needs to
142 know in order to prepare most documents.
143 However, the LyX Team has a long-term goal of making LyX extensible through
144 various configuration files and external packages.
145 That means that if you want to support the Fizzwizzle LaTeX package, you
146 can create a layout file for it without having to alter LyX itself.
147 We've already had contributions of several new features this way.
148 This is the place where all of that gets documented.
151 \begin_layout Standard
152 This manual also documents some special features, like fax support, version
153 control, and SGML support, which require additional software to work properly.
154 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
155 spruce up your documents by directly using the powerful features of LaTeX.
160 only WYSIWYM, and will only ever interface to certain LaTeX features.
163 \begin_layout Standard
164 Of course, with all of this extra documentation,
166 Extended LyX Features
168 may itself grow too big for its britches.
169 In that case, you can just call it the
170 \begin_inset Quotes eld
174 \begin_inset Quotes erd
180 \begin_layout Standard
181 If you haven't read the
185 yet, you are definitely in the wrong manual.
190 is the first place to go, since it will direct you to the correct manual,
191 and it also describes the notation and format of all of the manuals.
192 You should also be thoroughly familiar with the
196 and all of the basic features of LyX.
200 \begin_layout Standard
201 In this document, many sections are independent articles contributed by
202 an individual and are noted as such.
203 This person is generally whoever wrote the layout file for the new document
204 class or LaTeX package, or implemented the feature.
205 If there is no mention of an author to a chapter [or chapter sections],
206 that means it was written by the LyX Documentation Team.
209 \begin_layout Standard
210 Since all the topics in this manual depend heavily on LyX's interaction
211 with LaTeX, this first chapter covers the inner workings of LyX and how
212 to direct LyX to generate exactly the LaTeX code you want.
213 It is obviously for more seasoned LyX users.
216 \begin_layout Chapter
220 \begin_layout Section
224 \begin_layout Standard
225 \begin_inset CommandInset label
227 name "sec:lyxandlatex"
231 This chapter is for both TeX-nicians and the LaTeX-curious.
232 In it, we'll explain how LyX and LaTeX work together to produce printable
234 This is the only place in any of the manuals where we assume you know something
238 \begin_layout Standard
239 At one time, we called LyX a
240 \begin_inset Quotes eld
243 WYSIWYM frontend to LaTeX,
244 \begin_inset Quotes erd
247 but that's no longer true.
248 There are frontends to LaTeX out there.
249 They are basically editors with the ability to run LaTeX and mark any errors
250 in the file you're editing.
259 run LaTeX, and it also marks errors in the file, it also does much, much
261 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
262 LyX has also added a few extensions to LaTeX.
263 Try the following sometime: select
265 Export\SpecialChar \menuseparator
275 menu, then look at the preamble of the resulting
280 You'll notice a variety of new macros defined specifically by LyX.
281 These macros are defined automatically, according to the features you use
285 \begin_layout Standard
286 There are several commands that automatically invoke LaTeX.
290 \begin_layout Itemize
296 iew\SpecialChar \menuseparator
303 \begin_layout Itemize
309 iew\SpecialChar \menuseparator
314 pdate\SpecialChar \menuseparator
320 \begin_layout Itemize
328 \SpecialChar \menuseparator
334 \begin_layout Itemize
342 \SpecialChar \menuseparator
348 \begin_layout Standard
349 They will only invoke LaTeX if the file has changed since the last time
354 \begin_layout Standard
355 When you run LaTeX on the file you're editing, LyX performs these steps:
358 \begin_layout Enumerate
359 Convert the document to LaTeX and save to a file with the extension
370 \begin_layout Enumerate
375 file (maybe several times).
378 \begin_layout Enumerate
379 If there are any errors, insert error boxes in the document to mark where
381 These boxes are transient and are not saved along with the document.
384 \begin_layout Standard
385 If you've run LaTeX using
407 , LyX performs two more steps:
410 \begin_layout Itemize
415 to convert the DVI file to PostScript:
419 \begin_layout Itemize
425 , the output file has the extension
430 \begin_layout Itemize
439 , the output file has the extension
447 \begin_layout Itemize
452 or send the PostScript file to the printer.
455 \begin_layout Section
456 \begin_inset Quotes eld
459 Help! LyX generated an unreadable
464 \begin_inset Quotes erd
470 \begin_layout Standard
471 Die-hard LaTeX users will scream and howl this into the night, then declare
472 LyX useless, simply because they didn't RTFM.
475 \begin_layout Standard
476 We're going to set the record straight.
477 LyX produces two kinds of LaTeX files.
478 One is human readable.
479 The other is LyX readable.
480 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
486 file is not human readable.
487 Don't even try to read it.
492 file that you can send to a colleague, select
497 xport\SpecialChar \menuseparator
514 \begin_layout Section
515 Translating LaTeX files into LyX
516 \begin_inset CommandInset label
518 name "sec:Translating-LaTeX-files"
525 \begin_layout Standard
526 You can import a LaTeX file into LyX by using the
531 ile\SpecialChar \menuseparator
536 mport\SpecialChar \menuseparator
544 This will call a program named
548 ---which will create a file
556 ---and then open that file.
559 \begin_layout Standard
564 will translate most legal LaTeX, but not everything.
565 It will leave things it doesn't understand in TeX mode, so after translating
570 , you can look for red text and hand-edit it to look right.
573 \begin_layout Standard
574 If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
576 \begin_inset CommandInset ref
578 reference "sec:latexcodes"
585 \begin_layout Section
586 Inserting LaTeX Code into LyX Documents
587 \begin_inset CommandInset label
589 name "sec:Inserting-LaTeX-Code"
596 \begin_layout Standard
597 \begin_inset CommandInset label
599 name "sec:latexcodes"
603 This is a rather important point: You can always insert LaTeX code into
605 LyX simply cannot, and will probably never be able to, display every possible
607 If ever you need to insert LaTeX commands into your LyX document, you can
608 use the ERT box, which you can insert into your document with
613 nsert\SpecialChar \menuseparator
621 The ERT box comes in three forms: collapsed, open, and inlined.
622 The first two are used just like any other collapsible (foldable) box (such
623 as footnotes), and are useful for significant amounts of LaTeX commands.
625 \begin_inset Quotes eld
629 \begin_inset Quotes erd
632 ERT box displays its content as part of the button, and is useful for very
633 short sections of LaTeX commands.
638 \begin_layout Standard
648 \begin_layout Standard
649 You can switch between all three by right-clicking on the ERT.
650 Note that if you want more than one line of LaTeX commands, you cannot
651 use the inlined mode.
654 \begin_layout Standard
655 Here's an example of inserting LaTeX commands in a LyX document.
656 The code looks like this:
659 \begin_layout LyX-Code
668 This is an example for a minipage environment.
671 can put nearly everything in it, even (non-floating)
714 \begin_layout LyX-Code
718 \begin_layout Standard
719 The ERT box containing this text is directly after this paragraph.
720 Those of you reading the manual online will only see a bunch of funky text
722 Those reading a printed version of the manuals will see the actual results:
725 \begin_layout Standard
729 \begin_layout Standard
736 \begin_layout Standard
743 \begin_layout Standard
745 This is an example for a minipage environment.
746 You can put nearly everything in it, even (non-floating) figures and tables.
750 \begin_layout Standard
757 \begin_layout Standard
762 \begin_layout Standard
769 \begin_layout Standard
776 \begin_layout Standard
783 \begin_layout Standard
789 \begin_layout Standard
796 \begin_layout Standard
803 \begin_layout Standard
810 \begin_layout Standard
822 \begin_layout Standard
823 In addition to these two methods, you can also create a separate file containing
824 some complex LaTeX structure.
830 nsert\SpecialChar \menuseparator
838 to include your file (you should select the type
843 We recommend that you only do this if you have a
852 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
856 \begin_layout Standard
857 There are a few last notes to emphasize:
860 \begin_layout Itemize
861 Inside of LyX, LaTeX code appears
866 \begin_layout Itemize
871 check if your LaTeX code is correct.
874 \begin_layout Itemize
875 Beware reinventing the wheel.
878 \begin_layout Standard
879 That last note refers to two things.
880 First, LyX does have quite a few features tucked into it, and more are
882 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
883 feature before you go off merrily coding LaTeX.
884 Second, there are numerous LaTeX packages out there to do all sorts of
885 things, from labels to envelopes to fancy multipage tables.
886 Check out a CTAN site for details (see Section
887 \begin_inset Quotes eld
891 \begin_inset Quotes erd
902 \begin_layout Standard
907 : I seem to do this an awful lot.
908 Sat down and merrily began coding something to print out labels, only to
909 learn that there were already 2 different LaTeX packages to do this.
910 Worse yet --- I had them already!
918 \begin_layout Standard
919 If you do need to do some wild and fancy things within your document, be
920 sure to check out a good LaTeX book for assistance.
921 There are a number of them listed in the bibliography of the
928 \begin_layout Standard
929 There are a number of LaTeX commands which have to be placed before the
930 beginning of the actual text.
931 They go into the preamble, and this is explained in the next section.
934 \begin_layout Section
935 LyX and the LaTeX Preamble
938 \begin_layout Subsection
939 About the LaTeX Preamble
942 \begin_layout Standard
943 \begin_inset CommandInset label
949 If you already know LaTeX, there is no need to explain here what the preamble
951 If you don't, the following will give you some ideas --- we recommend again
952 that you consult a LaTeX book for further information.
953 In any case, you should read the points below, because they explain what
954 you can do and what you don't need to do in the LaTeX preamble of a LyX
958 \begin_layout Standard
959 The LaTeX preamble comes at the very beginning of a document,
967 \begin_layout Itemize
968 declare the document class.
969 LyX already does this for you.
973 \begin_layout Standard
974 If you're a seasoned LaTeX-nician, and you have some custom document class
975 you want to use, check out the
979 for information on how to make LyX interface to it.
980 Be sure to submit your efforts to the LyX Team for inclusion in future
985 \begin_layout Itemize
986 declare the usage of packages.
987 LaTeX packages provide special commands, which are only available within
988 a document when the package has been declared in the preamble.
989 For example, the package
993 forces all paragraphs to be indented.
994 There are other packages for labels, envelopes, margins, etc.
998 \begin_layout Itemize
999 set counters, variables, lengths and widths.
1000 There are several LaTeX counters and variables which
1004 be set globally from within the preamble in order to have the desired effect.
1005 [There are other variables which you can set and reset inside the document,
1006 too.] Margins are a good example of something which must be set in the preamble.
1007 Another example is the label format for lists.
1008 You can actually set these just about anywhere, but it's best to do it
1009 just once, inside the preamble.
1012 \begin_layout Itemize
1013 declare user defined commands [with
1025 ], mostly abbreviations for LaTeX commands which appear very often inside
1027 Although the preamble is a good place to declare such commands, they
1031 be declared anywhere else [but
1035 they are used for the first time, of course\SpecialChar \ldots{}
1037 This can be useful if there is a lot of raw LaTeX code in your document,
1038 which normally should not be the case.
1041 \begin_layout Standard
1042 LyX adds its own set of definitions to the preamble of the
1047 This makes LaTeX files generated by LyX portable.
1050 \begin_layout Subsection
1051 Changing the Preamble
1054 \begin_layout Standard
1055 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1056 can't change them without patching LyX itself.
1057 You can, however, add your own stuff to the preamble.
1058 There are two ways to do this:
1061 \begin_layout Enumerate
1088 \SpecialChar \menuseparator
1096 dialog, depending on your frontend.
1097 Note that the LyX keybindings will not work in this dialog, alas.
1100 \begin_layout Enumerate
1101 Use the preamble contents you've added as your default template (see
1102 \begin_inset Quotes eld
1106 \begin_inset Quotes erd
1113 ), so that it will be the default preamble for any file you create.
1116 \begin_layout Standard
1117 LyX adds anything in the
1124 dialog to its own built-in preamble.
1125 Before adding your own declarations in the preamble, you should make sure
1126 that LyX doesn't already support what you want to do (remember what we
1127 said about reinventing the wheel?).
1130 make sure your preamble code is correct
1133 LyX doesn't check it.
1136 \begin_layout Subsection
1140 \begin_layout Standard
1141 Here are some examples of what you can add to a preamble, and what they
1145 \begin_layout Subsubsection
1149 \begin_layout Standard
1150 There are two variables under LaTeX that control page position:
1163 Their names should be self-explanatory.
1164 These variables are useful if you think for a moment about computer labels.
1165 Sometimes, the size of a print medium and the area of the medium that you
1166 can actually print on aren't the same.
1182 \begin_layout Standard
1183 The default values for
1195 are both 0 pt.,\InsetSpace ~
1198 the page isn't shifted.
1201 \begin_layout Standard
1202 Unfortunately, some DVI drivers always seem to shift the page.
1203 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1204 If you're using LyX on a system that you don't personally maintain, and
1205 your sysadmin is a doofus,
1218 Suppose you're left and top margins are always 0.5 inches too big.
1219 You can add this to the preamble:
1222 \begin_layout LyX-Code
1230 \begin_layout LyX-Code
1238 \begin_layout Standard
1239 \SpecialChar \ldots{}
1240 and your margins should now be correct.
1243 \begin_layout Subsubsection
1247 \begin_layout Standard
1248 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1249 There's a rather nice package, available at your nearest CTAN archive,
1250 for printing sheets of labels, called
1255 Now, your system may not have this package installed by default.
1256 We leave that up to you to check.
1257 You'll also want to read the documentation for it; we're not going to do
1259 Since this is an example, however, we'll give you an example of how you
1263 \begin_layout Standard
1264 First, make sure you're using the
1269 Next, you need to put the following in your preamble:
1272 \begin_layout LyX-Code
1278 \begin_layout LyX-Code
1284 \begin_layout LyX-Code
1290 \begin_layout LyX-Code
1296 \begin_layout LyX-Code
1302 \begin_layout LyX-Code
1308 \begin_layout LyX-Code
1314 \begin_layout Standard
1315 This sets things up for Avery® label sheets, stock #5360.
1316 You're now ready to print labels, but you'll need to insert LaTeX code,
1317 placing the commands
1329 around each label text.
1330 This and other special features of
1334 are explained in its documentation.
1337 \begin_layout Standard
1338 Someday, someone may write a LyX layout file to support this package directly.
1339 Maybe that someone is you.
1342 \begin_layout Subsubsection
1343 Example #3: Paragraph Indentation
1346 \begin_layout Standard
1347 Americans are trained to indent the first line of
1352 As with all of their other weird quirks, most Americans will whine and
1353 moan until they can have their way and indent the first line of all paragraphs.
1357 \begin_layout Standard
1362 : This was written by an American ---
1366 ! It's my perception of my fellow countrymen.
1367 Tough if you don't like it.
1376 \begin_layout Standard
1377 Of course, this behavior isn't standard typography.
1378 In books, you typically only indent the first line of a paragraph
1382 it follows another one.
1383 The idea behind indenting the first line of a paragraph is to distinguish
1384 neighboring paragraphs from one another.
1385 If there is no previous paragraph, for example, it follows a figure, or
1386 is the first paragraph in a section, then there is no special indentation.
1390 \begin_layout Standard
1391 If you're a typical American, though, you don't care about such esoteric
1392 things; you want your indentation! Add this to the preamble:
1395 \begin_layout LyX-Code
1398 usepackage{indentfirst}
1401 \begin_layout Standard
1402 If your TeX distribution isn't a braindead one, you'll have this package,
1403 and all of your paragraphs will get the indentation you think they deserve.
1406 \begin_layout Subsubsection
1407 Example #4: This Document
1410 \begin_layout Standard
1411 You can also check out the preamble of this document to get an idea of some
1412 of the advanced things you can do.
1413 You'll probably need to make the
1418 reamble\SpecialChar \ldots{}
1421 dialog full-screen to see most of it.
1422 Also, there are more examples and an assortment of LaTeX
1423 \begin_inset Quotes eld
1427 \begin_inset Quotes erd
1430 given in Chapter\InsetSpace ~
1432 \begin_inset CommandInset ref
1434 reference "cha:secrets"
1442 \begin_layout Section
1443 LyX and LaTeX Errors
1446 \begin_layout Standard
1447 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1449 It then uses the log-file from the LaTeX run to do a post-mortem.
1450 As we stated earlier in the chapter, LyX generates two kinds of
1454 files, one of which it uses to locate errors in the document.
1455 If there was an error someplace, LyX will put a box with the word
1456 \begin_inset Quotes eld
1460 \begin_inset Quotes erd
1463 at the appropriate place in the document.
1467 \begin_layout Standard
1468 LyX will occasionally misguess where the error was.
1469 This will typically happen with tables, figures, math, and the preamble.
1474 It will also display a message alerting you to the fact that there were
1478 \begin_layout Standard
1479 You can navigate through the errors by using
1495 \begin_inset Quotes eld
1499 \begin_inset Quotes erd
1502 the error-boxes and view the error message LaTeX produced by clicking on
1506 \begin_layout Standard
1507 Some folks also like to look at the log file directly, accessible from
1512 ocument\SpecialChar \menuseparator
1522 There are some fairly common error messages and warnings.
1523 We'll cover those here.
1524 You should look at a good LaTeX book for a complete listing.
1527 \begin_layout Itemize
1528 \begin_inset Quotes eld
1536 \begin_inset Quotes eld
1543 \begin_layout Standard
1544 Anything beginning with these word is a warning message for the purpose
1546 \begin_inset Quotes eld
1550 \begin_inset Quotes erd
1553 the LaTeX code itself.
1554 You'll get messages like this if you added or changed cross-references
1555 or bibliography entries, in which case, LaTeX is trying to tell you that
1556 you need to make another run.
1559 \begin_layout Standard
1560 You can by-and-large ignore these.
1564 \begin_layout Itemize
1565 \begin_inset Quotes eld
1573 \begin_inset Quotes erd
1580 \begin_layout Standard
1581 Another warning message, this time about fonts which LaTeX couldn't find.
1582 The rest of the message will often say something about a replacement font
1586 \begin_layout Standard
1587 You can safely ignore these.
1591 \begin_layout Itemize
1592 \begin_inset Quotes eld
1602 \begin_inset Quotes erd
1609 \begin_layout Standard
1615 They are warning you about lines that were too long and run past the right
1617 Almost always, this is unnoticeable in the final output.
1618 Or, only one or two characters extend past the margin.
1619 LaTeX seems to generate at least one of these messages for just about any
1623 \begin_layout Standard
1624 You can ignore these stupid messages.
1625 Your eyes will tell you if there's a problem with something that's too
1626 wide; just look at the output.
1630 \begin_layout Itemize
1631 \begin_inset Quotes eld
1641 \begin_inset Quotes erd
1648 \begin_layout Standard
1649 Not quite as common as its cousin.
1650 LaTeX seems to like to print lines that are a bit too wide as opposed to
1651 ones that are a bit too narrow.
1652 We have no idea why.
1655 \begin_layout Standard
1656 You can ignore these, too.
1660 \begin_layout Itemize
1661 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1675 \begin_inset Quotes eld
1685 \begin_inset Quotes erd
1692 \begin_layout Standard
1693 Warnings about troubles breaking the page.
1694 Once again, just look at the output.
1695 Your eyes will tell you where something has gone wrong.
1699 \begin_layout Itemize
1700 \begin_inset Quotes eld
1706 \begin_inset Quotes els
1710 \begin_inset Quotes ers
1716 \begin_inset Quotes erd
1723 \begin_layout Standard
1725 \begin_inset Quotes eld
1729 \begin_inset Quotes erd
1732 isn't installed on this system.
1733 This usually appears because some package your document needs isn't installed.
1734 If you didn't touch the preamble or didn't use the
1740 command, then one of the packages LyX tried to load is missing.
1746 elp\SpecialChar \menuseparator
1753 , to get a list of packages that LyX knows about.
1754 This file is updated whenever you reconfigure LyX (using
1761 \SpecialChar \menuseparator
1766 ) and tells you which packages have been detected and what they do.
1769 \begin_layout Standard
1780 command, and the package in question isn't installed, you'll need to install
1785 \begin_layout Itemize
1786 \begin_inset Quotes eld
1791 LaTeX Error: Unknown option
1794 \begin_inset Quotes erd
1801 \begin_layout Standard
1802 Error messages beginning with this are trying to tell you that you specified
1803 a bad or undefined option to a package.
1804 Check the package's documentation.
1808 \begin_layout Itemize
1809 \begin_inset Quotes eld
1814 Undefined control sequence
1817 \begin_inset Quotes erd
1824 \begin_layout Standard
1825 If you've inserted LaTeX code into your document, but made a typo, you'll
1827 You may have forgotten to load a package.
1828 In any case, this error message usually means that you used an undefined
1833 \begin_layout Standard
1834 There are other error and warning messages.
1835 Some are self-explanatory.
1836 These are usually LaTeX messages.
1837 Others are downright cryptic.
1838 These are actually TeX error messages, and we really have
1842 what they mean or how to decipher them.
1845 \begin_layout Standard
1846 There's a general sequence you should follow if you get error messages:
1849 \begin_layout Enumerate
1850 Look at the LaTeX code you inserted for typos.
1853 \begin_layout Enumerate
1854 If there are no typos, check and see that you used the command(s) correctly.
1857 \begin_layout Enumerate
1858 If you get a bunch of error boxes piled up at the very top of the document,
1859 it means that there are errors in the preamble.
1860 Start debugging your preamble.
1863 \begin_layout Enumerate
1864 If you didn't add anything to the preamble and didn't add any LaTeX code
1865 to the document, the first suspect is your LaTeX distribution itself.
1866 Check for missing packages and install them.
1869 \begin_layout Enumerate
1870 Okay, so there are no missing packages.
1871 Did you use any of the fine-tuning options in LyX? Specifically, did you
1876 any of them, like trying to manually insert lots of
1878 Protected\InsetSpace ~
1889 s? Did you try to kludge something together with these instead of using
1890 the appropriate paragraph environment?
1893 \begin_layout Enumerate
1894 All right, you didn't use any of the fine-tuning options, you played by
1896 Did you try to pull a fancy maneuver? Did you do something funky inside
1897 a table or an equation, like inserting a graphic into a table cell?
1900 \begin_layout Enumerate
1901 Do you have long sections of text where LaTeX cannot find a place to break
1902 a line? By default, LaTeX is rather strict about how much extra inter-word
1903 spacing it will add in order to break a line.
1904 Preferably, you should rework the paragraph to avoid the problem.
1905 If this isn't an option, you can wrap your text in
1911 to make LaTeX's line breaking more, well, sloppy.
1914 \begin_layout Enumerate
1915 Did you go overboard with the nesting? LyX (currently) doesn't check to
1916 make sure you're in the limits for nesting environments.
1917 If you nested a bunch of environments to the
1918 \begin_inset Formula $17^{\mathrm{th}}$
1921 level, that's the problem.
1924 \begin_layout Enumerate
1925 Okay, you didn't get any error messages, but your output looks whacked.
1926 If you have a table or figure that's too wide or long for the page, you
1931 \begin_layout Enumerate
1932 rescale the figure so it fits.
1935 \begin_layout Enumerate
1936 trim down the table so it fits.
1939 \begin_layout Standard
1940 If something else is wrong with the output, and you didn't try to pull anything
1941 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1945 \begin_layout Standard
1946 If all this doesn't help --- well, then
1950 you might have found a bug in LyX\SpecialChar \ldots{}
1954 \begin_layout Chapter
1958 \begin_layout Section
1959 Preparing a Bibliography with BibTeX
1960 \begin_inset CommandInset label
1962 name "sec:Preparing-a-Bibliography"
1969 \begin_layout Standard
1976 Jürgen Spitzmüller
1979 \begin_layout Standard
1980 \begin_inset VSpace bigskip
1986 \begin_layout Standard
1988 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1991 e.\InsetSpace \thinspace{}
1995 setting up your own bibliographic databases),
1999 , do not walk, to your nearest copy of the 2nd edition of Lamport's
2001 LaTeX: A Document Preparation System
2003 , particularly Appendix B.
2004 The rest of this discussion assumes you have created a correct bibliography
2005 file, that you have all relevant environment variables set correctly (esp.
2018 ), and that if sufficiently desperate, you could create and
2019 \begin_inset Quotes eld
2023 \begin_inset Quotes erd
2026 a LaTeX file with a BibTeX database.
2030 \begin_layout Standard
2031 For those who don't know what BibTeX is, it is a system for creating a large
2032 database of your most used journal references.
2033 For all future articles you write, you only need to include this standard
2034 database and reference the appropriate key to each reference.
2035 Even if you write only a few papers with handful of references each, it
2036 is well worth your time to examine BibTeX and decide whether it will be
2040 \begin_layout Standard
2041 To use BibTeX with LyX, first read the
2045 where it describes how to insert citations.
2046 The basic mechanism for inserting BibTeX references is the same.
2047 Then, at the very end of your document, select
2049 Insert\SpecialChar \menuseparator
2054 TOC\SpecialChar \menuseparator
2058 In the resulting dialog, fill out the dialog boxes as follows:
2061 \begin_layout Description
2062 Database: enter the name of your
2075 For searching multiple
2079 files, just enter them in the desired order, separated by commas.
2083 \begin_layout Description
2084 Style: enter the name of your BibTeX style file *without* the
2089 The default style is
2093 (which should be included in your LaTeX distribution, so you don't have
2094 to worry about creating it).
2097 \begin_layout Standard
2098 For each citation, assuming that the source is in the
2107 nsert\SpecialChar \menuseparator
2114 at the correct location in the text, and enter the appropriate reference
2116 Nothing else is required; when invoking
2121 iew\SpecialChar \menuseparator
2128 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2129 including multiple invocations of LaTeX.
2133 \begin_layout Subsection
2134 Alternative Citation Styles
2137 \begin_layout Standard
2138 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2139 g.\InsetSpace \space{}
2141 \begin_inset Quotes eld
2145 \begin_inset Quotes erd
2148 ) to refer to a cited work.
2149 However, in many scientific disciplines, other citation styles are in use.
2150 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2151 g.\InsetSpace \space{}
2153 \begin_inset Quotes eld
2157 \begin_inset Quotes erd
2161 LyX supports two packages that provide this style,
2170 Both packages have their own pros and cons, which cannot be listed in detail.
2171 If you only want to have simple author-year (or author-numerical) style
2172 or if you want to use one of the countless style files for natbib, than
2177 package is probably your choice.
2178 If you need special features like short title references, ibidem etc., you
2179 might consider the fairly new
2186 \begin_layout Standard
2187 The handling of both packages in LyX is basically the same.
2193 ocument\SpecialChar \menuseparator
2204 pane (with the xforms frontend: the
2218 With both packages, you will get some extra features in the citation dialog
2219 and you can select the style of the reference (
2220 \begin_inset Quotes eld
2224 \begin_inset Quotes erd
2228 \begin_inset Quotes eld
2232 \begin_inset Quotes erd
2236 \begin_inset Quotes eld
2240 \begin_inset Quotes erd
2244 \begin_inset Quotes eld
2248 \begin_inset Quotes erd
2252 Note that both packages need specifically designed style files (they both
2253 ship their own, while there are lots of additional style files and even
2254 an interactive style file builder
2258 \begin_layout Standard
2260 \begin_inset Flex URL
2263 \begin_layout Standard
2265 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2282 \begin_layout Subsection
2283 Sectionated Bibliographies
2284 \begin_inset CommandInset label
2286 name "sub:Sectionated-Bibliographies"
2293 \begin_layout Standard
2294 Sometimes you might need to divide your bibliography into several sections.
2295 If you are, for instance, a historian, the possibility to separate sources
2296 and scientific works is most likely a
2297 \begin_inset Quotes eld
2301 \begin_inset Quotes erd
2305 Unfortunately, BibTeX itself does not allow you to do this.
2306 The good news is, though: With the help of some LaTeX packages, BibTeX
2307 can be extended to fit your historical needs.
2310 \begin_layout Standard
2311 As of version 1.4, LyX provides native support for one of these packages,
2320 \begin_layout Standard
2322 \begin_inset Flex URL
2325 \begin_layout Standard
2327 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2337 The advantage of this package (compared to other packages like
2341 ) is that you don't need to define new citation commands.
2342 Instead, you need to prepare different bibliographic databases which include
2343 the entries for the different sections of the bibliography.
2344 For example: If you want to divide your bibliography into the sections
2346 \begin_inset Quotes eld
2350 \begin_inset Quotes erd
2354 \begin_inset Quotes eld
2358 \begin_inset Quotes erd
2361 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2362 g.\InsetSpace \space{}
2375 \begin_layout Standard
2381 ocument\SpecialChar \menuseparator
2392 pane (with the xforms frontend: the
2399 Sectionated\InsetSpace ~
2403 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2405 \begin_inset CommandInset ref
2407 reference "sec:Preparing-a-Bibliography"
2411 ), one for each section of your bibliography.
2412 Returning to our example: Insert a BibTeX reference for the database
2416 and a second one for the database
2421 You are free to use the same or different styles for each section.
2422 Additionally, you can chose if the bibliography section should contain
2424 \begin_inset Quotes eld
2427 all cited references
2428 \begin_inset Quotes erd
2431 of the specified database(s) (which is the default),
2432 \begin_inset Quotes eld
2435 all uncited references
2436 \begin_inset Quotes erd
2440 \begin_inset Quotes eld
2444 \begin_inset Quotes erd
2448 This might be useful if you would like to separate your bibliography into
2450 \begin_inset Quotes eld
2454 \begin_inset Quotes erd
2458 \begin_inset Quotes eld
2462 \begin_inset Quotes erd
2466 \begin_inset Quotes eld
2470 \begin_inset Quotes erd
2474 The titles for the sections can be added as ordinary sections or subsections.
2479 removes the bibliography title, you have manually re-add that, too (as
2480 a chapter* or section*, for instance).
2483 \begin_layout Subsection
2484 Multiple Bibliographies
2487 \begin_layout Standard
2488 Multiple bibliographies, e.\InsetSpace \thinspace{}
2489 g.\InsetSpace \space{}
2490 a bibliography for each section or chapter of
2491 the document, are not supported by BibTeX itself.
2496 package, which is used for the creation of sectionated bibliographies in
2497 LyX (cf.\InsetSpace ~
2498 section\InsetSpace ~
2500 \begin_inset CommandInset ref
2502 reference "sub:Sectionated-Bibliographies"
2506 ), provides an easy way to solve this task, if you are willing to use some
2507 LaTeX-Code (ERT, cf.\InsetSpace ~
2508 section\InsetSpace ~
2510 \begin_inset CommandInset ref
2512 reference "sec:Inserting-LaTeX-Code"
2520 \begin_layout Standard
2521 An alternative approach is to use the
2529 package, respectively.
2537 \begin_layout Standard
2543 ocument\SpecialChar \menuseparator
2554 pane (with the xforms frontend: the
2561 Sectionated\InsetSpace ~
2565 In the document, you have to enclose the sections, which shall contain
2566 their own bibliography (including the BibTeX reference itself), between
2579 (those commands have to be inserted as ERT).
2580 The bibliography will contain all references which have been cited in the
2582 N.\InsetSpace \thinspace{}
2583 B.: If you are using this approach, then
2587 citation reference has to be inside some btUnit.
2588 Also, the btUnits cannot be nested.
2591 \begin_layout Standard
2595 \begin_layout Section
2599 \begin_layout Subsection
2603 \begin_layout Standard
2604 When you are working on a large file with many sections, it is often convenient
2605 to break up the document into several files, or perhaps you have something
2606 where a table may change from time to time, but the preceding text does
2608 In these cases, you should seriously consider using multipart documents.
2609 For example, scientific papers often have five major sections: the introduction
2610 , observations, results, discussion, and conclusion.
2611 Each of these could be its own separate LyX file, with one
2612 \begin_inset Quotes eld
2616 \begin_inset Quotes erd
2619 file which contains the title, authors, abstract, references, etc., plus
2620 the five included files.
2621 It is important to note that each of these files is a full LyX file which
2622 can be formatted and printed on its own, as well as included in a master
2624 Each of these files must have the same document class, however--- don't
2625 attempt to mix book classes with article classes.
2626 You may also include LaTeX files; however, these files must not have their
2632 everything up to and including the
2644 line must be deleted) or else errors will be generated when you try to
2648 \begin_layout Standard
2649 LyX allows you to include files quite easily with
2654 nsert\SpecialChar \menuseparator
2663 When you click on this selection a small box is inserted into the file
2664 at the current cursor location.
2665 Clicking on the box raises a dialog which allows you to select the file
2666 to be included, and the method of its inclusion.
2670 \begin_layout Standard
2671 The file selection box should by now be obvious.
2672 The three inclusion methods are
2673 \begin_inset Quotes eld
2677 \begin_inset Quotes erd
2681 \begin_inset Quotes eld
2685 \begin_inset Quotes erd
2689 \begin_inset Quotes eld
2693 \begin_inset Quotes erd
2697 The difference between
2698 \begin_inset Quotes eld
2702 \begin_inset Quotes erd
2706 \begin_inset Quotes eld
2710 \begin_inset Quotes erd
2713 is really only meaningful to LaTeXperts, but the practical difference is
2714 that files which are
2715 \begin_inset Quotes eld
2719 \begin_inset Quotes erd
2722 are typeset beginning on a new page, while files which are
2723 \begin_inset Quotes eld
2727 \begin_inset Quotes erd
2730 are typeset starting on the current page.
2731 Perhaps the labeling in LyX will be changed someday to reflect this.
2734 \begin_layout Standard
2735 Generally, the master file is converted into a full LaTeX file before typesettin
2736 g, while the included files are converted to LaTeX files which do not have
2737 all the preamble information.
2747 button prevents this conversion.
2750 \begin_layout Standard
2752 \begin_inset Quotes eld
2756 \begin_inset Quotes erd
2759 included file allows you to include a file typeset exactly as it appears
2760 in the file, i.e.\InsetSpace ~
2761 verbatim mode, with the characters set in a fixed-width
2763 Normally, spaces in this file are invisible, though two consecutive spaces
2764 are conserved, unlike LyX's normal treatment of spaces.
2765 However, setting the
2775 checkbox typesets a mark to unambiguously define the presence of a space.
2779 \begin_layout Subsection
2780 Cross-References Between Files
2783 \begin_layout Standard
2784 It is possible to set up cross-references between the different files.
2785 First, open all the files in question: let's call them A and B in a two
2786 file example, where B is included in A.
2787 Let's say you insert a label in A, then want to reference it in B.
2788 Open the cross-reference dialog in whilst in document B, and you can select
2790 \begin_inset Quotes eld
2794 \begin_inset Quotes erd
2800 \begin_layout Section
2801 Fancy Headers and Footers
2804 \begin_layout Standard
2805 The default page layout is rather plain; for an article document class,
2806 all you get is a centered page number at the bottom of the page.
2807 This document is the book class, so it appears to be a bit fancier, but
2808 to really put on a show, you need to set the document page style to
2809 \begin_inset Quotes eld
2813 \begin_inset Quotes erd
2816 , as mentioned in the
2822 This section describes the LaTeX codes you need to insert in your LaTeX
2823 preamble or the text in order to get the desired effects.
2826 \begin_layout Standard
2827 The page header is divided into three fields, not surprisingly labeled
2828 \begin_inset Quotes eld
2832 \begin_inset Quotes erd
2836 \begin_inset Quotes eld
2840 \begin_inset Quotes erd
2844 \begin_inset Quotes eld
2848 \begin_inset Quotes erd
2852 The footer is also divided into these three fields.
2853 The LaTeX commands to set these fields in the simplest manner are
2878 Suppose you wish to put your name in the upper left hand corner of each
2880 Simply insert the following command in the preamble:
2883 \begin_layout Standard
2892 \begin_layout Standard
2893 You will now see your name in the upper left.
2894 If a field has a default entry that you would like to get rid of (often
2895 the page number appears in the central footer, simply include a command
2896 with a blank argument, e.\InsetSpace \thinspace{}
2900 \begin_layout Standard
2908 \begin_layout Standard
2909 Let's get really fancy: lets put the section number with the word
2910 \begin_inset Quotes eld
2914 \begin_inset Quotes erd
2917 (e.\InsetSpace \thinspace{}
2919 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
2921 Page 4) in the upper
2922 right, your name in the lower left, and the date in the lower right.
2923 The following commands should now appear in the preamble:
2926 \begin_layout Standard
2936 \begin_layout Standard
2944 \begin_layout Standard
2954 \begin_layout Standard
2963 \begin_layout Standard
2971 \begin_layout Standard
2981 \begin_layout Standard
2994 access LaTeX's section and page counters, and so print out the current
2995 section and page numbers.
3002 simply prints out today's date.
3005 \begin_layout Standard
3006 The thicknesses of the horizontal rules drawn beneath the header and above
3007 the footer can also be modified.
3008 If you don't want one of the headers, set its thickness to 0.
3009 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3010 Use the commands, e.\InsetSpace \thinspace{}
3018 headrulewidth}{0.4pt}
3026 footrulewidth}{0.4pt}
3028 to set the thicknesses.
3031 \begin_layout Standard
3032 You can switch the header/footer settings on and off for individual pages
3037 thispagestyle{empty}
3043 thispagestyle{plain}
3049 thispagestyle{fancy}
3052 Simply insert them in the text on the page you want changed and mark them
3054 In fact, title pages are marked as plain by default, while following pages
3055 are marked fancy when using the global fancy setting.
3058 \begin_layout Standard
3059 There are more complex commands which will let you insert things in the
3060 upper left on odd numbered pages, etc., but I will refer you to the
3064 package documentation for more descriptions.
3065 For example, if you have a teTeX installation, look for
3067 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3073 \begin_layout Standard
3074 As a final example, it is possible to include an Encapsulated PostScript
3075 file in the header or footer.
3076 Suppose you want to put a company logo in the upper lefthand corner.
3077 You might try something like
3080 \begin_layout Standard
3089 includegraphics{logo.eps}}}
3092 \begin_layout Standard
3094 (you may need to preface this with
3098 usepackage{graphics}
3100 if you don't include EPS files elsewhere in your document).
3103 \begin_layout Section
3104 Itemize Bullet Selection
3105 \begin_inset CommandInset label
3114 \begin_layout Standard
3120 \begin_layout Subsection
3124 \begin_layout Standard
3125 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3126 Using this dialog you can easily specify what bullet shape to use at each
3127 level of an itemized list.
3128 These settings are document-wide so you won't be able to specify different
3129 sets of bullets for different paragraphs
3133 \begin_layout Standard
3134 Well, actually you can but you'll have to do it by hand.
3142 \begin_layout Subsection
3146 \begin_layout Standard
3147 Open the dialog by selecting the
3152 ocument\SpecialChar \menuseparator
3159 menu item and then select the
3169 \begin_layout Standard
3170 The dialog provides you with a table of bullet shapes.
3171 A column of buttons on the left of the table provides access to the six
3172 different panels of bullet shapes.
3173 The row of buttons across the top is used to select which bullet depth
3175 A text entry under the table shows the currently selected bullet shape's
3176 LaTeX equivalent and this can be edited if desired.
3177 If you do modify the text you will also need to specify any needed packages
3178 in the LaTeX preamble.
3181 \begin_layout Standard
3182 The six panels are divided up by the packages they require.
3183 The following table shows the mappings from button name to LaTeX packages.
3186 \begin_layout Standard
3188 \begin_inset Tabular
3189 <lyxtabular version="3" rows="7" columns="2">
3191 <column alignment="center" valignment="top" leftline="true" width="0pt">
3192 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3193 <row topline="true" bottomline="true">
3194 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3197 \begin_layout Standard
3212 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3215 \begin_layout Standard
3231 <row topline="true">
3232 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3235 \begin_layout Standard
3250 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3253 \begin_layout Standard
3268 <row topline="true">
3269 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3272 \begin_layout Standard
3287 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3290 \begin_layout Standard
3306 <row topline="true">
3307 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3310 \begin_layout Standard
3325 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3328 \begin_layout Standard
3344 <row topline="true">
3345 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3348 \begin_layout Standard
3363 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3366 \begin_layout Standard
3382 <row topline="true">
3383 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3386 \begin_layout Standard
3401 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3404 \begin_layout Standard
3420 <row topline="true" bottomline="true">
3421 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3424 \begin_layout Standard
3439 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3442 \begin_layout Standard
3465 \begin_layout Standard
3466 LyX doesn't stop you using bullets from packages you don't have.
3467 If you get errors from LaTeX when you try to view or print the file then
3468 its likely you are missing a package.
3469 LyX doesn't restrict your use since you may be editing locally and exporting
3473 \begin_layout Subsection
3477 \begin_layout Standard
3478 Select which bullet depth you want to change then select the bullet shape
3480 Any changes will not be visible in LyX, but are visible when viewing the
3481 document using xdvi or ghostview.
3484 \begin_layout Standard
3485 You can reset a bullet shape to the default simply by clicking your right
3486 mouse button on the appropriate bullet depth button.
3489 \begin_layout Standard
3494 want to have multiple sets of paragraphs with different sets of bullets
3495 in each then you're going to have to get your hands dirty.
3496 The itemize bullet selection dialog can help though because it provides
3497 you with the LaTeX code for a wide range of bullet shapes.
3498 To make your own custom paragraphs you have the following options:
3501 \begin_layout Standard
3505 \begin_layout Standard
3521 \begin_layout Standard
3525 \begin_layout Standard
3547 \begin_layout Itemize
3548 Use the LaTeX command
3554 to specify a new bullet shape for a given depth.
3555 You'll also need to save the current bullet shape so you can restore it
3557 In this itemized list the following LaTeX code was used to change the bullet
3558 used for the first depth.
3590 Note that the itemize depth is specified in Roman numerals as part of the
3600 \begin_layout Itemize
3604 \begin_layout Standard
3617 Specify each individual entry by starting each item with the bullet shape
3618 enclosed in square brackets and set as TeX.
3619 For example, this item was started with
3632 \begin_layout Standard
3636 \begin_layout Standard
3652 \begin_layout Standard
3653 You'll also need to revert the labelitem back to its previous setting for
3654 the global bullet shape settings to remain in effect.
3655 The way used here was:
3668 \begin_layout Chapter
3669 Special Document Classes
3672 \begin_layout Section
3673 \begin_inset CommandInset label
3675 name "sec:AMS-LaTeX"
3682 \begin_layout Standard
3685 David Johnson; updated by Richard Heck
3688 \begin_layout Standard
3689 \begin_inset VSpace bigskip
3695 \begin_layout Standard
3697 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3698 papers to be submitted to American Mathematical Society publications.
3699 The layouts are not tailored to a specific journal, but easily can be.
3700 You should refer to the AMS documentation for specific instructions for
3701 each journal (usually it will entail only changing a single line in the
3703 That documentation is available on the Web at
3704 \begin_inset Flex URL
3707 \begin_layout Standard
3715 \begin_inset Flex URL
3718 \begin_layout Standard
3720 ftp://ftp.ams.org/pub/tex/amslatex/
3726 These layouts are appropriate, and useful, for any mathematical writing.
3730 \begin_layout Standard
3731 There are two basic AMS LaTeX layouts:
3734 \begin_layout Enumerate
3735 amsart: The standard AMS article format.
3738 \begin_layout Enumerate
3739 amsbook: the standard AMS book (really, monograph) format.
3743 \begin_layout Standard
3744 These layouts themselves contain only the minimum necessary to use the AMS
3746 They do not, in particular, contain any of the `theorem' environments used
3747 for setting theorems, lemmas, and the like.
3748 These are contained, instead, in the
3749 \begin_inset Flex CharStyle:Code
3752 \begin_layout Standard
3758 module, which you will need to load separately when you selected one of
3760 Less commonly used environments are in the
3761 \begin_inset Flex CharStyle:Code
3764 \begin_layout Standard
3765 Theorems (AMS-Extended)
3774 \begin_layout Standard
3775 By default, theorems and the like are numbered consecutively throughout
3776 the document, but this may be modified by loading the module
3777 \begin_inset Flex CharStyle:Code
3780 \begin_layout Standard
3781 Theorems (Order by Section)
3786 or, if you are using
3787 \begin_inset Flex CharStyle:Code
3790 \begin_layout Standard
3797 \begin_inset Flex CharStyle:Code
3800 \begin_layout Standard
3801 Theorems (Order by Chapter)
3807 These will number the results as
3808 \begin_inset Formula $n.m$
3811 , where the first number refers to the section (or chapter) and the second
3812 refers to the total number of results so far in that section (or chapter).
3813 Many environments are also available unnumbered.
3814 These are indicated by an asterisk at the end.
3815 If you happen to want
3819 unnumbered results, the the module
3820 \begin_inset Flex CharStyle:Code
3823 \begin_layout Standard
3829 provides that option.
3832 \begin_layout Standard
3833 Note that these modules do not
3837 to be used with the AMS classes.
3838 It is perfectly possible to use the
3839 \begin_inset Flex CharStyle:Code
3842 \begin_layout Standard
3848 module, and the others mentioned, with other classes, such as
3849 \begin_inset Flex CharStyle:Code
3852 \begin_layout Standard
3859 \begin_inset Flex CharStyle:Code
3862 \begin_layout Standard
3869 \begin_inset Flex CharStyle:Code
3872 \begin_layout Standard
3881 \begin_layout Subsection
3882 What these layouts provide
3885 \begin_layout Standard
3886 There is a long list of included environments provided by these layouts.
3887 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3888 variety of `theorem' environments.
3889 However, the AMS recommends the environments that are available in LyX.
3893 \begin_layout Standard
3894 The following environments---as well as the standard environments, such
3896 \begin_inset Flex CharStyle:Noun
3899 \begin_layout Standard
3906 \begin_inset Flex CharStyle:Noun
3909 \begin_layout Standard
3916 \begin_inset Flex CharStyle:Noun
3919 \begin_layout Standard
3926 \begin_inset Flex CharStyle:Noun
3929 \begin_layout Standard
3936 \begin_inset Flex CharStyle:Noun
3939 \begin_layout Standard
3946 \begin_inset Flex CharStyle:Code
3949 \begin_layout Standard
3956 \begin_inset Flex CharStyle:Code
3959 \begin_layout Standard
3968 \begin_layout Description
3969 Address This should be the author's permanent address.
3972 \begin_layout Description
3973 Current\InsetSpace ~
3974 Address This should be the author's temporary address at the time
3975 of submission, if different from the Address.
3978 \begin_layout Description
3979 Email Author's e-mail address
3982 \begin_layout Description
3983 URL Author's Web address, if desired.
3986 \begin_layout Description
3987 Keywords Key words or phrases used to identify specific topics discussed
3991 \begin_layout Description
3992 Subjectclass These refer to the AMS Subject Classifications, published and
3995 Mathematical Reviews
3998 These are also available online at the AMS cites listed above.
4001 \begin_layout Description
4005 \begin_layout Description
4009 \begin_layout Description
4013 \begin_layout Standard
4014 The following environments are provided by both the
4015 \begin_inset Flex CharStyle:Code
4018 \begin_layout Standard
4025 \begin_inset Flex CharStyle:Code
4028 \begin_layout Standard
4034 modules, in the latter case in both starred (unnumbered) and unstarred
4035 (numbered) versions.
4036 These same environments are provided only in the starred versions by the
4038 \begin_inset Flex CharStyle:Code
4041 \begin_layout Standard
4050 \begin_layout Theorem
4051 This is typically used for the statements of major results.
4055 \begin_layout Corollary*
4056 This is used for statements which follow fairly directly from previous statement
4058 Again, these can be major results.
4063 These are smaller results needed to prove other statements.
4066 \begin_layout Proposition
4067 These are less major results which (hopefully) add to the general theory
4071 \begin_layout Conjecture
4072 These are statements provided without justification, which the author does
4073 not know how to prove, but which seem to be true (to the author, at least).
4076 \begin_layout Definition*
4077 Guess what this is for.
4078 The font is different for this environment than for the previous ones.
4082 \begin_layout Example*
4083 Used for examples illustrating proven results.
4086 \begin_layout Problem
4087 It's not really known what this is for.
4088 You should figure it out.
4091 \begin_layout Exercise*
4092 Write a description for this one.
4095 \begin_layout Remark
4096 This environment is also a type of theorem, usually a lesser sort of observation.
4099 \begin_layout Claim*
4100 Often used in the course of giving a proof of a larger result.
4104 Generally, these are used to break up long arguments, using specific instances
4110 The numbering scheme for cases is on its own, not together with other numbered
4116 At the end of this environment , a QED symbol (usually a square, but it
4117 can vary with different styles) is placed.
4118 If you want to have other environments within this one---for example, Case
4119 environments---and have the QED symbol appear only after them, then the
4120 other environments need to be nested within the proof environment.
4122 \begin_inset CommandInset ref
4124 reference "sec:Nesting"
4132 for information on nesting.
4135 \begin_layout Standard
4136 And these are provided by
4137 \begin_inset Flex CharStyle:Code
4140 \begin_layout Standard
4141 Theorems (AMS-Extended)
4149 \begin_layout Criterion*
4150 A required condition.
4153 \begin_layout Algorithm*
4154 A general procedure to be used.
4157 \begin_layout Axiom*
4158 This is a property or statement taken as true within the system being discussed.
4161 \begin_layout Condition*
4162 Sometimes used to state a condition assumed within the present context of
4167 Similar to a Remark.
4170 \begin_layout Notation*
4171 Used for the explanation of, yes, notation.
4174 \begin_layout Summary
4175 Do we really need to tell you?
4178 \begin_layout Acknowledgement*
4182 \begin_layout Conclusion*
4183 Sometimes used at the end of a long train of argument.
4187 Used in a way similar to Proposition, though perhaps lower on the scale.
4190 \begin_layout Standard
4191 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4193 They need to be available on your system in order to use these environments.
4196 \begin_layout Section
4200 \begin_layout Standard
4205 can be used to type letters according to German conventions.
4206 A template file is included in
4208 .../lyx/share/templates
4210 for you to use as a starting point.
4213 \begin_layout Section
4217 \begin_layout Standard
4222 provides an alternative to the standard
4227 It provides similar functionality, but you might prefer this layout with
4228 sans serif sections, headings, and more.
4231 \begin_layout Section
4235 \begin_layout Standard
4241 \begin_layout Subsection
4245 \begin_layout Standard
4246 This section describes how LyX can be used to write articles for submission
4247 to the scientific journal
4249 Astronomy and Astrophysics
4251 (www.edpsciences.fr/aa/
4252 \begin_inset Flex URL
4255 \begin_layout Standard
4257 http://www.edpsciences.fr/aa/
4262 ) using Version 5.01 of the document class
4267 This package can be downloaded from the ftp site
4270 \begin_layout Standard
4271 \begin_inset VSpace medskip
4277 \begin_layout Standard
4279 \begin_inset Flex URL
4282 \begin_layout Standard
4284 ftp://ftp.edpsciences.org/pub/aa/readme.html
4292 \begin_layout Standard
4293 \begin_inset VSpace medskip
4299 \begin_layout Standard
4300 A manual comes together with that package, and this text is not meant to
4301 replace the original manual but merely a short guide how to realize the
4302 correct form of your paper.
4306 \begin_layout Standard
4307 Please note that the publisher of the journal was changed from Springer
4308 to EDP Sciences starting January 1, 2001.
4309 That change implicated also some slight changes of the style files, namely
4310 the removal of the thesaurus command.
4311 The LyX class aa supports the newest version of these style files, V 5.01.
4312 If you have an older version installed, please upgrade.
4313 For compatibility, the old (version 4) layout has been kept as
4318 Please refer to the comments in
4320 LyXDir/layouts/aapaper.layout
4325 \begin_layout Subsection
4329 \begin_layout Standard
4330 It is recommended you start from the example template distributed with LyX.
4331 If you are not using a template, note the following settings:
4334 \begin_layout Itemize
4344 ocument\SpecialChar \menuseparator
4351 dialog (OK, that one was obvious).
4354 \begin_layout Itemize
4355 Don't change the option
4365 The whole layout is done by the macros, you shouldn't change anything.
4368 \begin_layout Subsection
4372 \begin_layout Standard
4373 First thing to enter is the header information.
4374 It consists of seven entries, of which some are optional.
4378 \begin_layout Itemize
4386 \begin_layout Itemize
4394 \begin_layout Itemize
4402 \begin_layout Itemize
4410 \begin_layout Itemize
4415 : [optional] if more than one author: whom to contact for offprint requests.
4418 \begin_layout Itemize
4423 : [optional] mail address for contacts.
4426 \begin_layout Itemize
4434 Received: <date>; Accepted <date>
4437 \begin_layout Standard
4438 There is no need to issue the
4444 command, this is done automatically by LyX when the header is finished.
4445 Although the order of the single header entries doesn't matter it is advised
4446 to keep the above sequence, just to get the best optics and meets the layout
4447 of the real document.
4450 \begin_layout Standard
4451 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4456 \begin_layout Standard
4465 to state your present address, just use the standard footnote via
4470 nsert\SpecialChar \menuseparator
4478 LyX will automagically use the term
4487 \begin_layout Standard
4488 In addition to these topics, the macros use three additional LaTeX commands
4489 that have no counterpart in LyX:
4492 \begin_layout Itemize
4499 to separate different names for more than one author and institute, respectivel
4503 \begin_layout Itemize
4510 to mark corresponding author/institute pairs.
4511 The institutes are numbered sequentially as they appear in the
4515 field, so you have to put a marker to each author.
4518 \begin_layout Itemize
4525 to supply an email address for fast contact.
4528 \begin_layout Standard
4529 In all cases, the appropriate command has to be entered in LyX and marked
4535 \begin_layout Subsection
4539 \begin_layout Standard
4540 The abstract should immediately follow the header block.
4541 With version 5 the abstract environment was changed to a command, and there
4542 is now a resctriction to only one paragraph.
4543 In addition, it should contain an entry with the keywords.
4544 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4551 by hand and mark it as LaTeX code.
4552 Refer to the example paper.
4555 \begin_layout Subsection
4556 Supported environments
4559 \begin_layout Standard
4560 The A&A paper layout supports the following environments for structuring
4564 \begin_layout Itemize
4570 \begin_layout Itemize
4576 \begin_layout Itemize
4582 \begin_layout Itemize
4588 \begin_layout Itemize
4594 \begin_layout Itemize
4600 \begin_layout Itemize
4606 \begin_layout Itemize
4612 \begin_layout Itemize
4618 \begin_layout Itemize
4624 \begin_layout Itemize
4630 \begin_layout Itemize
4636 \begin_layout Subsection
4637 Commands not supported by LyX
4640 \begin_layout Standard
4641 Some commands are not yet supported by the
4646 Some have already been mentioned.
4647 For the sake of completeness, they are listed all together here:
4650 \begin_layout Itemize
4658 \begin_layout Itemize
4666 \begin_layout Itemize
4674 \begin_layout Itemize
4682 \begin_layout Itemize
4690 \begin_layout Itemize
4698 \begin_layout Itemize
4706 \begin_layout Itemize
4714 \begin_layout Standard
4715 If you want to use any of these commands, you have to enter them yourself.
4718 Do not forget to mark them as LaTeX code!
4721 \begin_layout Subsection
4722 Figure and Table Floats
4725 \begin_layout Standard
4726 LyX provides support for the necessary float environments
4728 figure, figure*, table
4734 , therefore we won't tell much about it here.
4741 Just remember that tables should be left-aligned.
4742 For that, select the table and change the alignment in
4747 dit\SpecialChar \menuseparator
4752 aragraph\InsetSpace ~
4756 \begin_layout Standard
4757 There is only one special thing: the figures with caption besides the figure.
4758 To create such a figure, you have to do the following:
4761 \begin_layout Enumerate
4762 Create a wide figure float:
4767 nsert\SpecialChar \menuseparator
4772 t\SpecialChar \menuseparator
4775 , then right click in the figure and select
4786 \begin_layout Enumerate
4787 Enter your caption text.
4790 \begin_layout Enumerate
4795 to move the cursor above the caption.
4798 \begin_layout Enumerate
4802 \begin_layout Enumerate
4803 Position the cursor behind the figure and insert a horizontal fill:
4808 nsert\SpecialChar \menuseparator
4816 \SpecialChar \menuseparator
4819 orizontal\InsetSpace ~
4825 \begin_layout Enumerate
4826 Switch to LaTeX mode:
4834 \begin_layout Enumerate
4844 Do not close the brace!
4847 \begin_layout Enumerate
4848 Position the cursor behind the caption text, switch to LaTeX mode and insert
4861 \begin_layout Standard
4862 Also, refer to the figures in the example paper.
4865 \begin_layout Subsection
4869 \begin_layout Standard
4870 For submission, the paper has to be formated in a special double-spacing
4872 For this purpose, you have to give the option
4876 to the documentclass.
4877 This must be done using the extra class options field in the
4882 ocument\SpecialChar \menuseparator
4890 Just enter the string
4897 \begin_layout Subsection
4901 \begin_layout Standard
4906 directory contains an example paper written with LyX.
4907 It is the example paper from the original macro package, translated to
4909 Use it for inspiration, and compare the original LaTeX code with LyX way
4913 \begin_layout Section
4917 \begin_layout Standard
4923 \begin_layout Subsection
4927 \begin_layout Standard
4928 AASTeX is a set of macros produced by the American Astronomical Society
4929 to facilitate electronic manuscript submission to the three journals they
4930 publish: the Astrophysical Journal (including the Letters and Supplement),
4931 the Astronomical Journal, and the Publications of the Astronomical Society
4933 LyX has proven to be an excellent tool for generating these documents,
4934 especially given its equation, citation, and figure handling capabilities.
4935 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4936 is the version described here, or higher.
4937 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4938 incompatible with LyX.
4939 The AASTeX package may be downloaded from the AASTeX Web site
4942 \begin_layout Standard
4943 \begin_inset VSpace medskip
4949 \begin_layout Standard
4951 \begin_inset Flex URL
4954 \begin_layout Standard
4956 http://www.journals.uchicago.edu/AAS/AASTeX
4964 \begin_layout Standard
4965 \begin_inset VSpace medskip
4971 \begin_layout Standard
4972 A complete user guide is contained in that package and you should familiarize
4973 yourself with it thoroughly before embarking on writing a paper in LyX.
4974 LyX will not reduce the need to figure out all the AASTeX commands, it
4975 will only reduce the drudgery of typing everything in.
4976 It is your responsibility to ensure that the final exported LaTeX document
4977 conforms completely to the requirements of the journal to which you are
4978 submitting your paper.
4981 \begin_layout Subsection
4982 Starting a New Paper
4985 \begin_layout Standard
4986 I strongly suggest that you start with the AASTeX template file.
4992 ile\SpecialChar \menuseparator
5002 , enter the new file name, then choose the
5007 This will show the most common fields found in a manuscript.
5008 Simply overwrite the existing text (including the brackets,
5012 ) with the correct information.
5013 Many of the AASTeX commands and environments can be implemented directly
5014 in LyX, but some cannot: most noticeably
5026 , which should stick out like a sore thumb if you actually just opened the
5028 For commands such as these, the LaTeX code must be entered directly and
5030 Such commands are referred to as ERT, or Evil Red Text.
5031 I tried to minimize the amount of ERT needed in an AASTeX document, but
5032 there is still a bit more required than any of us would like.
5035 \begin_layout Subsection
5036 Finishing Your Paper
5039 \begin_layout Standard
5040 When the paper is finished to your satisfaction and previews/prints correctly,
5042 \begin_inset Quotes eld
5046 \begin_inset Quotes erd
5049 actions which need to be done before you submit it to the journals.
5053 \begin_layout Enumerate
5054 Export your paper as a LaTeX file (
5059 ile\SpecialChar \menuseparator
5064 xport\SpecialChar \menuseparator
5075 \begin_layout Enumerate
5080 file with your favorite text editor
5084 \begin_layout Enumerate
5085 remove the comment lines before the
5094 \begin_layout Enumerate
5099 usepackage...{fontenc}
5101 line if it appears (usually just after
5116 \begin_layout Enumerate
5117 remove everything between (and including) the
5129 commands, except for any commands you specifically put into the LaTeX preamble
5130 (which should appear immediately after the
5131 \begin_inset Quotes eld
5134 User specified LaTeX commands
5135 \begin_inset Quotes erd
5146 \begin_layout Enumerate
5147 Run the resulting file through LaTeX to make sure it still processes correctly.
5150 \begin_layout Enumerate
5151 Reread the journal requirements to make sure your filenames and formats
5155 \begin_layout Enumerate
5159 \begin_layout Subsection
5160 Comments On Specific Commands
5163 \begin_layout Standard
5164 I will not describe the detailed usage of the individual AASTeX commands:
5165 the AASTeX User Guide (
5169 ) gives a good description of each.
5170 Thus it's probably easiest for me to go down the list as found in the guide
5171 and offer comments where necessary.
5172 So let's begin \SpecialChar \ldots{}
5176 \begin_layout Subsubsection
5177 Things that work as expected
5180 \begin_layout Standard
5184 \begin_layout Standard
5196 \begin_layout Standard
5197 Because they work as you might expect, I simply list them and the section
5298 begin{thebibliography}
5306 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5307 graphicx figure commands (2.14.1),
5331 (2.15.4, amongst other places),
5358 \begin_layout Standard
5359 The following style options also work correctly:
5380 Simply put them in the
5386 Layout\SpecialChar \menuseparator
5392 \begin_layout Standard
5396 \begin_layout Standard
5408 \begin_layout Subsubsection
5409 Things that work, but require more comment
5412 \begin_layout Standard
5413 The following items work, but require a little more discussion:
5416 \begin_layout Itemize
5417 These items are reserved for use by the journal editors, but you can put
5418 them into the LaTeX preamble if you feel compelled to do so:
5451 \begin_layout Itemize
5452 These items may be placed in the LaTeX preamble, and are included as blanks
5453 in the template file:
5474 \begin_layout Itemize
5481 (2.3) -- can only be used
5482 \begin_inset Quotes eld
5486 \begin_inset Quotes erd
5489 , not in the middle of a paragraph.
5490 Use ERT if you need to embed it.
5493 \begin_layout Itemize
5500 (2.3) -- will have extra {} after it.
5501 This should not cause an error.
5504 \begin_layout Itemize
5511 (2.6) -- can only be used
5512 \begin_inset Quotes eld
5516 \begin_inset Quotes erd
5519 , not in the middle of a paragraph.
5520 Use ERT if you need to embed it.
5523 \begin_layout Itemize
5530 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5534 \begin_layout Itemize
5541 (2.8) -- same as for
5548 \begin_layout Itemize
5555 (2.9) -- will have extra {} after it.
5556 This should not cause an error.
5559 \begin_layout Itemize
5566 (2.11) -- will have extra {} after it.
5567 This should not cause an error.
5570 \begin_layout Itemize
5577 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5578 at the beginning of the text and selecting
5580 Insert\SpecialChar \menuseparator
5585 \begin_inset Quotes eld
5589 \begin_inset Quotes erd
5592 inserts an optional argument of the type needed by
5599 Hopefully it will be renamed someday.
5602 \begin_layout Itemize
5615 for the catalog ID optional parameter
5618 \begin_layout Itemize
5631 for the catalog ID optional parameter
5634 \begin_layout Subsubsection
5635 Things not implemented, use ERT
5638 \begin_layout Standard
5642 \begin_layout Standard
5654 \begin_layout Standard
5677 setcounter{equation}
5679 (2.12), Journal name abbreviations (2.13.4),
5715 (2.15.4, insert it as the first element in the lefthand cell after where
5717 Don't use any of LyX's rules in the table),
5729 (2.15.5), much of Misc (2.17, except
5780 \begin_layout Standard
5784 \begin_layout Standard
5796 \begin_layout Subsubsection
5797 Things that cannot be implemented
5800 \begin_layout Standard
5801 \SpecialChar \ldots{}
5802 at least in any meaningful sort of way, so I suggest ignoring them.
5803 They are the references environment (2.13.3), and the deluxetable environment
5805 If you really, really need to use deluxetable, I suggest editing it in
5806 a separate file with a text editor, then using
5811 nsert\SpecialChar \menuseparator
5819 to include it in your LyX document.
5824 file to see an example of this.
5827 \begin_layout Subsection
5828 FAQs, Tips, Tricks, and Other Ruminations
5831 \begin_layout Subsubsection
5832 Getting LyX and AASTeX to cooperate
5835 \begin_layout Standard
5836 It can be a bit tricky to get LyX to recognize a new layout and document
5838 When all else fails, do this:
5841 \begin_layout Enumerate
5842 Make certain that LaTeX can find AASTeX.
5843 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5844 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5851 \begin_layout Enumerate
5863 \begin_layout Enumerate
5869 ools\SpecialChar \menuseparator
5876 in LyX, then restart LyX.
5879 \begin_layout Enumerate
5880 Open a regular new file, not from a template.
5881 Does AASTeX appear in the class list in
5886 ocument\SpecialChar \menuseparator
5896 \begin_layout Standard
5897 If you get a warning from an existing AASTeX document about not being able
5898 to find the AASTeX layout or a message about
5899 \begin_inset Quotes eld
5902 You should not mix title layouts with normal ones
5903 \begin_inset Quotes erd
5906 , things haven't been installed correctly.
5909 \begin_layout Subsubsection
5910 LaTeX error processing a table
5913 \begin_layout Standard
5914 LyX, by default, attempts to center the table caption/title.
5915 This seems to produce a bad interaction in AASTeX so you should click somewhere
5916 in the caption/title, then select
5921 dit\SpecialChar \menuseparator
5926 aragraph\InsetSpace ~
5941 This took care of it for me.
5944 \begin_layout Subsubsection
5946 \begin_inset CommandInset label
5955 \begin_layout Standard
5956 A couple of things: 1) I have noticed some funny spacing in the reference
5957 entries in the text.
5958 When you enter the bibliography item data, make sure their is
5962 space between the last author and the parenthesis setting off the year;
5965 e.\InsetSpace \thinspace{}
5978 2) Entering the references at all is not obvious.
5979 The easiest thing is to start typing your first reference at the end of
5980 the document, then mark it as type
5985 That will put a small gray box in front of what you just typed.
5986 Click on the box to fill in the rest of the information.
5987 For new references, go to the end of an existing reference and press return.
5988 That will create a new line with its own box, etc.
5991 \begin_layout Subsubsection
5995 \begin_layout Standard
5996 Even though AASTeX provides its own figure commands (
6002 , for example), I much prefer LaTeX's standard figure commands (with the
6011 commands as ERT into a Figure Float box if you desire, but I never
6012 have much luck getting the layout right.
6013 With the standard graphics, LyX will insert a
6017 usepackage{graphicx}
6019 command into the LaTeX preamble and handle the figures in the standard
6020 LaTeX2e way, interspersing the figures in the text.
6021 I believe ApJ accepts figures exactly this way now; AJ might still use
6023 \begin_inset Quotes eld
6026 stack everything at the end
6027 \begin_inset Quotes erd
6033 \begin_layout Subsubsection
6034 Things I could have done, but didn't
6037 \begin_layout Standard
6039 \begin_inset Quotes eld
6043 \begin_inset Quotes erd
6046 things I could have implemented, but chose not to.
6047 For instance, I saw no point in double-spacing the text in the LyX window,
6048 even though it is double-spaced in the paper manuscript.
6049 Also, I chose not to make separate layouts for the preprint and preprint2
6051 Since I assume you will spend most of your time in the plain manuscript
6052 mode anyway, I decided not to chew up more disk space with this.
6056 \begin_layout Subsection
6060 \begin_layout Standard
6061 Your mileage may vary.
6062 I've now had papers published by both ApJ and AJ that have had 98% of the
6063 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6065 I have had no trouble with the submission process, and I'm sure the journals
6066 were never aware that there might be a difference.
6067 So, go forth and publish!
6070 \begin_layout Section
6074 \begin_layout Standard
6077 Panayotis Papasotiriou
6080 \begin_layout Subsection
6084 \begin_layout Standard
6085 The ijmpc package is a set of macros that facilitates electronic manuscript
6088 International Journal of Modern Physics C
6091 Similarly, the ijmpd package is for creating manuscripts to be submitted
6094 International Journal of Modern Physics D
6097 Both journals are published by World Scientific.
6098 The corresponding document classes are named
6107 These files, together with instructions for the authors, can be downloaded
6109 \begin_inset Flex URL
6112 \begin_layout Standard
6114 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6120 \begin_inset Flex URL
6123 \begin_layout Standard
6125 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6131 Both packages are modified versions of the standard
6132 \begin_inset Quotes eld
6136 \begin_inset Quotes erd
6139 package, and they are almost (but not exactly) identical.
6140 Most of their features are supported by LyX.
6141 I have used LyX successfully to write articles submitted to both journals
6142 without any problem.
6145 \begin_layout Subsection
6149 \begin_layout Standard
6150 As usual, the easiest way to write a paper is to start with a template.
6156 ile\SpecialChar \menuseparator
6175 This will give an (almost) empty document that includes the most common
6176 fields found in a manuscript.
6177 Simply overwrite the existing text (including the brackets,
6182 You should keep in mind the following remarks.
6185 \begin_layout Enumerate
6186 LyX won't let you change the font size and the page style of the document,
6187 because such modifications are not allowed by both packages.
6190 \begin_layout Enumerate
6191 The language of the document should not be changed.
6192 Before previewing your paper, be sure that the babel package is not used.
6193 To do this, click on
6198 ools\SpecialChar \menuseparator
6216 checkbox in the language settings, and click on
6227 , if you wish to make this change permanent).
6230 \begin_layout Enumerate
6232 \begin_inset Quotes eld
6236 \begin_inset Quotes erd
6239 style must be used to define keywords.
6242 \begin_layout Enumerate
6243 The ijmpc package provides a style named
6244 \begin_inset Quotes eld
6247 Classification Codes
6248 \begin_inset Quotes erd
6251 , which can be used to define classification codes, such as PACS numbers.
6252 Note that this facility is not supported by the ijmpd package.
6255 \begin_layout Enumerate
6256 Several new environments are available:
6257 \begin_inset Quotes eld
6261 \begin_inset Quotes erd
6265 \begin_inset Quotes eld
6269 \begin_inset Quotes erd
6273 \begin_inset Quotes eld
6277 \begin_inset Quotes erd
6281 \begin_inset Quotes eld
6285 \begin_inset Quotes erd
6289 \begin_inset Quotes eld
6293 \begin_inset Quotes erd
6297 \begin_inset Quotes eld
6301 \begin_inset Quotes erd
6305 \begin_inset Quotes eld
6309 \begin_inset Quotes erd
6313 \begin_inset Quotes eld
6317 \begin_inset Quotes erd
6321 \begin_inset Quotes eld
6325 \begin_inset Quotes erd
6329 \begin_inset Quotes eld
6333 \begin_inset Quotes erd
6337 \begin_inset Quotes eld
6341 \begin_inset Quotes erd
6345 \begin_inset Quotes eld
6349 \begin_inset Quotes erd
6353 \begin_inset Quotes eld
6357 \begin_inset Quotes erd
6361 \begin_inset Quotes eld
6365 \begin_inset Quotes erd
6369 Their use is more or less obvious.
6370 LyX supports all these environments; it will use the proper label, text
6371 style, and numbering scheme for each of them.
6374 \begin_layout Enumerate
6375 Both packages use basic citations; the natbib package should not be used.
6376 In LyX, citation references are shown as usual; in the output, citations
6377 are shown as superscripts.
6378 If you want to use a citation as normal text, you should use the
6382 command, e.\InsetSpace \thinspace{}
6384 \begin_inset Quotes eld
6387 See Ref.\InsetSpace ~
6395 \begin_inset Quotes erd
6401 \begin_layout Enumerate
6403 \begin_inset Quotes eld
6407 \begin_inset Quotes erd
6410 section in both packages.
6411 To put acknowledgments, just use the
6412 \begin_inset Quotes eld
6416 \begin_inset Quotes erd
6422 \begin_layout Enumerate
6423 Appendices may be added to the paper,
6427 the Acknowledgments and
6432 LyX provides a special environment, called
6433 \begin_inset Quotes eld
6437 \begin_inset Quotes erd
6440 which marks the beginning of the appendices.
6441 This environment should be left blank; it just sends a LaTeX command, but
6442 nothing is really printed.
6444 \begin_inset Quotes eld
6448 \begin_inset Quotes erd
6451 is printed with blue letters, as a signal that all sections after that
6452 point are appendices.
6453 To write an appendix, use the
6454 \begin_inset Quotes eld
6458 \begin_inset Quotes erd
6462 LyX will number each appendix with capital letters, as required by both
6465 \begin_inset Quotes eld
6469 \begin_inset Quotes erd
6476 be present before the first appendix; if not, all appendices will be numbered
6477 as normal sections in the output.
6480 \begin_layout Enumerate
6481 The ijmpc and the ijmpd packages use the
6485 command to implement table captions.
6486 As a result, a table created by LyX is printed correctly, but its caption
6488 However, you can use some ERT to overpass this problem, so that captions
6489 are printed as expected.
6490 To do so, create a float table as usual, remove the caption, and replace
6501 (sic); you must also the ERT
6505 immediately after the tabular material.
6506 Study the example table included in the template files to see how this
6507 trick is implemented.
6508 Alternatively, If you need table captions, you should implement the whole
6513 file, then include this file to the LyX document (
6518 nsert\SpecialChar \menuseparator
6523 \SpecialChar \menuseparator
6532 Details on how to create a table float can be found in the files
6540 , included in the corresponding packages.
6543 \begin_layout Subsection
6544 Preparing a paper for submission
6547 \begin_layout Standard
6548 Before you submit your paper you must export the LyX document as a LaTeX
6554 ile\SpecialChar \menuseparator
6559 xport\SpecialChar \menuseparator
6574 \begin_layout Standard
6575 Actually you have the choice between LaTeX (plain) and pdflatex.
6576 If you intend to use pdflatex to prepare the paper, you should use the
6577 pdflatex option so that included graphics are converted to PDF format,
6578 ready for use by pdflatex.
6583 , then make the following changes to the resulting
6590 \begin_layout Enumerate
6591 Remove the comment lines before the
6600 \begin_layout Enumerate
6601 Remove everything between (and including) the
6613 commands, except for any commands you specifically put into the LaTeX preamble.
6616 \begin_layout Standard
6621 file should be saved and processed through LaTeX as many times as necessary.
6622 You may also want to check the resulting
6629 \begin_layout Subsection
6633 \begin_layout Standard
6634 The use of ERT is reduced to two commands, which must be placed at the top
6636 If you started writing your paper by using the
6644 template, the ERT needed is already in its place; you usually don't need
6646 You may only modify the first ERT to specify the information printed to
6647 the top of odd and even pages (authors' names and short paper's title,
6649 This ERT must have the form
6653 markboth{Authors' Names}{Short Paper's Title}
6658 \begin_layout Section
6662 \begin_layout Standard
6668 \begin_layout Subsection
6672 \begin_layout Standard
6673 The iopart package provides a document class to create electronic manuscript
6674 submission to the journals published by the Institute of Physics.
6675 Instructions for the authors how to create a paper using the iopart class
6676 can be downloaded together with the iopart package from the site
6677 \begin_inset Flex URL
6680 \begin_layout Standard
6682 ftp://ftp.iop.org/pub/journals/latex2e
6690 \begin_layout Subsection
6694 \begin_layout Standard
6695 The easiest way to write a paper is to start with the file
6699 that is available in LyX's examples files folder.
6700 Open this file, save it under a new name, and start writing.
6701 The example file explains how to use the special text environments.
6702 Here are the most important advices:
6705 \begin_layout Itemize
6706 To be able to compile your document to a PDF, PS, or DVI, assure that the
6709 Use AMS math package
6711 in the document settings under
6718 \begin_layout Itemize
6721 The title environment defines the kind of your paper.
6722 So use one of the following environments for the title:
6726 \begin_layout Itemize
6735 \begin_layout Itemize
6744 \begin_layout Itemize
6750 for a Topical review
6753 \begin_layout Itemize
6762 \begin_layout Itemize
6771 \begin_layout Itemize
6777 for a Paper (same as Title)
6780 \begin_layout Itemize
6786 for a Preliminary communication
6789 \begin_layout Itemize
6795 for a Rapid communication
6798 \begin_layout Itemize
6804 for a Letter to the editor
6808 \begin_layout Itemize
6811 All title environments except of
6815 can have an optional short title.
6818 \begin_layout Itemize
6819 There is a general title environment
6823 which is not directly supported by the LyX.
6824 This can be used as ERT when your document doesn't fit into one of the
6828 \begin_layout Standard
6829 For more informations like hints for special table and formula formatting,
6830 look at the IOP author guidelines.
6833 \begin_layout Section
6837 \begin_layout Standard
6840 Panayotis Papasotiriou
6843 \begin_layout Subsection
6847 \begin_layout Standard
6848 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6849 that facilitates electronic manuscript submission to the journals they
6851 Most known of them (at least in my domain of interest) are
6853 Astrophysics and Space Science
6859 , but there are many others (see a complete list at
6860 \begin_inset Flex URL
6863 \begin_layout Standard
6865 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6871 The Kluwer package may be downloaded from the site
6872 \begin_inset Flex URL
6875 \begin_layout Standard
6877 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6883 A complete user guide is contained in that package (but it can also be
6884 downloaded separately).
6887 \begin_layout Standard
6888 LyX supports many features of the package but not everything.
6889 However, the ERT needed is reduced to some
6890 \begin_inset Quotes eld
6894 \begin_inset Quotes erd
6897 commands of the package (see\InsetSpace ~
6899 \begin_inset CommandInset ref
6901 reference "subsec:kluwer_peculiarities"
6906 I have recently used LyX to write an article submitted to the
6908 Astrophysics and Space Science
6910 without any problem.
6913 \begin_layout Subsection
6917 \begin_layout Standard
6918 The easiest way to write a paper is to start with the Kluwer template file.
6921 File\SpecialChar \menuseparator
6936 This will give an (almost) empty document that includes the most common
6937 fields found in a manuscript and a short description of their use.
6938 As in most templates, simply overwrite the existing text (including the
6943 ) with the correct information.
6946 \begin_layout Subsection
6947 Preparing a paper for submission
6950 \begin_layout Standard
6951 As in the AASTeX package, before you submit your paper to a journal you
6953 \begin_inset Quotes eld
6957 \begin_inset Quotes erd
6963 \begin_layout Enumerate
6964 Export your paper as a LaTeX file.
6965 To do this, click on
6970 ile\SpecialChar \menuseparator
6975 xport\SpecialChar \menuseparator
6986 \begin_layout Enumerate
6991 file with a text editor and make the following changes
6995 \begin_layout Enumerate
6996 remove the comment lines before the
7005 \begin_layout Enumerate
7006 remove everything between (and including) the
7018 commands, except for any commands you specifically put into the LaTeX preamble.
7021 \begin_layout Standard
7030 \begin_layout Enumerate
7035 file through LaTeX as many times as necessary (usually up to three).
7038 \begin_layout Enumerate
7043 document using, e.\InsetSpace \thinspace{}
7048 , and check if everything is OK (it should, if you didn't make any mistake).
7051 \begin_layout Subsection
7052 \begin_inset Quotes eld
7056 \begin_inset Quotes erd
7059 of the Kluwer package
7060 \begin_inset CommandInset label
7062 name "subsec:kluwer_peculiarities"
7069 \begin_layout Standard
7070 The Kluwer package has the following
7071 \begin_inset Quotes eld
7075 \begin_inset Quotes erd
7081 \begin_layout Enumerate
7082 It is possible to write multiple articles in the same LaTeX file
7086 \begin_layout Standard
7087 I can't imagine any good reason to do this.
7093 Each article must be included in the environment
7094 \begin_inset Quotes eld
7098 \begin_inset Quotes erd
7102 Unfortunately, this environment cannot be omitted, even if you write just
7104 Therefore, each article starts with the command
7110 and, obviously, ends with the command
7117 Although this can be implemented in LyX, I didn't included it, since it
7118 looks ugly and can confuse the novice user.
7119 Therefore, you need to enter them directly and mark them as LaTeX code
7121 \begin_inset Quotes eld
7125 \begin_inset Quotes erd
7131 \begin_layout Enumerate
7132 Information given at the beginning of the article (i.e., title, subtitle,
7133 author, institution, running title, running author, abstract and keywords)
7134 must be included in an environment called
7135 \begin_inset Quotes eld
7139 \begin_inset Quotes erd
7143 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7160 \begin_layout Enumerate
7161 According to the user manual, the label of each bibliography item must be
7185 \begin_layout Standard
7190 template takes care of all these
7191 \begin_inset Quotes eld
7195 \begin_inset Quotes erd
7199 If you start a new paper using this template you don't need to do anything
7204 \begin_layout Enumerate
7205 don't delete the ERT included in the template, and
7208 \begin_layout Enumerate
7209 copy the example bibliography item included in the template and modify it
7210 as necessary to enter new bibliography items.
7213 \begin_layout Section
7217 \begin_layout Standard
7223 \begin_layout Subsection
7227 \begin_layout Standard
7228 The LyX document classes
7230 article (koma-script)
7234 report (koma-script)
7252 correspond to the LaTeX document classes
7268 , resp.\InsetSpace ~
7269 of the Koma-Script family.
7270 They are replacements for the standard document classes
7286 , resp., and fit better to European typography conventions in a number of
7290 \begin_layout Itemize
7291 Standard character size is 11pt in
7293 article (koma-script)
7297 report (koma-script)
7305 letter (koma-script)
7310 \begin_layout Itemize
7311 Headings, labels of the description environment, and a number of elements
7314 letter (koma-script)
7316 document class are set in a bold sans serif font.
7320 \begin_layout Standard
7321 There is a big difference between the bold sans serif old cm fonts and new
7322 ec fonts, especially in the appearance of headings.
7323 In comparison, the ec bold sans serif fonts look a bit thin.
7324 Here the LaTeX package
7332 helps to produce the
7333 \begin_inset Quotes eld
7337 \begin_inset Quotes erd
7340 appearance when using the ec fonts.
7345 The numbering of chapter headings is made in the same way as the numbering
7346 of section headings, that is without the extra line
7347 \begin_inset Quotes eld
7350 Chapter\SpecialChar \ldots{}
7352 \begin_inset Quotes erd
7356 In addition, the appearance of the headings can be modified by using a
7357 number of options (in LyX to be entered in the field
7371 ayout\SpecialChar \menuseparator
7379 A detailed German description of these options can be found in the Koma-Script
7387 \begin_layout Itemize
7388 The main means in the Koma-Script document classes to design the type area
7397 (in LyX to be entered in the extra class options field in the dialog
7402 ocument\SpecialChar \menuseparator
7410 They make a clearer modification of page margins possible as do the options
7416 ocument\SpecialChar \menuseparator
7424 A detailed German description of these and other type area options can
7425 be found in the Koma-Script documentation
7432 \begin_layout Itemize
7433 The LaTeX document classes of the Koma-Script family define a number of
7434 additional commands.
7435 Those part of it which makes sense in LyX is implemented in corresponding
7439 \begin_layout Standard
7440 A detailed German description of the LaTeX document classes of the Koma-Script
7441 family can be found in the Koma-Script documentation
7449 \begin_layout Standard
7450 There is an English translation
7454 , but it is not a complete one.
7459 The following sections describe only those aspects, which are relevant
7463 \begin_layout Subsection
7464 article (koma-script), report (koma-script), and book (koma-script)
7467 \begin_layout Standard
7468 The document classes
7470 article (koma-script)
7474 report (koma-script)
7484 are implemented in the layout files
7497 They contain all the paragraph types of the corresponding standard document
7510 , resp., partly modified, with the exception of the LyX specific
7514 -type, which is replaced by the new
7518 -type having the same functionality.
7523 -Type there is a number of new paragraph types added.
7530 letter (koma-script)
7535 \begin_layout Itemize
7544 : are equivalents to
7552 , resp., additionally inserting an entry in the table of contents.
7561 are not contained in
7563 article (koma-script)
7568 \begin_layout Itemize
7585 , resp., additionally clearing running heads.
7592 article (koma-script)
7598 \begin_layout Standard
7611 report (koma-script)
7613 , but since this is identical to
7617 , is has not been implemented in LyX.
7625 \begin_layout Itemize
7630 : generates a heading directly above the following paragraph in the standard
7631 character size without affecting the structure of the document.
7634 \begin_layout Itemize
7643 are special captions which respect the different space settings needed
7644 for captions placed above or below an element (if you follow strict typographic
7645 rules, you might want to place table captions always above the table).
7646 You can also use the class option
7663 You need at least Koma-Script version 2.8q to use this.
7666 \begin_layout Itemize
7671 : can be used to set a bonmot, e.
7675 \begin_layout Standard
7688 \begin_layout Standard
7697 at the beginning of a chapter.
7698 If you use the optional argument (
7703 nsert\SpecialChar \menuseparator
7707 ), you can insert the dictum's author there.
7708 Dictum and author are separated by a line.
7709 You need at least Koma-Script version 2.8q to use this.
7716 article (koma-script)
7721 \begin_layout Standard
7722 The following types, together with the standard types
7734 , form the title area of the document.
7735 They must be entered ahead of the first
7736 \begin_inset Quotes eld
7740 \begin_inset Quotes erd
7747 \begin_layout Standard
7748 The corresponding LaTeX commands must appear before the
7759 When such a type is used more than once, the latter usage overwrites the
7760 former one, that means, for every type only the latest usage is valid.
7761 The order of the different types however has, like
7773 , no effect on the appearance of the produced document.
7776 \begin_layout Itemize
7781 : produces a centered paragraph above the ordinary title (
7793 ) for the subject of the document.
7796 \begin_layout Itemize
7801 : produces a centered paragraph below the ordinary title (
7813 ) for the publishers' name.
7816 \begin_layout Itemize
7823 report (koma-script)
7829 produces a centered paragraph on its own page behind the title page, or
7832 article (koma-script)
7834 produces a centered paragraph below the ordinary title (
7853 \begin_layout Itemize
7858 : produces a left aligned paragraph above the ordinary title (
7874 ) for a document`s head.
7877 \begin_layout Itemize
7882 : produces in a double-sided print in
7884 report (koma-script)
7890 a left-aligned paragraph at the top of the title page`s back or has no
7891 effect in a single-sided print or in
7893 article (koma-script)
7898 \begin_layout Itemize
7903 : produces in a double-sided print in
7905 report (koma-script)
7911 a left-aligned paragraph at the bottom of the title page`s back or has
7912 no effect in a single-sided print or in
7914 article (koma-script)
7919 \begin_layout Itemize
7924 : produces a special
7925 \begin_inset Quotes eld
7929 \begin_inset Quotes erd
7932 page ahead of the actual document containing a paragraph without special
7936 \begin_layout Standard
7937 The layout files for the document classes
7939 article (koma-script)
7943 report (koma-script)
7954 This is thought of as a place to define your own types.
7959 in your personal layout directory and edit the file!
7962 \begin_layout Subsection
7963 letter (koma-script)
7966 \begin_layout Standard
7970 \begin_layout Standard
7982 \begin_layout Standard
7986 letter (koma-script)
7988 is implemented in the layout file
7993 It contains all the paragraph types of the corresponding standard document
7998 , partly modified, with the exception of the LyX specific types
8010 type, which is replaced by the new
8015 In addition, it contains, in contrast to the standard document class, the
8033 Furthermore, there are a number of new letter specific types.
8036 \begin_layout Standard
8040 \begin_layout Standard
8052 \begin_layout Standard
8053 The appearance of the letter produced by this document class can be controlled
8054 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8058 \begin_layout Standard
8059 For example, the standard appearance of the letter`s heading, consisting
8060 of name and address, is quite self-willed.
8062 \begin_inset Quotes eld
8066 \begin_inset Quotes erd
8069 heading is produced by the following LaTeX commands in the preamble:
8072 \begin_layout LyX-Code
8082 \begin_layout LyX-Code
8098 \begin_layout LyX-Code
8108 \begin_layout LyX-Code
8128 A detailed German description of such LaTeX commands can be found in the
8129 Koma-Script documentation
8134 With it, the letter's author can produce his personal letter layout.
8137 \begin_layout Standard
8146 define the beginning of the letter and must be used in every letter.
8147 To emphasize them in the LyX document class, they are marked with the letter
8156 , resp.\InsetSpace ~
8158 It is possible to write any number of letters in one file.
8163 type produces a new letter using the same addressee and a
8167 type produces a new addressee.
8184 are ordinary paragraph types and can also be used several times in one
8185 and the same letter.
8188 \begin_layout Itemize
8193 : produces a paragraph for the addressee and implicitly defines the beginning
8197 \begin_layout Itemize
8202 : produces a paragraph for the form of address and implicitly produces a
8206 \begin_layout Itemize
8211 : produces a paragraph for a close.
8214 \begin_layout Itemize
8219 : produces a paragraph for a postscript.
8222 \begin_layout Itemize
8227 : produces a paragraph for a distribution list.
8230 \begin_layout Itemize
8235 : produces a paragraph for enclosures.
8238 \begin_layout Standard
8279 are input types provided with a label to enter information, which will
8280 be processed by the document class.
8284 \begin_layout Standard
8285 It could be seen as a matter of inconsequence, that the types
8293 described above are not such input types as well.
8294 Because of the special meaning of those types, however, I have implemented
8295 them as ordinary paragraph types with a one letter mark in the left margin.
8296 Moreover, it would affect my feeling of symmetry, if the
8304 type had such a serious different appearance.
8309 The types must be used ahead of the corresponding
8316 \begin_layout Standard
8317 An implementation of these types in a WYSIWYG fashion does not seem to make
8318 sense, because the real appearance of the produced letter does not only
8319 depend on the usage of the particular type, but also on other factors.
8320 For example, a signature entered in the
8324 type will in the standard behavior appear in the produced letter only,
8325 when in the same letter also a
8330 The entered value of the
8334 type will in the standard behavior not appear in the produced letter at
8336 The possibility to design the letter`s heading freely is already indicated
8337 in a footnote above.
8340 \begin_layout Standard
8341 The input types can also be used as empty paragraphs.
8342 This makes sense e.\InsetSpace \thinspace{}
8353 type is not used at all, in the standard behavior the value of the
8357 type is used as signature, whereas if an empty
8361 type is used, no signature value is defined.
8364 \begin_layout Standard
8365 By using the input types it is possible to write a letter template, containing
8366 filled input types with your personal dates (name, address, etc.) and empty
8367 input types for other dates you want to enter.
8370 \begin_layout Itemize
8375 : sender's name, in the standard behavior appears as a centered paragraph
8376 in small caps in the letter`s heading.
8379 \begin_layout Itemize
8384 : sender's signature, in the standard behavior appears below the
8393 type is used, the value of the
8397 type appears instead.
8400 \begin_layout Itemize
8405 : sender's address, in the standard behavior appears in a centered paragraph
8406 in the letter`s heading below the sender's name.
8409 \begin_layout Itemize
8414 : sender's telephone number, in the standard behavior only sets the LaTeX
8424 \begin_layout Itemize
8429 : place of the letter`s making.
8432 \begin_layout Itemize
8437 : date of the letter`s making.
8446 , in the standard behavior, produce the place and the date in a right-aligned
8447 line below the addressee's field.
8452 type is used, neither place nor date appear, independent of the value of
8462 type is used, the date of the letter `s production is used.
8465 \begin_layout Itemize
8470 : sender`s back address, in the standard behavior appears above the addressee's
8471 field in a small sans serif font.
8474 \begin_layout Itemize
8479 : special mail information, in the standard behavior appears underlined
8480 above the addressee's field below the back address.
8483 \begin_layout Itemize
8488 : additional information, in the standard behavior appears on right side
8489 below the addressee`s field.
8492 \begin_layout Itemize
8497 : the letter's title, in the standard behavior appears in a big, bold, sans
8498 serif font above the subject.
8501 \begin_layout Itemize
8506 : the letter's subject, in the standard behavior appears in a bold font
8514 \begin_layout Standard
8535 produce a business letter like line above the
8539 line containing the fields
8540 \begin_inset Quotes eld
8544 \begin_inset Quotes erd
8548 \begin_inset Quotes eld
8552 \begin_inset Quotes erd
8556 \begin_inset Quotes eld
8560 \begin_inset Quotes erd
8564 \begin_inset Quotes eld
8568 \begin_inset Quotes erd
8572 \begin_inset Quotes eld
8576 \begin_inset Quotes erd
8580 \begin_inset Quotes eld
8584 \begin_inset Quotes erd
8588 For the date field, the value of the
8594 \begin_inset Quotes eld
8597 business letter types
8598 \begin_inset Quotes erd
8601 is used, the value of the
8605 type however does not appear, but only the LaTeX variable
8612 The ordinary output of place and date in a right-aligned line below the
8613 addressee`s field is suppressed.
8614 The types are implemented as input types provided with a label and must
8615 be used ahead of the corresponding
8622 \begin_layout Itemize
8630 \begin_layout Itemize
8638 \begin_layout Itemize
8646 \begin_layout Itemize
8654 \begin_layout Itemize
8662 \begin_layout Subsection
8663 The new letter class: letter (koma-script v.2)
8666 \begin_layout Standard
8669 Jürgen Spitzmüller
8672 \begin_layout Standard
8673 \begin_inset VSpace medskip
8679 \begin_layout Standard
8681 Koma-Script version 2.8 has introduced a new letter class
8685 which supersedes the now unsupported
8690 It has --- on the LaTeX side --- a completely new interface and is not
8691 compatible with the old class.
8692 Therefore, LyX supports both, though it is recommended to use the new class.
8695 \begin_layout Standard
8696 This class covers the same functionality as
8698 letter (koma-script),
8705 (receiver's address, same as
8722 will start a new letter (i.
8726 \begin_layout Standard
8739 \begin_layout Standard
8748 you can write several letters per document).
8749 New elements are sender's
8765 and the possibility to use a
8774 nsert\SpecialChar \menuseparator
8784 \begin_layout Standard
8785 The biggest improvement is, though, that the letter's layout is configurable
8786 at almost any needs.
8787 This can be done via the preamble or with a special style file (Letter
8788 Class Option, extension
8792 ), that will be read in as a class option.
8796 \begin_layout Standard
8797 The KOMA package comes with some default
8802 There is, for instance, a
8806 file that follows german typesetting rules, or a
8810 that provides the default layout of the old
8815 The latter can be loaded with the class option
8824 ayout\SpecialChar \menuseparator
8829 ocument\SpecialChar \menuseparator
8841 template that is included in LyX for examples.
8842 A detailed description is to be found in the Koma-Script documentation
8850 \begin_layout Subsection
8854 \begin_layout Standard
8855 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8859 \begin_layout Itemize
8860 The chapter number of a
8864 type appears on a line of its own above the chapter heading instead of
8865 appearing in the same line ahead of it.
8866 The cause for that is the LyX internal behavior for the labeltype
8873 \begin_layout Itemize
8874 The headings of the types
8883 \begin_inset Quotes eld
8887 \begin_inset Quotes erd
8890 LaTeX table of contents, but not in the LyX table of contents (
8895 ocument\SpecialChar \menuseparator
8907 \begin_layout Itemize
8912 document class appear in a skip separation mode, not indented.
8913 This is the standard behavior, no special LaTeX commands are needed for
8920 ocument\SpecialChar \menuseparator
8927 dialog the corresponding radio button indicates
8943 value always has the effect that extra LaTeX commands are inserted in the
8944 document to produce the gap, which is not what is wanted in this case.
8947 \begin_layout Section
8955 \begin_layout Standard
8961 \begin_layout Subsection
8965 \begin_layout Standard
8966 These are the layout files for some of the journal formats used by Springer
8967 Verlag and listed on
8968 \begin_inset Flex URL
8971 \begin_layout Standard
8973 http://www.springer.de/author/tex/help-journals.html
8978 , where you should also go to fetch the class files (yes, these are LaTeX2e
8980 It is a modular system: the things common to all journals are implemented
8985 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8990 for Journal of Geodesy) can include.
8993 \begin_layout Standard
8994 This means that implementing support for any other Springer journal on this
8995 list is as simple as writing your own
9003 file following the outline given in
9011 \begin_layout Standard
9012 It is reasonably well tested only for the Journal of Geodesy.
9021 come with the standard LyX distribution.
9022 Install the relevant class file (downloaded from Springer) in a proper
9023 directory, reconfigure LaTeX (in the teTeX case by running
9027 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9028 LyX and it should work.
9031 \begin_layout Subsection
9035 \begin_layout Standard
9036 A large number of theorem-like styles ---
9042 \SpecialChar \ldots{}
9048 \begin_layout Standard
9051 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9052 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9055 See the Springer class file documentation for details.
9058 \begin_layout Subsection
9062 \begin_layout Itemize
9074 \begin_layout Itemize
9077 Probability Theory and Related Fields
9083 --- Jean-Marc Lasgouttes
9086 \begin_layout Standard
9087 Add your own, it isn't so hard!
9090 \begin_layout Subsection
9094 \begin_layout Standard
9095 These files are partly based on the older
9099 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9105 layout, are now defunct.
9106 Jean-Marc Lasgouttes helped out big in making me find my way around the
9107 LyX layout file mechanism.
9110 \begin_layout Subsection
9114 \begin_layout Standard
9116 But probably less than in the old hacked-LaTeX
9123 \begin_layout Standard
9124 Limitations e.\InsetSpace \thinspace{}
9125 g.: does not display the number for theorem-like layouts, just
9129 \begin_layout Section
9137 \begin_layout Standard
9143 \begin_layout Subsection
9147 \begin_layout Standard
9148 These are the layout files for some of the journals of the American Geophysical
9150 It is assumed that you have both the AGU's own class files and AGUplus
9151 installed (everything to be found at
9152 \begin_inset Flex URL
9155 \begin_layout Standard
9157 ftp://ftp.agu.org/journals/latex/journals
9165 \begin_layout Subsection
9169 \begin_layout Standard
9179 They are still called this in the LyX GUI, though their LaTeX equivalents
9180 in the AGU classes are
9191 \begin_layout Standard
9192 Newly defined styles are
9229 These are mostly manuscript attributes and defined in the AGU class documentati
9233 \begin_layout Standard
9234 I suspect this is still badly incomplete.
9237 \begin_layout Subsection
9241 \begin_layout Standard
9258 \begin_layout Subsection
9262 \begin_layout Itemize
9265 Journal of Geophysical Research
9274 \begin_layout Standard
9275 Add your own, it isn't so hard! Look at the
9286 \begin_layout Subsection
9287 Bugs and things to remember
9290 \begin_layout Standard
9291 In order to use the new layouts, you must remember to do the following for
9295 \begin_layout Enumerate
9301 This can be done in the
9303 layout\SpecialChar \menuseparator
9308 document\SpecialChar \menuseparator
9312 (AGU articles are always in English, right? So
9319 \begin_layout Enumerate
9329 (Yes, this is a bug.)
9332 \begin_layout Enumerate
9333 Make sure you use the
9337 bibliography style, by entering
9341 into the second field of the BibTeX inset.
9342 None of the standard styles will do.
9345 \begin_layout Section
9353 \begin_layout Standard
9359 \begin_layout Subsection
9363 \begin_layout Standard
9364 This is the layout file for the European Geophysical Society journals.
9369 can be downloaded from the web site of the EGS under
9370 \begin_inset Flex URL
9373 \begin_layout Standard
9383 \begin_layout Subsection
9387 \begin_layout Standard
9390 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9398 The current layout file is unfortunately very unmodular and would benefit
9399 from using the various
9406 \begin_layout Section
9412 \begin_inset CommandInset label
9421 \begin_layout Standard
9429 \begin_layout Subsection
9433 \begin_layout Standard
9434 This section describes how to use LyX to make slides for overhead projectors.
9435 There are two document classes that can do this: the default slides class
9441 This section documents the former.
9444 \begin_layout Standard
9445 I'm going to say this again, nice and clear, so that there's no misunderstanding
9449 \begin_layout Standard
9450 \begin_inset VSpace bigskip
9456 \begin_layout Standard
9460 This section documents the class
9461 \begin_inset Quotes eld
9469 \begin_inset Quotes erd
9477 \begin_layout Standard
9478 \begin_inset VSpace bigskip
9484 \begin_layout Standard
9485 If you're looking for the documentation for
9486 \begin_inset Quotes eld
9494 \begin_inset Quotes erd
9497 , check out section\InsetSpace ~
9499 \begin_inset CommandInset ref
9501 reference "sec:foiltex"
9511 \begin_inset Quotes eld
9519 \begin_inset Quotes erd
9522 ] is actually somewhat better than the default
9530 \begin_layout Standard
9531 \SpecialChar \ldots{}
9532 or so I've been told repeatedly by its advocates.
9533 Having never used it, I have no idea if this claim is true or not.
9538 which this section documents.
9541 \begin_layout Standard
9542 This class is the LaTeX2e improvement of the old
9547 Every LaTeX2e distribution includes this class [which I'll just refer to
9549 \begin_inset Quotes eld
9557 \begin_inset Quotes erd
9560 from now on], so you're bound to have it.
9561 As I noted earlier, there are other classes, such as
9565 , which also produce slides for overhead projectors and do a better job
9567 However, there are some things which
9571 can do which the others can't, such as generate overlays.
9572 Read on to learn more!
9575 \begin_layout Subsection
9577 \begin_inset CommandInset label
9579 name "sec:slidesetup"
9586 \begin_layout Standard
9587 Obviously, to use this document class, you need to select
9588 \begin_inset Quotes eld
9596 \begin_inset Quotes erd
9599 from the class list in the
9604 ocument\SpecialChar \menuseparator
9612 There are some other special things you should know about this class:
9615 \begin_layout Itemize
9616 Don't bother changing the options
9621 They're not supported by the
9628 \begin_layout Itemize
9637 behaves a bit differently for this class.
9638 The possible choices and what they do are as follows:
9642 \begin_layout Description
9647 The final output contains page numbers in the lower right corner.
9650 \begin_layout Description
9659 , but also prints out any time markers you've put in.
9660 This is the default.
9663 \begin_layout Description
9668 The final output contains no page numbers, time markers, or alignment markers.
9672 \begin_layout Itemize
9677 class has an extra option:
9683 \begin_inset Quotes eld
9691 \begin_inset Quotes erd
9694 in the extra class options.
9698 \begin_layout Standard
9699 Using this options allows you to add time markers to
9704 See section\InsetSpace ~
9706 \begin_inset CommandInset ref
9708 reference "sec:slideNote"
9716 \begin_layout Standard
9717 You can also use the template file
9718 \begin_inset Quotes eld
9726 \begin_inset Quotes erd
9729 to automatically set up a document to use the
9738 ile\SpecialChar \menuseparator
9747 to open your new document].
9748 The template file also contains some examples of the special paragraph
9749 environments used by this class.
9750 I'll describe those next.
9753 \begin_layout Subsection
9754 Paragraph Environments
9757 \begin_layout Subsubsection
9758 Supported Environments
9761 \begin_layout Standard
9762 The first thing you'll notice when you start up a new
9766 document is the font size and type: it's the equivalent of the size
9767 \begin_inset Quotes eld
9775 \begin_inset Quotes erd
9784 This is also what's used in the output.
9786 \begin_inset Quotes eld
9790 \begin_inset Quotes erd
9793 to remind you that this is a slide.
9794 Your final slides will use a larger font; ergo, you'll have less space.
9795 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9798 \begin_layout Standard
9799 The next thing that becomes obvious is the changes to the paragraph environment
9800 pull-down box [at the far-left end of the toolbar].
9801 Most of the paragraph environments you're used to seeing are missing.
9802 There are also five new ones.
9807 class itself only supports certain paragraph environments:
9810 \begin_layout Itemize
9816 \begin_layout Itemize
9822 \begin_layout Itemize
9828 \begin_layout Itemize
9834 \begin_layout Itemize
9840 \begin_layout Itemize
9846 \begin_layout Itemize
9852 \begin_layout Itemize
9858 \begin_layout Itemize
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Standard
9877 All of the other standard environments, including the section-heading environmen
9878 ts, aren't used in the
9885 \begin_layout Standard
9886 On the other hand, you'll notice the following new environments:
9889 \begin_layout Itemize
9895 \begin_layout Itemize
9901 \begin_layout Itemize
9907 \begin_layout Itemize
9913 \begin_layout Itemize
9919 \begin_layout Standard
9920 These five are kind of quirky, due to a
9921 \begin_inset Quotes eld
9925 \begin_inset Quotes erd
9929 You see, LyX doesn't permit you to nest any other paragraph environment
9930 into an empty environment.
9931 Now, that's fine and dandy, but it means that you wouldn't be able to start
9932 a slide with anything except plain text.
9933 To deal with this, I've performed a little
9934 \begin_inset Quotes eld
9938 \begin_inset Quotes erd
9944 \begin_layout Subsubsection
9945 Quirks of the New Environments
9946 \begin_inset CommandInset label
9948 name "sec:slideQuirk"
9955 \begin_layout Standard
9956 All five of the new paragraph environments are somewhat quirky due to inherent
9957 limitiations in the current version of LyX.
9958 As I just mentioned, LyX forbids environments that begin with another environme
9960 To get around this, the
9964 environment isn't a paragraph environment as described in the
9972 \begin_layout Standard
9986 \begin_inset Quotes eld
9989 pseudo-environments.
9990 \begin_inset Quotes erd
9993 They look like a section heading or a
9994 \begin_inset Quotes eld
10002 \begin_inset Quotes erd
10005 but really begin a [and, if necessary, end the previous] paragraph environment.
10015 \begin_inset Quotes eld
10019 \begin_inset Quotes erd
10022 These two perform some action.
10025 \begin_layout Standard
10026 A common feature of all five environments,
10046 , is a rather long-ish label.
10047 The text following this label --- ordinarily the contents of the paragraph
10048 environment --- is utterly irrelevant for
10069 LyX completely ignores it.
10070 In fact, you can leave these five environments completely empty.
10074 \begin_layout Standard
10079 to put any text after the rather long-ish label, you might want to.
10080 This could be a short description of the contents of the
10085 In that case, enter in your descriptive comment and hit
10089 as you normally would.
10092 \begin_layout Standard
10093 If, on the other hand, you don't want to enter in any descriptive text,
10094 you'll hit another LyX quirk.
10095 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10096 environment until you put something in the old one.
10100 \begin_layout Itemize
10101 Start entering the text that will
10129 \begin_layout Itemize
10130 Now move to the beginning of that paragraph.
10134 \begin_layout Itemize
10143 \begin_layout Itemize
10144 Finally, change this new, empty paragraph to a
10168 \begin_layout Standard
10169 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10173 \begin_layout Subsection
10174 Making a Presentation with
10187 \begin_layout Subsubsection
10195 \begin_layout Standard
10196 If you're expecting this section to teach you how to actually make a presentatio
10197 n, you'll be sorely disappointed.
10198 Naturally, I'll describe all of the ways the
10202 class can assist you in preparing the materials for a presentation.
10203 Filling in the contents, however, is up to you.
10208 the LyX philosophy.]
10211 \begin_layout Standard
10216 environment [in the manner described in section\InsetSpace ~
10218 \begin_inset CommandInset ref
10220 reference "sec:slideQuirk"
10224 ] tells LyX to begin a new slide [duh].
10225 The label for this environment/
10226 \begin_inset Quotes erd
10230 \begin_inset Quotes erd
10234 \begin_inset Quotes eld
10238 \begin_inset Quotes erd
10241 in cool blue, followed by the label,
10242 \begin_inset Quotes eld
10246 \begin_inset Quotes erd
10250 Any text or paragraph environments that follow this one go on the new slide.
10254 \begin_layout Standard
10255 Slides are probably the only time you'll need to forcibly end pages in LyX
10256 (this can be specified in the
10261 In fact, you'll want to, once you finish entering the contents of one slide.
10262 If you've entered more text than can physically fit on a slide, the extra
10263 overflows onto a new slide.
10264 I don't recommend doing this, however, since the overflow slide won't have
10265 any page number on it.
10266 Furthermore, it may interfere with any
10270 you've made to accompany the oversized
10277 \begin_layout Standard
10286 environments work the same way as the
10291 They both create an
10292 \begin_inset Quotes eld
10296 \begin_inset Quotes erd
10299 followed by a label [
10300 \begin_inset Quotes eld
10304 \begin_inset Quotes erd
10308 \begin_inset Quotes eld
10312 \begin_inset Quotes erd
10316 The color is a stunning magenta instead of blue, and the
10317 \begin_inset Quotes eld
10321 \begin_inset Quotes erd
10324 will look different, in style and in length.
10325 The label fonts of all three also differ from one another.
10328 \begin_layout Standard
10333 , if the contents of a
10341 exceed the physical size of a slide or sheet of paper, the extra will overflow
10343 Again, you should avoid this.
10344 It defeats the whole purpose of
10355 \begin_layout Subsubsection
10365 \begin_layout Standard
10370 is a slide that sits atop another slide.
10371 Perhaps you wish to discuss a figure on the main
10375 before displaying the text associated with it.
10376 One way to accomplish this is tape a flap of dark paper over the part of
10381 you want to display later.
10382 This method fails, however, if you wish to overlap one graph with another,
10384 You would then have to fumble while speaking to align the two separate,
10389 s to align the two graphs.
10394 environment in both cases makes life much easier.
10397 \begin_layout Standard
10402 receives the page number of its
10403 \begin_inset Quotes eld
10407 \begin_inset Quotes erd
10415 \begin_inset Quotes eld
10423 \begin_inset Quotes erd
10430 \begin_layout Standard
10431 Presumably, mutliple
10436 \begin_inset Quotes eld
10444 \begin_inset Quotes erd
10448 \begin_inset Quotes eld
10456 \begin_inset Quotes erd
10460 \begin_inset Quotes eld
10468 \begin_inset Quotes erd
10471 , etc.\InsetSpace ~
10472 appended to the page number of the parent
10482 Clearly, you want the contents of both the
10490 to each fit on a single physical slide! You should probably consider an
10496 \begin_inset Quotes eld
10500 \begin_inset Quotes erd
10512 class provides a visual cue for this: the label at the start of an
10516 is shorter than that at the start of a
10521 Lastly, when you generate printable output, you'll find alignment markers
10522 in all four corners of both the
10526 page and its parent
10531 These will assist you in lining up the two physical slides.
10534 \begin_layout Standard
10535 The major problem in overlaying two slides is aligning the contents of the
10536 two transparencies.
10537 How much space should you leave for that graph on the second slide? Worse
10538 still, what if you want a graph and a sentence on second slide, but there
10539 is text on the main transparency that goes in between them? You could try
10540 and insert vertical space of the right size.
10541 The better way is to use
10552 \begin_layout Standard
10553 As their names imply,
10561 are two command-like paragraph environments that make all subsequent text
10562 invisible and visible, respectively.
10563 Note from section\InsetSpace ~
10565 \begin_inset CommandInset ref
10567 reference "sec:slideQuirk"
10571 that you don't place anything
10575 these two environments, however.
10580 , it inserts a centered, sky-blue label into the page reading
10581 \begin_inset Quotes eld
10584 <Invisible Text Follows>
10585 \begin_inset Quotes erd
10589 For paragraphs following this label, the parts of the
10597 ; it doesn't matter which] where they would be contain instead blank space.
10601 \begin_layout Standard
10606 , the corresponding centered label is
10607 \begin_inset Quotes eld
10610 <Visible Text Follows>
10611 \begin_inset Quotes erd
10615 Paragraphs following this label behave normally.
10616 Note that the beginning of a new
10628 automatically shuts off an
10633 It's therefore not necessary to use
10644 \begin_layout Standard
10645 By now, it should be obvious how to create overlay transparencies using
10646 the proper combination of
10665 \begin_layout Enumerate
10670 , including everything that will appear on it, whether on the main slide
10678 \begin_layout Enumerate
10679 Before each figure or paragraph that will appear only on the
10688 If necessary, insert a
10692 environment after the
10699 \begin_layout Enumerate
10704 immediately following the
10711 \begin_layout Enumerate
10712 Copy the contents of this
10723 \begin_layout Enumerate
10728 , change all of the
10739 \begin_layout Standard
10741 You've just made an
10748 \begin_layout Standard
10749 There's one problem with the way I've designed the LyX
10753 class: you can't make text in the middle of a paragraph invisible, nor
10754 make text in the middle of an invisible paragraph visible again.
10755 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10759 \begin_layout Standard
10760 The commands of interest are:
10763 \begin_layout Itemize
10768 invisible \SpecialChar \ldots{}
10772 \begin_layout Itemize
10777 visible \SpecialChar \ldots{}
10781 \begin_layout Standard
10782 \SpecialChar \ldots{}
10783 and need to be marked as TeX.
10785 \begin_inset Quotes eld
10789 \begin_inset Quotes erd
10792 you wish to change goes in between the brackets [and after the
10805 If you don't know how to mark text as TeX, see the appropriate section
10818 \begin_layout Subsubsection
10828 \begin_inset CommandInset label
10830 name "sec:slideNote"
10837 \begin_layout Standard
10846 is associated with a
10847 \begin_inset Quotes eld
10851 \begin_inset Quotes erd
10863 class provides visual cues.
10868 is shorter than that of a
10872 [yet longer than that of an
10876 ] and, like the label of an
10880 is shockingly magenta.
10881 Additionally, the printed
10885 has the page number of its
10886 \begin_inset Quotes eld
10890 \begin_inset Quotes erd
10898 \begin_inset Quotes eld
10906 \begin_inset Quotes erd
10910 \begin_inset Quotes eld
10918 \begin_inset Quotes erd
10922 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10934 You can have multiple
10938 s associated with a single
10950 , you'll probably want to break up long
10954 s so that they fit on a single sheet of paper.
10957 \begin_layout Standard
10962 is obvious: it contains anything additional you might want to say about
10968 It could also be used as a sheet of reminders for a particular
10973 In the case of the latter, you might want to make use of time markers.
10979 \begin_inset Quotes eld
10983 \begin_inset Quotes erd
10986 support for time markers, a
10991 So, you'll have to resort to using the LaTeX codes.
10994 \begin_layout Standard
10995 To use time markers, you'll need to specify the extra class option
10996 \begin_inset Quotes eld
11004 \begin_inset Quotes erd
11007 [see section\InsetSpace ~
11009 \begin_inset CommandInset ref
11011 reference "sec:slidesetup"
11016 This option turns on timing marks, which will appear in the lower-left-hand
11022 To set what appears in the time marker, you use the LaTeX commands
11023 \begin_inset Quotes eld
11033 \begin_inset Quotes erd
11037 \begin_inset Quotes eld
11047 \begin_inset Quotes erd
11051 The arguments of both commands are time measured in seconds.
11053 \begin_inset Quotes eld
11063 \begin_inset Quotes erd
11066 sets the time marker to a given time.
11068 \begin_inset Quotes eld
11078 \begin_inset Quotes erd
11081 increments the time marker by the specified amount.
11082 Using time markers and
11086 s in this fashion, you can remind yourself how much time to spend on a particula
11094 \begin_layout Standard
11095 There's one last feature to describe.
11096 Clearly, you'd like to print out all of your
11104 s on transparencies while printing all of your
11121 with which it is associated.
11122 What's a person to do?
11125 \begin_layout Standard
11126 Luckily, there are two LaTeX commands that allow you to select what to print
11128 Both must be placed into the preamble of your document.
11130 \begin_inset Quotes eld
11142 \begin_inset Quotes erd
11145 will cause the output to contain only the
11154 Correspondingly, the command
11155 \begin_inset Quotes eld
11167 \begin_inset Quotes erd
11170 prevents the output of anything but
11175 I'd advise placing both commands in the preamble and initially comment
11177 You can then preview your entire presentation as you write.
11178 When you're done writing, you can then uncomment one of the two to select
11179 what you want to print.
11180 I like to uncomment
11181 \begin_inset Quotes eld
11193 \begin_inset Quotes erd
11196 , print to a file with
11197 \begin_inset Quotes eld
11205 \begin_inset Quotes erd
11208 in its name, comment it back out, then uncomment
11209 \begin_inset Quotes eld
11221 \begin_inset Quotes erd
11225 \begin_inset Quotes eld
11233 \begin_inset Quotes erd
11237 I can then send either file to a printer, loading transparencies or plain
11238 paper as appropriate.
11241 \begin_layout Standard
11242 You can also provide other arguments to the
11243 \begin_inset Quotes eld
11253 \begin_inset Quotes erd
11257 \begin_inset Quotes eld
11267 \begin_inset Quotes erd
11271 See a good LaTeX book for details.
11274 \begin_layout Subsection
11279 Class Template File
11282 \begin_layout Standard
11283 I have also provided a template file,
11284 \begin_inset Quotes eld
11292 \begin_inset Quotes erd
11300 To use it, begin your new presentation with
11305 ile\SpecialChar \menuseparator
11315 Your new LyX presentation file will contain an example
11336 additionally contain an example of the use of
11345 Lastly, the preamble will contain:
11348 \begin_layout LyX-Code
11349 % Uncomment to print out only slides and overlays
11352 \begin_layout LyX-Code
11356 \begin_layout LyX-Code
11366 \begin_layout LyX-Code
11367 % Uncomment to print out only notes
11370 \begin_layout LyX-Code
11374 \begin_layout LyX-Code
11382 \begin_layout Standard
11383 One final thing: I created this class to support the LaTeX2e
11384 \begin_inset Quotes eld
11392 \begin_inset Quotes erd
11395 class, one of the built-in LaTeX2e classes.
11396 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11397 built-in slide class.
11398 It's here if you want it or need it.
11399 There exist other LaTeX2e classes for creating presentations, such as the
11404 class [see section\InsetSpace ~
11406 \begin_inset CommandInset ref
11408 reference "sec:foiltex"
11413 \begin_inset Quotes eld
11421 \begin_inset Quotes erd
11424 package [present on some TeX distributions].
11425 The latter is not yet supported under LyX.
11429 \begin_layout Standard
11430 Perhaps you can take on the task\SpecialChar \ldots{}
11436 I know nothing about these other classes.
11437 Try them out to see what sort of alternative they provide.
11440 \begin_layout Section
11449 \begin_inset CommandInset label
11458 \begin_layout Standard
11464 \begin_layout Subsection
11468 \begin_layout Standard
11469 This section describes how to use LyX to make slides for overhead projectors.
11470 There are two document classes that can do this: the default slides class
11476 This section documents the latter.
11479 \begin_layout Standard
11480 I'm going to say this again, nice and clear, so that there's no misunderstanding
11484 \begin_layout Standard
11485 \begin_inset VSpace bigskip
11491 \begin_layout Standard
11495 This section documents the class
11496 \begin_inset Quotes eld
11504 \begin_inset Quotes erd
11512 \begin_layout Standard
11513 \begin_inset VSpace bigskip
11519 \begin_layout Standard
11520 If you're looking for the documentation for
11521 \begin_inset Quotes eld
11529 \begin_inset Quotes erd
11532 , check out section\InsetSpace ~
11534 \begin_inset CommandInset ref
11536 reference "sec:slitex"
11541 If your machine doesn't have the
11546 \begin_inset Quotes eld
11554 \begin_inset Quotes erd
11557 ] installed, you'll probably have to use the default
11561 class, which isn't quite as good as
11566 \begin_layout Standard
11571 class is designed for use with version 2.1 of the
11575 LaTeX class file which is now an integral part of LaTeX2e.
11578 \begin_layout Subsection
11582 \begin_layout Standard
11583 Obviously, to use this document class, you need to select
11584 \begin_inset Quotes eld
11592 \begin_inset Quotes erd
11604 Document\InsetSpace ~
11608 There are some settings in the
11610 Document\InsetSpace ~
11613 dialog that you should know about that are specific to this class:
11616 \begin_layout Itemize
11617 Don't change the options
11627 Document\InsetSpace ~
11631 They're ignored by the
11638 \begin_layout Itemize
11639 The default font size is 20pt with the other options being 17pt, 25pt and
11643 \begin_layout Itemize
11644 The default font is
11652 but all math equations are still typeset in the usual roman font.
11655 \begin_layout Itemize
11660 TeX supports A4 and Letter paper sizes as well as a special size for working
11662 It doesn't support A5, B5, legal or executive paper sizes.
11665 \begin_layout Itemize
11666 Don't bother changing the
11670 settings because they are ignored anyway.
11671 All floats appear where they are defined in the text.
11674 \begin_layout Itemize
11682 setting behaves a bit differently for this class.
11687 TeX provides extensive footer and header capabilities including a user-defined
11689 See section\InsetSpace ~
11691 \begin_inset CommandInset ref
11693 reference "sec:foilfoot"
11698 The title page is treated differently to all other pages in the document
11707 has the logo centered at the bottom of the page (if one is defined).
11708 The possible page style choices and what they do are as follows:
11713 \labelwidthstring MMMMMMM
11720 The final output contains no page numbers, or other headers or footers
11721 (except footnotes of course).
11726 \labelwidthstring MMMMMMM
11733 The final output contains page numbers centered at the bottom of the page.
11734 No other headings or footers (other than footnotes).
11738 \labelwidthstring MMMMMMM
11743 Page numbers in lower right corner.
11744 Additional headers and footers are also shown.
11745 This is also the default.
11749 \labelwidthstring MMMMMMM
11754 Gives you access to the
11758 package although its use with
11762 TeX is discouraged by the writer of the
11766 TeX package because of some potential page layout clashes.
11770 \begin_layout Subsubsection
11774 \begin_layout Standard
11775 The following options may be used in the extra class options in the
11780 ocument\SpecialChar \menuseparator
11791 \labelwidthstring MMMMMMx
11796 This sets up the page layout for 7.33in by 11in paper, which is about the
11797 same aspect ratio as a 35mm slide, making it a bit easier to work with
11802 \labelwidthstring MMMMMMx
11807 Places a rule across the page below the header on every page except the
11812 \labelwidthstring MMMMMMx
11817 Places a rule across the page above the footer on every page except the
11822 \labelwidthstring MMMMMMx
11827 This is automatically set each time you create a new
11836 TeX to use the dvips driver to rotate those pages that are set as landscape
11841 \labelwidthstring MMMMMMx
11846 Simply changes the page dimensions to those of a landscape page but doesn't
11848 Thus if you use this option you need to use an external program to rotate
11849 each page or feed your paper through your printer as landscape.
11850 Note that this option effectively reverses the roles of the
11858 environments (don't worry these are described in the next section).
11862 \labelwidthstring MMMMMMx
11867 Equation numbers on the left.
11871 \labelwidthstring MMMMMMx
11876 Flush-left equations.
11879 \begin_layout Subsection
11880 Supported Environments
11883 \begin_layout Standard
11884 Most of the environments commonly supported in other classes are also supported
11890 There are several additional environments provided by
11894 TeX as well as a couple added by LyX.
11895 The following environments are shared with other classes:
11898 \begin_layout Standard
11902 \begin_layout Standard
11906 begin{multicols}{2}
11914 \begin_layout Itemize
11920 \begin_layout Itemize
11926 \begin_layout Itemize
11932 \begin_layout Itemize
11938 \begin_layout Itemize
11944 \begin_layout Itemize
11950 \begin_layout Itemize
11956 \begin_layout Itemize
11962 \begin_layout Itemize
11968 \begin_layout Itemize
11974 \begin_layout Itemize
11980 \begin_layout Itemize
11986 \begin_layout Itemize
11992 \begin_layout Itemize
11998 \begin_layout Itemize
12004 \begin_layout Itemize
12010 \begin_layout Itemize
12016 \begin_layout Itemize
12022 \begin_layout Standard
12026 \begin_layout Standard
12038 \begin_layout Standard
12039 That is, all the major environments apart from the sectioning environments.
12040 Since foils are essentially self-contained sections, with a title and body,
12045 TeX provides specific commands for starting new foils and these are:
12048 \begin_layout Itemize
12054 \begin_layout Itemize
12060 \begin_layout Standard
12061 LyX also provides slightly modified versions of these two environments called:
12064 \begin_layout Itemize
12070 \begin_layout Itemize
12073 ShortRotatefoilhead
12076 \begin_layout Standard
12077 and the differences will be explained in the next section.
12080 \begin_layout Standard
12081 Since foils are often used in presenting ideas or new theorems and such
12086 TeX also provides a comprehensive box of goodies for presenting them:
12089 \begin_layout Standard
12093 \begin_layout Standard
12097 begin{multicols}{2}
12105 \begin_layout Itemize
12111 \begin_layout Itemize
12117 \begin_layout Itemize
12123 \begin_layout Itemize
12129 \begin_layout Itemize
12135 \begin_layout Itemize
12141 \begin_layout Itemize
12147 \begin_layout Itemize
12153 \begin_layout Itemize
12159 \begin_layout Itemize
12165 \begin_layout Itemize
12171 \begin_layout Standard
12175 \begin_layout Standard
12187 \begin_layout Standard
12188 The starred versions are unnumbered while the unstarred versions are numbered.
12189 There are also two list environments added by LyX and these are:
12192 \begin_layout Itemize
12198 \begin_layout Itemize
12204 \begin_layout Standard
12209 TeX provides some powerful header and footer capabilities that are best
12210 set in the preamble although they may be set at any point in a document.
12211 If you want to change these settings in your document the best place to
12212 do so is at the very top of a foil,
12217 straight after the foilhead.
12220 \begin_layout Standard
12221 For this purpose, the following command styles are provided [
12228 \begin_layout Standard
12232 \begin_layout Standard
12236 begin{multicols}{2}
12244 \begin_layout Itemize
12251 \begin_layout Itemize
12257 \begin_layout Itemize
12264 \begin_layout Itemize
12271 \begin_layout Itemize
12279 \begin_layout Standard
12285 \begin_layout Standard
12289 \begin_layout Standard
12301 \begin_layout Standard
12302 There are also a few commands provided by
12306 TeX that aren't directly supported by LyX but I'll tell you what they do
12307 and how to use them in section\InsetSpace ~
12309 \begin_inset CommandInset ref
12311 reference "sec:unsuppfoils"
12318 \begin_layout Subsection
12319 Building a Set of Foils
12322 \begin_layout Standard
12323 This section will give a simple introduction to using the different environments
12324 to build a set of foils.
12325 If you want to see an example set of foils take a look at the
12329 file accessible from the
12334 ile\SpecialChar \menuseparator
12339 pen\SpecialChar \ldots{}
12350 \begin_layout Subsubsection
12351 Give It a Title Page
12354 \begin_layout Standard
12355 Unlike other classes that provide
12375 creates the title on a page of its own.
12376 If you leave out the
12380 environment LaTeX will substitute the current date (every time you regenerate
12384 \begin_layout Subsubsection
12388 \begin_layout Standard
12389 As I mentioned earlier, there are four ways of starting a new foil.
12390 For portrait foils you should use
12399 The difference between these two environments is the amount of space between
12400 the title of the foil (the foilhead) and the body of the foil.
12403 \begin_layout Standard
12404 Landscape foils are generated using the
12410 ShortRotatefoilhead
12413 Again the only difference is the spacing between foilhead and body.
12414 Both of the short versions have 0.5 inches less separation between the foilhead
12419 \begin_layout Standard
12420 One problem with the support for landscape foils is the requirement that
12421 you have to use the
12425 driver to generate the PostScript output otherwise the foils won't be rotated.
12426 It is possible to get landscape foils even if you haven't got the
12430 driver provided you can feed your foils sideways through your printer ;-)
12433 \begin_layout Subsubsection
12434 Theorems, Lemmas, Proofs and more
12437 \begin_layout Standard
12438 Due to a small bug in LyX you can't have two of the same type of these environme
12439 nts directly following each other.
12440 They must be separated by something.
12441 If you try, you will just be extending the previous environment as if you
12442 had merged the two environments together.
12443 So, how do you get around this problem? The simplest option is to insert
12444 some text between the two environments or add a
12448 environment between the two with just a
12449 \begin_inset Quotes eld
12457 \begin_inset Quotes erd
12461 This will force LyX to produce two separate environments and hence the
12462 correct LaTeX output.
12463 An example is provided in the example file included with the LyX distribution.
12464 Remember, this problem only occurs if you are trying to place two of the
12465 same type of theorem-like environments one directly after the other.
12468 \begin_layout Subsubsection
12472 \begin_layout Standard
12473 You get all the commonly supported list styles found in other classes as
12474 well as two new ones.
12475 I'll only describe the new ones here.
12476 If you want to find out more about the other list environments check out
12482 If you intend to use itemized lists you might also want to read about the
12485 Itemize\InsetSpace ~
12486 Bullet\InsetSpace ~
12489 dialog described above in section\InsetSpace ~
12491 \begin_inset CommandInset ref
12493 reference "sec:bullet"
12500 \begin_layout Standard
12501 The two new list styles,
12509 , are designed to make it easier for you to create lists of do's and don'ts
12510 or right and wrong by providing dedicated environments that use a tick
12511 or a cross as the label of the list.
12512 These lists are in fact dedicated variants of the
12517 They do however require that you have the
12521 packages installed.
12524 \begin_layout Subsubsection
12528 \begin_layout Standard
12533 TeX redefines the floating tables and figures so that they appear exactly
12534 where they are in the text rather than pushing them to the top of the page
12535 or to some user specified location.
12536 In fact if you change the float placement settings they are simply ignored.
12539 \begin_layout Subsubsection
12540 Page Headers and Footers
12541 \begin_inset CommandInset label
12543 name "sec:foilfoot"
12550 \begin_layout Standard
12560 are two commands used to control the left-footer text string.
12561 The first is meant to allow you to include a graphic logo on your foils
12563 \begin_inset Quotes eld
12571 \begin_inset Quotes erd
12575 While the second is meant to provide a classification for the audience,
12578 e.\InsetSpace \thinspace{}
12583 It is empty by default.
12586 \begin_layout Standard
12587 The remaining page corners can be filled by
12592 (which defaults to page numbers),
12605 \begin_layout Subsection
12611 \begin_inset CommandInset label
12613 name "sec:unsuppfoils"
12620 \begin_layout Standard
12621 All the commands mentioned below need to be set in a
12629 within another environment.
12632 \begin_layout Subsubsection
12636 \begin_layout Standard
12637 All lengths are adjusted using the
12660 should be replaced by the name given to the length you want to change and
12665 is the length value.
12666 All lengths should be specified in units of length such as inches (
12678 ) or relative to some document or font-based length such as
12688 \begin_layout Standard
12689 It's possible to change the spacing between a foilhead and the body of the
12690 foil by adjusting the length specified by
12697 For example, to make
12701 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12708 foilheadskip}{-0.5in}
12711 \begin_layout Standard
12712 The spacings around floats can be adjusted by setting these lengths:
12716 \labelwidthstring MMMMMMMMMMM
12723 Separation between the text and the top of the float
12727 \labelwidthstring MMMMMMMMMMM
12734 Separation between the float and the caption
12738 \labelwidthstring MMMMMMMMMMM
12745 Separation between the caption and the following text
12749 \labelwidthstring MMMMMMMMMMM
12756 You can make the captions narrower than the surrounding text by adjusting
12758 Best done relative to
12767 \begin_layout Standard
12768 There are also several title page related lengths that you may find useful
12769 if you have a long title or several authors:
12773 \labelwidthstring MMMMMMMMMMM
12780 Separation from headers to
12786 \labelwidthstring MMMMMMMMMMM
12805 \labelwidthstring MMMMMMMMMMM
12820 \labelwidthstring MMMMMMMMMMM
12837 \labelwidthstring MMMMMMMMMMM
12853 \begin_layout Standard
12854 The last length related command affects all the list environments.
12865 a list environment then all the vertical spacing between the list items
12867 Note that this is a command not a length so it doesn't require
12873 like the stuff mentioned above.
12876 \begin_layout Subsubsection
12877 Headers and Footers
12880 \begin_layout Standard
12893 commands control whether the logo in the
12897 definition appear on a given page.
12904 in the preamble then none of the foils will have the logo on them.
12905 If you don't want the logo on a particular page place the
12911 directly after the foilhead of that page and the
12917 directly after the next foilhead.
12920 \begin_layout Standard
12921 If you decide to use the
12925 page style setting in the
12927 Document\InsetSpace ~
12930 dialog you should probably add
12940 to your preamble so headers and footers on landscape pages are correctly
12941 placed when rotated.
12942 This is due to some clashes between the page layouts provided by the
12953 \begin_layout Section
12954 Latex8 (IEEE Conference Papers)
12957 \begin_layout Standard
12963 \begin_layout Subsection
12967 \begin_layout Standard
12968 Since this class is specifically for writing submissions to IEEE sponsored
12969 conferences I strongly recommend that you get a copy of their Authors Kit.
12974 package and associated bibliography style file is included in the kit.
12975 The Authors Kit is usually sent out by email once your initial submission
12977 There is a lot of useful information in the Authors Kit explaining formatting
12978 restrictions and so on and I will assume you have read this since that
12979 means I don't have to repeat it all here.
12982 \begin_layout Subsection
12986 \begin_layout Standard
12987 [AR\SpecialChar \@.
12991 \begin_layout Subsection
12992 Supported Environments
12995 \begin_layout Itemize
13001 \begin_layout Itemize
13007 \begin_layout Itemize
13013 \begin_layout Itemize
13019 \begin_layout Itemize
13025 \begin_layout Itemize
13031 \begin_layout Itemize
13037 \begin_layout Itemize
13043 \begin_layout Itemize
13049 \begin_layout Subsection
13050 Differences Between Screen and Paper
13053 \begin_layout Standard
13054 There are slight differences in appearance mainly with the presentation
13055 of section counters.
13056 On screen the trailing period of the section counter is missing but it
13057 will appear in the output so don't let this worry you.
13060 \begin_layout Section
13061 Hollywood (Hollywood spec scripts)
13064 \begin_layout Standard
13070 \begin_layout Subsection
13074 \begin_layout Standard
13075 Getting the format of a Hollywood script right is a
13076 \begin_inset Quotes eld
13080 \begin_inset Quotes erd
13083 It is designed to make the readers focus on content and to be easy and
13084 familiar for the actors to read.
13085 Each page of a script should be one minute of film.
13086 Nothing goes in a script that you cannot see or hear on screen.
13087 The courier 12 pt font should be used throughout.
13091 \begin_layout Subsection
13095 \begin_layout Standard
13096 Speakers' lines should NEVER break in mid-sentence.
13097 If a speaker's lines continue over a page break, repeat the
13101 title followed by (Cont'd).
13104 \begin_layout Subsection
13108 \begin_layout Standard
13113 names as labels then cross-reference the label to insert the name.
13114 The cross-reference dialog will show the current cast of characters.
13115 You can use this to insert the speaker name in narratives also.
13118 \begin_layout Subsection
13119 Paper size and Margins
13122 \begin_layout Standard
13123 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13126 \begin_layout Subsection
13130 \begin_layout Standard
13131 The following environments are available.
13132 You can use hollywood.bind to get the bind keys shown at the right.
13135 \begin_layout Itemize
13142 Used where nothing else works.
13146 \begin_layout Itemize
13159 Usually followed by something like
13160 \begin_inset Quotes eld
13163 on Sally waking up.
13164 \begin_inset Quotes erd
13170 \begin_layout Itemize
13179 Introduces a new INTERIOR camera set-up.
13180 Always followed by DAY or NIGHT, or something similar to define the lighting
13182 Everthing on this line in CAPS.
13185 \begin_layout Itemize
13194 Introduces a new EXTERIOR camera set-up.
13195 Everthing on this line in CAPS.
13198 \begin_layout Itemize
13207 The character speaking.
13210 \begin_layout Itemize
13219 Instructions to the speaker.
13220 The () are automatically inserted, but only the ( will show in LyX.
13221 Both will be printed.
13224 \begin_layout Itemize
13240 \begin_layout Itemize
13249 Camera movement instruction.
13250 e.\InsetSpace \thinspace{}
13255 \begin_layout Itemize
13263 \begin_layout Itemize
13271 \begin_layout Itemize
13279 \begin_layout Itemize
13287 \begin_layout Subsection
13291 \begin_layout Itemize
13292 (O.S) --- off screen
13295 \begin_layout Itemize
13296 (V.0) --- voice over
13299 \begin_layout Itemize
13304 \begin_layout Itemize
13309 \begin_layout Itemize
13310 PAN --- camera movement
13313 \begin_layout Itemize
13314 INSERT --- cut to close-up of
13317 \begin_layout Section
13321 \begin_layout Standard
13327 \begin_layout Subsection
13331 \begin_layout Standard
13332 Broadway is for writing plays.
13333 The format is more decorative than Hollywood, and much less standardized.
13334 This format should be suitable for workshops.
13337 \begin_layout Subsection
13341 \begin_layout Standard
13342 The same as in Hollywood.
13345 \begin_layout Subsection
13349 \begin_layout Standard
13354 names as labels then cross-reference the label to insert the name.
13355 The cross-reference dialog will show the current cast of characters.
13358 \begin_layout Subsection
13359 Paper size and Margins
13362 \begin_layout Standard
13363 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13366 \begin_layout Subsection
13370 \begin_layout Standard
13371 The following environments are available.
13372 You can use broadway.bind to get the bind keys shown at the right.
13375 \begin_layout Itemize
13382 You should not have to use this, but it is here for anything that does not
13386 \begin_layout Itemize
13395 Used to describe stage setting and the action.
13396 First use of speaker names in all CAPs.
13399 \begin_layout Itemize
13408 Automatically numbered.
13409 On screen it will be arabic, but will print as Roman.
13412 \begin_layout Itemize
13426 It is just centered text.
13429 \begin_layout Itemize
13438 Not automatically numbered.
13439 You supply the number.
13440 This is because I couldn't figure out how.
13443 \begin_layout Itemize
13452 A special case of Narrative to describe the setting and action as the curtain
13456 \begin_layout Itemize
13465 The speaker's (actor's) title, centered in all CAPS.
13468 \begin_layout Itemize
13477 Instructions to the speaker.
13478 The parentheses are automatically inserted.
13479 The ( will appear on screen, but both will be in the printed play.
13480 This environment is only used within
13487 \begin_layout Itemize
13496 What the Speaker says.
13499 \begin_layout Itemize
13508 The curtain comes down.
13511 \begin_layout Itemize
13519 \begin_layout Itemize
13527 \begin_layout Itemize
13535 \begin_layout Standard
13539 \begin_layout Section
13543 \begin_layout Standard
13549 \begin_layout Standard
13550 \begin_inset VSpace bigskip
13556 \begin_layout Standard
13560 Revtex\InsetSpace ~
13563 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13564 \begin_inset Formula $\beta$
13567 release of May, 1999) class.
13570 \begin_layout Standard
13575 textclass, which works with RevTeX 3.1.
13576 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13577 That means that it doesn't interact very well with LyX, which requires
13578 LaTeX2e, although it has been kludged to work.
13579 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13582 RevTeX\InsetSpace ~
13585 textclass should also be pretty easy to use.
13588 \begin_layout Standard
13589 These documents are supposed to be used in
13593 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13594 macros, and assume you'll know what to put in the preamble if necessary.
13597 \begin_layout Subsection
13601 \begin_layout Standard
13602 All you need to do is install RevTeX 4, as described in the package's README
13604 The package can be found at The RevTeX 4 Web Site
13605 \begin_inset Flex URL
13608 \begin_layout Standard
13610 http://publish.aps.org/revtex4/
13616 Install it somewhere that LaTeX can see it.
13617 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13618 (i.e., not the directory where you installed the class file.) Then, if you
13619 reconfigure LyX, it will find the class file and let you use the RevTeX4
13623 \begin_layout Standard
13624 Probably the easiest way to get started is either to import a RevTeX 4 document
13631 Revtex\InsetSpace ~
13634 template, found in the templates directory.
13637 \begin_layout Subsection
13641 \begin_layout Standard
13642 Optional arguments to
13649 \begin_inset Quotes eld
13653 \begin_inset Quotes erd
13657 \begin_inset Quotes eld
13661 \begin_inset Quotes erd
13675 Document\InsetSpace ~
13679 Remember that in RevTeX, at least one optional argument is required!
13682 \begin_layout Standard
13683 Other preamble matter, like
13699 dialog, also as usual.
13702 \begin_layout Subsection
13706 \begin_layout Standard
13707 The layouts basically correspond to the commands in RevTeX4.0.
13708 For example, the Email layout corresponds to
13715 Note that (at least as of RevTeX 4.0 Beta), the
13723 layouts are exactly equivalent, so you shouldn't need to use both.
13727 \begin_layout Standard
13728 In case you're curious, both were included so that
13732 would be able to translate both
13752 \begin_layout Subsection
13756 \begin_layout Standard
13757 There are a couple of important unique aspects of RevTeX 4 which might cause
13758 bugs that will be even more confusing in LyX.
13761 \begin_layout Standard
13779 The LyX equivalent is that there is a separate Thanks layout.
13784 write footnotes in the
13788 layout, or weird things may happen.
13789 See the RevTeX 4 documentation for more details.
13792 \begin_layout Standard
13795 Author\InsetSpace ~
13800 Author\InsetSpace ~
13807 layouts must be placed
13815 layout and the corresponding
13832 , the LaTeX won't compile.
13835 \begin_layout Subsection
13839 \begin_layout Standard
13840 The main problem with this layout is that you can't use the optional arguments
13841 to layouts like Email and Title.
13842 (The problem is not unique to this layout; you can't use optional arguments
13843 to the Section layouts either.) This means that after you export that file
13844 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13845 need to edit the LaTeX file with a text editor to add the optional arguments
13846 to set, e.\InsetSpace \thinspace{}
13847 g., the running title for the page headers.
13848 Lacking these layouts makes the
13854 (and the equivalent
13860 ) useless, so the corresponding layouts don't exist, and will have to be
13865 \begin_layout Standard
13870 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13871 has not been updated yet to take advantage of it.
13879 \begin_layout Section
13880 Article (mwart), book (mwbk) and report (mwrep)
13881 \begin_inset OptArg
13884 \begin_layout Standard
13897 \begin_layout Standard
13903 \begin_layout Standard
13904 The LyX document classes
13920 correspond to the LaTeX document classes
13933 They are replacements for the standard document classes
13945 , resp., and fit better to Polish typography conventions in a number of points.
13949 \begin_layout Standard
13953 \begin_layout Itemize
13954 Unnumbered titles (with star, eg.
13959 ) are added into table of contents,
13962 \begin_layout Itemize
13963 Additional page styles:
13967 \begin_layout Description
13968 uheadings header with separated lines,
13971 \begin_layout Description
13972 myheadings custom header, contents headers via commands:
13987 \begin_layout Description
13988 myuheadings custom header with separated lines,
13991 \begin_layout Description
13992 outer page number is placed on outer side of page
13996 \begin_layout Itemize
14001 \begin_layout Description
14002 rmheadings serif titles --- default,
14005 \begin_layout Description
14006 sfheadings sansserif titles,
14009 \begin_layout Description
14010 authortitle on title page first placed is author next title --- default,
14013 \begin_layout Description
14014 titleauthor on title page first placed is title next author,
14017 \begin_layout Description
14018 withmarginpar reserve place on page for margins.
14022 \begin_layout Section
14026 \begin_layout Standard
14032 \begin_layout Standard
14033 Elsevier Science Publishers B.V.
14034 provides a standard LaTeX document class (
14038 ) for submitting articles to their various journals.
14039 The style file can be downloaded directly from their web site:
14040 \begin_inset Flex URL
14043 \begin_layout Standard
14045 http://authors.elsevier.com/
14051 Instructions are supplied along with the class file, which details the
14052 requirements of the publishers.
14053 LyX includes package that allows for the use of this class, by a layout
14054 and a template file.
14055 Installation of the class file is the same as for any other LaTeX package;
14056 instructions are provided in the Elsevier documentation.
14059 \begin_layout Standard
14069 As the Elsevier class file is based mainly on the standard article class,
14070 most of the normal functionality is provided.
14071 The Elsevier class defines a number of mathematical environments, which
14072 are similar to the AMS environments.
14073 These commands are all described in the Elsevier documentation, and are
14077 \begin_layout Standard
14078 The easiest way to use the Elsevier style is to base documents on the included
14080 It is best not to use options such as fancy headings or the geometry package,
14081 as elements such as these are defined by Elsevier in their style file.
14082 Ideally, no extra packages except those mentioned in the Elsevier documentation
14084 Essentially, Elsevier require as
14085 \begin_inset Quotes eld
14089 \begin_inset Quotes erd
14096 \begin_layout Standard
14105 file as possible, as their intention is to take the supplied file and replace
14106 the class file with one for the particular journal to which the paper has
14108 This also means that not too much time should be spent on the formating
14110 When it comes to be published, this will change anyway.
14111 The rest of the usage for this layout is substantially the same as for
14112 the normal article class.
14113 For details of what Elsevier do and don't allow, refer to their documentation.
14116 \begin_layout Section
14120 \begin_layout Standard
14123 Jürgen Spitzmüller
14126 \begin_layout Subsection
14130 \begin_layout Standard
14131 Memoir is a very powerful and constantly evolving class.
14132 It has been designed with regard to fictional and non-fictional literature.
14133 Its aim is to let the user have maximum control over the typesetting of
14135 Memoir is based on the standard book class, but it can also emulate the
14136 article class (see below).
14139 \begin_layout Standard
14140 Peter Wilson, the developer of Memoir, is known as the author of lots of
14141 useful packages in the LaTeX world.
14142 Most of them have been merged with Memoir.
14143 Therefore, it is much easier to layout the table of contents, appendices,
14144 chapter designs and such.
14145 LyX, though, does not support all of these goodies natively.
14146 Some of them might be added to forthcoming releases
14150 \begin_layout Standard
14151 You are invited to send suggestions to
14152 \begin_inset Flex URL
14155 \begin_layout Standard
14157 lyx-devel@lists.lyx.org
14167 , lots will probably never, due to the limitations of LyX's framework.
14168 Of course you can still use all features with the help of some native LaTeX
14173 \begin_layout Standard
14178 \begin_layout Standard
14187 section\InsetSpace ~
14189 \begin_inset CommandInset ref
14191 reference "sec:Inserting-LaTeX-Code"
14201 In this section, we can only list those features which are natively supported
14203 For detailed descriptions (and for the rest of features) we are recommending
14204 to have a look at the detailed manual of the Memoir class
14208 \begin_layout Standard
14213 \begin_layout Standard
14223 \begin_inset Flex URL
14226 \begin_layout Standard
14228 CTAN:/macros/latex/memoir/memman.pdf
14238 , which is not only a user guide for the class, but also both a comprehensive
14239 description on good typesetting and a superb example for good typesetting
14243 \begin_layout Subsection
14244 Basic features and restrictions
14247 \begin_layout Standard
14248 Memoir supports basically all features of the standard book classes.
14249 There are, however, some differences, as follows:
14252 \begin_layout Description
14254 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14258 \begin_layout Description
14260 style: The fancy page style is not supported, due to a command clash
14261 between Memoir and the fancyhdr package (they are both defining a command
14262 with the same name, which confuses LaTeX).
14263 Instead, Memoir comes with a bunch of own page styles (see
14265 Layout\SpecialChar \menuseparator
14266 Document\SpecialChar \menuseparator
14271 If you want to use these for the chapter pages, you have to use the command
14278 in the main text or in preamble (e.
14282 \begin_layout Standard
14295 \begin_layout Standard
14308 chapterstyle{companion}
14313 \begin_layout Description
14314 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14315 an optional argument in the standard classes.
14316 With this, you can specify an alternative version of the title for the
14317 table of contents and the headers (for instance, if the title is too long).
14318 In LyX, you can do this via
14320 Insert\SpecialChar \menuseparator
14324 at the beginning of a chapter/section.
14325 Memoir features a second optional argument and thus separates the table
14326 of contents from the header.
14327 You can define three variants of a title with this: one for the main text,
14328 one for the table of contents, and one for the headers.
14329 Simply insert two optional arguments if you need this feature, the first
14330 one containing the short title for the Table of Contents, the second one
14331 containing an alternative short title for the headers.
14334 \begin_layout Description
14335 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14336 of contents, the list of figures and the list of table start a new page
14338 Memoir does not follow this route.
14339 You have to insert a page break yourself, if you want to have one.
14342 \begin_layout Description
14343 Titlepage: For some unknown reason, Memoir uses pagination on the title
14344 page (in the standard classes, title pages are
14345 \begin_inset Quotes eld
14349 \begin_inset Quotes erd
14356 \begin_layout Standard
14369 \begin_layout Standard
14379 If you want an empty title page, type
14383 aliaspagestyle{title}{empty}
14388 \begin_layout Description
14389 Article: With the class option
14395 Layout\SpecialChar \menuseparator
14396 Document\SpecialChar \menuseparator
14400 ), you can emulate article style.
14401 That is, counters (footnotes, figures, tables etc.) will not be reset on
14402 new chapters, chapters don't start a new page (but are---in contrary to
14404 \begin_inset Quotes eld
14408 \begin_inset Quotes erd
14411 article classes---still allowed), parts, though, use their own page, as
14415 \begin_layout Description
14416 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14417 font commands, which have been used in the old LaTeX version 2.09 (e.
14421 \begin_layout Standard
14434 \begin_layout Standard
14456 It produces an error and stops LaTeX whenever such a command appears.
14461 reallows the commands and spits out warnings instead (which does at least
14463 Since a lot of packages and particularly BibTeX style files are still using
14464 those commands, we have decided to use this option by default.
14467 \begin_layout Subsection
14471 \begin_layout Standard
14472 We will only describe the features supported by LyX (which is not much currently
14474 Please consult the Memoir manual
14478 \begin_layout Standard
14483 \begin_layout Standard
14493 \begin_inset Flex URL
14496 \begin_layout Standard
14498 CTAN:/macros/latex/memoir/memman.pdf
14511 \begin_layout Description
14512 Abstract: You may wonder why an abstract is an extra feature.
14513 Well, it is in book class.
14514 Usually books don't have abstracts.
14515 Memoir, however, has.
14516 You can use it wherever and how often you like.
14519 \begin_layout Description
14520 Chapterprecis: You may know this from belletristic: The contents of a chapter
14521 is shortly described below the title and also in the table of contents
14526 \begin_layout Standard
14539 \begin_layout Standard
14550 Our hero arrives in Troia; he loses some friends; he finds others
14553 Chapterprecis does exactly this.
14554 It is therefore only sensible below a chapter.
14557 \begin_layout Description
14558 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14559 The epigraph environment provides an elegant way of typesetting such a
14561 The motto itself (text) and its author (source) are divided by a short
14563 Unfortunately, we have to fool LyX a bit here again, since the environment
14564 needs two arguments (text and source).
14565 In this case, we have to use curly brackets (in TeX mode) between the two
14576 <author of the slogan>.
14579 \begin_layout Description
14580 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14581 complex figurative poems).
14582 LyX can only support a few of them.
14583 One is poemtitle, which is a centered title for poems, which will also
14584 be added to the table of contents (verse is the standard environment for
14586 Memoir has some enhanced versions of verse, but you need to use ERT, because
14587 they have to be nested inside regular verse environments, which is not
14588 possible with LyX).
14591 \begin_layout Description
14592 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14595 \begin_layout Chapter
14596 Importing and Exporting Alternate File Formats
14597 \begin_inset OptArg
14600 \begin_layout Standard
14601 Importing and Exporting
14609 \begin_layout Section
14613 \begin_layout Standard
14614 Importing and exporting LyX documents from/to other formats has been touched
14620 Here we describe more of the gory details needed to understand just what
14621 is going on when you click on the
14626 ile\SpecialChar \menuseparator
14638 ile\SpecialChar \menuseparator
14649 \begin_layout Section
14650 Importing Other Formats
14653 \begin_layout Subsection
14657 \begin_layout Standard
14658 Translating from LaTeX into LyX is performed by a converter program called
14664 Although it is a standalone program which can be called from the command
14665 line, LyX will call it automatically when a LaTeX document is imported.
14666 See section\InsetSpace ~
14668 \begin_inset CommandInset ref
14670 reference "sec:Translating-LaTeX-files"
14674 for a complete description.
14677 \begin_layout Subsection
14681 \begin_layout Standard
14682 When importing plain ASCII text, there are two methods of reading the file.
14684 \begin_inset Quotes eld
14688 \begin_inset Quotes erd
14691 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14694 \begin_inset Quotes eld
14698 \begin_inset Quotes erd
14701 assumes that consecutive lines separated by only a single linebreak form
14702 a single paragraph.
14703 Successive linebreaks with no intervening text are thus assumed to be paragraph
14707 \begin_layout Subsection
14711 \begin_layout Standard
14714 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14717 \begin_layout Section
14718 Exporting Other Formats
14721 \begin_layout Standard
14722 The output formats listed here in the following are also explained concerning
14723 possible graphics formats in the
14730 \begin_layout Subsection
14734 \begin_layout Standard
14735 LyX generates two types of LaTeX files: stripped down versions for the normal
14740 , etc.) which one normally never sees
14744 \begin_layout Standard
14745 The resulting file is a perfectly valid LaTeX file, though the preamble
14746 might look a bit strange since it includes some definitions used by LyX
14747 which wouldn't show up in most human-written files.
14752 , and human readable forms which are suitable for exchanging with your colleague
14754 The only settable option for the translation is the line length of the
14756 The default is 65 characters, but it can be set in
14763 \SpecialChar \menuseparator
14784 \begin_layout Subsection
14785 Device Independent Files
14788 \begin_layout Standard
14789 Device Independent files (DVI files) are produced by running LaTeX on your
14791 There are no user settable options.
14794 \begin_layout Subsection
14798 \begin_layout Standard
14799 The next step in the conversion chain is converting a DVI file into Postscript.
14807 \SpecialChar \menuseparator
14815 \SpecialChar \menuseparator
14824 or, if you need more control on the result,
14831 \SpecialChar \menuseparator
14840 If you use the later, note that it is possible to configure, in
14847 \SpecialChar \menuseparator
14855 , the options passed to the dvips program to achieve different effects.
14858 \begin_layout Subsection
14862 \begin_layout Standard
14863 Exporting as ASCII attempts to preserve the
14864 \begin_inset Quotes eld
14868 \begin_inset Quotes erd
14871 of the document as well as possible, but things like centering and indentation
14872 are thrown out; paragraphs are separated by blank lines.
14873 Section numbering and cross-references are done correctly, so the resulting
14874 text files is remarkably readable.
14875 The only changeable option is the length of lines, as for LaTeX output.
14878 \begin_layout Subsection
14882 \begin_layout Standard
14883 LyX documents can be converted to hypertext markup, usually by converting
14884 to LaTeX first, then converting that to HTML\SpecialChar \@.
14886 \begin_inset Formula $\rightarrow$
14889 HTML converters are currently known to LyX:
14906 Though they are autodetected, you can overide the selection in preferences.
14907 You can also include further command line options in this dialog.
14911 \begin_layout Subsection
14915 \begin_layout Standard
14923 \begin_layout Standard
14924 \begin_inset VSpace bigskip
14930 \begin_layout Standard
14931 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14932 any version of LyX is to save the document as a Postscript file, then run
14938 Starting with version 1.1.6, the menu item
14942 will do all this for you.
14943 There are some issues with fonts that you need to pay attention to: see
14944 Section\InsetSpace ~
14946 \begin_inset CommandInset ref
14948 reference "sec:badfonts"
14953 Also, as of version 1.1.6, there is a better method that will generate much
14954 more sophisticated files.
14957 \begin_layout Subsubsection
14961 \begin_layout Standard
14962 With pdfLaTeX you cannot use pstricks.
14963 On the other hand, with pdfLaTeX it is possible to insert directly images
14964 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14967 \begin_layout Subsubsection
14968 Why does the text look so bad when viewed with Acrobat Reader?
14969 \begin_inset CommandInset label
14971 name "sec:badfonts"
14976 \begin_inset OptArg
14979 \begin_layout Standard
14980 Bad Fonts in Acrobat Reader
14988 \begin_layout Standard
14989 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14990 When creating a PDF from the LyX file, you need to use outline font instead
14991 of the default bitmap fonts (in fact, you should also use outline fonts
14992 for Postscript files).
14993 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14994 (Computer Modern) fonts.
14995 pdfLaTeX uses these font by default.
14996 Dvips doesn't use these fonts by default, so to make it use them, add the
14997 following to lines to your
15004 \begin_layout LyX-Code
15008 \begin_layout LyX-Code
15012 \begin_layout Standard
15013 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15015 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15016 fonts, for which there are no Type1 version.
15017 The solution is to use the ae package which emulates T1 coded fonts using
15018 the standard CM fonts.
15019 This is done by adding
15023 usepackage{ae,aecompl}
15025 to the preamble of the LyX file.
15026 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
15029 they are taken from the EC fonts.
15030 Therefore you get these glyphs as bitmaps.
15033 \begin_layout Standard
15034 Note: LyX uses by default the T1 font encoding.
15035 If you wish to use the default font encoding (this is not recommended,
15036 unless you only write English documents), clear the field
15044 in preferences (tabs
15056 \begin_layout Standard
15057 An alternate option is to use the standard Postscript fonts instead of the
15058 Computer Modern fonts.
15059 To do that, you need to select
15063 as the global font in the document layout dialog.
15064 When using the Postscript fonts, the result PDF file is smaller as the
15065 fonts are not saved into the file.
15066 Furthermore, the Postscript fonts include all T1 glyphs.
15067 On the other hand, the Postscript fonts have no bold symbol font, so poor
15068 man's bold must be used (see Section\InsetSpace ~
15070 \begin_inset CommandInset ref
15072 reference "sec:pdfbold"
15077 The Postscript fonts also look different from the Computer Modern fonts.
15080 \begin_layout Standard
15081 To sum up, both the Computer Modern and the Postscript fonts gives good
15082 results (with few exceptions).
15083 The decision of which one to use is a matter of taste.
15086 \begin_layout Subsubsection
15089 boldsymbol{} command work when I use pslatex?
15090 \begin_inset CommandInset label
15097 \begin_inset OptArg
15100 \begin_layout Standard
15117 \begin_layout Standard
15118 The Postscript fonts do not have a bold symbol font.
15119 The solution is to use the
15125 (poor man's bold) command.
15128 \begin_layout Standard
15129 It is possible to redefine the
15144 \begin_layout LyX-Code
15154 \begin_layout Standard
15158 \begin_layout Subsubsection
15159 Is it possible to do write LaTeX-code which is processed only when running
15161 \begin_inset OptArg
15164 \begin_layout Standard
15165 Conditionals with pdfLaTeX
15173 \begin_layout Standard
15174 Yes you can do this with the
15179 Here is an example:
15182 \begin_layout LyX-Code
15186 \begin_layout LyX-Code
15192 \begin_layout LyX-Code
15198 \begin_layout LyX-Code
15201 pdfinfo { /Author (your name and e-mail address)
15204 \begin_layout LyX-Code
15205 /Title (official title -- i.e., title element)
15208 \begin_layout LyX-Code
15209 /Subject (one line description of the document)
15212 \begin_layout LyX-Code
15216 \begin_layout LyX-Code
15219 pdfcatalog { /PageMode (/UseNone)
15222 \begin_layout LyX-Code
15223 % /OpenAction (fitbh)
15226 \begin_layout LyX-Code
15230 \begin_layout LyX-Code
15233 usepackage[pdftex]{hyperref}
15236 \begin_layout LyX-Code
15242 \begin_layout LyX-Code
15245 usepackage[ps2pdf]{hyperref}
15248 \begin_layout LyX-Code
15254 \begin_layout Subsubsection
15255 How can I make URLs clickable?
15258 \begin_layout Standard
15259 See the references here:
15262 \begin_layout Standard
15263 \begin_inset Flex URL
15266 \begin_layout Standard
15268 http://wiki.lyx.org/pmwiki.php/FAQ/PDF
15276 \begin_layout Subsection
15280 \begin_layout Standard
15281 Custom exports are possible if you have some particularly weird format you
15282 wish to convert to, assuming you have the relevant converter, of course.
15287 file can be chosen in the
15292 ile\SpecialChar \menuseparator
15297 xport\SpecialChar \menuseparator
15304 dialog; LyX will automatically convert the file to this point, then feed
15305 it to your custom converter.
15306 The possible values are all formats that LyX can produce from its own documents.
15310 \begin_layout Standard
15311 The converter command is also specified in the dialog.
15312 It should be a completely qualified command line which uses the variable
15317 to specify the name of the file.
15318 If this variable is not given, then the file will be sent to the standard
15319 input of your command.
15320 You may have to apply a bit of ingenuity to escape this sequence correctly
15321 so that it is compatible with your shell.
15325 \begin_layout Standard
15326 While it is not possible to save this command using the
15330 dialog, you can manually edit your
15337 \begin_layout LyX-Code
15340 custom_export_command "mycommand $$FName"
15343 \begin_layout Chapter
15344 LyX Features needing Extra Software
15347 \begin_layout Section
15351 \begin_layout Standard
15357 \begin_layout Subsection
15361 \begin_layout Standard
15369 menu, you'll find a
15378 This feature requires you to have the
15382 program installed, and is grayed out if you don't have it.
15383 You can get it from your nearest CTAN mirror, or over the Web from
15384 \begin_inset Flex URL
15387 \begin_layout Standard
15389 http://www.ifi.uio.no/~jensthi/chktex/
15397 \begin_layout Standard
15402 package is a program that was written by
15407 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15408 and easy to forget.
15409 The program runs over your LaTeX file and checks the integrity of the file,
15410 and flags some common errors.
15411 In other technical words, it is
15418 \begin_layout Standard
15419 Well, what is a syntax checker doing in LyX which is supposed to produce
15420 correct LaTeX anyways? The answer is simple: Just as
15424 not only checks the
15428 of C programs, but also does
15432 checks for type-errors,
15436 catches some common
15440 errors, in addition to the syntactical ones.
15445 is capable of detecting several common errors, such as
15448 \begin_layout Itemize
15449 Ellipsis detection:
15451 Use \SpecialChar \ldots{}
15455 \begin_layout Itemize
15456 No space in front of/after parenthesis:
15461 \begin_layout Itemize
15462 Enforcement of normal space after common abbreviations:
15466 is too wide spacing.
15469 \begin_layout Itemize
15470 Enforcement of end-of-sentence space when the last sentence ends with a
15474 And this is wrong spacing.
15477 \begin_layout Itemize
15478 Space in front of labels and similar commands:
15480 The label should stick right
15481 up to the text to avoid falling to a wrong page.
15483 \begin_inset CommandInset label
15493 \begin_layout Standard
15494 This footnote is in danger of falling off to a wrong page
15499 The label is separated too much.
15502 \begin_layout Itemize
15503 Space in front of references, instead of hard spaces:
15505 In you are in bad luck,
15506 the text will break right between the referenced text and reference number,
15509 \begin_inset CommandInset ref
15511 reference "sec:chktex"
15518 \begin_layout Itemize
15520 \begin_inset Quotes eld
15524 \begin_inset Quotes erd
15528 \begin_inset Formula $\times$
15533 2x2 looks cheap compared to
15534 \begin_inset Formula $2\times2$
15540 \begin_layout Standard
15541 and more \SpecialChar \ldots{}
15542 It is an invaluable tool when you are
15543 \begin_inset Quotes eld
15547 \begin_inset Quotes erd
15550 your document before printing, and you should run it right after the obligatory
15551 spelling check, and before you go fine tuning the typesetting.
15554 \begin_layout Subsection
15558 \begin_layout Standard
15559 If you have the program installed, usage is as simple as choosing
15564 ools\SpecialChar \menuseparator
15573 This will make LyX generate a LaTeX file of your document, start
15577 to check it, and then make LyX insert
15578 \begin_inset Quotes eld
15582 \begin_inset Quotes erd
15585 with the warnings from
15589 , if there were any.
15590 The warnings will be placed close to the point of the mistake, and you
15591 can quickly find them by using the
15596 avigate\SpecialChar \menuseparator
15603 menu item, or the shortcut key
15612 Open the error boxes by clicking on them with the mouse, or use the shortcut
15621 bindings, or the corresponding
15630 Read the warning and correct the mistake, if it is a mistake.
15631 If you have trouble understanding what the warning is about, you can safely
15633 Remember that there is a hidden layer between the document on screen and
15634 the technical details in invoking
15638 , and this gap can make some warnings seem arcane or just right down plain
15642 \begin_layout Standard
15643 This document is an excellent testing bed for the feature, and it should
15644 provide quite a few warnings for you to fiddle with.
15645 Since computers are only so smart, expect most of the warnings to be false
15649 \begin_layout Subsection
15650 How to fine tune it
15653 \begin_layout Standard
15654 Sometimes, you'll find that
15658 makes more noise than suits your mood.
15659 Then you can choose not to use it, wait until your mood changes, or try
15664 to get better along with you.
15665 Another choice in the most desperate situations is to use
15670 iew\SpecialChar \menuseparator
15680 , which will get rid of all warnings instantly.
15683 \begin_layout Standard
15692 very configurable and extensible, you shouldn't expect to solve all problems
15698 Since LyX has to generate a somewhat special LaTeX file to be able to match
15699 the line numbers from the
15707 \begin_layout Standard
15708 You can inspect the specific output from
15714 Edit\SpecialChar \menuseparator
15728 to the internal document structure, some of the warnings will not seen
15729 to appear correctly.
15730 There are two things you can do about this:
15733 \begin_layout Itemize
15738 invocation command line in
15754 installation configuration file (usually with the file
15759 See below to learn what warnings can be enabled and disabled on the command
15764 \begin_layout Itemize
15765 Export your document as a raw LaTeX file using
15770 ile\SpecialChar \menuseparator
15775 xport\SpecialChar \menuseparator
15787 Invoked in this way, it can be a hassle to find the corresponding place
15788 in the document inside LyX, but with a little patience, you should be able
15792 \begin_layout Standard
15793 Here follows the warning messages that can be enabled and disabled in
15802 to disable a warning, and
15806 to enable a warning.
15807 The emphasized entries are disabled by default, because the default is
15810 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15815 \begin_layout Standard
15816 Notice that you should only use the options that enable and disable warnings,
15817 because LyX relies on some of the other command line parameters to be set
15818 in a specific way to have a chance to communicate with
15825 \begin_layout Enumerate
15829 Command terminated with space.
15832 \begin_layout Enumerate
15835 Non-breaking space (
15836 \begin_inset Quotes eld
15844 \begin_inset Quotes erd
15847 ) should have been used.
15850 \begin_layout Enumerate
15854 You should enclose the previous parenthesis with
15855 \begin_inset Quotes eld
15863 \begin_inset Quotes erd
15869 \begin_layout Enumerate
15872 Italic correction (
15873 \begin_inset Quotes eld
15883 \begin_inset Quotes erd
15886 ) found in non-italic buffer.
15889 \begin_layout Enumerate
15892 Italic correction (
15893 \begin_inset Quotes eld
15903 \begin_inset Quotes erd
15906 ) found more than once.
15909 \begin_layout Enumerate
15913 No italic correction (
15914 \begin_inset Quotes eld
15924 \begin_inset Quotes erd
15930 \begin_layout Enumerate
15934 \begin_inset Quotes eld
15942 \begin_inset Quotes erd
15946 \begin_inset Quotes eld
15954 \begin_inset Quotes erd
15960 \begin_layout Enumerate
15963 Wrong length of dash may have been used.
15966 \begin_layout Enumerate
15970 \begin_inset Quotes eld
15978 \begin_inset Quotes erd
15982 \begin_inset Quotes eld
15990 \begin_inset Quotes erd
15996 \begin_layout Enumerate
16000 \begin_inset Quotes eld
16008 \begin_inset Quotes erd
16014 \begin_layout Enumerate
16018 \begin_inset Quotes eld
16026 \begin_inset Quotes erd
16029 to achieve an ellipsis.
16032 \begin_layout Enumerate
16035 Inter-word spacing (
16036 \begin_inset Quotes eld
16046 \begin_inset Quotes eld
16049 ) should perhaps be used.
16052 \begin_layout Enumerate
16055 Inter-sentence spacing (
16056 \begin_inset Quotes eld
16066 \begin_inset Quotes erd
16069 ) should perhaps be used.
16072 \begin_layout Enumerate
16075 Could not find argument for command.
16078 \begin_layout Enumerate
16082 \begin_inset Quotes eld
16090 \begin_inset Quotes erd
16096 \begin_layout Enumerate
16099 Math mode still on at end of LaTeX file.
16102 \begin_layout Enumerate
16106 \begin_inset Quotes eld
16114 \begin_inset Quotes erd
16117 doesn't match the number of
16118 \begin_inset Quotes eld
16126 \begin_inset Quotes erd
16132 \begin_layout Enumerate
16135 You should use either
16138 \begin_inset Quotes eld
16146 \begin_inset Quotes erd
16151 as an alternative to
16152 \begin_inset Quotes eld
16160 \begin_inset Quotes erd
16166 \begin_layout Enumerate
16173 " (ASCII 39) instead of "
16180 \begin_layout Enumerate
16183 User-specified pattern found.
16186 \begin_layout Enumerate
16189 This command might not be intended.
16192 \begin_layout Enumerate
16199 \begin_layout Enumerate
16217 \begin_layout Enumerate
16220 Delete this space to maintain correct page references.
16223 \begin_layout Enumerate
16227 You might wish to put this between a pair of
16228 \begin_inset Quotes eld
16236 \begin_inset Quotes erd
16242 \begin_layout Enumerate
16245 You ought to remove spaces in front of punctuation.
16248 \begin_layout Enumerate
16251 Could not execute LaTeX command.
16254 \begin_layout Enumerate
16263 in front of small punctuation.
16266 \begin_layout Enumerate
16274 may look prettier here.
16277 \begin_layout Enumerate
16281 Multiple spaces detected in output.
16284 \begin_layout Enumerate
16287 This text may be ignored.
16290 \begin_layout Enumerate
16296 \begin_inset Quotes eld
16301 to begin quotation, not
16308 \begin_layout Enumerate
16315 to end quotation, not
16318 \begin_inset Quotes eld
16326 \begin_layout Enumerate
16332 \begin_layout Enumerate
16335 You should perhaps use
16336 \begin_inset Quotes eld
16344 \begin_inset Quotes erd
16350 \begin_layout Enumerate
16353 You should put a space in front of/after parenthesis.
16356 \begin_layout Enumerate
16359 You should avoid spaces in front of/after parenthesis.
16362 \begin_layout Enumerate
16366 You should not use punctuation in front of/after quotes.
16369 \begin_layout Enumerate
16372 Double space found.
16375 \begin_layout Enumerate
16378 You should put punctuation outside inner/inside display math mode.
16381 \begin_layout Enumerate
16384 You ought to not use primitive TeX in LaTeX code.
16387 \begin_layout Enumerate
16390 You should remove spaces in front of
16391 \begin_inset Quotes eld
16399 \begin_inset Quotes erd
16405 \begin_layout Enumerate
16408 \begin_inset Quotes eld
16416 \begin_inset Quotes erd
16419 is normally not followed by
16420 \begin_inset Quotes eld
16428 \begin_inset Quotes erd
16434 \begin_layout Standard
16435 In later versions of LyX, we hope to provide a more complete interface to
16436 this tool (and it's smaller cousin
16440 ) to exploit the full power of it.
16441 But it's not exactly useless as it is now: go try it on one of your existing
16442 documents of a certain length and be surprised.
16445 \begin_layout Section
16446 Version Control in LyX
16449 \begin_layout Standard
16452 Lars Gullik Bjønnes
16455 \begin_layout Subsection
16459 \begin_layout Standard
16460 A friend of mine wanted to try LyX for a group project.
16461 When he didn't find support for version control or file locking, he dropped
16463 This angered me a bit, so I thought that I should at least make support
16464 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16465 This has now been done.
16466 LyX now supports some of the most basic RCS commands.
16467 If you need to something a bit more sophisticated you will have to do that
16468 manually in an xterm.
16471 \begin_layout Standard
16472 Before you begin to use the version control features in LyX, you should
16474 \begin_inset Quotes eld
16478 \begin_inset Quotes erd
16481 (a man file, read it with
16486 This file describes all the basic features of RCS.
16487 You should especially notice the comment about a RCS directory, and the
16488 notion of a master RCS file (the file ending in
16495 \begin_layout Standard
16496 The implementation in LyX assumes a recent version of the GNU RCS package---no
16497 guarantees are made for older versions.
16500 \begin_layout Subsection
16501 RCS commands in LyX
16504 \begin_layout Standard
16505 The following sections describe the RCS commands supported by LyX.
16506 You can find them in the
16511 ile\SpecialChar \menuseparator
16516 ersion\InsetSpace ~
16522 \begin_layout Subsubsection
16528 \begin_layout Standard
16529 If your document is not under revision control, this is the only item shown
16531 And if it is under revision control, the
16538 item is grayed out.
16542 \begin_layout Standard
16543 This command registers your document with RCS\SpecialChar \@.
16544 You are asked interactively
16545 to supply an initial description of the document.
16546 The document is now set in Read-Only mode and you have to
16553 , before making any changes to it.
16554 A document under revision control has a
16555 \begin_inset Quotes eld
16558 [RCS:<version> <locker>]
16559 \begin_inset Quotes erd
16562 item tagged to the filename in the minibuffer.
16565 \begin_layout Standard
16566 RCS command that is run:
16568 ci -q -u -i -t-"<initial description>" <file-name>
16571 \begin_layout Standard
16576 to understand the switches.
16580 \begin_layout Subsubsection
16586 \begin_layout Standard
16587 When you are finished editing a file, you check in your changes.
16588 When you do this, you are asked for a description of the changes.
16589 This is stored in the history log.
16590 The version number is bumped, your changes are applied to the master RCS
16591 file, the document is unlocked and set to Read-Only mode.
16595 \begin_layout Standard
16598 ci -q -u -m"<description>" <file-name>
16601 \begin_layout Subsubsection
16607 \begin_layout Standard
16608 By doing this you lock the document so that only you can edit it.
16609 This will also make the document Read-Write only for you.
16610 You will usually continue editing for a while and when you are finished
16611 you check in your changes.
16612 The status line is changed to reflect that you have locked the file.
16616 \begin_layout Standard
16619 co -q -l <file-name>
16622 \begin_layout Subsubsection
16625 Revert To Last Version
16628 \begin_layout Standard
16629 This will discard all changes made to the document since the last check
16631 You get a warning before changes are discarded.
16634 \begin_layout Standard
16637 co -f -u<version> <file-name>
16640 \begin_layout Subsubsection
16646 \begin_layout Standard
16647 This makes as if the last check in never happened.
16648 No changes are made to the document loaded into LyX, but the last version
16649 is removed from the master RCS file.
16653 \begin_layout Standard
16656 rcs -o<version> <file-name>
16659 \begin_layout Subsubsection
16665 \begin_layout Standard
16666 This show the complete history of the RCS document.
16671 is shown in a browser.
16679 \begin_layout Section
16680 Literate Programming
16683 \begin_layout Standard
16688 (kayvan@sylvan.com)
16692 original documentation written by
16694 Edmar Wienskoski Jr.
16697 (edmar-w-jr@technologist.com)
16700 \begin_layout Subsection
16704 \begin_layout Standard
16705 The main purpose of this documentation is to show you how to use LyX for
16706 literate programming.
16707 Where it is assumed that you are familiar with this programming technique,
16709 \begin_inset Quotes eld
16713 \begin_inset Quotes erd
16717 \begin_inset Quotes eld
16721 \begin_inset Quotes erd
16725 If that is not the case, please follow the web links provided in the following
16727 There is a lot of good documentation out there covering old development
16728 history to the latest tools tips.
16731 \begin_layout Standard
16732 It is also assumed that you are familiar with LyX itself to a point that
16733 you are comfortable changing your LyX preferences, and X resources file.
16734 If that is not the case please refer to other LyX documentation to cover
16735 your specific needs.
16738 \begin_layout Subsection
16739 Literate Programming
16742 \begin_layout Standard
16743 From the Literate Programming FAQ:
16746 \begin_layout Quotation
16747 Literate programming is the combination of documentation and source together
16748 in a fashion suited for reading by human beings.
16749 In fact, literate programs should be enjoyable reading, even inviting!
16750 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16751 and documentation in a single file.
16752 Literate programming tools then parse the file to produce either readable
16753 documentation or compilable source.
16754 The WEB style of literate programming was created by D.E.
16755 Knuth during the development of his TeX typesetting software.
16759 \begin_layout Standard
16760 Another excerpt says:
16763 \begin_layout Quotation
16766 How is literate programming different from verbose commenting?
16769 \begin_layout Quotation
16770 There are three distinguishing characteristics.
16771 In order of importance, they are:
16775 \begin_layout Itemize
16776 flexible order of elaboration
16779 \begin_layout Itemize
16780 automatic support for browsing
16783 \begin_layout Itemize
16784 typeset documentation, especially diagrams and mathematics
16788 \begin_layout Standard
16789 Now that I sparked your curiosity, take a look in the references.
16792 \begin_layout Subsubsection
16796 \begin_layout Standard
16797 The complete Literate Programming FAQ can be found at:
16800 \begin_layout Quote
16801 Literate Programming FAQ
16802 \begin_inset Flex URL
16805 \begin_layout Standard
16807 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16815 \begin_layout Standard
16816 The FAQ lists 23 (twenty three!) different literate programming tools.
16817 Where some are specialized or
16818 \begin_inset Quotes eld
16822 \begin_inset Quotes erd
16825 for particular programming languages, while other have general scope.
16830 for my own use for several reasons:
16833 \begin_layout Itemize
16834 It can generate the documentation either in LaTeX or HTML.
16837 \begin_layout Itemize
16838 It has a open architecture, i.e., it is easy to plug in new filters and to
16839 perform special processing that you may need.
16843 \begin_layout Itemize
16844 There is a good selection of filters available already (the HTML is one
16848 \begin_layout Itemize
16852 \begin_layout Standard
16853 The Noweb web page can be found at:
16856 \begin_layout Quote
16858 \begin_inset Flex URL
16861 \begin_layout Standard
16863 http://www.cs.virginia.edu/~nr/noweb/
16871 \begin_layout Standard
16872 Starting from there you can reach many other interesting links and even
16873 some literate program examples.
16876 \begin_layout Subsection
16877 \begin_inset CommandInset label
16879 name "sub:LyX-and-Literate"
16883 LyX and Literate Programming
16886 \begin_layout Standard
16887 The LyX support for Literate Programming is provided by using the generic
16888 LyX convertors mechanism.
16889 This support is provided in a
16890 \begin_inset Quotes eld
16894 \begin_inset Quotes erd
16897 way, i.e., you will be able to use this new LyX feature with some other literate
16898 programming tool of your choice by just changing your LyX preferences.
16901 \begin_layout Subsubsection
16902 Generating documents and code (weaving and tangling)
16905 \begin_layout Paragraph
16906 Selecting the document class
16909 \begin_layout Standard
16910 If you have installed Noweb and LyX successfully, whenever you open a new
16911 document or try to change the document class of an existing one, you will
16912 find that there are three new document classes available:
16915 \begin_layout Itemize
16919 \begin_layout Itemize
16923 \begin_layout Itemize
16927 \begin_layout Standard
16928 You must select one of them to create your literate documents from.
16932 \begin_layout Standard
16933 Note that literate documents are not limited to these three classes.
16934 New classes can be generated from other styles like letter or in combination
16935 with other class variations like Article (AMS).
16936 If you have special needs that cannot be covered by one of the existing
16937 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16938 will arrange to insert a new entry, or teach you how to do it.
16942 \begin_layout Standard
16943 It is very simple, it involves the creation of a file with four lines, and
16944 re-running of the auto configuration.
16949 Moreover, if you use a literate tool other than Noweb you may need to create
16950 a new set of document classes for it.
16953 \begin_layout Paragraph
16957 \begin_layout Standard
16958 LyX enables you to write code with a layout named
16966 \begin_layout Standard
16967 The equivalent Noweb term is
16968 \begin_inset Quotes eld
16972 \begin_inset Quotes erd
16976 For historical reasons, I got used to the term
16977 \begin_inset Quotes eld
16981 \begin_inset Quotes erd
16984 introduced by other literate tool named Nuweb, which I used for many years
16985 before rendering myself to Noweb.
16990 Noweb delimits scraps like this:
16993 \begin_layout LyX-Code
16997 \begin_layout LyX-Code
17001 \begin_layout LyX-Code
17005 \begin_layout LyX-Code
17009 \begin_layout LyX-Code
17013 \begin_layout Standard
17014 The problem is that whatever is written in between the << and the
17018 must be taken literally, i.e., LyX should be prevented from making any special
17019 interpretation of what has been written.
17020 This is handled by a special layout named Scrap, that works like a normal
17021 paragraph but has a free spacing capability.
17024 \begin_layout Standard
17025 The down side of the Scrap paragraph layout is that consecutive paragraphs
17026 of code will be spaced with one empty line in the source code and also
17027 in the printed documentation.
17028 The work around is to enter each line of code within a single Scrap, with
17029 a newline (ctrl-return).
17030 The example above will look like this:
17034 \begin_layout Standard
17035 If you have a printed version of this document you will not see any difference
17036 between the previous example and this one.
17044 \begin_layout LyX-Code
17056 \begin_layout Standard
17057 This layout works fine.
17058 The only real inconvenience is that you have to type ctrl-return instead
17063 \begin_layout Standard
17064 It is in my list of
17065 \begin_inset Quotes eld
17069 \begin_inset Quotes erd
17080 \begin_layout Standard
17081 As a special note, you can also use the
17082 \begin_inset Quotes eld
17086 \begin_inset Quotes erd
17089 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17093 \begin_layout LyX-Code
17096 def some_function(args):
17098 "This is the doc string for this
17101 print "My args: ", args
17104 \begin_layout LyX-Code
17105 @ %def some_function
17108 \begin_layout Standard
17109 For an example of this usage and the resulting cross-reference output, look
17110 at the Literate python program in
17112 LIBDIR/examples/listerrors.lyx
17114 which should make this all clear.
17117 \begin_layout Paragraph
17118 Generating the documentation
17121 \begin_layout Standard
17122 At this point you already have a new document file with a proper document
17123 class, and with some code and text on it.
17124 How do I print it? The answer is simple, you select
17129 iew\SpecialChar \menuseparator
17137 Just like you would do for a plain document.
17138 No special procedure is required.
17141 \begin_layout Standard
17142 To help orientate you, I will now explain what happens inside LyX:
17145 \begin_layout Enumerate
17151 pdate\SpecialChar \menuseparator
17158 menu option is chosen, a LaTeX file is generated.
17163 \begin_layout Standard
17164 If the document is of any literate class the generated file will be named
17165 with an extension name defined by the
17166 \begin_inset Quotes eld
17170 \begin_inset Quotes erd
17173 format (defined in the Preferences panel), otherwise the file will have
17182 \begin_layout Enumerate
17183 Note that the only difference so far is in the name of the file, no special
17184 processing is required by LyX.
17185 Given that you formatted the code using the Scrap layout that, by itself,
17186 takes care of the business.
17189 \begin_layout Enumerate
17190 If the document is of any literate class LyX will then use the internal
17191 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17195 \begin_layout Standard
17196 The converters are defined in the
17201 ools\SpecialChar \menuseparator
17209 \begin_inset Quotes eld
17213 \begin_inset Quotes erd
17218 \begin_inset CommandInset ref
17220 reference "sub:converters"
17228 manual for general information about converters.
17233 to generate the LaTeX file.
17237 \begin_layout Standard
17238 Otherwise it will just skip this step.
17242 \begin_layout Enumerate
17243 Finally, LaTeX is invoked and the regular post processing continues as in
17247 \begin_layout Standard
17248 Independence from a particular
17249 \begin_inset Quotes eld
17253 \begin_inset Quotes erd
17256 is easily achieved by changing the commands that are run by the various
17260 \begin_layout Paragraph
17261 Generating the code
17264 \begin_layout Standard
17265 When the build menu option is chosen or the corresponding button in the
17266 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17267 Next, LyX invokes the
17272 This converter needs to be defined by the user and is not installed by
17273 default, though the Program format is.
17274 This converter (like any other converter) will have two parts:
17277 \begin_layout Enumerate
17278 The converter program itself.
17279 This program performs the conversion from the one format to the other (in
17280 this case, from the Noweb format to the Program pseudo-format).
17283 \begin_layout Enumerate
17284 The error log parser.
17285 This is a program whose sole purpose is to rewrite error messages in a
17286 format that LyX understands.
17287 This makes it possible for LyX to place error boxes in the right places
17288 in the file buffer.
17291 \begin_layout Standard
17292 The first part, the
17293 \begin_inset Quotes eld
17297 \begin_inset Quotes erd
17300 setting, should be set to
17301 \begin_inset Quotes eld
17309 \begin_inset Quotes erd
17313 This basically means that LyX will call
17314 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17321 (a program or script) with the name of the Noweb file (normally a file
17322 in the LyX temp directory).
17326 \begin_layout Standard
17327 This is an implementation of
17328 \begin_inset Quotes eld
17332 \begin_inset Quotes erd
17335 that you can place in a directory on your path:
17338 \begin_layout LyX-Code
17342 \begin_layout LyX-Code
17346 \begin_layout LyX-Code
17347 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17350 \begin_layout Standard
17351 The next part of the converter setting is the
17352 \begin_inset Quotes eld
17356 \begin_inset Quotes erd
17359 which is to be set to
17360 \begin_inset Quotes eld
17365 parselog=listerrors
17368 \begin_inset Quotes erd
17372 This will run any errors that are generated by the
17373 \begin_inset Quotes eld
17377 \begin_inset Quotes erd
17380 process through the
17381 \begin_inset Quotes eld
17385 \begin_inset Quotes erd
17391 \begin_layout Standard
17392 The converter code looks in
17400 then on the path for the
17401 \begin_inset Quotes eld
17405 \begin_inset Quotes erd
17411 \begin_layout Standard
17412 The build will normally take place in LyX's temporary directory, so the
17413 files produced by the conversion will be in that directory.
17414 LyX will copy out what it regards as the `main' file, but the
17418 conversion may produce several files, and so most of these would then be
17419 deleted when LyX was closed.
17420 The present solution is to use a `copier',
17424 \begin_layout Standard
17426 \begin_inset CommandInset ref
17428 reference "sec:converters-etc"
17436 manual for information on these.
17445 script in its default mode, so that the entire contents of the temporary
17446 directory is copied.
17447 More will get copied than is needed, to be sure, but nothing will be lost.
17448 If, however, you know what extensions the generated files will have, this
17449 can be improved by using the
17458 This option takes a comma-separated list of extensions to copy.
17459 So, for example, if the conversion will generate only files with the extensions
17468 , then the correct definition would be:
17471 \begin_layout LyX-Code
17472 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17475 \begin_layout Standard
17476 The result will be that only files with these two extensions will be copied
17480 \begin_layout Paragraph
17481 Build instructions in the document
17484 \begin_layout Standard
17485 The last piece of the integration between LyX and noweb is the
17486 \begin_inset Quotes eld
17490 \begin_inset Quotes erd
17494 Generally, the instructions for building your program should be embedded
17495 in a scrap of its own.
17497 \begin_inset Quotes eld
17501 \begin_inset Quotes erd
17504 above uses the notangle command to look for this scrap (called
17505 \begin_inset Quotes eld
17509 \begin_inset Quotes erd
17512 ) and runs its contents through
17513 \begin_inset Quotes eld
17517 \begin_inset Quotes erd
17523 \begin_layout Standard
17524 Typically, such a scrap would look something like this:
17527 \begin_layout LyX-Code
17534 if [ -z "${NOWEB_SOURCE}" ]
17538 NOWEB_SOURCE=myfile.nw
17544 code to extract files ...]
17547 code to compile files ...]
17552 \begin_layout Standard
17555 LIBDIR/examples/listerrors.lyx
17559 LIBDIR/examples/Literate.lyx
17561 which implement two versions of the
17562 \begin_inset Quotes eld
17566 \begin_inset Quotes erd
17569 program for some illustrations of how all of these pieces go together or
17572 LIBDIR/examples/noweb2lyx.lyx.
17575 Interestingly, these three files show off the language-indepence of the
17576 LyX literate programming support since they are written in Python, C and
17580 \begin_layout Subsubsection
17584 \begin_layout Standard
17585 All the Literate Programming support is configured by the
17590 ools\SpecialChar \menuseparator
17598 \begin_inset Quotes eld
17602 \begin_inset Quotes erd
17606 The important parts are:
17609 \begin_layout Description
17612 \begin_inset Quotes eld
17616 \begin_inset Quotes erd
17620 format Set up via the Formats tab, this is where the Noweb-specific pieces
17630 , the file extension is set to
17635 This tells LyX to create a file with a
17639 extension in the first step of the conversion process.
17642 \begin_layout Description
17649 format This is an empty format whose sole purpose is to be the endpoint
17650 of a conversion (which then allows us to set up a converter for it).
17653 \begin_layout Description
17662 This converter performs the
17663 \begin_inset Quotes eld
17667 \begin_inset Quotes erd
17670 of the literate document.
17671 For Noweb, it is set to
17672 \begin_inset Quotes eld
17677 noweave -delay -index $$i > $$o
17680 \begin_inset Quotes erd
17686 \begin_layout Description
17696 \begin_inset Quotes eld
17700 \begin_inset Quotes erd
17704 As stated above, the Converter is set to
17705 \begin_inset Quotes eld
17713 \begin_inset Quotes erd
17716 , with Flags set to
17717 \begin_inset Quotes eld
17722 originaldir,parselog=listerrors
17725 \begin_inset Quotes erd
17731 \begin_layout Subsubsection
17735 \begin_layout Standard
17736 There is also a new function implemented in the LyX server, the
17737 \begin_inset Quotes eld
17740 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17744 \begin_layout Standard
17745 When debugging code with ddd/gdb, it is possible to invoke a text editor
17746 at the current execution position with a single key stroke.
17747 The default ddd configuration for that is shift-ctrl-V.
17748 It happens that you can define the editor command line invocation in ddd
17754 dit\SpecialChar \menuseparator
17759 references\SpecialChar \menuseparator
17766 dialog and changing the "Edit Sources" entry.
17769 \begin_layout Standard
17770 I take advantage of the new created LyX server function and this ddd feature,
17772 \begin_inset Quotes eld
17776 \begin_inset Quotes erd
17782 \begin_layout LyX-Code
17783 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17786 \begin_layout Standard
17787 With this, whenever you are using ddd and find a point in the program that
17788 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17789 ddd you forward this information to LyX through the LyX server and then
17790 the LyX window will show the same file with the cursor at the same position
17791 ddd was pointing to.
17792 No more guessing or long scrolling to locate a point in the program back
17796 \begin_layout Standard
17797 Note however that you must enable the LyX server to get this feature working
17798 (it is disabled by default).
17799 You can enable it in
17811 ) by entering in the
17816 \begin_inset Quotes eld
17821 /home/<your-home-directory>/.lyx/lyxpipe
17824 \begin_inset Quotes erd
17830 \begin_layout Standard
17831 Read the LyX server documentation in the
17833 Customization Manual
17835 for further information.
17838 \begin_layout Subsubsection
17842 \begin_layout Standard
17843 There are six new buttons that can be added to your LyX toolbar.
17844 Five of these buttons are short cuts to layout styles:
17865 The last one is a short cut to the
17866 \begin_inset Quotes eld
17870 \begin_inset Quotes erd
17877 \begin_layout Standard
17878 LyX has a range of buttons that are available for tool bar customization.
17879 In my toolbar I like to combine the six short cuts above with two more:
17887 \SpecialChar \menuseparator
17895 \SpecialChar \menuseparator
17908 iew\SpecialChar \menuseparator
17916 Here is how it looks like:
17919 \begin_layout LyX-Code
17923 \begin_layout LyX-Code
17927 \begin_layout LyX-Code
17928 Icon "layout Standard"
17931 \begin_layout LyX-Code
17932 Icon "layout Section"
17935 \begin_layout LyX-Code
17936 Icon "layout LaTeX"
17939 \begin_layout LyX-Code
17940 Icon "layout LyX-Code"
17943 \begin_layout LyX-Code
17944 Icon "layout Scrap"
17947 \begin_layout LyX-Code
17951 \begin_layout LyX-Code
17955 \begin_layout LyX-Code
17956 Icon "buffer-typeset"
17959 \begin_layout LyX-Code
17960 Icon "build-program"
17963 \begin_layout LyX-Code
17967 \begin_layout LyX-Code
17971 \begin_layout LyX-Code
17975 \begin_layout LyX-Code
17979 \begin_layout LyX-Code
17983 \begin_layout Subsubsection
17984 Colors customization
17987 \begin_layout Standard
17988 There are a number of colors in LyX that can be customized in
17993 One of the things that bothers people is the LaTeX font color.
17994 The default color is red, since the scraps uses LaTeX font, and there is
17995 a lot of scraps in literate documents, you may get tired of seeing everything
17997 You can change it by going to the tabs
18006 \begin_layout Standard
18007 The next thing is the visible presence of the newline character in the screen.
18008 You can choose the color of this particular character and make it blend
18010 I recommend you choosing a color that is close to the background but not
18011 equal, that way you still can see it is there, but it is not bothering
18016 \begin_layout Chapter
18017 Secrets of the LaTeX Masters
18018 \begin_inset CommandInset label
18027 \begin_layout Standard
18028 Though LyX is a powerful tool, it cannot hope to support everything that
18029 can be done with pure TeX/LaTeX.
18030 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18031 as long as you are not afraid to use that
18032 \begin_inset Quotes eld
18036 \begin_inset Quotes erd
18039 button on the toolbar or add things to the LaTeX preamble.
18040 This section lists some tips, tricks, and otherwise cool ideas to give
18041 your document that extra little flair.
18044 Do try this at home
18046 , just start with something a little smaller and less important than your
18050 \begin_layout Standard
18051 Most ideas in this section require less common files in your LaTeX installation.
18052 If you have a system like teTeX, most will already be available.
18053 A few, however, will need to be downloaded from one of the CTAN archives.
18054 Often, there are several ways to do something, or several LaTeX style files
18055 which do the same thing.
18056 We do not endorse one choice over another, we simply claim that we have
18057 done a particular task with a particular file.
18058 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18061 \begin_layout Section
18065 \begin_layout Standard
18068 Lars Gullik Bjønnes
18071 \begin_layout Subsection
18075 \begin_layout Standard
18076 The aim for this chapter
18080 \begin_layout Standard
18081 Editor's note: Lars' original chapter was a masterful description of how
18087 However, it was too long to flow smoothly in this document.
18088 I have therefore chosen to excerpt the most important sections here (sorry,
18089 Lars); you can read the original chapter (and more of the story!) in the
18092 examples/multicol.lyx
18100 is to show how the LaTeX package
18104 can be used in a LyX document.
18105 As LyX doesn't support the
18109 package natively yet, we have to use some small hacks.
18110 By reading this section it should be obvious how to do this.
18113 \begin_layout Subsection
18117 \begin_layout Standard
18122 package allows switching between one and multicolumn format on the same
18124 Footnotes are handled correctly (for the most part), but will be placed
18125 at the bottom of the page and not under each column.
18126 LaTeX's float mechanism, however, is partly disabled in the current implementat
18128 At the moment only page-wide floats can be used within the scope of the
18132 \begin_layout Subsection
18136 \begin_layout Subsubsection
18140 \begin_layout Standard
18141 If you want to have two columns in your text, you have use LaTeX mode to
18146 begin{multicols}{2}
18148 at the point where you want the two column layout to start, and then
18154 where you want it to end.
18158 \begin_layout Standard
18162 \begin_layout Standard
18166 begin{multicols}{2}
18174 \begin_layout Standard
18179 The Adventure of the Empty House
18185 Sir Arthur Conan Doyle
18188 \begin_layout Standard
18191 It was in the spring of the year 1894 that all London was interested, and
18192 the fashionable world dismayed, by the murder of the Honourable Ronald
18193 Adair under most unusual and inexplicable circumstances.
18194 The public has already learned those particulars of the crime which came
18195 out in the police investigation, but a good deal was suppressed upon that
18196 occasion, since the case for the prosecution was so overwhelmingly strong
18197 that it was not necessary to bring forward all the facts.
18198 Only now, at the end of nearly ten years, am I allowed to supply those
18199 missing links which make up the whole of that remarkable chain.
18200 The crime was of interest in itself, but that interest was as nothing to
18201 me compared to the inconceivable sequel, which afforded me the greatest
18202 shock and surprise of any event in my adventurous life.
18203 Even now, after this long interval, I find myself thrilling as I think
18204 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18205 ty which utterly submerged my mind.
18206 Let me say to that public, which has shown some interest in those glimpses
18207 which I have occasionally given them of the thoughts and actions of a very
18208 remarkable man, that they are not to blame me if I have not shared my knowledge
18209 with them, for I should have considered it my first duty to do so, had
18210 I not been barred by a positive prohibition from his own lips, which was
18211 only withdrawn upon the third of last month.
18214 \begin_layout Standard
18218 \begin_layout Standard
18230 \begin_layout Subsubsection
18234 \begin_layout Standard
18235 The same pattern is used when you want more than two columns:
18238 \begin_layout Standard
18242 \begin_layout Standard
18246 begin{multicols}{3}
18254 \begin_layout Standard
18257 It can be imagined that my close intimacy with Sherlock Holmes had interested
18258 me deeply in crime, and that after his disappearance I never failed to
18259 read with care the various problems which came before the public.
18260 And I even attempted, more than once, for my own private satisfaction,
18261 to employ his methods in their solution, though with indifferent success.
18262 There was none, however, which appealed to me like this tragedy of Ronald
18264 As I read the evidence at the inquest, which led up to a verdict of willful
18265 murder against some person or persons unknown, I realized more clearly
18266 than I had ever done the loss which the community had sustained by the
18267 death of Sherlock Holmes.
18268 There were points about this strange business which would, I was sure,
18269 have specially appealed to him, and the efforts of the police would have
18270 been supplemented, or more probably anticipated, by the trained observation
18271 and the alert mind of the first criminal agent in Europe.
18272 All day, as I drove upon my round, I turned over the case in my mind and
18273 found no explanation which appeared to me to be adequate.
18274 At the risk of telling a twice-told tale, I will recapitulate the facts
18275 as they were known to the public at the conclusion of the inquest.
18278 \begin_layout Standard
18282 \begin_layout Standard
18294 \begin_layout Standard
18295 You can have more than 3 columns if you want to, but that might not be very
18296 pleasant for the eye.
18299 \begin_layout Subsubsection
18300 Columns inside columns
18303 \begin_layout Standard
18304 You can even have columns inside columns:
18307 \begin_layout Standard
18311 \begin_layout Standard
18315 begin{multicols}{2}
18323 \begin_layout Standard
18326 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18327 at that time governor of one of the Australian colonies.
18328 Adair's mother had returned from Australia to undergo the operation for
18329 cataract, and she, her son Ronald, and her daughter Hilda were living together
18333 \begin_layout Standard
18337 \begin_layout Standard
18341 begin{multicols}{2}
18349 \begin_layout Standard
18352 The youth moved in the best society--had, so far as was known, no enemies
18353 and no particular vices.
18354 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18355 had been broken off by mutual consent some months before, and there was
18356 no sign that it had left any very profound feeling behind it.
18357 For the rest {sic} the man's life moved in a narrow and conventional circle,
18358 for his habits were quiet and his nature unemotional.
18359 Yet it was upon this easy-going young aristocrat that death came, in most
18360 strange and unexpected form, between the hours of ten and eleven-twenty
18361 on the night of March 30, 1894.
18364 \begin_layout Standard
18368 \begin_layout Standard
18380 \begin_layout Standard
18383 Ronald Adair was fond of cards--playing continually, but never for such
18384 stakes as would hurt him.
18385 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18386 It was shown that, after dinner on the day of his death, he had played
18387 a rubber of whist at the latter club.
18388 He had also played there in the afternoon.
18393 The evidence of those who had played with him-- Mr.
18394 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18395 and that there was a fairly equal fall of the cards.
18396 Adair might have lost five pounds, but not more.
18397 His fortune was a considerable one, and such a loss could not in any way
18399 He had played nearly every day at one club or other, but he was a cautious
18400 player, and usually rose a winner.
18401 It came out in evidence that, in partnership with Colonel Moran, he had
18402 actually won as much as four hundred and twenty pounds in a sitting, some
18403 weeks before, from Godfrey Milner and Lord Balmoral.
18404 So much for his recent history as it came out at the inquest.
18407 \begin_layout Standard
18411 \begin_layout Standard
18423 \begin_layout Standard
18424 Please do read the file
18426 examples/multicol.lyx
18428 for more advanced examples including column and header spacing, vertical
18429 separator lines, and more.
18432 \begin_layout Section
18437 Paragraph Environment
18438 \begin_inset OptArg
18441 \begin_layout Standard
18442 Numbering in Enumerate
18450 \begin_layout Standard
18456 \begin_layout Standard
18457 \begin_inset VSpace bigskip
18463 \begin_layout Standard
18465 The default numbering for the
18469 paragraph environment begins with Arabic numbers and ends with uppercase
18471 Suppose, however, you wanted a different type of numbering scheme.
18472 Here's a quickie example of how to change the numbering scheme:
18475 \begin_layout LyX-Code
18485 \begin_layout LyX-Code
18495 \begin_layout LyX-Code
18505 \begin_layout LyX-Code
18515 \begin_layout Standard
18516 \SpecialChar \ldots{}
18517 which changes the numbering scheme to uppercase Roman numerals, uppercase
18518 letters, Arabic numbers, and lowercase letter.
18521 \begin_layout Standard
18522 Additionally, the previous example also adds a little bit extra to the numbering
18524 For example, the first level label actually looks like:
18525 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18533 For ease of reading, we'll describe what the numbering schemes look like
18534 using a notation something like this: <
18535 \begin_inset Quotes eld
18539 \begin_inset Quotes erd
18544 \begin_inset Quotes erd
18548 \begin_inset Quotes erd
18553 \begin_inset Quotes erd
18557 \begin_inset Quotes erd
18562 \begin_inset Quotes eld
18566 \begin_inset Quotes erd
18573 \begin_layout Standard
18574 As you can see in the example, there is a label command for each nesting
18581 \SpecialChar \ldots{}
18588 , as well as a counter,
18592 \SpecialChar \ldots{}
18598 There are also five
18599 \begin_inset Quotes eld
18603 \begin_inset Quotes erd
18636 , each of which take one counter as an argument.
18637 You can add characters before or after these, but there's no need to add
18641 \begin_layout Standard
18642 You can get really fancy with these.
18646 \begin_layout LyX-Code
18660 \begin_layout LyX-Code
18672 \begin_layout LyX-Code
18682 \begin_layout LyX-Code
18692 \begin_layout Standard
18693 produces the somewhat out of hand numbering scheme: <
18694 \begin_inset Quotes eld
18698 \begin_inset Quotes erd
18703 \begin_inset Quotes erd
18707 \begin_inset Quotes erd
18712 \begin_inset Quotes erd
18716 \begin_inset Quotes erd
18721 \begin_inset Quotes eld
18725 \begin_inset Quotes erd
18732 \begin_layout Standard
18736 \begin_layout Section
18740 \begin_layout Standard
18746 \begin_layout Standard
18747 \begin_inset VSpace bigskip
18753 \begin_layout Standard
18758 \begin_layout Standard
18764 tmpfont}{cmr17 scaled 2500}{
18776 \begin_layout Standard
18781 \begin_layout Standard
18792 hose of you who like the style of old books probably also like
18793 \begin_inset Quotes eld
18797 \begin_inset Quotes erd
18800 ---those large capital letters which begin each new chapter or section.
18801 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18802 know some plain TeX!) but does require a lot of work and many iterations,
18803 as you can see by all the ugly TeX-mode stuff at the beginning of this
18807 \begin_layout Standard
18811 \begin_layout Standard
18817 bigdrop{-1em}{3}{ptmri}{T}+
18822 here is a much easier way of doing this, of course.
18831 ) package from CTAN allows a simple way to add such letters to your documents.
18832 Since this package is not a standard part of teTeX, I can't demonstrate
18833 it within this document, but if you copy this paragraph to a new document,
18835 \begin_inset Quotes eld
18845 \begin_inset Quotes erd
18848 and the pluses from the TeX code at the beginning of the paragraph, and
18853 usepackage{dropcaps}
18855 to your LaTeX preamble, you will get a nice Times Roman Italic
18856 \begin_inset Quotes eld
18860 \begin_inset Quotes erd
18863 , whose height is three lines of text and which protrudes 1 em into the
18865 (Make certain you have copied
18866 \begin_inset Quotes eld
18874 \begin_inset Quotes erd
18877 into a directory where TeX can see it.) The first argument is the amount
18878 of indentation; in this case the negative sign moves it into the margin.
18879 The second argument is the height of the letter in number of lines of text.
18880 The third argument is the font name: virtually anything which has a tfm
18881 file should work (wade through the
18883 .../texmf/fonts/tfm
18885 directory for possibilities).
18886 My personal favorite is
18887 \begin_inset Quotes eld
18895 \begin_inset Quotes erd
18898 , a fancy German font specifically designed for dropped capitals.
18899 The fourth argument is the letter (or letters) to be dropped.
18904 package also offers the
18910 command, as well as a slightly simplified
18919 \begin_layout Section
18920 Non-standard Paragraph Shapes
18923 \begin_layout Standard
18929 \begin_layout Standard
18930 \begin_inset VSpace bigskip
18936 \begin_layout Standard
18940 \begin_layout Standard
18952 \begin_layout Standard
18956 \begin_layout Standard
18965 \begin_layout Standard
18979 \begin_layout Standard
18984 \begin_layout Standard
18995 \begin_layout Standard
19004 \begin_layout Standard
19013 \begin_layout Standard
19022 \begin_layout Standard
19031 \begin_layout Standard
19040 \begin_layout Standard
19049 \begin_layout Standard
19058 \begin_layout Standard
19067 \begin_layout Standard
19076 \begin_layout Standard
19085 \begin_layout Standard
19094 \begin_layout Standard
19103 \begin_layout Standard
19112 \begin_layout Standard
19121 \begin_layout Standard
19130 \begin_layout Standard
19139 \begin_layout Standard
19148 \begin_layout Standard
19157 \begin_layout Standard
19163 There are times when the tyranny of rectangular paragraphs must be overthrown.
19164 In such situations, a call to the delightful plain TeX command
19171 As you can see, completely arbitrary shapes can be laid out with a suitable
19172 set of linelength definitions.
19173 While this parshape may look a bit silly and useless, one could conceive
19174 of situations such as finely tuned dropped capitals, word wrapping around
19175 non-rectangular graphics, etc.
19176 which will benefit from such handcrafting.
19179 \begin_layout Standard
19180 \begin_inset VSpace bigskip
19186 \begin_layout Standard
19191 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19198 is the number of lines of text which define the paragraph.
19199 If there turn out to be fewer lines, the shape is truncated; if there are
19200 more, the excess lines have the same dimensions as the last line of the
19210 entries specify the indentation of the line from the left margin, and the
19211 length of the line as measured from that point.
19212 The shape applies only to the current paragraph; everything is reset to
19213 normal for the next paragraph.
19216 \begin_layout Standard
19220 \begin_layout Standard
19232 \begin_layout Section
19236 \begin_layout Standard
19237 As you can see, the examples in this section range from the useful to the
19239 While I don't expect that anyone will ever need the paragraph shape demonstrate
19240 d in the last section, the important point is that you can do almost anything
19241 you want in LyX if you are willing to figure out how to do it in TeX and
19243 TeX is a fantastically powerful typesetting system and all that power is
19244 available to you since LyX uses it as its backend.