1 #LyX 1.5.3svn 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\@}
51 \font_typewriter default
52 \font_default_family default
58 \paperfontsize default
66 \paperorientation portrait
69 \paragraph_separation indent
71 \quotes_language english
74 \paperpagestyle headings
75 \tracking_changes false
92 \begin_layout Standard
94 Principal maintainer of this file is
99 If you have comments or error corrections, please send them to the LyX
100 Documentation mailing list, <lyx-docs@lists.lyx.org>.
108 \begin_layout Standard
109 \begin_inset LatexCommand tableofcontents
116 \begin_layout Chapter
120 \begin_layout Standard
123 Extended LyX Features
125 manual, which you are now reading, is essentially Part II of the
127 User's Guide\SpecialChar \@.
130 The reason for splitting this document is simple: the
134 is already huge, and it contains all of the basic features one needs to
135 know in order to prepare most documents.
136 However, the LyX Team has a long-term goal of making LyX extensible through
137 various configuration files and external packages.
138 That means that if you want to support the Fizzwizzle LaTeX package, you
139 can create a layout file for it without having to alter LyX itself.
140 We've already had contributions of several new features this way.
141 This is the place where all of that gets documented.
144 \begin_layout Standard
145 This manual also documents some special features, like fax support, version
146 control, and SGML support, which require additional software to work properly.
147 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
148 spruce up your documents by directly using the powerful features of LaTeX.
153 only WYSIWYM, and will only ever interface to certain LaTeX features.
156 \begin_layout Standard
157 Of course, with all of this extra documentation,
159 Extended LyX Features
161 may itself grow too big for its britches.
162 In that case, you can just call it the
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
173 \begin_layout Standard
174 If you haven't read the
178 yet, you are definitely in the wrong manual.
183 is the first place to go, since it will direct you to the correct manual,
184 and it also describes the notation and format of all of the manuals.
185 You should also be thoroughly familiar with the
189 and all of the basic features of LyX.
193 \begin_layout Standard
194 In this document, many sections are independent articles contributed by
195 an individual and are noted as such.
196 This person is generally whoever wrote the layout file for the new document
197 class or LaTeX package, or implemented the feature.
198 If there is no mention of an author to a chapter [or chapter sections],
199 that means it was written by the LyX Documentation Team.
202 \begin_layout Standard
203 Since all the topics in this manual depend heavily on LyX's interaction
204 with LaTeX, this first chapter covers the inner workings of LyX and how
205 to direct LyX to generate exactly the LaTeX code you want.
206 It is obviously for more seasoned LyX users.
209 \begin_layout Chapter
213 \begin_layout Section
217 \begin_layout Standard
218 \begin_inset LatexCommand label
219 name "sec:lyxandlatex"
223 This chapter is for both TeX-nicians and the LaTeX-curious.
224 In it, we'll explain how LyX and LaTeX work together to produce printable
226 This is the only place in any of the manuals where we assume you know something
230 \begin_layout Standard
231 At one time, we called LyX a
232 \begin_inset Quotes eld
235 WYSIWYM frontend to LaTeX,
236 \begin_inset Quotes erd
239 but that's no longer true.
240 There are frontends to LaTeX out there.
241 They are basically editors with the ability to run LaTeX and mark any errors
242 in the file you're editing.
251 run LaTeX, and it also marks errors in the file, it also does much, much
253 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
254 LyX has also added a few extensions to LaTeX.
255 Try the following sometime: select
257 Export\SpecialChar \menuseparator
267 menu, then look at the preamble of the resulting
272 You'll notice a variety of new macros defined specifically by LyX.
273 These macros are defined automatically, according to the features you use
277 \begin_layout Standard
278 There are several commands that automatically invoke LaTeX.
282 \begin_layout Itemize
288 iew\SpecialChar \menuseparator
295 \begin_layout Itemize
301 iew\SpecialChar \menuseparator
306 pdate\SpecialChar \menuseparator
312 \begin_layout Itemize
320 \SpecialChar \menuseparator
326 \begin_layout Itemize
334 \SpecialChar \menuseparator
340 \begin_layout Standard
341 They will only invoke LaTeX if the file has changed since the last time
346 \begin_layout Standard
347 When you run LaTeX on the file you're editing, LyX performs these steps:
350 \begin_layout Enumerate
351 Convert the document to LaTeX and save to a file with the extension
362 \begin_layout Enumerate
367 file (maybe several times).
370 \begin_layout Enumerate
371 If there are any errors, insert error boxes in the document to mark where
373 These boxes are transient and are not saved along with the document.
376 \begin_layout Standard
377 If you've run LaTeX using
399 , LyX performs two more steps:
402 \begin_layout Itemize
407 to convert the DVI file to PostScript:
411 \begin_layout Itemize
417 , the output file has the extension
422 \begin_layout Itemize
431 , the output file has the extension
439 \begin_layout Itemize
444 or send the PostScript file to the printer.
447 \begin_layout Section
448 \begin_inset Quotes eld
451 Help! LyX generated an unreadable
456 \begin_inset Quotes erd
462 \begin_layout Standard
463 Die-hard LaTeX users will scream and howl this into the night, then declare
464 LyX useless, simply because they didn't RTFM.
467 \begin_layout Standard
468 We're going to set the record straight.
469 LyX produces two kinds of LaTeX files.
470 One is human readable.
471 The other is LyX readable.
472 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
478 file is not human readable.
479 Don't even try to read it.
484 file that you can send to a colleague, select
489 xport\SpecialChar \menuseparator
506 \begin_layout Section
507 Translating LaTeX files into LyX
508 \begin_inset LatexCommand label
509 name "sec:Translating-LaTeX-files"
516 \begin_layout Standard
517 You can import a LaTeX file into LyX by using the
522 ile\SpecialChar \menuseparator
527 mport\SpecialChar \menuseparator
535 This will call a program named
539 ---which will create a file
547 ---and then open that file.
550 \begin_layout Standard
555 will translate most legal LaTeX, but not everything.
556 It will leave things it doesn't understand in TeX mode, so after translating
561 , you can look for red text and hand-edit it to look right.
564 \begin_layout Standard
565 If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
567 \begin_inset LatexCommand ref
568 reference "sec:latexcodes"
575 \begin_layout Section
576 Inserting LaTeX Code into LyX Documents
577 \begin_inset LatexCommand label
578 name "sec:Inserting-LaTeX-Code"
585 \begin_layout Standard
586 \begin_inset LatexCommand label
587 name "sec:latexcodes"
591 This is a rather important point: You can always insert LaTeX code into
593 LyX simply cannot, and will probably never be able to, display every possible
595 If ever you need to insert LaTeX commands into your LyX document, you can
596 use the ERT box, which you can insert into your document with
601 nsert\SpecialChar \menuseparator
609 The ERT box comes in three forms: collapsed, open, and inlined.
610 The first two are used just like any other collapsible (foldable) box (such
611 as footnotes), and are useful for significant amounts of LaTeX commands.
613 \begin_inset Quotes eld
617 \begin_inset Quotes erd
620 ERT box displays its content as part of the button, and is useful for very
621 short sections of LaTeX commands.
626 \begin_layout Standard
636 \begin_layout Standard
637 You can switch between all three by right-clicking on the ERT.
638 Note that if you want more than one line of LaTeX commands, you cannot
639 use the inlined mode.
642 \begin_layout Standard
643 Here's an example of inserting LaTeX commands in a LyX document.
644 The code looks like this:
647 \begin_layout LyX-Code
656 This is an example for a minipage environment.
659 can put nearly everything in it, even (non-floating)
702 \begin_layout LyX-Code
706 \begin_layout Standard
707 The ERT box containing this text is directly after this paragraph.
708 Those of you reading the manual online will only see a bunch of funky text
710 Those reading a printed version of the manuals will see the actual results:
713 \begin_layout Standard
717 \begin_layout Standard
724 \begin_layout Standard
731 \begin_layout Standard
733 This is an example for a minipage environment.
734 You can put nearly everything in it, even (non-floating) figures and tables.
738 \begin_layout Standard
745 \begin_layout Standard
750 \begin_layout Standard
757 \begin_layout Standard
764 \begin_layout Standard
771 \begin_layout Standard
777 \begin_layout Standard
784 \begin_layout Standard
791 \begin_layout Standard
798 \begin_layout Standard
810 \begin_layout Standard
811 In addition to these two methods, you can also create a separate file containing
812 some complex LaTeX structure.
818 nsert\SpecialChar \menuseparator
826 to include your file (you should select the type
831 We recommend that you only do this if you have a
840 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
844 \begin_layout Standard
845 There are a few last notes to emphasize:
848 \begin_layout Itemize
849 Inside of LyX, LaTeX code appears
854 \begin_layout Itemize
859 check if your LaTeX code is correct.
862 \begin_layout Itemize
863 Beware reinventing the wheel.
866 \begin_layout Standard
867 That last note refers to two things.
868 First, LyX does have quite a few features tucked into it, and more are
870 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
871 feature before you go off merrily coding LaTeX.
872 Second, there are numerous LaTeX packages out there to do all sorts of
873 things, from labels to envelopes to fancy multipage tables.
874 Check out a CTAN site for details (see Section
875 \begin_inset Quotes eld
879 \begin_inset Quotes erd
890 \begin_layout Standard
895 : I seem to do this an awful lot.
896 Sat down and merrily began coding something to print out labels, only to
897 learn that there were already 2 different LaTeX packages to do this.
898 Worse yet --- I had them already!
906 \begin_layout Standard
907 If you do need to do some wild and fancy things within your document, be
908 sure to check out a good LaTeX book for assistance.
909 There are a number of them listed in the bibliography of the
916 \begin_layout Standard
917 There are a number of LaTeX commands which have to be placed before the
918 beginning of the actual text.
919 They go into the preamble, and this is explained in the next section.
922 \begin_layout Section
923 LyX and the LaTeX Preamble
926 \begin_layout Subsection
927 About the LaTeX Preamble
930 \begin_layout Standard
931 \begin_inset LatexCommand label
936 If you already know LaTeX, there is no need to explain here what the preamble
938 If you don't, the following will give you some ideas --- we recommend again
939 that you consult a LaTeX book for further information.
940 In any case, you should read the points below, because they explain what
941 you can do and what you don't need to do in the LaTeX preamble of a LyX
945 \begin_layout Standard
946 The LaTeX preamble comes at the very beginning of a document,
954 \begin_layout Itemize
955 declare the document class.
956 LyX already does this for you.
960 \begin_layout Standard
961 If you're a seasoned LaTeX-nician, and you have some custom document class
962 you want to use, check out the
966 for information on how to make LyX interface to it.
967 Be sure to submit your efforts to the LyX Team for inclusion in future
972 \begin_layout Itemize
973 declare the usage of packages.
974 LaTeX packages provide special commands, which are only available within
975 a document when the package has been declared in the preamble.
976 For example, the package
980 forces all paragraphs to be indented.
981 There are other packages for labels, envelopes, margins, etc.
985 \begin_layout Itemize
986 set counters, variables, lengths and widths.
987 There are several LaTeX counters and variables which
991 be set globally from within the preamble in order to have the desired effect.
992 [There are other variables which you can set and reset inside the document,
993 too.] Margins are a good example of something which must be set in the preamble.
994 Another example is the label format for lists.
995 You can actually set these just about anywhere, but it's best to do it
996 just once, inside the preamble.
999 \begin_layout Itemize
1000 declare user defined commands [with
1012 ], mostly abbreviations for LaTeX commands which appear very often inside
1014 Although the preamble is a good place to declare such commands, they
1018 be declared anywhere else [but
1022 they are used for the first time, of course\SpecialChar \ldots{}
1024 This can be useful if there is a lot of raw LaTeX code in your document,
1025 which normally should not be the case.
1028 \begin_layout Standard
1029 LyX adds its own set of definitions to the preamble of the
1034 This makes LaTeX files generated by LyX portable.
1037 \begin_layout Subsection
1038 Changing the Preamble
1041 \begin_layout Standard
1042 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1043 can't change them without patching LyX itself.
1044 You can, however, add your own stuff to the preamble.
1045 There are two ways to do this:
1048 \begin_layout Enumerate
1075 \SpecialChar \menuseparator
1083 dialog, depending on your frontend.
1084 Note that the LyX keybindings will not work in this dialog, alas.
1087 \begin_layout Enumerate
1088 Use the preamble contents you've added as your default template (see
1089 \begin_inset Quotes eld
1093 \begin_inset Quotes erd
1100 ), so that it will be the default preamble for any file you create.
1103 \begin_layout Standard
1104 LyX adds anything in the
1111 dialog to its own built-in preamble.
1112 Before adding your own declarations in the preamble, you should make sure
1113 that LyX doesn't already support what you want to do (remember what we
1114 said about reinventing the wheel?).
1117 make sure your preamble code is correct
1120 LyX doesn't check it.
1123 \begin_layout Subsection
1127 \begin_layout Standard
1128 Here are some examples of what you can add to a preamble, and what they
1132 \begin_layout Subsubsection
1136 \begin_layout Standard
1137 There are two variables under LaTeX that control page position:
1150 Their names should be self-explanatory.
1151 These variables are useful if you think for a moment about computer labels.
1152 Sometimes, the size of a print medium and the area of the medium that you
1153 can actually print on aren't the same.
1169 \begin_layout Standard
1170 The default values for
1182 are both 0 pt.,\InsetSpace ~
1185 the page isn't shifted.
1188 \begin_layout Standard
1189 Unfortunately, some DVI drivers always seem to shift the page.
1190 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1191 If you're using LyX on a system that you don't personally maintain, and
1192 your sysadmin is a doofus,
1205 Suppose you're left and top margins are always 0.5 inches too big.
1206 You can add this to the preamble:
1209 \begin_layout LyX-Code
1217 \begin_layout LyX-Code
1225 \begin_layout Standard
1226 \SpecialChar \ldots{}
1227 and your margins should now be correct.
1230 \begin_layout Subsubsection
1234 \begin_layout Standard
1235 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1236 There's a rather nice package, available at your nearest CTAN archive,
1237 for printing sheets of labels, called
1242 Now, your system may not have this package installed by default.
1243 We leave that up to you to check.
1244 You'll also want to read the documentation for it; we're not going to do
1246 Since this is an example, however, we'll give you an example of how you
1250 \begin_layout Standard
1251 First, make sure you're using the
1256 Next, you need to put the following in your preamble:
1259 \begin_layout LyX-Code
1265 \begin_layout LyX-Code
1271 \begin_layout LyX-Code
1277 \begin_layout LyX-Code
1283 \begin_layout LyX-Code
1289 \begin_layout LyX-Code
1295 \begin_layout LyX-Code
1301 \begin_layout Standard
1302 This sets things up for Avery® label sheets, stock #5360.
1303 You're now ready to print labels, but you'll need to insert LaTeX code,
1304 placing the commands
1316 around each label text.
1317 This and other special features of
1321 are explained in its documentation.
1324 \begin_layout Standard
1325 Someday, someone may write a LyX layout file to support this package directly.
1326 Maybe that someone is you.
1329 \begin_layout Subsubsection
1330 Example #3: Paragraph Indentation
1333 \begin_layout Standard
1334 Americans are trained to indent the first line of
1339 As with all of their other weird quirks, most Americans will whine and
1340 moan until they can have their way and indent the first line of all paragraphs.
1344 \begin_layout Standard
1349 : This was written by an American ---
1353 ! It's my perception of my fellow countrymen.
1354 Tough if you don't like it.
1363 \begin_layout Standard
1364 Of course, this behavior isn't standard typography.
1365 In books, you typically only indent the first line of a paragraph
1369 it follows another one.
1370 The idea behind indenting the first line of a paragraph is to distinguish
1371 neighboring paragraphs from one another.
1372 If there is no previous paragraph, for example, it follows a figure, or
1373 is the first paragraph in a section, then there is no special indentation.
1377 \begin_layout Standard
1378 If you're a typical American, though, you don't care about such esoteric
1379 things; you want your indentation! Add this to the preamble:
1382 \begin_layout LyX-Code
1385 usepackage{indentfirst}
1388 \begin_layout Standard
1389 If your TeX distribution isn't a braindead one, you'll have this package,
1390 and all of your paragraphs will get the indentation you think they deserve.
1393 \begin_layout Subsubsection
1394 Example #4: This Document
1397 \begin_layout Standard
1398 You can also check out the preamble of this document to get an idea of some
1399 of the advanced things you can do.
1400 You'll probably need to make the
1405 reamble\SpecialChar \ldots{}
1408 dialog full-screen to see most of it.
1409 Also, there are more examples and an assortment of LaTeX
1410 \begin_inset Quotes eld
1414 \begin_inset Quotes erd
1417 given in Chapter\InsetSpace ~
1419 \begin_inset LatexCommand ref
1420 reference "cha:secrets"
1428 \begin_layout Section
1429 LyX and LaTeX Errors
1432 \begin_layout Standard
1433 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1435 It then uses the log-file from the LaTeX run to do a post-mortem.
1436 As we stated earlier in the chapter, LyX generates two kinds of
1440 files, one of which it uses to locate errors in the document.
1441 If there was an error someplace, LyX will put a box with the word
1442 \begin_inset Quotes eld
1446 \begin_inset Quotes erd
1449 at the appropriate place in the document.
1453 \begin_layout Standard
1454 LyX will occasionally misguess where the error was.
1455 This will typically happen with tables, figures, math, and the preamble.
1460 It will also display a message alerting you to the fact that there were
1464 \begin_layout Standard
1465 You can navigate through the errors by using
1481 \begin_inset Quotes eld
1485 \begin_inset Quotes erd
1488 the error-boxes and view the error message LaTeX produced by clicking on
1492 \begin_layout Standard
1493 Some folks also like to look at the log file directly, accessible from
1498 ocument\SpecialChar \menuseparator
1508 There are some fairly common error messages and warnings.
1509 We'll cover those here.
1510 You should look at a good LaTeX book for a complete listing.
1513 \begin_layout Itemize
1514 \begin_inset Quotes eld
1522 \begin_inset Quotes eld
1529 \begin_layout Standard
1530 Anything beginning with these word is a warning message for the purpose
1532 \begin_inset Quotes eld
1536 \begin_inset Quotes erd
1539 the LaTeX code itself.
1540 You'll get messages like this if you added or changed cross-references
1541 or bibliography entries, in which case, LaTeX is trying to tell you that
1542 you need to make another run.
1545 \begin_layout Standard
1546 You can by-and-large ignore these.
1550 \begin_layout Itemize
1551 \begin_inset Quotes eld
1559 \begin_inset Quotes erd
1566 \begin_layout Standard
1567 Another warning message, this time about fonts which LaTeX couldn't find.
1568 The rest of the message will often say something about a replacement font
1572 \begin_layout Standard
1573 You can safely ignore these.
1577 \begin_layout Itemize
1578 \begin_inset Quotes eld
1588 \begin_inset Quotes erd
1595 \begin_layout Standard
1601 They are warning you about lines that were too long and run past the right
1603 Almost always, this is unnoticeable in the final output.
1604 Or, only one or two characters extend past the margin.
1605 LaTeX seems to generate at least one of these messages for just about any
1609 \begin_layout Standard
1610 You can ignore these stupid messages.
1611 Your eyes will tell you if there's a problem with something that's too
1612 wide; just look at the output.
1616 \begin_layout Itemize
1617 \begin_inset Quotes eld
1627 \begin_inset Quotes erd
1634 \begin_layout Standard
1635 Not quite as common as its cousin.
1636 LaTeX seems to like to print lines that are a bit too wide as opposed to
1637 ones that are a bit too narrow.
1638 We have no idea why.
1641 \begin_layout Standard
1642 You can ignore these, too.
1646 \begin_layout Itemize
1647 \begin_inset Quotes eld
1657 \begin_inset Quotes erd
1661 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1678 \begin_layout Standard
1679 Warnings about troubles breaking the page.
1680 Once again, just look at the output.
1681 Your eyes will tell you where something has gone wrong.
1685 \begin_layout Itemize
1686 \begin_inset Quotes eld
1692 \begin_inset Quotes els
1696 \begin_inset Quotes ers
1702 \begin_inset Quotes erd
1709 \begin_layout Standard
1711 \begin_inset Quotes eld
1715 \begin_inset Quotes erd
1718 isn't installed on this system.
1719 This usually appears because some package your document needs isn't installed.
1720 If you didn't touch the preamble or didn't use the
1726 command, then one of the packages LyX tried to load is missing.
1732 elp\SpecialChar \menuseparator
1739 , to get a list of packages that LyX knows about.
1740 This file is updated whenever you reconfigure LyX (using
1747 \SpecialChar \menuseparator
1752 ) and tells you which packages have been detected and what they do.
1755 \begin_layout Standard
1766 command, and the package in question isn't installed, you'll need to install
1771 \begin_layout Itemize
1772 \begin_inset Quotes eld
1777 LaTeX Error: Unknown option
1780 \begin_inset Quotes erd
1787 \begin_layout Standard
1788 Error messages beginning with this are trying to tell you that you specified
1789 a bad or undefined option to a package.
1790 Check the package's documentation.
1794 \begin_layout Itemize
1795 \begin_inset Quotes eld
1800 Undefined control sequence
1803 \begin_inset Quotes erd
1810 \begin_layout Standard
1811 If you've inserted LaTeX code into your document, but made a typo, you'll
1813 You may have forgotten to load a package.
1814 In any case, this error message usually means that you used an undefined
1819 \begin_layout Standard
1820 There are other error and warning messages.
1821 Some are self-explanatory.
1822 These are usually LaTeX messages.
1823 Others are downright cryptic.
1824 These are actually TeX error messages, and we really have
1828 what they mean or how to decipher them.
1831 \begin_layout Standard
1832 There's a general sequence you should follow if you get error messages:
1835 \begin_layout Enumerate
1836 Look at the LaTeX code you inserted for typos.
1839 \begin_layout Enumerate
1840 If there are no typos, check and see that you used the command(s) correctly.
1843 \begin_layout Enumerate
1844 If you get a bunch of error boxes piled up at the very top of the document,
1845 it means that there are errors in the preamble.
1846 Start debugging your preamble.
1849 \begin_layout Enumerate
1850 If you didn't add anything to the preamble and didn't add any LaTeX code
1851 to the document, the first suspect is your LaTeX distribution itself.
1852 Check for missing packages and install them.
1855 \begin_layout Enumerate
1856 Okay, so there are no missing packages.
1857 Did you use any of the fine-tuning options in LyX? Specifically, did you
1862 any of them, like trying to manually insert lots of
1864 Protected\InsetSpace ~
1875 s? Did you try to kludge something together with these instead of using
1876 the appropriate paragraph environment?
1879 \begin_layout Enumerate
1880 All right, you didn't use any of the fine-tuning options, you played by
1882 Did you try to pull a fancy maneuver? Did you do something funky inside
1883 a table or an equation, like inserting a graphic into a table cell?
1886 \begin_layout Enumerate
1887 Do you have long sections of text where LaTeX cannot find a place to break
1888 a line? By default, LaTeX is rather strict about how much extra inter-word
1889 spacing it will add in order to break a line.
1890 Preferably, you should rework the paragraph to avoid the problem.
1891 If this isn't an option, you can wrap your text in
1897 to make LaTeX's line breaking more, well, sloppy.
1900 \begin_layout Enumerate
1901 Did you go overboard with the nesting? LyX (currently) doesn't check to
1902 make sure you're in the limits for nesting environments.
1903 If you nested a bunch of environments to the
1904 \begin_inset Formula $17^{\mathrm{th}}$
1907 level, that's the problem.
1910 \begin_layout Enumerate
1911 Okay, you didn't get any error messages, but your output looks whacked.
1912 If you have a table or figure that's too wide or long for the page, you
1917 \begin_layout Enumerate
1918 rescale the figure so it fits.
1921 \begin_layout Enumerate
1922 trim down the table so it fits.
1925 \begin_layout Standard
1926 If something else is wrong with the output, and you didn't try to pull anything
1927 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1931 \begin_layout Standard
1932 If all this doesn't help --- well, then
1936 you might have found a bug in LyX\SpecialChar \ldots{}
1940 \begin_layout Chapter
1944 \begin_layout Section
1945 Preparing a Bibliography with BibTeX
1946 \begin_inset LatexCommand label
1947 name "sec:Preparing-a-Bibliography"
1954 \begin_layout Standard
1961 Jürgen Spitzmüller
1964 \begin_layout Standard
1965 \begin_inset VSpace bigskip
1971 \begin_layout Standard
1973 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1976 e.\InsetSpace \thinspace{}
1980 setting up your own bibliographic databases),
1984 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1986 LaTeX: A Document Preparation System
1988 , particularly Appendix B.
1989 The rest of this discussion assumes you have created a correct bibliography
1990 file, that you have all relevant environment variables set correctly (esp.
2003 ), and that if sufficiently desperate, you could create and
2004 \begin_inset Quotes eld
2008 \begin_inset Quotes erd
2011 a LaTeX file with a BibTeX database.
2015 \begin_layout Standard
2016 For those who don't know what BibTeX is, it is a system for creating a large
2017 database of your most used journal references.
2018 For all future articles you write, you only need to include this standard
2019 database and reference the appropriate key to each reference.
2020 Even if you write only a few papers with handful of references each, it
2021 is well worth your time to examine BibTeX and decide whether it will be
2025 \begin_layout Standard
2026 To use BibTeX with LyX, first read the
2030 where it describes how to insert citations.
2031 The basic mechanism for inserting BibTeX references is the same.
2032 Then, at the very end of your document, select
2034 Insert\SpecialChar \menuseparator
2039 TOC\SpecialChar \menuseparator
2043 In the resulting dialog, fill out the dialog boxes as follows:
2046 \begin_layout Description
2047 Database: enter the name of your
2060 For searching multiple
2064 files, just enter them in the desired order, separated by commas.
2068 \begin_layout Description
2069 Style: enter the name of your BibTeX style file *without* the
2074 The default style is
2078 (which should be included in your LaTeX distribution, so you don't have
2079 to worry about creating it).
2082 \begin_layout Standard
2083 For each citation, assuming that the source is in the
2092 nsert\SpecialChar \menuseparator
2099 at the correct location in the text, and enter the appropriate reference
2101 Nothing else is required; when invoking
2106 iew\SpecialChar \menuseparator
2113 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2114 including multiple invocations of LaTeX.
2118 \begin_layout Subsection
2119 Alternative Citation Styles
2122 \begin_layout Standard
2123 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2124 g.\InsetSpace \space{}
2126 \begin_inset Quotes eld
2130 \begin_inset Quotes erd
2133 ) to refer to a cited work.
2134 However, in many scientific disciplines, other citation styles are in use.
2135 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2136 g.\InsetSpace \space{}
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2146 LyX supports two packages that provide this style,
2155 Both packages have their own pros and cons, which cannot be listed in detail.
2156 If you only want to have simple author-year (or author-numerical) style
2157 or if you want to use one of the countless style files for natbib, than
2162 package is probably your choice.
2163 If you need special features like short title references, ibidem etc., you
2164 might consider the fairly new
2171 \begin_layout Standard
2172 The handling of both packages in LyX is basically the same.
2178 ocument\SpecialChar \menuseparator
2189 pane (with the xforms frontend: the
2203 With both packages, you will get some extra features in the citation dialog
2204 and you can select the style of the reference (
2205 \begin_inset Quotes eld
2209 \begin_inset Quotes erd
2213 \begin_inset Quotes eld
2217 \begin_inset Quotes erd
2221 \begin_inset Quotes eld
2225 \begin_inset Quotes erd
2229 \begin_inset Quotes eld
2233 \begin_inset Quotes erd
2237 Note that both packages need specifically designed style files (they both
2238 ship their own, while there are lots of additional style files and even
2239 an interactive style file builder
2243 \begin_layout Standard
2245 \begin_inset LatexCommand url
2246 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2262 \begin_layout Subsection
2263 Sectionated Bibliographies
2264 \begin_inset LatexCommand label
2265 name "sub:Sectionated-Bibliographies"
2272 \begin_layout Standard
2273 Sometimes you might need to divide your bibliography into several sections.
2274 If you are, for instance, a historian, the possibility to separate sources
2275 and scientific works is most likely a
2276 \begin_inset Quotes eld
2280 \begin_inset Quotes erd
2284 Unfortunately, BibTeX itself does not allow you to do this.
2285 The good news is, though: With the help of some LaTeX packages, BibTeX
2286 can be extended to fit your historical needs.
2289 \begin_layout Standard
2290 As of version 1.4, LyX provides native support for one of these packages,
2299 \begin_layout Standard
2301 \begin_inset LatexCommand url
2302 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2311 The advantage of this package (compared to other packages like
2315 ) is that you don't need to define new citation commands.
2316 Instead, you need to prepare different bibliographic databases which include
2317 the entries for the different sections of the bibliography.
2318 For example: If you want to divide your bibliography into the sections
2320 \begin_inset Quotes eld
2324 \begin_inset Quotes erd
2328 \begin_inset Quotes eld
2332 \begin_inset Quotes erd
2335 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2336 g.\InsetSpace \space{}
2349 \begin_layout Standard
2355 ocument\SpecialChar \menuseparator
2366 pane (with the xforms frontend: the
2373 Sectionated\InsetSpace ~
2377 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2379 \begin_inset LatexCommand ref
2380 reference "sec:Preparing-a-Bibliography"
2384 ), one for each section of your bibliography.
2385 Returning to our example: Insert a BibTeX reference for the database
2389 and a second one for the database
2394 You are free to use the same or different styles for each section.
2395 Additionally, you can chose if the bibliography section should contain
2397 \begin_inset Quotes eld
2400 all cited references
2401 \begin_inset Quotes erd
2404 of the specified database(s) (which is the default),
2405 \begin_inset Quotes eld
2408 all uncited references
2409 \begin_inset Quotes erd
2413 \begin_inset Quotes eld
2417 \begin_inset Quotes erd
2421 This might be useful if you would like to separate your bibliography into
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 The titles for the sections can be added as ordinary sections or subsections.
2452 removes the bibliography title, you have manually re-add that, too (as
2453 a chapter* or section*, for instance).
2456 \begin_layout Subsection
2457 Multiple Bibliographies
2460 \begin_layout Standard
2461 Multiple bibliographies, e.\InsetSpace \thinspace{}
2462 g.\InsetSpace \space{}
2463 a bibliography for each section or chapter of
2464 the document, are not supported by BibTeX itself.
2469 package, which is used for the creation of sectionated bibliographies in
2470 LyX (cf.\InsetSpace ~
2471 section\InsetSpace ~
2473 \begin_inset LatexCommand ref
2474 reference "sub:Sectionated-Bibliographies"
2478 ), provides an easy way to solve this task, if you are willing to use some
2479 LaTeX-Code (ERT, cf.\InsetSpace ~
2480 section\InsetSpace ~
2482 \begin_inset LatexCommand ref
2483 reference "sec:Inserting-LaTeX-Code"
2491 \begin_layout Standard
2492 An alternative approach is to use the
2500 package, respectively.
2508 \begin_layout Standard
2514 ocument\SpecialChar \menuseparator
2525 pane (with the xforms frontend: the
2532 Sectionated\InsetSpace ~
2536 In the document, you have to enclose the sections, which shall contain
2537 their own bibliography (including the BibTeX reference itself), between
2550 (those commands have to be inserted as ERT).
2551 The bibliography will contain all references which have been cited in the
2553 N.\InsetSpace \thinspace{}
2554 B.: If you are using this approach, then
2558 citation reference has to be inside some btUnit.
2559 Also, the btUnits cannot be nested.
2562 \begin_layout Standard
2566 \begin_layout Section
2570 \begin_layout Subsection
2574 \begin_layout Standard
2575 When you are working on a large file with many sections, it is often convenient
2576 to break up the document into several files, or perhaps you have something
2577 where a table may change from time to time, but the preceding text does
2579 In these cases, you should seriously consider using multipart documents.
2580 For example, scientific papers often have five major sections: the introduction
2581 , observations, results, discussion, and conclusion.
2582 Each of these could be its own separate LyX file, with one
2583 \begin_inset Quotes eld
2587 \begin_inset Quotes erd
2590 file which contains the title, authors, abstract, references, etc., plus
2591 the five included files.
2592 It is important to note that each of these files is a full LyX file which
2593 can be formatted and printed on its own, as well as included in a master
2595 Each of these files must have the same document class, however--- don't
2596 attempt to mix book classes with article classes.
2597 You may also include LaTeX files; however, these files must not have their
2603 everything up to and including the
2615 line must be deleted) or else errors will be generated when you try to
2619 \begin_layout Standard
2620 LyX allows you to include files quite easily with
2625 nsert\SpecialChar \menuseparator
2634 When you click on this selection a small box is inserted into the file
2635 at the current cursor location.
2636 Clicking on the box raises a dialog which allows you to select the file
2637 to be included, and the method of its inclusion.
2641 \begin_layout Standard
2642 The file selection box should by now be obvious.
2643 The three inclusion methods are
2644 \begin_inset Quotes eld
2648 \begin_inset Quotes erd
2652 \begin_inset Quotes eld
2656 \begin_inset Quotes erd
2660 \begin_inset Quotes eld
2664 \begin_inset Quotes erd
2668 The difference between
2669 \begin_inset Quotes eld
2673 \begin_inset Quotes erd
2677 \begin_inset Quotes eld
2681 \begin_inset Quotes erd
2684 is really only meaningful to LaTeXperts, but the practical difference is
2685 that files which are
2686 \begin_inset Quotes eld
2690 \begin_inset Quotes erd
2693 are typeset beginning on a new page, while files which are
2694 \begin_inset Quotes eld
2698 \begin_inset Quotes erd
2701 are typeset starting on the current page.
2702 Perhaps the labeling in LyX will be changed someday to reflect this.
2705 \begin_layout Standard
2706 Generally, the master file is converted into a full LaTeX file before typesettin
2707 g, while the included files are converted to LaTeX files which do not have
2708 all the preamble information.
2718 button prevents this conversion.
2721 \begin_layout Standard
2723 \begin_inset Quotes eld
2727 \begin_inset Quotes erd
2730 included file allows you to include a file typeset exactly as it appears
2731 in the file, i.e.\InsetSpace ~
2732 verbatim mode, with the characters set in a fixed-width
2734 Normally, spaces in this file are invisible, though two consecutive spaces
2735 are conserved, unlike LyX's normal treatment of spaces.
2736 However, setting the
2746 checkbox typesets a mark to unambiguously define the presence of a space.
2750 \begin_layout Subsection
2751 Cross-References Between Files
2754 \begin_layout Standard
2755 It is possible to set up cross-references between the different files.
2756 First, open all the files in question: let's call them A and B in a two
2757 file example, where B is included in A.
2758 Let's say you insert a label in A, then want to reference it in B.
2759 Open the cross-reference dialog in whilst in document B, and you can select
2761 \begin_inset Quotes eld
2765 \begin_inset Quotes erd
2771 \begin_layout Section
2772 Fancy Headers and Footers
2775 \begin_layout Standard
2776 The default page layout is rather plain; for an article document class,
2777 all you get is a centered page number at the bottom of the page.
2778 This document is the book class, so it appears to be a bit fancier, but
2779 to really put on a show, you need to set the document page style to
2780 \begin_inset Quotes eld
2784 \begin_inset Quotes erd
2787 , as mentioned in the
2793 This section describes the LaTeX codes you need to insert in your LaTeX
2794 preamble or the text in order to get the desired effects.
2797 \begin_layout Standard
2798 The page header is divided into three fields, not surprisingly labeled
2799 \begin_inset Quotes eld
2803 \begin_inset Quotes erd
2807 \begin_inset Quotes eld
2811 \begin_inset Quotes erd
2815 \begin_inset Quotes eld
2819 \begin_inset Quotes erd
2823 The footer is also divided into these three fields.
2824 The LaTeX commands to set these fields in the simplest manner are
2849 Suppose you wish to put your name in the upper left hand corner of each
2851 Simply insert the following command in the preamble:
2854 \begin_layout Standard
2863 \begin_layout Standard
2864 You will now see your name in the upper left.
2865 If a field has a default entry that you would like to get rid of (often
2866 the page number appears in the central footer, simply include a command
2867 with a blank argument, e.\InsetSpace \thinspace{}
2871 \begin_layout Standard
2879 \begin_layout Standard
2880 Let's get really fancy: lets put the section number with the word
2881 \begin_inset Quotes eld
2885 \begin_inset Quotes erd
2888 (e.\InsetSpace \thinspace{}
2890 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
2892 Page 4) in the upper
2893 right, your name in the lower left, and the date in the lower right.
2894 The following commands should now appear in the preamble:
2897 \begin_layout Standard
2907 \begin_layout Standard
2915 \begin_layout Standard
2925 \begin_layout Standard
2934 \begin_layout Standard
2942 \begin_layout Standard
2952 \begin_layout Standard
2965 access LaTeX's section and page counters, and so print out the current
2966 section and page numbers.
2973 simply prints out today's date.
2976 \begin_layout Standard
2977 The thicknesses of the horizontal rules drawn beneath the header and above
2978 the footer can also be modified.
2979 If you don't want one of the headers, set its thickness to 0.
2980 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2981 Use the commands, e.\InsetSpace \thinspace{}
2989 headrulewidth}{0.4pt}
2997 footrulewidth}{0.4pt}
2999 to set the thicknesses.
3002 \begin_layout Standard
3003 You can switch the header/footer settings on and off for individual pages
3008 thispagestyle{empty}
3014 thispagestyle{plain}
3020 thispagestyle{fancy}
3023 Simply insert them in the text on the page you want changed and mark them
3025 In fact, title pages are marked as plain by default, while following pages
3026 are marked fancy when using the global fancy setting.
3029 \begin_layout Standard
3030 There are more complex commands which will let you insert things in the
3031 upper left on odd numbered pages, etc., but I will refer you to the
3035 package documentation for more descriptions.
3036 For example, if you have a teTeX installation, look for
3038 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3044 \begin_layout Standard
3045 As a final example, it is possible to include an Encapsulated PostScript
3046 file in the header or footer.
3047 Suppose you want to put a company logo in the upper lefthand corner.
3048 You might try something like
3051 \begin_layout Standard
3060 includegraphics{logo.eps}}}
3063 \begin_layout Standard
3065 (you may need to preface this with
3069 usepackage{graphics}
3071 if you don't include EPS files elsewhere in your document).
3074 \begin_layout Section
3075 Itemize Bullet Selection
3076 \begin_inset LatexCommand label
3084 \begin_layout Standard
3090 \begin_layout Subsection
3094 \begin_layout Standard
3095 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3096 Using this dialog you can easily specify what bullet shape to use at each
3097 level of an itemized list.
3098 These settings are document-wide so you won't be able to specify different
3099 sets of bullets for different paragraphs
3103 \begin_layout Standard
3104 Well, actually you can but you'll have to do it by hand.
3112 \begin_layout Subsection
3116 \begin_layout Standard
3117 Open the dialog by selecting the
3122 ocument\SpecialChar \menuseparator
3129 menu item and then select the
3139 \begin_layout Standard
3140 The dialog provides you with a table of bullet shapes.
3141 A column of buttons on the left of the table provides access to the six
3142 different panels of bullet shapes.
3143 The row of buttons across the top is used to select which bullet depth
3145 A text entry under the table shows the currently selected bullet shape's
3146 LaTeX equivalent and this can be edited if desired.
3147 If you do modify the text you will also need to specify any needed packages
3148 in the LaTeX preamble.
3151 \begin_layout Standard
3152 The six panels are divided up by the packages they require.
3153 The following table shows the mappings from button name to LaTeX packages.
3156 \begin_layout Standard
3158 \begin_inset Tabular
3159 <lyxtabular version="3" rows="7" columns="2">
3161 <column alignment="center" valignment="top" leftline="true" width="0pt">
3162 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3163 <row topline="true" bottomline="true">
3164 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3167 \begin_layout Standard
3182 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3185 \begin_layout Standard
3201 <row topline="true">
3202 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3205 \begin_layout Standard
3220 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3223 \begin_layout Standard
3238 <row topline="true">
3239 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3242 \begin_layout Standard
3257 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3260 \begin_layout Standard
3276 <row topline="true">
3277 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3280 \begin_layout Standard
3295 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3298 \begin_layout Standard
3314 <row topline="true">
3315 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3318 \begin_layout Standard
3333 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3336 \begin_layout Standard
3352 <row topline="true">
3353 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3356 \begin_layout Standard
3371 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3374 \begin_layout Standard
3390 <row topline="true" bottomline="true">
3391 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3394 \begin_layout Standard
3409 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3412 \begin_layout Standard
3435 \begin_layout Standard
3436 LyX doesn't stop you using bullets from packages you don't have.
3437 If you get errors from LaTeX when you try to view or print the file then
3438 its likely you are missing a package.
3439 LyX doesn't restrict your use since you may be editing locally and exporting
3443 \begin_layout Subsection
3447 \begin_layout Standard
3448 Select which bullet depth you want to change then select the bullet shape
3450 Any changes will not be visible in LyX, but are visible when viewing the
3451 document using xdvi or ghostview.
3454 \begin_layout Standard
3455 You can reset a bullet shape to the default simply by clicking your right
3456 mouse button on the appropriate bullet depth button.
3459 \begin_layout Standard
3464 want to have multiple sets of paragraphs with different sets of bullets
3465 in each then you're going to have to get your hands dirty.
3466 The itemize bullet selection dialog can help though because it provides
3467 you with the LaTeX code for a wide range of bullet shapes.
3468 To make your own custom paragraphs you have the following options:
3471 \begin_layout Standard
3475 \begin_layout Standard
3491 \begin_layout Standard
3495 \begin_layout Standard
3517 \begin_layout Itemize
3518 Use the LaTeX command
3524 to specify a new bullet shape for a given depth.
3525 You'll also need to save the current bullet shape so you can restore it
3527 In this itemized list the following LaTeX code was used to change the bullet
3528 used for the first depth.
3560 Note that the itemize depth is specified in Roman numerals as part of the
3570 \begin_layout Itemize
3574 \begin_layout Standard
3587 Specify each individual entry by starting each item with the bullet shape
3588 enclosed in square brackets and set as TeX.
3589 For example, this item was started with
3602 \begin_layout Standard
3606 \begin_layout Standard
3622 \begin_layout Standard
3623 You'll also need to revert the labelitem back to its previous setting for
3624 the global bullet shape settings to remain in effect.
3625 The way used here was:
3638 \begin_layout Chapter
3639 Special Document Classes
3642 \begin_layout Section
3646 \begin_layout Standard
3652 \begin_layout Standard
3653 \begin_inset VSpace bigskip
3659 \begin_layout Standard
3661 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3662 papers to be submitted to American Mathematical Society publications.
3663 The layouts are not tailored to a specific journal, but easily can be.
3664 You should refer to the AMS documentation for specific instructions for
3665 each journal (usually it will entail only changing a single line in the
3667 That documentation is available on the Web at
3668 \begin_inset LatexCommand url
3669 target "http://www.ams.org"
3674 \begin_inset LatexCommand url
3675 target "ftp://ftp.ams.org/pub/tex/amslatex/"
3679 .These layouts are appropriate, and useful, for any mathematical writing.
3680 There are currently 4 distinct AMS LaTeX layouts:
3683 \begin_layout Enumerate
3684 amsart: The standard AMS-article format.
3685 All results and similar statements are numbered as
3686 \begin_inset Formula $(n.m)$
3689 , where the first number refers to the section, and the second refers to
3690 the total number of results (Theorems, Corollaries, Propositions, Definitions
3691 and Remarks, etc.) in that section.
3692 There are also many (but not all) environments available unnumbered, which
3693 is occasionally needed.
3694 Unnumbered environments indicated by an asterisk at the end.
3697 \begin_layout Enumerate
3698 amsart-seq: Here, numbering for each type of statement is in its own sequence,
3699 with no reference to the section number.
3700 There are also many (but not all) environments available unnumbered, which
3701 is occasionally needed.
3702 Unnumbered environments indicated by an asterisk at the end.
3705 \begin_layout Enumerate
3706 amsart-plain: This one is even more terse, since all the environments are
3710 \begin_layout Enumerate
3711 amsbook: the standard AMS book (really, monograph) format.
3712 Numbering is similar to the amsart layout, except that all numbering is
3714 \begin_inset Formula $(n.m.p)$
3717 , where the first number refers to the chapter, the second to the section,
3718 and the third is the number of the results (Theorems, Corollaries, Propositions
3719 , Definitions and Remarks, etc.) in that section.
3720 There are also many (but not all) environments available unnumbered, which
3721 is occasionally needed.
3722 Unnumbered environments indicated by an asterisk at the end.
3725 \begin_layout Standard
3726 Any AMS LyX file can be converted to either of the numbering schemes by
3727 simply changing the document class in the
3732 ocument\SpecialChar \menuseparator
3743 \begin_layout Subsection
3744 What these layouts provide
3747 \begin_layout Standard
3748 There is a long list of included environments provided by these layouts.
3749 Most mathematical papers or books will set as special statements most of
3750 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
3751 variety of such declarations.
3752 However, the AMS recommends the environments that are available in LyX.
3753 The list of environments (not counting the standard environments such as
3756 sections, bibliography, title, author, date
3761 \begin_layout Description
3762 Theorem This is typically used for the statements of major results.
3764 \begin_inset Quotes eld
3772 \begin_inset Quotes erd
3775 appears in bold type, along with an automatically-determined number (an
3780 , is also available).
3781 The text is italicized.
3784 \begin_layout Description
3785 Corollary This is used for statements which follow fairly directly from
3786 previous statements.
3787 Again, these can be major results.
3795 \begin_layout Description
3796 Lemma These are smaller results needed to prove other statements.
3799 \begin_layout Description
3800 Proposition These are less major results which (hopefully) add to the general
3801 theory being discussed.
3804 \begin_layout Description
3805 Conjecture These are statements provided without justification, which the
3806 author does not know how to prove, but which seem to be true (to the author,
3810 \begin_layout Description
3811 Criterion A required condition.
3814 \begin_layout Description
3815 Algorithm A general procedure to be used.
3818 \begin_layout Description
3819 Axiom This is a property or statement taken as true within the system being
3823 \begin_layout Description
3824 Definition Guess what this is for.
3825 The font, both on-screen and in the output, is different for this environment
3826 than for the previous ones.
3828 \begin_inset Quotes eld
3832 \begin_inset Quotes erd
3835 ) is still set in boldface, along with the number, if any, but the rest
3839 \begin_layout Description
3840 Example Typeset similarly to Definition.
3843 \begin_layout Description
3847 \begin_layout Description
3851 \begin_layout Description
3855 \begin_layout Description
3856 Remark This environment is also a new type of theorem.
3857 This is set with the word Remark in italics, and the rest upright.
3860 \begin_layout Description
3861 Note Set similarly to the Remark environment.
3864 \begin_layout Description
3868 \begin_layout Description
3872 \begin_layout Description
3876 \begin_layout Description
3880 \begin_layout Description
3881 Case Generally, these are used to break up long arguments, using specific
3882 instances of some condition.
3883 The numbering scheme for cases is on its own, not together with other numbered
3888 \begin_layout Description
3892 \begin_layout Description
3896 \begin_layout Description
3898 \begin_inset Quotes eld
3906 \begin_inset Quotes erd
3909 is set in italics, but the rest is set upright.
3910 At the end of this environment (other environments can be nested within
3911 this one, of course) a QED symbol (usually a square, but it can vary with
3912 different styles) is placed.
3915 \begin_layout Description
3916 Address This should be the author's permanent address.
3919 \begin_layout Description
3920 Current\InsetSpace ~
3921 Address This should be the author's temporary address at the time
3922 of submission, if different from the Address.
3925 \begin_layout Description
3926 Email Author's e-mail address
3929 \begin_layout Description
3930 URL Author's Web address, if desired.
3933 \begin_layout Description
3934 Keywords Key words or phrases used to identify specific topics discussed
3938 \begin_layout Description
3939 Subjectclass These refer to the AMS Subject Classifications, published and
3942 Mathematical Reviews
3945 These are also available online at the AMS cites listed above.
3948 \begin_layout Description
3952 \begin_layout Description
3956 \begin_layout Description
3960 \begin_layout Standard
3961 In addition, these environments automatically provide the AMS LaTeX and
3963 They need to be available on your system in order to use these environments.
3966 \begin_layout Section
3970 \begin_layout Standard
3975 can be used to type letters according to German conventions.
3976 A template file is included in
3978 .../lyx/share/templates
3980 for you to use as a starting point.
3983 \begin_layout Section
3987 \begin_layout Standard
3992 provides an alternative to the standard
3997 It provides similar functionality, but you might prefer this layout with
3998 sans serif sections, headings, and more.
4001 \begin_layout Section
4005 \begin_layout Standard
4011 \begin_layout Subsection
4015 \begin_layout Standard
4016 This section describes how LyX can be used to write articles for submission
4017 to the scientific journal
4019 Astronomy and Astrophysics
4022 \begin_inset LatexCommand url
4023 name "www.edpsciences.fr/aa/"
4024 target "http://www.edpsciences.fr/aa/"
4028 ) using Version 5.01 of the document class
4033 This package can be downloaded from the ftp site
4036 \begin_layout Standard
4037 \begin_inset VSpace medskip
4043 \begin_layout Standard
4045 \begin_inset LatexCommand url
4046 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4053 \begin_layout Standard
4054 \begin_inset VSpace medskip
4060 \begin_layout Standard
4061 A manual comes together with that package, and this text is not meant to
4062 replace the original manual but merely a short guide how to realize the
4063 correct form of your paper.
4067 \begin_layout Standard
4068 Please note that the publisher of the journal was changed from Springer
4069 to EDP Sciences starting January 1, 2001.
4070 That change implicated also some slight changes of the style files, namely
4071 the removal of the thesaurus command.
4072 The LyX class aa supports the newest version of these style files, V 5.01.
4073 If you have an older version installed, please upgrade.
4074 For compatibility, the old (version 4) layout has been kept as
4079 Please refer to the comments in
4081 LyXDir/layouts/aapaper.layout
4086 \begin_layout Subsection
4090 \begin_layout Standard
4091 It is recommended you start from the example template distributed with LyX.
4092 If you are not using a template, note the following settings:
4095 \begin_layout Itemize
4105 ocument\SpecialChar \menuseparator
4112 dialog (OK, that one was obvious).
4115 \begin_layout Itemize
4116 Don't change the option
4126 The whole layout is done by the macros, you shouldn't change anything.
4129 \begin_layout Subsection
4133 \begin_layout Standard
4134 First thing to enter is the header information.
4135 It consists of seven entries, of which some are optional.
4139 \begin_layout Itemize
4147 \begin_layout Itemize
4155 \begin_layout Itemize
4163 \begin_layout Itemize
4171 \begin_layout Itemize
4176 : [optional] if more than one author: whom to contact for offprint requests.
4179 \begin_layout Itemize
4184 : [optional] mail address for contacts.
4187 \begin_layout Itemize
4195 Received: <date>; Accepted <date>
4198 \begin_layout Standard
4199 There is no need to issue the
4205 command, this is done automatically by LyX when the header is finished.
4206 Although the order of the single header entries doesn't matter it is advised
4207 to keep the above sequence, just to get the best optics and meets the layout
4208 of the real document.
4211 \begin_layout Standard
4212 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4217 \begin_layout Standard
4226 to state your present address, just use the standard footnote via
4231 nsert\SpecialChar \menuseparator
4239 LyX will automagically use the term
4248 \begin_layout Standard
4249 In addition to these topics, the macros use three additional LaTeX commands
4250 that have no counterpart in LyX:
4253 \begin_layout Itemize
4260 to separate different names for more than one author and institute, respectivel
4264 \begin_layout Itemize
4271 to mark corresponding author/institute pairs.
4272 The institutes are numbered sequentially as they appear in the
4276 field, so you have to put a marker to each author.
4279 \begin_layout Itemize
4286 to supply an email address for fast contact.
4289 \begin_layout Standard
4290 In all cases, the appropriate command has to be entered in LyX and marked
4296 \begin_layout Subsection
4300 \begin_layout Standard
4301 The abstract should immediately follow the header block.
4302 With version 5 the abstract environment was changed to a command, and there
4303 is now a resctriction to only one paragraph.
4304 In addition, it should contain an entry with the keywords.
4305 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4312 by hand and mark it as LaTeX code.
4313 Refer to the example paper.
4316 \begin_layout Subsection
4317 Supported environments
4320 \begin_layout Standard
4321 The A&A paper layout supports the following environments for structuring
4325 \begin_layout Itemize
4331 \begin_layout Itemize
4337 \begin_layout Itemize
4343 \begin_layout Itemize
4349 \begin_layout Itemize
4355 \begin_layout Itemize
4361 \begin_layout Itemize
4367 \begin_layout Itemize
4373 \begin_layout Itemize
4379 \begin_layout Itemize
4385 \begin_layout Itemize
4391 \begin_layout Itemize
4397 \begin_layout Subsection
4398 Commands not supported by LyX
4401 \begin_layout Standard
4402 Some commands are not yet supported by the
4407 Some have already been mentioned.
4408 For the sake of completeness, they are listed all together here:
4411 \begin_layout Itemize
4419 \begin_layout Itemize
4427 \begin_layout Itemize
4435 \begin_layout Itemize
4443 \begin_layout Itemize
4451 \begin_layout Itemize
4459 \begin_layout Itemize
4467 \begin_layout Itemize
4475 \begin_layout Standard
4476 If you want to use any of these commands, you have to enter them yourself.
4479 Do not forget to mark them as LaTeX code!
4482 \begin_layout Subsection
4483 Figure and Table Floats
4486 \begin_layout Standard
4487 LyX provides support for the necessary float environments
4489 figure, figure*, table
4495 , therefore we won't tell much about it here.
4502 Just remember that tables should be left-aligned.
4503 For that, select the table and change the alignment in
4508 dit\SpecialChar \menuseparator
4513 aragraph\InsetSpace ~
4517 \begin_layout Standard
4518 There is only one special thing: the figures with caption besides the figure.
4519 To create such a figure, you have to do the following:
4522 \begin_layout Enumerate
4523 Create a wide figure float:
4528 nsert\SpecialChar \menuseparator
4533 t\SpecialChar \menuseparator
4536 , then right click in the figure and select
4547 \begin_layout Enumerate
4548 Enter your caption text.
4551 \begin_layout Enumerate
4556 to move the cursor above the caption.
4559 \begin_layout Enumerate
4563 \begin_layout Enumerate
4564 Position the cursor behind the figure and insert a horizontal fill:
4569 nsert\SpecialChar \menuseparator
4577 \SpecialChar \menuseparator
4580 orizontal\InsetSpace ~
4586 \begin_layout Enumerate
4587 Switch to LaTeX mode:
4595 \begin_layout Enumerate
4605 Do not close the brace!
4608 \begin_layout Enumerate
4609 Position the cursor behind the caption text, switch to LaTeX mode and insert
4622 \begin_layout Standard
4623 Also, refer to the figures in the example paper.
4626 \begin_layout Subsection
4630 \begin_layout Standard
4631 For submission, the paper has to be formated in a special double-spacing
4633 For this purpose, you have to give the option
4637 to the documentclass.
4638 This must be done using the extra class options field in the
4643 ocument\SpecialChar \menuseparator
4651 Just enter the string
4658 \begin_layout Subsection
4662 \begin_layout Standard
4667 directory contains an example paper written with LyX.
4668 It is the example paper from the original macro package, translated to
4670 Use it for inspiration, and compare the original LaTeX code with LyX way
4674 \begin_layout Section
4678 \begin_layout Standard
4684 \begin_layout Subsection
4688 \begin_layout Standard
4689 AASTeX is a set of macros produced by the American Astronomical Society
4690 to facilitate electronic manuscript submission to the three journals they
4691 publish: the Astrophysical Journal (including the Letters and Supplement),
4692 the Astronomical Journal, and the Publications of the Astronomical Society
4694 LyX has proven to be an excellent tool for generating these documents,
4695 especially given its equation, citation, and figure handling capabilities.
4696 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4697 is the version described here, or higher.
4698 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4699 incompatible with LyX.
4700 The AASTeX package may be downloaded from the AASTeX Web site
4703 \begin_layout Standard
4704 \begin_inset VSpace medskip
4710 \begin_layout Standard
4712 \begin_inset LatexCommand url
4713 target "http://www.journals.uchicago.edu/AAS/AASTeX"
4720 \begin_layout Standard
4721 \begin_inset VSpace medskip
4727 \begin_layout Standard
4728 A complete user guide is contained in that package and you should familiarize
4729 yourself with it thoroughly before embarking on writing a paper in LyX.
4730 LyX will not reduce the need to figure out all the AASTeX commands, it
4731 will only reduce the drudgery of typing everything in.
4732 It is your responsibility to ensure that the final exported LaTeX document
4733 conforms completely to the requirements of the journal to which you are
4734 submitting your paper.
4737 \begin_layout Subsection
4738 Starting a New Paper
4741 \begin_layout Standard
4742 I strongly suggest that you start with the AASTeX template file.
4748 ile\SpecialChar \menuseparator
4758 , enter the new file name, then choose the
4763 This will show the most common fields found in a manuscript.
4764 Simply overwrite the existing text (including the brackets,
4768 ) with the correct information.
4769 Many of the AASTeX commands and environments can be implemented directly
4770 in LyX, but some cannot: most noticeably
4782 , which should stick out like a sore thumb if you actually just opened the
4784 For commands such as these, the LaTeX code must be entered directly and
4786 Such commands are referred to as ERT, or Evil Red Text.
4787 I tried to minimize the amount of ERT needed in an AASTeX document, but
4788 there is still a bit more required than any of us would like.
4791 \begin_layout Subsection
4792 Finishing Your Paper
4795 \begin_layout Standard
4796 When the paper is finished to your satisfaction and previews/prints correctly,
4798 \begin_inset Quotes eld
4802 \begin_inset Quotes erd
4805 actions which need to be done before you submit it to the journals.
4809 \begin_layout Enumerate
4810 Export your paper as a LaTeX file (
4815 ile\SpecialChar \menuseparator
4820 xport\SpecialChar \menuseparator
4831 \begin_layout Enumerate
4836 file with your favorite text editor
4840 \begin_layout Enumerate
4841 remove the comment lines before the
4850 \begin_layout Enumerate
4855 usepackage...{fontenc}
4857 line if it appears (usually just after
4872 \begin_layout Enumerate
4873 remove everything between (and including) the
4885 commands, except for any commands you specifically put into the LaTeX preamble
4886 (which should appear immediately after the
4887 \begin_inset Quotes eld
4890 User specified LaTeX commands
4891 \begin_inset Quotes erd
4902 \begin_layout Enumerate
4903 Run the resulting file through LaTeX to make sure it still processes correctly.
4906 \begin_layout Enumerate
4907 Reread the journal requirements to make sure your filenames and formats
4911 \begin_layout Enumerate
4915 \begin_layout Subsection
4916 Comments On Specific Commands
4919 \begin_layout Standard
4920 I will not describe the detailed usage of the individual AASTeX commands:
4921 the AASTeX User Guide (
4925 ) gives a good description of each.
4926 Thus it's probably easiest for me to go down the list as found in the guide
4927 and offer comments where necessary.
4928 So let's begin \SpecialChar \ldots{}
4932 \begin_layout Subsubsection
4933 Things that work as expected
4936 \begin_layout Standard
4940 \begin_layout Standard
4952 \begin_layout Standard
4953 Because they work as you might expect, I simply list them and the section
5054 begin{thebibliography}
5062 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5063 graphicx figure commands (2.14.1),
5087 (2.15.4, amongst other places),
5114 \begin_layout Standard
5115 The following style options also work correctly:
5136 Simply put them in the
5142 Layout\SpecialChar \menuseparator
5148 \begin_layout Standard
5152 \begin_layout Standard
5164 \begin_layout Subsubsection
5165 Things that work, but require more comment
5168 \begin_layout Standard
5169 The following items work, but require a little more discussion:
5172 \begin_layout Itemize
5173 These items are reserved for use by the journal editors, but you can put
5174 them into the LaTeX preamble if you feel compelled to do so:
5207 \begin_layout Itemize
5208 These items may be placed in the LaTeX preamble, and are included as blanks
5209 in the template file:
5230 \begin_layout Itemize
5237 (2.3) -- can only be used
5238 \begin_inset Quotes eld
5242 \begin_inset Quotes erd
5245 , not in the middle of a paragraph.
5246 Use ERT if you need to embed it.
5249 \begin_layout Itemize
5256 (2.3) -- will have extra {} after it.
5257 This should not cause an error.
5260 \begin_layout Itemize
5267 (2.6) -- can only be used
5268 \begin_inset Quotes eld
5272 \begin_inset Quotes erd
5275 , not in the middle of a paragraph.
5276 Use ERT if you need to embed it.
5279 \begin_layout Itemize
5286 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5290 \begin_layout Itemize
5297 (2.8) -- same as for
5304 \begin_layout Itemize
5311 (2.9) -- will have extra {} after it.
5312 This should not cause an error.
5315 \begin_layout Itemize
5322 (2.11) -- will have extra {} after it.
5323 This should not cause an error.
5326 \begin_layout Itemize
5333 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5334 at the beginning of the text and selecting
5336 Insert\SpecialChar \menuseparator
5341 \begin_inset Quotes eld
5345 \begin_inset Quotes erd
5348 inserts an optional argument of the type needed by
5355 Hopefully it will be renamed someday.
5358 \begin_layout Itemize
5371 for the catalog ID optional parameter
5374 \begin_layout Itemize
5387 for the catalog ID optional parameter
5390 \begin_layout Subsubsection
5391 Things not implemented, use ERT
5394 \begin_layout Standard
5398 \begin_layout Standard
5410 \begin_layout Standard
5433 setcounter{equation}
5435 (2.12), Journal name abbreviations (2.13.4),
5471 (2.15.4, insert it as the first element in the lefthand cell after where
5473 Don't use any of LyX's rules in the table),
5485 (2.15.5), much of Misc (2.17, except
5536 \begin_layout Standard
5540 \begin_layout Standard
5552 \begin_layout Subsubsection
5553 Things that cannot be implemented
5556 \begin_layout Standard
5557 \SpecialChar \ldots{}
5558 at least in any meaningful sort of way, so I suggest ignoring them.
5559 They are the references environment (2.13.3), and the deluxetable environment
5561 If you really, really need to use deluxetable, I suggest editing it in
5562 a separate file with a text editor, then using
5567 nsert\SpecialChar \menuseparator
5575 to include it in your LyX document.
5580 file to see an example of this.
5583 \begin_layout Subsection
5584 FAQs, Tips, Tricks, and Other Ruminations
5587 \begin_layout Subsubsection
5588 Getting LyX and AASTeX to cooperate
5591 \begin_layout Standard
5592 It can be a bit tricky to get LyX to recognize a new layout and document
5594 When all else fails, do this:
5597 \begin_layout Enumerate
5598 Make certain that LaTeX can find AASTeX.
5599 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5600 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5607 \begin_layout Enumerate
5619 \begin_layout Enumerate
5625 ools\SpecialChar \menuseparator
5632 in LyX, then restart LyX.
5635 \begin_layout Enumerate
5636 Open a regular new file, not from a template.
5637 Does AASTeX appear in the class list in
5642 ocument\SpecialChar \menuseparator
5652 \begin_layout Standard
5653 If you get a warning from an existing AASTeX document about not being able
5654 to find the AASTeX layout or a message about
5655 \begin_inset Quotes eld
5658 You should not mix title layouts with normal ones
5659 \begin_inset Quotes erd
5662 , things haven't been installed correctly.
5665 \begin_layout Subsubsection
5666 LaTeX error processing a table
5669 \begin_layout Standard
5670 LyX, by default, attempts to center the table caption/title.
5671 This seems to produce a bad interaction in AASTeX so you should click somewhere
5672 in the caption/title, then select
5677 dit\SpecialChar \menuseparator
5682 aragraph\InsetSpace ~
5697 This took care of it for me.
5700 \begin_layout Subsubsection
5702 \begin_inset LatexCommand label
5710 \begin_layout Standard
5711 A couple of things: 1) I have noticed some funny spacing in the reference
5712 entries in the text.
5713 When you enter the bibliography item data, make sure their is
5717 space between the last author and the parenthesis setting off the year;
5720 e.\InsetSpace \thinspace{}
5733 2) Entering the references at all is not obvious.
5734 The easiest thing is to start typing your first reference at the end of
5735 the document, then mark it as type
5740 That will put a small gray box in front of what you just typed.
5741 Click on the box to fill in the rest of the information.
5742 For new references, go to the end of an existing reference and press return.
5743 That will create a new line with its own box, etc.
5746 \begin_layout Subsubsection
5750 \begin_layout Standard
5751 Even though AASTeX provides its own figure commands (
5757 , for example), I much prefer LaTeX's standard figure commands (with the
5766 commands as ERT into a Figure Float box if you desire, but I never
5767 have much luck getting the layout right.
5768 With the standard graphics, LyX will insert a
5772 usepackage{graphicx}
5774 command into the LaTeX preamble and handle the figures in the standard
5775 LaTeX2e way, interspersing the figures in the text.
5776 I believe ApJ accepts figures exactly this way now; AJ might still use
5778 \begin_inset Quotes eld
5781 stack everything at the end
5782 \begin_inset Quotes erd
5788 \begin_layout Subsubsection
5789 Things I could have done, but didn't
5792 \begin_layout Standard
5794 \begin_inset Quotes eld
5798 \begin_inset Quotes erd
5801 things I could have implemented, but chose not to.
5802 For instance, I saw no point in double-spacing the text in the LyX window,
5803 even though it is double-spaced in the paper manuscript.
5804 Also, I chose not to make separate layouts for the preprint and preprint2
5806 Since I assume you will spend most of your time in the plain manuscript
5807 mode anyway, I decided not to chew up more disk space with this.
5811 \begin_layout Subsection
5815 \begin_layout Standard
5816 Your mileage may vary.
5817 I've now had papers published by both ApJ and AJ that have had 98% of the
5818 effort done in LyX; the last 2% was the LaTeX post-processing and a few
5820 I have had no trouble with the submission process, and I'm sure the journals
5821 were never aware that there might be a difference.
5822 So, go forth and publish!
5825 \begin_layout Section
5829 \begin_layout Standard
5832 Panayotis Papasotiriou
5835 \begin_layout Subsection
5839 \begin_layout Standard
5840 The ijmpc package is a set of macros that facilitates electronic manuscript
5843 International Journal of Modern Physics C
5846 Similarly, the ijmpd package is for creating manuscripts to be submitted
5849 International Journal of Modern Physics D
5852 Both journals are published by World Scientific.
5853 The corresponding document classes are named
5862 These files, together with instructions for the authors, can be downloaded
5864 \begin_inset LatexCommand url
5865 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
5870 \begin_inset LatexCommand url
5871 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
5876 Both packages are modified versions of the standard
5877 \begin_inset Quotes eld
5881 \begin_inset Quotes erd
5884 package, and they are almost (but not exactly) identical.
5885 Most of their features are supported by LyX.
5886 I have used LyX successfully to write articles submitted to both journals
5887 without any problem.
5890 \begin_layout Subsection
5894 \begin_layout Standard
5895 As usual, the easiest way to write a paper is to start with a template.
5901 ile\SpecialChar \menuseparator
5920 This will give an (almost) empty document that includes the most common
5921 fields found in a manuscript.
5922 Simply overwrite the existing text (including the brackets,
5927 You should keep in mind the following remarks.
5930 \begin_layout Enumerate
5931 LyX won't let you change the font size and the page style of the document,
5932 because such modifications are not allowed by both packages.
5935 \begin_layout Enumerate
5936 The language of the document should not be changed.
5937 Before previewing your paper, be sure that the babel package is not used.
5938 To do this, click on
5943 ools\SpecialChar \menuseparator
5961 checkbox in the language settings, and click on
5972 , if you wish to make this change permanent).
5975 \begin_layout Enumerate
5977 \begin_inset Quotes eld
5981 \begin_inset Quotes erd
5984 style must be used to define keywords.
5987 \begin_layout Enumerate
5988 The ijmpc package provides a style named
5989 \begin_inset Quotes eld
5992 Classification Codes
5993 \begin_inset Quotes erd
5996 , which can be used to define classification codes, such as PACS numbers.
5997 Note that this facility is not supported by the ijmpd package.
6000 \begin_layout Enumerate
6001 Several new environments are available:
6002 \begin_inset Quotes eld
6006 \begin_inset Quotes erd
6010 \begin_inset Quotes eld
6014 \begin_inset Quotes erd
6018 \begin_inset Quotes eld
6022 \begin_inset Quotes erd
6026 \begin_inset Quotes eld
6030 \begin_inset Quotes erd
6034 \begin_inset Quotes eld
6038 \begin_inset Quotes erd
6042 \begin_inset Quotes eld
6046 \begin_inset Quotes erd
6050 \begin_inset Quotes eld
6054 \begin_inset Quotes erd
6058 \begin_inset Quotes eld
6062 \begin_inset Quotes erd
6066 \begin_inset Quotes eld
6070 \begin_inset Quotes erd
6074 \begin_inset Quotes eld
6078 \begin_inset Quotes erd
6082 \begin_inset Quotes eld
6086 \begin_inset Quotes erd
6090 \begin_inset Quotes eld
6094 \begin_inset Quotes erd
6098 \begin_inset Quotes eld
6102 \begin_inset Quotes erd
6106 \begin_inset Quotes eld
6110 \begin_inset Quotes erd
6114 Their use is more or less obvious.
6115 LyX supports all these environments; it will use the proper label, text
6116 style, and numbering scheme for each of them.
6119 \begin_layout Enumerate
6120 Both packages use basic citations; the natbib package should not be used.
6121 In LyX, citation references are shown as usual; in the output, citations
6122 are shown as superscripts.
6123 If you want to use a citation as normal text, you should use the
6127 command, e.\InsetSpace \thinspace{}
6129 \begin_inset Quotes eld
6132 See Ref.\InsetSpace ~
6140 \begin_inset Quotes erd
6146 \begin_layout Enumerate
6148 \begin_inset Quotes eld
6152 \begin_inset Quotes erd
6155 section in both packages.
6156 To put acknowledgments, just use the
6157 \begin_inset Quotes eld
6161 \begin_inset Quotes erd
6167 \begin_layout Enumerate
6168 Appendices may be added to the paper,
6172 the Acknowledgments and
6177 LyX provides a special environment, called
6178 \begin_inset Quotes eld
6182 \begin_inset Quotes erd
6185 which marks the beginning of the appendices.
6186 This environment should be left blank; it just sends a LaTeX command, but
6187 nothing is really printed.
6189 \begin_inset Quotes eld
6193 \begin_inset Quotes erd
6196 is printed with blue letters, as a signal that all sections after that
6197 point are appendices.
6198 To write an appendix, use the
6199 \begin_inset Quotes eld
6203 \begin_inset Quotes erd
6207 LyX will number each appendix with capital letters, as required by both
6210 \begin_inset Quotes eld
6214 \begin_inset Quotes erd
6221 be present before the first appendix; if not, all appendices will be numbered
6222 as normal sections in the output.
6225 \begin_layout Enumerate
6226 The ijmpc and the ijmpd packages use the
6230 command to implement table captions.
6231 As a result, a table created by LyX is printed correctly, but its caption
6233 However, you can use some ERT to overpass this problem, so that captions
6234 are printed as expected.
6235 To do so, create a float table as usual, remove the caption, and replace
6246 (sic); you must also the ERT
6250 immediately after the tabular material.
6251 Study the example table included in the template files to see how this
6252 trick is implemented.
6253 Alternatively, If you need table captions, you should implement the whole
6258 file, then include this file to the LyX document (
6263 nsert\SpecialChar \menuseparator
6268 \SpecialChar \menuseparator
6277 Details on how to create a table float can be found in the files
6285 , included in the corresponding packages.
6288 \begin_layout Subsection
6289 Preparing a paper for submission
6292 \begin_layout Standard
6293 Before you submit your paper you must export the LyX document as a LaTeX
6299 ile\SpecialChar \menuseparator
6304 xport\SpecialChar \menuseparator
6319 \begin_layout Standard
6320 Actually you have the choice between LaTeX (plain) and pdflatex.
6321 If you intend to use pdflatex to prepare the paper, you should use the
6322 pdflatex option so that included graphics are converted to PDF format,
6323 ready for use by pdflatex.
6328 , then make the following changes to the resulting
6335 \begin_layout Enumerate
6336 Remove the comment lines before the
6345 \begin_layout Enumerate
6346 Remove everything between (and including) the
6358 commands, except for any commands you specifically put into the LaTeX preamble.
6361 \begin_layout Standard
6366 file should be saved and processed through LaTeX as many times as necessary.
6367 You may also want to check the resulting
6374 \begin_layout Subsection
6378 \begin_layout Standard
6379 The use of ERT is reduced to two commands, which must be placed at the top
6381 If you started writing your paper by using the
6389 template, the ERT needed is already in its place; you usually don't need
6391 You may only modify the first ERT to specify the information printed to
6392 the top of odd and even pages (authors' names and short paper's title,
6394 This ERT must have the form
6398 markboth{Authors' Names}{Short Paper's Title}
6403 \begin_layout Section
6407 \begin_layout Standard
6413 \begin_layout Subsection
6417 \begin_layout Standard
6418 The iopart package provides a document class to create electronic manuscript
6419 submission to the journals published by the Institute of Physics.
6420 Instructions for the authors how to create a paper using the iopart class
6421 can be downloaded together with the iopart package from the site
6422 \begin_inset LatexCommand url
6423 target "ftp://ftp.iop.org/pub/journals/latex2e"
6430 \begin_layout Subsection
6434 \begin_layout Standard
6435 The easiest way to write a paper is to start with the file
6439 that is available in LyX's examples files folder.
6440 Open this file, save it under a new name, and start writing.
6441 The example file explains how to use the special text environments.
6442 Here are the most important advices:
6445 \begin_layout Itemize
6446 To be able to compile your document to a PDF, PS, or DVI, assure that the
6449 Use AMS math package
6451 in the document settings under
6458 \begin_layout Itemize
6461 The title environment defines the kind of your paper.
6462 So use one of the following environments for the title:
6466 \begin_layout Itemize
6475 \begin_layout Itemize
6484 \begin_layout Itemize
6490 for a Topical review
6493 \begin_layout Itemize
6502 \begin_layout Itemize
6511 \begin_layout Itemize
6517 for a Paper (same as Title)
6520 \begin_layout Itemize
6526 for a Preliminary communication
6529 \begin_layout Itemize
6535 for a Rapid communication
6538 \begin_layout Itemize
6544 for a Letter to the editor
6548 \begin_layout Itemize
6551 All title environments except of
6555 can have an optional short title.
6558 \begin_layout Itemize
6559 There is a general title environment
6563 which is not directly supported by the LyX.
6564 This can be used as ERT when your document doesn't fit into one of the
6568 \begin_layout Standard
6569 For more informations like hints for special table and formula formatting,
6570 look at the IOP author guidelines.
6573 \begin_layout Section
6577 \begin_layout Standard
6580 Panayotis Papasotiriou
6583 \begin_layout Subsection
6587 \begin_layout Standard
6588 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6589 that facilitates electronic manuscript submission to the journals they
6591 Most known of them (at least in my domain of interest) are
6593 Astrophysics and Space Science
6599 , but there are many others (see a complete list at
6600 \begin_inset LatexCommand url
6601 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6606 The Kluwer package may be downloaded from the site
6607 \begin_inset LatexCommand url
6608 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6613 A complete user guide is contained in that package (but it can also be
6614 downloaded separately).
6617 \begin_layout Standard
6618 LyX supports many features of the package but not everything.
6619 However, the ERT needed is reduced to some
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6627 commands of the package (see\InsetSpace ~
6629 \begin_inset LatexCommand ref
6630 reference "subsec:kluwer_peculiarities"
6635 I have recently used LyX to write an article submitted to the
6637 Astrophysics and Space Science
6639 without any problem.
6642 \begin_layout Subsection
6646 \begin_layout Standard
6647 The easiest way to write a paper is to start with the Kluwer template file.
6650 File\SpecialChar \menuseparator
6665 This will give an (almost) empty document that includes the most common
6666 fields found in a manuscript and a short description of their use.
6667 As in most templates, simply overwrite the existing text (including the
6672 ) with the correct information.
6675 \begin_layout Subsection
6676 Preparing a paper for submission
6679 \begin_layout Standard
6680 As in the AASTeX package, before you submit your paper to a journal you
6682 \begin_inset Quotes eld
6686 \begin_inset Quotes erd
6692 \begin_layout Enumerate
6693 Export your paper as a LaTeX file.
6694 To do this, click on
6699 ile\SpecialChar \menuseparator
6704 xport\SpecialChar \menuseparator
6715 \begin_layout Enumerate
6720 file with a text editor and make the following changes
6724 \begin_layout Enumerate
6725 remove the comment lines before the
6734 \begin_layout Enumerate
6735 remove everything between (and including) the
6747 commands, except for any commands you specifically put into the LaTeX preamble.
6750 \begin_layout Standard
6759 \begin_layout Enumerate
6764 file through LaTeX as many times as necessary (usually up to three).
6767 \begin_layout Enumerate
6772 document using, e.\InsetSpace \thinspace{}
6777 , and check if everything is OK (it should, if you didn't make any mistake).
6780 \begin_layout Subsection
6781 \begin_inset Quotes eld
6785 \begin_inset Quotes erd
6788 of the Kluwer package
6789 \begin_inset LatexCommand label
6790 name "subsec:kluwer_peculiarities"
6797 \begin_layout Standard
6798 The Kluwer package has the following
6799 \begin_inset Quotes eld
6803 \begin_inset Quotes erd
6809 \begin_layout Enumerate
6810 It is possible to write multiple articles in the same LaTeX file
6814 \begin_layout Standard
6815 I can't imagine any good reason to do this.
6821 Each article must be included in the environment
6822 \begin_inset Quotes eld
6826 \begin_inset Quotes erd
6830 Unfortunately, this environment cannot be omitted, even if you write just
6832 Therefore, each article starts with the command
6838 and, obviously, ends with the command
6845 Although this can be implemented in LyX, I didn't included it, since it
6846 looks ugly and can confuse the novice user.
6847 Therefore, you need to enter them directly and mark them as LaTeX code
6849 \begin_inset Quotes eld
6853 \begin_inset Quotes erd
6859 \begin_layout Enumerate
6860 Information given at the beginning of the article (i.e., title, subtitle,
6861 author, institution, running title, running author, abstract and keywords)
6862 must be included in an environment called
6863 \begin_inset Quotes eld
6867 \begin_inset Quotes erd
6871 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
6888 \begin_layout Enumerate
6889 According to the user manual, the label of each bibliography item must be
6913 \begin_layout Standard
6918 template takes care of all these
6919 \begin_inset Quotes eld
6923 \begin_inset Quotes erd
6927 If you start a new paper using this template you don't need to do anything
6932 \begin_layout Enumerate
6933 don't delete the ERT included in the template, and
6936 \begin_layout Enumerate
6937 copy the example bibliography item included in the template and modify it
6938 as necessary to enter new bibliography items.
6941 \begin_layout Section
6945 \begin_layout Standard
6951 \begin_layout Subsection
6955 \begin_layout Standard
6956 The LyX document classes
6958 article (koma-script)
6962 report (koma-script)
6980 correspond to the LaTeX document classes
6996 , resp.\InsetSpace ~
6997 of the Koma-Script family.
6998 They are replacements for the standard document classes
7014 , resp., and fit better to European typography conventions in a number of
7018 \begin_layout Itemize
7019 Standard character size is 11pt in
7021 article (koma-script)
7025 report (koma-script)
7033 letter (koma-script)
7038 \begin_layout Itemize
7039 Headings, labels of the description environment, and a number of elements
7042 letter (koma-script)
7044 document class are set in a bold sans serif font.
7048 \begin_layout Standard
7049 There is a big difference between the bold sans serif old cm fonts and new
7050 ec fonts, especially in the appearance of headings.
7051 In comparison, the ec bold sans serif fonts look a bit thin.
7052 Here the LaTeX package
7060 helps to produce the
7061 \begin_inset Quotes eld
7065 \begin_inset Quotes erd
7068 appearance when using the ec fonts.
7073 The numbering of chapter headings is made in the same way as the numbering
7074 of section headings, that is without the extra line
7075 \begin_inset Quotes eld
7078 Chapter\SpecialChar \ldots{}
7080 \begin_inset Quotes erd
7084 In addition, the appearance of the headings can be modified by using a
7085 number of options (in LyX to be entered in the field
7099 ayout\SpecialChar \menuseparator
7107 A detailed German description of these options can be found in the Koma-Script
7115 \begin_layout Itemize
7116 The main means in the Koma-Script document classes to design the type area
7125 (in LyX to be entered in the extra class options field in the dialog
7130 ocument\SpecialChar \menuseparator
7138 They make a clearer modification of page margins possible as do the options
7144 ocument\SpecialChar \menuseparator
7152 A detailed German description of these and other type area options can
7153 be found in the Koma-Script documentation
7160 \begin_layout Itemize
7161 The LaTeX document classes of the Koma-Script family define a number of
7162 additional commands.
7163 Those part of it which makes sense in LyX is implemented in corresponding
7167 \begin_layout Standard
7168 A detailed German description of the LaTeX document classes of the Koma-Script
7169 family can be found in the Koma-Script documentation
7177 \begin_layout Standard
7178 There is an English translation
7182 , but it is not a complete one.
7187 The following sections describe only those aspects, which are relevant
7191 \begin_layout Subsection
7192 article (koma-script), report (koma-script), and book (koma-script)
7195 \begin_layout Standard
7196 The document classes
7198 article (koma-script)
7202 report (koma-script)
7212 are implemented in the layout files
7225 They contain all the paragraph types of the corresponding standard document
7238 , resp., partly modified, with the exception of the LyX specific
7242 -type, which is replaced by the new
7246 -type having the same functionality.
7251 -Type there is a number of new paragraph types added.
7258 letter (koma-script)
7263 \begin_layout Itemize
7272 : are equivalents to
7280 , resp., additionally inserting an entry in the table of contents.
7289 are not contained in
7291 article (koma-script)
7296 \begin_layout Itemize
7313 , resp., additionally clearing running heads.
7320 article (koma-script)
7326 \begin_layout Standard
7339 report (koma-script)
7341 , but since this is identical to
7345 , is has not been implemented in LyX.
7353 \begin_layout Itemize
7358 : generates a heading directly above the following paragraph in the standard
7359 character size without affecting the structure of the document.
7362 \begin_layout Itemize
7371 are special captions which respect the different space settings needed
7372 for captions placed above or below an element (if you follow strict typographic
7373 rules, you might want to place table captions always above the table).
7374 You can also use the class option
7391 You need at least Koma-Script version 2.8q to use this.
7394 \begin_layout Itemize
7399 : can be used to set a bonmot, e.
7403 \begin_layout Standard
7416 \begin_layout Standard
7425 at the beginning of a chapter.
7426 If you use the optional argument (
7431 nsert\SpecialChar \menuseparator
7435 ), you can insert the dictum's author there.
7436 Dictum and author are separated by a line.
7437 You need at least Koma-Script version 2.8q to use this.
7444 article (koma-script)
7449 \begin_layout Standard
7450 The following types, together with the standard types
7462 , form the title area of the document.
7463 They must be entered ahead of the first
7464 \begin_inset Quotes eld
7468 \begin_inset Quotes erd
7475 \begin_layout Standard
7476 The corresponding LaTeX commands must appear before the
7487 When such a type is used more than once, the latter usage overwrites the
7488 former one, that means, for every type only the latest usage is valid.
7489 The order of the different types however has, like
7501 , no effect on the appearance of the produced document.
7504 \begin_layout Itemize
7509 : produces a centered paragraph above the ordinary title (
7521 ) for the subject of the document.
7524 \begin_layout Itemize
7529 : produces a centered paragraph below the ordinary title (
7541 ) for the publishers' name.
7544 \begin_layout Itemize
7551 report (koma-script)
7557 produces a centered paragraph on its own page behind the title page, or
7560 article (koma-script)
7562 produces a centered paragraph below the ordinary title (
7581 \begin_layout Itemize
7586 : produces a left aligned paragraph above the ordinary title (
7602 ) for a document`s head.
7605 \begin_layout Itemize
7610 : produces in a double-sided print in
7612 report (koma-script)
7618 a left-aligned paragraph at the top of the title page`s back or has no
7619 effect in a single-sided print or in
7621 article (koma-script)
7626 \begin_layout Itemize
7631 : produces in a double-sided print in
7633 report (koma-script)
7639 a left-aligned paragraph at the bottom of the title page`s back or has
7640 no effect in a single-sided print or in
7642 article (koma-script)
7647 \begin_layout Itemize
7652 : produces a special
7653 \begin_inset Quotes eld
7657 \begin_inset Quotes erd
7660 page ahead of the actual document containing a paragraph without special
7664 \begin_layout Standard
7665 The layout files for the document classes
7667 article (koma-script)
7671 report (koma-script)
7682 This is thought of as a place to define your own types.
7687 in your personal layout directory and edit the file!
7690 \begin_layout Subsection
7691 letter (koma-script)
7694 \begin_layout Standard
7698 \begin_layout Standard
7710 \begin_layout Standard
7714 letter (koma-script)
7716 is implemented in the layout file
7721 It contains all the paragraph types of the corresponding standard document
7726 , partly modified, with the exception of the LyX specific types
7738 type, which is replaced by the new
7743 In addition, it contains, in contrast to the standard document class, the
7761 Furthermore, there are a number of new letter specific types.
7764 \begin_layout Standard
7768 \begin_layout Standard
7780 \begin_layout Standard
7781 The appearance of the letter produced by this document class can be controlled
7782 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7786 \begin_layout Standard
7787 For example, the standard appearance of the letter`s heading, consisting
7788 of name and address, is quite self-willed.
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7797 heading is produced by the following LaTeX commands in the preamble:
7800 \begin_layout LyX-Code
7810 \begin_layout LyX-Code
7826 \begin_layout LyX-Code
7836 \begin_layout LyX-Code
7856 A detailed German description of such LaTeX commands can be found in the
7857 Koma-Script documentation
7862 With it, the letter's author can produce his personal letter layout.
7865 \begin_layout Standard
7874 define the beginning of the letter and must be used in every letter.
7875 To emphasize them in the LyX document class, they are marked with the letter
7884 , resp.\InsetSpace ~
7886 It is possible to write any number of letters in one file.
7891 type produces a new letter using the same addressee and a
7895 type produces a new addressee.
7912 are ordinary paragraph types and can also be used several times in one
7913 and the same letter.
7916 \begin_layout Itemize
7921 : produces a paragraph for the addressee and implicitly defines the beginning
7925 \begin_layout Itemize
7930 : produces a paragraph for the form of address and implicitly produces a
7934 \begin_layout Itemize
7939 : produces a paragraph for a close.
7942 \begin_layout Itemize
7947 : produces a paragraph for a postscript.
7950 \begin_layout Itemize
7955 : produces a paragraph for a distribution list.
7958 \begin_layout Itemize
7963 : produces a paragraph for enclosures.
7966 \begin_layout Standard
8007 are input types provided with a label to enter information, which will
8008 be processed by the document class.
8012 \begin_layout Standard
8013 It could be seen as a matter of inconsequence, that the types
8021 described above are not such input types as well.
8022 Because of the special meaning of those types, however, I have implemented
8023 them as ordinary paragraph types with a one letter mark in the left margin.
8024 Moreover, it would affect my feeling of symmetry, if the
8032 type had such a serious different appearance.
8037 The types must be used ahead of the corresponding
8044 \begin_layout Standard
8045 An implementation of these types in a WYSIWYG fashion does not seem to make
8046 sense, because the real appearance of the produced letter does not only
8047 depend on the usage of the particular type, but also on other factors.
8048 For example, a signature entered in the
8052 type will in the standard behavior appear in the produced letter only,
8053 when in the same letter also a
8058 The entered value of the
8062 type will in the standard behavior not appear in the produced letter at
8064 The possibility to design the letter`s heading freely is already indicated
8065 in a footnote above.
8068 \begin_layout Standard
8069 The input types can also be used as empty paragraphs.
8070 This makes sense e.\InsetSpace \thinspace{}
8081 type is not used at all, in the standard behavior the value of the
8085 type is used as signature, whereas if an empty
8089 type is used, no signature value is defined.
8092 \begin_layout Standard
8093 By using the input types it is possible to write a letter template, containing
8094 filled input types with your personal dates (name, address, etc.) and empty
8095 input types for other dates you want to enter.
8098 \begin_layout Itemize
8103 : sender's name, in the standard behavior appears as a centered paragraph
8104 in small caps in the letter`s heading.
8107 \begin_layout Itemize
8112 : sender's signature, in the standard behavior appears below the
8121 type is used, the value of the
8125 type appears instead.
8128 \begin_layout Itemize
8133 : sender's address, in the standard behavior appears in a centered paragraph
8134 in the letter`s heading below the sender's name.
8137 \begin_layout Itemize
8142 : sender's telephone number, in the standard behavior only sets the LaTeX
8152 \begin_layout Itemize
8157 : place of the letter`s making.
8160 \begin_layout Itemize
8165 : date of the letter`s making.
8174 , in the standard behavior, produce the place and the date in a right-aligned
8175 line below the addressee's field.
8180 type is used, neither place nor date appear, independent of the value of
8190 type is used, the date of the letter `s production is used.
8193 \begin_layout Itemize
8198 : sender`s back address, in the standard behavior appears above the addressee's
8199 field in a small sans serif font.
8202 \begin_layout Itemize
8207 : special mail information, in the standard behavior appears underlined
8208 above the addressee's field below the back address.
8211 \begin_layout Itemize
8216 : additional information, in the standard behavior appears on right side
8217 below the addressee`s field.
8220 \begin_layout Itemize
8225 : the letter's title, in the standard behavior appears in a big, bold, sans
8226 serif font above the subject.
8229 \begin_layout Itemize
8234 : the letter's subject, in the standard behavior appears in a bold font
8242 \begin_layout Standard
8263 produce a business letter like line above the
8267 line containing the fields
8268 \begin_inset Quotes eld
8272 \begin_inset Quotes erd
8276 \begin_inset Quotes eld
8280 \begin_inset Quotes erd
8284 \begin_inset Quotes eld
8288 \begin_inset Quotes erd
8292 \begin_inset Quotes eld
8296 \begin_inset Quotes erd
8300 \begin_inset Quotes eld
8304 \begin_inset Quotes erd
8308 \begin_inset Quotes eld
8312 \begin_inset Quotes erd
8316 For the date field, the value of the
8322 \begin_inset Quotes eld
8325 business letter types
8326 \begin_inset Quotes erd
8329 is used, the value of the
8333 type however does not appear, but only the LaTeX variable
8340 The ordinary output of place and date in a right-aligned line below the
8341 addressee`s field is suppressed.
8342 The types are implemented as input types provided with a label and must
8343 be used ahead of the corresponding
8350 \begin_layout Itemize
8358 \begin_layout Itemize
8366 \begin_layout Itemize
8374 \begin_layout Itemize
8382 \begin_layout Itemize
8390 \begin_layout Subsection
8391 The new letter class: letter (koma-script v.2)
8394 \begin_layout Standard
8397 Jürgen Spitzmüller
8400 \begin_layout Standard
8401 \begin_inset VSpace medskip
8407 \begin_layout Standard
8409 Koma-Script version 2.8 has introduced a new letter class
8413 which supersedes the now unsupported
8418 It has --- on the LaTeX side --- a completely new interface and is not
8419 compatible with the old class.
8420 Therefore, LyX supports both, though it is recommended to use the new class.
8423 \begin_layout Standard
8424 This class covers the same functionality as
8426 letter (koma-script),
8433 (receiver's address, same as
8450 will start a new letter (i.
8454 \begin_layout Standard
8467 \begin_layout Standard
8476 you can write several letters per document).
8477 New elements are sender's
8493 and the possibility to use a
8502 nsert\SpecialChar \menuseparator
8512 \begin_layout Standard
8513 The biggest improvement is, though, that the letter's layout is configurable
8514 at almost any needs.
8515 This can be done via the preamble or with a special style file (Letter
8516 Class Option, extension
8520 ), that will be read in as a class option.
8524 \begin_layout Standard
8525 The KOMA package comes with some default
8530 There is, for instance, a
8534 file that follows german typesetting rules, or a
8538 that provides the default layout of the old
8543 The latter can be loaded with the class option
8552 ayout\SpecialChar \menuseparator
8557 ocument\SpecialChar \menuseparator
8569 template that is included in LyX for examples.
8570 A detailed description is to be found in the Koma-Script documentation
8578 \begin_layout Subsection
8582 \begin_layout Standard
8583 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8587 \begin_layout Itemize
8588 The chapter number of a
8592 type appears on a line of its own above the chapter heading instead of
8593 appearing in the same line ahead of it.
8594 The cause for that is the LyX internal behavior for the labeltype
8601 \begin_layout Itemize
8602 The headings of the types
8611 \begin_inset Quotes eld
8615 \begin_inset Quotes erd
8618 LaTeX table of contents, but not in the LyX table of contents (
8623 ocument\SpecialChar \menuseparator
8635 \begin_layout Itemize
8640 document class appear in a skip separation mode, not indented.
8641 This is the standard behavior, no special LaTeX commands are needed for
8648 ocument\SpecialChar \menuseparator
8655 dialog the corresponding radio button indicates
8671 value always has the effect that extra LaTeX commands are inserted in the
8672 document to produce the gap, which is not what is wanted in this case.
8675 \begin_layout Section
8683 \begin_layout Standard
8689 \begin_layout Subsection
8693 \begin_layout Standard
8694 These are the layout files for some of the journal formats used by Springer
8695 Verlag and listed on
8696 \begin_inset LatexCommand url
8697 target "http://www.springer.de/author/tex/help-journals.html"
8701 , where you should also go to fetch the class files (yes, these are LaTeX2e
8703 It is a modular system: the things common to all journals are implemented
8708 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8713 for Journal of Geodesy) can include.
8716 \begin_layout Standard
8717 This means that implementing support for any other Springer journal on this
8718 list is as simple as writing your own
8726 file following the outline given in
8734 \begin_layout Standard
8735 It is reasonably well tested only for the Journal of Geodesy.
8744 come with the standard LyX distribution.
8745 Install the relevant class file (downloaded from Springer) in a proper
8746 directory, reconfigure LaTeX (in the teTeX case by running
8750 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8751 LyX and it should work.
8754 \begin_layout Subsection
8758 \begin_layout Standard
8759 A large number of theorem-like styles ---
8765 \SpecialChar \ldots{}
8771 \begin_layout Standard
8774 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8775 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8778 See the Springer class file documentation for details.
8781 \begin_layout Subsection
8785 \begin_layout Itemize
8797 \begin_layout Itemize
8800 Probability Theory and Related Fields
8806 --- Jean-Marc Lasgouttes
8809 \begin_layout Standard
8810 Add your own, it isn't so hard!
8813 \begin_layout Subsection
8817 \begin_layout Standard
8818 These files are partly based on the older
8822 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8828 layout, are now defunct.
8829 Jean-Marc Lasgouttes helped out big in making me find my way around the
8830 LyX layout file mechanism.
8833 \begin_layout Subsection
8837 \begin_layout Standard
8839 But probably less than in the old hacked-LaTeX
8846 \begin_layout Standard
8847 Limitations e.\InsetSpace \thinspace{}
8848 g.: does not display the number for theorem-like layouts, just
8852 \begin_layout Section
8860 \begin_layout Standard
8866 \begin_layout Subsection
8870 \begin_layout Standard
8871 These are the layout files for some of the journals of the American Geophysical
8873 It is assumed that you have both the AGU's own class files and AGUplus
8874 installed (everything to be found at
8875 \begin_inset LatexCommand url
8876 target "ftp://ftp.agu.org/journals/latex/journals"
8883 \begin_layout Subsection
8887 \begin_layout Standard
8897 They are still called this in the LyX GUI, though their LaTeX equivalents
8898 in the AGU classes are
8909 \begin_layout Standard
8910 Newly defined styles are
8947 These are mostly manuscript attributes and defined in the AGU class documentati
8951 \begin_layout Standard
8952 I suspect this is still badly incomplete.
8955 \begin_layout Subsection
8959 \begin_layout Standard
8976 \begin_layout Subsection
8980 \begin_layout Itemize
8983 Journal of Geophysical Research
8992 \begin_layout Standard
8993 Add your own, it isn't so hard! Look at the
9004 \begin_layout Subsection
9005 Bugs and things to remember
9008 \begin_layout Standard
9009 In order to use the new layouts, you must remember to do the following for
9013 \begin_layout Enumerate
9019 This can be done in the
9021 layout\SpecialChar \menuseparator
9026 document\SpecialChar \menuseparator
9030 (AGU articles are always in English, right? So
9037 \begin_layout Enumerate
9047 (Yes, this is a bug.)
9050 \begin_layout Enumerate
9051 Make sure you use the
9055 bibliography style, by entering
9059 into the second field of the BibTeX inset.
9060 None of the standard styles will do.
9063 \begin_layout Section
9071 \begin_layout Standard
9077 \begin_layout Subsection
9081 \begin_layout Standard
9082 This is the layout file for the European Geophysical Society journals.
9087 can be downloaded from the web site of the EGS under
9088 \begin_inset LatexCommand url
9089 target "www.copernicus.org"
9096 \begin_layout Subsection
9100 \begin_layout Standard
9103 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9111 The current layout file is unfortunately very unmodular and would benefit
9112 from using the various
9119 \begin_layout Section
9125 \begin_inset LatexCommand label
9133 \begin_layout Standard
9141 \begin_layout Subsection
9145 \begin_layout Standard
9146 This section describes how to use LyX to make slides for overhead projectors.
9147 There are two document classes that can do this: the default slides class
9153 This section documents the former.
9156 \begin_layout Standard
9157 I'm going to say this again, nice and clear, so that there's no misunderstanding
9161 \begin_layout Standard
9162 \begin_inset VSpace bigskip
9168 \begin_layout Standard
9172 This section documents the class
9173 \begin_inset Quotes eld
9181 \begin_inset Quotes erd
9189 \begin_layout Standard
9190 \begin_inset VSpace bigskip
9196 \begin_layout Standard
9197 If you're looking for the documentation for
9198 \begin_inset Quotes eld
9206 \begin_inset Quotes erd
9209 , check out section\InsetSpace ~
9211 \begin_inset LatexCommand ref
9212 reference "sec:foiltex"
9222 \begin_inset Quotes eld
9230 \begin_inset Quotes erd
9233 ] is actually somewhat better than the default
9241 \begin_layout Standard
9242 \SpecialChar \ldots{}
9243 or so I've been told repeatedly by its advocates.
9244 Having never used it, I have no idea if this claim is true or not.
9249 which this section documents.
9252 \begin_layout Standard
9253 This class is the LaTeX2e improvement of the old
9258 Every LaTeX2e distribution includes this class [which I'll just refer to
9260 \begin_inset Quotes eld
9268 \begin_inset Quotes erd
9271 from now on], so you're bound to have it.
9272 As I noted earlier, there are other classes, such as
9276 , which also produce slides for overhead projectors and do a better job
9278 However, there are some things which
9282 can do which the others can't, such as generate overlays.
9283 Read on to learn more!
9286 \begin_layout Subsection
9288 \begin_inset LatexCommand label
9289 name "sec:slidesetup"
9296 \begin_layout Standard
9297 Obviously, to use this document class, you need to select
9298 \begin_inset Quotes eld
9306 \begin_inset Quotes erd
9309 from the class list in the
9314 ocument\SpecialChar \menuseparator
9322 There are some other special things you should know about this class:
9325 \begin_layout Itemize
9326 Don't bother changing the options
9331 They're not supported by the
9338 \begin_layout Itemize
9347 behaves a bit differently for this class.
9348 The possible choices and what they do are as follows:
9352 \begin_layout Description
9357 The final output contains page numbers in the lower right corner.
9360 \begin_layout Description
9369 , but also prints out any time markers you've put in.
9370 This is the default.
9373 \begin_layout Description
9378 The final output contains no page numbers, time markers, or alignment markers.
9382 \begin_layout Itemize
9387 class has an extra option:
9393 \begin_inset Quotes eld
9401 \begin_inset Quotes erd
9404 in the extra class options.
9408 \begin_layout Standard
9409 Using this options allows you to add time markers to
9414 See section\InsetSpace ~
9416 \begin_inset LatexCommand ref
9417 reference "sec:slideNote"
9425 \begin_layout Standard
9426 You can also use the template file
9427 \begin_inset Quotes eld
9435 \begin_inset Quotes erd
9438 to automatically set up a document to use the
9447 ile\SpecialChar \menuseparator
9456 to open your new document].
9457 The template file also contains some examples of the special paragraph
9458 environments used by this class.
9459 I'll describe those next.
9462 \begin_layout Subsection
9463 Paragraph Environments
9466 \begin_layout Subsubsection
9467 Supported Environments
9470 \begin_layout Standard
9471 The first thing you'll notice when you start up a new
9475 document is the font size and type: it's the equivalent of the size
9476 \begin_inset Quotes eld
9484 \begin_inset Quotes erd
9493 This is also what's used in the output.
9495 \begin_inset Quotes eld
9499 \begin_inset Quotes erd
9502 to remind you that this is a slide.
9503 Your final slides will use a larger font; ergo, you'll have less space.
9504 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9507 \begin_layout Standard
9508 The next thing that becomes obvious is the changes to the paragraph environment
9509 pull-down box [at the far-left end of the toolbar].
9510 Most of the paragraph environments you're used to seeing are missing.
9511 There are also five new ones.
9516 class itself only supports certain paragraph environments:
9519 \begin_layout Itemize
9525 \begin_layout Itemize
9531 \begin_layout Itemize
9537 \begin_layout Itemize
9543 \begin_layout Itemize
9549 \begin_layout Itemize
9555 \begin_layout Itemize
9561 \begin_layout Itemize
9567 \begin_layout Itemize
9573 \begin_layout Itemize
9579 \begin_layout Itemize
9585 \begin_layout Standard
9586 All of the other standard environments, including the section-heading environmen
9587 ts, aren't used in the
9594 \begin_layout Standard
9595 On the other hand, you'll notice the following new environments:
9598 \begin_layout Itemize
9604 \begin_layout Itemize
9610 \begin_layout Itemize
9616 \begin_layout Itemize
9622 \begin_layout Itemize
9628 \begin_layout Standard
9629 These five are kind of quirky, due to a
9630 \begin_inset Quotes eld
9634 \begin_inset Quotes erd
9638 You see, LyX doesn't permit you to nest any other paragraph environment
9639 into an empty environment.
9640 Now, that's fine and dandy, but it means that you wouldn't be able to start
9641 a slide with anything except plain text.
9642 To deal with this, I've performed a little
9643 \begin_inset Quotes eld
9647 \begin_inset Quotes erd
9653 \begin_layout Subsubsection
9654 Quirks of the New Environments
9655 \begin_inset LatexCommand label
9656 name "sec:slideQuirk"
9663 \begin_layout Standard
9664 All five of the new paragraph environments are somewhat quirky due to inherent
9665 limitiations in the current version of LyX.
9666 As I just mentioned, LyX forbids environments that begin with another environme
9668 To get around this, the
9672 environment isn't a paragraph environment as described in the
9680 \begin_layout Standard
9694 \begin_inset Quotes eld
9697 pseudo-environments.
9698 \begin_inset Quotes erd
9701 They look like a section heading or a
9702 \begin_inset Quotes eld
9710 \begin_inset Quotes erd
9713 but really begin a [and, if necessary, end the previous] paragraph environment.
9723 \begin_inset Quotes eld
9727 \begin_inset Quotes erd
9730 These two perform some action.
9733 \begin_layout Standard
9734 A common feature of all five environments,
9754 , is a rather long-ish label.
9755 The text following this label --- ordinarily the contents of the paragraph
9756 environment --- is utterly irrelevant for
9777 LyX completely ignores it.
9778 In fact, you can leave these five environments completely empty.
9782 \begin_layout Standard
9787 to put any text after the rather long-ish label, you might want to.
9788 This could be a short description of the contents of the
9793 In that case, enter in your descriptive comment and hit
9797 as you normally would.
9800 \begin_layout Standard
9801 If, on the other hand, you don't want to enter in any descriptive text,
9802 you'll hit another LyX quirk.
9803 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9804 environment until you put something in the old one.
9808 \begin_layout Itemize
9809 Start entering the text that will
9837 \begin_layout Itemize
9838 Now move to the beginning of that paragraph.
9842 \begin_layout Itemize
9851 \begin_layout Itemize
9852 Finally, change this new, empty paragraph to a
9876 \begin_layout Standard
9877 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9881 \begin_layout Subsection
9882 Making a Presentation with
9895 \begin_layout Subsubsection
9903 \begin_layout Standard
9904 If you're expecting this section to teach you how to actually make a presentatio
9905 n, you'll be sorely disappointed.
9906 Naturally, I'll describe all of the ways the
9910 class can assist you in preparing the materials for a presentation.
9911 Filling in the contents, however, is up to you.
9916 the LyX philosophy.]
9919 \begin_layout Standard
9924 environment [in the manner described in section\InsetSpace ~
9926 \begin_inset LatexCommand ref
9927 reference "sec:slideQuirk"
9931 ] tells LyX to begin a new slide [duh].
9932 The label for this environment/
9933 \begin_inset Quotes erd
9937 \begin_inset Quotes erd
9941 \begin_inset Quotes eld
9945 \begin_inset Quotes erd
9948 in cool blue, followed by the label,
9949 \begin_inset Quotes eld
9953 \begin_inset Quotes erd
9957 Any text or paragraph environments that follow this one go on the new slide.
9961 \begin_layout Standard
9962 Slides are probably the only time you'll need to forcibly end pages in LyX
9963 (this can be specified in the
9968 In fact, you'll want to, once you finish entering the contents of one slide.
9969 If you've entered more text than can physically fit on a slide, the extra
9970 overflows onto a new slide.
9971 I don't recommend doing this, however, since the overflow slide won't have
9972 any page number on it.
9973 Furthermore, it may interfere with any
9977 you've made to accompany the oversized
9984 \begin_layout Standard
9993 environments work the same way as the
9999 \begin_inset Quotes eld
10003 \begin_inset Quotes erd
10006 followed by a label [
10007 \begin_inset Quotes eld
10011 \begin_inset Quotes erd
10015 \begin_inset Quotes eld
10019 \begin_inset Quotes erd
10023 The color is a stunning magenta instead of blue, and the
10024 \begin_inset Quotes eld
10028 \begin_inset Quotes erd
10031 will look different, in style and in length.
10032 The label fonts of all three also differ from one another.
10035 \begin_layout Standard
10040 , if the contents of a
10048 exceed the physical size of a slide or sheet of paper, the extra will overflow
10050 Again, you should avoid this.
10051 It defeats the whole purpose of
10062 \begin_layout Subsubsection
10072 \begin_layout Standard
10077 is a slide that sits atop another slide.
10078 Perhaps you wish to discuss a figure on the main
10082 before displaying the text associated with it.
10083 One way to accomplish this is tape a flap of dark paper over the part of
10088 you want to display later.
10089 This method fails, however, if you wish to overlap one graph with another,
10091 You would then have to fumble while speaking to align the two separate,
10096 s to align the two graphs.
10101 environment in both cases makes life much easier.
10104 \begin_layout Standard
10109 receives the page number of its
10110 \begin_inset Quotes eld
10114 \begin_inset Quotes erd
10122 \begin_inset Quotes eld
10130 \begin_inset Quotes erd
10137 \begin_layout Standard
10138 Presumably, mutliple
10143 \begin_inset Quotes eld
10151 \begin_inset Quotes erd
10155 \begin_inset Quotes eld
10163 \begin_inset Quotes erd
10167 \begin_inset Quotes eld
10175 \begin_inset Quotes erd
10178 , etc.\InsetSpace ~
10179 appended to the page number of the parent
10189 Clearly, you want the contents of both the
10197 to each fit on a single physical slide! You should probably consider an
10203 \begin_inset Quotes eld
10207 \begin_inset Quotes erd
10219 class provides a visual cue for this: the label at the start of an
10223 is shorter than that at the start of a
10228 Lastly, when you generate printable output, you'll find alignment markers
10229 in all four corners of both the
10233 page and its parent
10238 These will assist you in lining up the two physical slides.
10241 \begin_layout Standard
10242 The major problem in overlaying two slides is aligning the contents of the
10243 two transparencies.
10244 How much space should you leave for that graph on the second slide? Worse
10245 still, what if you want a graph and a sentence on second slide, but there
10246 is text on the main transparency that goes in between them? You could try
10247 and insert vertical space of the right size.
10248 The better way is to use
10259 \begin_layout Standard
10260 As their names imply,
10268 are two command-like paragraph environments that make all subsequent text
10269 invisible and visible, respectively.
10270 Note from section\InsetSpace ~
10272 \begin_inset LatexCommand ref
10273 reference "sec:slideQuirk"
10277 that you don't place anything
10281 these two environments, however.
10286 , it inserts a centered, sky-blue label into the page reading
10287 \begin_inset Quotes eld
10290 <Invisible Text Follows>
10291 \begin_inset Quotes erd
10295 For paragraphs following this label, the parts of the
10303 ; it doesn't matter which] where they would be contain instead blank space.
10307 \begin_layout Standard
10312 , the corresponding centered label is
10313 \begin_inset Quotes eld
10316 <Visible Text Follows>
10317 \begin_inset Quotes erd
10321 Paragraphs following this label behave normally.
10322 Note that the beginning of a new
10334 automatically shuts off an
10339 It's therefore not necessary to use
10350 \begin_layout Standard
10351 By now, it should be obvious how to create overlay transparencies using
10352 the proper combination of
10371 \begin_layout Enumerate
10376 , including everything that will appear on it, whether on the main slide
10384 \begin_layout Enumerate
10385 Before each figure or paragraph that will appear only on the
10394 If necessary, insert a
10398 environment after the
10405 \begin_layout Enumerate
10410 immediately following the
10417 \begin_layout Enumerate
10418 Copy the contents of this
10429 \begin_layout Enumerate
10434 , change all of the
10445 \begin_layout Standard
10447 You've just made an
10454 \begin_layout Standard
10455 There's one problem with the way I've designed the LyX
10459 class: you can't make text in the middle of a paragraph invisible, nor
10460 make text in the middle of an invisible paragraph visible again.
10461 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10465 \begin_layout Standard
10466 The commands of interest are:
10469 \begin_layout Itemize
10474 invisible \SpecialChar \ldots{}
10478 \begin_layout Itemize
10483 visible \SpecialChar \ldots{}
10487 \begin_layout Standard
10488 \SpecialChar \ldots{}
10489 and need to be marked as TeX.
10491 \begin_inset Quotes eld
10495 \begin_inset Quotes erd
10498 you wish to change goes in between the brackets [and after the
10511 If you don't know how to mark text as TeX, see the appropriate section
10524 \begin_layout Subsubsection
10534 \begin_inset LatexCommand label
10535 name "sec:slideNote"
10542 \begin_layout Standard
10551 is associated with a
10552 \begin_inset Quotes eld
10556 \begin_inset Quotes erd
10568 class provides visual cues.
10573 is shorter than that of a
10577 [yet longer than that of an
10581 ] and, like the label of an
10585 is shockingly magenta.
10586 Additionally, the printed
10590 has the page number of its
10591 \begin_inset Quotes eld
10595 \begin_inset Quotes erd
10603 \begin_inset Quotes eld
10611 \begin_inset Quotes erd
10615 \begin_inset Quotes eld
10623 \begin_inset Quotes erd
10627 \begin_inset Quotes eld
10635 \begin_inset Quotes erd
10639 You can have multiple
10643 s associated with a single
10655 , you'll probably want to break up long
10659 s so that they fit on a single sheet of paper.
10662 \begin_layout Standard
10667 is obvious: it contains anything additional you might want to say about
10673 It could also be used as a sheet of reminders for a particular
10678 In the case of the latter, you might want to make use of time markers.
10684 \begin_inset Quotes eld
10688 \begin_inset Quotes erd
10691 support for time markers, a
10696 So, you'll have to resort to using the LaTeX codes.
10699 \begin_layout Standard
10700 To use time markers, you'll need to specify the extra class option
10701 \begin_inset Quotes eld
10709 \begin_inset Quotes erd
10712 [see section\InsetSpace ~
10714 \begin_inset LatexCommand ref
10715 reference "sec:slidesetup"
10720 This option turns on timing marks, which will appear in the lower-left-hand
10726 To set what appears in the time marker, you use the LaTeX commands
10727 \begin_inset Quotes eld
10737 \begin_inset Quotes erd
10741 \begin_inset Quotes eld
10751 \begin_inset Quotes erd
10755 The arguments of both commands are time measured in seconds.
10757 \begin_inset Quotes eld
10767 \begin_inset Quotes erd
10770 sets the time marker to a given time.
10772 \begin_inset Quotes eld
10782 \begin_inset Quotes erd
10785 increments the time marker by the specified amount.
10786 Using time markers and
10790 s in this fashion, you can remind yourself how much time to spend on a particula
10798 \begin_layout Standard
10799 There's one last feature to describe.
10800 Clearly, you'd like to print out all of your
10808 s on transparencies while printing all of your
10825 with which it is associated.
10826 What's a person to do?
10829 \begin_layout Standard
10830 Luckily, there are two LaTeX commands that allow you to select what to print
10832 Both must be placed into the preamble of your document.
10834 \begin_inset Quotes eld
10846 \begin_inset Quotes erd
10849 will cause the output to contain only the
10858 Correspondingly, the command
10859 \begin_inset Quotes eld
10871 \begin_inset Quotes erd
10874 prevents the output of anything but
10879 I'd advise placing both commands in the preamble and initially comment
10881 You can then preview your entire presentation as you write.
10882 When you're done writing, you can then uncomment one of the two to select
10883 what you want to print.
10884 I like to uncomment
10885 \begin_inset Quotes eld
10897 \begin_inset Quotes erd
10900 , print to a file with
10901 \begin_inset Quotes eld
10909 \begin_inset Quotes erd
10912 in its name, comment it back out, then uncomment
10913 \begin_inset Quotes eld
10925 \begin_inset Quotes erd
10929 \begin_inset Quotes eld
10937 \begin_inset Quotes erd
10941 I can then send either file to a printer, loading transparencies or plain
10942 paper as appropriate.
10945 \begin_layout Standard
10946 You can also provide other arguments to the
10947 \begin_inset Quotes eld
10957 \begin_inset Quotes erd
10961 \begin_inset Quotes eld
10971 \begin_inset Quotes erd
10975 See a good LaTeX book for details.
10978 \begin_layout Subsection
10983 Class Template File
10986 \begin_layout Standard
10987 I have also provided a template file,
10988 \begin_inset Quotes eld
10996 \begin_inset Quotes erd
11004 To use it, begin your new presentation with
11009 ile\SpecialChar \menuseparator
11019 Your new LyX presentation file will contain an example
11040 additionally contain an example of the use of
11049 Lastly, the preamble will contain:
11052 \begin_layout LyX-Code
11053 % Uncomment to print out only slides and overlays
11056 \begin_layout LyX-Code
11060 \begin_layout LyX-Code
11070 \begin_layout LyX-Code
11071 % Uncomment to print out only notes
11074 \begin_layout LyX-Code
11078 \begin_layout LyX-Code
11086 \begin_layout Standard
11087 One final thing: I created this class to support the LaTeX2e
11088 \begin_inset Quotes eld
11096 \begin_inset Quotes erd
11099 class, one of the built-in LaTeX2e classes.
11100 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11101 built-in slide class.
11102 It's here if you want it or need it.
11103 There exist other LaTeX2e classes for creating presentations, such as the
11108 class [see section\InsetSpace ~
11110 \begin_inset LatexCommand ref
11111 reference "sec:foiltex"
11116 \begin_inset Quotes eld
11124 \begin_inset Quotes erd
11127 package [present on some TeX distributions].
11128 The latter is not yet supported under LyX.
11132 \begin_layout Standard
11133 Perhaps you can take on the task\SpecialChar \ldots{}
11139 I know nothing about these other classes.
11140 Try them out to see what sort of alternative they provide.
11143 \begin_layout Section
11152 \begin_inset LatexCommand label
11160 \begin_layout Standard
11166 \begin_layout Subsection
11170 \begin_layout Standard
11171 This section describes how to use LyX to make slides for overhead projectors.
11172 There are two document classes that can do this: the default slides class
11178 This section documents the latter.
11181 \begin_layout Standard
11182 I'm going to say this again, nice and clear, so that there's no misunderstanding
11186 \begin_layout Standard
11187 \begin_inset VSpace bigskip
11193 \begin_layout Standard
11197 This section documents the class
11198 \begin_inset Quotes eld
11206 \begin_inset Quotes erd
11214 \begin_layout Standard
11215 \begin_inset VSpace bigskip
11221 \begin_layout Standard
11222 If you're looking for the documentation for
11223 \begin_inset Quotes eld
11231 \begin_inset Quotes erd
11234 , check out section\InsetSpace ~
11236 \begin_inset LatexCommand ref
11237 reference "sec:slitex"
11242 If your machine doesn't have the
11247 \begin_inset Quotes eld
11255 \begin_inset Quotes erd
11258 ] installed, you'll probably have to use the default
11262 class, which isn't quite as good as
11267 \begin_layout Standard
11272 class is designed for use with version 2.1 of the
11276 LaTeX class file which is now an integral part of LaTeX2e.
11279 \begin_layout Subsection
11283 \begin_layout Standard
11284 Obviously, to use this document class, you need to select
11285 \begin_inset Quotes eld
11293 \begin_inset Quotes erd
11305 Document\InsetSpace ~
11309 There are some settings in the
11311 Document\InsetSpace ~
11314 dialog that you should know about that are specific to this class:
11317 \begin_layout Itemize
11318 Don't change the options
11328 Document\InsetSpace ~
11332 They're ignored by the
11339 \begin_layout Itemize
11340 The default font size is 20pt with the other options being 17pt, 25pt and
11344 \begin_layout Itemize
11345 The default font is
11353 but all math equations are still typeset in the usual roman font.
11356 \begin_layout Itemize
11361 TeX supports A4 and Letter paper sizes as well as a special size for working
11363 It doesn't support A5, B5, legal or executive paper sizes.
11366 \begin_layout Itemize
11367 Don't bother changing the
11371 settings because they are ignored anyway.
11372 All floats appear where they are defined in the text.
11375 \begin_layout Itemize
11383 setting behaves a bit differently for this class.
11388 TeX provides extensive footer and header capabilities including a user-defined
11390 See section\InsetSpace ~
11392 \begin_inset LatexCommand ref
11393 reference "sec:foilfoot"
11398 The title page is treated differently to all other pages in the document
11407 has the logo centered at the bottom of the page (if one is defined).
11408 The possible page style choices and what they do are as follows:
11413 \labelwidthstring MMMMMMM
11420 The final output contains no page numbers, or other headers or footers
11421 (except footnotes of course).
11426 \labelwidthstring MMMMMMM
11433 The final output contains page numbers centered at the bottom of the page.
11434 No other headings or footers (other than footnotes).
11438 \labelwidthstring MMMMMMM
11443 Page numbers in lower right corner.
11444 Additional headers and footers are also shown.
11445 This is also the default.
11449 \labelwidthstring MMMMMMM
11454 Gives you access to the
11458 package although its use with
11462 TeX is discouraged by the writer of the
11466 TeX package because of some potential page layout clashes.
11470 \begin_layout Subsubsection
11474 \begin_layout Standard
11475 The following options may be used in the extra class options in the
11480 ocument\SpecialChar \menuseparator
11491 \labelwidthstring MMMMMMx
11496 This sets up the page layout for 7.33in by 11in paper, which is about the
11497 same aspect ratio as a 35mm slide, making it a bit easier to work with
11502 \labelwidthstring MMMMMMx
11507 Places a rule across the page below the header on every page except the
11512 \labelwidthstring MMMMMMx
11517 Places a rule across the page above the footer on every page except the
11522 \labelwidthstring MMMMMMx
11527 This is automatically set each time you create a new
11536 TeX to use the dvips driver to rotate those pages that are set as landscape
11541 \labelwidthstring MMMMMMx
11546 Simply changes the page dimensions to those of a landscape page but doesn't
11548 Thus if you use this option you need to use an external program to rotate
11549 each page or feed your paper through your printer as landscape.
11550 Note that this option effectively reverses the roles of the
11558 environments (don't worry these are described in the next section).
11562 \labelwidthstring MMMMMMx
11567 Equation numbers on the left.
11571 \labelwidthstring MMMMMMx
11576 Flush-left equations.
11579 \begin_layout Subsection
11580 Supported Environments
11583 \begin_layout Standard
11584 Most of the environments commonly supported in other classes are also supported
11590 There are several additional environments provided by
11594 TeX as well as a couple added by LyX.
11595 The following environments are shared with other classes:
11598 \begin_layout Standard
11602 \begin_layout Standard
11606 begin{multicols}{2}
11614 \begin_layout Itemize
11620 \begin_layout Itemize
11626 \begin_layout Itemize
11632 \begin_layout Itemize
11638 \begin_layout Itemize
11644 \begin_layout Itemize
11650 \begin_layout Itemize
11656 \begin_layout Itemize
11662 \begin_layout Itemize
11668 \begin_layout Itemize
11674 \begin_layout Itemize
11680 \begin_layout Itemize
11686 \begin_layout Itemize
11692 \begin_layout Itemize
11698 \begin_layout Itemize
11704 \begin_layout Itemize
11710 \begin_layout Itemize
11716 \begin_layout Itemize
11722 \begin_layout Standard
11726 \begin_layout Standard
11738 \begin_layout Standard
11739 That is, all the major environments apart from the sectioning environments.
11740 Since foils are essentially self-contained sections, with a title and body,
11745 TeX provides specific commands for starting new foils and these are:
11748 \begin_layout Itemize
11754 \begin_layout Itemize
11760 \begin_layout Standard
11761 LyX also provides slightly modified versions of these two environments called:
11764 \begin_layout Itemize
11770 \begin_layout Itemize
11773 ShortRotatefoilhead
11776 \begin_layout Standard
11777 and the differences will be explained in the next section.
11780 \begin_layout Standard
11781 Since foils are often used in presenting ideas or new theorems and such
11786 TeX also provides a comprehensive box of goodies for presenting them:
11789 \begin_layout Standard
11793 \begin_layout Standard
11797 begin{multicols}{2}
11805 \begin_layout Itemize
11811 \begin_layout Itemize
11817 \begin_layout Itemize
11823 \begin_layout Itemize
11829 \begin_layout Itemize
11835 \begin_layout Itemize
11841 \begin_layout Itemize
11847 \begin_layout Itemize
11853 \begin_layout Itemize
11859 \begin_layout Itemize
11865 \begin_layout Itemize
11871 \begin_layout Standard
11875 \begin_layout Standard
11887 \begin_layout Standard
11888 The starred versions are unnumbered while the unstarred versions are numbered.
11889 There are also two list environments added by LyX and these are:
11892 \begin_layout Itemize
11898 \begin_layout Itemize
11904 \begin_layout Standard
11909 TeX provides some powerful header and footer capabilities that are best
11910 set in the preamble although they may be set at any point in a document.
11911 If you want to change these settings in your document the best place to
11912 do so is at the very top of a foil,
11917 straight after the foilhead.
11920 \begin_layout Standard
11921 For this purpose, the following command styles are provided [
11928 \begin_layout Standard
11932 \begin_layout Standard
11936 begin{multicols}{2}
11944 \begin_layout Itemize
11951 \begin_layout Itemize
11957 \begin_layout Itemize
11964 \begin_layout Itemize
11971 \begin_layout Itemize
11979 \begin_layout Standard
11985 \begin_layout Standard
11989 \begin_layout Standard
12001 \begin_layout Standard
12002 There are also a few commands provided by
12006 TeX that aren't directly supported by LyX but I'll tell you what they do
12007 and how to use them in section\InsetSpace ~
12009 \begin_inset LatexCommand ref
12010 reference "sec:unsuppfoils"
12017 \begin_layout Subsection
12018 Building a Set of Foils
12021 \begin_layout Standard
12022 This section will give a simple introduction to using the different environments
12023 to build a set of foils.
12024 If you want to see an example set of foils take a look at the
12028 file accessible from the
12033 ile\SpecialChar \menuseparator
12038 pen\SpecialChar \ldots{}
12049 \begin_layout Subsubsection
12050 Give It a Title Page
12053 \begin_layout Standard
12054 Unlike other classes that provide
12074 creates the title on a page of its own.
12075 If you leave out the
12079 environment LaTeX will substitute the current date (every time you regenerate
12083 \begin_layout Subsubsection
12087 \begin_layout Standard
12088 As I mentioned earlier, there are four ways of starting a new foil.
12089 For portrait foils you should use
12098 The difference between these two environments is the amount of space between
12099 the title of the foil (the foilhead) and the body of the foil.
12102 \begin_layout Standard
12103 Landscape foils are generated using the
12109 ShortRotatefoilhead
12112 Again the only difference is the spacing between foilhead and body.
12113 Both of the short versions have 0.5 inches less separation between the foilhead
12118 \begin_layout Standard
12119 One problem with the support for landscape foils is the requirement that
12120 you have to use the
12124 driver to generate the PostScript output otherwise the foils won't be rotated.
12125 It is possible to get landscape foils even if you haven't got the
12129 driver provided you can feed your foils sideways through your printer ;-)
12132 \begin_layout Subsubsection
12133 Theorems, Lemmas, Proofs and more
12136 \begin_layout Standard
12137 Due to a small bug in LyX you can't have two of the same type of these environme
12138 nts directly following each other.
12139 They must be separated by something.
12140 If you try, you will just be extending the previous environment as if you
12141 had merged the two environments together.
12142 So, how do you get around this problem? The simplest option is to insert
12143 some text between the two environments or add a
12147 environment between the two with just a
12148 \begin_inset Quotes eld
12156 \begin_inset Quotes erd
12160 This will force LyX to produce two separate environments and hence the
12161 correct LaTeX output.
12162 An example is provided in the example file included with the LyX distribution.
12163 Remember, this problem only occurs if you are trying to place two of the
12164 same type of theorem-like environments one directly after the other.
12167 \begin_layout Subsubsection
12171 \begin_layout Standard
12172 You get all the commonly supported list styles found in other classes as
12173 well as two new ones.
12174 I'll only describe the new ones here.
12175 If you want to find out more about the other list environments check out
12181 If you intend to use itemized lists you might also want to read about the
12184 Itemize\InsetSpace ~
12185 Bullet\InsetSpace ~
12188 dialog described above in section\InsetSpace ~
12190 \begin_inset LatexCommand ref
12191 reference "sec:bullet"
12198 \begin_layout Standard
12199 The two new list styles,
12207 , are designed to make it easier for you to create lists of do's and don'ts
12208 or right and wrong by providing dedicated environments that use a tick
12209 or a cross as the label of the list.
12210 These lists are in fact dedicated variants of the
12215 They do however require that you have the
12219 packages installed.
12222 \begin_layout Subsubsection
12226 \begin_layout Standard
12231 TeX redefines the floating tables and figures so that they appear exactly
12232 where they are in the text rather than pushing them to the top of the page
12233 or to some user specified location.
12234 In fact if you change the float placement settings they are simply ignored.
12237 \begin_layout Subsubsection
12238 Page Headers and Footers
12239 \begin_inset LatexCommand label
12240 name "sec:foilfoot"
12247 \begin_layout Standard
12257 are two commands used to control the left-footer text string.
12258 The first is meant to allow you to include a graphic logo on your foils
12260 \begin_inset Quotes eld
12268 \begin_inset Quotes erd
12272 While the second is meant to provide a classification for the audience,
12275 e.\InsetSpace \thinspace{}
12280 It is empty by default.
12283 \begin_layout Standard
12284 The remaining page corners can be filled by
12289 (which defaults to page numbers),
12302 \begin_layout Subsection
12308 \begin_inset LatexCommand label
12309 name "sec:unsuppfoils"
12316 \begin_layout Standard
12317 All the commands mentioned below need to be set in a
12325 within another environment.
12328 \begin_layout Subsubsection
12332 \begin_layout Standard
12333 All lengths are adjusted using the
12356 should be replaced by the name given to the length you want to change and
12361 is the length value.
12362 All lengths should be specified in units of length such as inches (
12374 ) or relative to some document or font-based length such as
12384 \begin_layout Standard
12385 It's possible to change the spacing between a foilhead and the body of the
12386 foil by adjusting the length specified by
12393 For example, to make
12397 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12404 foilheadskip}{-0.5in}
12407 \begin_layout Standard
12408 The spacings around floats can be adjusted by setting these lengths:
12412 \labelwidthstring MMMMMMMMMMM
12419 Separation between the text and the top of the float
12423 \labelwidthstring MMMMMMMMMMM
12430 Separation between the float and the caption
12434 \labelwidthstring MMMMMMMMMMM
12441 Separation between the caption and the following text
12445 \labelwidthstring MMMMMMMMMMM
12452 You can make the captions narrower than the surrounding text by adjusting
12454 Best done relative to
12463 \begin_layout Standard
12464 There are also several title page related lengths that you may find useful
12465 if you have a long title or several authors:
12469 \labelwidthstring MMMMMMMMMMM
12476 Separation from headers to
12482 \labelwidthstring MMMMMMMMMMM
12501 \labelwidthstring MMMMMMMMMMM
12516 \labelwidthstring MMMMMMMMMMM
12533 \labelwidthstring MMMMMMMMMMM
12549 \begin_layout Standard
12550 The last length related command affects all the list environments.
12561 a list environment then all the vertical spacing between the list items
12563 Note that this is a command not a length so it doesn't require
12569 like the stuff mentioned above.
12572 \begin_layout Subsubsection
12573 Headers and Footers
12576 \begin_layout Standard
12589 commands control whether the logo in the
12593 definition appear on a given page.
12600 in the preamble then none of the foils will have the logo on them.
12601 If you don't want the logo on a particular page place the
12607 directly after the foilhead of that page and the
12613 directly after the next foilhead.
12616 \begin_layout Standard
12617 If you decide to use the
12621 page style setting in the
12623 Document\InsetSpace ~
12626 dialog you should probably add
12636 to your preamble so headers and footers on landscape pages are correctly
12637 placed when rotated.
12638 This is due to some clashes between the page layouts provided by the
12649 \begin_layout Section
12650 Latex8 (IEEE Conference Papers)
12653 \begin_layout Standard
12659 \begin_layout Subsection
12663 \begin_layout Standard
12664 Since this class is specifically for writing submissions to IEEE sponsored
12665 conferences I strongly recommend that you get a copy of their Authors Kit.
12670 package and associated bibliography style file is included in the kit.
12671 The Authors Kit is usually sent out by email once your initial submission
12673 There is a lot of useful information in the Authors Kit explaining formatting
12674 restrictions and so on and I will assume you have read this since that
12675 means I don't have to repeat it all here.
12678 \begin_layout Subsection
12682 \begin_layout Standard
12683 [AR\SpecialChar \@.
12687 \begin_layout Subsection
12688 Supported Environments
12691 \begin_layout Itemize
12697 \begin_layout Itemize
12703 \begin_layout Itemize
12709 \begin_layout Itemize
12715 \begin_layout Itemize
12721 \begin_layout Itemize
12727 \begin_layout Itemize
12733 \begin_layout Itemize
12739 \begin_layout Itemize
12745 \begin_layout Subsection
12746 Differences Between Screen and Paper
12749 \begin_layout Standard
12750 There are slight differences in appearance mainly with the presentation
12751 of section counters.
12752 On screen the trailing period of the section counter is missing but it
12753 will appear in the output so don't let this worry you.
12756 \begin_layout Section
12757 Hollywood (Hollywood spec scripts)
12760 \begin_layout Standard
12766 \begin_layout Subsection
12770 \begin_layout Standard
12771 Getting the format of a Hollywood script right is a
12772 \begin_inset Quotes eld
12776 \begin_inset Quotes erd
12779 It is designed to make the readers focus on content and to be easy and
12780 familiar for the actors to read.
12781 Each page of a script should be one minute of film.
12782 Nothing goes in a script that you cannot see or hear on screen.
12783 The courier 12 pt font should be used throughout.
12787 \begin_layout Subsection
12791 \begin_layout Standard
12792 Speakers' lines should NEVER break in mid-sentence.
12793 If a speaker's lines continue over a page break, repeat the
12797 title followed by (Cont'd).
12800 \begin_layout Subsection
12804 \begin_layout Standard
12809 names as labels then cross-reference the label to insert the name.
12810 The cross-reference dialog will show the current cast of characters.
12811 You can use this to insert the speaker name in narratives also.
12814 \begin_layout Subsection
12815 Paper size and Margins
12818 \begin_layout Standard
12819 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12822 \begin_layout Subsection
12826 \begin_layout Standard
12827 The following environments are available.
12828 You can use hollywood.bind to get the bind keys shown at the right.
12831 \begin_layout Itemize
12838 Used where nothing else works.
12842 \begin_layout Itemize
12855 Usually followed by something like
12856 \begin_inset Quotes eld
12859 on Sally waking up.
12860 \begin_inset Quotes erd
12866 \begin_layout Itemize
12875 Introduces a new INTERIOR camera set-up.
12876 Always followed by DAY or NIGHT, or something similar to define the lighting
12878 Everthing on this line in CAPS.
12881 \begin_layout Itemize
12890 Introduces a new EXTERIOR camera set-up.
12891 Everthing on this line in CAPS.
12894 \begin_layout Itemize
12903 The character speaking.
12906 \begin_layout Itemize
12915 Instructions to the speaker.
12916 The () are automatically inserted, but only the ( will show in LyX.
12917 Both will be printed.
12920 \begin_layout Itemize
12936 \begin_layout Itemize
12945 Camera movement instruction.
12946 e.\InsetSpace \thinspace{}
12951 \begin_layout Itemize
12959 \begin_layout Itemize
12967 \begin_layout Itemize
12975 \begin_layout Itemize
12983 \begin_layout Subsection
12987 \begin_layout Itemize
12988 (O.S) --- off screen
12991 \begin_layout Itemize
12992 (V.0) --- voice over
12995 \begin_layout Itemize
13000 \begin_layout Itemize
13005 \begin_layout Itemize
13006 PAN --- camera movement
13009 \begin_layout Itemize
13010 INSERT --- cut to close-up of
13013 \begin_layout Section
13017 \begin_layout Standard
13023 \begin_layout Subsection
13027 \begin_layout Standard
13028 Broadway is for writing plays.
13029 The format is more decorative than Hollywood, and much less standardized.
13030 This format should be suitable for workshops.
13033 \begin_layout Subsection
13037 \begin_layout Standard
13038 The same as in Hollywood.
13041 \begin_layout Subsection
13045 \begin_layout Standard
13050 names as labels then cross-reference the label to insert the name.
13051 The cross-reference dialog will show the current cast of characters.
13054 \begin_layout Subsection
13055 Paper size and Margins
13058 \begin_layout Standard
13059 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13062 \begin_layout Subsection
13066 \begin_layout Standard
13067 The following environments are available.
13068 You can use broadway.bind to get the bind keys shown at the right.
13071 \begin_layout Itemize
13078 You should not have to use this, but it is here for anything that does not
13082 \begin_layout Itemize
13091 Used to describe stage setting and the action.
13092 First use of speaker names in all CAPs.
13095 \begin_layout Itemize
13104 Automatically numbered.
13105 On screen it will be arabic, but will print as Roman.
13108 \begin_layout Itemize
13122 It is just centered text.
13125 \begin_layout Itemize
13134 Not automatically numbered.
13135 You supply the number.
13136 This is because I couldn't figure out how.
13139 \begin_layout Itemize
13148 A special case of Narrative to describe the setting and action as the curtain
13152 \begin_layout Itemize
13161 The speaker's (actor's) title, centered in all CAPS.
13164 \begin_layout Itemize
13173 Instructions to the speaker.
13174 The parentheses are automatically inserted.
13175 The ( will appear on screen, but both will be in the printed play.
13176 This environment is only used within
13183 \begin_layout Itemize
13192 What the Speaker says.
13195 \begin_layout Itemize
13204 The curtain comes down.
13207 \begin_layout Itemize
13215 \begin_layout Itemize
13223 \begin_layout Itemize
13231 \begin_layout Standard
13235 \begin_layout Section
13239 \begin_layout Standard
13245 \begin_layout Standard
13246 \begin_inset VSpace bigskip
13252 \begin_layout Standard
13256 Revtex\InsetSpace ~
13259 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13260 \begin_inset Formula $\beta$
13263 release of May, 1999) class.
13266 \begin_layout Standard
13271 textclass, which works with RevTeX 3.1.
13272 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13273 That means that it doesn't interact very well with LyX, which requires
13274 LaTeX2e, although it has been kludged to work.
13275 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13278 RevTeX\InsetSpace ~
13281 textclass should also be pretty easy to use.
13284 \begin_layout Standard
13285 These documents are supposed to be used in
13289 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13290 macros, and assume you'll know what to put in the preamble if necessary.
13293 \begin_layout Subsection
13297 \begin_layout Standard
13298 All you need to do is install RevTeX 4, as described in the package's README
13300 The package can be found at
13301 \begin_inset LatexCommand url
13302 name "The RevTeX 4 Web Site"
13303 target "http://publish.aps.org/revtex4/"
13308 Install it somewhere that LaTeX can see it.
13309 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13310 (i.e., not the directory where you installed the class file.) Then, if you
13311 reconfigure LyX, it will find the class file and let you use the RevTeX4
13315 \begin_layout Standard
13316 Probably the easiest way to get started is either to import a RevTeX 4 document
13323 Revtex\InsetSpace ~
13326 template, found in the templates directory.
13329 \begin_layout Subsection
13333 \begin_layout Standard
13334 Optional arguments to
13341 \begin_inset Quotes eld
13345 \begin_inset Quotes erd
13349 \begin_inset Quotes eld
13353 \begin_inset Quotes erd
13367 Document\InsetSpace ~
13371 Remember that in RevTeX, at least one optional argument is required!
13374 \begin_layout Standard
13375 Other preamble matter, like
13391 dialog, also as usual.
13394 \begin_layout Subsection
13398 \begin_layout Standard
13399 The layouts basically correspond to the commands in RevTeX4.0.
13400 For example, the Email layout corresponds to
13407 Note that (at least as of RevTeX 4.0 Beta), the
13415 layouts are exactly equivalent, so you shouldn't need to use both.
13419 \begin_layout Standard
13420 In case you're curious, both were included so that
13424 would be able to translate both
13444 \begin_layout Subsection
13448 \begin_layout Standard
13449 There are a couple of important unique aspects of RevTeX 4 which might cause
13450 bugs that will be even more confusing in LyX.
13453 \begin_layout Standard
13471 The LyX equivalent is that there is a separate Thanks layout.
13476 write footnotes in the
13480 layout, or weird things may happen.
13481 See the RevTeX 4 documentation for more details.
13484 \begin_layout Standard
13487 Author\InsetSpace ~
13492 Author\InsetSpace ~
13499 layouts must be placed
13507 layout and the corresponding
13524 , the LaTeX won't compile.
13527 \begin_layout Subsection
13531 \begin_layout Standard
13532 The main problem with this layout is that you can't use the optional arguments
13533 to layouts like Email and Title.
13534 (The problem is not unique to this layout; you can't use optional arguments
13535 to the Section layouts either.) This means that after you export that file
13536 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13537 need to edit the LaTeX file with a text editor to add the optional arguments
13538 to set, e.\InsetSpace \thinspace{}
13539 g., the running title for the page headers.
13540 Lacking these layouts makes the
13546 (and the equivalent
13552 ) useless, so the corresponding layouts don't exist, and will have to be
13557 \begin_layout Standard
13562 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13563 has not been updated yet to take advantage of it.
13571 \begin_layout Section
13572 Article (mwart), book (mwbk) and report (mwrep)
13573 \begin_inset OptArg
13576 \begin_layout Standard
13589 \begin_layout Standard
13595 \begin_layout Standard
13596 The LyX document classes
13612 correspond to the LaTeX document classes
13625 They are replacements for the standard document classes
13637 , resp., and fit better to Polish typography conventions in a number of points.
13641 \begin_layout Standard
13645 \begin_layout Itemize
13646 Unnumbered titles (with star, eg.
13651 ) are added into table of contents,
13654 \begin_layout Itemize
13655 Additional page styles:
13659 \begin_layout Description
13660 uheadings header with separated lines,
13663 \begin_layout Description
13664 myheadings custom header, contents headers via commands:
13679 \begin_layout Description
13680 myuheadings custom header with separated lines,
13683 \begin_layout Description
13684 outer page number is placed on outer side of page
13688 \begin_layout Itemize
13693 \begin_layout Description
13694 rmheadings serif titles --- default,
13697 \begin_layout Description
13698 sfheadings sansserif titles,
13701 \begin_layout Description
13702 authortitle on title page first placed is author next title --- default,
13705 \begin_layout Description
13706 titleauthor on title page first placed is title next author,
13709 \begin_layout Description
13710 withmarginpar reserve place on page for margins.
13714 \begin_layout Section
13718 \begin_layout Standard
13724 \begin_layout Standard
13725 Elsevier Science Publishers B.V.
13726 provides a standard LaTeX document class (
13730 ) for submitting articles to their various journals.
13731 The style file can be downloaded directly from their web site:
13732 \begin_inset LatexCommand url
13733 target "http://authors.elsevier.com/"
13738 Instructions are supplied along with the class file, which details the
13739 requirements of the publishers.
13740 LyX includes package that allows for the use of this class, by a layout
13741 and a template file.
13742 Installation of the class file is the same as for any other LaTeX package;
13743 instructions are provided in the Elsevier documentation.
13746 \begin_layout Standard
13756 As the Elsevier class file is based mainly on the standard article class,
13757 most of the normal functionality is provided.
13758 The Elsevier class defines a number of mathematical environments, which
13759 are similar to the AMS environments.
13760 These commands are all described in the Elsevier documentation, and are
13764 \begin_layout Standard
13765 The easiest way to use the Elsevier style is to base documents on the included
13767 It is best not to use options such as fancy headings or the geometry package,
13768 as elements such as these are defined by Elsevier in their style file.
13769 Ideally, no extra packages except those mentioned in the Elsevier documentation
13771 Essentially, Elsevier require as
13772 \begin_inset Quotes eld
13776 \begin_inset Quotes erd
13783 \begin_layout Standard
13792 file as possible, as their intention is to take the supplied file and replace
13793 the class file with one for the particular journal to which the paper has
13795 This also means that not too much time should be spent on the formating
13797 When it comes to be published, this will change anyway.
13798 The rest of the usage for this layout is substantially the same as for
13799 the normal article class.
13800 For details of what Elsevier do and don't allow, refer to their documentation.
13803 \begin_layout Section
13807 \begin_layout Standard
13810 Jürgen Spitzmüller
13813 \begin_layout Subsection
13817 \begin_layout Standard
13818 Memoir is a very powerful and constantly evolving class.
13819 It has been designed with regard to fictional and non-fictional literature.
13820 Its aim is to let the user have maximum control over the typesetting of
13822 Memoir is based on the standard book class, but it can also emulate the
13823 article class (see below).
13826 \begin_layout Standard
13827 Peter Wilson, the developer of Memoir, is known as the author of lots of
13828 useful packages in the LaTeX world.
13829 Most of them have been merged with Memoir.
13830 Therefore, it is much easier to layout the table of contents, appendices,
13831 chapter designs and such.
13832 LyX, though, does not support all of these goodies natively.
13833 Some of them might be added to forthcoming releases
13837 \begin_layout Standard
13838 You are invited to send suggestions to
13839 \begin_inset LatexCommand url
13840 target "lyx-devel@lists.lyx.org"
13849 , lots will probably never, due to the limitations of LyX's framework.
13850 Of course you can still use all features with the help of some native LaTeX
13855 \begin_layout Standard
13860 \begin_layout Standard
13869 section\InsetSpace ~
13871 \begin_inset LatexCommand ref
13872 reference "sec:Inserting-LaTeX-Code"
13882 In this section, we can only list those features which are natively supported
13884 For detailed descriptions (and for the rest of features) we are recommending
13885 to have a look at the detailed manual of the Memoir class
13889 \begin_layout Standard
13894 \begin_layout Standard
13904 \begin_inset LatexCommand url
13905 target "CTAN:/macros/latex/memoir/memman.pdf"
13914 , which is not only a user guide for the class, but also both a comprehensive
13915 description on good typesetting and a superb example for good typesetting
13919 \begin_layout Subsection
13920 Basic features and restrictions
13923 \begin_layout Standard
13924 Memoir supports basically all features of the standard book classes.
13925 There are, however, some differences, as follows:
13928 \begin_layout Description
13930 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
13934 \begin_layout Description
13936 style: The fancy page style is not supported, due to a command clash
13937 between Memoir and the fancyhdr package (they are both defining a command
13938 with the same name, which confuses LaTeX).
13939 Instead, Memoir comes with a bunch of own page styles (see
13941 Layout\SpecialChar \menuseparator
13942 Document\SpecialChar \menuseparator
13947 If you want to use these for the chapter pages, you have to use the command
13954 in the main text or in preamble (e.
13958 \begin_layout Standard
13971 \begin_layout Standard
13984 chapterstyle{companion}
13989 \begin_layout Description
13990 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13991 an optional argument in the standard classes.
13992 With this, you can specify an alternative version of the title for the
13993 table of contents and the headers (for instance, if the title is too long).
13994 In LyX, you can do this via
13996 Insert\SpecialChar \menuseparator
14000 at the beginning of a chapter/section.
14001 Memoir features a second optional argument and thus separates the table
14002 of contents from the header.
14003 You can define three variants of a title with this: one for the main text,
14004 one for the table of contents, and one for the headers.
14005 Simply insert two optional arguments if you need this feature, the first
14006 one containing the short title for the Table of Contents, the second one
14007 containing an alternative short title for the headers.
14010 \begin_layout Description
14011 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14012 of contents, the list of figures and the list of table start a new page
14014 Memoir does not follow this route.
14015 You have to insert a page break yourself, if you want to have one.
14018 \begin_layout Description
14019 Titlepage: For some unknown reason, Memoir uses pagination on the title
14020 page (in the standard classes, title pages are
14021 \begin_inset Quotes eld
14025 \begin_inset Quotes erd
14032 \begin_layout Standard
14045 \begin_layout Standard
14055 If you want an empty title page, type
14059 aliaspagestyle{title}{empty}
14064 \begin_layout Description
14065 Article: With the class option
14071 Layout\SpecialChar \menuseparator
14072 Document\SpecialChar \menuseparator
14076 ), you can emulate article style.
14077 That is, counters (footnotes, figures, tables etc.) will not be reset on
14078 new chapters, chapters don't start a new page (but are---in contrary to
14080 \begin_inset Quotes eld
14084 \begin_inset Quotes erd
14087 article classes---still allowed), parts, though, use their own page, as
14091 \begin_layout Description
14092 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14093 font commands, which have been used in the old LaTeX version 2.09 (e.
14097 \begin_layout Standard
14110 \begin_layout Standard
14132 It produces an error and stops LaTeX whenever such a command appears.
14137 reallows the commands and spits out warnings instead (which does at least
14139 Since a lot of packages and particularly BibTeX style files are still using
14140 those commands, we have decided to use this option by default.
14143 \begin_layout Subsection
14147 \begin_layout Standard
14148 We will only describe the features supported by LyX (which is not much currently
14150 Please consult the Memoir manual
14154 \begin_layout Standard
14159 \begin_layout Standard
14169 \begin_inset LatexCommand url
14170 target "CTAN:/macros/latex/memoir/memman.pdf"
14182 \begin_layout Description
14183 Abstract: You may wonder why an abstract is an extra feature.
14184 Well, it is in book class.
14185 Usually books don't have abstracts.
14186 Memoir, however, has.
14187 You can use it wherever and how often you like.
14190 \begin_layout Description
14191 Chapterprecis: You may know this from belletristic: The contents of a chapter
14192 is shortly described below the title and also in the table of contents
14197 \begin_layout Standard
14210 \begin_layout Standard
14221 Our hero arrives in Troia; he loses some friends; he finds others
14224 Chapterprecis does exactly this.
14225 It is therefore only sensible below a chapter.
14228 \begin_layout Description
14229 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14230 The epigraph environment provides an elegant way of typesetting such a
14232 The motto itself (text) and its author (source) are divided by a short
14234 Unfortunately, we have to fool LyX a bit here again, since the environment
14235 needs two arguments (text and source).
14236 In this case, we have to use curly brackets (in TeX mode) between the two
14247 <author of the slogan>.
14250 \begin_layout Description
14251 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14252 complex figurative poems).
14253 LyX can only support a few of them.
14254 One is poemtitle, which is a centered title for poems, which will also
14255 be added to the table of contents (verse is the standard environment for
14257 Memoir has some enhanced versions of verse, but you need to use ERT, because
14258 they have to be nested inside regular verse environments, which is not
14259 possible with LyX).
14262 \begin_layout Description
14263 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14266 \begin_layout Chapter
14267 Importing and Exporting Alternate File Formats
14268 \begin_inset OptArg
14271 \begin_layout Standard
14272 Importing and Exporting
14280 \begin_layout Section
14284 \begin_layout Standard
14285 Importing and exporting LyX documents from/to other formats has been touched
14291 Here we describe more of the gory details needed to understand just what
14292 is going on when you click on the
14297 ile\SpecialChar \menuseparator
14309 ile\SpecialChar \menuseparator
14320 \begin_layout Section
14321 Importing Other Formats
14324 \begin_layout Subsection
14328 \begin_layout Standard
14329 Translating from LaTeX into LyX is performed by a converter program called
14335 Although it is a standalone program which can be called from the command
14336 line, LyX will call it automatically when a LaTeX document is imported.
14337 See section\InsetSpace ~
14339 \begin_inset LatexCommand ref
14340 reference "sec:Translating-LaTeX-files"
14344 for a complete description.
14347 \begin_layout Subsection
14351 \begin_layout Standard
14352 When importing plain ASCII text, there are two methods of reading the file.
14354 \begin_inset Quotes eld
14358 \begin_inset Quotes erd
14361 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14364 \begin_inset Quotes eld
14368 \begin_inset Quotes erd
14371 assumes that consecutive lines separated by only a single linebreak form
14372 a single paragraph.
14373 Successive linebreaks with no intervening text are thus assumed to be paragraph
14377 \begin_layout Subsection
14381 \begin_layout Standard
14384 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14387 \begin_layout Section
14388 Exporting Other Formats
14391 \begin_layout Standard
14392 The output formats listed here in the following are also explained concerning
14393 possible graphics formats in the
14400 \begin_layout Subsection
14404 \begin_layout Standard
14405 LyX generates two types of LaTeX files: stripped down versions for the normal
14410 , etc.) which one normally never sees
14414 \begin_layout Standard
14415 The resulting file is a perfectly valid LaTeX file, though the preamble
14416 might look a bit strange since it includes some definitions used by LyX
14417 which wouldn't show up in most human-written files.
14422 , and human readable forms which are suitable for exchanging with your colleague
14424 The only settable option for the translation is the line length of the
14426 The default is 65 characters, but it can be set in
14433 \SpecialChar \menuseparator
14454 \begin_layout Subsection
14455 Device Independent Files
14458 \begin_layout Standard
14459 Device Independent files (DVI files) are produced by running LaTeX on your
14461 There are no user settable options.
14464 \begin_layout Subsection
14468 \begin_layout Standard
14469 The next step in the conversion chain is converting a DVI file into Postscript.
14477 \SpecialChar \menuseparator
14485 \SpecialChar \menuseparator
14494 or, if you need more control on the result,
14501 \SpecialChar \menuseparator
14510 If you use the later, note that it is possible to configure, in
14517 \SpecialChar \menuseparator
14525 , the options passed to the dvips program to achieve different effects.
14528 \begin_layout Subsection
14532 \begin_layout Standard
14533 Exporting as ASCII attempts to preserve the
14534 \begin_inset Quotes eld
14538 \begin_inset Quotes erd
14541 of the document as well as possible, but things like centering and indentation
14542 are thrown out; paragraphs are separated by blank lines.
14543 Section numbering and cross-references are done correctly, so the resulting
14544 text files is remarkably readable.
14545 The only changeable option is the length of lines, as for LaTeX output.
14548 \begin_layout Subsection
14552 \begin_layout Standard
14553 LyX documents can be converted to hypertext markup, usually by converting
14554 to LaTeX first, then converting that to HTML\SpecialChar \@.
14556 \begin_inset Formula $\rightarrow$
14559 HTML converters are currently known to LyX:
14576 Though they are autodetected, you can overide the selection in preferences.
14577 You can also include further command line options in this dialog.
14581 \begin_layout Subsection
14585 \begin_layout Standard
14593 \begin_layout Standard
14594 \begin_inset VSpace bigskip
14600 \begin_layout Standard
14601 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14602 any version of LyX is to save the document as a Postscript file, then run
14608 Starting with version 1.1.6, the menu item
14612 will do all this for you.
14613 There are some issues with fonts that you need to pay attention to: see
14614 Section\InsetSpace ~
14616 \begin_inset LatexCommand ref
14617 reference "sec:badfonts"
14622 Also, as of version 1.1.6, there is a better method that will generate much
14623 more sophisticated files.
14626 \begin_layout Subsubsection
14630 \begin_layout Standard
14631 With pdfLaTeX you cannot use pstricks.
14632 On the other hand, with pdfLaTeX it is possible to insert directly images
14633 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14636 \begin_layout Subsubsection
14637 Why does the text look so bad when viewed with Acrobat Reader?
14638 \begin_inset LatexCommand label
14639 name "sec:badfonts"
14644 \begin_inset OptArg
14647 \begin_layout Standard
14648 Bad Fonts in Acrobat Reader
14656 \begin_layout Standard
14657 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14658 When creating a PDF from the LyX file, you need to use outline font instead
14659 of the default bitmap fonts (in fact, you should also use outline fonts
14660 for Postscript files).
14661 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14662 (Computer Modern) fonts.
14663 pdfLaTeX uses these font by default.
14664 Dvips doesn't use these fonts by default, so to make it use them, add the
14665 following to lines to your
14672 \begin_layout LyX-Code
14676 \begin_layout LyX-Code
14680 \begin_layout Standard
14681 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14683 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14684 fonts, for which there are no Type1 version.
14685 The solution is to use the ae package which emulates T1 coded fonts using
14686 the standard CM fonts.
14687 This is done by adding
14691 usepackage{ae,aecompl}
14693 to the preamble of the LyX file.
14694 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14697 they are taken from the EC fonts.
14698 Therefore you get these glyphs as bitmaps.
14701 \begin_layout Standard
14702 Note: LyX uses by default the T1 font encoding.
14703 If you wish to use the default font encoding (this is not recommended,
14704 unless you only write English documents), clear the field
14712 in preferences (tabs
14724 \begin_layout Standard
14725 An alternate option is to use the standard Postscript fonts instead of the
14726 Computer Modern fonts.
14727 To do that, you need to select
14731 as the global font in the document layout dialog.
14732 When using the Postscript fonts, the result PDF file is smaller as the
14733 fonts are not saved into the file.
14734 Furthermore, the Postscript fonts include all T1 glyphs.
14735 On the other hand, the Postscript fonts have no bold symbol font, so poor
14736 man's bold must be used (see Section\InsetSpace ~
14738 \begin_inset LatexCommand ref
14739 reference "sec:pdfbold"
14744 The Postscript fonts also look different from the Computer Modern fonts.
14747 \begin_layout Standard
14748 To sum up, both the Computer Modern and the Postscript fonts gives good
14749 results (with few exceptions).
14750 The decision of which one to use is a matter of taste.
14753 \begin_layout Subsubsection
14756 boldsymbol{} command work when I use pslatex?
14757 \begin_inset LatexCommand label
14763 \begin_inset OptArg
14766 \begin_layout Standard
14783 \begin_layout Standard
14784 The Postscript fonts do not have a bold symbol font.
14785 The solution is to use the
14791 (poor man's bold) command.
14794 \begin_layout Standard
14795 It is possible to redefine the
14810 \begin_layout LyX-Code
14820 \begin_layout Standard
14824 \begin_layout Subsubsection
14825 Is it possible to do write LaTeX-code which is processed only when running
14827 \begin_inset OptArg
14830 \begin_layout Standard
14831 Conditionals with pdfLaTeX
14839 \begin_layout Standard
14840 Yes you can do this with the
14845 Here is an example:
14848 \begin_layout LyX-Code
14852 \begin_layout LyX-Code
14858 \begin_layout LyX-Code
14864 \begin_layout LyX-Code
14867 pdfinfo { /Author (your name and e-mail address)
14870 \begin_layout LyX-Code
14871 /Title (official title -- i.e., title element)
14874 \begin_layout LyX-Code
14875 /Subject (one line description of the document)
14878 \begin_layout LyX-Code
14882 \begin_layout LyX-Code
14885 pdfcatalog { /PageMode (/UseNone)
14888 \begin_layout LyX-Code
14889 % /OpenAction (fitbh)
14892 \begin_layout LyX-Code
14896 \begin_layout LyX-Code
14899 usepackage[pdftex]{hyperref}
14902 \begin_layout LyX-Code
14908 \begin_layout LyX-Code
14911 usepackage[ps2pdf]{hyperref}
14914 \begin_layout LyX-Code
14920 \begin_layout Subsubsection
14921 How can I make URLs clickable?
14924 \begin_layout Standard
14925 See the references here:
14928 \begin_layout Standard
14929 \begin_inset LatexCommand url
14930 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
14937 \begin_layout Subsection
14941 \begin_layout Standard
14942 Custom exports are possible if you have some particularly weird format you
14943 wish to convert to, assuming you have the relevant converter, of course.
14948 file can be chosen in the
14953 ile\SpecialChar \menuseparator
14958 xport\SpecialChar \menuseparator
14965 dialog; LyX will automatically convert the file to this point, then feed
14966 it to your custom converter.
14967 The possible values are all formats that LyX can produce from its own documents.
14971 \begin_layout Standard
14972 The converter command is also specified in the dialog.
14973 It should be a completely qualified command line which uses the variable
14978 to specify the name of the file.
14979 If this variable is not given, then the file will be sent to the standard
14980 input of your command.
14981 You may have to apply a bit of ingenuity to escape this sequence correctly
14982 so that it is compatible with your shell.
14986 \begin_layout Standard
14987 While it is not possible to save this command using the
14991 dialog, you can manually edit your
14998 \begin_layout LyX-Code
15001 custom_export_command "mycommand $$FName"
15004 \begin_layout Chapter
15005 LyX Features needing Extra Software
15008 \begin_layout Section
15012 \begin_layout Standard
15018 \begin_layout Subsection
15022 \begin_layout Standard
15030 menu, you'll find a
15039 This feature requires you to have the
15043 program installed, and is grayed out if you don't have it.
15044 You can get it from your nearest CTAN mirror, or over the Web from
15045 \begin_inset LatexCommand url
15046 target "http://www.ifi.uio.no/~jensthi/chktex/"
15053 \begin_layout Standard
15058 package is a program that was written by
15063 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15064 and easy to forget.
15065 The program runs over your LaTeX file and checks the integrity of the file,
15066 and flags some common errors.
15067 In other technical words, it is
15074 \begin_layout Standard
15075 Well, what is a syntax checker doing in LyX which is supposed to produce
15076 correct LaTeX anyways? The answer is simple: Just as
15080 not only checks the
15084 of C programs, but also does
15088 checks for type-errors,
15092 catches some common
15096 errors, in addition to the syntactical ones.
15101 is capable of detecting several common errors, such as
15104 \begin_layout Itemize
15105 Ellipsis detection:
15107 Use \SpecialChar \ldots{}
15111 \begin_layout Itemize
15112 No space in front of/after parenthesis:
15117 \begin_layout Itemize
15118 Enforcement of normal space after common abbreviations:
15122 is too wide spacing.
15125 \begin_layout Itemize
15126 Enforcement of end-of-sentence space when the last sentence ends with a
15130 And this is wrong spacing.
15133 \begin_layout Itemize
15134 Space in front of labels and similar commands:
15136 The label should stick right
15137 up to the text to avoid falling to a wrong page.
15139 \begin_inset LatexCommand label
15148 \begin_layout Standard
15149 This footnote is in danger of falling off to a wrong page
15154 The label is separated too much.
15157 \begin_layout Itemize
15158 Space in front of references, instead of hard spaces:
15160 In you are in bad luck,
15161 the text will break right between the referenced text and reference number,
15164 \begin_inset LatexCommand ref
15165 reference "sec:chktex"
15172 \begin_layout Itemize
15174 \begin_inset Quotes eld
15178 \begin_inset Quotes erd
15182 \begin_inset Formula $\times$
15187 2x2 looks cheap compared to
15188 \begin_inset Formula $2\times2$
15194 \begin_layout Standard
15195 and more \SpecialChar \ldots{}
15196 It is an invaluable tool when you are
15197 \begin_inset Quotes eld
15201 \begin_inset Quotes erd
15204 your document before printing, and you should run it right after the obligatory
15205 spelling check, and before you go fine tuning the typesetting.
15208 \begin_layout Subsection
15212 \begin_layout Standard
15213 If you have the program installed, usage is as simple as choosing
15218 ools\SpecialChar \menuseparator
15227 This will make LyX generate a LaTeX file of your document, start
15231 to check it, and then make LyX insert
15232 \begin_inset Quotes eld
15236 \begin_inset Quotes erd
15239 with the warnings from
15243 , if there were any.
15244 The warnings will be placed close to the point of the mistake, and you
15245 can quickly find them by using the
15250 avigate\SpecialChar \menuseparator
15257 menu item, or the shortcut key
15266 Open the error boxes by clicking on them with the mouse, or use the shortcut
15275 bindings, or the corresponding
15284 Read the warning and correct the mistake, if it is a mistake.
15285 If you have trouble understanding what the warning is about, you can safely
15287 Remember that there is a hidden layer between the document on screen and
15288 the technical details in invoking
15292 , and this gap can make some warnings seem arcane or just right down plain
15296 \begin_layout Standard
15297 This document is an excellent testing bed for the feature, and it should
15298 provide quite a few warnings for you to fiddle with.
15299 Since computers are only so smart, expect most of the warnings to be false
15303 \begin_layout Subsection
15304 How to fine tune it
15307 \begin_layout Standard
15308 Sometimes, you'll find that
15312 makes more noise than suits your mood.
15313 Then you can choose not to use it, wait until your mood changes, or try
15318 to get better along with you.
15319 Another choice in the most desperate situations is to use
15324 iew\SpecialChar \menuseparator
15334 , which will get rid of all warnings instantly.
15337 \begin_layout Standard
15346 very configurable and extensible, you shouldn't expect to solve all problems
15352 Since LyX has to generate a somewhat special LaTeX file to be able to match
15353 the line numbers from the
15361 \begin_layout Standard
15362 You can inspect the specific output from
15368 Edit\SpecialChar \menuseparator
15382 to the internal document structure, some of the warnings will not seen
15383 to appear correctly.
15384 There are two things you can do about this:
15387 \begin_layout Itemize
15392 invocation command line in
15408 installation configuration file (usually with the file
15413 See below to learn what warnings can be enabled and disabled on the command
15418 \begin_layout Itemize
15419 Export your document as a raw LaTeX file using
15424 ile\SpecialChar \menuseparator
15429 xport\SpecialChar \menuseparator
15441 Invoked in this way, it can be a hassle to find the corresponding place
15442 in the document inside LyX, but with a little patience, you should be able
15446 \begin_layout Standard
15447 Here follows the warning messages that can be enabled and disabled in
15456 to disable a warning, and
15460 to enable a warning.
15461 The emphasized entries are disabled by default, because the default is
15464 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15469 \begin_layout Standard
15470 Notice that you should only use the options that enable and disable warnings,
15471 because LyX relies on some of the other command line parameters to be set
15472 in a specific way to have a chance to communicate with
15479 \begin_layout Enumerate
15483 Command terminated with space.
15486 \begin_layout Enumerate
15489 Non-breaking space (
15490 \begin_inset Quotes eld
15498 \begin_inset Quotes erd
15501 ) should have been used.
15504 \begin_layout Enumerate
15508 You should enclose the previous parenthesis with
15509 \begin_inset Quotes eld
15517 \begin_inset Quotes erd
15523 \begin_layout Enumerate
15526 Italic correction (
15527 \begin_inset Quotes eld
15537 \begin_inset Quotes erd
15540 ) found in non-italic buffer.
15543 \begin_layout Enumerate
15546 Italic correction (
15547 \begin_inset Quotes eld
15557 \begin_inset Quotes erd
15560 ) found more than once.
15563 \begin_layout Enumerate
15567 No italic correction (
15568 \begin_inset Quotes eld
15578 \begin_inset Quotes erd
15584 \begin_layout Enumerate
15588 \begin_inset Quotes eld
15596 \begin_inset Quotes erd
15600 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15614 \begin_layout Enumerate
15617 Wrong length of dash may have been used.
15620 \begin_layout Enumerate
15624 \begin_inset Quotes eld
15632 \begin_inset Quotes erd
15636 \begin_inset Quotes eld
15644 \begin_inset Quotes erd
15650 \begin_layout Enumerate
15654 \begin_inset Quotes eld
15662 \begin_inset Quotes erd
15668 \begin_layout Enumerate
15672 \begin_inset Quotes eld
15680 \begin_inset Quotes erd
15683 to achieve an ellipsis.
15686 \begin_layout Enumerate
15689 Inter-word spacing (
15690 \begin_inset Quotes eld
15700 \begin_inset Quotes eld
15703 ) should perhaps be used.
15706 \begin_layout Enumerate
15709 Inter-sentence spacing (
15710 \begin_inset Quotes eld
15720 \begin_inset Quotes erd
15723 ) should perhaps be used.
15726 \begin_layout Enumerate
15729 Could not find argument for command.
15732 \begin_layout Enumerate
15736 \begin_inset Quotes eld
15744 \begin_inset Quotes erd
15750 \begin_layout Enumerate
15753 Math mode still on at end of LaTeX file.
15756 \begin_layout Enumerate
15760 \begin_inset Quotes eld
15768 \begin_inset Quotes erd
15771 doesn't match the number of
15772 \begin_inset Quotes eld
15780 \begin_inset Quotes erd
15786 \begin_layout Enumerate
15789 You should use either
15792 \begin_inset Quotes eld
15800 \begin_inset Quotes erd
15805 as an alternative to
15806 \begin_inset Quotes eld
15814 \begin_inset Quotes erd
15820 \begin_layout Enumerate
15827 " (ASCII 39) instead of "
15834 \begin_layout Enumerate
15837 User-specified pattern found.
15840 \begin_layout Enumerate
15843 This command might not be intended.
15846 \begin_layout Enumerate
15853 \begin_layout Enumerate
15871 \begin_layout Enumerate
15874 Delete this space to maintain correct page references.
15877 \begin_layout Enumerate
15881 You might wish to put this between a pair of
15882 \begin_inset Quotes eld
15890 \begin_inset Quotes erd
15896 \begin_layout Enumerate
15899 You ought to remove spaces in front of punctuation.
15902 \begin_layout Enumerate
15905 Could not execute LaTeX command.
15908 \begin_layout Enumerate
15917 in front of small punctuation.
15920 \begin_layout Enumerate
15928 may look prettier here.
15931 \begin_layout Enumerate
15935 Multiple spaces detected in output.
15938 \begin_layout Enumerate
15941 This text may be ignored.
15944 \begin_layout Enumerate
15950 \begin_inset Quotes eld
15955 to begin quotation, not
15962 \begin_layout Enumerate
15969 to end quotation, not
15972 \begin_inset Quotes eld
15980 \begin_layout Enumerate
15986 \begin_layout Enumerate
15989 You should perhaps use
15990 \begin_inset Quotes eld
15998 \begin_inset Quotes erd
16004 \begin_layout Enumerate
16007 You should put a space in front of/after parenthesis.
16010 \begin_layout Enumerate
16013 You should avoid spaces in front of/after parenthesis.
16016 \begin_layout Enumerate
16020 You should not use punctuation in front of/after quotes.
16023 \begin_layout Enumerate
16026 Double space found.
16029 \begin_layout Enumerate
16032 You should put punctuation outside inner/inside display math mode.
16035 \begin_layout Enumerate
16038 You ought to not use primitive TeX in LaTeX code.
16041 \begin_layout Enumerate
16044 You should remove spaces in front of
16045 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16059 \begin_layout Enumerate
16062 \begin_inset Quotes eld
16070 \begin_inset Quotes erd
16073 is normally not followed by
16074 \begin_inset Quotes eld
16082 \begin_inset Quotes erd
16088 \begin_layout Standard
16089 In later versions of LyX, we hope to provide a more complete interface to
16090 this tool (and it's smaller cousin
16094 ) to exploit the full power of it.
16095 But it's not exactly useless as it is now: go try it on one of your existing
16096 documents of a certain length and be surprised.
16099 \begin_layout Section
16100 Version Control in LyX
16103 \begin_layout Standard
16106 Lars Gullik Bjønnes
16109 \begin_layout Subsection
16113 \begin_layout Standard
16114 A friend of mine wanted to try LyX for a group project.
16115 When he didn't find support for version control or file locking, he dropped
16117 This angered me a bit, so I thought that I should at least make support
16118 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16119 This has now been done.
16120 LyX now supports some of the most basic RCS commands.
16121 If you need to something a bit more sophisticated you will have to do that
16122 manually in an xterm.
16125 \begin_layout Standard
16126 Before you begin to use the version control features in LyX, you should
16128 \begin_inset Quotes eld
16132 \begin_inset Quotes erd
16135 (a man file, read it with
16140 This file describes all the basic features of RCS.
16141 You should especially notice the comment about a RCS directory, and the
16142 notion of a master RCS file (the file ending in
16149 \begin_layout Standard
16150 The implementation in LyX assumes a recent version of the GNU RCS package---no
16151 guarantees are made for older versions.
16154 \begin_layout Subsection
16155 RCS commands in LyX
16158 \begin_layout Standard
16159 The following sections describe the RCS commands supported by LyX.
16160 You can find them in the
16165 ile\SpecialChar \menuseparator
16170 ersion\InsetSpace ~
16176 \begin_layout Subsubsection
16182 \begin_layout Standard
16183 If your document is not under revision control, this is the only item shown
16185 And if it is under revision control, the
16192 item is grayed out.
16196 \begin_layout Standard
16197 This command registers your document with RCS\SpecialChar \@.
16198 You are asked interactively
16199 to supply an initial description of the document.
16200 The document is now set in Read-Only mode and you have to
16207 , before making any changes to it.
16208 A document under revision control has a
16209 \begin_inset Quotes eld
16212 [RCS:<version> <locker>]
16213 \begin_inset Quotes erd
16216 item tagged to the filename in the minibuffer.
16219 \begin_layout Standard
16220 RCS command that is run:
16222 ci -q -u -i -t-"<initial description>" <file-name>
16225 \begin_layout Standard
16230 to understand the switches.
16234 \begin_layout Subsubsection
16240 \begin_layout Standard
16241 When you are finished editing a file, you check in your changes.
16242 When you do this, you are asked for a description of the changes.
16243 This is stored in the history log.
16244 The version number is bumped, your changes are applied to the master RCS
16245 file, the document is unlocked and set to Read-Only mode.
16249 \begin_layout Standard
16252 ci -q -u -m"<description>" <file-name>
16255 \begin_layout Subsubsection
16261 \begin_layout Standard
16262 By doing this you lock the document so that only you can edit it.
16263 This will also make the document Read-Write only for you.
16264 You will usually continue editing for a while and when you are finished
16265 you check in your changes.
16266 The status line is changed to reflect that you have locked the file.
16270 \begin_layout Standard
16273 co -q -l <file-name>
16276 \begin_layout Subsubsection
16279 Revert To Last Version
16282 \begin_layout Standard
16283 This will discard all changes made to the document since the last check
16285 You get a warning before changes are discarded.
16288 \begin_layout Standard
16291 co -f -u<version> <file-name>
16294 \begin_layout Subsubsection
16300 \begin_layout Standard
16301 This makes as if the last check in never happened.
16302 No changes are made to the document loaded into LyX, but the last version
16303 is removed from the master RCS file.
16307 \begin_layout Standard
16310 rcs -o<version> <file-name>
16313 \begin_layout Subsubsection
16319 \begin_layout Standard
16320 This show the complete history of the RCS document.
16325 is shown in a browser.
16333 \begin_layout Section
16334 Literate Programming
16337 \begin_layout Standard
16342 (kayvan@sylvan.com)
16346 original documentation written by
16348 Edmar Wienskoski Jr.
16351 (edmar-w-jr@technologist.com)
16354 \begin_layout Subsection
16358 \begin_layout Standard
16359 The main purpose of this documentation is to show you how to use LyX for
16360 literate programming.
16361 Where it is assumed that you are familiar with this programming technique,
16363 \begin_inset Quotes eld
16367 \begin_inset Quotes erd
16371 \begin_inset Quotes eld
16375 \begin_inset Quotes erd
16379 If that is not the case, please follow the web links provided in the following
16381 There is a lot of good documentation out there covering old development
16382 history to the latest tools tips.
16385 \begin_layout Standard
16386 It is also assumed that you are familiar with LyX itself to a point that
16387 you are comfortable changing your LyX preferences, and X resources file.
16388 If that is not the case please refer to other LyX documentation to cover
16389 your specific needs.
16392 \begin_layout Subsection
16393 Literate Programming
16396 \begin_layout Standard
16397 From the Literate Programming FAQ:
16400 \begin_layout Quotation
16401 Literate programming is the combination of documentation and source together
16402 in a fashion suited for reading by human beings.
16403 In fact, literate programs should be enjoyable reading, even inviting!
16404 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16405 and documentation in a single file.
16406 Literate programming tools then parse the file to produce either readable
16407 documentation or compilable source.
16408 The WEB style of literate programming was created by D.E.
16409 Knuth during the development of his TeX typesetting software.
16413 \begin_layout Standard
16414 Another excerpt says:
16417 \begin_layout Quotation
16420 How is literate programming different from verbose commenting?
16423 \begin_layout Quotation
16424 There are three distinguishing characteristics.
16425 In order of importance, they are:
16429 \begin_layout Itemize
16430 flexible order of elaboration
16433 \begin_layout Itemize
16434 automatic support for browsing
16437 \begin_layout Itemize
16438 typeset documentation, especially diagrams and mathematics
16442 \begin_layout Standard
16443 Now that I sparked your curiosity, take a look in the references.
16446 \begin_layout Subsubsection
16450 \begin_layout Standard
16451 The complete Literate Programming FAQ can be found at:
16454 \begin_layout Quote
16455 \begin_inset LatexCommand url
16456 name "Literate Programming FAQ"
16457 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
16464 \begin_layout Standard
16465 The FAQ lists 23 (twenty three!) different literate programming tools.
16466 Where some are specialized or
16467 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16474 for particular programming languages, while other have general scope.
16479 for my own use for several reasons:
16482 \begin_layout Itemize
16483 It can generate the documentation either in LaTeX or HTML.
16486 \begin_layout Itemize
16487 It has a open architecture, i.e., it is easy to plug in new filters and to
16488 perform special processing that you may need.
16492 \begin_layout Itemize
16493 There is a good selection of filters available already (the HTML is one
16497 \begin_layout Itemize
16501 \begin_layout Standard
16502 The Noweb web page can be found at:
16505 \begin_layout Quote
16506 \begin_inset LatexCommand url
16507 name "Noweb home page"
16508 target "http://www.cs.virginia.edu/~nr/noweb/"
16515 \begin_layout Standard
16516 Starting from there you can reach many other interesting links and even
16517 some literate program examples.
16520 \begin_layout Subsection
16521 \begin_inset LatexCommand label
16522 name "sub:LyX-and-Literate"
16526 LyX and Literate Programming
16529 \begin_layout Standard
16530 The LyX support for Literate Programming is provided by using the generic
16531 LyX convertors mechanism.
16532 This support is provided in a
16533 \begin_inset Quotes eld
16537 \begin_inset Quotes erd
16540 way, i.e., you will be able to use this new LyX feature with some other literate
16541 programming tool of your choice by just changing your LyX preferences.
16544 \begin_layout Subsubsection
16545 Generating documents and code (weaving and tangling)
16548 \begin_layout Paragraph
16549 Selecting the document class
16552 \begin_layout Standard
16553 If you have installed Noweb and LyX successfully, whenever you open a new
16554 document or try to change the document class of an existing one, you will
16555 find that there are three new document classes available:
16558 \begin_layout Itemize
16562 \begin_layout Itemize
16566 \begin_layout Itemize
16570 \begin_layout Standard
16571 You must select one of them to create your literate documents from.
16575 \begin_layout Standard
16576 Note that literate documents are not limited to these three classes.
16577 New classes can be generated from other styles like letter or in combination
16578 with other class variations like Article (AMS).
16579 If you have special needs that cannot be covered by one of the existing
16580 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16581 will arrange to insert a new entry, or teach you how to do it.
16585 \begin_layout Standard
16586 It is very simple, it involves the creation of a file with four lines, and
16587 re-running of the auto configuration.
16592 Moreover, if you use a literate tool other than Noweb you may need to create
16593 a new set of document classes for it.
16596 \begin_layout Paragraph
16600 \begin_layout Standard
16601 LyX enables you to write code with a layout named
16609 \begin_layout Standard
16610 The equivalent Noweb term is
16611 \begin_inset Quotes eld
16615 \begin_inset Quotes erd
16619 For historical reasons, I got used to the term
16620 \begin_inset Quotes eld
16624 \begin_inset Quotes erd
16627 introduced by other literate tool named Nuweb, which I used for many years
16628 before rendering myself to Noweb.
16633 Noweb delimits scraps like this:
16636 \begin_layout LyX-Code
16640 \begin_layout LyX-Code
16644 \begin_layout LyX-Code
16648 \begin_layout LyX-Code
16652 \begin_layout LyX-Code
16656 \begin_layout Standard
16657 The problem is that whatever is written in between the << and the
16661 must be taken literally, i.e., LyX should be prevented from making any special
16662 interpretation of what has been written.
16663 This is handled by a special layout named Scrap, that works like a normal
16664 paragraph but has a free spacing capability.
16667 \begin_layout Standard
16668 The down side of the Scrap paragraph layout is that consecutive paragraphs
16669 of code will be spaced with one empty line in the source code and also
16670 in the printed documentation.
16671 The work around is to enter each line of code within a single Scrap, with
16672 a newline (ctrl-return).
16673 The example above will look like this:
16677 \begin_layout Standard
16678 If you have a printed version of this document you will not see any difference
16679 between the previous example and this one.
16687 \begin_layout LyX-Code
16699 \begin_layout Standard
16700 This layout works fine.
16701 The only real inconvenience is that you have to type ctrl-return instead
16706 \begin_layout Standard
16707 It is in my list of
16708 \begin_inset Quotes eld
16712 \begin_inset Quotes erd
16723 \begin_layout Standard
16724 As a special note, you can also use the
16725 \begin_inset Quotes eld
16729 \begin_inset Quotes erd
16732 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16736 \begin_layout LyX-Code
16739 def some_function(args):
16741 "This is the doc string for this
16744 print "My args: ", args
16747 \begin_layout LyX-Code
16748 @ %def some_function
16751 \begin_layout Standard
16752 For an example of this usage and the resulting cross-reference output, look
16753 at the Literate python program in
16755 LIBDIR/examples/listerrors.lyx
16757 which should make this all clear.
16760 \begin_layout Paragraph
16761 Generating the documentation
16764 \begin_layout Standard
16765 At this point you already have a new document file with a proper document
16766 class, and with some code and text on it.
16767 How do I print it? The answer is simple, you select
16772 iew\SpecialChar \menuseparator
16780 Just like you would do for a plain document.
16781 No special procedure is required.
16784 \begin_layout Standard
16785 To help orientate you, I will now explain what happens inside LyX:
16788 \begin_layout Enumerate
16794 pdate\SpecialChar \menuseparator
16801 menu option is chosen, a LaTeX file is generated.
16806 \begin_layout Standard
16807 If the document is of any literate class the generated file will be named
16808 with an extension name defined by the
16809 \begin_inset Quotes eld
16813 \begin_inset Quotes erd
16816 format (defined in the Preferences panel), otherwise the file will have
16825 \begin_layout Enumerate
16826 Note that the only difference so far is in the name of the file, no special
16827 processing is required by LyX.
16828 Given that you formatted the code using the Scrap layout that, by itself,
16829 takes care of the business.
16832 \begin_layout Enumerate
16833 If the document is of any literate class LyX will then use the internal
16834 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16838 \begin_layout Standard
16839 The converters are defined in the
16844 ools\SpecialChar \menuseparator
16852 \begin_inset Quotes eld
16856 \begin_inset Quotes erd
16861 \begin_inset LatexCommand ref
16862 reference "sub:converters"
16870 manual for general information about converters.
16875 to generate the LaTeX file.
16879 \begin_layout Standard
16880 Otherwise it will just skip this step.
16884 \begin_layout Enumerate
16885 Finally, LaTeX is invoked and the regular post processing continues as in
16889 \begin_layout Standard
16890 Independence from a particular
16891 \begin_inset Quotes eld
16895 \begin_inset Quotes erd
16898 is easily achieved by changing the commands that are run by the various
16902 \begin_layout Paragraph
16903 Generating the code
16906 \begin_layout Standard
16907 When the build menu option is chosen or the corresponding button in the
16908 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16909 Next, LyX invokes the
16914 This converter needs to be defined by the user and is not installed by
16915 default, though the Program format is.
16916 This converter (like any other converter) will have two parts:
16919 \begin_layout Enumerate
16920 The converter program itself.
16921 This program performs the conversion from the one format to the other (in
16922 this case, from the Noweb format to the Program pseudo-format).
16925 \begin_layout Enumerate
16926 The error log parser.
16927 This is a program whose sole purpose is to rewrite error messages in a
16928 format that LyX understands.
16929 This makes it possible for LyX to place error boxes in the right places
16930 in the file buffer.
16933 \begin_layout Standard
16934 The first part, the
16935 \begin_inset Quotes eld
16939 \begin_inset Quotes erd
16942 setting, should be set to
16943 \begin_inset Quotes eld
16951 \begin_inset Quotes erd
16955 This basically means that LyX will call
16956 \begin_inset Quotes eld
16960 \begin_inset Quotes erd
16963 (a program or script) with the name of the Noweb file (normally a file
16964 in the LyX temp directory).
16968 \begin_layout Standard
16969 This is an implementation of
16970 \begin_inset Quotes eld
16974 \begin_inset Quotes erd
16977 that you can place in a directory on your path:
16980 \begin_layout LyX-Code
16984 \begin_layout LyX-Code
16988 \begin_layout LyX-Code
16989 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
16992 \begin_layout Standard
16993 The next part of the converter setting is the
16994 \begin_inset Quotes eld
16998 \begin_inset Quotes erd
17001 which is to be set to
17002 \begin_inset Quotes eld
17007 parselog=listerrors
17010 \begin_inset Quotes erd
17014 This will run any errors that are generated by the
17015 \begin_inset Quotes eld
17019 \begin_inset Quotes erd
17022 process through the
17023 \begin_inset Quotes eld
17027 \begin_inset Quotes erd
17033 \begin_layout Standard
17034 The converter code looks in
17042 then on the path for the
17043 \begin_inset Quotes eld
17047 \begin_inset Quotes erd
17053 \begin_layout Standard
17054 The build will normally take place in LyX's temporary directory, so the
17055 files produced by the conversion will be in that directory.
17056 LyX will copy out what it regards as the `main' file, but the
17060 conversion may produce several files, and so most of these would then be
17061 deleted when LyX was closed.
17062 The present solution is to use a `copier',
17066 \begin_layout Standard
17068 \begin_inset LatexCommand ref
17069 reference "sec:converters-etc"
17077 manual for information on these.
17086 script in its default mode, so that the entire contents of the temporary
17087 directory is copied.
17088 More will get copied than is needed, to be sure, but nothing will be lost.
17089 If, however, you know what extensions the generated files will have, this
17090 can be improved by using the
17099 This option takes a comma-separated list of extensions to copy.
17100 So, for example, if the conversion will generate only files with the extensions
17109 , then the correct definition would be:
17112 \begin_layout LyX-Code
17113 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17116 \begin_layout Standard
17117 The result will be that only files with these two extensions will be copied
17121 \begin_layout Paragraph
17122 Build instructions in the document
17125 \begin_layout Standard
17126 The last piece of the integration between LyX and noweb is the
17127 \begin_inset Quotes eld
17131 \begin_inset Quotes erd
17135 Generally, the instructions for building your program should be embedded
17136 in a scrap of its own.
17138 \begin_inset Quotes eld
17142 \begin_inset Quotes erd
17145 above uses the notangle command to look for this scrap (called
17146 \begin_inset Quotes eld
17150 \begin_inset Quotes erd
17153 ) and runs its contents through
17154 \begin_inset Quotes eld
17158 \begin_inset Quotes erd
17164 \begin_layout Standard
17165 Typically, such a scrap would look something like this:
17168 \begin_layout LyX-Code
17175 if [ -z "${NOWEB_SOURCE}" ]
17179 NOWEB_SOURCE=myfile.nw
17185 code to extract files ...]
17188 code to compile files ...]
17193 \begin_layout Standard
17196 LIBDIR/examples/listerrors.lyx
17200 LIBDIR/examples/Literate.lyx
17202 which implement two versions of the
17203 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17210 program for some illustrations of how all of these pieces go together or
17213 LIBDIR/examples/noweb2lyx.lyx.
17216 Interestingly, these three files show off the language-indepence of the
17217 LyX literate programming support since they are written in Python, C and
17221 \begin_layout Subsubsection
17225 \begin_layout Standard
17226 All the Literate Programming support is configured by the
17231 ools\SpecialChar \menuseparator
17239 \begin_inset Quotes eld
17243 \begin_inset Quotes erd
17247 The important parts are:
17250 \begin_layout Description
17253 \begin_inset Quotes eld
17257 \begin_inset Quotes erd
17261 format Set up via the Formats tab, this is where the Noweb-specific pieces
17271 , the file extension is set to
17276 This tells LyX to create a file with a
17280 extension in the first step of the conversion process.
17283 \begin_layout Description
17290 format This is an empty format whose sole purpose is to be the endpoint
17291 of a conversion (which then allows us to set up a converter for it).
17294 \begin_layout Description
17303 This converter performs the
17304 \begin_inset Quotes eld
17308 \begin_inset Quotes erd
17311 of the literate document.
17312 For Noweb, it is set to
17313 \begin_inset Quotes eld
17318 noweave -delay -index $$i > $$o
17321 \begin_inset Quotes erd
17327 \begin_layout Description
17337 \begin_inset Quotes eld
17341 \begin_inset Quotes erd
17345 As stated above, the Converter is set to
17346 \begin_inset Quotes eld
17354 \begin_inset Quotes erd
17357 , with Flags set to
17358 \begin_inset Quotes eld
17363 originaldir,parselog=listerrors
17366 \begin_inset Quotes erd
17372 \begin_layout Subsubsection
17376 \begin_layout Standard
17377 There is also a new function implemented in the LyX server, the
17378 \begin_inset Quotes eld
17381 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17385 \begin_layout Standard
17386 When debugging code with ddd/gdb, it is possible to invoke a text editor
17387 at the current execution position with a single key stroke.
17388 The default ddd configuration for that is shift-ctrl-V.
17389 It happens that you can define the editor command line invocation in ddd
17395 dit\SpecialChar \menuseparator
17400 references\SpecialChar \menuseparator
17407 dialog and changing the "Edit Sources" entry.
17410 \begin_layout Standard
17411 I take advantage of the new created LyX server function and this ddd feature,
17413 \begin_inset Quotes eld
17417 \begin_inset Quotes erd
17423 \begin_layout LyX-Code
17424 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17427 \begin_layout Standard
17428 With this, whenever you are using ddd and find a point in the program that
17429 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17430 ddd you forward this information to LyX through the LyX server and then
17431 the LyX window will show the same file with the cursor at the same position
17432 ddd was pointing to.
17433 No more guessing or long scrolling to locate a point in the program back
17437 \begin_layout Standard
17438 Note however that you must enable the LyX server to get this feature working
17439 (it is disabled by default).
17440 You can enable it in
17452 ) by entering in the
17457 \begin_inset Quotes eld
17462 /home/<your-home-directory>/.lyx/lyxpipe
17465 \begin_inset Quotes erd
17471 \begin_layout Standard
17472 Read the LyX server documentation in the
17474 Customization Manual
17476 for further information.
17479 \begin_layout Subsubsection
17483 \begin_layout Standard
17484 There are six new buttons that can be added to your LyX toolbar.
17485 Five of these buttons are short cuts to layout styles:
17506 The last one is a short cut to the
17507 \begin_inset Quotes eld
17511 \begin_inset Quotes erd
17518 \begin_layout Standard
17519 LyX has a range of buttons that are available for tool bar customization.
17520 In my toolbar I like to combine the six short cuts above with two more:
17528 \SpecialChar \menuseparator
17536 \SpecialChar \menuseparator
17549 iew\SpecialChar \menuseparator
17557 Here is how it looks like:
17560 \begin_layout LyX-Code
17564 \begin_layout LyX-Code
17568 \begin_layout LyX-Code
17569 Icon "layout Standard"
17572 \begin_layout LyX-Code
17573 Icon "layout Section"
17576 \begin_layout LyX-Code
17577 Icon "layout LaTeX"
17580 \begin_layout LyX-Code
17581 Icon "layout LyX-Code"
17584 \begin_layout LyX-Code
17585 Icon "layout Scrap"
17588 \begin_layout LyX-Code
17592 \begin_layout LyX-Code
17596 \begin_layout LyX-Code
17597 Icon "buffer-typeset"
17600 \begin_layout LyX-Code
17601 Icon "build-program"
17604 \begin_layout LyX-Code
17608 \begin_layout LyX-Code
17612 \begin_layout LyX-Code
17616 \begin_layout LyX-Code
17620 \begin_layout LyX-Code
17624 \begin_layout Subsubsection
17625 Colors customization
17628 \begin_layout Standard
17629 There are a number of colors in LyX that can be customized in
17634 One of the things that bothers people is the LaTeX font color.
17635 The default color is red, since the scraps uses LaTeX font, and there is
17636 a lot of scraps in literate documents, you may get tired of seeing everything
17638 You can change it by going to the tabs
17647 \begin_layout Standard
17648 The next thing is the visible presence of the newline character in the screen.
17649 You can choose the color of this particular character and make it blend
17651 I recommend you choosing a color that is close to the background but not
17652 equal, that way you still can see it is there, but it is not bothering
17657 \begin_layout Chapter
17658 Secrets of the LaTeX Masters
17659 \begin_inset LatexCommand label
17667 \begin_layout Standard
17668 Though LyX is a powerful tool, it cannot hope to support everything that
17669 can be done with pure TeX/LaTeX.
17670 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17671 as long as you are not afraid to use that
17672 \begin_inset Quotes eld
17676 \begin_inset Quotes erd
17679 button on the toolbar or add things to the LaTeX preamble.
17680 This section lists some tips, tricks, and otherwise cool ideas to give
17681 your document that extra little flair.
17684 Do try this at home
17686 , just start with something a little smaller and less important than your
17690 \begin_layout Standard
17691 Most ideas in this section require less common files in your LaTeX installation.
17692 If you have a system like teTeX, most will already be available.
17693 A few, however, will need to be downloaded from one of the CTAN archives.
17694 Often, there are several ways to do something, or several LaTeX style files
17695 which do the same thing.
17696 We do not endorse one choice over another, we simply claim that we have
17697 done a particular task with a particular file.
17698 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17701 \begin_layout Section
17705 \begin_layout Standard
17708 Lars Gullik Bjønnes
17711 \begin_layout Subsection
17715 \begin_layout Standard
17716 The aim for this chapter
17720 \begin_layout Standard
17721 Editor's note: Lars' original chapter was a masterful description of how
17727 However, it was too long to flow smoothly in this document.
17728 I have therefore chosen to excerpt the most important sections here (sorry,
17729 Lars); you can read the original chapter (and more of the story!) in the
17732 examples/multicol.lyx
17740 is to show how the LaTeX package
17744 can be used in a LyX document.
17745 As LyX doesn't support the
17749 package natively yet, we have to use some small hacks.
17750 By reading this section it should be obvious how to do this.
17753 \begin_layout Subsection
17757 \begin_layout Standard
17762 package allows switching between one and multicolumn format on the same
17764 Footnotes are handled correctly (for the most part), but will be placed
17765 at the bottom of the page and not under each column.
17766 LaTeX's float mechanism, however, is partly disabled in the current implementat
17768 At the moment only page-wide floats can be used within the scope of the
17772 \begin_layout Subsection
17776 \begin_layout Subsubsection
17780 \begin_layout Standard
17781 If you want to have two columns in your text, you have use LaTeX mode to
17786 begin{multicols}{2}
17788 at the point where you want the two column layout to start, and then
17794 where you want it to end.
17798 \begin_layout Standard
17802 \begin_layout Standard
17806 begin{multicols}{2}
17814 \begin_layout Standard
17819 The Adventure of the Empty House
17825 Sir Arthur Conan Doyle
17828 \begin_layout Standard
17831 It was in the spring of the year 1894 that all London was interested, and
17832 the fashionable world dismayed, by the murder of the Honourable Ronald
17833 Adair under most unusual and inexplicable circumstances.
17834 The public has already learned those particulars of the crime which came
17835 out in the police investigation, but a good deal was suppressed upon that
17836 occasion, since the case for the prosecution was so overwhelmingly strong
17837 that it was not necessary to bring forward all the facts.
17838 Only now, at the end of nearly ten years, am I allowed to supply those
17839 missing links which make up the whole of that remarkable chain.
17840 The crime was of interest in itself, but that interest was as nothing to
17841 me compared to the inconceivable sequel, which afforded me the greatest
17842 shock and surprise of any event in my adventurous life.
17843 Even now, after this long interval, I find myself thrilling as I think
17844 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17845 ty which utterly submerged my mind.
17846 Let me say to that public, which has shown some interest in those glimpses
17847 which I have occasionally given them of the thoughts and actions of a very
17848 remarkable man, that they are not to blame me if I have not shared my knowledge
17849 with them, for I should have considered it my first duty to do so, had
17850 I not been barred by a positive prohibition from his own lips, which was
17851 only withdrawn upon the third of last month.
17854 \begin_layout Standard
17858 \begin_layout Standard
17870 \begin_layout Subsubsection
17874 \begin_layout Standard
17875 The same pattern is used when you want more than two columns:
17878 \begin_layout Standard
17882 \begin_layout Standard
17886 begin{multicols}{3}
17894 \begin_layout Standard
17897 It can be imagined that my close intimacy with Sherlock Holmes had interested
17898 me deeply in crime, and that after his disappearance I never failed to
17899 read with care the various problems which came before the public.
17900 And I even attempted, more than once, for my own private satisfaction,
17901 to employ his methods in their solution, though with indifferent success.
17902 There was none, however, which appealed to me like this tragedy of Ronald
17904 As I read the evidence at the inquest, which led up to a verdict of willful
17905 murder against some person or persons unknown, I realized more clearly
17906 than I had ever done the loss which the community had sustained by the
17907 death of Sherlock Holmes.
17908 There were points about this strange business which would, I was sure,
17909 have specially appealed to him, and the efforts of the police would have
17910 been supplemented, or more probably anticipated, by the trained observation
17911 and the alert mind of the first criminal agent in Europe.
17912 All day, as I drove upon my round, I turned over the case in my mind and
17913 found no explanation which appeared to me to be adequate.
17914 At the risk of telling a twice-told tale, I will recapitulate the facts
17915 as they were known to the public at the conclusion of the inquest.
17918 \begin_layout Standard
17922 \begin_layout Standard
17934 \begin_layout Standard
17935 You can have more than 3 columns if you want to, but that might not be very
17936 pleasant for the eye.
17939 \begin_layout Subsubsection
17940 Columns inside columns
17943 \begin_layout Standard
17944 You can even have columns inside columns:
17947 \begin_layout Standard
17951 \begin_layout Standard
17955 begin{multicols}{2}
17963 \begin_layout Standard
17966 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17967 at that time governor of one of the Australian colonies.
17968 Adair's mother had returned from Australia to undergo the operation for
17969 cataract, and she, her son Ronald, and her daughter Hilda were living together
17973 \begin_layout Standard
17977 \begin_layout Standard
17981 begin{multicols}{2}
17989 \begin_layout Standard
17992 The youth moved in the best society--had, so far as was known, no enemies
17993 and no particular vices.
17994 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
17995 had been broken off by mutual consent some months before, and there was
17996 no sign that it had left any very profound feeling behind it.
17997 For the rest {sic} the man's life moved in a narrow and conventional circle,
17998 for his habits were quiet and his nature unemotional.
17999 Yet it was upon this easy-going young aristocrat that death came, in most
18000 strange and unexpected form, between the hours of ten and eleven-twenty
18001 on the night of March 30, 1894.
18004 \begin_layout Standard
18008 \begin_layout Standard
18020 \begin_layout Standard
18023 Ronald Adair was fond of cards--playing continually, but never for such
18024 stakes as would hurt him.
18025 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18026 It was shown that, after dinner on the day of his death, he had played
18027 a rubber of whist at the latter club.
18028 He had also played there in the afternoon.
18033 The evidence of those who had played with him-- Mr.
18034 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18035 and that there was a fairly equal fall of the cards.
18036 Adair might have lost five pounds, but not more.
18037 His fortune was a considerable one, and such a loss could not in any way
18039 He had played nearly every day at one club or other, but he was a cautious
18040 player, and usually rose a winner.
18041 It came out in evidence that, in partnership with Colonel Moran, he had
18042 actually won as much as four hundred and twenty pounds in a sitting, some
18043 weeks before, from Godfrey Milner and Lord Balmoral.
18044 So much for his recent history as it came out at the inquest.
18047 \begin_layout Standard
18051 \begin_layout Standard
18063 \begin_layout Standard
18064 Please do read the file
18066 examples/multicol.lyx
18068 for more advanced examples including column and header spacing, vertical
18069 separator lines, and more.
18072 \begin_layout Section
18077 Paragraph Environment
18078 \begin_inset OptArg
18081 \begin_layout Standard
18082 Numbering in Enumerate
18090 \begin_layout Standard
18096 \begin_layout Standard
18097 \begin_inset VSpace bigskip
18103 \begin_layout Standard
18105 The default numbering for the
18109 paragraph environment begins with Arabic numbers and ends with uppercase
18111 Suppose, however, you wanted a different type of numbering scheme.
18112 Here's a quickie example of how to change the numbering scheme:
18115 \begin_layout LyX-Code
18125 \begin_layout LyX-Code
18135 \begin_layout LyX-Code
18145 \begin_layout LyX-Code
18155 \begin_layout Standard
18156 \SpecialChar \ldots{}
18157 which changes the numbering scheme to uppercase Roman numerals, uppercase
18158 letters, Arabic numbers, and lowercase letter.
18161 \begin_layout Standard
18162 Additionally, the previous example also adds a little bit extra to the numbering
18164 For example, the first level label actually looks like:
18165 \begin_inset Quotes eld
18169 \begin_inset Quotes erd
18173 For ease of reading, we'll describe what the numbering schemes look like
18174 using a notation something like this: <
18175 \begin_inset Quotes eld
18179 \begin_inset Quotes erd
18184 \begin_inset Quotes erd
18188 \begin_inset Quotes erd
18193 \begin_inset Quotes erd
18197 \begin_inset Quotes erd
18202 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18213 \begin_layout Standard
18214 As you can see in the example, there is a label command for each nesting
18221 \SpecialChar \ldots{}
18228 , as well as a counter,
18232 \SpecialChar \ldots{}
18238 There are also five
18239 \begin_inset Quotes eld
18243 \begin_inset Quotes erd
18276 , each of which take one counter as an argument.
18277 You can add characters before or after these, but there's no need to add
18281 \begin_layout Standard
18282 You can get really fancy with these.
18286 \begin_layout LyX-Code
18300 \begin_layout LyX-Code
18312 \begin_layout LyX-Code
18322 \begin_layout LyX-Code
18332 \begin_layout Standard
18333 produces the somewhat out of hand numbering scheme: <
18334 \begin_inset Quotes eld
18338 \begin_inset Quotes erd
18343 \begin_inset Quotes erd
18347 \begin_inset Quotes erd
18352 \begin_inset Quotes erd
18356 \begin_inset Quotes erd
18361 \begin_inset Quotes eld
18365 \begin_inset Quotes erd
18372 \begin_layout Standard
18376 \begin_layout Section
18380 \begin_layout Standard
18386 \begin_layout Standard
18387 \begin_inset VSpace bigskip
18393 \begin_layout Standard
18398 \begin_layout Standard
18404 tmpfont}{cmr17 scaled 2500}{
18416 \begin_layout Standard
18421 \begin_layout Standard
18432 hose of you who like the style of old books probably also like
18433 \begin_inset Quotes eld
18437 \begin_inset Quotes erd
18440 ---those large capital letters which begin each new chapter or section.
18441 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18442 know some plain TeX!) but does require a lot of work and many iterations,
18443 as you can see by all the ugly TeX-mode stuff at the beginning of this
18447 \begin_layout Standard
18451 \begin_layout Standard
18457 bigdrop{-1em}{3}{ptmri}{T}+
18462 here is a much easier way of doing this, of course.
18471 ) package from CTAN allows a simple way to add such letters to your documents.
18472 Since this package is not a standard part of teTeX, I can't demonstrate
18473 it within this document, but if you copy this paragraph to a new document,
18475 \begin_inset Quotes eld
18485 \begin_inset Quotes erd
18488 and the pluses from the TeX code at the beginning of the paragraph, and
18493 usepackage{dropcaps}
18495 to your LaTeX preamble, you will get a nice Times Roman Italic
18496 \begin_inset Quotes eld
18500 \begin_inset Quotes erd
18503 , whose height is three lines of text and which protrudes 1 em into the
18505 (Make certain you have copied
18506 \begin_inset Quotes eld
18514 \begin_inset Quotes erd
18517 into a directory where TeX can see it.) The first argument is the amount
18518 of indentation; in this case the negative sign moves it into the margin.
18519 The second argument is the height of the letter in number of lines of text.
18520 The third argument is the font name: virtually anything which has a tfm
18521 file should work (wade through the
18523 .../texmf/fonts/tfm
18525 directory for possibilities).
18526 My personal favorite is
18527 \begin_inset Quotes eld
18535 \begin_inset Quotes erd
18538 , a fancy German font specifically designed for dropped capitals.
18539 The fourth argument is the letter (or letters) to be dropped.
18544 package also offers the
18550 command, as well as a slightly simplified
18559 \begin_layout Section
18560 Non-standard Paragraph Shapes
18563 \begin_layout Standard
18569 \begin_layout Standard
18570 \begin_inset VSpace bigskip
18576 \begin_layout Standard
18580 \begin_layout Standard
18592 \begin_layout Standard
18596 \begin_layout Standard
18605 \begin_layout Standard
18619 \begin_layout Standard
18624 \begin_layout Standard
18635 \begin_layout Standard
18644 \begin_layout Standard
18653 \begin_layout Standard
18662 \begin_layout Standard
18671 \begin_layout Standard
18680 \begin_layout Standard
18689 \begin_layout Standard
18698 \begin_layout Standard
18707 \begin_layout Standard
18716 \begin_layout Standard
18725 \begin_layout Standard
18734 \begin_layout Standard
18743 \begin_layout Standard
18752 \begin_layout Standard
18761 \begin_layout Standard
18770 \begin_layout Standard
18779 \begin_layout Standard
18788 \begin_layout Standard
18797 \begin_layout Standard
18803 There are times when the tyranny of rectangular paragraphs must be overthrown.
18804 In such situations, a call to the delightful plain TeX command
18811 As you can see, completely arbitrary shapes can be laid out with a suitable
18812 set of linelength definitions.
18813 While this parshape may look a bit silly and useless, one could conceive
18814 of situations such as finely tuned dropped capitals, word wrapping around
18815 non-rectangular graphics, etc.
18816 which will benefit from such handcrafting.
18819 \begin_layout Standard
18820 \begin_inset VSpace bigskip
18826 \begin_layout Standard
18831 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18838 is the number of lines of text which define the paragraph.
18839 If there turn out to be fewer lines, the shape is truncated; if there are
18840 more, the excess lines have the same dimensions as the last line of the
18850 entries specify the indentation of the line from the left margin, and the
18851 length of the line as measured from that point.
18852 The shape applies only to the current paragraph; everything is reset to
18853 normal for the next paragraph.
18856 \begin_layout Standard
18860 \begin_layout Standard
18872 \begin_layout Section
18876 \begin_layout Standard
18877 As you can see, the examples in this section range from the useful to the
18879 While I don't expect that anyone will ever need the paragraph shape demonstrate
18880 d in the last section, the important point is that you can do almost anything
18881 you want in LyX if you are willing to figure out how to do it in TeX and
18883 TeX is a fantastically powerful typesetting system and all that power is
18884 available to you since LyX uses it as its backend.
projects / lyx.git / blob