1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the User's Guide prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the User's Guide may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
57 \font_typewriter default
58 \font_default_family default
68 \pdf_title "LyX's Extended manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX's extended documentation"
71 \pdf_keywords "LyX, Documentation, Extended"
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen false
75 \pdf_bookmarksopenlevel 1
80 \pdf_pagebackref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
89 \paperorientation portrait
92 \paragraph_separation indent
94 \quotes_language english
97 \paperpagestyle headings
98 \tracking_changes false
107 Extended LyX Features
115 \begin_layout Plain Layout
117 Principal maintainer of this file is
122 If you have comments or error corrections, please send them to the LyX
123 Documentation mailing list, <lyx-docs@lists.lyx.org>.
131 \begin_layout Standard
132 \begin_inset CommandInset toc
133 LatexCommand tableofcontents
140 \begin_layout Chapter
144 \begin_layout Standard
147 Extended LyX Features
149 manual, which you are now reading, is essentially Part II of the
151 User's Guide\SpecialChar \@.
154 The reason for splitting this document is simple: the
158 is already huge, and it contains all of the basic features one needs to
159 know in order to prepare most documents.
160 However, the LyX Team has a long-term goal of making LyX extensible through
161 various configuration files and external packages.
162 That means that if you want to support the Fizzwizzle LaTeX package, you
163 can create a layout file for it without having to alter LyX itself.
164 We've already had contributions of several new features this way.
165 This is the place where all of that gets documented.
168 \begin_layout Standard
169 This manual also documents some special features, like fax support, version
170 control, and SGML support, which require additional software to work properly.
171 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
172 spruce up your documents by directly using the powerful features of LaTeX.
177 only WYSIWYM, and will only ever interface to certain LaTeX features.
180 \begin_layout Standard
181 Of course, with all of this extra documentation,
183 Extended LyX Features
185 may itself grow too big for its britches.
186 In that case, you can just call it the
187 \begin_inset Quotes eld
191 \begin_inset Quotes erd
197 \begin_layout Standard
198 If you haven't read the
202 yet, you are definitely in the wrong manual.
207 is the first place to go, since it will direct you to the correct manual,
208 and it also describes the notation and format of all of the manuals.
209 You should also be thoroughly familiar with the
213 and all of the basic features of LyX.
217 \begin_layout Standard
218 In this document, many sections are independent articles contributed by
219 an individual and are noted as such.
220 This person is generally whoever wrote the layout file for the new document
221 class or LaTeX package, or implemented the feature.
222 If there is no mention of an author to a chapter [or chapter sections],
223 that means it was written by the LyX Documentation Team.
226 \begin_layout Standard
227 Since all the topics in this manual depend heavily on LyX's interaction
228 with LaTeX, this first chapter covers the inner workings of LyX and how
229 to direct LyX to generate exactly the LaTeX code you want.
230 It is obviously for more seasoned LyX users.
233 \begin_layout Chapter
237 \begin_layout Section
241 \begin_layout Standard
242 \begin_inset CommandInset label
244 name "sec:lyxandlatex"
248 This chapter is for both TeX-nicians and the LaTeX-curious.
249 In it, we'll explain how LyX and LaTeX work together to produce printable
251 This is the only place in any of the manuals where we assume you know something
255 \begin_layout Standard
256 At one time, we called LyX a
257 \begin_inset Quotes eld
260 WYSIWYM frontend to LaTeX,
261 \begin_inset Quotes erd
264 but that's no longer true.
265 There are frontends to LaTeX out there.
266 They are basically editors with the ability to run LaTeX and mark any errors
267 in the file you're editing.
276 run LaTeX, and it also marks errors in the file, it also does much, much
278 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
279 LyX has also added a few extensions to LaTeX.
280 Try the following sometime: select
282 Export\SpecialChar \menuseparator
292 menu, then look at the preamble of the resulting
297 You'll notice a variety of new macros defined specifically by LyX.
298 These macros are defined automatically, according to the features you use
302 \begin_layout Standard
303 There are several commands that automatically invoke LaTeX.
307 \begin_layout Itemize
313 iew\SpecialChar \menuseparator
323 \begin_layout Itemize
329 iew\SpecialChar \menuseparator
334 pdate\SpecialChar \menuseparator
340 \begin_layout Itemize
348 \SpecialChar \menuseparator
354 \begin_layout Itemize
362 \SpecialChar \menuseparator
368 \begin_layout Standard
369 They will only invoke LaTeX if the file has changed since the last time
374 \begin_layout Standard
375 When you run LaTeX on the file you're editing, LyX performs these steps:
378 \begin_layout Enumerate
379 Convert the document to LaTeX and save to a file with the extension
390 \begin_layout Enumerate
395 file (maybe several times).
398 \begin_layout Enumerate
399 If there are any errors, insert error boxes in the document to mark where
401 These boxes are transient and are not saved along with the document.
404 \begin_layout Standard
405 If you've run LaTeX using
433 , LyX performs two more steps:
436 \begin_layout Itemize
441 to convert the DVI file to PostScript:
445 \begin_layout Itemize
454 , the output file has the extension
459 \begin_layout Itemize
471 , the output file has the extension
479 \begin_layout Itemize
484 or send the PostScript file to the printer.
487 \begin_layout Section
488 \begin_inset Quotes eld
491 Help! LyX generated an unreadable
496 \begin_inset Quotes erd
502 \begin_layout Standard
503 Die-hard LaTeX users will scream and howl this into the night, then declare
504 LyX useless, simply because they didn't RTFM.
507 \begin_layout Standard
508 We're going to set the record straight.
509 LyX produces two kinds of LaTeX files.
510 One is human readable.
511 The other is LyX readable.
512 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
518 file is not human readable.
519 Don't even try to read it.
524 file that you can send to a colleague, select
529 xport\SpecialChar \menuseparator
546 \begin_layout Section
547 Translating LaTeX files into LyX
548 \begin_inset CommandInset label
550 name "sec:Translating-LaTeX-files"
557 \begin_layout Standard
558 You can import a LaTeX file into LyX by using the
563 ile\SpecialChar \menuseparator
568 mport\SpecialChar \menuseparator
576 This will call a program named
580 ---which will create a file
588 ---and then open that file.
591 \begin_layout Standard
596 will translate most legal LaTeX, but not everything.
597 It will leave things it doesn't understand in TeX mode, so after translating
602 , you can look for red text and hand-edit it to look right.
605 \begin_layout Standard
606 If you just want to put a piece of TeX code into a LyX file, see section
611 \begin_inset CommandInset ref
613 reference "sec:Inserting-TeX-Code"
620 \begin_layout Section
621 Inserting TeX Code into LyX Documents
622 \begin_inset CommandInset label
624 name "sec:Inserting-TeX-Code"
631 \begin_layout Standard
632 This is a rather important point: You can always insert TeX code into any
634 LyX simply cannot, and will probably never be able to, display every possible
636 If ever you need to insert LaTeX commands into your LyX document, you can
637 use the TeX Code box, which you can insert into your document with
639 Insert\SpecialChar \menuseparator
643 The TeX Code box comes in three forms: collapsed, open, and inlined.
644 The first two are used just like any other collapsible (foldable) box (such
645 as footnotes), and are useful for significant amounts of LaTeX commands.
647 \begin_inset Quotes eld
651 \begin_inset Quotes erd
654 TeX Code box displays its content as part of the button, and is useful
655 for very short sections of LaTeX commands.
660 \begin_layout Plain Layout
670 \begin_layout Standard
671 You can switch between all three by right-clicking on the TeX Code.
672 Note that if you want more than one line of LaTeX commands, you cannot
673 use the inlined mode.
676 \begin_layout Standard
677 Here's an example of inserting LaTeX commands in a LyX document.
678 The code looks like this:
681 \begin_layout LyX-Code
685 \begin_inset Newline newline
691 \begin_inset Newline newline
694 This is an example for a minipage environment.
696 \begin_inset Newline newline
699 can put nearly everything in it, even (non-floating)
700 \begin_inset Newline newline
705 \begin_inset Newline newline
711 \begin_inset Newline newline
715 \begin_inset Newline newline
721 \begin_inset Newline newline
727 \begin_inset Newline newline
733 \begin_inset Newline newline
738 \begin_inset Newline newline
744 \begin_inset Newline newline
750 \begin_inset Newline newline
756 \begin_inset Newline newline
764 \begin_layout LyX-Code
768 \begin_layout Standard
769 The TeX Code box containing this text is directly after this paragraph.
770 Those of you reading the manual online will only see a bunch of funky text
772 Those reading a printed version of the manuals will see the actual results:
775 \begin_layout Standard
779 \begin_layout Plain Layout
786 \begin_layout Plain Layout
793 \begin_layout Plain Layout
795 This is an example for a minipage environment.
796 You can put nearly everything in it, even (non-floating) figures and tables.
800 \begin_layout Plain Layout
807 \begin_layout Plain Layout
812 \begin_layout Plain Layout
819 \begin_layout Plain Layout
826 \begin_layout Plain Layout
833 \begin_layout Plain Layout
839 \begin_layout Plain Layout
846 \begin_layout Plain Layout
853 \begin_layout Plain Layout
860 \begin_layout Plain Layout
872 \begin_layout Standard
873 In addition to these two methods, you can also create a separate file containing
874 some complex LaTeX structure.
877 Insert\SpecialChar \menuseparator
884 to include your file (you should select the type
889 We recommend that you only do this if you have a
898 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
902 \begin_layout Standard
903 There are a few last notes to emphasize:
906 \begin_layout Itemize
907 Inside of LyX, LaTeX code appears
912 \begin_layout Itemize
917 check if your LaTeX code is correct.
920 \begin_layout Itemize
921 Beware reinventing the wheel.
924 \begin_layout Standard
925 That last note refers to two things.
926 First, LyX does have quite a few features tucked into it, and more are
928 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
929 feature before you go off merrily coding LaTeX.
930 Second, there are numerous LaTeX packages out there to do all sorts of
931 things, from labels to envelopes to fancy multipage tables.
932 Check out a CTAN site for details (see Section
933 \begin_inset Quotes eld
937 \begin_inset Quotes erd
948 \begin_layout Plain Layout
953 : I seem to do this an awful lot.
954 Sat down and merrily began coding something to print out labels, only to
955 learn that there were already 2 different LaTeX packages to do this.
956 Worse yet --- I had them already!
964 \begin_layout Standard
965 If you do need to do some wild and fancy things within your document, be
966 sure to check out a good LaTeX book for assistance.
967 There are a number of them listed in the bibliography of the
974 \begin_layout Standard
975 There are a number of LaTeX commands which have to be placed before the
976 beginning of the actual text.
977 They go into the preamble, and this is explained in the next section.
980 \begin_layout Section
981 LyX and the LaTeX Preamble
984 \begin_layout Subsection
985 About the LaTeX Preamble
988 \begin_layout Standard
989 \begin_inset CommandInset label
995 If you already know LaTeX, there is no need to explain here what the preamble
997 If you don't, the following will give you some ideas --- we recommend again
998 that you consult a LaTeX book for further information.
999 In any case, you should read the points below, because they explain what
1000 you can do and what you don't need to do in the LaTeX preamble of a LyX
1004 \begin_layout Standard
1005 The LaTeX preamble comes at the very beginning of a document,
1013 \begin_layout Itemize
1014 declare the document class.
1015 LyX already does this for you.
1019 \begin_layout Standard
1020 If you're a seasoned LaTeX-nician, and you have some custom document class
1021 you want to use, check out the
1023 Customization Manual
1025 for information on how to make LyX interface to it.
1026 Be sure to submit your efforts to the LyX Team for inclusion in future
1031 \begin_layout Itemize
1032 declare the usage of packages.
1033 LaTeX packages provide special commands, which are only available within
1034 a document when the package has been declared in the preamble.
1035 For example, the package
1039 forces all paragraphs to be indented.
1040 There are other packages for labels, envelopes, margins, etc.
1044 \begin_layout Itemize
1045 set counters, variables, lengths and widths.
1046 There are several LaTeX counters and variables which
1050 be set globally from within the preamble in order to have the desired effect.
1051 [There are other variables which you can set and reset inside the document,
1052 too.] Margins are a good example of something which must be set in the preamble.
1053 Another example is the label format for lists.
1054 You can actually set these just about anywhere, but it's best to do it
1055 just once, inside the preamble.
1058 \begin_layout Itemize
1059 declare user defined commands [with
1071 ], mostly abbreviations for LaTeX commands which appear very often inside
1073 Although the preamble is a good place to declare such commands, they
1077 be declared anywhere else [but
1081 they are used for the first time, of course\SpecialChar \ldots{}
1083 This can be useful if there is a lot of raw LaTeX code in your document,
1084 which normally should not be the case.
1087 \begin_layout Standard
1088 LyX adds its own set of definitions to the preamble of the
1093 This makes LaTeX files generated by LyX portable.
1096 \begin_layout Subsection
1097 Changing the Preamble
1100 \begin_layout Standard
1101 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1102 can't change them without patching LyX itself.
1103 You can, however, add your own stuff to the preamble.
1104 There are two ways to do this:
1107 \begin_layout Enumerate
1114 \begin_inset space ~
1137 \SpecialChar \menuseparator
1145 dialog, depending on your frontend.
1146 Note that the LyX keybindings will not work in this dialog, alas.
1149 \begin_layout Enumerate
1150 Use the preamble contents you've added as your default template (see
1151 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1162 ), so that it will be the default preamble for any file you create.
1165 \begin_layout Standard
1166 LyX adds anything in the
1173 dialog to its own built-in preamble.
1174 Before adding your own declarations in the preamble, you should make sure
1175 that LyX doesn't already support what you want to do (remember what we
1176 said about reinventing the wheel?).
1179 make sure your preamble code is correct
1182 LyX doesn't check it.
1185 \begin_layout Subsection
1189 \begin_layout Standard
1190 Here are some examples of what you can add to a preamble, and what they
1194 \begin_layout Subsubsection
1198 \begin_layout Standard
1199 There are two variables under LaTeX that control page position:
1212 Their names should be self-explanatory.
1213 These variables are useful if you think for a moment about computer labels.
1214 Sometimes, the size of a print medium and the area of the medium that you
1215 can actually print on aren't the same.
1231 \begin_layout Standard
1232 The default values for
1245 \begin_inset space ~
1249 \begin_inset space ~
1253 \begin_inset space ~
1256 the page isn't shifted.
1259 \begin_layout Standard
1260 Unfortunately, some DVI drivers always seem to shift the page.
1261 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1262 If you're using LyX on a system that you don't personally maintain, and
1263 your sysadmin is a doofus,
1276 Suppose you're left and top margins are always 0.5 inches too big.
1277 You can add this to the preamble:
1280 \begin_layout LyX-Code
1288 \begin_layout LyX-Code
1296 \begin_layout Standard
1297 \SpecialChar \ldots{}
1298 and your margins should now be correct.
1301 \begin_layout Subsubsection
1305 \begin_layout Standard
1306 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1307 There's a rather nice package, available at your nearest CTAN archive,
1308 for printing sheets of labels, called
1313 Now, your system may not have this package installed by default.
1314 We leave that up to you to check.
1315 You'll also want to read the documentation for it; we're not going to do
1317 Since this is an example, however, we'll give you an example of how you
1321 \begin_layout Standard
1322 First, make sure you're using the
1327 Next, you need to put the following in your preamble:
1330 \begin_layout LyX-Code
1336 \begin_layout LyX-Code
1342 \begin_layout LyX-Code
1348 \begin_layout LyX-Code
1354 \begin_layout LyX-Code
1360 \begin_layout LyX-Code
1366 \begin_layout LyX-Code
1372 \begin_layout Standard
1373 This sets things up for Avery® label sheets, stock #5360.
1374 You're now ready to print labels, but you'll need to insert LaTeX code,
1375 placing the commands
1387 around each label text.
1388 This and other special features of
1392 are explained in its documentation.
1395 \begin_layout Standard
1396 Someday, someone may write a LyX layout file to support this package directly.
1397 Maybe that someone is you.
1400 \begin_layout Subsubsection
1401 Example #3: Paragraph Indentation
1404 \begin_layout Standard
1405 Americans are trained to indent the first line of
1410 As with all of their other weird quirks, most Americans will whine and
1411 moan until they can have their way and indent the first line of all paragraphs.
1415 \begin_layout Plain Layout
1420 : This was written by an American ---
1424 ! It's my perception of my fellow countrymen.
1425 Tough if you don't like it.
1434 \begin_layout Standard
1435 Of course, this behavior isn't standard typography.
1436 In books, you typically only indent the first line of a paragraph
1440 it follows another one.
1441 The idea behind indenting the first line of a paragraph is to distinguish
1442 neighboring paragraphs from one another.
1443 If there is no previous paragraph, for example, it follows a figure, or
1444 is the first paragraph in a section, then there is no special indentation.
1448 \begin_layout Standard
1449 If you're a typical American, though, you don't care about such esoteric
1450 things; you want your indentation! Add this to the preamble:
1453 \begin_layout LyX-Code
1456 usepackage{indentfirst}
1459 \begin_layout Standard
1460 If your TeX distribution isn't a braindead one, you'll have this package,
1461 and all of your paragraphs will get the indentation you think they deserve.
1464 \begin_layout Subsubsection
1465 Example #4: This Document
1468 \begin_layout Standard
1469 You can also check out the preamble of this document to get an idea of some
1470 of the advanced things you can do.
1471 You'll probably need to make the
1476 reamble\SpecialChar \ldots{}
1479 dialog full-screen to see most of it.
1480 Also, there are more examples and an assortment of LaTeX
1481 \begin_inset Quotes eld
1485 \begin_inset Quotes erd
1489 \begin_inset space ~
1493 \begin_inset CommandInset ref
1495 reference "cha:secrets"
1503 \begin_layout Section
1504 LyX and LaTeX Errors
1507 \begin_layout Standard
1508 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1510 It then uses the log-file from the LaTeX run to do a post-mortem.
1511 As we stated earlier in the chapter, LyX generates two kinds of
1515 files, one of which it uses to locate errors in the document.
1516 If there was an error someplace, LyX will put a box with the word
1517 \begin_inset Quotes eld
1521 \begin_inset Quotes erd
1524 at the appropriate place in the document.
1528 \begin_layout Plain Layout
1529 LyX will occasionally misguess where the error was.
1530 This will typically happen with tables, figures, math, and the preamble.
1535 It will also display a message alerting you to the fact that there were
1539 \begin_layout Standard
1540 You can navigate through the errors by using
1556 \begin_inset Quotes eld
1560 \begin_inset Quotes erd
1563 the error-boxes and view the error message LaTeX produced by clicking on
1567 \begin_layout Standard
1568 Some folks also like to look at the log file directly, accessible from
1573 ocument\SpecialChar \menuseparator
1579 \begin_inset space ~
1583 \begin_inset space ~
1589 There are some fairly common error messages and warnings.
1590 We'll cover those here.
1591 You should look at a good LaTeX book for a complete listing.
1594 \begin_layout Itemize
1595 \begin_inset Quotes eld
1603 \begin_inset Quotes eld
1610 \begin_layout Standard
1611 Anything beginning with these word is a warning message for the purpose
1613 \begin_inset Quotes eld
1617 \begin_inset Quotes erd
1620 the LaTeX code itself.
1621 You'll get messages like this if you added or changed cross-references
1622 or bibliography entries, in which case, LaTeX is trying to tell you that
1623 you need to make another run.
1626 \begin_layout Standard
1627 You can by-and-large ignore these.
1631 \begin_layout Itemize
1632 \begin_inset Quotes eld
1640 \begin_inset Quotes erd
1647 \begin_layout Standard
1648 Another warning message, this time about fonts which LaTeX couldn't find.
1649 The rest of the message will often say something about a replacement font
1653 \begin_layout Standard
1654 You can safely ignore these.
1658 \begin_layout Itemize
1659 \begin_inset Quotes eld
1669 \begin_inset Quotes erd
1676 \begin_layout Standard
1682 They are warning you about lines that were too long and run past the right
1684 Almost always, this is unnoticeable in the final output.
1685 Or, only one or two characters extend past the margin.
1686 LaTeX seems to generate at least one of these messages for just about any
1690 \begin_layout Standard
1691 You can ignore these stupid messages.
1692 Your eyes will tell you if there's a problem with something that's too
1693 wide; just look at the output.
1697 \begin_layout Itemize
1698 \begin_inset Quotes eld
1708 \begin_inset Quotes erd
1715 \begin_layout Standard
1716 Not quite as common as its cousin.
1717 LaTeX seems to like to print lines that are a bit too wide as opposed to
1718 ones that are a bit too narrow.
1719 We have no idea why.
1722 \begin_layout Standard
1723 You can ignore these, too.
1727 \begin_layout Itemize
1728 \begin_inset Quotes eld
1738 \begin_inset Quotes erd
1742 \begin_inset Quotes eld
1752 \begin_inset Quotes erd
1759 \begin_layout Standard
1760 Warnings about troubles breaking the page.
1761 Once again, just look at the output.
1762 Your eyes will tell you where something has gone wrong.
1766 \begin_layout Itemize
1767 \begin_inset Quotes eld
1773 \begin_inset Quotes els
1777 \begin_inset Quotes ers
1783 \begin_inset Quotes erd
1790 \begin_layout Standard
1792 \begin_inset Quotes eld
1796 \begin_inset Quotes erd
1799 isn't installed on this system.
1800 This usually appears because some package your document needs isn't installed.
1801 If you didn't touch the preamble or didn't use the
1807 command, then one of the packages LyX tried to load is missing.
1813 elp\SpecialChar \menuseparator
1820 , to get a list of packages that LyX knows about.
1821 This file is updated whenever you reconfigure LyX (using
1828 \SpecialChar \menuseparator
1833 ) and tells you which packages have been detected and what they do.
1836 \begin_layout Standard
1847 command, and the package in question isn't installed, you'll need to install
1852 \begin_layout Itemize
1853 \begin_inset Quotes eld
1858 LaTeX Error: Unknown option
1861 \begin_inset Quotes erd
1868 \begin_layout Standard
1869 Error messages beginning with this are trying to tell you that you specified
1870 a bad or undefined option to a package.
1871 Check the package's documentation.
1875 \begin_layout Itemize
1876 \begin_inset Quotes eld
1881 Undefined control sequence
1884 \begin_inset Quotes erd
1891 \begin_layout Standard
1892 If you've inserted LaTeX code into your document, but made a typo, you'll
1894 You may have forgotten to load a package.
1895 In any case, this error message usually means that you used an undefined
1900 \begin_layout Standard
1901 There are other error and warning messages.
1902 Some are self-explanatory.
1903 These are usually LaTeX messages.
1904 Others are downright cryptic.
1905 These are actually TeX error messages, and we really have
1909 what they mean or how to decipher them.
1912 \begin_layout Standard
1913 There's a general sequence you should follow if you get error messages:
1916 \begin_layout Enumerate
1917 Look at the LaTeX code you inserted for typos.
1920 \begin_layout Enumerate
1921 If there are no typos, check and see that you used the command(s) correctly.
1924 \begin_layout Enumerate
1925 If you get a bunch of error boxes piled up at the very top of the document,
1926 it means that there are errors in the preamble.
1927 Start debugging your preamble.
1930 \begin_layout Enumerate
1931 If you didn't add anything to the preamble and didn't add any LaTeX code
1932 to the document, the first suspect is your LaTeX distribution itself.
1933 Check for missing packages and install them.
1936 \begin_layout Enumerate
1937 Okay, so there are no missing packages.
1938 Did you use any of the fine-tuning options in LyX? Specifically, did you
1943 any of them, like trying to manually insert lots of
1946 \begin_inset space ~
1959 s? Did you try to kludge something together with these instead of using
1960 the appropriate paragraph environment?
1963 \begin_layout Enumerate
1964 All right, you didn't use any of the fine-tuning options, you played by
1966 Did you try to pull a fancy maneuver? Did you do something funky inside
1967 a table or an equation, like inserting a graphic into a table cell?
1970 \begin_layout Enumerate
1971 Do you have long sections of text where LaTeX cannot find a place to break
1972 a line? By default, LaTeX is rather strict about how much extra inter-word
1973 spacing it will add in order to break a line.
1974 Preferably, you should rework the paragraph to avoid the problem.
1975 If this isn't an option, you can wrap your text in
1981 to make LaTeX's line breaking more, well, sloppy.
1984 \begin_layout Enumerate
1985 Did you go overboard with the nesting? LyX (currently) doesn't check to
1986 make sure you're in the limits for nesting environments.
1987 If you nested a bunch of environments to the
1988 \begin_inset Formula $17^{\mathrm{th}}$
1991 level, that's the problem.
1994 \begin_layout Enumerate
1995 Okay, you didn't get any error messages, but your output looks whacked.
1996 If you have a table or figure that's too wide or long for the page, you
2001 \begin_layout Enumerate
2002 rescale the figure so it fits.
2005 \begin_layout Enumerate
2006 trim down the table so it fits.
2009 \begin_layout Standard
2010 If something else is wrong with the output, and you didn't try to pull anything
2011 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2015 \begin_layout Standard
2016 If all this doesn't help --- well, then
2020 you might have found a bug in LyX\SpecialChar \ldots{}
2024 \begin_layout Chapter
2028 \begin_layout Section
2029 Preparing a Bibliography with BibTeX
2032 \begin_layout Standard
2033 The basics how to use BibTeX are explained in section
2035 Bibliography databases (BibTeX)
2042 The following subsections explain special bibliography features supported
2046 \begin_layout Subsection
2047 Alternative Citation Styles
2050 \begin_layout Standard
2051 Standard BibTeX uses numbers (e.
2052 \begin_inset space \thinspace{}
2056 \begin_inset space \space{}
2060 \begin_inset Quotes eld
2064 \begin_inset Quotes erd
2067 ) to refer to a cited work.
2068 However, in many scientific disciplines, other citation styles are in use.
2069 The most common one is the author-year style (e.
2070 \begin_inset space \thinspace{}
2074 \begin_inset space \space{}
2078 \begin_inset Quotes eld
2082 \begin_inset Quotes erd
2086 LyX supports two packages that provide this style,
2095 Both packages have their own pros and cons, which cannot be listed in detail.
2096 If you only want to have simple author-year (or author-numerical) style
2097 or if you want to use one of the countless style files for natbib, than
2102 package is probably your choice.
2103 If you need special features like short title references, ibidem etc., you
2104 might consider the fairly new
2111 \begin_layout Standard
2112 The handling of both packages in LyX is basically the same.
2115 Document\SpecialChar \menuseparator
2131 With both packages, you will get some extra features in the citation dialog
2132 and you can select the style of the reference (
2133 \begin_inset Quotes eld
2137 \begin_inset Quotes erd
2141 \begin_inset Quotes eld
2145 \begin_inset Quotes erd
2149 \begin_inset Quotes eld
2153 \begin_inset Quotes erd
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2165 Note that both packages need specifically designed style files (they both
2166 ship their own, while there are lots of additional style files and even
2167 an interactive style file builder
2171 \begin_layout Plain Layout
2173 \begin_inset Flex URL
2176 \begin_layout Plain Layout
2178 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2195 \begin_layout Subsection
2196 Sectioned Bibliographies
2199 \begin_layout Standard
2200 Sometimes you might need to divide your bibliography into several sections.
2201 If you are for instance a historian, the possibility to separate sources
2202 and scientific works is most likely a
2203 \begin_inset Quotes eld
2207 \begin_inset Quotes erd
2211 Unfortunately, BibTeX itself does not allow you to do this.
2212 But with the help of some LaTeX packages, BibTeX can be extended to fit
2216 \begin_layout Standard
2217 LyX provides native support for one of these packages,
2225 \begin_layout Plain Layout
2227 \begin_inset Flex URL
2230 \begin_layout Plain Layout
2232 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2242 The advantage of this package (compared to other packages like
2246 ) is that you don't need to define new citation commands.
2247 Instead, you need to prepare different bibliographic databases which include
2248 the entries for the different sections of the bibliography.
2249 For example: If you want to divide your bibliography into the sections
2251 \begin_inset Quotes eld
2255 \begin_inset Quotes erd
2259 \begin_inset Quotes eld
2263 \begin_inset Quotes erd
2266 , you first need to create two bibliographic databases, e.
2267 \begin_inset space \thinspace{}
2271 \begin_inset space \space{}
2286 \begin_layout Standard
2289 Document\SpecialChar \menuseparator
2299 \begin_inset space ~
2305 Now you can insert multiple BibTeX bibliographies, one for each section
2306 of your bibliography.
2307 Returning to our example: Insert the BibTeX bibliography
2311 and a second one for the database
2316 You are free to use the same or different styles for each section.
2317 Additionally, you can chose if the bibliography section should contain
2319 \begin_inset Quotes eld
2322 all cited references
2323 \begin_inset Quotes erd
2326 of the specified database(s) (which is the default),
2327 \begin_inset Quotes eld
2330 all uncited references
2331 \begin_inset Quotes erd
2335 \begin_inset Quotes eld
2339 \begin_inset Quotes erd
2343 This might be useful if you would like to separate your bibliography into
2345 \begin_inset Quotes eld
2349 \begin_inset Quotes erd
2353 \begin_inset Quotes eld
2357 \begin_inset Quotes erd
2361 \begin_inset Quotes eld
2365 \begin_inset Quotes erd
2369 The titles for the sections can be added as ordinary sections or subsections.
2374 removes the bibliography title, you have manually re-add that, too (as
2375 a chapter* or section*, for instance).
2378 \begin_layout Subsection
2379 Multiple Bibliographies
2382 \begin_layout Standard
2383 Multiple bibliographies, e.
2384 \begin_inset space \thinspace{}
2388 \begin_inset space \space{}
2391 a bibliography for each section or chapter of the document, are not supported
2397 package, which is used for the creation of sectioned bibliographies in
2398 LyX (see the previous section), provides an easy way to solve this task,
2399 if you are willing to use some TeX Code (see section
2400 \begin_inset space ~
2404 \begin_inset CommandInset ref
2406 reference "sec:Inserting-TeX-Code"
2414 \begin_layout Plain Layout
2415 An alternative approach is to use the
2423 package, respectively.
2431 \begin_layout Standard
2434 Document\SpecialChar \menuseparator
2444 \begin_inset space ~
2450 In the document, you have to enclose the sections, which shall contain
2451 their own bibliography (including the BibTeX bibliography itself), between
2464 (those commands have to be inserted as ERT).
2465 The bibliography will contain all references which have been cited in the
2471 If you are using this approach, then
2475 citation reference has to be inside some btUnit.
2476 Also, the btUnits cannot be nested.
2479 \begin_layout Standard
2483 \begin_layout Section
2487 \begin_layout Subsection
2491 \begin_layout Standard
2492 When you are working on a large file with many sections, it is often convenient
2493 to break up the document into several files, or perhaps you have something
2494 where a table may change from time to time, but the preceding text does
2496 In these cases, you should seriously consider using multipart documents.
2497 For example, scientific papers often have five major sections: the introduction
2498 , observations, results, discussion, and conclusion.
2499 Each of these could be its own separate LyX file, with one
2500 \begin_inset Quotes eld
2504 \begin_inset Quotes erd
2507 file which contains the title, authors, abstract, references, etc., plus
2508 the five included files.
2509 It is important to note that each of these files is a full LyX file which
2510 can be formatted and printed on its own, as well as included in a master
2512 Each of these files must have the same document class, however--- don't
2513 attempt to mix book classes with article classes.
2514 You may also include LaTeX files; however, these files must not have their
2520 everything up to and including the
2532 line must be deleted) or else errors will be generated when you try to
2536 \begin_layout Standard
2537 LyX allows you to include files quite easily with
2539 Insert\SpecialChar \menuseparator
2541 \begin_inset space ~
2547 When you click on this selection a small box is inserted into the file
2548 at the current cursor location.
2549 Clicking on the box raises a dialog which allows you to select the file
2550 to be included, and the method of its inclusion.
2554 \begin_layout Standard
2555 The file selection box should by now be obvious.
2556 The three inclusion methods are
2557 \begin_inset Quotes eld
2561 \begin_inset Quotes erd
2565 \begin_inset Quotes eld
2569 \begin_inset Quotes erd
2573 \begin_inset Quotes eld
2577 \begin_inset Quotes erd
2581 The difference between
2582 \begin_inset Quotes eld
2586 \begin_inset Quotes erd
2590 \begin_inset Quotes eld
2594 \begin_inset Quotes erd
2597 is really only meaningful to LaTeXperts, but the practical difference is
2598 that files which are
2599 \begin_inset Quotes eld
2603 \begin_inset Quotes erd
2606 are typeset beginning on a new page, while files which are
2607 \begin_inset Quotes eld
2611 \begin_inset Quotes erd
2614 are typeset starting on the current page.
2615 Perhaps the labeling in LyX will be changed someday to reflect this.
2618 \begin_layout Standard
2619 Generally, the master file is converted into a full LaTeX file before typesettin
2620 g, while the included files are converted to LaTeX files which do not have
2621 all the preamble information.
2627 \begin_inset space ~
2634 button prevents this conversion.
2637 \begin_layout Standard
2639 \begin_inset Quotes eld
2643 \begin_inset Quotes erd
2646 included file allows you to include a file typeset exactly as it appears
2648 \begin_inset space ~
2651 verbatim mode, with the characters set in a fixed-width typewriter font.
2652 Normally, spaces in this file are invisible, though two consecutive spaces
2653 are conserved, unlike LyX's normal treatment of spaces.
2654 However, setting the
2657 \begin_inset space ~
2661 \begin_inset space ~
2665 \begin_inset space ~
2670 checkbox typesets a mark to unambiguously define the presence of a space.
2674 \begin_layout Subsection
2675 Cross-References Between Files
2678 \begin_layout Standard
2679 It is possible to set up cross-references between the different files.
2680 First, open all the files in question: let's call them A and B in a two
2681 file example, where B is included in A.
2682 Let's say you insert a label in A, then want to reference it in B.
2683 Open the cross-reference dialog in whilst in document B, and you can select
2685 \begin_inset Quotes eld
2689 \begin_inset Quotes erd
2695 \begin_layout Subsection
2696 Bibliography Lists in all Subdocuments
2699 \begin_layout Standard
2700 Copy the bibliography list with all entries to all subdocuments and transform
2702 This way LyX will find the
2706 -files and you can easily insert references without making the bibliography
2710 \begin_layout Standard
2711 As the bibliography list is in a comment, LaTeX won't use use it and the
2712 references will look like this [?] instead of [1].
2713 A solution is to use the LaTeX-package
2717 that will only include comments by processing the files separately.
2718 To do this, add in the LaTeX preamble of every subdocument the following:
2721 \begin_layout LyX-Code
2727 \begin_layout LyX-Code
2730 includecomment{comment}
2733 \begin_layout Standard
2735 \begin_inset Flex URL
2738 \begin_layout Plain Layout
2740 http://wiki.lyx.org/FAQ/Unsorted#toc31
2748 \begin_layout Section
2749 Fancy Headers and Footers
2752 \begin_layout Standard
2753 The default page layout is rather plain; for an article document class,
2754 all you get is a centered page number at the bottom of the page.
2755 This document is the book class, so it appears to be a bit fancier, but
2756 to really put on a show, you need to set the document page style to
2757 \begin_inset Quotes eld
2761 \begin_inset Quotes erd
2764 , as mentioned in the
2767 \begin_inset space ~
2773 This section describes the LaTeX codes you need to insert in your LaTeX
2774 preamble or the text in order to get the desired effects.
2777 \begin_layout Standard
2778 The page header is divided into three fields, not surprisingly labeled
2779 \begin_inset Quotes eld
2783 \begin_inset Quotes erd
2787 \begin_inset Quotes eld
2791 \begin_inset Quotes erd
2795 \begin_inset Quotes eld
2799 \begin_inset Quotes erd
2803 The footer is also divided into these three fields.
2804 The LaTeX commands to set these fields in the simplest manner are
2829 Suppose you wish to put your name in the upper left hand corner of each
2831 Simply insert the following command in the preamble:
2834 \begin_layout Standard
2843 \begin_layout Standard
2844 You will now see your name in the upper left.
2845 If a field has a default entry that you would like to get rid of (often
2846 the page number appears in the central footer, simply include a command
2847 with a blank argument, e.
2848 \begin_inset space \thinspace{}
2854 \begin_layout Standard
2862 \begin_layout Standard
2863 Let's get really fancy: lets put the section number with the word
2864 \begin_inset Quotes eld
2868 \begin_inset Quotes erd
2872 \begin_inset space \thinspace{}
2876 \begin_inset space ~
2879 Section 3) in the upper left, the page number (e.
2880 \begin_inset space \thinspace{}
2884 \begin_inset space ~
2887 Page 4) in the upper right, your name in the lower left, and the date in
2889 The following commands should now appear in the preamble:
2892 \begin_layout Standard
2902 \begin_layout Standard
2910 \begin_layout Standard
2920 \begin_layout Standard
2929 \begin_layout Standard
2937 \begin_layout Standard
2947 \begin_layout Standard
2960 access LaTeX's section and page counters, and so print out the current
2961 section and page numbers.
2968 simply prints out today's date.
2971 \begin_layout Standard
2972 The thicknesses of the horizontal rules drawn beneath the header and above
2973 the footer can also be modified.
2974 If you don't want one of the headers, set its thickness to 0.
2975 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2976 Use the commands, e.
2977 \begin_inset space \thinspace{}
2987 headrulewidth}{0.4pt}
2995 footrulewidth}{0.4pt}
2997 to set the thicknesses.
3000 \begin_layout Standard
3001 You can switch the header/footer settings on and off for individual pages
3006 thispagestyle{empty}
3012 thispagestyle{plain}
3018 thispagestyle{fancy}
3021 Simply insert them in the text on the page you want changed and mark them
3023 In fact, title pages are marked as plain by default, while following pages
3024 are marked fancy when using the global fancy setting.
3027 \begin_layout Standard
3028 There are more complex commands which will let you insert things in the
3029 upper left on odd numbered pages, etc., but I will refer you to the
3033 package documentation for more descriptions.
3034 For example, if you have a teTeX installation, look for
3036 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3042 \begin_layout Standard
3043 As a final example, it is possible to include an Encapsulated PostScript
3044 file in the header or footer.
3045 Suppose you want to put a company logo in the upper lefthand corner.
3046 You might try something like
3049 \begin_layout Standard
3058 includegraphics{logo.eps}}}
3061 \begin_layout Standard
3063 (you may need to preface this with
3067 usepackage{graphics}
3069 if you don't include EPS files elsewhere in your document).
3072 \begin_layout Section
3073 Itemize Bullet Selection
3074 \begin_inset CommandInset label
3083 \begin_layout Standard
3089 \begin_layout Subsection
3093 \begin_layout Standard
3094 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3095 Using this dialog you can easily specify what bullet shape to use at each
3096 level of an itemized list.
3097 These settings are document-wide so you won't be able to specify different
3098 sets of bullets for different paragraphs
3102 \begin_layout Plain Layout
3103 Well, actually you can but you'll have to do it by hand.
3111 \begin_layout Subsection
3115 \begin_layout Standard
3116 Open the dialog by selecting the
3121 ocument\SpecialChar \menuseparator
3128 menu item and then select the
3138 \begin_layout Standard
3139 The dialog provides you with a table of bullet shapes.
3140 A column of buttons on the left of the table provides access to the six
3141 different panels of bullet shapes.
3142 The row of buttons across the top is used to select which bullet depth
3144 A text entry under the table shows the currently selected bullet shape's
3145 LaTeX equivalent and this can be edited if desired.
3146 If you do modify the text you will also need to specify any needed packages
3147 in the LaTeX preamble.
3150 \begin_layout Standard
3151 The six panels are divided up by the packages they require.
3152 The following table shows the mappings from button name to LaTeX packages.
3155 \begin_layout Standard
3157 \begin_inset Tabular
3158 <lyxtabular version="3" rows="7" columns="2">
3160 <column alignment="center" valignment="top" width="0pt">
3161 <column alignment="center" valignment="top" width="0pt">
3163 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3166 \begin_layout Plain Layout
3181 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3184 \begin_layout Plain Layout
3201 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3204 \begin_layout Plain Layout
3219 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3222 \begin_layout Plain Layout
3238 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3241 \begin_layout Plain Layout
3256 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3259 \begin_layout Plain Layout
3276 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3279 \begin_layout Plain Layout
3294 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3297 \begin_layout Plain Layout
3314 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3317 \begin_layout Plain Layout
3332 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3335 \begin_layout Plain Layout
3352 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3355 \begin_layout Plain Layout
3370 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3373 \begin_layout Plain Layout
3390 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3393 \begin_layout Plain Layout
3408 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3411 \begin_layout Plain Layout
3434 \begin_layout Standard
3435 LyX doesn't stop you using bullets from packages you don't have.
3436 If you get errors from LaTeX when you try to view or print the file then
3437 its likely you are missing a package.
3438 LyX doesn't restrict your use since you may be editing locally and exporting
3442 \begin_layout Subsection
3446 \begin_layout Standard
3447 Select which bullet depth you want to change then select the bullet shape
3449 Any changes will not be visible in LyX, but are visible when viewing the
3450 document using xdvi or ghostview.
3453 \begin_layout Standard
3454 You can reset a bullet shape to the default simply by clicking your right
3455 mouse button on the appropriate bullet depth button.
3458 \begin_layout Standard
3463 want to have multiple sets of paragraphs with different sets of bullets
3464 in each then you're going to have to get your hands dirty.
3465 The itemize bullet selection dialog can help though because it provides
3466 you with the LaTeX code for a wide range of bullet shapes.
3467 To make your own custom paragraphs you have the following options:
3470 \begin_layout Standard
3474 \begin_layout Plain Layout
3490 \begin_layout Standard
3494 \begin_layout Plain Layout
3516 \begin_layout Itemize
3517 Use the LaTeX command
3523 to specify a new bullet shape for a given depth.
3524 You'll also need to save the current bullet shape so you can restore it
3526 In this itemized list the following LaTeX code was used to change the bullet
3527 used for the first depth.
3528 \begin_inset Newline newline
3544 \begin_inset Newline newline
3560 \begin_inset Newline newline
3565 Note that the itemize depth is specified in Roman numerals as part of the
3575 \begin_layout Itemize
3579 \begin_layout Plain Layout
3592 Specify each individual entry by starting each item with the bullet shape
3593 enclosed in square brackets and set as TeX.
3594 For example, this item was started with
3607 \begin_layout Standard
3611 \begin_layout Plain Layout
3627 \begin_layout Standard
3628 You'll also need to revert the labelitem back to its previous setting for
3629 the global bullet shape settings to remain in effect.
3630 The way used here was:
3631 \begin_inset Newline newline
3645 \begin_layout Chapter
3646 Special Document Classes
3649 \begin_layout Section
3650 \begin_inset CommandInset label
3652 name "sec:AMS-LaTeX"
3659 \begin_layout Standard
3662 David Johnson; updated by Richard Heck
3665 \begin_layout Standard
3666 \begin_inset VSpace bigskip
3672 \begin_layout Standard
3674 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3675 papers to be submitted to American Mathematical Society publications.
3676 The layouts are not tailored to a specific journal, but easily can be.
3677 You should refer to the AMS documentation for specific instructions for
3678 each journal (usually it will entail only changing a single line in the
3680 That documentation is available on the Web at
3681 \begin_inset Flex URL
3684 \begin_layout Plain Layout
3692 \begin_inset Flex URL
3695 \begin_layout Plain Layout
3697 ftp://ftp.ams.org/pub/tex/amslatex/
3703 These layouts are appropriate, and useful, for any mathematical writing.
3707 \begin_layout Standard
3708 There are two basic AMS LaTeX layouts:
3711 \begin_layout Enumerate
3712 amsart: The standard AMS article format.
3715 \begin_layout Enumerate
3716 amsbook: the standard AMS book (really, monograph) format.
3720 \begin_layout Standard
3721 These layouts themselves contain only the minimum necessary to use the AMS
3723 They do not, in particular, contain any of the `theorem' environments used
3724 for setting theorems, lemmas, and the like.
3725 These are contained, instead, in the
3726 \begin_inset Flex CharStyle:Code
3729 \begin_layout Plain Layout
3735 module, which you will need to load separately when you selected one of
3737 Less commonly used environments are in the
3738 \begin_inset Flex CharStyle:Code
3741 \begin_layout Plain Layout
3742 Theorems (AMS-Extended)
3751 \begin_layout Standard
3752 By default, theorems and the like are numbered consecutively throughout
3753 the document, but this may be modified by loading the module
3754 \begin_inset Flex CharStyle:Code
3757 \begin_layout Plain Layout
3758 Theorems (Order by Section)
3763 or, if you are using
3764 \begin_inset Flex CharStyle:Code
3767 \begin_layout Plain Layout
3774 \begin_inset Flex CharStyle:Code
3777 \begin_layout Plain Layout
3778 Theorems (Order by Chapter)
3784 These will number the results as
3785 \begin_inset Formula $n.m$
3788 , where the first number refers to the section (or chapter) and the second
3789 refers to the total number of results so far in that section (or chapter).
3790 Many environments are also available unnumbered.
3791 These are indicated by an asterisk at the end.
3792 If you happen to want
3796 unnumbered results, the the module
3797 \begin_inset Flex CharStyle:Code
3800 \begin_layout Plain Layout
3806 provides that option.
3809 \begin_layout Standard
3810 Note that these modules do not
3814 to be used with the AMS classes.
3815 It is perfectly possible to use the
3816 \begin_inset Flex CharStyle:Code
3819 \begin_layout Plain Layout
3825 module, and the others mentioned, with other classes, such as
3826 \begin_inset Flex CharStyle:Code
3829 \begin_layout Plain Layout
3836 \begin_inset Flex CharStyle:Code
3839 \begin_layout Plain Layout
3846 \begin_inset Flex CharStyle:Code
3849 \begin_layout Plain Layout
3858 \begin_layout Subsection
3859 What these layouts provide
3862 \begin_layout Standard
3863 There is a long list of included environments provided by these layouts.
3864 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3865 variety of `theorem' environments.
3866 However, the AMS recommends the environments that are available in LyX.
3870 \begin_layout Standard
3871 The following environments---as well as the standard environments, such
3873 \begin_inset Flex CharStyle:Noun
3876 \begin_layout Plain Layout
3883 \begin_inset Flex CharStyle:Noun
3886 \begin_layout Plain Layout
3893 \begin_inset Flex CharStyle:Noun
3896 \begin_layout Plain Layout
3903 \begin_inset Flex CharStyle:Noun
3906 \begin_layout Plain Layout
3913 \begin_inset Flex CharStyle:Noun
3916 \begin_layout Plain Layout
3923 \begin_inset Flex CharStyle:Code
3926 \begin_layout Plain Layout
3933 \begin_inset Flex CharStyle:Code
3936 \begin_layout Plain Layout
3945 \begin_layout Description
3946 Address This should be the author's permanent address.
3949 \begin_layout Description
3951 \begin_inset space ~
3954 Address This should be the author's temporary address at the time of submission,
3955 if different from the Address.
3958 \begin_layout Description
3959 Email Author's e-mail address
3962 \begin_layout Description
3963 URL Author's Web address, if desired.
3966 \begin_layout Description
3967 Keywords Key words or phrases used to identify specific topics discussed
3971 \begin_layout Description
3972 Subjectclass These refer to the AMS Subject Classifications, published and
3975 Mathematical Reviews
3978 These are also available online at the AMS cites listed above.
3981 \begin_layout Description
3985 \begin_layout Description
3989 \begin_layout Description
3993 \begin_layout Standard
3994 The following environments are provided by both the
3995 \begin_inset Flex CharStyle:Code
3998 \begin_layout Plain Layout
4005 \begin_inset Flex CharStyle:Code
4008 \begin_layout Plain Layout
4014 modules, in the latter case in both starred (unnumbered) and unstarred
4015 (numbered) versions.
4016 These same environments are provided only in the starred versions by the
4018 \begin_inset Flex CharStyle:Code
4021 \begin_layout Plain Layout
4030 \begin_layout Theorem
4031 This is typically used for the statements of major results.
4035 \begin_layout Corollary*
4036 This is used for statements which follow fairly directly from previous statement
4038 Again, these can be major results.
4043 These are smaller results needed to prove other statements.
4046 \begin_layout Proposition
4047 These are less major results which (hopefully) add to the general theory
4051 \begin_layout Conjecture
4052 These are statements provided without justification, which the author does
4053 not know how to prove, but which seem to be true (to the author, at least).
4056 \begin_layout Definition*
4057 Guess what this is for.
4058 The font is different for this environment than for the previous ones.
4062 \begin_layout Example*
4063 Used for examples illustrating proven results.
4066 \begin_layout Problem
4067 It's not really known what this is for.
4068 You should figure it out.
4071 \begin_layout Exercise*
4072 Write a description for this one.
4075 \begin_layout Remark
4076 This environment is also a type of theorem, usually a lesser sort of observation.
4079 \begin_layout Claim*
4080 Often used in the course of giving a proof of a larger result.
4084 Generally, these are used to break up long arguments, using specific instances
4090 The numbering scheme for cases is on its own, not together with other numbered
4096 At the end of this environment , a QED symbol (usually a square, but it
4097 can vary with different styles) is placed.
4098 If you want to have other environments within this one---for example, Case
4099 environments---and have the QED symbol appear only after them, then the
4100 other environments need to be nested within the proof environment.
4103 Nesting Environments
4109 for information on nesting.
4112 \begin_layout Standard
4113 And these are provided by
4114 \begin_inset Flex CharStyle:Code
4117 \begin_layout Plain Layout
4118 Theorems (AMS-Extended)
4126 \begin_layout Criterion*
4127 A required condition.
4130 \begin_layout Algorithm*
4131 A general procedure to be used.
4134 \begin_layout Axiom*
4135 This is a property or statement taken as true within the system being discussed.
4138 \begin_layout Condition*
4139 Sometimes used to state a condition assumed within the present context of
4144 Similar to a Remark.
4147 \begin_layout Notation*
4148 Used for the explanation of, yes, notation.
4151 \begin_layout Summary
4152 Do we really need to tell you?
4155 \begin_layout Acknowledgement*
4159 \begin_layout Conclusion*
4160 Sometimes used at the end of a long train of argument.
4164 Used in a way similar to Proposition, though perhaps lower on the scale.
4167 \begin_layout Standard
4168 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
4170 They need to be available on your system in order to use these environments.
4173 \begin_layout Section
4177 \begin_layout Standard
4182 can be used to type letters according to German conventions.
4183 A template file is included in
4185 .../lyx/share/templates
4187 for you to use as a starting point.
4190 \begin_layout Section
4194 \begin_layout Standard
4199 provides an alternative to the standard
4204 It provides similar functionality, but you might prefer this layout with
4205 sans serif sections, headings, and more.
4208 \begin_layout Section
4212 \begin_layout Standard
4218 \begin_layout Subsection
4222 \begin_layout Standard
4223 This section describes how LyX can be used to write articles for submission
4224 to the scientific journal
4226 Astronomy and Astrophysics
4228 (www.edpsciences.fr/aa/
4229 \begin_inset Flex URL
4232 \begin_layout Plain Layout
4234 http://www.edpsciences.fr/aa/
4239 ) using Version 5.01 of the document class
4244 This package can be downloaded from the ftp site
4247 \begin_layout Standard
4248 \begin_inset VSpace medskip
4254 \begin_layout Standard
4256 \begin_inset Flex URL
4259 \begin_layout Plain Layout
4261 ftp://ftp.edpsciences.org/pub/aa/readme.html
4269 \begin_layout Standard
4270 \begin_inset VSpace medskip
4276 \begin_layout Standard
4277 A manual comes together with that package, and this text is not meant to
4278 replace the original manual but merely a short guide how to realize the
4279 correct form of your paper.
4283 \begin_layout Standard
4284 Please note that the publisher of the journal was changed from Springer
4285 to EDP Sciences starting January 1, 2001.
4286 That change implicated also some slight changes of the style files, namely
4287 the removal of the thesaurus command.
4288 The LyX class aa supports the newest version of these style files, V 5.01.
4289 If you have an older version installed, please upgrade.
4290 For compatibility, the old (version 4) layout has been kept as
4295 Please refer to the comments in
4297 LyXDir/layouts/aapaper.layout
4302 \begin_layout Subsection
4306 \begin_layout Standard
4307 It is recommended you start from the example template distributed with LyX.
4308 If you are not using a template, note the following settings:
4311 \begin_layout Itemize
4321 ocument\SpecialChar \menuseparator
4328 dialog (OK, that one was obvious).
4331 \begin_layout Itemize
4332 Don't change the option
4335 \begin_inset space ~
4345 The whole layout is done by the macros, you shouldn't change anything.
4348 \begin_layout Subsection
4352 \begin_layout Standard
4353 First thing to enter is the header information.
4354 It consists of seven entries, of which some are optional.
4358 \begin_layout Itemize
4366 \begin_layout Itemize
4374 \begin_layout Itemize
4382 \begin_layout Itemize
4390 \begin_layout Itemize
4395 : [optional] if more than one author: whom to contact for offprint requests.
4398 \begin_layout Itemize
4403 : [optional] mail address for contacts.
4406 \begin_layout Itemize
4414 Received: <date>; Accepted <date>
4417 \begin_layout Standard
4418 There is no need to issue the
4424 command, this is done automatically by LyX when the header is finished.
4425 Although the order of the single header entries doesn't matter it is advised
4426 to keep the above sequence, just to get the best optics and meets the layout
4427 of the real document.
4430 \begin_layout Standard
4431 If you want to place footnotes in the header block, e.
4432 \begin_inset space \thinspace{}
4436 \begin_inset space ~
4439 to state your present address, just use the standard footnote via
4444 nsert\SpecialChar \menuseparator
4452 LyX will automagically use the term
4461 \begin_layout Standard
4462 In addition to these topics, the macros use three additional LaTeX commands
4463 that have no counterpart in LyX:
4466 \begin_layout Itemize
4473 to separate different names for more than one author and institute, respectivel
4477 \begin_layout Itemize
4484 to mark corresponding author/institute pairs.
4485 The institutes are numbered sequentially as they appear in the
4489 field, so you have to put a marker to each author.
4492 \begin_layout Itemize
4499 to supply an email address for fast contact.
4502 \begin_layout Standard
4503 In all cases, the appropriate command has to be entered in LyX and marked
4509 \begin_layout Subsection
4513 \begin_layout Standard
4514 The abstract should immediately follow the header block.
4515 With version 5 the abstract environment was changed to a command, and there
4516 is now a resctriction to only one paragraph.
4517 In addition, it should contain an entry with the keywords.
4518 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4525 by hand and mark it as LaTeX code.
4526 Refer to the example paper.
4529 \begin_layout Subsection
4530 Supported environments
4533 \begin_layout Standard
4534 The A&A paper layout supports the following environments for structuring
4538 \begin_layout Itemize
4544 \begin_layout Itemize
4550 \begin_layout Itemize
4556 \begin_layout Itemize
4562 \begin_layout Itemize
4568 \begin_layout Itemize
4574 \begin_layout Itemize
4580 \begin_layout Itemize
4586 \begin_layout Itemize
4592 \begin_layout Itemize
4598 \begin_layout Itemize
4604 \begin_layout Itemize
4610 \begin_layout Subsection
4611 Commands not supported by LyX
4614 \begin_layout Standard
4615 Some commands are not yet supported by the
4620 Some have already been mentioned.
4621 For the sake of completeness, they are listed all together here:
4624 \begin_layout Itemize
4632 \begin_layout Itemize
4640 \begin_layout Itemize
4648 \begin_layout Itemize
4656 \begin_layout Itemize
4664 \begin_layout Itemize
4672 \begin_layout Itemize
4680 \begin_layout Itemize
4688 \begin_layout Standard
4689 If you want to use any of these commands, you have to enter them yourself.
4692 Do not forget to mark them as LaTeX code!
4695 \begin_layout Subsection
4696 Figure and Table Floats
4699 \begin_layout Standard
4700 LyX provides support for the necessary float environments
4702 figure, figure*, table
4708 , therefore we won't tell much about it here.
4712 \begin_inset space ~
4718 Just remember that tables should be left-aligned.
4719 For that, select the table and change the alignment in
4724 dit\SpecialChar \menuseparator
4730 \begin_inset space ~
4736 \begin_layout Standard
4737 There is only one special thing: the figures with caption besides the figure.
4738 To create such a figure, you have to do the following:
4741 \begin_layout Enumerate
4742 Create a wide figure float:
4747 nsert\SpecialChar \menuseparator
4752 t\SpecialChar \menuseparator
4755 , then right click in the figure and select
4761 \begin_inset space ~
4769 \begin_layout Enumerate
4770 Enter your caption text.
4773 \begin_layout Enumerate
4778 to move the cursor above the caption.
4781 \begin_layout Enumerate
4785 \begin_layout Enumerate
4786 Position the cursor behind the figure and insert a horizontal fill:
4791 nsert\SpecialChar \menuseparator
4797 \begin_inset space ~
4802 \SpecialChar \menuseparator
4806 \begin_inset space ~
4814 \begin_layout Enumerate
4815 Switch to LaTeX mode:
4818 \begin_inset space ~
4826 \begin_layout Enumerate
4836 Do not close the brace!
4839 \begin_layout Enumerate
4840 Position the cursor behind the caption text, switch to LaTeX mode and insert
4844 \begin_inset space ~
4856 \begin_layout Standard
4857 Also, refer to the figures in the example paper.
4860 \begin_layout Subsection
4864 \begin_layout Standard
4865 For submission, the paper has to be formated in a special double-spacing
4867 For this purpose, you have to give the option
4871 to the documentclass.
4872 This must be done using the extra class options field in the
4877 ocument\SpecialChar \menuseparator
4885 Just enter the string
4892 \begin_layout Subsection
4896 \begin_layout Standard
4901 directory contains an example paper written with LyX.
4902 It is the example paper from the original macro package, translated to
4904 Use it for inspiration, and compare the original LaTeX code with LyX way
4908 \begin_layout Section
4912 \begin_layout Standard
4918 \begin_layout Subsection
4922 \begin_layout Standard
4923 AASTeX is a set of macros produced by the American Astronomical Society
4924 to facilitate electronic manuscript submission to the three journals they
4925 publish: the Astrophysical Journal (including the Letters and Supplement),
4926 the Astronomical Journal, and the Publications of the Astronomical Society
4928 LyX has proven to be an excellent tool for generating these documents,
4929 especially given its equation, citation, and figure handling capabilities.
4930 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4931 is the version described here, or higher.
4932 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4933 incompatible with LyX.
4934 The AASTeX package may be downloaded from the AASTeX Web site
4937 \begin_layout Standard
4938 \begin_inset VSpace medskip
4944 \begin_layout Standard
4946 \begin_inset Flex URL
4949 \begin_layout Plain Layout
4951 http://www.journals.uchicago.edu/AAS/AASTeX
4959 \begin_layout Standard
4960 \begin_inset VSpace medskip
4966 \begin_layout Standard
4967 A complete user guide is contained in that package and you should familiarize
4968 yourself with it thoroughly before embarking on writing a paper in LyX.
4969 LyX will not reduce the need to figure out all the AASTeX commands, it
4970 will only reduce the drudgery of typing everything in.
4971 It is your responsibility to ensure that the final exported LaTeX document
4972 conforms completely to the requirements of the journal to which you are
4973 submitting your paper.
4976 \begin_layout Subsection
4977 Starting a New Paper
4980 \begin_layout Standard
4981 I strongly suggest that you start with the AASTeX template file.
4987 ile\SpecialChar \menuseparator
4997 , enter the new file name, then choose the
5002 This will show the most common fields found in a manuscript.
5003 Simply overwrite the existing text (including the brackets,
5007 ) with the correct information.
5008 Many of the AASTeX commands and environments can be implemented directly
5009 in LyX, but some cannot: most noticeably
5021 , which should stick out like a sore thumb if you actually just opened the
5023 For commands such as these, the LaTeX code must be entered directly and
5025 Such commands are referred to as ERT, or Evil Red Text.
5026 I tried to minimize the amount of ERT needed in an AASTeX document, but
5027 there is still a bit more required than any of us would like.
5030 \begin_layout Subsection
5031 Finishing Your Paper
5034 \begin_layout Standard
5035 When the paper is finished to your satisfaction and previews/prints correctly,
5037 \begin_inset Quotes eld
5041 \begin_inset Quotes erd
5044 actions which need to be done before you submit it to the journals.
5048 \begin_layout Enumerate
5049 Export your paper as a LaTeX file (
5054 ile\SpecialChar \menuseparator
5059 xport\SpecialChar \menuseparator
5070 \begin_layout Enumerate
5075 file with your favorite text editor
5079 \begin_layout Enumerate
5080 remove the comment lines before the
5089 \begin_layout Enumerate
5094 usepackage...{fontenc}
5096 line if it appears (usually just after
5111 \begin_layout Enumerate
5112 remove everything between (and including) the
5124 commands, except for any commands you specifically put into the LaTeX preamble
5125 (which should appear immediately after the
5126 \begin_inset Quotes eld
5129 User specified LaTeX commands
5130 \begin_inset Quotes erd
5141 \begin_layout Enumerate
5142 Run the resulting file through LaTeX to make sure it still processes correctly.
5145 \begin_layout Enumerate
5146 Reread the journal requirements to make sure your filenames and formats
5150 \begin_layout Enumerate
5154 \begin_layout Subsection
5155 Comments On Specific Commands
5158 \begin_layout Standard
5159 I will not describe the detailed usage of the individual AASTeX commands:
5160 the AASTeX User Guide (
5164 ) gives a good description of each.
5165 Thus it's probably easiest for me to go down the list as found in the guide
5166 and offer comments where necessary.
5167 So let's begin \SpecialChar \ldots{}
5171 \begin_layout Subsubsection
5172 Things that work as expected
5175 \begin_layout Standard
5179 \begin_layout Plain Layout
5191 \begin_layout Standard
5192 Because they work as you might expect, I simply list them and the section
5293 begin{thebibliography}
5301 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5302 graphicx figure commands (2.14.1),
5326 (2.15.4, amongst other places),
5353 \begin_layout Standard
5354 The following style options also work correctly:
5375 Simply put them in the
5381 Layout\SpecialChar \menuseparator
5387 \begin_layout Standard
5391 \begin_layout Plain Layout
5403 \begin_layout Subsubsection
5404 Things that work, but require more comment
5407 \begin_layout Standard
5408 The following items work, but require a little more discussion:
5411 \begin_layout Itemize
5412 These items are reserved for use by the journal editors, but you can put
5413 them into the LaTeX preamble if you feel compelled to do so:
5446 \begin_layout Itemize
5447 These items may be placed in the LaTeX preamble, and are included as blanks
5448 in the template file:
5469 \begin_layout Itemize
5476 (2.3) -- can only be used
5477 \begin_inset Quotes eld
5481 \begin_inset Quotes erd
5484 , not in the middle of a paragraph.
5485 Use ERT if you need to embed it.
5488 \begin_layout Itemize
5495 (2.3) -- will have extra {} after it.
5496 This should not cause an error.
5499 \begin_layout Itemize
5506 (2.6) -- can only be used
5507 \begin_inset Quotes eld
5511 \begin_inset Quotes erd
5514 , not in the middle of a paragraph.
5515 Use ERT if you need to embed it.
5518 \begin_layout Itemize
5525 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5529 \begin_layout Itemize
5536 (2.8) -- same as for
5543 \begin_layout Itemize
5550 (2.9) -- will have extra {} after it.
5551 This should not cause an error.
5554 \begin_layout Itemize
5561 (2.11) -- will have extra {} after it.
5562 This should not cause an error.
5565 \begin_layout Itemize
5572 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5573 at the beginning of the text and selecting
5575 Insert\SpecialChar \menuseparator
5580 \begin_inset Quotes eld
5584 \begin_inset Quotes erd
5587 inserts an optional argument of the type needed by
5594 Hopefully it will be renamed someday.
5597 \begin_layout Itemize
5610 for the catalog ID optional parameter
5613 \begin_layout Itemize
5626 for the catalog ID optional parameter
5629 \begin_layout Subsubsection
5630 Things not implemented, use ERT
5633 \begin_layout Standard
5637 \begin_layout Plain Layout
5649 \begin_layout Standard
5672 setcounter{equation}
5674 (2.12), Journal name abbreviations (2.13.4),
5710 (2.15.4, insert it as the first element in the lefthand cell after where
5712 Don't use any of LyX's rules in the table),
5724 (2.15.5), much of Misc (2.17, except
5775 \begin_layout Standard
5779 \begin_layout Plain Layout
5791 \begin_layout Subsubsection
5792 Things that cannot be implemented
5795 \begin_layout Standard
5796 \SpecialChar \ldots{}
5797 at least in any meaningful sort of way, so I suggest ignoring them.
5798 They are the references environment (2.13.3), and the deluxetable environment
5800 If you really, really need to use deluxetable, I suggest editing it in
5801 a separate file with a text editor, then using
5806 nsert\SpecialChar \menuseparator
5812 \begin_inset space ~
5817 to include it in your LyX document.
5822 file to see an example of this.
5825 \begin_layout Subsection
5826 FAQs, Tips, Tricks, and Other Ruminations
5829 \begin_layout Subsubsection
5830 Getting LyX and AASTeX to cooperate
5833 \begin_layout Standard
5834 It can be a bit tricky to get LyX to recognize a new layout and document
5836 When all else fails, do this:
5839 \begin_layout Enumerate
5840 Make certain that LaTeX can find AASTeX.
5841 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5842 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5849 \begin_layout Enumerate
5861 \begin_layout Enumerate
5867 ools\SpecialChar \menuseparator
5874 in LyX, then restart LyX.
5877 \begin_layout Enumerate
5878 Open a regular new file, not from a template.
5879 Does AASTeX appear in the class list in
5884 ocument\SpecialChar \menuseparator
5894 \begin_layout Standard
5895 If you get a warning from an existing AASTeX document about not being able
5896 to find the AASTeX layout or a message about
5897 \begin_inset Quotes eld
5900 You should not mix title layouts with normal ones
5901 \begin_inset Quotes erd
5904 , things haven't been installed correctly.
5907 \begin_layout Subsubsection
5908 LaTeX error processing a table
5911 \begin_layout Standard
5912 LyX, by default, attempts to center the table caption/title.
5913 This seems to produce a bad interaction in AASTeX so you should click somewhere
5914 in the caption/title, then select
5919 dit\SpecialChar \menuseparator
5925 \begin_inset space ~
5942 This took care of it for me.
5945 \begin_layout Subsubsection
5947 \begin_inset CommandInset label
5956 \begin_layout Standard
5957 A couple of things: 1) I have noticed some funny spacing in the reference
5958 entries in the text.
5959 When you enter the bibliography item data, make sure their is
5963 space between the last author and the parenthesis setting off the year;
5967 \begin_inset space \thinspace{}
5971 \begin_inset space ~
5985 2) Entering the references at all is not obvious.
5986 The easiest thing is to start typing your first reference at the end of
5987 the document, then mark it as type
5992 That will put a small gray box in front of what you just typed.
5993 Click on the box to fill in the rest of the information.
5994 For new references, go to the end of an existing reference and press return.
5995 That will create a new line with its own box, etc.
5998 \begin_layout Subsubsection
6002 \begin_layout Standard
6003 Even though AASTeX provides its own figure commands (
6009 , for example), I much prefer LaTeX's standard figure commands (with the
6018 \begin_inset space ~
6021 commands as ERT into a Figure Float box if you desire, but I never have
6022 much luck getting the layout right.
6023 With the standard graphics, LyX will insert a
6027 usepackage{graphicx}
6029 command into the LaTeX preamble and handle the figures in the standard
6030 LaTeX2e way, interspersing the figures in the text.
6031 I believe ApJ accepts figures exactly this way now; AJ might still use
6033 \begin_inset Quotes eld
6036 stack everything at the end
6037 \begin_inset Quotes erd
6043 \begin_layout Subsubsection
6044 Things I could have done, but didn't
6047 \begin_layout Standard
6049 \begin_inset Quotes eld
6053 \begin_inset Quotes erd
6056 things I could have implemented, but chose not to.
6057 For instance, I saw no point in double-spacing the text in the LyX window,
6058 even though it is double-spaced in the paper manuscript.
6059 Also, I chose not to make separate layouts for the preprint and preprint2
6061 Since I assume you will spend most of your time in the plain manuscript
6062 mode anyway, I decided not to chew up more disk space with this.
6066 \begin_layout Subsection
6070 \begin_layout Standard
6071 Your mileage may vary.
6072 I've now had papers published by both ApJ and AJ that have had 98% of the
6073 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6075 I have had no trouble with the submission process, and I'm sure the journals
6076 were never aware that there might be a difference.
6077 So, go forth and publish!
6080 \begin_layout Section
6084 \begin_layout Standard
6087 Panayotis Papasotiriou
6090 \begin_layout Subsection
6094 \begin_layout Standard
6095 The ijmpc package is a set of macros that facilitates electronic manuscript
6098 International Journal of Modern Physics C
6101 Similarly, the ijmpd package is for creating manuscripts to be submitted
6104 International Journal of Modern Physics D
6107 Both journals are published by World Scientific.
6108 The corresponding document classes are named
6117 These files, together with instructions for the authors, can be downloaded
6119 \begin_inset Flex URL
6122 \begin_layout Plain Layout
6124 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
6130 \begin_inset Flex URL
6133 \begin_layout Plain Layout
6135 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
6141 Both packages are modified versions of the standard
6142 \begin_inset Quotes eld
6146 \begin_inset Quotes erd
6149 package, and they are almost (but not exactly) identical.
6150 Most of their features are supported by LyX.
6151 I have used LyX successfully to write articles submitted to both journals
6152 without any problem.
6155 \begin_layout Subsection
6159 \begin_layout Standard
6160 As usual, the easiest way to write a paper is to start with a template.
6166 ile\SpecialChar \menuseparator
6185 This will give an (almost) empty document that includes the most common
6186 fields found in a manuscript.
6187 Simply overwrite the existing text (including the brackets,
6192 You should keep in mind the following remarks.
6195 \begin_layout Enumerate
6196 LyX won't let you change the font size and the page style of the document,
6197 because such modifications are not allowed by both packages.
6200 \begin_layout Enumerate
6201 The language of the document should not be changed.
6202 Before previewing your paper, be sure that the babel package is not used.
6203 To do this, click on
6208 ools\SpecialChar \menuseparator
6226 checkbox in the language settings, and click on
6237 , if you wish to make this change permanent).
6240 \begin_layout Enumerate
6242 \begin_inset Quotes eld
6246 \begin_inset Quotes erd
6249 style must be used to define keywords.
6252 \begin_layout Enumerate
6253 The ijmpc package provides a style named
6254 \begin_inset Quotes eld
6257 Classification Codes
6258 \begin_inset Quotes erd
6261 , which can be used to define classification codes, such as PACS numbers.
6262 Note that this facility is not supported by the ijmpd package.
6265 \begin_layout Enumerate
6266 Several new environments are available:
6267 \begin_inset Quotes eld
6271 \begin_inset Quotes erd
6275 \begin_inset Quotes eld
6279 \begin_inset Quotes erd
6283 \begin_inset Quotes eld
6287 \begin_inset Quotes erd
6291 \begin_inset Quotes eld
6295 \begin_inset Quotes erd
6299 \begin_inset Quotes eld
6303 \begin_inset Quotes erd
6307 \begin_inset Quotes eld
6311 \begin_inset Quotes erd
6315 \begin_inset Quotes eld
6319 \begin_inset Quotes erd
6323 \begin_inset Quotes eld
6327 \begin_inset Quotes erd
6331 \begin_inset Quotes eld
6335 \begin_inset Quotes erd
6339 \begin_inset Quotes eld
6343 \begin_inset Quotes erd
6347 \begin_inset Quotes eld
6351 \begin_inset Quotes erd
6355 \begin_inset Quotes eld
6359 \begin_inset Quotes erd
6363 \begin_inset Quotes eld
6367 \begin_inset Quotes erd
6371 \begin_inset Quotes eld
6375 \begin_inset Quotes erd
6379 Their use is more or less obvious.
6380 LyX supports all these environments; it will use the proper label, text
6381 style, and numbering scheme for each of them.
6384 \begin_layout Enumerate
6385 Both packages use basic citations; the natbib package should not be used.
6386 In LyX, citation references are shown as usual; in the output, citations
6387 are shown as superscripts.
6388 If you want to use a citation as normal text, you should use the
6393 \begin_inset space \thinspace{}
6397 \begin_inset Quotes eld
6401 \begin_inset space ~
6411 \begin_inset Quotes erd
6417 \begin_layout Enumerate
6419 \begin_inset Quotes eld
6423 \begin_inset Quotes erd
6426 section in both packages.
6427 To put acknowledgments, just use the
6428 \begin_inset Quotes eld
6432 \begin_inset Quotes erd
6438 \begin_layout Enumerate
6439 Appendices may be added to the paper,
6443 the Acknowledgments and
6448 LyX provides a special environment, called
6449 \begin_inset Quotes eld
6453 \begin_inset Quotes erd
6456 which marks the beginning of the appendices.
6457 This environment should be left blank; it just sends a LaTeX command, but
6458 nothing is really printed.
6460 \begin_inset Quotes eld
6464 \begin_inset Quotes erd
6467 is printed with blue letters, as a signal that all sections after that
6468 point are appendices.
6469 To write an appendix, use the
6470 \begin_inset Quotes eld
6474 \begin_inset Quotes erd
6478 LyX will number each appendix with capital letters, as required by both
6481 \begin_inset Quotes eld
6485 \begin_inset Quotes erd
6492 be present before the first appendix; if not, all appendices will be numbered
6493 as normal sections in the output.
6496 \begin_layout Enumerate
6497 The ijmpc and the ijmpd packages use the
6501 command to implement table captions.
6502 As a result, a table created by LyX is printed correctly, but its caption
6504 However, you can use some ERT to overpass this problem, so that captions
6505 are printed as expected.
6506 To do so, create a float table as usual, remove the caption, and replace
6517 (sic); you must also the ERT
6521 immediately after the tabular material.
6522 Study the example table included in the template files to see how this
6523 trick is implemented.
6524 Alternatively, If you need table captions, you should implement the whole
6529 file, then include this file to the LyX document (
6534 nsert\SpecialChar \menuseparator
6539 \SpecialChar \menuseparator
6545 \begin_inset space ~
6551 Details on how to create a table float can be found in the files
6559 , included in the corresponding packages.
6562 \begin_layout Subsection
6563 Preparing a paper for submission
6566 \begin_layout Standard
6567 Before you submit your paper you must export the LyX document as a LaTeX
6573 ile\SpecialChar \menuseparator
6578 xport\SpecialChar \menuseparator
6593 \begin_layout Plain Layout
6594 Actually you have the choice between LaTeX (plain) and pdflatex.
6595 If you intend to use pdflatex to prepare the paper, you should use the
6596 pdflatex option so that included graphics are converted to PDF format,
6597 ready for use by pdflatex.
6602 , then make the following changes to the resulting
6609 \begin_layout Enumerate
6610 Remove the comment lines before the
6619 \begin_layout Enumerate
6620 Remove everything between (and including) the
6632 commands, except for any commands you specifically put into the LaTeX preamble.
6635 \begin_layout Standard
6640 file should be saved and processed through LaTeX as many times as necessary.
6641 You may also want to check the resulting
6648 \begin_layout Subsection
6652 \begin_layout Standard
6653 The use of ERT is reduced to two commands, which must be placed at the top
6655 If you started writing your paper by using the
6663 template, the ERT needed is already in its place; you usually don't need
6665 You may only modify the first ERT to specify the information printed to
6666 the top of odd and even pages (authors' names and short paper's title,
6668 This ERT must have the form
6672 markboth{Authors' Names}{Short Paper's Title}
6677 \begin_layout Section
6681 \begin_layout Standard
6687 \begin_layout Subsection
6691 \begin_layout Standard
6692 The iopart package provides a document class to create electronic manuscript
6693 submission to the journals published by the Institute of Physics.
6694 Instructions for the authors how to create a paper using the iopart class
6695 can be downloaded together with the iopart package from the site
6696 \begin_inset Flex URL
6699 \begin_layout Plain Layout
6701 ftp://ftp.iop.org/pub/journals/latex2e
6709 \begin_layout Subsection
6713 \begin_layout Standard
6714 The easiest way to write a paper is to start with the file
6718 that is available in LyX's examples files folder.
6719 Open this file, save it under a new name, and start writing.
6720 The example file explains how to use the special text environments.
6721 Here are the most important advices:
6724 \begin_layout Itemize
6725 To be able to compile your document to a PDF, PS, or DVI, assure that the
6728 Use AMS math package
6730 in the document settings under
6737 \begin_layout Itemize
6740 The title environment defines the kind of your paper.
6741 So use one of the following environments for the title:
6745 \begin_layout Itemize
6754 \begin_layout Itemize
6763 \begin_layout Itemize
6769 for a Topical review
6772 \begin_layout Itemize
6781 \begin_layout Itemize
6790 \begin_layout Itemize
6796 for a Paper (same as Title)
6799 \begin_layout Itemize
6805 for a Preliminary communication
6808 \begin_layout Itemize
6814 for a Rapid communication
6817 \begin_layout Itemize
6823 for a Letter to the editor
6827 \begin_layout Itemize
6830 All title environments except of
6834 can have an optional short title.
6837 \begin_layout Itemize
6838 There is a general title environment
6842 which is not directly supported by the LyX.
6843 This can be used as ERT when your document doesn't fit into one of the
6847 \begin_layout Standard
6848 For more informations like hints for special table and formula formatting,
6849 look at the IOP author guidelines.
6852 \begin_layout Section
6856 \begin_layout Standard
6859 Panayotis Papasotiriou
6862 \begin_layout Subsection
6866 \begin_layout Standard
6867 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6868 that facilitates electronic manuscript submission to the journals they
6870 Most known of them (at least in my domain of interest) are
6872 Astrophysics and Space Science
6878 , but there are many others (see a complete list at
6879 \begin_inset Flex URL
6882 \begin_layout Plain Layout
6884 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6890 The Kluwer package may be downloaded from the site
6891 \begin_inset Flex URL
6894 \begin_layout Plain Layout
6896 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6902 A complete user guide is contained in that package (but it can also be
6903 downloaded separately).
6906 \begin_layout Standard
6907 LyX supports many features of the package but not everything.
6908 However, the ERT needed is reduced to some
6909 \begin_inset Quotes eld
6913 \begin_inset Quotes erd
6916 commands of the package (see
6917 \begin_inset space ~
6921 \begin_inset CommandInset ref
6923 reference "subsec:kluwer_peculiarities"
6928 I have recently used LyX to write an article submitted to the
6930 Astrophysics and Space Science
6932 without any problem.
6935 \begin_layout Subsection
6939 \begin_layout Standard
6940 The easiest way to write a paper is to start with the Kluwer template file.
6943 File\SpecialChar \menuseparator
6958 This will give an (almost) empty document that includes the most common
6959 fields found in a manuscript and a short description of their use.
6960 As in most templates, simply overwrite the existing text (including the
6965 ) with the correct information.
6968 \begin_layout Subsection
6969 Preparing a paper for submission
6972 \begin_layout Standard
6973 As in the AASTeX package, before you submit your paper to a journal you
6975 \begin_inset Quotes eld
6979 \begin_inset Quotes erd
6985 \begin_layout Enumerate
6986 Export your paper as a LaTeX file.
6987 To do this, click on
6992 ile\SpecialChar \menuseparator
6997 xport\SpecialChar \menuseparator
7008 \begin_layout Enumerate
7013 file with a text editor and make the following changes
7017 \begin_layout Enumerate
7018 remove the comment lines before the
7027 \begin_layout Enumerate
7028 remove everything between (and including) the
7040 commands, except for any commands you specifically put into the LaTeX preamble.
7043 \begin_layout Standard
7052 \begin_layout Enumerate
7057 file through LaTeX as many times as necessary (usually up to three).
7060 \begin_layout Enumerate
7066 \begin_inset space \thinspace{}
7073 , and check if everything is OK (it should, if you didn't make any mistake).
7076 \begin_layout Subsection
7077 \begin_inset Quotes eld
7081 \begin_inset Quotes erd
7084 of the Kluwer package
7085 \begin_inset CommandInset label
7087 name "subsec:kluwer_peculiarities"
7094 \begin_layout Standard
7095 The Kluwer package has the following
7096 \begin_inset Quotes eld
7100 \begin_inset Quotes erd
7106 \begin_layout Enumerate
7107 It is possible to write multiple articles in the same LaTeX file
7111 \begin_layout Plain Layout
7112 I can't imagine any good reason to do this.
7118 Each article must be included in the environment
7119 \begin_inset Quotes eld
7123 \begin_inset Quotes erd
7127 Unfortunately, this environment cannot be omitted, even if you write just
7129 Therefore, each article starts with the command
7135 and, obviously, ends with the command
7142 Although this can be implemented in LyX, I didn't included it, since it
7143 looks ugly and can confuse the novice user.
7144 Therefore, you need to enter them directly and mark them as LaTeX code
7146 \begin_inset Quotes eld
7150 \begin_inset Quotes erd
7156 \begin_layout Enumerate
7157 Information given at the beginning of the article (i.e., title, subtitle,
7158 author, institution, running title, running author, abstract and keywords)
7159 must be included in an environment called
7160 \begin_inset Quotes eld
7164 \begin_inset Quotes erd
7168 This is not implemented in LyX, so you must enter title, subtitle etc.
7169 \begin_inset space ~
7172 between two ERT lines (
7187 \begin_layout Enumerate
7188 According to the user manual, the label of each bibliography item must be
7212 \begin_layout Standard
7217 template takes care of all these
7218 \begin_inset Quotes eld
7222 \begin_inset Quotes erd
7226 If you start a new paper using this template you don't need to do anything
7231 \begin_layout Enumerate
7232 don't delete the ERT included in the template, and
7235 \begin_layout Enumerate
7236 copy the example bibliography item included in the template and modify it
7237 as necessary to enter new bibliography items.
7240 \begin_layout Section
7244 \begin_layout Standard
7250 \begin_layout Subsection
7254 \begin_layout Standard
7255 The LyX document classes
7257 article (koma-script)
7261 report (koma-script)
7279 correspond to the LaTeX document classes
7296 \begin_inset space ~
7299 of the Koma-Script family.
7300 They are replacements for the standard document classes
7316 , resp., and fit better to European typography conventions in a number of
7320 \begin_layout Itemize
7321 Standard character size is 11pt in
7323 article (koma-script)
7327 report (koma-script)
7335 letter (koma-script)
7340 \begin_layout Itemize
7341 Headings, labels of the description environment, and a number of elements
7344 letter (koma-script)
7346 document class are set in a bold sans serif font.
7350 \begin_layout Plain Layout
7351 There is a big difference between the bold sans serif old cm fonts and new
7352 ec fonts, especially in the appearance of headings.
7353 In comparison, the ec bold sans serif fonts look a bit thin.
7354 Here the LaTeX package
7362 helps to produce the
7363 \begin_inset Quotes eld
7367 \begin_inset Quotes erd
7370 appearance when using the ec fonts.
7375 The numbering of chapter headings is made in the same way as the numbering
7376 of section headings, that is without the extra line
7377 \begin_inset Quotes eld
7380 Chapter\SpecialChar \ldots{}
7382 \begin_inset Quotes erd
7386 In addition, the appearance of the headings can be modified by using a
7387 number of options (in LyX to be entered in the field
7394 \begin_inset space ~
7404 ayout\SpecialChar \menuseparator
7412 A detailed German description of these options can be found in the Koma-Script
7420 \begin_layout Itemize
7421 The main means in the Koma-Script document classes to design the type area
7430 (in LyX to be entered in the extra class options field in the dialog
7435 ocument\SpecialChar \menuseparator
7443 They make a clearer modification of page margins possible as do the options
7449 ocument\SpecialChar \menuseparator
7457 A detailed German description of these and other type area options can
7458 be found in the Koma-Script documentation
7465 \begin_layout Itemize
7466 The LaTeX document classes of the Koma-Script family define a number of
7467 additional commands.
7468 Those part of it which makes sense in LyX is implemented in corresponding
7472 \begin_layout Standard
7473 A detailed German description of the LaTeX document classes of the Koma-Script
7474 family can be found in the Koma-Script documentation
7482 \begin_layout Plain Layout
7483 There is an English translation
7487 , but it is not a complete one.
7492 The following sections describe only those aspects, which are relevant
7496 \begin_layout Subsection
7497 article (koma-script), report (koma-script), and book (koma-script)
7500 \begin_layout Standard
7501 The document classes
7503 article (koma-script)
7507 report (koma-script)
7517 are implemented in the layout files
7530 They contain all the paragraph types of the corresponding standard document
7543 , resp., partly modified, with the exception of the LyX specific
7547 -type, which is replaced by the new
7551 -type having the same functionality.
7556 -Type there is a number of new paragraph types added.
7563 letter (koma-script)
7568 \begin_layout Itemize
7577 : are equivalents to
7585 , resp., additionally inserting an entry in the table of contents.
7594 are not contained in
7596 article (koma-script)
7601 \begin_layout Itemize
7618 , resp., additionally clearing running heads.
7625 article (koma-script)
7631 \begin_layout Plain Layout
7644 report (koma-script)
7646 , but since this is identical to
7650 , is has not been implemented in LyX.
7658 \begin_layout Itemize
7663 : generates a heading directly above the following paragraph in the standard
7664 character size without affecting the structure of the document.
7667 \begin_layout Itemize
7676 are special captions which respect the different space settings needed
7677 for captions placed above or below an element (if you follow strict typographic
7678 rules, you might want to place table captions always above the table).
7679 You can also use the class option
7696 You need at least Koma-Script version 2.8q to use this.
7699 \begin_layout Itemize
7704 : can be used to set a bonmot, e.
7705 \begin_inset space \thinspace{}
7709 \begin_inset space ~
7712 at the beginning of a chapter.
7713 If you use the optional argument (
7718 nsert\SpecialChar \menuseparator
7720 \begin_inset space ~
7725 ), you can insert the dictum's author there.
7726 Dictum and author are separated by a line.
7727 You need at least Koma-Script version 2.8q to use this.
7734 article (koma-script)
7739 \begin_layout Standard
7740 The following types, together with the standard types
7752 , form the title area of the document.
7753 They must be entered ahead of the first
7754 \begin_inset Quotes eld
7758 \begin_inset Quotes erd
7765 \begin_layout Plain Layout
7766 The corresponding LaTeX commands must appear before the
7777 When such a type is used more than once, the latter usage overwrites the
7778 former one, that means, for every type only the latest usage is valid.
7779 The order of the different types however has, like
7791 , no effect on the appearance of the produced document.
7794 \begin_layout Itemize
7799 : produces a centered paragraph above the ordinary title (
7811 ) for the subject of the document.
7814 \begin_layout Itemize
7819 : produces a centered paragraph below the ordinary title (
7831 ) for the publishers' name.
7834 \begin_layout Itemize
7841 report (koma-script)
7847 produces a centered paragraph on its own page behind the title page, or
7850 article (koma-script)
7852 produces a centered paragraph below the ordinary title (
7871 \begin_layout Itemize
7876 : produces a left aligned paragraph above the ordinary title (
7892 ) for a document`s head.
7895 \begin_layout Itemize
7900 : produces in a double-sided print in
7902 report (koma-script)
7908 a left-aligned paragraph at the top of the title page`s back or has no
7909 effect in a single-sided print or in
7911 article (koma-script)
7916 \begin_layout Itemize
7921 : produces in a double-sided print in
7923 report (koma-script)
7929 a left-aligned paragraph at the bottom of the title page`s back or has
7930 no effect in a single-sided print or in
7932 article (koma-script)
7937 \begin_layout Itemize
7942 : produces a special
7943 \begin_inset Quotes eld
7947 \begin_inset Quotes erd
7950 page ahead of the actual document containing a paragraph without special
7954 \begin_layout Standard
7955 The layout files for the document classes
7957 article (koma-script)
7961 report (koma-script)
7972 This is thought of as a place to define your own types.
7977 in your personal layout directory and edit the file!
7980 \begin_layout Subsection
7981 letter (koma-script)
7984 \begin_layout Standard
7988 \begin_layout Plain Layout
8000 \begin_layout Standard
8004 letter (koma-script)
8006 is implemented in the layout file
8011 It contains all the paragraph types of the corresponding standard document
8016 , partly modified, with the exception of the LyX specific types
8028 type, which is replaced by the new
8033 In addition, it contains, in contrast to the standard document class, the
8051 Furthermore, there are a number of new letter specific types.
8054 \begin_layout Standard
8058 \begin_layout Plain Layout
8070 \begin_layout Standard
8071 The appearance of the letter produced by this document class can be controlled
8072 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8076 \begin_layout Plain Layout
8077 For example, the standard appearance of the letter`s heading, consisting
8078 of name and address, is quite self-willed.
8080 \begin_inset Quotes eld
8084 \begin_inset Quotes erd
8087 heading is produced by the following LaTeX commands in the preamble:
8090 \begin_layout LyX-Code
8100 \begin_layout LyX-Code
8116 \begin_layout LyX-Code
8126 \begin_layout LyX-Code
8146 A detailed German description of such LaTeX commands can be found in the
8147 Koma-Script documentation
8152 With it, the letter's author can produce his personal letter layout.
8155 \begin_layout Standard
8164 define the beginning of the letter and must be used in every letter.
8165 To emphasize them in the LyX document class, they are marked with the letter
8175 \begin_inset space ~
8179 It is possible to write any number of letters in one file.
8184 type produces a new letter using the same addressee and a
8188 type produces a new addressee.
8205 are ordinary paragraph types and can also be used several times in one
8206 and the same letter.
8209 \begin_layout Itemize
8214 : produces a paragraph for the addressee and implicitly defines the beginning
8218 \begin_layout Itemize
8223 : produces a paragraph for the form of address and implicitly produces a
8227 \begin_layout Itemize
8232 : produces a paragraph for a close.
8235 \begin_layout Itemize
8240 : produces a paragraph for a postscript.
8243 \begin_layout Itemize
8248 : produces a paragraph for a distribution list.
8251 \begin_layout Itemize
8256 : produces a paragraph for enclosures.
8259 \begin_layout Standard
8300 are input types provided with a label to enter information, which will
8301 be processed by the document class.
8305 \begin_layout Plain Layout
8306 It could be seen as a matter of inconsequence, that the types
8314 described above are not such input types as well.
8315 Because of the special meaning of those types, however, I have implemented
8316 them as ordinary paragraph types with a one letter mark in the left margin.
8317 Moreover, it would affect my feeling of symmetry, if the
8325 type had such a serious different appearance.
8330 The types must be used ahead of the corresponding
8337 \begin_layout Standard
8338 An implementation of these types in a WYSIWYG fashion does not seem to make
8339 sense, because the real appearance of the produced letter does not only
8340 depend on the usage of the particular type, but also on other factors.
8341 For example, a signature entered in the
8345 type will in the standard behavior appear in the produced letter only,
8346 when in the same letter also a
8351 The entered value of the
8355 type will in the standard behavior not appear in the produced letter at
8357 The possibility to design the letter`s heading freely is already indicated
8358 in a footnote above.
8361 \begin_layout Standard
8362 The input types can also be used as empty paragraphs.
8364 \begin_inset space \thinspace{}
8368 \begin_inset space ~
8380 type is not used at all, in the standard behavior the value of the
8384 type is used as signature, whereas if an empty
8388 type is used, no signature value is defined.
8391 \begin_layout Standard
8392 By using the input types it is possible to write a letter template, containing
8393 filled input types with your personal dates (name, address, etc.) and empty
8394 input types for other dates you want to enter.
8397 \begin_layout Itemize
8402 : sender's name, in the standard behavior appears as a centered paragraph
8403 in small caps in the letter`s heading.
8406 \begin_layout Itemize
8411 : sender's signature, in the standard behavior appears below the
8420 type is used, the value of the
8424 type appears instead.
8427 \begin_layout Itemize
8432 : sender's address, in the standard behavior appears in a centered paragraph
8433 in the letter`s heading below the sender's name.
8436 \begin_layout Itemize
8441 : sender's telephone number, in the standard behavior only sets the LaTeX
8451 \begin_layout Itemize
8456 : place of the letter`s making.
8459 \begin_layout Itemize
8464 : date of the letter`s making.
8473 , in the standard behavior, produce the place and the date in a right-aligned
8474 line below the addressee's field.
8479 type is used, neither place nor date appear, independent of the value of
8489 type is used, the date of the letter `s production is used.
8492 \begin_layout Itemize
8497 : sender`s back address, in the standard behavior appears above the addressee's
8498 field in a small sans serif font.
8501 \begin_layout Itemize
8506 : special mail information, in the standard behavior appears underlined
8507 above the addressee's field below the back address.
8510 \begin_layout Itemize
8515 : additional information, in the standard behavior appears on right side
8516 below the addressee`s field.
8519 \begin_layout Itemize
8524 : the letter's title, in the standard behavior appears in a big, bold, sans
8525 serif font above the subject.
8528 \begin_layout Itemize
8533 : the letter's subject, in the standard behavior appears in a bold font
8541 \begin_layout Standard
8562 produce a business letter like line above the
8566 line containing the fields
8567 \begin_inset Quotes eld
8571 \begin_inset Quotes erd
8575 \begin_inset Quotes eld
8579 \begin_inset Quotes erd
8583 \begin_inset Quotes eld
8587 \begin_inset Quotes erd
8591 \begin_inset Quotes eld
8595 \begin_inset Quotes erd
8599 \begin_inset Quotes eld
8603 \begin_inset Quotes erd
8607 \begin_inset Quotes eld
8611 \begin_inset Quotes erd
8615 For the date field, the value of the
8621 \begin_inset Quotes eld
8624 business letter types
8625 \begin_inset Quotes erd
8628 is used, the value of the
8632 type however does not appear, but only the LaTeX variable
8639 The ordinary output of place and date in a right-aligned line below the
8640 addressee`s field is suppressed.
8641 The types are implemented as input types provided with a label and must
8642 be used ahead of the corresponding
8649 \begin_layout Itemize
8657 \begin_layout Itemize
8665 \begin_layout Itemize
8673 \begin_layout Itemize
8681 \begin_layout Itemize
8689 \begin_layout Subsection
8690 The new letter class: letter (koma-script v.2)
8693 \begin_layout Standard
8696 Jürgen Spitzmüller
8699 \begin_layout Standard
8700 \begin_inset VSpace medskip
8706 \begin_layout Standard
8708 Koma-Script version 2.8 has introduced a new letter class
8712 which supersedes the now unsupported
8717 It has --- on the LaTeX side --- a completely new interface and is not
8718 compatible with the old class.
8719 Therefore, LyX supports both, though it is recommended to use the new class.
8722 \begin_layout Standard
8723 This class covers the same functionality as
8725 letter (koma-script),
8732 (receiver's address, same as
8749 will start a new letter (i.
8750 \begin_inset space \thinspace{}
8754 \begin_inset space ~
8757 you can write several letters per document).
8758 New elements are sender's
8774 and the possibility to use a
8783 nsert\SpecialChar \menuseparator
8793 \begin_layout Standard
8794 The biggest improvement is, though, that the letter's layout is configurable
8795 at almost any needs.
8796 This can be done via the preamble or with a special style file (Letter
8797 Class Option, extension
8801 ), that will be read in as a class option.
8805 \begin_layout Plain Layout
8806 The KOMA package comes with some default
8811 There is, for instance, a
8815 file that follows german typesetting rules, or a
8819 that provides the default layout of the old
8824 The latter can be loaded with the class option
8833 ayout\SpecialChar \menuseparator
8838 ocument\SpecialChar \menuseparator
8850 template that is included in LyX for examples.
8851 A detailed description is to be found in the Koma-Script documentation
8859 \begin_layout Subsection
8863 \begin_layout Standard
8864 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8868 \begin_layout Itemize
8869 The chapter number of a
8873 type appears on a line of its own above the chapter heading instead of
8874 appearing in the same line ahead of it.
8875 The cause for that is the LyX internal behavior for the labeltype
8882 \begin_layout Itemize
8883 The headings of the types
8892 \begin_inset Quotes eld
8896 \begin_inset Quotes erd
8899 LaTeX table of contents, but not in the LyX table of contents (
8904 ocument\SpecialChar \menuseparator
8910 \begin_inset space ~
8914 \begin_inset space ~
8922 \begin_layout Itemize
8927 document class appear in a skip separation mode, not indented.
8928 This is the standard behavior, no special LaTeX commands are needed for
8935 ocument\SpecialChar \menuseparator
8942 dialog the corresponding radio button indicates
8958 value always has the effect that extra LaTeX commands are inserted in the
8959 document to produce the gap, which is not what is wanted in this case.
8962 \begin_layout Section
8970 \begin_layout Standard
8976 \begin_layout Subsection
8980 \begin_layout Standard
8981 These are the layout files for some of the journal formats used by Springer
8982 Verlag and listed on
8983 \begin_inset Flex URL
8986 \begin_layout Plain Layout
8988 http://www.springer.de/author/tex/help-journals.html
8993 , where you should also go to fetch the class files (yes, these are LaTeX2e
8995 It is a modular system: the things common to all journals are implemented
9000 , which journal-specific layout files (such as, e.
9001 \begin_inset space \thinspace{}
9008 for Journal of Geodesy) can include.
9011 \begin_layout Standard
9012 This means that implementing support for any other Springer journal on this
9013 list is as simple as writing your own
9021 file following the outline given in
9029 \begin_layout Standard
9030 It is reasonably well tested only for the Journal of Geodesy.
9039 come with the standard LyX distribution.
9040 Install the relevant class file (downloaded from Springer) in a proper
9041 directory, reconfigure LaTeX (in the teTeX case by running
9045 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9046 LyX and it should work.
9049 \begin_layout Subsection
9053 \begin_layout Standard
9054 A large number of theorem-like styles ---
9060 \SpecialChar \ldots{}
9066 \begin_layout Standard
9069 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9070 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9073 See the Springer class file documentation for details.
9076 \begin_layout Subsection
9080 \begin_layout Itemize
9092 \begin_layout Itemize
9095 Probability Theory and Related Fields
9101 --- Jean-Marc Lasgouttes
9104 \begin_layout Standard
9105 Add your own, it isn't so hard!
9108 \begin_layout Subsection
9112 \begin_layout Standard
9113 These files are partly based on the older
9117 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9123 layout, are now defunct.
9124 Jean-Marc Lasgouttes helped out big in making me find my way around the
9125 LyX layout file mechanism.
9128 \begin_layout Subsection
9132 \begin_layout Standard
9134 But probably less than in the old hacked-LaTeX
9141 \begin_layout Standard
9143 \begin_inset space \thinspace{}
9146 g.: does not display the number for theorem-like layouts, just #.
9149 \begin_layout Section
9157 \begin_layout Standard
9163 \begin_layout Subsection
9167 \begin_layout Standard
9168 These are the layout files for some of the journals of the American Geophysical
9170 It is assumed that you have both the AGU's own class files and AGUplus
9171 installed (everything to be found at
9172 \begin_inset Flex URL
9175 \begin_layout Plain Layout
9177 ftp://ftp.agu.org/journals/latex/journals
9185 \begin_layout Subsection
9189 \begin_layout Standard
9199 They are still called this in the LyX GUI, though their LaTeX equivalents
9200 in the AGU classes are
9211 \begin_layout Standard
9212 Newly defined styles are
9249 These are mostly manuscript attributes and defined in the AGU class documentati
9253 \begin_layout Standard
9254 I suspect this is still badly incomplete.
9257 \begin_layout Subsection
9261 \begin_layout Standard
9278 \begin_layout Subsection
9282 \begin_layout Itemize
9285 Journal of Geophysical Research
9294 \begin_layout Standard
9295 Add your own, it isn't so hard! Look at the
9306 \begin_layout Subsection
9307 Bugs and things to remember
9310 \begin_layout Standard
9311 In order to use the new layouts, you must remember to do the following for
9315 \begin_layout Enumerate
9321 This can be done in the
9323 layout\SpecialChar \menuseparator
9328 document\SpecialChar \menuseparator
9332 (AGU articles are always in English, right? So
9339 \begin_layout Enumerate
9349 (Yes, this is a bug.)
9352 \begin_layout Enumerate
9353 Make sure you use the
9357 bibliography style, by entering
9361 into the second field of the BibTeX inset.
9362 None of the standard styles will do.
9365 \begin_layout Section
9373 \begin_layout Standard
9379 \begin_layout Subsection
9383 \begin_layout Standard
9384 This is the layout file for the European Geophysical Society journals.
9389 can be downloaded from the web site of the EGS under
9390 \begin_inset Flex URL
9393 \begin_layout Plain Layout
9403 \begin_layout Subsection
9407 \begin_layout Standard
9410 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9418 The current layout file is unfortunately very unmodular and would benefit
9419 from using the various
9426 \begin_layout Section
9432 \begin_inset CommandInset label
9441 \begin_layout Standard
9449 \begin_layout Subsection
9453 \begin_layout Standard
9454 This section describes how to use LyX to make slides for overhead projectors.
9455 There are two document classes that can do this: the default slides class
9461 This section documents the former.
9464 \begin_layout Standard
9465 I'm going to say this again, nice and clear, so that there's no misunderstanding
9469 \begin_layout Standard
9470 \begin_inset VSpace bigskip
9476 \begin_layout Standard
9480 This section documents the class
9481 \begin_inset Quotes eld
9489 \begin_inset Quotes erd
9497 \begin_layout Standard
9498 \begin_inset VSpace bigskip
9504 \begin_layout Standard
9505 If you're looking for the documentation for
9506 \begin_inset Quotes eld
9514 \begin_inset Quotes erd
9518 \begin_inset space ~
9522 \begin_inset CommandInset ref
9524 reference "sec:foiltex"
9534 \begin_inset Quotes eld
9542 \begin_inset Quotes erd
9545 ] is actually somewhat better than the default
9553 \begin_layout Plain Layout
9554 \SpecialChar \ldots{}
9555 or so I've been told repeatedly by its advocates.
9556 Having never used it, I have no idea if this claim is true or not.
9561 which this section documents.
9564 \begin_layout Standard
9565 This class is the LaTeX2e improvement of the old
9570 Every LaTeX2e distribution includes this class [which I'll just refer to
9572 \begin_inset Quotes eld
9580 \begin_inset Quotes erd
9583 from now on], so you're bound to have it.
9584 As I noted earlier, there are other classes, such as
9588 , which also produce slides for overhead projectors and do a better job
9590 However, there are some things which
9594 can do which the others can't, such as generate overlays.
9595 Read on to learn more!
9598 \begin_layout Subsection
9600 \begin_inset CommandInset label
9602 name "sec:slidesetup"
9609 \begin_layout Standard
9610 Obviously, to use this document class, you need to select
9611 \begin_inset Quotes eld
9619 \begin_inset Quotes erd
9622 from the class list in the
9627 ocument\SpecialChar \menuseparator
9635 There are some other special things you should know about this class:
9638 \begin_layout Itemize
9639 Don't bother changing the options
9644 They're not supported by the
9651 \begin_layout Itemize
9658 \begin_inset space ~
9663 behaves a bit differently for this class.
9664 The possible choices and what they do are as follows:
9668 \begin_layout Description
9673 The final output contains page numbers in the lower right corner.
9676 \begin_layout Description
9685 , but also prints out any time markers you've put in.
9686 This is the default.
9689 \begin_layout Description
9694 The final output contains no page numbers, time markers, or alignment markers.
9698 \begin_layout Itemize
9703 class has an extra option:
9709 \begin_inset Quotes eld
9717 \begin_inset Quotes erd
9720 in the extra class options.
9724 \begin_layout Standard
9725 Using this options allows you to add time markers to
9731 \begin_inset space ~
9735 \begin_inset CommandInset ref
9737 reference "sec:slideNote"
9745 \begin_layout Standard
9746 You can also use the template file
9747 \begin_inset Quotes eld
9755 \begin_inset Quotes erd
9758 to automatically set up a document to use the
9767 ile\SpecialChar \menuseparator
9769 \begin_inset space ~
9773 \begin_inset space ~
9782 to open your new document].
9783 The template file also contains some examples of the special paragraph
9784 environments used by this class.
9785 I'll describe those next.
9788 \begin_layout Subsection
9789 Paragraph Environments
9792 \begin_layout Subsubsection
9793 Supported Environments
9796 \begin_layout Standard
9797 The first thing you'll notice when you start up a new
9801 document is the font size and type: it's the equivalent of the size
9802 \begin_inset Quotes eld
9810 \begin_inset Quotes erd
9816 \begin_inset space ~
9822 This is also what's used in the output.
9824 \begin_inset Quotes eld
9828 \begin_inset Quotes erd
9831 to remind you that this is a slide.
9832 Your final slides will use a larger font; ergo, you'll have less space.
9833 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9836 \begin_layout Standard
9837 The next thing that becomes obvious is the changes to the paragraph environment
9838 pull-down box [at the far-left end of the toolbar].
9839 Most of the paragraph environments you're used to seeing are missing.
9840 There are also five new ones.
9845 class itself only supports certain paragraph environments:
9848 \begin_layout Itemize
9854 \begin_layout Itemize
9860 \begin_layout Itemize
9866 \begin_layout Itemize
9872 \begin_layout Itemize
9878 \begin_layout Itemize
9884 \begin_layout Itemize
9890 \begin_layout Itemize
9896 \begin_layout Itemize
9902 \begin_layout Itemize
9908 \begin_layout Itemize
9914 \begin_layout Standard
9915 All of the other standard environments, including the section-heading environmen
9916 ts, aren't used in the
9923 \begin_layout Standard
9924 On the other hand, you'll notice the following new environments:
9927 \begin_layout Itemize
9933 \begin_layout Itemize
9939 \begin_layout Itemize
9945 \begin_layout Itemize
9951 \begin_layout Itemize
9957 \begin_layout Standard
9958 These five are kind of quirky, due to a
9959 \begin_inset Quotes eld
9963 \begin_inset Quotes erd
9967 You see, LyX doesn't permit you to nest any other paragraph environment
9968 into an empty environment.
9969 Now, that's fine and dandy, but it means that you wouldn't be able to start
9970 a slide with anything except plain text.
9971 To deal with this, I've performed a little
9972 \begin_inset Quotes eld
9976 \begin_inset Quotes erd
9982 \begin_layout Subsubsection
9983 Quirks of the New Environments
9984 \begin_inset CommandInset label
9986 name "sec:slideQuirk"
9993 \begin_layout Standard
9994 All five of the new paragraph environments are somewhat quirky due to inherent
9995 limitiations in the current version of LyX.
9996 As I just mentioned, LyX forbids environments that begin with another environme
9998 To get around this, the
10002 environment isn't a paragraph environment as described in the
10010 \begin_layout Standard
10011 You should consider
10024 \begin_inset Quotes eld
10027 pseudo-environments.
10028 \begin_inset Quotes erd
10031 They look like a section heading or a
10032 \begin_inset Quotes eld
10040 \begin_inset Quotes erd
10043 but really begin a [and, if necessary, end the previous] paragraph environment.
10053 \begin_inset Quotes eld
10057 \begin_inset Quotes erd
10060 These two perform some action.
10063 \begin_layout Standard
10064 A common feature of all five environments,
10084 , is a rather long-ish label.
10085 The text following this label --- ordinarily the contents of the paragraph
10086 environment --- is utterly irrelevant for
10107 LyX completely ignores it.
10108 In fact, you can leave these five environments completely empty.
10112 \begin_layout Standard
10117 to put any text after the rather long-ish label, you might want to.
10118 This could be a short description of the contents of the
10123 In that case, enter in your descriptive comment and hit
10127 as you normally would.
10130 \begin_layout Standard
10131 If, on the other hand, you don't want to enter in any descriptive text,
10132 you'll hit another LyX quirk.
10133 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10134 environment until you put something in the old one.
10138 \begin_layout Itemize
10139 Start entering the text that will
10167 \begin_layout Itemize
10168 Now move to the beginning of that paragraph.
10172 \begin_layout Itemize
10181 \begin_layout Itemize
10182 Finally, change this new, empty paragraph to a
10206 \begin_layout Standard
10207 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10211 \begin_layout Subsection
10212 Making a Presentation with
10225 \begin_layout Subsubsection
10233 \begin_layout Standard
10234 If you're expecting this section to teach you how to actually make a presentatio
10235 n, you'll be sorely disappointed.
10236 Naturally, I'll describe all of the ways the
10240 class can assist you in preparing the materials for a presentation.
10241 Filling in the contents, however, is up to you.
10246 the LyX philosophy.]
10249 \begin_layout Standard
10254 environment [in the manner described in section
10255 \begin_inset space ~
10259 \begin_inset CommandInset ref
10261 reference "sec:slideQuirk"
10265 ] tells LyX to begin a new slide [duh].
10266 The label for this environment/
10267 \begin_inset Quotes erd
10271 \begin_inset Quotes erd
10275 \begin_inset Quotes eld
10279 \begin_inset Quotes erd
10282 in cool blue, followed by the label,
10283 \begin_inset Quotes eld
10287 \begin_inset Quotes erd
10291 Any text or paragraph environments that follow this one go on the new slide.
10295 \begin_layout Standard
10296 Slides are probably the only time you'll need to forcibly end pages in LyX
10297 (this can be specified in the
10302 In fact, you'll want to, once you finish entering the contents of one slide.
10303 If you've entered more text than can physically fit on a slide, the extra
10304 overflows onto a new slide.
10305 I don't recommend doing this, however, since the overflow slide won't have
10306 any page number on it.
10307 Furthermore, it may interfere with any
10311 you've made to accompany the oversized
10318 \begin_layout Standard
10327 environments work the same way as the
10332 They both create an
10333 \begin_inset Quotes eld
10337 \begin_inset Quotes erd
10340 followed by a label [
10341 \begin_inset Quotes eld
10345 \begin_inset Quotes erd
10349 \begin_inset Quotes eld
10353 \begin_inset Quotes erd
10357 The color is a stunning magenta instead of blue, and the
10358 \begin_inset Quotes eld
10362 \begin_inset Quotes erd
10365 will look different, in style and in length.
10366 The label fonts of all three also differ from one another.
10369 \begin_layout Standard
10374 , if the contents of a
10382 exceed the physical size of a slide or sheet of paper, the extra will overflow
10384 Again, you should avoid this.
10385 It defeats the whole purpose of
10396 \begin_layout Subsubsection
10406 \begin_layout Standard
10411 is a slide that sits atop another slide.
10412 Perhaps you wish to discuss a figure on the main
10416 before displaying the text associated with it.
10417 One way to accomplish this is tape a flap of dark paper over the part of
10422 you want to display later.
10423 This method fails, however, if you wish to overlap one graph with another,
10425 You would then have to fumble while speaking to align the two separate,
10430 s to align the two graphs.
10435 environment in both cases makes life much easier.
10438 \begin_layout Standard
10443 receives the page number of its
10444 \begin_inset Quotes eld
10448 \begin_inset Quotes erd
10456 \begin_inset Quotes eld
10464 \begin_inset Quotes erd
10471 \begin_layout Plain Layout
10472 Presumably, mutliple
10477 \begin_inset Quotes eld
10485 \begin_inset Quotes erd
10489 \begin_inset Quotes eld
10497 \begin_inset Quotes erd
10501 \begin_inset Quotes eld
10509 \begin_inset Quotes erd
10513 \begin_inset space ~
10516 appended to the page number of the parent
10526 Clearly, you want the contents of both the
10534 to each fit on a single physical slide! You should probably consider an
10540 \begin_inset Quotes eld
10544 \begin_inset Quotes erd
10556 class provides a visual cue for this: the label at the start of an
10560 is shorter than that at the start of a
10565 Lastly, when you generate printable output, you'll find alignment markers
10566 in all four corners of both the
10570 page and its parent
10575 These will assist you in lining up the two physical slides.
10578 \begin_layout Standard
10579 The major problem in overlaying two slides is aligning the contents of the
10580 two transparencies.
10581 How much space should you leave for that graph on the second slide? Worse
10582 still, what if you want a graph and a sentence on second slide, but there
10583 is text on the main transparency that goes in between them? You could try
10584 and insert vertical space of the right size.
10585 The better way is to use
10596 \begin_layout Standard
10597 As their names imply,
10605 are two command-like paragraph environments that make all subsequent text
10606 invisible and visible, respectively.
10608 \begin_inset space ~
10612 \begin_inset CommandInset ref
10614 reference "sec:slideQuirk"
10618 that you don't place anything
10622 these two environments, however.
10627 , it inserts a centered, sky-blue label into the page reading
10628 \begin_inset Quotes eld
10631 <Invisible Text Follows>
10632 \begin_inset Quotes erd
10636 For paragraphs following this label, the parts of the
10644 ; it doesn't matter which] where they would be contain instead blank space.
10648 \begin_layout Standard
10653 , the corresponding centered label is
10654 \begin_inset Quotes eld
10657 <Visible Text Follows>
10658 \begin_inset Quotes erd
10662 Paragraphs following this label behave normally.
10663 Note that the beginning of a new
10675 automatically shuts off an
10680 It's therefore not necessary to use
10691 \begin_layout Standard
10692 By now, it should be obvious how to create overlay transparencies using
10693 the proper combination of
10712 \begin_layout Enumerate
10717 , including everything that will appear on it, whether on the main slide
10725 \begin_layout Enumerate
10726 Before each figure or paragraph that will appear only on the
10735 If necessary, insert a
10739 environment after the
10746 \begin_layout Enumerate
10751 immediately following the
10758 \begin_layout Enumerate
10759 Copy the contents of this
10770 \begin_layout Enumerate
10775 , change all of the
10786 \begin_layout Standard
10788 You've just made an
10795 \begin_layout Standard
10796 There's one problem with the way I've designed the LyX
10800 class: you can't make text in the middle of a paragraph invisible, nor
10801 make text in the middle of an invisible paragraph visible again.
10802 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10806 \begin_layout Plain Layout
10807 The commands of interest are:
10810 \begin_layout Itemize
10815 invisible \SpecialChar \ldots{}
10819 \begin_layout Itemize
10824 visible \SpecialChar \ldots{}
10828 \begin_layout Plain Layout
10829 \SpecialChar \ldots{}
10830 and need to be marked as TeX.
10832 \begin_inset Quotes eld
10836 \begin_inset Quotes erd
10839 you wish to change goes in between the brackets [and after the
10852 If you don't know how to mark text as TeX, see the appropriate section
10865 \begin_layout Subsubsection
10875 \begin_inset CommandInset label
10877 name "sec:slideNote"
10884 \begin_layout Standard
10893 is associated with a
10894 \begin_inset Quotes eld
10898 \begin_inset Quotes erd
10910 class provides visual cues.
10915 is shorter than that of a
10919 [yet longer than that of an
10923 ] and, like the label of an
10927 is shockingly magenta.
10928 Additionally, the printed
10932 has the page number of its
10933 \begin_inset Quotes eld
10937 \begin_inset Quotes erd
10945 \begin_inset Quotes eld
10953 \begin_inset Quotes erd
10957 \begin_inset Quotes eld
10965 \begin_inset Quotes erd
10969 \begin_inset Quotes eld
10977 \begin_inset Quotes erd
10981 You can have multiple
10985 s associated with a single
10997 , you'll probably want to break up long
11001 s so that they fit on a single sheet of paper.
11004 \begin_layout Standard
11009 is obvious: it contains anything additional you might want to say about
11015 It could also be used as a sheet of reminders for a particular
11020 In the case of the latter, you might want to make use of time markers.
11026 \begin_inset Quotes eld
11030 \begin_inset Quotes erd
11033 support for time markers, a
11038 So, you'll have to resort to using the LaTeX codes.
11041 \begin_layout Standard
11042 To use time markers, you'll need to specify the extra class option
11043 \begin_inset Quotes eld
11051 \begin_inset Quotes erd
11055 \begin_inset space ~
11059 \begin_inset CommandInset ref
11061 reference "sec:slidesetup"
11066 This option turns on timing marks, which will appear in the lower-left-hand
11072 To set what appears in the time marker, you use the LaTeX commands
11073 \begin_inset Quotes eld
11083 \begin_inset Quotes erd
11087 \begin_inset Quotes eld
11097 \begin_inset Quotes erd
11101 The arguments of both commands are time measured in seconds.
11103 \begin_inset Quotes eld
11113 \begin_inset Quotes erd
11116 sets the time marker to a given time.
11118 \begin_inset Quotes eld
11128 \begin_inset Quotes erd
11131 increments the time marker by the specified amount.
11132 Using time markers and
11136 s in this fashion, you can remind yourself how much time to spend on a particula
11144 \begin_layout Standard
11145 There's one last feature to describe.
11146 Clearly, you'd like to print out all of your
11154 s on transparencies while printing all of your
11171 with which it is associated.
11172 What's a person to do?
11175 \begin_layout Standard
11176 Luckily, there are two LaTeX commands that allow you to select what to print
11178 Both must be placed into the preamble of your document.
11180 \begin_inset Quotes eld
11192 \begin_inset Quotes erd
11195 will cause the output to contain only the
11204 Correspondingly, the command
11205 \begin_inset Quotes eld
11217 \begin_inset Quotes erd
11220 prevents the output of anything but
11225 I'd advise placing both commands in the preamble and initially comment
11227 You can then preview your entire presentation as you write.
11228 When you're done writing, you can then uncomment one of the two to select
11229 what you want to print.
11230 I like to uncomment
11231 \begin_inset Quotes eld
11243 \begin_inset Quotes erd
11246 , print to a file with
11247 \begin_inset Quotes eld
11255 \begin_inset Quotes erd
11258 in its name, comment it back out, then uncomment
11259 \begin_inset Quotes eld
11271 \begin_inset Quotes erd
11275 \begin_inset Quotes eld
11283 \begin_inset Quotes erd
11287 I can then send either file to a printer, loading transparencies or plain
11288 paper as appropriate.
11291 \begin_layout Standard
11292 You can also provide other arguments to the
11293 \begin_inset Quotes eld
11303 \begin_inset Quotes erd
11307 \begin_inset Quotes eld
11317 \begin_inset Quotes erd
11321 See a good LaTeX book for details.
11324 \begin_layout Subsection
11329 Class Template File
11332 \begin_layout Standard
11333 I have also provided a template file,
11334 \begin_inset Quotes eld
11342 \begin_inset Quotes erd
11350 To use it, begin your new presentation with
11355 ile\SpecialChar \menuseparator
11357 \begin_inset space ~
11361 \begin_inset space ~
11371 Your new LyX presentation file will contain an example
11392 additionally contain an example of the use of
11401 Lastly, the preamble will contain:
11404 \begin_layout LyX-Code
11405 % Uncomment to print out only slides and overlays
11408 \begin_layout LyX-Code
11412 \begin_layout LyX-Code
11418 \begin_inset Newline newline
11424 \begin_layout LyX-Code
11425 % Uncomment to print out only notes
11428 \begin_layout LyX-Code
11432 \begin_layout LyX-Code
11440 \begin_layout Standard
11441 One final thing: I created this class to support the LaTeX2e
11442 \begin_inset Quotes eld
11450 \begin_inset Quotes erd
11453 class, one of the built-in LaTeX2e classes.
11454 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11455 built-in slide class.
11456 It's here if you want it or need it.
11457 There exist other LaTeX2e classes for creating presentations, such as the
11463 \begin_inset space ~
11467 \begin_inset CommandInset ref
11469 reference "sec:foiltex"
11474 \begin_inset Quotes eld
11482 \begin_inset Quotes erd
11485 package [present on some TeX distributions].
11486 The latter is not yet supported under LyX.
11490 \begin_layout Plain Layout
11491 Perhaps you can take on the task\SpecialChar \ldots{}
11497 I know nothing about these other classes.
11498 Try them out to see what sort of alternative they provide.
11501 \begin_layout Section
11510 \begin_inset CommandInset label
11519 \begin_layout Standard
11525 \begin_layout Subsection
11529 \begin_layout Standard
11530 This section describes how to use LyX to make slides for overhead projectors.
11531 There are two document classes that can do this: the default slides class
11537 This section documents the latter.
11540 \begin_layout Standard
11541 I'm going to say this again, nice and clear, so that there's no misunderstanding
11545 \begin_layout Standard
11546 \begin_inset VSpace bigskip
11552 \begin_layout Standard
11556 This section documents the class
11557 \begin_inset Quotes eld
11565 \begin_inset Quotes erd
11573 \begin_layout Standard
11574 \begin_inset VSpace bigskip
11580 \begin_layout Standard
11581 If you're looking for the documentation for
11582 \begin_inset Quotes eld
11590 \begin_inset Quotes erd
11593 , check out section
11594 \begin_inset space ~
11598 \begin_inset CommandInset ref
11600 reference "sec:slitex"
11605 If your machine doesn't have the
11610 \begin_inset Quotes eld
11618 \begin_inset Quotes erd
11621 ] installed, you'll probably have to use the default
11625 class, which isn't quite as good as
11630 \begin_layout Standard
11635 class is designed for use with version 2.1 of the
11639 LaTeX class file which is now an integral part of LaTeX2e.
11642 \begin_layout Subsection
11646 \begin_layout Standard
11647 Obviously, to use this document class, you need to select
11648 \begin_inset Quotes eld
11656 \begin_inset Quotes erd
11669 \begin_inset space ~
11675 There are some settings in the
11678 \begin_inset space ~
11683 dialog that you should know about that are specific to this class:
11686 \begin_layout Itemize
11687 Don't change the options
11698 \begin_inset space ~
11704 They're ignored by the
11711 \begin_layout Itemize
11712 The default font size is 20pt with the other options being 17pt, 25pt and
11716 \begin_layout Itemize
11717 The default font is
11725 but all math equations are still typeset in the usual roman font.
11728 \begin_layout Itemize
11733 TeX supports A4 and Letter paper sizes as well as a special size for working
11735 It doesn't support A5, B5, legal or executive paper sizes.
11738 \begin_layout Itemize
11739 Don't bother changing the
11743 settings because they are ignored anyway.
11744 All floats appear where they are defined in the text.
11747 \begin_layout Itemize
11755 setting behaves a bit differently for this class.
11760 TeX provides extensive footer and header capabilities including a user-defined
11763 \begin_inset space ~
11767 \begin_inset CommandInset ref
11769 reference "sec:foilfoot"
11774 The title page is treated differently to all other pages in the document
11783 has the logo centered at the bottom of the page (if one is defined).
11784 The possible page style choices and what they do are as follows:
11788 \begin_layout Labeling
11789 \labelwidthstring MMMMMMM
11796 The final output contains no page numbers, or other headers or footers
11797 (except footnotes of course).
11801 \begin_layout Labeling
11802 \labelwidthstring MMMMMMM
11809 The final output contains page numbers centered at the bottom of the page.
11810 No other headings or footers (other than footnotes).
11813 \begin_layout Labeling
11814 \labelwidthstring MMMMMMM
11819 Page numbers in lower right corner.
11820 Additional headers and footers are also shown.
11821 This is also the default.
11824 \begin_layout Labeling
11825 \labelwidthstring MMMMMMM
11830 Gives you access to the
11834 package although its use with
11838 TeX is discouraged by the writer of the
11842 TeX package because of some potential page layout clashes.
11846 \begin_layout Subsubsection
11850 \begin_layout Standard
11851 The following options may be used in the extra class options in the
11856 ocument\SpecialChar \menuseparator
11866 \begin_layout Labeling
11867 \labelwidthstring MMMMMMx
11872 This sets up the page layout for 7.33in by 11in paper, which is about the
11873 same aspect ratio as a 35mm slide, making it a bit easier to work with
11877 \begin_layout Labeling
11878 \labelwidthstring MMMMMMx
11883 Places a rule across the page below the header on every page except the
11887 \begin_layout Labeling
11888 \labelwidthstring MMMMMMx
11893 Places a rule across the page above the footer on every page except the
11897 \begin_layout Labeling
11898 \labelwidthstring MMMMMMx
11903 This is automatically set each time you create a new
11912 TeX to use the dvips driver to rotate those pages that are set as landscape
11916 \begin_layout Labeling
11917 \labelwidthstring MMMMMMx
11922 Simply changes the page dimensions to those of a landscape page but doesn't
11924 Thus if you use this option you need to use an external program to rotate
11925 each page or feed your paper through your printer as landscape.
11926 Note that this option effectively reverses the roles of the
11934 environments (don't worry these are described in the next section).
11937 \begin_layout Labeling
11938 \labelwidthstring MMMMMMx
11943 Equation numbers on the left.
11946 \begin_layout Labeling
11947 \labelwidthstring MMMMMMx
11952 Flush-left equations.
11955 \begin_layout Subsection
11956 Supported Environments
11959 \begin_layout Standard
11960 Most of the environments commonly supported in other classes are also supported
11966 There are several additional environments provided by
11970 TeX as well as a couple added by LyX.
11971 The following environments are shared with other classes:
11974 \begin_layout Standard
11978 \begin_layout Plain Layout
11982 begin{multicols}{2}
11990 \begin_layout Itemize
11996 \begin_layout Itemize
12002 \begin_layout Itemize
12008 \begin_layout Itemize
12014 \begin_layout Itemize
12020 \begin_layout Itemize
12026 \begin_layout Itemize
12032 \begin_layout Itemize
12038 \begin_layout Itemize
12044 \begin_layout Itemize
12050 \begin_layout Itemize
12056 \begin_layout Itemize
12062 \begin_layout Itemize
12068 \begin_layout Itemize
12074 \begin_layout Itemize
12080 \begin_layout Itemize
12086 \begin_layout Itemize
12092 \begin_layout Itemize
12098 \begin_layout Standard
12102 \begin_layout Plain Layout
12114 \begin_layout Standard
12115 That is, all the major environments apart from the sectioning environments.
12116 Since foils are essentially self-contained sections, with a title and body,
12121 TeX provides specific commands for starting new foils and these are:
12124 \begin_layout Itemize
12130 \begin_layout Itemize
12136 \begin_layout Standard
12137 LyX also provides slightly modified versions of these two environments called:
12140 \begin_layout Itemize
12146 \begin_layout Itemize
12149 ShortRotatefoilhead
12152 \begin_layout Standard
12153 and the differences will be explained in the next section.
12156 \begin_layout Standard
12157 Since foils are often used in presenting ideas or new theorems and such
12162 TeX also provides a comprehensive box of goodies for presenting them:
12165 \begin_layout Standard
12169 \begin_layout Plain Layout
12173 begin{multicols}{2}
12181 \begin_layout Itemize
12187 \begin_layout Itemize
12193 \begin_layout Itemize
12199 \begin_layout Itemize
12205 \begin_layout Itemize
12211 \begin_layout Itemize
12217 \begin_layout Itemize
12223 \begin_layout Itemize
12229 \begin_layout Itemize
12235 \begin_layout Itemize
12241 \begin_layout Itemize
12247 \begin_layout Standard
12251 \begin_layout Plain Layout
12263 \begin_layout Standard
12264 The starred versions are unnumbered while the unstarred versions are numbered.
12265 There are also two list environments added by LyX and these are:
12268 \begin_layout Itemize
12274 \begin_layout Itemize
12280 \begin_layout Standard
12285 TeX provides some powerful header and footer capabilities that are best
12286 set in the preamble although they may be set at any point in a document.
12287 If you want to change these settings in your document the best place to
12288 do so is at the very top of a foil,
12293 straight after the foilhead.
12296 \begin_layout Standard
12297 For this purpose, the following command styles are provided [
12304 \begin_layout Standard
12308 \begin_layout Plain Layout
12312 begin{multicols}{2}
12320 \begin_layout Itemize
12324 \begin_inset space ~
12330 \begin_layout Itemize
12336 \begin_layout Itemize
12340 \begin_inset space ~
12346 \begin_layout Itemize
12350 \begin_inset space ~
12356 \begin_layout Itemize
12360 \begin_inset space ~
12367 \begin_layout Standard
12368 \begin_inset space ~
12375 \begin_layout Standard
12379 \begin_layout Plain Layout
12391 \begin_layout Standard
12392 There are also a few commands provided by
12396 TeX that aren't directly supported by LyX but I'll tell you what they do
12397 and how to use them in section
12398 \begin_inset space ~
12402 \begin_inset CommandInset ref
12404 reference "sec:unsuppfoils"
12411 \begin_layout Subsection
12412 Building a Set of Foils
12415 \begin_layout Standard
12416 This section will give a simple introduction to using the different environments
12417 to build a set of foils.
12418 If you want to see an example set of foils, take a look at the
12422 file you find in LyX's
12429 \begin_layout Subsubsection
12430 Give It a Title Page
12433 \begin_layout Standard
12434 Unlike other classes that provide
12454 creates the title on a page of its own.
12455 If you leave out the
12459 environment LaTeX will substitute the current date (every time you regenerate
12463 \begin_layout Subsubsection
12467 \begin_layout Standard
12468 As I mentioned earlier, there are four ways of starting a new foil.
12469 For portrait foils you should use
12478 The difference between these two environments is the amount of space between
12479 the title of the foil (the foilhead) and the body of the foil.
12482 \begin_layout Standard
12483 Landscape foils are generated using the
12489 ShortRotatefoilhead
12492 Again the only difference is the spacing between foilhead and body.
12493 Both of the short versions have 0.5 inches less separation between the foilhead
12498 \begin_layout Standard
12499 One problem with the support for landscape foils is the requirement that
12500 you have to use the
12504 driver to generate the PostScript output otherwise the foils won't be rotated.
12505 It is possible to get landscape foils even if you haven't got the
12509 driver provided you can feed your foils sideways through your printer ;-)
12512 \begin_layout Subsubsection
12513 Theorems, Lemmas, Proofs and more
12516 \begin_layout Standard
12517 Due to a small bug in LyX you can't have two of the same type of these environme
12518 nts directly following each other.
12519 They must be separated by something.
12520 If you try, you will just be extending the previous environment as if you
12521 had merged the two environments together.
12522 So, how do you get around this problem? The simplest option is to insert
12523 some text between the two environments or add a
12527 environment between the two with just a
12528 \begin_inset Quotes eld
12536 \begin_inset Quotes erd
12540 This will force LyX to produce two separate environments and hence the
12541 correct LaTeX output.
12542 An example is provided in the example file included with the LyX distribution.
12543 Remember, this problem only occurs if you are trying to place two of the
12544 same type of theorem-like environments one directly after the other.
12547 \begin_layout Subsubsection
12551 \begin_layout Standard
12552 You get all the commonly supported list styles found in other classes as
12553 well as two new ones.
12554 I'll only describe the new ones here.
12555 If you want to find out more about the other list environments check out
12561 If you intend to use itemized lists you might also want to read about the
12565 \begin_inset space ~
12569 \begin_inset space ~
12574 dialog described above in section
12575 \begin_inset space ~
12579 \begin_inset CommandInset ref
12581 reference "sec:bullet"
12588 \begin_layout Standard
12589 The two new list styles,
12597 , are designed to make it easier for you to create lists of do's and don'ts
12598 or right and wrong by providing dedicated environments that use a tick
12599 or a cross as the label of the list.
12600 These lists are in fact dedicated variants of the
12605 They do however require that you have the
12609 packages installed.
12612 \begin_layout Subsubsection
12616 \begin_layout Standard
12621 TeX redefines the floating tables and figures so that they appear exactly
12622 where they are in the text rather than pushing them to the top of the page
12623 or to some user specified location.
12624 In fact if you change the float placement settings they are simply ignored.
12627 \begin_layout Subsubsection
12628 Page Headers and Footers
12629 \begin_inset CommandInset label
12631 name "sec:foilfoot"
12638 \begin_layout Standard
12642 \begin_inset space ~
12651 are two commands used to control the left-footer text string.
12652 The first is meant to allow you to include a graphic logo on your foils
12654 \begin_inset Quotes eld
12662 \begin_inset Quotes erd
12666 While the second is meant to provide a classification for the audience,
12670 \begin_inset space \thinspace{}
12676 \begin_inset space ~
12680 It is empty by default.
12683 \begin_layout Standard
12684 The remaining page corners can be filled by
12687 \begin_inset space ~
12692 (which defaults to page numbers),
12695 \begin_inset space ~
12703 \begin_inset space ~
12711 \begin_layout Subsection
12717 \begin_inset CommandInset label
12719 name "sec:unsuppfoils"
12726 \begin_layout Standard
12727 All the commands mentioned below need to be set in a
12735 within another environment.
12738 \begin_layout Subsubsection
12742 \begin_layout Standard
12743 All lengths are adjusted using the
12766 should be replaced by the name given to the length you want to change and
12771 is the length value.
12772 All lengths should be specified in units of length such as inches (
12784 ) or relative to some document or font-based length such as
12794 \begin_layout Standard
12795 It's possible to change the spacing between a foilhead and the body of the
12796 foil by adjusting the length specified by
12803 For example, to make
12807 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12814 foilheadskip}{-0.5in}
12817 \begin_layout Standard
12818 The spacings around floats can be adjusted by setting these lengths:
12821 \begin_layout Labeling
12822 \labelwidthstring MMMMMMMMMMM
12829 Separation between the text and the top of the float
12832 \begin_layout Labeling
12833 \labelwidthstring MMMMMMMMMMM
12840 Separation between the float and the caption
12843 \begin_layout Labeling
12844 \labelwidthstring MMMMMMMMMMM
12851 Separation between the caption and the following text
12854 \begin_layout Labeling
12855 \labelwidthstring MMMMMMMMMMM
12862 You can make the captions narrower than the surrounding text by adjusting
12864 Best done relative to
12873 \begin_layout Standard
12874 There are also several title page related lengths that you may find useful
12875 if you have a long title or several authors:
12878 \begin_layout Labeling
12879 \labelwidthstring MMMMMMMMMMM
12886 Separation from headers to
12891 \begin_layout Labeling
12892 \labelwidthstring MMMMMMMMMMM
12910 \begin_layout Labeling
12911 \labelwidthstring MMMMMMMMMMM
12925 \begin_layout Labeling
12926 \labelwidthstring MMMMMMMMMMM
12942 \begin_layout Labeling
12943 \labelwidthstring MMMMMMMMMMM
12959 \begin_layout Standard
12960 The last length related command affects all the list environments.
12971 a list environment then all the vertical spacing between the list items
12973 Note that this is a command not a length so it doesn't require
12979 like the stuff mentioned above.
12982 \begin_layout Subsubsection
12983 Headers and Footers
12986 \begin_layout Standard
12999 commands control whether the logo in the
13003 definition appear on a given page.
13010 in the preamble then none of the foils will have the logo on them.
13011 If you don't want the logo on a particular page place the
13017 directly after the foilhead of that page and the
13023 directly after the next foilhead.
13026 \begin_layout Standard
13027 If you decide to use the
13031 page style setting in the
13034 \begin_inset space ~
13039 dialog you should probably add
13049 to your preamble so headers and footers on landscape pages are correctly
13050 placed when rotated.
13051 This is due to some clashes between the page layouts provided by the
13062 \begin_layout Section
13063 Latex8 (IEEE Conference Papers)
13066 \begin_layout Standard
13072 \begin_layout Subsection
13076 \begin_layout Standard
13077 Since this class is specifically for writing submissions to IEEE sponsored
13078 conferences I strongly recommend that you get a copy of their Authors Kit.
13083 package and associated bibliography style file is included in the kit.
13084 The Authors Kit is usually sent out by email once your initial submission
13086 There is a lot of useful information in the Authors Kit explaining formatting
13087 restrictions and so on and I will assume you have read this since that
13088 means I don't have to repeat it all here.
13091 \begin_layout Subsection
13095 \begin_layout Standard
13096 [AR\SpecialChar \@.
13100 \begin_layout Subsection
13101 Supported Environments
13104 \begin_layout Itemize
13110 \begin_layout Itemize
13116 \begin_layout Itemize
13122 \begin_layout Itemize
13128 \begin_layout Itemize
13134 \begin_layout Itemize
13140 \begin_layout Itemize
13146 \begin_layout Itemize
13152 \begin_layout Itemize
13158 \begin_layout Subsection
13159 Differences Between Screen and Paper
13162 \begin_layout Standard
13163 There are slight differences in appearance mainly with the presentation
13164 of section counters.
13165 On screen the trailing period of the section counter is missing but it
13166 will appear in the output so don't let this worry you.
13169 \begin_layout Section
13170 Hollywood (Hollywood spec scripts)
13173 \begin_layout Standard
13179 \begin_layout Subsection
13183 \begin_layout Standard
13184 Getting the format of a Hollywood script right is a
13185 \begin_inset Quotes eld
13189 \begin_inset Quotes erd
13192 It is designed to make the readers focus on content and to be easy and
13193 familiar for the actors to read.
13194 Each page of a script should be one minute of film.
13195 Nothing goes in a script that you cannot see or hear on screen.
13196 The courier 12 pt font should be used throughout.
13200 \begin_layout Subsection
13204 \begin_layout Standard
13205 Speakers' lines should NEVER break in mid-sentence.
13206 If a speaker's lines continue over a page break, repeat the
13210 title followed by (Cont'd).
13213 \begin_layout Subsection
13217 \begin_layout Standard
13222 names as labels then cross-reference the label to insert the name.
13223 The cross-reference dialog will show the current cast of characters.
13224 You can use this to insert the speaker name in narratives also.
13227 \begin_layout Subsection
13228 Paper size and Margins
13231 \begin_layout Standard
13232 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13235 \begin_layout Subsection
13239 \begin_layout Standard
13240 The following environments are available.
13241 You can use hollywood.bind to get the bind keys shown at the right.
13244 \begin_layout Itemize
13248 \begin_inset Newline newline
13253 Used where nothing else works.
13257 \begin_layout Itemize
13263 \begin_inset space \hfill{}
13271 \begin_inset Newline newline
13274 Usually followed by something like
13275 \begin_inset Quotes eld
13278 on Sally waking up.
13279 \begin_inset Quotes erd
13285 \begin_layout Itemize
13289 \begin_inset space \hfill{}
13293 \begin_inset Newline newline
13298 Introduces a new INTERIOR camera set-up.
13299 Always followed by DAY or NIGHT, or something similar to define the lighting
13301 Everthing on this line in CAPS.
13304 \begin_layout Itemize
13308 \begin_inset space \hfill{}
13312 \begin_inset Newline newline
13317 Introduces a new EXTERIOR camera set-up.
13318 Everthing on this line in CAPS.
13321 \begin_layout Itemize
13325 \begin_inset space \hfill{}
13329 \begin_inset Newline newline
13334 The character speaking.
13337 \begin_layout Itemize
13341 \begin_inset space \hfill{}
13345 \begin_inset Newline newline
13350 Instructions to the speaker.
13351 The () are automatically inserted, but only the ( will show in LyX.
13352 Both will be printed.
13355 \begin_layout Itemize
13359 \begin_inset space \hfill{}
13363 \begin_inset Newline newline
13375 \begin_layout Itemize
13379 \begin_inset space \hfill{}
13383 \begin_inset Newline newline
13388 Camera movement instruction.
13390 \begin_inset space \thinspace{}
13394 \begin_inset space ~
13400 \begin_layout Itemize
13404 \begin_inset space \hfill{}
13410 \begin_layout Itemize
13414 \begin_inset space \hfill{}
13420 \begin_layout Itemize
13424 \begin_inset space \hfill{}
13430 \begin_layout Itemize
13434 \begin_inset space \hfill{}
13440 \begin_layout Subsection
13444 \begin_layout Itemize
13445 (O.S) --- off screen
13448 \begin_layout Itemize
13449 (V.0) --- voice over
13452 \begin_layout Itemize
13457 \begin_layout Itemize
13462 \begin_layout Itemize
13463 PAN --- camera movement
13466 \begin_layout Itemize
13467 INSERT --- cut to close-up of
13470 \begin_layout Section
13474 \begin_layout Standard
13480 \begin_layout Subsection
13484 \begin_layout Standard
13485 Broadway is for writing plays.
13486 The format is more decorative than Hollywood, and much less standardized.
13487 This format should be suitable for workshops.
13490 \begin_layout Subsection
13494 \begin_layout Standard
13495 The same as in Hollywood.
13498 \begin_layout Subsection
13502 \begin_layout Standard
13507 names as labels then cross-reference the label to insert the name.
13508 The cross-reference dialog will show the current cast of characters.
13511 \begin_layout Subsection
13512 Paper size and Margins
13515 \begin_layout Standard
13516 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13519 \begin_layout Subsection
13523 \begin_layout Standard
13524 The following environments are available.
13525 You can use broadway.bind to get the bind keys shown at the right.
13528 \begin_layout Itemize
13532 \begin_inset Newline newline
13537 You should not have to use this, but it is here for anything that does not
13541 \begin_layout Itemize
13545 \begin_inset space \hfill{}
13549 \begin_inset Newline newline
13554 Used to describe stage setting and the action.
13555 First use of speaker names in all CAPs.
13558 \begin_layout Itemize
13562 \begin_inset space \hfill{}
13566 \begin_inset Newline newline
13571 Automatically numbered.
13572 On screen it will be arabic, but will print as Roman.
13575 \begin_layout Itemize
13579 \begin_inset space \hfill{}
13583 \begin_inset Newline newline
13593 It is just centered text.
13596 \begin_layout Itemize
13600 \begin_inset space \hfill{}
13604 \begin_inset Newline newline
13609 Not automatically numbered.
13610 You supply the number.
13611 This is because I couldn't figure out how.
13614 \begin_layout Itemize
13618 \begin_inset space \hfill{}
13622 \begin_inset Newline newline
13627 A special case of Narrative to describe the setting and action as the curtain
13631 \begin_layout Itemize
13635 \begin_inset space \hfill{}
13639 \begin_inset Newline newline
13644 The speaker's (actor's) title, centered in all CAPS.
13647 \begin_layout Itemize
13651 \begin_inset space \hfill{}
13655 \begin_inset Newline newline
13660 Instructions to the speaker.
13661 The parentheses are automatically inserted.
13662 The ( will appear on screen, but both will be in the printed play.
13663 This environment is only used within
13670 \begin_layout Itemize
13674 \begin_inset space \hfill{}
13678 \begin_inset Newline newline
13683 What the Speaker says.
13686 \begin_layout Itemize
13690 \begin_inset space \hfill{}
13694 \begin_inset Newline newline
13699 The curtain comes down.
13702 \begin_layout Itemize
13706 \begin_inset space \hfill{}
13712 \begin_layout Itemize
13716 \begin_inset space \hfill{}
13722 \begin_layout Itemize
13726 \begin_inset space \hfill{}
13732 \begin_layout Standard
13736 \begin_layout Section
13740 \begin_layout Standard
13746 \begin_layout Standard
13747 \begin_inset VSpace bigskip
13753 \begin_layout Standard
13758 \begin_inset space ~
13763 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13764 \begin_inset Formula $\beta$
13767 release of May, 1999) class.
13770 \begin_layout Standard
13775 textclass, which works with RevTeX 3.1.
13776 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13777 That means that it doesn't interact very well with LyX, which requires
13778 LaTeX2e, although it has been kludged to work.
13779 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13783 \begin_inset space ~
13788 textclass should also be pretty easy to use.
13791 \begin_layout Standard
13792 These documents are supposed to be used in
13796 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13797 macros, and assume you'll know what to put in the preamble if necessary.
13800 \begin_layout Subsection
13804 \begin_layout Standard
13805 All you need to do is install RevTeX 4, as described in the package's README
13807 The package can be found at The RevTeX 4 Web Site
13808 \begin_inset Flex URL
13811 \begin_layout Plain Layout
13813 http://publish.aps.org/revtex4/
13819 Install it somewhere that LaTeX can see it.
13820 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13821 (i.e., not the directory where you installed the class file.) Then, if you
13822 reconfigure LyX, it will find the class file and let you use the RevTeX4
13826 \begin_layout Standard
13827 Probably the easiest way to get started is either to import a RevTeX 4 document
13835 \begin_inset space ~
13840 template, found in the templates directory.
13843 \begin_layout Subsection
13847 \begin_layout Standard
13848 Optional arguments to
13855 \begin_inset Quotes eld
13859 \begin_inset Quotes erd
13863 \begin_inset Quotes eld
13867 \begin_inset Quotes erd
13877 \begin_inset space ~
13885 \begin_inset space ~
13891 Remember that in RevTeX, at least one optional argument is required!
13894 \begin_layout Standard
13895 Other preamble matter, like
13902 \begin_inset space ~
13912 \begin_inset space ~
13917 dialog, also as usual.
13920 \begin_layout Subsection
13924 \begin_layout Standard
13925 The layouts basically correspond to the commands in RevTeX4.0.
13926 For example, the Email layout corresponds to
13933 Note that (at least as of RevTeX 4.0 Beta), the
13941 layouts are exactly equivalent, so you shouldn't need to use both.
13945 \begin_layout Plain Layout
13946 In case you're curious, both were included so that
13950 would be able to translate both
13970 \begin_layout Subsection
13974 \begin_layout Standard
13975 There are a couple of important unique aspects of RevTeX 4 which might cause
13976 bugs that will be even more confusing in LyX.
13979 \begin_layout Standard
13997 The LyX equivalent is that there is a separate Thanks layout.
14002 write footnotes in the
14006 layout, or weird things may happen.
14007 See the RevTeX 4 documentation for more details.
14010 \begin_layout Standard
14014 \begin_inset space ~
14022 \begin_inset space ~
14031 layouts must be placed
14039 layout and the corresponding
14056 , the LaTeX won't compile.
14059 \begin_layout Subsection
14063 \begin_layout Standard
14064 The main problem with this layout is that you can't use the optional arguments
14065 to layouts like Email and Title.
14066 (The problem is not unique to this layout; you can't use optional arguments
14067 to the Section layouts either.) This means that after you export that file
14068 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14069 need to edit the LaTeX file with a text editor to add the optional arguments
14071 \begin_inset space \thinspace{}
14074 g., the running title for the page headers.
14075 Lacking these layouts makes the
14081 (and the equivalent
14087 ) useless, so the corresponding layouts don't exist, and will have to be
14092 \begin_layout Plain Layout
14097 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14098 has not been updated yet to take advantage of it.
14106 \begin_layout Section
14107 Article (mwart), book (mwbk) and report (mwrep)
14108 \begin_inset OptArg
14111 \begin_layout Plain Layout
14124 \begin_layout Standard
14130 \begin_layout Standard
14131 The LyX document classes
14147 correspond to the LaTeX document classes
14160 They are replacements for the standard document classes
14172 , resp., and fit better to Polish typography conventions in a number of points.
14176 \begin_layout Standard
14180 \begin_layout Itemize
14181 Unnumbered titles (with star, eg.
14186 ) are added into table of contents,
14189 \begin_layout Itemize
14190 Additional page styles:
14194 \begin_layout Description
14195 uheadings header with separated lines,
14198 \begin_layout Description
14199 myheadings custom header, contents headers via commands:
14214 \begin_layout Description
14215 myuheadings custom header with separated lines,
14218 \begin_layout Description
14219 outer page number is placed on outer side of page
14223 \begin_layout Itemize
14228 \begin_layout Description
14229 rmheadings serif titles --- default,
14232 \begin_layout Description
14233 sfheadings sansserif titles,
14236 \begin_layout Description
14237 authortitle on title page first placed is author next title --- default,
14240 \begin_layout Description
14241 titleauthor on title page first placed is title next author,
14244 \begin_layout Description
14245 withmarginpar reserve place on page for margins.
14249 \begin_layout Section
14253 \begin_layout Standard
14259 \begin_layout Standard
14260 Elsevier Science Publishers B.V.
14261 provides a standard LaTeX document class (
14265 ) for submitting articles to their various journals.
14266 The style file can be downloaded directly from their web site:
14267 \begin_inset Flex URL
14270 \begin_layout Plain Layout
14272 http://authors.elsevier.com/
14278 Instructions are supplied along with the class file, which details the
14279 requirements of the publishers.
14280 LyX includes package that allows for the use of this class, by a layout
14281 and a template file.
14282 Installation of the class file is the same as for any other LaTeX package;
14283 instructions are provided in the Elsevier documentation.
14286 \begin_layout Standard
14296 As the Elsevier class file is based mainly on the standard article class,
14297 most of the normal functionality is provided.
14298 The Elsevier class defines a number of mathematical environments, which
14299 are similar to the AMS environments.
14300 These commands are all described in the Elsevier documentation, and are
14304 \begin_layout Standard
14305 The easiest way to use the Elsevier style is to base documents on the included
14307 It is best not to use options such as fancy headings or the geometry package,
14308 as elements such as these are defined by Elsevier in their style file.
14309 Ideally, no extra packages except those mentioned in the Elsevier documentation
14311 Essentially, Elsevier require as
14312 \begin_inset Quotes eld
14316 \begin_inset Quotes erd
14319 a LaTeX file as possible, as their intention is to take the supplied file
14320 and replace the class file with one for the particular journal to which
14321 the paper has been submitted.
14322 This also means that not too much time should be spent on the formating
14324 When it comes to be published, this will change anyway.
14325 The rest of the usage for this layout is substantially the same as for
14326 the normal article class.
14327 For details of what Elsevier do and don't allow, refer to their documentation.
14330 \begin_layout Section
14334 \begin_layout Standard
14337 Jürgen Spitzmüller
14340 \begin_layout Subsection
14344 \begin_layout Standard
14345 Memoir is a very powerful and constantly evolving class.
14346 It has been designed with regard to fictional and non-fictional literature.
14347 Its aim is to let the user have maximum control over the typesetting of
14349 Memoir is based on the standard book class, but it can also emulate the
14350 article class (see below).
14353 \begin_layout Standard
14354 Peter Wilson, the developer of Memoir, is known as the author of lots of
14355 useful packages in the LaTeX world.
14356 Most of them have been merged with Memoir.
14357 Therefore, it is much easier to layout the table of contents, appendices,
14358 chapter designs and such.
14359 LyX, though, does not support all of these goodies natively.
14360 Some of them might be added to forthcoming releases
14364 \begin_layout Plain Layout
14365 You are invited to send suggestions to
14366 \begin_inset Flex URL
14369 \begin_layout Plain Layout
14371 lyx-devel@lists.lyx.org
14381 , lots will probably never, due to the limitations of LyX's framework.
14382 Of course you can still use all features with the help of some native LaTeX
14387 \begin_layout Plain Layout
14392 \begin_layout Plain Layout
14402 \begin_inset space ~
14406 \begin_inset CommandInset ref
14408 reference "sec:Inserting-TeX-Code"
14418 In this section, we can only list those features which are natively supported
14420 For detailed descriptions (and for the rest of features) we are recommending
14421 to have a look at the detailed manual of the Memoir class
14425 \begin_layout Plain Layout
14430 \begin_layout Plain Layout
14440 \begin_inset Flex URL
14443 \begin_layout Plain Layout
14445 CTAN:/macros/latex/memoir/memman.pdf
14455 , which is not only a user guide for the class, but also both a comprehensive
14456 description on good typesetting and a superb example for good typesetting
14460 \begin_layout Subsection
14461 Basic features and restrictions
14464 \begin_layout Standard
14465 Memoir supports basically all features of the standard book classes.
14466 There are, however, some differences, as follows:
14469 \begin_layout Description
14471 \begin_inset space ~
14474 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14477 \begin_layout Description
14479 \begin_inset space ~
14482 style: The fancy page style is not supported, due to a command clash between
14483 Memoir and the fancyhdr package (they are both defining a command with
14484 the same name, which confuses LaTeX).
14485 Instead, Memoir comes with a bunch of own page styles (see
14487 Layout\SpecialChar \menuseparator
14488 Document\SpecialChar \menuseparator
14490 \begin_inset space ~
14496 If you want to use these for the chapter pages, you have to use the command
14503 in the main text or in preamble (e.
14504 \begin_inset space \thinspace{}
14508 \begin_inset space ~
14515 chapterstyle{companion}
14520 \begin_layout Description
14521 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14522 an optional argument in the standard classes.
14523 With this, you can specify an alternative version of the title for the
14524 table of contents and the headers (for instance, if the title is too long).
14525 In LyX, you can do this via
14527 Insert\SpecialChar \menuseparator
14529 \begin_inset space ~
14534 at the beginning of a chapter/section.
14535 Memoir features a second optional argument and thus separates the table
14536 of contents from the header.
14537 You can define three variants of a title with this: one for the main text,
14538 one for the table of contents, and one for the headers.
14539 Simply insert two optional arguments if you need this feature, the first
14540 one containing the short title for the Table of Contents, the second one
14541 containing an alternative short title for the headers.
14544 \begin_layout Description
14545 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14546 of contents, the list of figures and the list of table start a new page
14548 Memoir does not follow this route.
14549 You have to insert a page break yourself, if you want to have one.
14552 \begin_layout Description
14553 Titlepage: For some unknown reason, Memoir uses pagination on the title
14554 page (in the standard classes, title pages are
14555 \begin_inset Quotes eld
14559 \begin_inset Quotes erd
14563 \begin_inset space \thinspace{}
14567 \begin_inset space ~
14571 If you want an empty title page, type
14575 aliaspagestyle{title}{empty}
14580 \begin_layout Description
14581 Article: With the class option
14587 Layout\SpecialChar \menuseparator
14588 Document\SpecialChar \menuseparator
14590 \begin_inset space ~
14595 ), you can emulate article style.
14596 That is, counters (footnotes, figures, tables etc.) will not be reset on
14597 new chapters, chapters don't start a new page (but are---in contrary to
14599 \begin_inset Quotes eld
14603 \begin_inset Quotes erd
14606 article classes---still allowed), parts, though, use their own page, as
14610 \begin_layout Description
14611 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14612 font commands, which have been used in the old LaTeX version 2.09 (e.
14613 \begin_inset space \thinspace{}
14617 \begin_inset space ~
14633 It produces an error and stops LaTeX whenever such a command appears.
14638 reallows the commands and spits out warnings instead (which does at least
14640 Since a lot of packages and particularly BibTeX style files are still using
14641 those commands, we have decided to use this option by default.
14644 \begin_layout Subsection
14648 \begin_layout Standard
14649 We will only describe the features supported by LyX (which is not much currently
14651 Please consult the Memoir manual
14655 \begin_layout Plain Layout
14660 \begin_layout Plain Layout
14670 \begin_inset Flex URL
14673 \begin_layout Plain Layout
14675 CTAN:/macros/latex/memoir/memman.pdf
14688 \begin_layout Description
14689 Abstract: You may wonder why an abstract is an extra feature.
14690 Well, it is in book class.
14691 Usually books don't have abstracts.
14692 Memoir, however, has.
14693 You can use it wherever and how often you like.
14696 \begin_layout Description
14697 Chapterprecis: You may know this from belletristic: The contents of a chapter
14698 is shortly described below the title and also in the table of contents
14700 \begin_inset space \thinspace{}
14704 \begin_inset space ~
14709 Our hero arrives in Troia; he loses some friends; he finds others
14712 Chapterprecis does exactly this.
14713 It is therefore only sensible below a chapter.
14716 \begin_layout Description
14717 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14718 The epigraph environment provides an elegant way of typesetting such a
14720 The motto itself (text) and its author (source) are divided by a short
14722 Unfortunately, we have to fool LyX a bit here again, since the environment
14723 needs two arguments (text and source).
14724 In this case, we have to use curly brackets (in TeX mode) between the two
14735 <author of the slogan>.
14738 \begin_layout Description
14739 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14740 complex figurative poems).
14741 LyX can only support a few of them.
14742 One is poemtitle, which is a centered title for poems, which will also
14743 be added to the table of contents (verse is the standard environment for
14745 Memoir has some enhanced versions of verse, but you need to use ERT, because
14746 they have to be nested inside regular verse environments, which is not
14747 possible with LyX).
14750 \begin_layout Description
14751 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14754 \begin_layout Chapter
14755 LyX Features needing Extra Software
14758 \begin_layout Section
14762 \begin_layout Standard
14768 \begin_layout Subsection
14772 \begin_layout Standard
14773 When you to have the
14777 program installed, you'll find in the
14784 \begin_inset space ~
14795 \begin_inset CommandInset href
14797 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14804 \begin_layout Standard
14809 package is a program that was written by
14814 in frustration because some constructs in LaTeX are sometimes non-intuitive,
14815 and easy to forget.
14816 The program runs over your LaTeX file and checks the integrity of the file,
14817 and flags some common errors.
14818 In other technical words, it is
14825 \begin_layout Standard
14826 Well, what is a syntax checker doing in LyX which is supposed to produce
14827 correct LaTeX anyways? The answer is simple: Just as
14831 not only checks the
14835 of C programs, but also does
14839 checks for type-errors,
14843 catches some common
14847 errors, in addition to the syntactical ones.
14852 is capable of detecting several common errors, such as
14855 \begin_layout Itemize
14856 Ellipsis detection:
14857 \begin_inset Newline newline
14860 Use \SpecialChar \ldots{}
14864 \begin_layout Itemize
14865 No space in front of/after parenthesis:
14866 \begin_inset Newline newline
14872 \begin_layout Itemize
14873 Enforcement of normal space after common abbreviations:
14874 \begin_inset Newline newline
14879 is too wide spacing.
14882 \begin_layout Itemize
14883 Enforcement of end-of-sentence space when the last sentence ends with a
14885 \begin_inset Newline newline
14889 And this is wrong spacing.
14892 \begin_layout Itemize
14893 Space in front of labels and similar commands:
14894 \begin_inset Newline newline
14897 The label should stick right up to the text to avoid falling to a wrong
14900 \begin_inset CommandInset label
14910 \begin_layout Plain Layout
14911 This footnote is in danger of falling off to a wrong page
14916 The label is separated too much.
14919 \begin_layout Itemize
14920 Space in front of references, instead of hard spaces:
14921 \begin_inset Newline newline
14924 In you are in bad luck, the text will break right between the referenced
14925 text and reference number, and that's a pity.
14927 \begin_inset CommandInset ref
14929 reference "sec:chktex"
14936 \begin_layout Itemize
14938 \begin_inset Quotes eld
14942 \begin_inset Quotes erd
14946 \begin_inset Formula $\times$
14950 \begin_inset Newline newline
14953 2x2 looks cheap compared to
14954 \begin_inset Formula $2\times2$
14960 \begin_layout Standard
14961 and more \SpecialChar \ldots{}
14962 It is an invaluable tool when you are
14963 \begin_inset Quotes eld
14967 \begin_inset Quotes erd
14970 your document before printing, and you should run it right after the obligatory
14971 spelling check, and before you go fine tuning the typesetting.
14974 \begin_layout Subsection
14978 \begin_layout Standard
14979 If you have the program installed, usage is as simple as choosing
14984 ools\SpecialChar \menuseparator
14990 \begin_inset space ~
14996 This will make LyX generate a LaTeX file of your document, start
15000 to check it, and then make LyX insert
15001 \begin_inset Quotes eld
15005 \begin_inset Quotes erd
15008 with the warnings from
15012 , if there were any.
15013 The warnings will be placed close to the point of the mistake, and you
15014 can quickly find them by using the
15019 avigate\SpecialChar \menuseparator
15026 menu item, or the shortcut key
15035 Open the error boxes by clicking on them with the mouse, or use the shortcut
15044 bindings, or the corresponding
15053 Read the warning and correct the mistake, if it is a mistake.
15054 If you have trouble understanding what the warning is about, you can safely
15056 Remember that there is a hidden layer between the document on screen and
15057 the technical details in invoking
15061 , and this gap can make some warnings seem arcane or just right down plain
15065 \begin_layout Standard
15066 This document is an excellent testing bed for the feature, and it should
15067 provide quite a few warnings for you to fiddle with.
15068 Since computers are only so smart, expect most of the warnings to be false
15072 \begin_layout Subsection
15073 How to fine tune it
15076 \begin_layout Standard
15077 Sometimes, you'll find that
15081 makes more noise than suits your mood.
15082 Then you can choose not to use it, wait until your mood changes, or try
15087 to get better along with you.
15088 Another choice in the most desperate situations is to use
15093 iew\SpecialChar \menuseparator
15099 \begin_inset space ~
15103 \begin_inset space ~
15107 \begin_inset space ~
15112 , which will get rid of all warnings instantly.
15115 \begin_layout Standard
15124 very configurable and extensible, you shouldn't expect to solve all problems
15130 Since LyX has to generate a somewhat special LaTeX file to be able to match
15131 the line numbers from the
15139 \begin_layout Plain Layout
15140 You can inspect the specific output from
15146 Edit\SpecialChar \menuseparator
15148 \begin_inset space ~
15152 \begin_inset space ~
15166 to the internal document structure, some of the warnings will not seen
15167 to appear correctly.
15168 There are two things you can do about this:
15171 \begin_layout Itemize
15176 invocation command line in
15192 installation configuration file (usually with the file
15197 See below to learn what warnings can be enabled and disabled on the command
15202 \begin_layout Itemize
15203 Export your document as a raw LaTeX file using
15208 ile\SpecialChar \menuseparator
15213 xport\SpecialChar \menuseparator
15225 Invoked in this way, it can be a hassle to find the corresponding place
15226 in the document inside LyX, but with a little patience, you should be able
15230 \begin_layout Standard
15231 Here follows the warning messages that can be enabled and disabled in
15240 to disable a warning, and
15244 to enable a warning.
15245 The emphasized entries are disabled by default, because the default is
15248 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15253 \begin_layout Standard
15254 Notice that you should only use the options that enable and disable warnings,
15255 because LyX relies on some of the other command line parameters to be set
15256 in a specific way to have a chance to communicate with
15263 \begin_layout Enumerate
15267 Command terminated with space.
15270 \begin_layout Enumerate
15273 Non-breaking space (
15274 \begin_inset Quotes eld
15282 \begin_inset Quotes erd
15285 ) should have been used.
15288 \begin_layout Enumerate
15292 You should enclose the previous parenthesis with
15293 \begin_inset Quotes eld
15301 \begin_inset Quotes erd
15307 \begin_layout Enumerate
15310 Italic correction (
15311 \begin_inset Quotes eld
15321 \begin_inset Quotes erd
15324 ) found in non-italic buffer.
15327 \begin_layout Enumerate
15330 Italic correction (
15331 \begin_inset Quotes eld
15341 \begin_inset Quotes erd
15344 ) found more than once.
15347 \begin_layout Enumerate
15351 No italic correction (
15352 \begin_inset Quotes eld
15362 \begin_inset Quotes erd
15368 \begin_layout Enumerate
15372 \begin_inset Quotes eld
15380 \begin_inset Quotes erd
15384 \begin_inset Quotes eld
15392 \begin_inset Quotes erd
15398 \begin_layout Enumerate
15401 Wrong length of dash may have been used.
15404 \begin_layout Enumerate
15408 \begin_inset Quotes eld
15416 \begin_inset Quotes erd
15420 \begin_inset Quotes eld
15428 \begin_inset Quotes erd
15434 \begin_layout Enumerate
15438 \begin_inset Quotes eld
15446 \begin_inset Quotes erd
15452 \begin_layout Enumerate
15456 \begin_inset Quotes eld
15464 \begin_inset Quotes erd
15467 to achieve an ellipsis.
15470 \begin_layout Enumerate
15473 Inter-word spacing (
15474 \begin_inset Quotes eld
15484 \begin_inset Quotes eld
15487 ) should perhaps be used.
15490 \begin_layout Enumerate
15493 Inter-sentence spacing (
15494 \begin_inset Quotes eld
15504 \begin_inset Quotes erd
15507 ) should perhaps be used.
15510 \begin_layout Enumerate
15513 Could not find argument for command.
15516 \begin_layout Enumerate
15520 \begin_inset Quotes eld
15528 \begin_inset Quotes erd
15534 \begin_layout Enumerate
15537 Math mode still on at end of LaTeX file.
15540 \begin_layout Enumerate
15544 \begin_inset Quotes eld
15552 \begin_inset Quotes erd
15555 doesn't match the number of
15556 \begin_inset Quotes eld
15564 \begin_inset Quotes erd
15570 \begin_layout Enumerate
15573 You should use either
15576 \begin_inset Quotes eld
15584 \begin_inset Quotes erd
15589 as an alternative to
15590 \begin_inset Quotes eld
15598 \begin_inset Quotes erd
15604 \begin_layout Enumerate
15611 " (ASCII 39) instead of "
15618 \begin_layout Enumerate
15621 User-specified pattern found.
15624 \begin_layout Enumerate
15627 This command might not be intended.
15630 \begin_layout Enumerate
15637 \begin_layout Enumerate
15655 \begin_layout Enumerate
15658 Delete this space to maintain correct page references.
15661 \begin_layout Enumerate
15665 You might wish to put this between a pair of
15666 \begin_inset Quotes eld
15674 \begin_inset Quotes erd
15680 \begin_layout Enumerate
15683 You ought to remove spaces in front of punctuation.
15686 \begin_layout Enumerate
15689 Could not execute LaTeX command.
15692 \begin_layout Enumerate
15701 in front of small punctuation.
15704 \begin_layout Enumerate
15712 may look prettier here.
15715 \begin_layout Enumerate
15719 Multiple spaces detected in output.
15722 \begin_layout Enumerate
15725 This text may be ignored.
15728 \begin_layout Enumerate
15734 \begin_inset Quotes eld
15739 to begin quotation, not
15746 \begin_layout Enumerate
15753 to end quotation, not
15756 \begin_inset Quotes eld
15764 \begin_layout Enumerate
15770 \begin_layout Enumerate
15773 You should perhaps use
15774 \begin_inset Quotes eld
15782 \begin_inset Quotes erd
15788 \begin_layout Enumerate
15791 You should put a space in front of/after parenthesis.
15794 \begin_layout Enumerate
15797 You should avoid spaces in front of/after parenthesis.
15800 \begin_layout Enumerate
15804 You should not use punctuation in front of/after quotes.
15807 \begin_layout Enumerate
15810 Double space found.
15813 \begin_layout Enumerate
15816 You should put punctuation outside inner/inside display math mode.
15819 \begin_layout Enumerate
15822 You ought to not use primitive TeX in LaTeX code.
15825 \begin_layout Enumerate
15828 You should remove spaces in front of
15829 \begin_inset Quotes eld
15837 \begin_inset Quotes erd
15843 \begin_layout Enumerate
15846 \begin_inset Quotes eld
15854 \begin_inset Quotes erd
15857 is normally not followed by
15858 \begin_inset Quotes eld
15866 \begin_inset Quotes erd
15872 \begin_layout Standard
15873 In later versions of LyX, we hope to provide a more complete interface to
15874 this tool (and it's smaller cousin
15878 ) to exploit the full power of it.
15879 But it's not exactly useless as it is now: go try it on one of your existing
15880 documents of a certain length and be surprised.
15883 \begin_layout Section
15884 Version Control in LyX
15887 \begin_layout Standard
15890 Lars Gullik Bjønnes,
15897 \begin_layout Subsection
15901 \begin_layout Standard
15902 A friend of mine wanted to try LyX for a group project.
15903 When he didn't find support for version control or file locking, he dropped
15905 This angered me a bit, so I thought that I should at least make support
15906 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
15907 This has now been done.
15908 LyX now supports some of the most basic RCS commands.
15909 If you need to something a bit more sophisticated you will have to do that
15910 manually in an xterm.
15913 \begin_layout Standard
15914 Before you begin to use the version control features in LyX, you should
15916 \begin_inset Quotes eld
15920 \begin_inset Quotes erd
15923 (a man file, read it with
15928 This file describes all the basic features of RCS.
15929 You should especially notice the comment about a RCS directory, and the
15930 notion of a master RCS file (the file ending in
15937 \begin_layout Standard
15938 Later basic CVS/SVN support was added.
15939 You should be familiar with CVS/SVN usage before start using it under LyX.
15940 Most of the log messages are not currently displayed after operations -
15941 you can check them in terminal window if unsure.
15944 \begin_layout Standard
15945 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
15946 package---no guarantees are made for older versions.
15949 \begin_layout Subsection
15950 RCS commands in LyX
15953 \begin_layout Standard
15954 The following sections describe the RCS commands supported by LyX.
15955 You can find them in the
15960 ile\SpecialChar \menuseparator
15966 \begin_inset space ~
15974 \begin_layout Subsubsection
15980 \begin_layout Standard
15981 If your document is not under revision control, this is the only item shown
15983 And if it is under revision control, the
15990 item is not visible.
15994 \begin_layout Standard
15995 This command registers your document with RCS (unless you are under the
15996 directory managed by CVS)\SpecialChar \@.
15997 You are asked interactively to supply an initial
15998 description of the document.
15999 The document is now set in Read-Only mode and you have to
16002 \begin_inset space ~
16006 \begin_inset space ~
16010 \begin_inset space ~
16015 , before making any changes to it.
16016 A document under revision control has a
16017 \begin_inset Quotes eld
16020 [RCS:<version> <locker>]
16021 \begin_inset Quotes erd
16024 item tagged to the filename in the minibuffer.
16027 \begin_layout Standard
16028 RCS command that is run:
16030 ci -q -u -i -t-"<initial description>" <file-name>
16033 \begin_layout Standard
16038 to understand the switches.
16042 \begin_layout Subsubsection
16048 \begin_layout Standard
16049 When you are finished editing a file, you check in your changes.
16050 When you do this, you are asked for a description of the changes.
16051 This is stored in the history log.
16052 The version number is bumped, your changes are applied to the master RCS
16053 file, the document is unlocked and set to Read-Only mode.
16057 \begin_layout Standard
16060 ci -q -u -m"<description>" <file-name>
16063 \begin_layout Subsubsection
16069 \begin_layout Standard
16070 By doing this you lock the document so that only you can edit it.
16071 This will also make the document Read-Write only for you.
16072 You will usually continue editing for a while and when you are finished
16073 you check in your changes.
16074 The status line is changed to reflect that you have locked the file.
16078 \begin_layout Standard
16081 co -q -l <file-name>
16084 \begin_layout Subsubsection
16087 Revert To Repository Version
16090 \begin_layout Standard
16091 This will discard all changes made to the document since the last check
16093 You get a warning before changes are discarded.
16096 \begin_layout Standard
16099 co -f -u<version> <file-name>
16102 \begin_layout Subsubsection
16108 \begin_layout Standard
16109 This makes as if the last check in never happened.
16110 No changes are made to the document loaded into LyX, but the last version
16111 is removed from the master RCS file.
16115 \begin_layout Standard
16118 rcs -o<version> <file-name>
16121 \begin_layout Subsubsection
16127 \begin_layout Standard
16128 This show the complete history of the RCS document.
16133 is shown in a browser.
16141 \begin_layout Subsection
16142 CVS commands in LyX
16145 \begin_layout Standard
16146 CVS is now partially supported by LyX.
16147 You can find the commands in the
16152 ile\SpecialChar \menuseparator
16158 \begin_inset space ~
16166 \begin_layout Subsubsection
16172 \begin_layout Standard
16173 If your document is not under revision control, this is the only item shown
16175 And if it is under revision control, the
16182 item is not visible.
16186 \begin_layout Standard
16187 This command registers in CVS your document ONLY in case you have already
16188 the documents directory under CVS control (in particular
16193 This means you have to checkout the archive by yourself.
16197 \begin_layout Standard
16198 Then you are asked interactively to supply an initial description of the
16200 Don't forget that registered file is not yet commited.
16203 \begin_layout Standard
16204 CVS command that is run:
16207 \begin_inset Quotes erd
16211 \begin_inset Quotes eld
16215 \begin_inset Quotes erd
16221 \begin_layout Standard
16226 to understand the switches.
16230 \begin_layout Subsubsection
16236 \begin_layout Standard
16237 When you are finished editing a file, you commit your changes.
16238 When you do this, you are asked for a description of the changes.
16239 After that changes are commited.
16242 \begin_layout Standard
16245 cvs -q commit -m"<description>" <file-name>
16248 \begin_layout Subsubsection
16251 Revert To Repository Version
16254 \begin_layout Standard
16255 This will discard all changes made to the document since the last check
16257 You get a warning before changes are discarded.
16258 Firstly the file is deleted, secondly CVS update command is run.
16261 \begin_layout Standard
16265 \begin_inset Quotes eld
16269 \begin_inset Quotes erd
16275 \begin_layout Subsubsection
16281 \begin_layout Standard
16282 This show the complete history of the CVS document.
16286 \begin_inset Quotes eld
16290 \begin_inset Quotes erd
16295 is shown in a browser.
16298 \begin_layout Subsection
16299 SVN commands in LyX
16302 \begin_layout Standard
16303 SVN is now partially supported by LyX.
16304 You can find the commands in the
16309 ile\SpecialChar \menuseparator
16315 \begin_inset space ~
16321 Please note that if you use password protected access to repository via
16322 ssh, you will be asked in terminal window.
16325 \begin_layout Subsubsection
16331 \begin_layout Standard
16332 If your document is not under revision control, this is the only item shown
16334 And if it is under revision control, the
16341 item is not visible.
16345 \begin_layout Standard
16346 This command registers in SVN your document ONLY in case you have already
16347 the documents directory under SVN control (in particular
16352 This means you have to checkout the archive by yourself.
16356 \begin_layout Standard
16357 Then you are asked interactively to supply an initial description of the
16359 Don't forget that registered file is not yet commited.
16362 \begin_layout Standard
16363 SVN command that is run:
16366 \begin_inset Quotes eld
16370 \begin_inset Quotes erd
16376 \begin_layout Standard
16381 to understand the switches.
16385 \begin_layout Subsubsection
16391 \begin_layout Standard
16392 When you are finished editing a file, you commit your changes.
16393 When you do this, you are asked for a description of the changes.
16394 After that changes are commited.
16397 \begin_layout Standard
16400 svn commit -q -m"<description>" <file-name>
16403 \begin_layout Subsubsection
16409 \begin_layout Standard
16410 Updates the changes of this file from the repository.
16411 Be sure you understand SVN merging and conflicts resolving before using
16412 this function, because all conflicts has to be done manually by you!
16415 \begin_layout Standard
16419 \begin_inset Quotes eld
16423 \begin_inset Quotes erd
16429 \begin_layout Subsubsection
16432 Revert To Repository Version
16435 \begin_layout Standard
16436 This will discard all changes made to the document since the last check
16438 You get a warning before changes are discarded.
16442 \begin_layout Standard
16446 \begin_inset Quotes eld
16450 \begin_inset Quotes erd
16456 \begin_layout Subsubsection
16462 \begin_layout Standard
16463 This show the complete history of the SVN document.
16467 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16476 is shown in a browser.
16479 \begin_layout Section
16480 Literate Programming
16483 \begin_layout Standard
16488 (kayvan@sylvan.com)
16492 original documentation written by
16494 Edmar Wienskoski Jr.
16497 (edmar-w-jr@technologist.com)
16500 \begin_layout Subsection
16504 \begin_layout Standard
16505 The main purpose of this documentation is to show you how to use LyX for
16506 literate programming.
16507 Where it is assumed that you are familiar with this programming technique,
16509 \begin_inset Quotes eld
16513 \begin_inset Quotes erd
16517 \begin_inset Quotes eld
16521 \begin_inset Quotes erd
16525 If that is not the case, please follow the web links provided in the following
16527 There is a lot of good documentation out there covering old development
16528 history to the latest tools tips.
16531 \begin_layout Standard
16532 It is also assumed that you are familiar with LyX itself to a point that
16533 you are comfortable changing your LyX preferences, and X resources file.
16534 If that is not the case please refer to other LyX documentation to cover
16535 your specific needs.
16538 \begin_layout Subsection
16539 Literate Programming
16542 \begin_layout Standard
16543 From the Literate Programming FAQ:
16546 \begin_layout Quotation
16547 Literate programming is the combination of documentation and source together
16548 in a fashion suited for reading by human beings.
16549 In fact, literate programs should be enjoyable reading, even inviting!
16550 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16551 and documentation in a single file.
16552 Literate programming tools then parse the file to produce either readable
16553 documentation or compilable source.
16554 The WEB style of literate programming was created by D.E.
16555 Knuth during the development of his TeX typesetting software.
16559 \begin_layout Standard
16560 Another excerpt says:
16563 \begin_layout Quotation
16566 How is literate programming different from verbose commenting?
16569 \begin_layout Quotation
16570 There are three distinguishing characteristics.
16571 In order of importance, they are:
16575 \begin_layout Itemize
16576 flexible order of elaboration
16579 \begin_layout Itemize
16580 automatic support for browsing
16583 \begin_layout Itemize
16584 typeset documentation, especially diagrams and mathematics
16588 \begin_layout Standard
16589 Now that I sparked your curiosity, take a look in the references.
16592 \begin_layout Subsubsection
16596 \begin_layout Standard
16597 The complete Literate Programming FAQ can be found at:
16600 \begin_layout Quote
16601 Literate Programming FAQ
16602 \begin_inset Flex URL
16605 \begin_layout Plain Layout
16607 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16615 \begin_layout Standard
16616 The FAQ lists 23 (twenty three!) different literate programming tools.
16617 Where some are specialized or
16618 \begin_inset Quotes eld
16622 \begin_inset Quotes erd
16625 for particular programming languages, while other have general scope.
16630 for my own use for several reasons:
16633 \begin_layout Itemize
16634 It can generate the documentation either in LaTeX or HTML.
16637 \begin_layout Itemize
16638 It has a open architecture, i.e., it is easy to plug in new filters and to
16639 perform special processing that you may need.
16643 \begin_layout Itemize
16644 There is a good selection of filters available already (the HTML is one
16648 \begin_layout Itemize
16652 \begin_layout Standard
16653 The Noweb web page can be found at:
16656 \begin_layout Quote
16658 \begin_inset Flex URL
16661 \begin_layout Plain Layout
16663 http://www.cs.virginia.edu/~nr/noweb/
16671 \begin_layout Standard
16672 Starting from there you can reach many other interesting links and even
16673 some literate program examples.
16676 \begin_layout Subsection
16677 \begin_inset CommandInset label
16679 name "sub:LyX-and-Literate"
16683 LyX and Literate Programming
16686 \begin_layout Standard
16687 The LyX support for Literate Programming is provided by using the generic
16688 LyX convertors mechanism.
16689 This support is provided in a
16690 \begin_inset Quotes eld
16694 \begin_inset Quotes erd
16697 way, i.e., you will be able to use this new LyX feature with some other literate
16698 programming tool of your choice by just changing your LyX preferences.
16701 \begin_layout Subsubsection
16702 Generating documents and code (weaving and tangling)
16705 \begin_layout Paragraph
16706 Selecting the document class
16709 \begin_layout Standard
16710 If you have installed Noweb and LyX successfully, whenever you open a new
16711 document or try to change the document class of an existing one, you will
16712 find that there are three new document classes available:
16715 \begin_layout Itemize
16719 \begin_layout Itemize
16723 \begin_layout Itemize
16727 \begin_layout Standard
16728 You must select one of them to create your literate documents from.
16732 \begin_layout Standard
16733 Note that literate documents are not limited to these three classes.
16734 New classes can be generated from other styles like letter or in combination
16735 with other class variations like Article (AMS).
16736 If you have special needs that cannot be covered by one of the existing
16737 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16738 will arrange to insert a new entry, or teach you how to do it.
16742 \begin_layout Plain Layout
16743 It is very simple, it involves the creation of a file with four lines, and
16744 re-running of the auto configuration.
16749 Moreover, if you use a literate tool other than Noweb you may need to create
16750 a new set of document classes for it.
16753 \begin_layout Paragraph
16757 \begin_layout Standard
16758 LyX enables you to write code with a layout named
16766 \begin_layout Plain Layout
16767 The equivalent Noweb term is
16768 \begin_inset Quotes eld
16772 \begin_inset Quotes erd
16776 For historical reasons, I got used to the term
16777 \begin_inset Quotes eld
16781 \begin_inset Quotes erd
16784 introduced by other literate tool named Nuweb, which I used for many years
16785 before rendering myself to Noweb.
16790 Noweb delimits scraps like this:
16793 \begin_layout LyX-Code
16797 \begin_layout LyX-Code
16801 \begin_layout LyX-Code
16805 \begin_layout LyX-Code
16809 \begin_layout LyX-Code
16813 \begin_layout Standard
16814 The problem is that whatever is written in between the << and the
16818 must be taken literally, i.e., LyX should be prevented from making any special
16819 interpretation of what has been written.
16820 This is handled by a special layout named Scrap, that works like a normal
16821 paragraph but has a free spacing capability.
16824 \begin_layout Standard
16825 The down side of the Scrap paragraph layout is that consecutive paragraphs
16826 of code will be spaced with one empty line in the source code and also
16827 in the printed documentation.
16828 The work around is to enter each line of code within a single Scrap, with
16829 a newline (ctrl-return).
16830 The example above will look like this:
16834 \begin_layout Plain Layout
16835 If you have a printed version of this document you will not see any difference
16836 between the previous example and this one.
16844 \begin_layout LyX-Code
16846 \begin_inset Newline newline
16850 \begin_inset Newline newline
16854 \begin_inset Newline newline
16858 \begin_inset Newline newline
16864 \begin_layout Standard
16865 This layout works fine.
16866 The only real inconvenience is that you have to type ctrl-return instead
16871 \begin_layout Plain Layout
16872 It is in my list of
16873 \begin_inset Quotes eld
16877 \begin_inset Quotes erd
16888 \begin_layout Standard
16889 As a special note, you can also use the
16890 \begin_inset Quotes eld
16894 \begin_inset Quotes erd
16897 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16901 \begin_layout LyX-Code
16903 \begin_inset Newline newline
16906 def some_function(args):
16907 \begin_inset Newline newline
16910 "This is the doc string for this function."
16911 \begin_inset Newline newline
16914 print "My args: ", args
16917 \begin_layout LyX-Code
16918 @ %def some_function
16921 \begin_layout Standard
16922 For an example of this usage and the resulting cross-reference output, look
16923 at the Literate python program in
16925 LIBDIR/examples/listerrors.lyx
16927 which should make this all clear.
16930 \begin_layout Paragraph
16931 Generating the documentation
16934 \begin_layout Standard
16935 At this point you already have a new document file with a proper document
16936 class, and with some code and text on it.
16937 How do I print it? The answer is simple, you select
16942 iew\SpecialChar \menuseparator
16950 Just like you would do for a plain document.
16951 No special procedure is required.
16954 \begin_layout Standard
16955 To help orientate you, I will now explain what happens inside LyX:
16958 \begin_layout Enumerate
16961 Update\SpecialChar \menuseparator
16964 menu option is chosen, a LaTeX file is generated.
16969 \begin_layout Standard
16970 If the document is of any literate class the generated file will be named
16971 with an extension name defined by the
16972 \begin_inset Quotes eld
16976 \begin_inset Quotes erd
16979 format (defined in the Preferences panel), otherwise the file will have
16988 \begin_layout Enumerate
16989 Note that the only difference so far is in the name of the file, no special
16990 processing is required by LyX.
16991 Given that you formatted the code using the Scrap layout that, by itself,
16992 takes care of the business.
16995 \begin_layout Enumerate
16996 If the document is of any literate class LyX will then use the internal
16997 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17001 \begin_layout Plain Layout
17002 The converters are defined in the
17004 Tools\SpecialChar \menuseparator
17008 \begin_inset Quotes eld
17012 \begin_inset Quotes erd
17024 manual for general information about converters.
17029 to generate the LaTeX file.
17033 \begin_layout Standard
17034 Otherwise it will just skip this step.
17038 \begin_layout Enumerate
17039 Finally, LaTeX is invoked and the regular post processing continues as in
17043 \begin_layout Standard
17044 Independence from a particular
17045 \begin_inset Quotes eld
17049 \begin_inset Quotes erd
17052 is easily achieved by changing the commands that are run by the various
17056 \begin_layout Paragraph
17057 Generating the code
17060 \begin_layout Standard
17061 When the build menu option is chosen or the corresponding button in the
17062 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17063 Next, LyX invokes the
17068 This converter needs to be defined by the user and is not installed by
17069 default, though the Program format is.
17070 This converter (like any other converter) will have two parts:
17073 \begin_layout Enumerate
17074 The converter program itself.
17075 This program performs the conversion from the one format to the other (in
17076 this case, from the Noweb format to the Program pseudo-format).
17079 \begin_layout Enumerate
17080 The error log parser.
17081 This is a program whose sole purpose is to rewrite error messages in a
17082 format that LyX understands.
17083 This makes it possible for LyX to place error boxes in the right places
17084 in the file buffer.
17087 \begin_layout Standard
17088 The first part, the
17089 \begin_inset Quotes eld
17093 \begin_inset Quotes erd
17096 setting, should be set to
17097 \begin_inset Quotes eld
17105 \begin_inset Quotes erd
17109 This basically means that LyX will call
17110 \begin_inset Quotes eld
17114 \begin_inset Quotes erd
17117 (a program or script) with the name of the Noweb file (normally a file
17118 in the LyX temp directory).
17122 \begin_layout Standard
17123 This is an implementation of
17124 \begin_inset Quotes eld
17128 \begin_inset Quotes erd
17131 that you can place in a directory on your path:
17134 \begin_layout LyX-Code
17138 \begin_layout LyX-Code
17142 \begin_layout LyX-Code
17143 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17146 \begin_layout Standard
17147 The next part of the converter setting is the
17148 \begin_inset Quotes eld
17152 \begin_inset Quotes erd
17155 which is to be set to
17156 \begin_inset Quotes eld
17161 parselog=listerrors
17164 \begin_inset Quotes erd
17168 This will run any errors that are generated by the
17169 \begin_inset Quotes eld
17173 \begin_inset Quotes erd
17176 process through the
17177 \begin_inset Quotes eld
17181 \begin_inset Quotes erd
17187 \begin_layout Standard
17188 The converter code looks in
17196 then on the path for the
17197 \begin_inset Quotes eld
17201 \begin_inset Quotes erd
17207 \begin_layout Standard
17208 The build will normally take place in LyX's temporary directory, so the
17209 files produced by the conversion will be in that directory.
17210 LyX will copy out what it regards as the `main' file, but the
17214 conversion may produce several files, and so most of these would then be
17215 deleted when LyX was closed.
17216 The present solution is to use a `copier',
17220 \begin_layout Plain Layout
17229 manual for information on these.
17238 script in its default mode, so that the entire contents of the temporary
17239 directory is copied.
17240 More will get copied than is needed, to be sure, but nothing will be lost.
17241 If, however, you know what extensions the generated files will have, this
17242 can be improved by using the
17251 This option takes a comma-separated list of extensions to copy.
17252 So, for example, if the conversion will generate only files with the extensions
17261 , then the correct definition would be:
17264 \begin_layout LyX-Code
17265 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17268 \begin_layout Standard
17269 The result will be that only files with these two extensions will be copied
17273 \begin_layout Paragraph
17274 Build instructions in the document
17277 \begin_layout Standard
17278 The last piece of the integration between LyX and noweb is the
17279 \begin_inset Quotes eld
17283 \begin_inset Quotes erd
17287 Generally, the instructions for building your program should be embedded
17288 in a scrap of its own.
17290 \begin_inset Quotes eld
17294 \begin_inset Quotes erd
17297 above uses the notangle command to look for this scrap (called
17298 \begin_inset Quotes eld
17302 \begin_inset Quotes erd
17305 ) and runs its contents through
17306 \begin_inset Quotes eld
17310 \begin_inset Quotes erd
17316 \begin_layout Standard
17317 Typically, such a scrap would look something like this:
17320 \begin_layout LyX-Code
17322 \begin_inset Newline newline
17326 \begin_inset Newline newline
17330 \begin_inset Newline newline
17333 if [ -z "${NOWEB_SOURCE}" ]
17334 \begin_inset Newline newline
17338 \begin_inset Newline newline
17341 NOWEB_SOURCE=myfile.nw
17342 \begin_inset Newline newline
17346 \begin_inset Newline newline
17350 code to extract files ...]
17351 \begin_inset Newline newline
17355 code to compile files ...]
17356 \begin_inset Newline newline
17362 \begin_layout Standard
17365 LIBDIR/examples/listerrors.lyx
17369 LIBDIR/examples/Literate.lyx
17371 which implement two versions of the
17372 \begin_inset Quotes eld
17376 \begin_inset Quotes erd
17379 program for some illustrations of how all of these pieces go together or
17382 LIBDIR/examples/noweb2lyx.lyx.
17385 Interestingly, these three files show off the language-indepence of the
17386 LyX literate programming support since they are written in Python, C and
17390 \begin_layout Subsubsection
17394 \begin_layout Standard
17395 All the Literate Programming support is configured by the
17400 ools\SpecialChar \menuseparator
17408 \begin_inset Quotes eld
17412 \begin_inset Quotes erd
17416 The important parts are:
17419 \begin_layout Description
17421 \begin_inset space ~
17425 \begin_inset Quotes eld
17429 \begin_inset Quotes erd
17433 \begin_inset space ~
17436 format Set up via the Formats tab, this is where the Noweb-specific pieces
17446 , the file extension is set to
17451 This tells LyX to create a file with a
17455 extension in the first step of the conversion process.
17458 \begin_layout Description
17460 \begin_inset space ~
17468 \begin_inset space ~
17471 format This is an empty format whose sole purpose is to be the endpoint
17472 of a conversion (which then allows us to set up a converter for it).
17475 \begin_layout Description
17484 This converter performs the
17485 \begin_inset Quotes eld
17489 \begin_inset Quotes erd
17492 of the literate document.
17493 For Noweb, it is set to
17494 \begin_inset Quotes eld
17499 noweave -delay -index $$i > $$o
17502 \begin_inset Quotes erd
17508 \begin_layout Description
17518 \begin_inset Quotes eld
17522 \begin_inset Quotes erd
17526 As stated above, the Converter is set to
17527 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17538 , with Flags set to
17539 \begin_inset Quotes eld
17544 originaldir,parselog=listerrors
17547 \begin_inset Quotes erd
17553 \begin_layout Subsubsection
17557 \begin_layout Standard
17558 There is also a new function implemented in the LyX server, the
17559 \begin_inset Quotes eld
17562 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17566 \begin_layout Standard
17567 When debugging code with ddd/gdb, it is possible to invoke a text editor
17568 at the current execution position with a single key stroke.
17569 The default ddd configuration for that is shift-ctrl-V.
17570 It happens that you can define the editor command line invocation in ddd
17576 dit\SpecialChar \menuseparator
17581 references\SpecialChar \menuseparator
17588 dialog and changing the "Edit Sources" entry.
17591 \begin_layout Standard
17592 I take advantage of the new created LyX server function and this ddd feature,
17594 \begin_inset Quotes eld
17598 \begin_inset Quotes erd
17604 \begin_layout LyX-Code
17605 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17608 \begin_layout Standard
17609 With this, whenever you are using ddd and find a point in the program that
17610 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17611 ddd you forward this information to LyX through the LyX server and then
17612 the LyX window will show the same file with the cursor at the same position
17613 ddd was pointing to.
17614 No more guessing or long scrolling to locate a point in the program back
17618 \begin_layout Standard
17619 Note however that you must enable the LyX server to get this feature working
17620 (it is disabled by default).
17621 You can enable it in
17633 ) by entering in the
17638 \begin_inset Quotes eld
17643 /home/<your-home-directory>/.lyx/lyxpipe
17646 \begin_inset Quotes erd
17652 \begin_layout Standard
17653 Read the LyX server documentation in the
17655 Customization Manual
17657 for further information.
17660 \begin_layout Subsubsection
17664 \begin_layout Standard
17665 There are six new buttons that can be added to your LyX toolbar.
17666 Five of these buttons are short cuts to layout styles:
17687 The last one is a short cut to the
17688 \begin_inset Quotes eld
17692 \begin_inset Quotes erd
17699 \begin_layout Standard
17700 LyX has a range of buttons that are available for tool bar customization.
17701 In my toolbar I like to combine the six short cuts above with two more:
17709 \SpecialChar \menuseparator
17717 \SpecialChar \menuseparator
17730 iew\SpecialChar \menuseparator
17738 Here is how it looks like:
17741 \begin_layout LyX-Code
17745 \begin_layout LyX-Code
17749 \begin_layout LyX-Code
17750 Icon "layout Standard"
17753 \begin_layout LyX-Code
17754 Icon "layout Section"
17757 \begin_layout LyX-Code
17758 Icon "layout LaTeX"
17761 \begin_layout LyX-Code
17762 Icon "layout LyX-Code"
17765 \begin_layout LyX-Code
17766 Icon "layout Scrap"
17769 \begin_layout LyX-Code
17773 \begin_layout LyX-Code
17777 \begin_layout LyX-Code
17778 Icon "buffer-typeset"
17781 \begin_layout LyX-Code
17782 Icon "build-program"
17785 \begin_layout LyX-Code
17789 \begin_layout LyX-Code
17793 \begin_layout LyX-Code
17797 \begin_layout LyX-Code
17801 \begin_layout LyX-Code
17805 \begin_layout Subsubsection
17806 Colors customization
17809 \begin_layout Standard
17810 There are a number of colors in LyX that can be customized in
17815 One of the things that bothers people is the LaTeX font color.
17816 The default color is red, since the scraps uses LaTeX font, and there is
17817 a lot of scraps in literate documents, you may get tired of seeing everything
17819 You can change it by going to the tabs
17828 \begin_layout Standard
17829 The next thing is the visible presence of the newline character in the screen.
17830 You can choose the color of this particular character and make it blend
17832 I recommend you choosing a color that is close to the background but not
17833 equal, that way you still can see it is there, but it is not bothering
17838 \begin_layout Chapter
17839 Secrets of the LaTeX Masters
17840 \begin_inset CommandInset label
17849 \begin_layout Standard
17850 Though LyX is a powerful tool, it cannot hope to support everything that
17851 can be done with pure TeX/LaTeX.
17852 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17853 as long as you are not afraid to use that
17854 \begin_inset Quotes eld
17858 \begin_inset Quotes erd
17861 button on the toolbar or add things to the LaTeX preamble.
17862 This section lists some tips, tricks, and otherwise cool ideas to give
17863 your document that extra little flair.
17866 Do try this at home
17868 , just start with something a little smaller and less important than your
17872 \begin_layout Standard
17873 Most ideas in this section require less common files in your LaTeX installation.
17874 If you have a system like teTeX, most will already be available.
17875 A few, however, will need to be downloaded from one of the CTAN archives.
17876 Often, there are several ways to do something, or several LaTeX style files
17877 which do the same thing.
17878 We do not endorse one choice over another, we simply claim that we have
17879 done a particular task with a particular file.
17880 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17883 \begin_layout Section
17887 \begin_layout Standard
17890 Lars Gullik Bjønnes
17893 \begin_layout Subsection
17897 \begin_layout Standard
17898 The aim for this chapter
17902 \begin_layout Plain Layout
17903 Editor's note: Lars' original chapter was a masterful description of how
17909 However, it was too long to flow smoothly in this document.
17910 I have therefore chosen to excerpt the most important sections here (sorry,
17911 Lars); you can read the original chapter (and more of the story!) in the
17914 examples/multicol.lyx
17922 is to show how the LaTeX package
17926 can be used in a LyX document.
17927 As LyX doesn't support the
17931 package natively yet, we have to use some small hacks.
17932 By reading this section it should be obvious how to do this.
17935 \begin_layout Subsection
17939 \begin_layout Standard
17944 package allows switching between one and multicolumn format on the same
17946 Footnotes are handled correctly (for the most part), but will be placed
17947 at the bottom of the page and not under each column.
17948 LaTeX's float mechanism, however, is partly disabled in the current implementat
17950 At the moment only page-wide floats can be used within the scope of the
17954 \begin_layout Subsection
17958 \begin_layout Subsubsection
17962 \begin_layout Standard
17963 If you want to have two columns in your text, you have use LaTeX mode to
17968 begin{multicols}{2}
17970 at the point where you want the two column layout to start, and then
17976 where you want it to end.
17980 \begin_layout Standard
17984 \begin_layout Plain Layout
17988 begin{multicols}{2}
17996 \begin_layout Standard
18001 The Adventure of the Empty House
18004 \begin_inset Newline newline
18009 Sir Arthur Conan Doyle
18012 \begin_layout Standard
18015 It was in the spring of the year 1894 that all London was interested, and
18016 the fashionable world dismayed, by the murder of the Honourable Ronald
18017 Adair under most unusual and inexplicable circumstances.
18018 The public has already learned those particulars of the crime which came
18019 out in the police investigation, but a good deal was suppressed upon that
18020 occasion, since the case for the prosecution was so overwhelmingly strong
18021 that it was not necessary to bring forward all the facts.
18022 Only now, at the end of nearly ten years, am I allowed to supply those
18023 missing links which make up the whole of that remarkable chain.
18024 The crime was of interest in itself, but that interest was as nothing to
18025 me compared to the inconceivable sequel, which afforded me the greatest
18026 shock and surprise of any event in my adventurous life.
18027 Even now, after this long interval, I find myself thrilling as I think
18028 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18029 ty which utterly submerged my mind.
18030 Let me say to that public, which has shown some interest in those glimpses
18031 which I have occasionally given them of the thoughts and actions of a very
18032 remarkable man, that they are not to blame me if I have not shared my knowledge
18033 with them, for I should have considered it my first duty to do so, had
18034 I not been barred by a positive prohibition from his own lips, which was
18035 only withdrawn upon the third of last month.
18038 \begin_layout Standard
18042 \begin_layout Plain Layout
18054 \begin_layout Subsubsection
18058 \begin_layout Standard
18059 The same pattern is used when you want more than two columns:
18062 \begin_layout Standard
18066 \begin_layout Plain Layout
18070 begin{multicols}{3}
18078 \begin_layout Standard
18081 It can be imagined that my close intimacy with Sherlock Holmes had interested
18082 me deeply in crime, and that after his disappearance I never failed to
18083 read with care the various problems which came before the public.
18084 And I even attempted, more than once, for my own private satisfaction,
18085 to employ his methods in their solution, though with indifferent success.
18086 There was none, however, which appealed to me like this tragedy of Ronald
18088 As I read the evidence at the inquest, which led up to a verdict of willful
18089 murder against some person or persons unknown, I realized more clearly
18090 than I had ever done the loss which the community had sustained by the
18091 death of Sherlock Holmes.
18092 There were points about this strange business which would, I was sure,
18093 have specially appealed to him, and the efforts of the police would have
18094 been supplemented, or more probably anticipated, by the trained observation
18095 and the alert mind of the first criminal agent in Europe.
18096 All day, as I drove upon my round, I turned over the case in my mind and
18097 found no explanation which appeared to me to be adequate.
18098 At the risk of telling a twice-told tale, I will recapitulate the facts
18099 as they were known to the public at the conclusion of the inquest.
18102 \begin_layout Standard
18106 \begin_layout Plain Layout
18118 \begin_layout Standard
18119 You can have more than 3 columns if you want to, but that might not be very
18120 pleasant for the eye.
18123 \begin_layout Subsubsection
18124 Columns inside columns
18127 \begin_layout Standard
18128 You can even have columns inside columns:
18131 \begin_layout Standard
18135 \begin_layout Plain Layout
18139 begin{multicols}{2}
18147 \begin_layout Standard
18150 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18151 at that time governor of one of the Australian colonies.
18152 Adair's mother had returned from Australia to undergo the operation for
18153 cataract, and she, her son Ronald, and her daughter Hilda were living together
18157 \begin_layout Standard
18161 \begin_layout Plain Layout
18165 begin{multicols}{2}
18173 \begin_layout Standard
18176 The youth moved in the best society--had, so far as was known, no enemies
18177 and no particular vices.
18178 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18179 had been broken off by mutual consent some months before, and there was
18180 no sign that it had left any very profound feeling behind it.
18181 For the rest {sic} the man's life moved in a narrow and conventional circle,
18182 for his habits were quiet and his nature unemotional.
18183 Yet it was upon this easy-going young aristocrat that death came, in most
18184 strange and unexpected form, between the hours of ten and eleven-twenty
18185 on the night of March 30, 1894.
18188 \begin_layout Standard
18192 \begin_layout Plain Layout
18204 \begin_layout Standard
18207 Ronald Adair was fond of cards--playing continually, but never for such
18208 stakes as would hurt him.
18209 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18210 It was shown that, after dinner on the day of his death, he had played
18211 a rubber of whist at the latter club.
18212 He had also played there in the afternoon.
18217 The evidence of those who had played with him-- Mr.
18218 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18219 and that there was a fairly equal fall of the cards.
18220 Adair might have lost five pounds, but not more.
18221 His fortune was a considerable one, and such a loss could not in any way
18223 He had played nearly every day at one club or other, but he was a cautious
18224 player, and usually rose a winner.
18225 It came out in evidence that, in partnership with Colonel Moran, he had
18226 actually won as much as four hundred and twenty pounds in a sitting, some
18227 weeks before, from Godfrey Milner and Lord Balmoral.
18228 So much for his recent history as it came out at the inquest.
18231 \begin_layout Standard
18235 \begin_layout Plain Layout
18247 \begin_layout Standard
18248 Please do read the file
18250 examples/multicol.lyx
18252 for more advanced examples including column and header spacing, vertical
18253 separator lines, and more.
18256 \begin_layout Section
18261 Paragraph Environment
18262 \begin_inset OptArg
18265 \begin_layout Plain Layout
18266 Numbering in Enumerate
18274 \begin_layout Standard
18280 \begin_layout Standard
18281 \begin_inset VSpace bigskip
18287 \begin_layout Standard
18289 The default numbering for the
18293 paragraph environment begins with Arabic numbers and ends with uppercase
18295 Suppose, however, you wanted a different type of numbering scheme.
18296 Here's a quickie example of how to change the numbering scheme:
18299 \begin_layout LyX-Code
18309 \begin_layout LyX-Code
18319 \begin_layout LyX-Code
18329 \begin_layout LyX-Code
18339 \begin_layout Standard
18340 \SpecialChar \ldots{}
18341 which changes the numbering scheme to uppercase Roman numerals, uppercase
18342 letters, Arabic numbers, and lowercase letter.
18345 \begin_layout Standard
18346 Additionally, the previous example also adds a little bit extra to the numbering
18348 For example, the first level label actually looks like:
18349 \begin_inset Quotes eld
18353 \begin_inset Quotes erd
18357 For ease of reading, we'll describe what the numbering schemes look like
18358 using a notation something like this: <
18359 \begin_inset Quotes eld
18363 \begin_inset Quotes erd
18367 \begin_inset space ~
18371 \begin_inset Quotes erd
18375 \begin_inset Quotes erd
18379 \begin_inset space ~
18383 \begin_inset Quotes erd
18387 \begin_inset Quotes erd
18391 \begin_inset space ~
18395 \begin_inset Quotes eld
18399 \begin_inset Quotes erd
18406 \begin_layout Standard
18407 As you can see in the example, there is a label command for each nesting
18414 \SpecialChar \ldots{}
18421 , as well as a counter,
18425 \SpecialChar \ldots{}
18431 There are also five
18432 \begin_inset Quotes eld
18436 \begin_inset Quotes erd
18469 , each of which take one counter as an argument.
18470 You can add characters before or after these, but there's no need to add
18474 \begin_layout Standard
18475 You can get really fancy with these.
18479 \begin_layout LyX-Code
18493 \begin_layout LyX-Code
18505 \begin_layout LyX-Code
18515 \begin_layout LyX-Code
18525 \begin_layout Standard
18526 produces the somewhat out of hand numbering scheme: <
18527 \begin_inset Quotes eld
18531 \begin_inset Quotes erd
18535 \begin_inset space ~
18539 \begin_inset Quotes erd
18543 \begin_inset Quotes erd
18547 \begin_inset space ~
18551 \begin_inset Quotes erd
18555 \begin_inset Quotes erd
18559 \begin_inset space ~
18563 \begin_inset Quotes eld
18567 \begin_inset Quotes erd
18574 \begin_layout Standard
18578 \begin_layout Section
18582 \begin_layout Standard
18588 \begin_layout Standard
18589 \begin_inset VSpace bigskip
18595 \begin_layout Standard
18600 \begin_layout Plain Layout
18606 tmpfont}{cmr17 scaled 2500}{
18618 \begin_layout Standard
18623 \begin_layout Plain Layout
18634 hose of you who like the style of old books probably also like
18635 \begin_inset Quotes eld
18639 \begin_inset Quotes erd
18642 ---those large capital letters which begin each new chapter or section.
18643 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18644 know some plain TeX!) but does require a lot of work and many iterations,
18645 as you can see by all the ugly TeX-mode stuff at the beginning of this
18649 \begin_layout Standard
18653 \begin_layout Plain Layout
18659 bigdrop{-1em}{3}{ptmri}{T}+
18664 here is a much easier way of doing this, of course.
18673 ) package from CTAN allows a simple way to add such letters to your documents.
18674 Since this package is not a standard part of teTeX, I can't demonstrate
18675 it within this document, but if you copy this paragraph to a new document,
18677 \begin_inset Quotes eld
18687 \begin_inset Quotes erd
18690 and the pluses from the TeX code at the beginning of the paragraph, and
18695 usepackage{dropcaps}
18697 to your LaTeX preamble, you will get a nice Times Roman Italic
18698 \begin_inset Quotes eld
18702 \begin_inset Quotes erd
18705 , whose height is three lines of text and which protrudes 1 em into the
18707 (Make certain you have copied
18708 \begin_inset Quotes eld
18716 \begin_inset Quotes erd
18719 into a directory where TeX can see it.) The first argument is the amount
18720 of indentation; in this case the negative sign moves it into the margin.
18721 The second argument is the height of the letter in number of lines of text.
18722 The third argument is the font name: virtually anything which has a tfm
18723 file should work (wade through the
18725 .../texmf/fonts/tfm
18727 directory for possibilities).
18728 My personal favorite is
18729 \begin_inset Quotes eld
18737 \begin_inset Quotes erd
18740 , a fancy German font specifically designed for dropped capitals.
18741 The fourth argument is the letter (or letters) to be dropped.
18746 package also offers the
18752 command, as well as a slightly simplified
18761 \begin_layout Section
18762 Non-standard Paragraph Shapes
18765 \begin_layout Standard
18771 \begin_layout Standard
18772 \begin_inset VSpace bigskip
18778 \begin_layout Standard
18782 \begin_layout Plain Layout
18794 \begin_layout Standard
18798 \begin_layout Plain Layout
18807 \begin_layout Plain Layout
18821 \begin_layout Standard
18826 \begin_layout Plain Layout
18837 \begin_layout Plain Layout
18846 \begin_layout Plain Layout
18855 \begin_layout Plain Layout
18864 \begin_layout Plain Layout
18873 \begin_layout Plain Layout
18882 \begin_layout Plain Layout
18891 \begin_layout Plain Layout
18900 \begin_layout Plain Layout
18909 \begin_layout Plain Layout
18918 \begin_layout Plain Layout
18927 \begin_layout Plain Layout
18936 \begin_layout Plain Layout
18945 \begin_layout Plain Layout
18954 \begin_layout Plain Layout
18963 \begin_layout Plain Layout
18972 \begin_layout Plain Layout
18981 \begin_layout Plain Layout
18990 \begin_layout Plain Layout
18999 \begin_layout Plain Layout
19005 There are times when the tyranny of rectangular paragraphs must be overthrown.
19006 In such situations, a call to the delightful plain TeX command
19013 As you can see, completely arbitrary shapes can be laid out with a suitable
19014 set of linelength definitions.
19015 While this parshape may look a bit silly and useless, one could conceive
19016 of situations such as finely tuned dropped capitals, word wrapping around
19017 non-rectangular graphics, etc.
19018 which will benefit from such handcrafting.
19021 \begin_layout Standard
19022 \begin_inset VSpace bigskip
19028 \begin_layout Standard
19033 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19040 is the number of lines of text which define the paragraph.
19041 If there turn out to be fewer lines, the shape is truncated; if there are
19042 more, the excess lines have the same dimensions as the last line of the
19052 entries specify the indentation of the line from the left margin, and the
19053 length of the line as measured from that point.
19054 The shape applies only to the current paragraph; everything is reset to
19055 normal for the next paragraph.
19058 \begin_layout Standard
19062 \begin_layout Plain Layout
19074 \begin_layout Section
19078 \begin_layout Standard
19079 As you can see, the examples in this section range from the useful to the
19081 While I don't expect that anyone will ever need the paragraph shape demonstrate
19082 d in the last section, the important point is that you can do almost anything
19083 you want in LyX if you are willing to figure out how to do it in TeX and
19085 TeX is a fantastically powerful typesetting system and all that power is
19086 available to you since LyX uses it as its backend.
projects / lyx.git / blob