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 manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual 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
48 \use_default_options false
56 InsetLayout CharStyle:MenuItem
65 \newcommand*{\menuitem}[1]{{\sffamily #1}}
73 \font_typewriter default
74 \font_default_family default
84 \pdf_title "LyX's Extended manual"
85 \pdf_author "LyX Team"
86 \pdf_subject "LyX's extended documentation"
87 \pdf_keywords "LyX, Documentation, Extended"
89 \pdf_bookmarksnumbered true
90 \pdf_bookmarksopen false
91 \pdf_bookmarksopenlevel 1
96 \pdf_pdfusetitle false
97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
104 \paperorientation portrait
107 \paragraph_separation indent
109 \quotes_language english
112 \paperpagestyle headings
113 \tracking_changes false
114 \output_changes false
122 Additional LyX Features
130 \begin_layout Plain Layout
132 Principal maintainer of this file is
137 If you have comments or error corrections, please send them to the LyX
138 Documentation mailing list,
139 \begin_inset Flex CharStyle:Code
142 \begin_layout Plain Layout
144 <lyx-docs@lists.lyx.org>
157 \begin_layout Standard
158 \begin_inset CommandInset toc
159 LatexCommand tableofcontents
166 \begin_layout Chapter
170 \begin_layout Standard
171 This manual is essentially Part II of the
173 User's Guide\SpecialChar \@.
176 The reason for separating this document out is simple: the
180 is already quite lengthy, and it contains information on all of the basic
181 features one needs to know in order to prepare most documents.
182 However, the LyX Team has worked to LyX extensible through various configuratio
183 n files and external packages.
184 That means that if you want to support the Fizzwizzle LaTeX package, you
185 can create a layout file (or module) for it without having to alter LyX
187 We've already had contributions of several new features this way.
188 This is the place where all of those get documented.
191 \begin_layout Standard
192 This manual also documents some special features, like fax support, version
193 control, and SGML support, which require additional software to work properly.
194 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
195 spruce up your documents by directly using the powerful features of LaTeX.
200 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
203 \begin_layout Standard
204 If you haven't read the
208 yet, you are definitely in the wrong manual.
213 is the first place to go, since it describes the notation and format of
215 You should also be thoroughly familiar with the
219 and all of the basic features of LyX before attempting to read this one.
222 \begin_layout Standard
223 Since all the topics in this manual depend heavily on LyX's interaction
224 with LaTeX, this first chapter covers the inner workings of LyX and how
225 to direct LyX to generate exactly the LaTeX code you want.
226 It is obviously for more seasoned LyX users.
229 \begin_layout Chapter
233 \begin_layout Section
237 \begin_layout Standard
238 This chapter is for both TeX-nicians and the LaTeX-curious.
239 In it, we'll explain how LyX and LaTeX work together to produce printable
241 This is the only place in any of the manuals where we assume you know something
245 \begin_layout Standard
246 At one time, LyX was called a
247 \begin_inset Quotes eld
250 WYSIWYM frontend to LaTeX,
251 \begin_inset Quotes erd
254 but that's no longer true.
255 There are frontends to LaTeX out there.
259 \begin_layout Plain Layout
260 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
261 There are also the LaTeX modes for vi and emacs, of course.
266 These are basically text editors with the ability to run LaTeX and mark
267 any errors in the file you're editing.
276 run LaTeX, and it also indicates errors in the file, it also does much,
278 For one thing, you don't need to know LaTeX to use LyX effectively.
279 And LyX has added its own extensions to LaTeX.
280 Try the following sometime: select
281 \begin_inset Flex CharStyle:MenuItem
284 \begin_layout Plain Layout
285 Export\SpecialChar \menuseparator
292 \begin_inset Flex CharStyle:MenuItem
295 \begin_layout Plain Layout
302 \begin_inset Flex CharStyle:MenuItem
305 \begin_layout Plain Layout
306 View\SpecialChar \menuseparator
312 ), then look at the preamble of the resulting
313 \begin_inset Flex CharStyle:Code
316 \begin_layout Plain Layout
323 You'll notice a variety of new macros defined specifically by LyX.
324 These macros are defined automatically, according to the features you use
328 \begin_layout Standard
329 There are several commands that automatically invoke LaTeX.
333 \begin_layout Itemize
334 \begin_inset Flex CharStyle:MenuItem
337 \begin_layout Plain Layout
338 View\SpecialChar \menuseparator
347 \begin_layout Itemize
348 \begin_inset Flex CharStyle:MenuItem
351 \begin_layout Plain Layout
352 View\SpecialChar \menuseparator
353 Update\SpecialChar \menuseparator
362 \begin_layout Itemize
363 \begin_inset Flex CharStyle:MenuItem
366 \begin_layout Plain Layout
367 File\SpecialChar \menuseparator
376 \begin_layout Itemize
377 \begin_inset Flex CharStyle:MenuItem
380 \begin_layout Plain Layout
381 File\SpecialChar \menuseparator
390 \begin_layout Standard
391 They will only invoke LaTeX if the file has changed since the last time
396 \begin_layout Standard
397 When LyX runs LaTeX on the file you're editing, it performs these steps:
400 \begin_layout Enumerate
401 Convert the document to LaTeX and save to a file with the extension
402 \begin_inset Flex CharStyle:Code
405 \begin_layout Plain Layout
412 \begin_inset Flex CharStyle:Code
415 \begin_layout Plain Layout
424 \begin_layout Enumerate
426 \begin_inset Flex CharStyle:Code
429 \begin_layout Plain Layout
435 file (maybe several times), and run any other commands (such as
436 \begin_inset Flex CharStyle:Code
439 \begin_layout Plain Layout
446 \begin_inset Flex CharStyle:Code
449 \begin_layout Plain Layout
455 ) needed to compile the LaTeX file.
458 \begin_layout Enumerate
459 If there are any errors, show the error log.
462 \begin_layout Standard
463 If you've run LaTeX using
464 \begin_inset Flex CharStyle:MenuItem
467 \begin_layout Plain Layout
470 \SpecialChar \menuseparator
478 , LyX then runs a DVI viewer to display the DVI-file.
480 \begin_inset Flex CharStyle:MenuItem
483 \begin_layout Plain Layout
486 \SpecialChar \menuseparator
494 , LyX performs further steps:
497 \begin_layout Itemize
499 \begin_inset Flex CharStyle:Code
502 \begin_layout Plain Layout
508 to convert the DVI file to PostScript.
511 \begin_layout Itemize
512 Run a PostScript viewer, such as
513 \begin_inset Flex CharStyle:Code
516 \begin_layout Plain Layout
522 , to display the PostScript file.
525 \begin_layout Standard
526 LyX does similar things when viewing, or exporting, other formats.
529 \begin_layout Section
530 Translating LaTeX files into LyX
533 \begin_layout Standard
534 You can import a LaTeX file into LyX by using the
535 \begin_inset Flex CharStyle:MenuItem
538 \begin_layout Plain Layout
539 File\SpecialChar \menuseparator
540 Import\SpecialChar \menuseparator
547 This will call a program named
548 \begin_inset Flex CharStyle:Code
551 \begin_layout Plain Layout
557 which will create a file
558 \begin_inset Flex CharStyle:Code
561 \begin_layout Plain Layout
568 \begin_inset Flex CharStyle:Code
571 \begin_layout Plain Layout
578 LyX will then open that file.
582 \begin_layout Plain Layout
583 \begin_inset Flex CharStyle:Code
586 \begin_layout Plain Layout
592 can also be run from the command line, of course.
600 \begin_layout Standard
601 \begin_inset Flex CharStyle:Code
604 \begin_layout Plain Layout
610 will translate most legal LaTeX, but not everything.
611 It will put things it doesn't understand into ERT, so after translating
613 \begin_inset Flex CharStyle:Code
616 \begin_layout Plain Layout
622 , you can look for ERT and hand-edit it until it looks right.
625 \begin_layout Standard
626 If you don't know what ERT is, read the next section.
629 \begin_layout Section
630 \begin_inset CommandInset label
632 name "sec:Inserting-TeX-Code"
636 Inserting TeX Code into LyX Documents
639 \begin_layout Standard
640 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
641 You can always insert TeX code into any LyX document.
642 LyX cannot, and will never be able to, display every possible LaTeX construct.
643 If ever you need to insert LaTeX commands into your LyX document, you can
645 \begin_inset Flex CharStyle:Code
648 \begin_layout Plain Layout
654 box, which you can insert into your document with
655 \begin_inset Flex CharStyle:MenuItem
658 \begin_layout Plain Layout
659 Insert\SpecialChar \menuseparator
668 \begin_layout Standard
669 Here's an example of inserting LaTeX commands in a LyX document.
670 The code looks like this:
673 \begin_layout LyX-Code
677 \begin_inset Newline newline
683 \begin_inset Newline newline
686 This is an example for a minipage environment.
688 \begin_inset Newline newline
691 can put nearly everything in it, even (non-floating)
692 \begin_inset Newline newline
697 \begin_inset Newline newline
703 \begin_inset Newline newline
707 \begin_inset Newline newline
713 \begin_inset Newline newline
719 \begin_inset Newline newline
725 \begin_inset Newline newline
730 \begin_inset Newline newline
736 \begin_inset Newline newline
742 \begin_inset Newline newline
748 \begin_inset Newline newline
756 \begin_layout LyX-Code
760 \begin_layout Standard
762 \begin_inset Flex CharStyle:Code
765 \begin_layout Plain Layout
771 box containing this text is directly after this paragraph.
772 Those of you reading the manual in LyX will only see the ERT inset.
773 Those reading a printed version of the manuals will see the actual results:
776 \begin_layout Standard
780 \begin_layout Plain Layout
787 \begin_layout Plain Layout
794 \begin_layout Plain Layout
796 This is an example for a minipage environment.
797 You can put nearly everything in it, even (non-floating) figures and tables.
801 \begin_layout Plain Layout
808 \begin_layout Plain Layout
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
827 \begin_layout Plain Layout
834 \begin_layout Plain Layout
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
854 \begin_layout Plain Layout
861 \begin_layout Plain Layout
873 \begin_layout Standard
874 In addition to using ERT, you can also create a separate file containing
875 some complex LaTeX structure and then use
876 \begin_inset Flex CharStyle:MenuItem
879 \begin_layout Plain Layout
880 Insert\SpecialChar \menuseparator
890 to include your file (you should select the type
891 \begin_inset Flex CharStyle:Code
894 \begin_layout Plain Layout
901 We recommend that you only do this if you have a
902 \begin_inset Flex CharStyle:Code
905 \begin_layout Plain Layout
916 Otherwise, you'll have a big job tracking down LaTeX errors.
919 \begin_layout Standard
920 There are a few last points to emphasize:
923 \begin_layout Itemize
928 check if your LaTeX code is correct.
931 \begin_layout Itemize
932 Beware reinventing the wheel.
935 \begin_layout Standard
936 On that last point, LyX does have quite a few features tucked into it, and
938 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
939 feature before you decide you have to do it by hand.
940 Moreover, there are numerous LaTeX packages out there to do all sorts of
941 things, from labels to envelopes to fancy multipage tables.
943 \begin_inset CommandInset href
946 target "http://www.ctan.org/"
950 for details, and see chapter
951 \begin_inset CommandInset ref
953 reference "cha:secrets"
960 \begin_layout Standard
961 If you do need to do some wild and fancy things within your document, be
962 sure to check out a good LaTeX book for assistance.
963 There are a number of them listed in the bibliography of the
970 \begin_layout Section
971 LyX and the LaTeX Preamble
974 \begin_layout Subsection
975 About the LaTeX Preamble
978 \begin_layout Standard
979 If you already know LaTeX, there is no need to explain here what the preamble
981 If you don't, the following will give you some ideas---we recommend again
982 that you consult a LaTeX book for further information.
983 In any case, you should read the points below, because they explain what
984 you can do and what you don't need to do in the LaTeX preamble of a LyX
988 \begin_layout Standard
989 The LaTeX preamble comes at the very beginning of a document,
997 \begin_layout Itemize
998 Declare the document class.
1000 \begin_inset Newline newline
1003 LyX already does this for you.
1004 If you're a seasoned LaTeX-nician, and you have a custom document class
1005 you want to use, check out the
1007 Customization Manual
1009 for information on how to make LyX interface to it.
1012 \begin_layout Itemize
1013 Declare the usage of packages.
1015 \begin_inset Newline newline
1018 LaTeX packages provide special commands, which are only available within
1019 a document when the package has been declared in the preamble.
1020 For example, the package
1021 \begin_inset Flex CharStyle:Code
1024 \begin_layout Plain Layout
1030 forces all paragraphs to be indented.
1031 There are other packages for labels, envelopes, margins, etc.
1035 \begin_layout Itemize
1036 Set counters, variables, lengths and widths.
1038 \begin_inset Newline newline
1041 There are several LaTeX counters and variables which
1045 be set globally from within the preamble in order to have the desired effect.
1046 (There are variables which you can set and reset inside the document, too.)
1047 Margins are a good example of something which must be set in the preamble.
1048 Another example is the label format for lists.
1049 You can actually set these just about anywhere, but it's best to do it
1050 just once, inside the preamble.
1053 \begin_layout Itemize
1054 Declare user defined commands (with
1055 \begin_inset Flex CharStyle:Code
1058 \begin_layout Plain Layout
1067 \begin_inset Flex CharStyle:Code
1070 \begin_layout Plain Layout
1079 \begin_inset Newline newline
1082 These are abbreviations for LaTeX commands which appear very often inside
1084 Although the preamble is a good place to declare such commands, they
1088 be declared anywhere (before they are used for the first time, of course).
1089 This can be useful if there is a lot of raw LaTeX code in your document,
1090 which normally should not be the case.
1093 \begin_layout Standard
1094 LyX adds its own set of definitions to the preamble of the
1095 \begin_inset Flex CharStyle:Code
1098 \begin_layout Plain Layout
1105 This makes LaTeX files generated by LyX portable.
1108 \begin_layout Subsection
1109 Changing the Preamble
1112 \begin_layout Standard
1113 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1114 can't change them without patching LyX itself.
1115 You can, however, add your own stuff to the preamble by selecting
1116 \begin_inset Flex CharStyle:MenuItem
1119 \begin_layout Plain Layout
1121 \begin_inset space ~
1130 \begin_inset Flex CharStyle:MenuItem
1133 \begin_layout Plain Layout
1134 Document\SpecialChar \menuseparator
1141 LyX adds anything in the
1142 \begin_inset Flex CharStyle:MenuItem
1145 \begin_layout Plain Layout
1151 dialog to its own built-in preamble.
1152 Before adding your own declarations in the preamble, you should make sure
1153 that LyX doesn't already support what you want to do.
1154 (Remember what we said about reinventing the wheel?) Also,
1156 make sure your preamble code is correct
1159 LyX doesn't check it for you.
1160 If there is an error, you're likely to get an error like
1161 \begin_inset Quotes eld
1165 \begin_inset Flex CharStyle:Code
1168 \begin_layout Plain Layout
1177 \begin_inset Quotes erd
1181 If you see this error, check your preamble.
1184 \begin_layout Subsection
1188 \begin_layout Standard
1189 Here are some examples of what you can add to a preamble, and what they
1193 \begin_layout Subsubsection
1197 \begin_layout Standard
1198 There are two variables under LaTeX that control page position:
1199 \begin_inset Flex CharStyle:Code
1202 \begin_layout Plain Layout
1211 \begin_inset Flex CharStyle:Code
1214 \begin_layout Plain Layout
1223 Their names should be self-explanatory.
1224 These variables are useful if you think for a moment about computer labels.
1225 Sometimes, the size of a print medium and the area of the medium that you
1226 can actually print on aren't the same.
1228 \begin_inset Flex CharStyle:Code
1231 \begin_layout Plain Layout
1240 \begin_inset Flex CharStyle:Code
1243 \begin_layout Plain Layout
1254 \begin_layout Standard
1255 The default values for
1256 \begin_inset Flex CharStyle:Code
1259 \begin_layout Plain Layout
1268 \begin_inset Flex CharStyle:Code
1271 \begin_layout Plain Layout
1280 \begin_inset space \thinspace{}
1284 \begin_inset space \space{}
1287 the page isn't shifted.
1288 Unfortunately, some DVI drivers always seem to shift the page.
1289 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1290 If you're using LyX on a system that you don't personally maintain, and
1291 your sysadmin is a doofus,
1292 \begin_inset Flex CharStyle:Code
1295 \begin_layout Plain Layout
1304 \begin_inset Flex CharStyle:Code
1307 \begin_layout Plain Layout
1316 Suppose you're left and top margins are always 0.5
1317 \begin_inset space \thinspace{}
1321 You can add this to the preamble:
1324 \begin_layout LyX-Code
1332 \begin_layout LyX-Code
1340 \begin_layout Standard
1341 and your margins should now be correct.
1344 \begin_layout Subsubsection
1348 \begin_layout Standard
1349 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1350 There's a rather nice package, available at your nearest CTAN archive,
1351 for printing sheets of labels:
1352 \begin_inset Flex CharStyle:Code
1355 \begin_layout Plain Layout
1362 Now, your system may not have this package installed by default.
1363 We leave that up to you to check.
1364 You'll also want to read the documentation for it; we're not going to do
1366 Since this is an example, however, we'll give you an example of how you
1370 \begin_layout Standard
1371 First, make sure you're using the
1372 \begin_inset Flex CharStyle:Code
1375 \begin_layout Plain Layout
1382 Next, you need to put the following in your preamble:
1385 \begin_layout LyX-Code
1391 \begin_layout LyX-Code
1397 \begin_layout LyX-Code
1403 \begin_layout LyX-Code
1409 \begin_layout LyX-Code
1415 \begin_layout LyX-Code
1421 \begin_layout LyX-Code
1427 \begin_layout Standard
1428 This sets things up for Avery label sheets, stock #5360.
1429 You're now ready to print labels, but you'll need to insert LaTeX code,
1430 placing the commands
1431 \begin_inset Flex CharStyle:Code
1434 \begin_layout Plain Layout
1443 \begin_inset Flex CharStyle:Code
1446 \begin_layout Plain Layout
1454 around each label text.
1455 This and other special features of
1456 \begin_inset Flex CharStyle:Code
1459 \begin_layout Plain Layout
1465 are explained in its documentation.
1468 \begin_layout Standard
1469 Someday, someone may write a LyX layout file to support this package directly.
1470 Maybe that someone is you.
1473 \begin_layout Subsubsection
1474 Example #3: Paragraph Indentation
1477 \begin_layout Standard
1478 Americans are trained to indent the first line of
1483 As with all of their other weird quirks, most Americans will whine and
1484 moan until they can have their way and indent the first line of all paragraphs.
1493 \begin_layout Standard
1494 Of course, this behavior isn't standard typography.
1495 In books, you typically only indent the first line of a paragraph
1499 it follows another one.
1500 The idea behind indenting the first line of a paragraph is to distinguish
1501 neighboring paragraphs from one another.
1502 If there is no previous paragraph---for example, if it follows a figure
1503 or is the first paragraph in a section---then there is no need for indentation.
1507 \begin_layout Standard
1508 If you're a typical American (we're still joking!), though, you don't care
1509 about such esoteric things; you want your indentation! Add this to the
1513 \begin_layout LyX-Code
1516 usepackage{indentfirst}
1519 \begin_layout Standard
1520 If your TeX distribution isn't braindead, you'll have this package, and
1521 all of your paragraphs will get the indentation the Founding Fathers intended
1525 \begin_layout Subsubsection
1526 Example #4: This Document
1529 \begin_layout Standard
1530 You can also check out the preamble of this document to get an idea of some
1531 of the advanced things you can do.
1532 Also, there are more examples and an assortment of LaTeX
1533 \begin_inset Quotes eld
1537 \begin_inset Quotes erd
1541 \begin_inset space ~
1545 \begin_inset CommandInset ref
1547 reference "cha:secrets"
1555 \begin_layout Section
1556 LyX and LaTeX Errors
1559 \begin_layout Standard
1560 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1562 It then uses the logfile from the LaTeX run to do a post-mortem.
1563 After analyzing the logfile,LyX displays a dialog listing the errors.
1564 Clicking on any one of them will take you to the position in your LyX file
1565 where the error occurred.
1569 \begin_layout Plain Layout
1571 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1573 There are also cases where LaTeX reports the error on one line, but the
1574 actual error is earlier.
1575 This is not unlike forgetting a closing brace in a program: You'll get
1576 an error, but only later.
1584 \begin_layout Standard
1585 Some folks also like to look at the log file directly: It is available from
1587 \begin_inset Flex CharStyle:MenuItem
1590 \begin_layout Plain Layout
1593 \SpecialChar \menuseparator
1597 \begin_inset space ~
1606 There are some fairly common error messages and warnings.
1607 We'll cover those here.
1608 You should look at a good LaTeX book for a complete listing.
1611 \begin_layout Itemize
1612 \begin_inset Flex CharStyle:Code
1615 \begin_layout Plain Layout
1622 \begin_inset Newline newline
1625 Anything beginning with these words is a warning message for the purpose
1627 \begin_inset Quotes eld
1631 \begin_inset Quotes erd
1634 the LaTeX code itself.
1635 You'll get messages like this if you added or changed cross-references
1636 or bibliography entries, in which case, LaTeX is trying to tell you that
1637 you need to make another run.
1638 You can by-and-large ignore these.
1641 \begin_layout Itemize
1642 \begin_inset Flex CharStyle:Code
1645 \begin_layout Plain Layout
1652 \begin_inset Newline newline
1655 Another warning message, this time about fonts which LaTeX couldn't find.
1656 The rest of the message will often say something about a replacement font
1658 You can safely ignore these, too.
1661 \begin_layout Itemize
1662 \begin_inset Flex CharStyle:Code
1665 \begin_layout Plain Layout
1674 \begin_inset Newline newline
1682 They are warnings about lines that were too long and run past the right
1684 Almost always, this is unnoticeable in the final output.
1685 (It can be just a point or two.) Or, only one or two characters extend past
1687 LaTeX seems to generate at least one of these messages for just about any
1689 \begin_inset Newline newline
1692 You can ignore these messages.
1693 Your eyes will tell you if there's a problem with something that's too
1694 wide; just look at the output.
1698 \begin_layout Plain Layout
1699 You can also enable the `draft' option in
1700 \begin_inset Flex CharStyle:MenuItem
1703 \begin_layout Plain Layout
1706 \SpecialChar \menuseparator
1714 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1722 \begin_layout Itemize
1723 \begin_inset Flex CharStyle:Code
1726 \begin_layout Plain Layout
1735 \begin_inset Newline newline
1738 Not quite as common as its cousin.
1739 LaTeX seems to like to print lines that are a bit too wide as opposed to
1740 ones that are a bit too narrow.
1741 We have no idea why.
1744 \begin_layout Itemize
1745 \begin_inset Flex CharStyle:Code
1748 \begin_layout Plain Layout
1757 \begin_inset Flex CharStyle:Code
1760 \begin_layout Plain Layout
1769 \begin_inset Newline newline
1772 Warnings about troubles breaking the page.
1773 Once again, just look at the output.
1774 Your eyes will tell you where something has gone wrong.
1777 \begin_layout Itemize
1778 \begin_inset Flex CharStyle:Code
1781 \begin_layout Plain Layout
1783 \begin_inset Quotes els
1787 \begin_inset Quotes ers
1796 \begin_inset Newline newline
1800 \begin_inset Quotes eld
1804 \begin_inset Quotes erd
1807 isn't installed on this system.
1808 This usually appears because some package your document needs isn't installed.
1809 If you didn't touch the preamble or didn't use the
1810 \begin_inset Flex CharStyle:Code
1813 \begin_layout Plain Layout
1821 command, then one of the packages LyX tried to load is missing.
1823 \begin_inset Flex CharStyle:MenuItem
1826 \begin_layout Plain Layout
1827 Help\SpecialChar \menuseparator
1833 to get a list of packages that LyX knows about.
1834 This file is updated whenever you reconfigure LyX (using
1835 \begin_inset Flex CharStyle:MenuItem
1838 \begin_layout Plain Layout
1839 Tools\SpecialChar \menuseparator
1845 ) and tells you which packages have been detected and what they do.
1846 \begin_inset Newline newline
1850 \begin_inset Flex CharStyle:Code
1853 \begin_layout Plain Layout
1861 command and the package in question isn't installed, then you'll need to
1862 install it yourself.
1865 \begin_layout Itemize
1866 \begin_inset Flex CharStyle:Code
1869 \begin_layout Plain Layout
1870 LaTeX Error: Unknown option
1876 \begin_inset Newline newline
1879 Error messages beginning with this are trying to tell you that you specified
1880 a bad or undefined option to a package.
1881 Check the package's documentation.
1884 \begin_layout Itemize
1885 \begin_inset Flex CharStyle:Code
1888 \begin_layout Plain Layout
1889 Undefined control sequence
1895 \begin_inset Newline newline
1898 If you've inserted LaTeX code into your document, but made a typo, you'll
1900 You may have forgotten to load a package.
1901 In any case, this error message usually means that you used an undefined
1906 \begin_layout Standard
1907 There are other error and warning messages.
1908 Some are self-explanatory.
1909 These are usually LaTeX messages.
1910 Others are downright cryptic.
1911 These are usually TeX error messages, and we really have
1915 what they mean or how to decipher them.
1919 \begin_layout Standard
1920 There's a general sequence you should follow if you get error messages:
1923 \begin_layout Enumerate
1924 Look at the LaTeX code you inserted for typos.
1927 \begin_layout Enumerate
1928 If there are no typos, check that you used the command(s) correctly.
1931 \begin_layout Enumerate
1932 If you get a bunch of error boxes piled up at the very top of the document---and
1933 especially if you see a
1934 \begin_inset Quotes eld
1938 \begin_inset Flex CharStyle:Code
1941 \begin_layout Plain Layout
1950 \begin_inset Quotes erd
1953 error---it means that there are errors in the preamble.
1954 Start debugging your preamble.
1957 \begin_layout Enumerate
1958 If you didn't add anything to the preamble and didn't add any LaTeX code
1959 to the document, the first suspect is your LaTeX distribution itself.
1960 Check for missing packages and install them.
1963 \begin_layout Enumerate
1964 Okay, so there are no missing packages.
1965 Did you use any of the fine-tuning options in LyX? Specifically, did you
1970 any of them, like trying to manually insert lots of
1971 \begin_inset Flex CharStyle:Code
1974 \begin_layout Plain Layout
1976 \begin_inset space ~
1985 \begin_inset Flex CharStyle:Code
1988 \begin_layout Plain Layout
1995 \begin_inset Flex CharStyle:Code
1998 \begin_layout Plain Layout
2004 ? Did you try to kludge something together with these instead of using the
2005 appropriate paragraph environment?
2008 \begin_layout Enumerate
2009 All right, you didn't use any of the fine-tuning options, you played by
2011 Did you try to pull a fancy maneuver? Did you do something funky inside
2012 a table or an equation, like inserting a graphic into a table cell?
2015 \begin_layout Enumerate
2016 Do you have long sections of text where LaTeX cannot find a place to break
2017 a line? By default, LaTeX is rather strict about how much extra inter-word
2018 spacing it will add in order to break a line.
2019 Preferably, you should rework the paragraph to avoid the problem.
2020 If this isn't an option, you can wrap your text in
2021 \begin_inset Flex CharStyle:Code
2024 \begin_layout Plain Layout
2032 to make LaTeX's line breaking more, well, sloppy.
2035 \begin_layout Enumerate
2036 Did you go overboard with the nesting? LyX (currently) doesn't check to
2037 make sure you're in the limits for nesting environments.
2038 If you nested a bunch of environments to the
2039 \begin_inset Formula $17^{\mathrm{th}}$
2042 level, that's the problem.
2043 (The limit in LaTeX is five.)
2046 \begin_layout Enumerate
2047 Okay, you didn't get any error messages, but your output looks awful.
2048 If you have a table or figure that's too wide or long for the page, you
2053 \begin_layout Enumerate
2054 rescale the figure so it fits.
2057 \begin_layout Enumerate
2058 trim down the table so it fits.
2062 \begin_layout Enumerate
2063 If something else is wrong with the output, and you didn't try to pull anything
2064 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2067 \begin_layout Standard
2068 If all this doesn't help---well, then
2072 you might have found a bug in LyX\SpecialChar \ldots{}
2076 \begin_layout Chapter
2080 \begin_layout Section
2081 Customizing Bibliographies with BibTeX
2084 \begin_layout Standard
2085 The basics how to use BibTeX are explained in section
2087 Bibliography databases (BibTeX)
2094 The following subsections explain special bibliography features supported
2098 \begin_layout Subsection
2099 Alternative Citation Styles
2102 \begin_layout Standard
2103 Standard BibTeX uses numbers (e.g.
2104 \begin_inset space \space{}
2108 \begin_inset Quotes eld
2112 \begin_inset Quotes erd
2115 ) to refer to a cited work.
2116 However, in many scientific disciplines, other citation styles are in use.
2117 The most common one is the author-year style (e.g.
2118 \begin_inset space \space{}
2122 \begin_inset Quotes eld
2126 \begin_inset Quotes erd
2130 LyX supports two packages that provide this style,
2131 \begin_inset Flex CharStyle:Code
2134 \begin_layout Plain Layout
2141 \begin_inset Flex CharStyle:Code
2144 \begin_layout Plain Layout
2151 Both packages have their pros and cons, which cannot be listed in detail.
2152 If you only want to have simple author-year (or author-numerical) style,
2153 or if you want to use one of the countless style files for
2154 \begin_inset Flex CharStyle:Code
2157 \begin_layout Plain Layout
2163 , than the established
2164 \begin_inset Flex CharStyle:Code
2167 \begin_layout Plain Layout
2173 package is probably your choice.
2174 If you need special features like short title references, ibidem etc., you
2176 \begin_inset Flex CharStyle:Code
2179 \begin_layout Plain Layout
2188 \begin_layout Standard
2189 The handling of both packages in LyX is basically the same.
2191 \begin_inset Flex CharStyle:MenuItem
2194 \begin_layout Plain Layout
2195 Document\SpecialChar \menuseparator
2202 \begin_inset Flex CharStyle:MenuItem
2205 \begin_layout Plain Layout
2212 \begin_inset Flex CharStyle:MenuItem
2215 \begin_layout Plain Layout
2222 \begin_inset Flex CharStyle:MenuItem
2225 \begin_layout Plain Layout
2232 With both packages, you will get some extra features in the citation dialog
2233 and you can select the style of the reference (
2234 \begin_inset Quotes eld
2238 \begin_inset Quotes erd
2242 \begin_inset Quotes eld
2246 \begin_inset Quotes erd
2250 \begin_inset Quotes eld
2254 \begin_inset Quotes erd
2258 \begin_inset Quotes eld
2262 \begin_inset Quotes erd
2266 Note that both packages need specifically designed style files.
2267 They both ship their own, but there are lots of additional style files,
2268 and there is even an interactive style file builder
2272 \begin_layout Plain Layout
2274 \begin_inset Flex URL
2277 \begin_layout Plain Layout
2279 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2290 \begin_inset Flex CharStyle:Code
2293 \begin_layout Plain Layout
2302 \begin_layout Subsection
2303 Sectioned Bibliographies
2306 \begin_layout Standard
2307 Sometimes you might need to divide your bibliography into several sections.
2308 If you are for instance a historian, the possibility to separate sources
2309 and scientific works is most likely a
2310 \begin_inset Quotes eld
2314 \begin_inset Quotes erd
2318 Unfortunately, BibTeX itself does not allow you to do this.
2319 But with the help of some LaTeX packages, BibTeX can be extended to fit
2323 \begin_layout Standard
2324 LyX provides native support for one of these packages,
2332 \begin_layout Plain Layout
2334 \begin_inset Flex URL
2337 \begin_layout Plain Layout
2339 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2349 The advantage of this package (compared to other packages like
2353 ) is that you don't need to define new citation commands.
2354 Instead, you need to prepare different bibliographic databases which include
2355 the entries for the different sections of the bibliography.
2356 For example: If you want to divide your bibliography into the sections
2358 \begin_inset Quotes eld
2362 \begin_inset Quotes erd
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2373 , you first need to create two bibliographic databases, e.g.
2374 \begin_inset space \space{}
2378 \begin_inset Flex CharStyle:Code
2381 \begin_layout Plain Layout
2388 \begin_inset Flex CharStyle:Code
2391 \begin_layout Plain Layout
2401 \begin_layout Standard
2403 \begin_inset Flex CharStyle:MenuItem
2406 \begin_layout Plain Layout
2407 Document\SpecialChar \menuseparator
2414 \begin_inset Flex CharStyle:MenuItem
2417 \begin_layout Plain Layout
2424 \begin_inset Flex CharStyle:MenuItem
2427 \begin_layout Plain Layout
2428 Sectioned bibliography
2434 Now you can insert multiple BibTeX bibliographies, one for each section
2435 of your bibliography.
2436 Returning to our example: Insert the BibTeX bibliography
2437 \begin_inset Flex CharStyle:Code
2440 \begin_layout Plain Layout
2446 and a second one for the database
2447 \begin_inset Flex CharStyle:Code
2450 \begin_layout Plain Layout
2457 You are free to use the same or different styles for each section.
2458 Additionally, you can chose if the bibliography section should contain
2460 \begin_inset Quotes eld
2463 all cited references
2464 \begin_inset Quotes erd
2467 of the specified database(s) (which is the default),
2468 \begin_inset Quotes eld
2471 all uncited references
2472 \begin_inset Quotes erd
2476 \begin_inset Quotes eld
2480 \begin_inset Quotes erd
2484 This might be useful if you would like to separate your bibliography into
2486 \begin_inset Quotes eld
2490 \begin_inset Quotes erd
2494 \begin_inset Quotes eld
2498 \begin_inset Quotes erd
2502 \begin_inset Quotes eld
2506 \begin_inset Quotes erd
2510 The titles for the sections can be added as ordinary sections or subsections.
2512 \begin_inset Flex CharStyle:Code
2515 \begin_layout Plain Layout
2521 removes the bibliography title, you have manually re-add that, too (as
2522 a chapter* or section*, for instance).
2525 \begin_layout Subsection
2526 Multiple Bibliographies
2529 \begin_layout Standard
2530 Multiple bibliographies, e.g.
2531 \begin_inset space \space{}
2534 a bibliography for each section or chapter of the document, are not supported
2537 \begin_inset Flex CharStyle:Code
2540 \begin_layout Plain Layout
2546 package, which is used for the creation of sectioned bibliographies in
2547 LyX (see the previous section), provides an easy way to solve this task,
2548 if you are willing to use some
2549 \begin_inset Flex CharStyle:MenuItem
2552 \begin_layout Plain Layout
2559 \begin_inset space ~
2563 \begin_inset CommandInset ref
2565 reference "sec:Inserting-TeX-Code"
2573 \begin_layout Plain Layout
2574 An alternative approach is to use the
2575 \begin_inset Flex CharStyle:Code
2578 \begin_layout Plain Layout
2585 \begin_inset Flex CharStyle:Code
2588 \begin_layout Plain Layout
2594 package, respectively.
2602 \begin_layout Standard
2604 \begin_inset Flex CharStyle:MenuItem
2607 \begin_layout Plain Layout
2608 Document\SpecialChar \menuseparator
2615 \begin_inset Flex CharStyle:MenuItem
2618 \begin_layout Plain Layout
2625 \begin_inset Flex CharStyle:MenuItem
2628 \begin_layout Plain Layout
2629 Sectioned bibliography
2635 In the document, you have to enclose the sections, which shall contain
2636 their own bibliography (including the BibTeX bibliography itself), between
2638 \begin_inset Flex CharStyle:Code
2641 \begin_layout Plain Layout
2650 \begin_inset Flex CharStyle:Code
2653 \begin_layout Plain Layout
2661 (those commands have to be inserted as ERT).
2662 The bibliography will contain all references which have been cited in the
2664 \begin_inset Flex CharStyle:Code
2667 \begin_layout Plain Layout
2678 If you are using this approach, then every citation reference has to be
2680 \begin_inset Flex CharStyle:Code
2683 \begin_layout Plain Layout
2691 \begin_inset Flex CharStyle:Code
2694 \begin_layout Plain Layout
2703 \begin_layout Section
2707 \begin_layout Subsection
2711 \begin_layout Standard
2712 When you are working on a large file with many sections, it is often convenient
2713 to break up the document into several files, or perhaps you have something
2714 where a table may change from time to time, but the preceding text does
2716 In these cases, you should seriously consider using multipart documents.
2717 For example, scientific papers often have five major sections: the introduction
2718 , observations, results, discussion, and conclusion.
2719 Each of these could be its own separate LyX file, with one
2720 \begin_inset Quotes eld
2724 \begin_inset Quotes erd
2727 file which contains the title, authors, abstract, references, etc., plus
2728 the five included files.
2729 It is important to note that each of these files is a full LyX file which
2730 can be formatted and printed on its own, as well as included in a master
2732 Each of these files must have the same document class, however---don't
2733 attempt to mix book classes with article classes.
2734 You may also include LaTeX files; however, these files must not have their
2736 \begin_inset space \space{}
2739 everything up to and including the
2740 \begin_inset Flex CharStyle:Code
2743 \begin_layout Plain Layout
2752 \begin_inset Flex CharStyle:Code
2755 \begin_layout Plain Layout
2763 line must be deleted) or else errors will be generated when you try to
2767 \begin_layout Standard
2768 LyX allows you to include files quite easily with
2769 \begin_inset Flex CharStyle:MenuItem
2772 \begin_layout Plain Layout
2773 Insert\SpecialChar \menuseparator
2775 \begin_inset space ~
2784 When you click on this selection a small box is inserted into the file
2785 at the current cursor location.
2786 Clicking on the box raises a dialog which allows you to select the file
2787 to be included, and the method of its inclusion.
2791 \begin_layout Standard
2792 The file selection box should by now be obvious.
2793 The three inclusion methods are
2794 \begin_inset Quotes eld
2798 \begin_inset Quotes erd
2802 \begin_inset Quotes eld
2806 \begin_inset Quotes erd
2810 \begin_inset Quotes eld
2814 \begin_inset Quotes erd
2818 The difference between
2819 \begin_inset Quotes eld
2823 \begin_inset Quotes erd
2827 \begin_inset Quotes eld
2831 \begin_inset Quotes erd
2834 is really only meaningful to LaTeXperts, but the practical difference is
2835 that files which are
2836 \begin_inset Quotes eld
2840 \begin_inset Quotes erd
2843 are typeset beginning on a new page, while files which are
2844 \begin_inset Quotes eld
2848 \begin_inset Quotes erd
2851 are typeset starting on the current page.
2854 \begin_layout Standard
2855 Generally, the master file is converted into a full LaTeX file before typesettin
2856 g, while the included files are converted to LaTeX files which do not have
2857 all the preamble information.
2860 \begin_layout Standard
2862 \begin_inset Quotes eld
2866 \begin_inset Quotes erd
2869 included file allows you to include a file typeset exactly as it appears
2871 \begin_inset space \space{}
2875 \begin_inset Flex CharStyle:Code
2878 \begin_layout Plain Layout
2884 mode, with the characters set in a fixed-width typewriter font.
2885 Normally, spaces in this file are invisible, though two consecutive spaces
2886 are conserved, unlike LyX's normal treatment of spaces.
2887 However, setting the
2888 \begin_inset Flex CharStyle:MenuItem
2891 \begin_layout Plain Layout
2893 \begin_inset space ~
2897 \begin_inset space ~
2901 \begin_inset space ~
2909 checkbox typesets a mark to unambiguously define the presence of a space.
2913 \begin_layout Subsection
2914 Cross-References Between Files
2917 \begin_layout Standard
2918 \begin_inset Box Shadowbox
2927 height_special "totalheight"
2930 \begin_layout Plain Layout
2931 This section is somewhat out of date.
2932 Need to describe default master documents and how children are opened when
2942 \begin_layout Standard
2943 It is possible to set up cross-references between the different files.
2944 First, open all the files in question: let's call them A and B in a two
2945 file example, where B is included in A.
2946 Let's say you insert a label in A, then want to reference it in B.
2947 Open the cross-reference dialog in whilst in document B, and you can select
2949 \begin_inset Quotes eld
2953 \begin_inset Quotes erd
2959 \begin_layout Subsection
2960 Bibliography Lists in all Subdocuments
2963 \begin_layout Standard
2964 \begin_inset Box Frameless
2973 height_special "totalheight"
2976 \begin_layout Plain Layout
2977 This section also needs updating.
2978 There is now material about this on the wiki, and it could be copied here.
2986 \begin_layout Standard
2987 Copy the bibliography list with all entries to all subdocuments and transform
2989 This way LyX will find the
2990 \begin_inset Flex CharStyle:Code
2993 \begin_layout Plain Layout
2999 -files and you can easily insert references without making the bibliography
3003 \begin_layout Standard
3004 As the bibliography list is in a comment, LaTeX won't use use it and the
3005 references will look like this: [?], instead of like this: [1].
3006 One solution is to use the LaTeX-package
3007 \begin_inset Flex CharStyle:Code
3010 \begin_layout Plain Layout
3016 that will only include comments by processing the files separately.
3017 To do this, add in the LaTeX preamble of every subdocument the following:
3020 \begin_layout LyX-Code
3026 \begin_layout LyX-Code
3029 includecomment{comment}
3032 \begin_layout Standard
3034 \begin_inset Flex URL
3037 \begin_layout Plain Layout
3039 http://wiki.lyx.org/FAQ/Unsorted#toc31
3047 \begin_layout Section
3048 Fancy Headers and Footers
3051 \begin_layout Standard
3052 The default page layout is rather plain; for an
3053 \begin_inset Flex CharStyle:Code
3056 \begin_layout Plain Layout
3062 document class, all you get is a centered page number at the bottom of
3064 This document uses KOMA-script's book class, so it appears to be a bit
3066 But to really put on a show, you need to set the document page style to
3068 \begin_inset Quotes eld
3072 \begin_inset Quotes erd
3075 , as mentioned in the
3080 This section describes the LaTeX code you need to insert in your LaTeX
3081 preamble in order to get the desired effects.
3084 \begin_layout Standard
3085 The page header is divided into three fields, not surprisingly labeled
3086 \begin_inset Quotes eld
3090 \begin_inset Quotes erd
3094 \begin_inset Quotes eld
3098 \begin_inset Quotes erd
3102 \begin_inset Quotes eld
3106 \begin_inset Quotes erd
3110 The footer is also divided into these three fields.
3111 The LaTeX commands to set these fields in the simplest manner are
3112 \begin_inset Flex CharStyle:Code
3115 \begin_layout Plain Layout
3124 \begin_inset Flex CharStyle:Code
3127 \begin_layout Plain Layout
3136 \begin_inset Flex CharStyle:Code
3139 \begin_layout Plain Layout
3148 \begin_inset Flex CharStyle:Code
3151 \begin_layout Plain Layout
3160 Suppose you wish to put your name in the upper left hand corner of each
3162 Simply insert the following command in the preamble:
3165 \begin_layout Standard
3174 \begin_layout Standard
3175 You will now see your name in the upper left.
3176 If a field has a default entry that you would like to get rid of (often
3177 the page number appears in the central footer, simply include a command
3178 with a blank argument, e.g.:
3181 \begin_layout Standard
3189 \begin_layout Standard
3190 Let's get really fancy: lets put the section number with the word
3191 \begin_inset Quotes eld
3195 \begin_inset Quotes erd
3199 \begin_inset space \space{}
3202 Section 3) in the upper left, the page number (e.g.
3203 \begin_inset space \space{}
3206 Page 4) in the upper right, your name in the lower left, and the date in
3208 The following commands should now appear in the preamble:
3211 \begin_layout Standard
3221 \begin_layout Standard
3229 \begin_layout Standard
3239 \begin_layout Standard
3248 \begin_layout Standard
3256 \begin_layout Standard
3266 \begin_layout Standard
3268 \begin_inset Flex CharStyle:Code
3271 \begin_layout Plain Layout
3280 \begin_inset Flex CharStyle:Code
3283 \begin_layout Plain Layout
3291 access LaTeX's section and page counters, and so print out the current
3292 section and page numbers.
3294 \begin_inset Flex CharStyle:Code
3297 \begin_layout Plain Layout
3305 simply prints out today's date.
3308 \begin_layout Standard
3309 The thicknesses of the horizontal rules drawn beneath the header and above
3310 the footer can also be modified.
3311 If you don't want one of the rules, set its thickness to 0.
3312 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3318 \begin_inset Flex CharStyle:Code
3321 \begin_layout Plain Layout
3326 headrulewidth}{0.4pt}
3332 \begin_inset Flex CharStyle:Code
3335 \begin_layout Plain Layout
3340 footrulewidth}{0.4pt}
3345 to set the thicknesses.
3348 \begin_layout Standard
3349 You can switch the header/footer settings on and off for individual pages
3351 \begin_inset Flex CharStyle:Code
3354 \begin_layout Plain Layout
3357 thispagestyle{empty}
3363 \begin_inset Flex CharStyle:Code
3366 \begin_layout Plain Layout
3369 thispagestyle{plain}
3375 \begin_inset Flex CharStyle:Code
3378 \begin_layout Plain Layout
3381 thispagestyle{fancy}
3387 Simply insert them in the text on the page you want changed and mark them
3389 In fact, title pages are marked as plain by default, while following pages
3390 are marked fancy when using the global fancy setting.
3393 \begin_layout Standard
3394 There are more complex commands which will let you insert things in the
3395 upper left on odd numbered pages, etc., but we will refer you to the
3396 \begin_inset Flex CharStyle:Code
3399 \begin_layout Plain Layout
3405 package documentation for more information.
3407 \begin_inset Flex CharStyle:Code
3410 \begin_layout Plain Layout
3419 \begin_layout Standard
3420 As a final example, it is possible to include an image in the header or
3422 Suppose you want to put a company logo in the upper lefthand corner.
3423 You might try something like
3426 \begin_layout Standard
3435 includegraphics{logo.eps}}}
3438 \begin_layout Standard
3440 (you may need to preface this with
3441 \begin_inset Flex CharStyle:Code
3444 \begin_layout Plain Layout
3448 usepackage{graphics}
3453 if you don't include graphics elsewhere in your document).
3456 \begin_layout Section
3457 Itemize Bullet Selection
3458 \begin_inset CommandInset label
3467 \begin_layout Standard
3473 \begin_layout Subsection
3477 \begin_layout Standard
3478 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3479 Using this dialog you can easily specify what bullet shape to use at each
3480 level of an itemized list.
3481 These settings are document-wide so you won't be able to specify different
3482 sets of bullets for different paragraphs.
3486 \begin_layout Plain Layout
3487 Well, actually you can but you'll have to do it by hand.
3495 \begin_layout Subsection
3499 \begin_layout Standard
3500 Open the dialog by selecting the
3501 \begin_inset Flex CharStyle:MenuItem
3504 \begin_layout Plain Layout
3505 Document\SpecialChar \menuseparator
3511 menu item and then select the
3512 \begin_inset Flex CharStyle:MenuItem
3515 \begin_layout Plain Layout
3524 \begin_layout Standard
3525 The dialog provides you with a table of bullet shapes.
3526 A column of buttons on the left of the table provides access to the six
3527 different panels of bullet shapes.
3528 The row of buttons across the top is used to select which bullet depth
3530 A text entry under the table shows the currently selected bullet shape's
3531 LaTeX equivalent and this can be edited if desired.
3532 If you do modify the text you will also need to specify any needed packages
3533 in the LaTeX preamble.
3536 \begin_layout Standard
3537 The six panels are divided up by the packages they require.
3538 The following table shows the mappings from button name to LaTeX packages.
3541 \begin_layout Standard
3543 \begin_inset Tabular
3544 <lyxtabular version="3" rows="7" columns="2">
3546 <column alignment="center" valignment="top" width="0pt">
3547 <column alignment="center" valignment="top" width="0pt">
3549 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3552 \begin_layout Plain Layout
3567 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3570 \begin_layout Plain Layout
3587 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3590 \begin_layout Plain Layout
3605 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3608 \begin_layout Plain Layout
3624 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3627 \begin_layout Plain Layout
3642 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3645 \begin_layout Plain Layout
3662 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3665 \begin_layout Plain Layout
3680 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3683 \begin_layout Plain Layout
3700 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3703 \begin_layout Plain Layout
3718 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3721 \begin_layout Plain Layout
3738 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3741 \begin_layout Plain Layout
3756 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3759 \begin_layout Plain Layout
3776 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3779 \begin_layout Plain Layout
3794 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3797 \begin_layout Plain Layout
3820 \begin_layout Standard
3821 LyX doesn't stop you using bullets from packages you don't have.
3822 If you get errors from LaTeX when you try to view or print the file, then
3823 it is likely you are missing a package.
3827 \begin_layout Plain Layout
3828 LyX doesn't restrict your use since you may be editing locally and exporting
3837 \begin_layout Subsection
3841 \begin_layout Standard
3842 Select which bullet depth you want to change then select the bullet shape
3844 Any changes will not be visible in LyX, but are visible when viewing the
3848 \begin_layout Standard
3849 You can reset a bullet shape to the default simply by clicking your right
3850 mouse button on the appropriate bullet depth button.
3854 \begin_layout Plain Layout
3859 want to have multiple sets of paragraphs with different sets of bullets
3860 in each, then you're going to have to get your hands dirty with ERT.
3861 The bullet selection dialog can help though because it provides you with
3862 the LaTeX code for a wide range of bullet shapes.
3863 To make your own custom paragraphs you have the following options:
3866 \begin_layout Plain Layout
3870 \begin_layout Plain Layout
3886 \begin_layout Plain Layout
3890 \begin_layout Plain Layout
3912 \begin_layout Itemize
3913 Use the LaTeX command
3914 \begin_inset Flex CharStyle:Code
3917 \begin_layout Plain Layout
3925 to specify a new bullet shape for a given depth.
3926 You'll also need to save the current bullet shape so you can restore it
3928 In this itemized list the following LaTeX code was used to change the bullet
3929 used for the first depth.
3933 \begin_layout LyX-Code
3943 \begin_layout LyX-Code
3960 \begin_layout Itemize
3961 Note that the itemize depth is specified in Roman numerals as part of the
3971 \begin_layout Itemize
3975 \begin_layout Plain Layout
3988 Specify each individual entry by starting each item with the bullet shape
3989 enclosed in square brackets and set as
3990 \begin_inset Flex CharStyle:MenuItem
3993 \begin_layout Plain Layout
4000 For example, this item was started with
4001 \begin_inset Flex CharStyle:Code
4004 \begin_layout Plain Layout
4019 \begin_layout Plain Layout
4023 \begin_layout Plain Layout
4039 \begin_layout Plain Layout
4040 You'll also need to revert the labelitem back to its previous setting for
4041 the global bullet shape settings to remain in effect.
4042 The way used here was:
4045 \begin_layout LyX-Code
4060 \begin_layout Chapter
4064 \begin_layout Section
4068 \begin_layout Standard
4069 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4070 and retrieve information about the LyX internal state.
4071 This is only intended for advanced users, but they should find it useful.
4072 It is by writing to the LyX server, for example, that bibliography managers,
4073 such as JabRef, are able to
4074 \begin_inset Quotes eld
4078 \begin_inset Quotes erd
4084 \begin_layout Standard
4085 Please note that, at present,
4087 the server does not work on Windows
4093 \begin_layout Plain Layout
4094 There is no reason it cannot do so.
4095 But none of the developers on Windows have yet implemented this functionality
4104 \begin_layout Section
4105 Starting the LyX Server
4108 \begin_layout Standard
4109 The LyX server works through the use of a pair of named pipes.
4110 These are usually located in
4111 \begin_inset Flex CharStyle:Code
4114 \begin_layout Plain Layout
4121 \begin_inset Quotes eld
4125 \begin_inset Flex CharStyle:Code
4128 \begin_layout Plain Layout
4135 \begin_inset Quotes erd
4139 \begin_inset Quotes eld
4143 \begin_inset Flex CharStyle:Code
4146 \begin_layout Plain Layout
4153 \begin_inset Quotes erd
4157 External programs write into
4158 \begin_inset Flex CharStyle:Code
4161 \begin_layout Plain Layout
4167 and read back data from
4168 \begin_inset Flex CharStyle:Code
4171 \begin_layout Plain Layout
4178 The stem of the pipe names can be defined in the
4179 \begin_inset Flex CharStyle:MenuItem
4182 \begin_layout Plain Layout
4187 ools\SpecialChar \menuseparator
4198 \begin_inset Flex CharStyle:Code
4201 \begin_layout Plain Layout
4202 "/home/myhome/lyxpipe"
4212 configure this manually in order for the server to start.
4215 \begin_layout Standard
4217 \begin_inset Flex CharStyle:Code
4220 \begin_layout Plain Layout
4227 \begin_inset Flex CharStyle:Code
4230 \begin_layout Plain Layout
4236 ' to create the pipes.
4237 If one of the pipes already exists, LyX will assume that another LyX process
4238 is already running and will not start the server.
4239 This means that if LyX crashes, or if for some other reason, a
4240 \begin_inset Quotes eld
4244 \begin_inset Quotes erd
4247 pipe is left in existence when LyX closes, then LyX will not start the
4249 (This is bug 641.) You will need to delete the pipes manually and then restart
4253 \begin_layout Standard
4254 To have several LyX processes with servers at the same time, you have to
4255 use different configurations, perhaps by using separate user directories,
4257 \begin_inset Flex CharStyle:Code
4260 \begin_layout Plain Layout
4266 file, for each process.
4269 \begin_layout Standard
4270 If you are developing a client program, you might find it useful to enable
4271 debugging information from the LyX server.
4272 Do this by starting LyX as
4273 \begin_inset Flex CharStyle:Code
4276 \begin_layout Plain Layout
4285 \begin_layout Standard
4286 Other than this, there are a few points to consider:
4289 \begin_layout Itemize
4290 Both server and clients must run on UNIX or OS/2 machines.
4291 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4292 not possible right now.
4295 \begin_layout Itemize
4296 On OS/2, only one client can connect to LyXServer at a time.
4299 \begin_layout Itemize
4300 On OS/2, clients must open the input pipe with
4301 \begin_inset Flex CharStyle:Code
4304 \begin_layout Plain Layout
4313 \begin_layout Standard
4314 You can find a complete example client written in C in the source distribution
4316 \begin_inset Flex CharStyle:Code
4319 \begin_layout Plain Layout
4320 development/lyxserver/server_monitor.c
4328 \begin_layout Section
4329 Normal communication
4332 \begin_layout Standard
4333 To issue a LyX call, the client writes a line of ASCII text into the input
4335 This line has the following format:
4352 \begin_layout Description
4353 clientname is a name that the client can choose arbitrarily.
4354 Its only use is that LyX will echo it if it sends an answer---so a client
4355 can dispatch results from different requesters.
4358 \begin_layout Description
4359 function is the function you want LyX to perform.
4360 It is the same as the commands you'd use in the minibuffer.
4363 \begin_layout Description
4364 argument is an optional argument which is meaningful only to some functions
4366 \begin_inset Quotes eld
4370 \begin_inset Quotes erd
4373 LFUN will insert the argument as text at the cursor position).
4376 \begin_layout Standard
4377 The answer from LyX will arrive in the output pipe and be of the form
4394 \begin_layout Standard
4403 are just echoed from the command request, while
4407 is more or less useful information filled according to how the command
4408 execution worked out.
4409 Some commands, such as
4410 \begin_inset Quotes eld
4414 \begin_inset Quotes erd
4417 , will return information about the internal state of LyX, while other will
4418 return an empty data-response.
4419 This means that the command execution went fine.
4422 \begin_layout Standard
4423 In case of errors, the response from LyX will have this form
4440 \begin_layout Standard
4445 should contain an explanation of why the command failed.
4448 \begin_layout Standard
4452 \begin_layout LyX-Code
4453 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4456 \begin_layout LyX-Code
4457 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4458 \begin_inset Newline newline
4461 read a <~/.lyxpipe.out
4462 \begin_inset Newline newline
4468 \begin_layout Section
4472 \begin_layout Standard
4473 LyX can notify clients of events going on asynchronously.
4474 Currently it will only do this if the user binds a key sequence with the
4476 \begin_inset Quotes eld
4480 \begin_inset Quotes erd
4484 The format of the string LyX sends is as follows:
4488 \begin_inset Flex CharStyle:Code
4491 \begin_layout Plain Layout
4502 \begin_layout Standard
4507 is the printed representation of the key sequence that was actually typed
4511 \begin_layout Standard
4512 This mechanism can be used to extend LyX's command set and implement macros.
4513 Bind some key sequence to
4514 \begin_inset Quotes eld
4518 \begin_inset Quotes erd
4522 Then start a client that listens on the output pipe, dispatches the command
4523 according to the sequence, and starts a function that may use LyX calls
4524 and LyX requests to issue a command or a series of commands to LyX.
4527 \begin_layout Section
4528 The simple LyX Server Protocol
4531 \begin_layout Standard
4532 LyX implements a simple protocol that can be used for session management.
4533 All messages are of the form
4546 \begin_layout Standard
4552 \begin_inset Quotes eld
4556 \begin_inset Quotes erd
4560 \begin_inset Quotes eld
4564 \begin_inset Quotes erd
4569 \begin_inset Quotes eld
4573 \begin_inset Quotes erd
4576 is received from a client, LyX will report back to inform the client that
4577 it's listening to it's messages, while
4578 \begin_inset Quotes eld
4582 \begin_inset Quotes erd
4585 sent from LyX will inform clients that LyX is closing.
4588 \begin_layout Chapter
4589 Special Document Classes
4592 \begin_layout Section
4596 \begin_layout Standard
4602 \begin_layout Subsection
4606 \begin_layout Standard
4607 This section describes how LyX can be used to write articles for submission
4608 to the scientific journal
4610 Astronomy and Astrophysics
4612 (www.edpsciences.fr/aa/
4613 \begin_inset Flex URL
4616 \begin_layout Plain Layout
4618 http://www.edpsciences.fr/aa/
4623 ) using Version 5.01 of the document class
4628 This package can be downloaded from the ftp site
4631 \begin_layout Standard
4632 \begin_inset VSpace medskip
4638 \begin_layout Standard
4640 \begin_inset Flex URL
4643 \begin_layout Plain Layout
4645 ftp://ftp.edpsciences.org/pub/aa/readme.html
4653 \begin_layout Standard
4654 \begin_inset VSpace medskip
4660 \begin_layout Standard
4661 A manual comes together with that package, and this text is not meant to
4662 replace the original manual but merely a short guide how to realize the
4663 correct form of your paper.
4667 \begin_layout Standard
4668 Please note that the publisher of the journal was changed from Springer
4669 to EDP Sciences starting January 1, 2001.
4670 That change implicated also some slight changes of the style files, namely
4671 the removal of the thesaurus command.
4672 The LyX class aa supports the newest version of these style files, V 5.01.
4673 If you have an older version installed, please upgrade.
4674 For compatibility, the old (version 4) layout has been kept as
4679 Please refer to the comments in
4681 LyXDir/layouts/aapaper.layout
4686 \begin_layout Subsection
4690 \begin_layout Standard
4691 It is recommended you start from the example template distributed with LyX.
4692 If you are not using a template, note the following settings:
4695 \begin_layout Itemize
4705 ocument\SpecialChar \menuseparator
4712 dialog (OK, that one was obvious).
4715 \begin_layout Itemize
4716 Don't change the option
4719 \begin_inset space ~
4729 The whole layout is done by the macros, you shouldn't change anything.
4732 \begin_layout Subsection
4736 \begin_layout Standard
4737 First thing to enter is the header information.
4738 It consists of seven entries, of which some are optional.
4742 \begin_layout Itemize
4750 \begin_layout Itemize
4758 \begin_layout Itemize
4766 \begin_layout Itemize
4774 \begin_layout Itemize
4779 : [optional] if more than one author: whom to contact for offprint requests.
4782 \begin_layout Itemize
4787 : [optional] mail address for contacts.
4790 \begin_layout Itemize
4798 Received: <date>; Accepted <date>
4801 \begin_layout Standard
4802 There is no need to issue the
4808 command, this is done automatically by LyX when the header is finished.
4809 Although the order of the single header entries doesn't matter it is advised
4810 to keep the above sequence, just to get the best optics and meets the layout
4811 of the real document.
4814 \begin_layout Standard
4815 If you want to place footnotes in the header block, e.g.
4816 \begin_inset space \space{}
4819 to state your present address, just use the standard footnote via the menu
4822 Insert\SpecialChar \menuseparator
4826 LyX will automagically use the term
4835 \begin_layout Standard
4836 In addition to these topics, the macros use three additional LaTeX commands
4837 that have no counterpart in LyX:
4840 \begin_layout Itemize
4847 to separate different names for more than one author and institute, respectivel
4851 \begin_layout Itemize
4858 to mark corresponding author/institute pairs.
4859 The institutes are numbered sequentially as they appear in the
4863 field, so you have to put a marker to each author.
4866 \begin_layout Itemize
4873 to supply an email address for fast contact.
4876 \begin_layout Standard
4877 In all cases, the appropriate command has to be entered in LyX and marked
4883 \begin_layout Subsection
4887 \begin_layout Standard
4888 The abstract should immediately follow the header block.
4889 With version 5 the abstract environment was changed to a command, and there
4890 is now a resctriction to only one paragraph.
4891 In addition, it should contain an entry with the keywords.
4892 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4899 by hand and mark it as LaTeX code.
4900 Refer to the example paper.
4903 \begin_layout Subsection
4904 Supported environments
4907 \begin_layout Standard
4908 The A&A paper layout supports the following environments for structuring
4912 \begin_layout Itemize
4918 \begin_layout Itemize
4924 \begin_layout Itemize
4930 \begin_layout Itemize
4936 \begin_layout Itemize
4942 \begin_layout Itemize
4948 \begin_layout Itemize
4954 \begin_layout Itemize
4960 \begin_layout Itemize
4966 \begin_layout Itemize
4972 \begin_layout Itemize
4978 \begin_layout Itemize
4984 \begin_layout Subsection
4985 Commands not supported by LyX
4988 \begin_layout Standard
4989 Some commands are not yet supported by the
4994 Some have already been mentioned.
4995 For the sake of completeness, they are listed all together here:
4998 \begin_layout Itemize
5006 \begin_layout Itemize
5014 \begin_layout Itemize
5022 \begin_layout Itemize
5030 \begin_layout Itemize
5038 \begin_layout Itemize
5046 \begin_layout Itemize
5054 \begin_layout Itemize
5062 \begin_layout Standard
5063 If you want to use any of these commands, you have to enter them yourself.
5066 Do not forget to mark them as LaTeX code!
5069 \begin_layout Subsection
5070 Figure and Table Floats
5073 \begin_layout Standard
5074 LyX provides support for the necessary float environments
5076 figure, figure*, table
5082 , therefore we won't tell much about it here.
5086 \begin_inset space ~
5092 Just remember that tables should be left-aligned.
5093 For that, select the table and change the alignment in
5098 dit\SpecialChar \menuseparator
5104 \begin_inset space ~
5110 \begin_layout Standard
5111 There is only one special thing: the figures with caption besides the figure.
5112 To create such a figure, you have to do the following:
5115 \begin_layout Enumerate
5116 Create a wide figure float:
5121 nsert\SpecialChar \menuseparator
5126 t\SpecialChar \menuseparator
5129 , then right click in the figure and select
5135 \begin_inset space ~
5143 \begin_layout Enumerate
5144 Enter your caption text.
5147 \begin_layout Enumerate
5152 to move the cursor above the caption.
5155 \begin_layout Enumerate
5159 \begin_layout Enumerate
5160 Position the cursor behind the figure and insert a horizontal fill:
5165 nsert\SpecialChar \menuseparator
5171 \begin_inset space ~
5176 \SpecialChar \menuseparator
5180 \begin_inset space ~
5188 \begin_layout Enumerate
5189 Switch to LaTeX mode:
5192 \begin_inset space ~
5200 \begin_layout Enumerate
5210 Do not close the brace!
5213 \begin_layout Enumerate
5214 Position the cursor behind the caption text, switch to LaTeX mode and insert
5218 \begin_inset space ~
5230 \begin_layout Standard
5231 Also, refer to the figures in the example paper.
5234 \begin_layout Subsection
5238 \begin_layout Standard
5239 For submission, the paper has to be formated in a special double-spacing
5241 For this purpose, you have to give the option
5245 to the documentclass.
5246 This must be done using the extra class options field in the
5248 Document\SpecialChar \menuseparator
5252 Just enter the string
5259 \begin_layout Subsection
5263 \begin_layout Standard
5268 directory contains an example paper written with LyX.
5269 It is the example paper from the original macro package, translated to
5271 Use it for inspiration, and compare the original LaTeX code with LyX way
5275 \begin_layout Section
5279 \begin_layout Standard
5285 \begin_layout Subsection
5289 \begin_layout Standard
5290 AASTeX is a set of macros produced by the American Astronomical Society
5291 to facilitate electronic manuscript submission to the three journals they
5292 publish: the Astrophysical Journal (including the Letters and Supplement),
5293 the Astronomical Journal, and the Publications of the Astronomical Society
5295 LyX has proven to be an excellent tool for generating these documents,
5296 especially given its equation, citation, and figure handling capabilities.
5297 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5298 is the version described here, or higher.
5299 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5300 incompatible with LyX.
5301 The AASTeX package may be downloaded from the AASTeX Web site
5304 \begin_layout Standard
5305 \begin_inset VSpace medskip
5311 \begin_layout Standard
5313 \begin_inset Flex URL
5316 \begin_layout Plain Layout
5318 http://www.journals.uchicago.edu/AAS/AASTeX
5326 \begin_layout Standard
5327 \begin_inset VSpace medskip
5333 \begin_layout Standard
5334 A complete user guide is contained in that package and you should familiarize
5335 yourself with it thoroughly before embarking on writing a paper in LyX.
5336 LyX will not reduce the need to figure out all the AASTeX commands, it
5337 will only reduce the drudgery of typing everything in.
5338 It is your responsibility to ensure that the final exported LaTeX document
5339 conforms completely to the requirements of the journal to which you are
5340 submitting your paper.
5343 \begin_layout Subsection
5344 Starting a New Paper
5347 \begin_layout Standard
5348 I strongly suggest that you start with the AASTeX template file.
5354 ile\SpecialChar \menuseparator
5364 , enter the new file name, then choose the
5369 This will show the most common fields found in a manuscript.
5370 Simply overwrite the existing text (including the brackets,
5374 ) with the correct information.
5375 Many of the AASTeX commands and environments can be implemented directly
5376 in LyX, but some cannot: most noticeably
5388 , which should stick out like a sore thumb if you actually just opened the
5390 For commands such as these, the LaTeX code must be entered directly and
5392 Such commands are referred to as ERT, or Evil Red Text.
5393 I tried to minimize the amount of ERT needed in an AASTeX document, but
5394 there is still a bit more required than any of us would like.
5397 \begin_layout Subsection
5398 Finishing Your Paper
5401 \begin_layout Standard
5402 When the paper is finished to your satisfaction and previews/prints correctly,
5404 \begin_inset Quotes eld
5408 \begin_inset Quotes erd
5411 actions which need to be done before you submit it to the journals.
5415 \begin_layout Enumerate
5416 Export your paper as a LaTeX file (
5421 ile\SpecialChar \menuseparator
5426 xport\SpecialChar \menuseparator
5437 \begin_layout Enumerate
5442 file with your favorite text editor
5446 \begin_layout Enumerate
5447 remove the comment lines before the
5456 \begin_layout Enumerate
5461 usepackage...{fontenc}
5463 line if it appears (usually just after
5478 \begin_layout Enumerate
5479 remove everything between (and including) the
5491 commands, except for any commands you specifically put into the LaTeX preamble
5492 (which should appear immediately after the
5493 \begin_inset Quotes eld
5496 User specified LaTeX commands
5497 \begin_inset Quotes erd
5508 \begin_layout Enumerate
5509 Run the resulting file through LaTeX to make sure it still processes correctly.
5512 \begin_layout Enumerate
5513 Reread the journal requirements to make sure your filenames and formats
5517 \begin_layout Enumerate
5521 \begin_layout Subsection
5522 Comments On Specific Commands
5525 \begin_layout Standard
5526 I will not describe the detailed usage of the individual AASTeX commands:
5527 the AASTeX User Guide (
5531 ) gives a good description of each.
5532 Thus it's probably easiest for me to go down the list as found in the guide
5533 and offer comments where necessary.
5534 So let's begin \SpecialChar \ldots{}
5538 \begin_layout Subsubsection
5539 Things that work as expected
5542 \begin_layout Standard
5546 \begin_layout Plain Layout
5558 \begin_layout Standard
5559 Because they work as you might expect, I simply list them and the section
5660 begin{thebibliography}
5668 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5669 graphicx figure commands (2.14.1),
5693 (2.15.4, amongst other places),
5720 \begin_layout Standard
5721 The following style options also work correctly:
5742 Simply put them in the
5748 Layout\SpecialChar \menuseparator
5754 \begin_layout Standard
5758 \begin_layout Plain Layout
5770 \begin_layout Subsubsection
5771 Things that work, but require more comment
5774 \begin_layout Standard
5775 The following items work, but require a little more discussion:
5778 \begin_layout Itemize
5779 These items are reserved for use by the journal editors, but you can put
5780 them into the LaTeX preamble if you feel compelled to do so:
5813 \begin_layout Itemize
5814 These items may be placed in the LaTeX preamble, and are included as blanks
5815 in the template file:
5836 \begin_layout Itemize
5843 (2.3) -- can only be used
5844 \begin_inset Quotes eld
5848 \begin_inset Quotes erd
5851 , not in the middle of a paragraph.
5852 Use ERT if you need to embed it.
5855 \begin_layout Itemize
5862 (2.3) -- will have extra {} after it.
5863 This should not cause an error.
5866 \begin_layout Itemize
5873 (2.6) -- can only be used
5874 \begin_inset Quotes eld
5878 \begin_inset Quotes erd
5881 , not in the middle of a paragraph.
5882 Use ERT if you need to embed it.
5885 \begin_layout Itemize
5892 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5896 \begin_layout Itemize
5903 (2.8) -- same as for
5910 \begin_layout Itemize
5917 (2.9) -- will have extra {} after it.
5918 This should not cause an error.
5921 \begin_layout Itemize
5928 (2.11) -- will have extra {} after it.
5929 This should not cause an error.
5932 \begin_layout Itemize
5939 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5940 at the beginning of the text and selecting
5942 Insert\SpecialChar \menuseparator
5947 \begin_inset Quotes eld
5951 \begin_inset Quotes erd
5954 inserts an optional argument of the type needed by
5961 Hopefully it will be renamed someday.
5964 \begin_layout Itemize
5977 for the catalog ID optional parameter
5980 \begin_layout Itemize
5993 for the catalog ID optional parameter
5996 \begin_layout Subsubsection
5997 Things not implemented, use ERT
6000 \begin_layout Standard
6004 \begin_layout Plain Layout
6016 \begin_layout Standard
6039 setcounter{equation}
6041 (2.12), Journal name abbreviations (2.13.4),
6077 (2.15.4, insert it as the first element in the lefthand cell after where
6079 Don't use any of LyX's rules in the table),
6091 (2.15.5), much of Misc (2.17, except
6142 \begin_layout Standard
6146 \begin_layout Plain Layout
6158 \begin_layout Subsubsection
6159 Things that cannot be implemented
6162 \begin_layout Standard
6163 \SpecialChar \ldots{}
6164 at least in any meaningful sort of way, so I suggest ignoring them.
6165 They are the references environment (2.13.3), and the deluxetable environment
6167 If you really, really need to use deluxetable, I suggest editing it in
6168 a separate file with a text editor, then using
6173 nsert\SpecialChar \menuseparator
6179 \begin_inset space ~
6184 to include it in your LyX document.
6189 file to see an example of this.
6192 \begin_layout Subsection
6193 FAQs, Tips, Tricks, and Other Ruminations
6196 \begin_layout Subsubsection
6197 Getting LyX and AASTeX to cooperate
6200 \begin_layout Standard
6201 It can be a bit tricky to get LyX to recognize a new layout and document
6203 When all else fails, do this:
6206 \begin_layout Enumerate
6207 Make certain that LaTeX can find AASTeX.
6208 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6209 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6216 \begin_layout Enumerate
6228 \begin_layout Enumerate
6234 ools\SpecialChar \menuseparator
6241 in LyX, then restart LyX.
6244 \begin_layout Enumerate
6245 Open a regular new file, not from a template.
6246 Does AASTeX appear in the class list in
6251 ocument\SpecialChar \menuseparator
6261 \begin_layout Standard
6262 If you get a warning from an existing AASTeX document about not being able
6263 to find the AASTeX layout or a message about
6264 \begin_inset Quotes eld
6267 You should not mix title layouts with normal ones
6268 \begin_inset Quotes erd
6271 , things haven't been installed correctly.
6274 \begin_layout Subsubsection
6275 LaTeX error processing a table
6278 \begin_layout Standard
6279 LyX, by default, attempts to center the table caption/title.
6280 This seems to produce a bad interaction in AASTeX so you should click somewhere
6281 in the caption/title, then select
6286 dit\SpecialChar \menuseparator
6292 \begin_inset space ~
6309 This took care of it for me.
6312 \begin_layout Subsubsection
6316 \begin_layout Standard
6317 A couple of things: 1) I have noticed some funny spacing in the reference
6318 entries in the text.
6319 When you enter the bibliography item data, make sure their is
6323 space between the last author and the parenthesis setting off the year;
6327 \begin_inset space \space{}
6341 2) Entering the references at all is not obvious.
6342 The easiest thing is to start typing your first reference at the end of
6343 the document, then mark it as type
6348 That will put a small gray box in front of what you just typed.
6349 Click on the box to fill in the rest of the information.
6350 For new references, go to the end of an existing reference and press return.
6351 That will create a new line with its own box, etc.
6354 \begin_layout Subsubsection
6358 \begin_layout Standard
6359 Even though AASTeX provides its own figure commands (
6365 , for example), I much prefer LaTeX's standard figure commands (with the
6374 \begin_inset space ~
6377 commands as ERT into a Figure Float box if you desire, but I never have
6378 much luck getting the layout right.
6379 With the standard graphics, LyX will insert a
6383 usepackage{graphicx}
6385 command into the LaTeX preamble and handle the figures in the standard
6386 LaTeX2e way, interspersing the figures in the text.
6387 I believe ApJ accepts figures exactly this way now; AJ might still use
6389 \begin_inset Quotes eld
6392 stack everything at the end
6393 \begin_inset Quotes erd
6399 \begin_layout Subsubsection
6400 Things I could have done, but didn't
6403 \begin_layout Standard
6405 \begin_inset Quotes eld
6409 \begin_inset Quotes erd
6412 things I could have implemented, but chose not to.
6413 For instance, I saw no point in double-spacing the text in the LyX window,
6414 even though it is double-spaced in the paper manuscript.
6415 Also, I chose not to make separate layouts for the preprint and preprint2
6417 Since I assume you will spend most of your time in the plain manuscript
6418 mode anyway, I decided not to chew up more disk space with this.
6422 \begin_layout Subsection
6426 \begin_layout Standard
6427 Your mileage may vary.
6428 I've now had papers published by both ApJ and AJ that have had 98% of the
6429 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6431 I have had no trouble with the submission process, and I'm sure the journals
6432 were never aware that there might be a difference.
6433 So, go forth and publish!
6436 \begin_layout Section
6440 \begin_layout Standard
6443 David Johnson; updated by Richard Heck
6446 \begin_layout Standard
6447 \begin_inset VSpace bigskip
6453 \begin_layout Standard
6455 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6456 papers to be submitted to American Mathematical Society publications.
6457 The layouts are not tailored to a specific journal, but easily can be.
6458 You should refer to the AMS documentation for specific instructions for
6459 each journal (usually it will entail only changing a single line in the
6461 That documentation is available on the Web at
6462 \begin_inset Flex URL
6465 \begin_layout Plain Layout
6473 \begin_inset Flex URL
6476 \begin_layout Plain Layout
6478 ftp://ftp.ams.org/pub/tex/amslatex/
6484 These layouts are appropriate, and useful, for any mathematical writing.
6488 \begin_layout Standard
6489 There are two basic AMS LaTeX layouts:
6492 \begin_layout Itemize
6493 amsart: The standard AMS article format.
6496 \begin_layout Itemize
6497 amsbook: the standard AMS book (really, monograph) format.
6501 \begin_layout Standard
6502 The layouts themselves contain only the minimum necessary to use the AMS
6504 They do not, in particular, contain any of the `theorem' environments used
6505 for setting theorems, lemmas, and the like.
6506 These are contained, instead, in the
6507 \begin_inset Flex CharStyle:Code
6510 \begin_layout Plain Layout
6516 module, which is loaded by default when when you select one of the AMS
6518 (It can also be used with other classes and can be removed, if you would
6519 rather use something else.) Less commonly used environments are in the
6520 \begin_inset Flex CharStyle:Code
6523 \begin_layout Plain Layout
6524 Theorems (AMS-Extended)
6529 module, which must be loaded manually.
6532 \begin_layout Standard
6533 By default, theorems and the like are numbered consecutively throughout
6534 the document, but this may be modified by loading the module
6535 \begin_inset Flex CharStyle:Code
6538 \begin_layout Plain Layout
6539 Theorems (Order by Section)
6544 or, if you are using
6545 \begin_inset Flex CharStyle:Code
6548 \begin_layout Plain Layout
6555 \begin_inset Flex CharStyle:Code
6558 \begin_layout Plain Layout
6559 Theorems (Order by Chapter)
6565 These will number the results as
6566 \begin_inset Formula $n.m$
6569 , where the first number refers to the section (or chapter) and the second
6570 refers to the total number of results so far in that section (or chapter).
6571 Many environments are also available unnumbered.
6572 These are indicated by an asterisk at the end.
6573 If you happen to want
6577 unnumbered results, the the module
6578 \begin_inset Flex CharStyle:Code
6581 \begin_layout Plain Layout
6587 provides that option.
6590 \begin_layout Standard
6591 Note that these modules do not
6595 to be used with the AMS classes.
6596 It is perfectly possible to use the
6597 \begin_inset Flex CharStyle:Code
6600 \begin_layout Plain Layout
6606 module, and the others mentioned, with other classes, such as
6607 \begin_inset Flex CharStyle:Code
6610 \begin_layout Plain Layout
6617 \begin_inset Flex CharStyle:Code
6620 \begin_layout Plain Layout
6627 \begin_inset Flex CharStyle:Code
6630 \begin_layout Plain Layout
6639 \begin_layout Subsection
6640 What these layouts provide
6643 \begin_layout Standard
6644 There is a long list of included environments provided by these layouts.
6645 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6646 variety of `theorem' environments.
6647 However, the AMS recommends the environments that are available in LyX.
6651 \begin_layout Standard
6652 The following environments---as well as the standard environments, such
6654 \begin_inset Flex CharStyle:Noun
6657 \begin_layout Plain Layout
6664 \begin_inset Flex CharStyle:Noun
6667 \begin_layout Plain Layout
6674 \begin_inset Flex CharStyle:Noun
6677 \begin_layout Plain Layout
6684 \begin_inset Flex CharStyle:Noun
6687 \begin_layout Plain Layout
6694 \begin_inset Flex CharStyle:Noun
6697 \begin_layout Plain Layout
6704 \begin_inset Flex CharStyle:Code
6707 \begin_layout Plain Layout
6714 \begin_inset Flex CharStyle:Code
6717 \begin_layout Plain Layout
6726 \begin_layout Description
6727 Address This should be the author's permanent address.
6730 \begin_layout Description
6732 \begin_inset space ~
6735 Address This should be the author's temporary address at the time of submission,
6736 if different from the Address.
6739 \begin_layout Description
6740 Email Author's e-mail address
6743 \begin_layout Description
6744 URL Author's Web address, if desired.
6747 \begin_layout Description
6748 Keywords Key words or phrases used to identify specific topics discussed
6752 \begin_layout Description
6753 Subjectclass These refer to the AMS Subject Classifications, published and
6756 Mathematical Reviews
6759 These are also available online at the AMS cites listed above.
6762 \begin_layout Description
6766 \begin_layout Description
6770 \begin_layout Description
6774 \begin_layout Standard
6775 The following environments are provided by both the
6776 \begin_inset Flex CharStyle:Code
6779 \begin_layout Plain Layout
6786 \begin_inset Flex CharStyle:Code
6789 \begin_layout Plain Layout
6795 modules, in the latter case in both starred (unnumbered) and unstarred
6796 (numbered) versions.
6797 These same environments are provided only in the starred versions by the
6799 \begin_inset Flex CharStyle:Code
6802 \begin_layout Plain Layout
6811 \begin_layout Theorem
6812 This is typically used for the statements of major results.
6816 \begin_layout Corollary*
6817 This is used for statements which follow fairly directly from previous statement
6819 Again, these can be major results.
6824 These are smaller results needed to prove other statements.
6827 \begin_layout Proposition
6828 These are less major results which (hopefully) add to the general theory
6832 \begin_layout Conjecture
6833 These are statements provided without justification, which the author does
6834 not know how to prove, but which seem to be true (to the author, at least).
6837 \begin_layout Definition*
6838 Guess what this is for.
6839 The font is different for this environment than for the previous ones.
6843 \begin_layout Example*
6844 Used for examples illustrating proven results.
6847 \begin_layout Problem
6848 It's not really known what this is for.
6849 You should figure it out.
6852 \begin_layout Exercise*
6853 Write a description for this one.
6856 \begin_layout Remark
6857 This environment is also a type of theorem, usually a lesser sort of observation.
6860 \begin_layout Claim*
6861 Often used in the course of giving a proof of a larger result.
6865 Generally, these are used to break up long arguments, using specific instances
6871 The numbering scheme for cases is on its own, not together with other numbered
6877 At the end of this environment, a QED symbol (usually a square, but it can
6878 vary with different styles) is placed.
6879 If you want to have other environments within this one---for example, Case
6880 environments---and have the QED symbol appear only after them, then the
6881 other environments need to be nested within the proof environment.
6884 Nesting Environments
6890 for information on nesting.
6893 \begin_layout Standard
6894 And these environments are provided by
6895 \begin_inset Flex CharStyle:Code
6898 \begin_layout Plain Layout
6899 Theorems (AMS-Extended)
6907 \begin_layout Criterion*
6908 A required condition.
6911 \begin_layout Algorithm*
6912 A general procedure to be used.
6915 \begin_layout Axiom*
6916 This is a property or statement taken as true within the system being discussed.
6919 \begin_layout Condition*
6920 Sometimes used to state a condition assumed within the present context of
6925 Similar to a Remark.
6928 \begin_layout Notation*
6929 Used for the explanation of, yes, notation.
6932 \begin_layout Summary
6933 Do we really need to tell you?
6936 \begin_layout Acknowledgement*
6940 \begin_layout Conclusion*
6941 Sometimes used at the end of a long train of argument.
6945 Used in a way similar to Proposition, though perhaps lower on the scale.
6948 \begin_layout Standard
6949 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6951 They need to be available on your system in order to use these environments.
6954 \begin_layout Section
6962 \begin_layout Standard
6968 \begin_layout Subsection
6972 \begin_layout Standard
6973 These are the layout files for some of the journals of the American Geophysical
6975 It is assumed that you have both the AGU's own class files and AGUplus
6976 installed (everything to be found at
6977 \begin_inset Flex URL
6980 \begin_layout Plain Layout
6982 ftp://ftp.agu.org/journals/latex/journals
6990 \begin_layout Subsection
6994 \begin_layout Standard
7004 They are still called this in the LyX GUI, though their LaTeX equivalents
7005 in the AGU classes are
7016 \begin_layout Standard
7017 Newly defined styles are
7054 These are mostly manuscript attributes and defined in the AGU class documentati
7058 \begin_layout Standard
7059 I suspect this is still badly incomplete.
7062 \begin_layout Subsection
7066 \begin_layout Standard
7083 \begin_layout Subsection
7087 \begin_layout Itemize
7090 Journal of Geophysical Research
7099 \begin_layout Standard
7100 Add your own, it isn't so hard! Look at the
7111 \begin_layout Subsection
7112 Bugs and things to remember
7115 \begin_layout Standard
7116 In order to use the new layouts, you must remember to do the following for
7120 \begin_layout Enumerate
7126 This can be done in the
7128 layout\SpecialChar \menuseparator
7133 document\SpecialChar \menuseparator
7137 (AGU articles are always in English, right? So
7144 \begin_layout Enumerate
7154 (Yes, this is a bug.)
7157 \begin_layout Enumerate
7158 Make sure you use the
7162 bibliography style, by entering
7166 into the second field of the BibTeX inset.
7167 None of the standard styles will do.
7170 \begin_layout Section
7174 \begin_layout Standard
7180 \begin_layout Subsection
7184 \begin_layout Standard
7185 Broadway is for writing plays.
7186 The format is more decorative than Hollywood, and much less standardized.
7187 This format should be suitable for workshops.
7190 \begin_layout Subsection
7194 \begin_layout Standard
7195 The same as in Hollywood.
7198 \begin_layout Subsection
7202 \begin_layout Standard
7207 names as labels then cross-reference the label to insert the name.
7208 The cross-reference dialog will show the current cast of characters.
7211 \begin_layout Subsection
7212 Paper size and Margins
7215 \begin_layout Standard
7216 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7219 \begin_layout Subsection
7223 \begin_layout Standard
7224 The following environments are available.
7225 You can use broadway.bind to get the bind keys shown at the right.
7228 \begin_layout Itemize
7232 \begin_inset Newline newline
7237 You should not have to use this, but it is here for anything that does not
7241 \begin_layout Itemize
7245 \begin_inset space \hfill{}
7249 \begin_inset Newline newline
7254 Used to describe stage setting and the action.
7255 First use of speaker names in all CAPs.
7258 \begin_layout Itemize
7262 \begin_inset space \hfill{}
7266 \begin_inset Newline newline
7271 Automatically numbered.
7272 On screen it will be arabic, but will print as Roman.
7275 \begin_layout Itemize
7279 \begin_inset space \hfill{}
7283 \begin_inset Newline newline
7293 It is just centered text.
7296 \begin_layout Itemize
7300 \begin_inset space \hfill{}
7304 \begin_inset Newline newline
7309 Not automatically numbered.
7310 You supply the number.
7311 This is because I couldn't figure out how.
7314 \begin_layout Itemize
7318 \begin_inset space \hfill{}
7322 \begin_inset Newline newline
7327 A special case of Narrative to describe the setting and action as the curtain
7331 \begin_layout Itemize
7335 \begin_inset space \hfill{}
7339 \begin_inset Newline newline
7344 The speaker's (actor's) title, centered in all CAPS.
7347 \begin_layout Itemize
7351 \begin_inset space \hfill{}
7355 \begin_inset Newline newline
7360 Instructions to the speaker.
7361 The parentheses are automatically inserted.
7362 The ( will appear on screen, but both will be in the printed play.
7363 This environment is only used within
7370 \begin_layout Itemize
7374 \begin_inset space \hfill{}
7378 \begin_inset Newline newline
7383 What the Speaker says.
7386 \begin_layout Itemize
7390 \begin_inset space \hfill{}
7394 \begin_inset Newline newline
7399 The curtain comes down.
7402 \begin_layout Itemize
7406 \begin_inset space \hfill{}
7412 \begin_layout Itemize
7416 \begin_inset space \hfill{}
7422 \begin_layout Itemize
7426 \begin_inset space \hfill{}
7432 \begin_layout Standard
7436 \begin_layout Section
7440 \begin_layout Standard
7445 can be used to type letters according to German conventions.
7446 A template file is included in
7448 .../lyx/share/templates
7450 for you to use as a starting point.
7453 \begin_layout Section
7461 \begin_layout Standard
7467 \begin_layout Subsection
7471 \begin_layout Standard
7472 This is the layout file for the European Geophysical Society journals.
7477 can be downloaded from the web site of the EGS under
7478 \begin_inset Flex URL
7481 \begin_layout Plain Layout
7491 \begin_layout Subsection
7495 \begin_layout Standard
7498 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7506 The current layout file is unfortunately very unmodular and would benefit
7507 from using the various
7514 \begin_layout Section
7518 \begin_layout Standard
7524 \begin_layout Standard
7525 Elsevier Science Publishers B.V.
7526 provides a standard LaTeX document class (
7530 ) for submitting articles to their various journals.
7531 The style file can be downloaded directly from their web site:
7532 \begin_inset Flex URL
7535 \begin_layout Plain Layout
7537 http://authors.elsevier.com/
7543 Instructions are supplied along with the class file, which details the
7544 requirements of the publishers.
7545 LyX includes package that allows for the use of this class, by a layout
7546 and a template file.
7547 Installation of the class file is the same as for any other LaTeX package;
7548 instructions are provided in the Elsevier documentation.
7551 \begin_layout Standard
7561 As the Elsevier class file is based mainly on the standard article class,
7562 most of the normal functionality is provided.
7563 The Elsevier class defines a number of mathematical environments, which
7564 are similar to the AMS environments.
7565 These commands are all described in the Elsevier documentation, and are
7569 \begin_layout Standard
7570 The easiest way to use the Elsevier style is to base documents on the included
7572 It is best not to use options such as fancy headings or the geometry package,
7573 as elements such as these are defined by Elsevier in their style file.
7574 Ideally, no extra packages except those mentioned in the Elsevier documentation
7576 Essentially, Elsevier require as
7577 \begin_inset Quotes eld
7581 \begin_inset Quotes erd
7584 a LaTeX file as possible, as their intention is to take the supplied file
7585 and replace the class file with one for the particular journal to which
7586 the paper has been submitted.
7587 This also means that not too much time should be spent on the formating
7589 When it comes to be published, this will change anyway.
7590 The rest of the usage for this layout is substantially the same as for
7591 the normal article class.
7592 For details of what Elsevier do and don't allow, refer to their documentation.
7595 \begin_layout Section
7604 \begin_inset CommandInset label
7613 \begin_layout Standard
7619 \begin_layout Subsection
7623 \begin_layout Standard
7624 This section describes how to use LyX to make slides for overhead projectors.
7625 There are two document classes that can do this: the default slides class
7631 This section documents the latter.
7634 \begin_layout Standard
7635 I'm going to say this again, nice and clear, so that there's no misunderstanding
7639 \begin_layout Standard
7640 \begin_inset VSpace bigskip
7646 \begin_layout Standard
7650 This section documents the class
7651 \begin_inset Quotes eld
7659 \begin_inset Quotes erd
7667 \begin_layout Standard
7668 \begin_inset VSpace bigskip
7674 \begin_layout Standard
7675 If you're looking for the documentation for
7676 \begin_inset Quotes eld
7684 \begin_inset Quotes erd
7688 \begin_inset space ~
7692 \begin_inset CommandInset ref
7694 reference "sec:slitex"
7699 If your machine doesn't have the
7704 \begin_inset Quotes eld
7712 \begin_inset Quotes erd
7715 ] installed, you'll probably have to use the default
7719 class, which isn't quite as good as
7724 \begin_layout Standard
7729 class is designed for use with version 2.1 of the
7733 LaTeX class file which is now an integral part of LaTeX2e.
7736 \begin_layout Subsection
7740 \begin_layout Standard
7741 Obviously, to use this document class, you need to select
7742 \begin_inset Quotes eld
7750 \begin_inset Quotes erd
7760 \begin_inset space ~
7766 There are some settings in the
7769 \begin_inset space ~
7774 dialog that you should know about that are specific to this class:
7777 \begin_layout Itemize
7778 Don't change the options
7789 \begin_inset space ~
7795 They're ignored by the
7802 \begin_layout Itemize
7803 The default font size is 20
7804 \begin_inset space \thinspace{}
7807 pt with the other options being 17
7808 \begin_inset space \thinspace{}
7812 \begin_inset space \thinspace{}
7816 \begin_inset space \thinspace{}
7822 \begin_layout Itemize
7831 but all math equations are still typeset in the usual roman font.
7834 \begin_layout Itemize
7839 TeX supports A4 and Letter paper sizes as well as a special size for working
7841 \begin_inset space \thinspace{}
7845 It doesn't support A5, B5, legal or executive paper sizes.
7848 \begin_layout Itemize
7849 Don't bother changing the
7853 settings because they are ignored anyway.
7854 All floats appear where they are defined in the text.
7857 \begin_layout Itemize
7862 setting behaves a bit differently for this class.
7867 TeX provides extensive footer and header capabilities including a user-defined
7870 \begin_inset space ~
7874 \begin_inset CommandInset ref
7876 reference "sec:foilfoot"
7881 The title page is treated differently to all other pages in the document
7890 has the logo centered at the bottom of the page (if one is defined).
7891 The possible page style choices and what they do are as follows:
7895 \begin_layout Labeling
7896 \labelwidthstring MMMMMMM
7903 The final output contains no page numbers, or other headers or footers
7904 (except footnotes of course).
7908 \begin_layout Labeling
7909 \labelwidthstring MMMMMMM
7916 The final output contains page numbers centered at the bottom of the page.
7917 No other headings or footers (other than footnotes).
7920 \begin_layout Labeling
7921 \labelwidthstring MMMMMMM
7926 Page numbers in lower right corner.
7927 Additional headers and footers are also shown.
7928 This is also the default.
7931 \begin_layout Labeling
7932 \labelwidthstring MMMMMMM
7937 Gives you access to the
7941 package although its use with
7945 TeX is discouraged by the writer of the
7949 TeX package because of some potential page layout clashes.
7953 \begin_layout Subsubsection
7957 \begin_layout Standard
7958 The following options may be used in the extra class options in the
7960 Document\SpecialChar \menuseparator
7966 \begin_layout Labeling
7967 \labelwidthstring MMMMMMx
7972 This sets up the page layout for 7.33
7973 \begin_inset space \thinspace{}
7977 \begin_inset space \thinspace{}
7980 in paper, which is about the same aspect ratio as a 35
7981 \begin_inset space \thinspace{}
7984 mm slide, making it a bit easier to work with this medium.
7987 \begin_layout Labeling
7988 \labelwidthstring MMMMMMx
7993 Places a rule across the page below the header on every page except the
7997 \begin_layout Labeling
7998 \labelwidthstring MMMMMMx
8003 Places a rule across the page above the footer on every page except the
8007 \begin_layout Labeling
8008 \labelwidthstring MMMMMMx
8013 This is automatically set each time you create a new
8022 TeX to use the dvips driver to rotate those pages that are set as landscape
8026 \begin_layout Labeling
8027 \labelwidthstring MMMMMMx
8032 Simply changes the page dimensions to those of a landscape page but doesn't
8034 Thus if you use this option you need to use an external program to rotate
8035 each page or feed your paper through your printer as landscape.
8036 Note that this option effectively reverses the roles of the
8044 environments (don't worry these are described in the next section).
8047 \begin_layout Labeling
8048 \labelwidthstring MMMMMMx
8053 Equation numbers on the left.
8056 \begin_layout Labeling
8057 \labelwidthstring MMMMMMx
8062 Flush-left equations.
8065 \begin_layout Subsection
8066 Supported Environments
8069 \begin_layout Standard
8070 Most of the environments commonly supported in other classes are also supported
8076 There are several additional environments provided by
8080 TeX as well as a couple added by LyX.
8081 The following environments are shared with other classes:
8084 \begin_layout Standard
8088 \begin_layout Plain Layout
8100 \begin_layout Itemize
8106 \begin_layout Itemize
8112 \begin_layout Itemize
8118 \begin_layout Itemize
8124 \begin_layout Itemize
8130 \begin_layout Itemize
8136 \begin_layout Itemize
8142 \begin_layout Itemize
8148 \begin_layout Itemize
8154 \begin_layout Itemize
8160 \begin_layout Itemize
8166 \begin_layout Itemize
8172 \begin_layout Itemize
8178 \begin_layout Itemize
8184 \begin_layout Itemize
8190 \begin_layout Itemize
8196 \begin_layout Itemize
8202 \begin_layout Itemize
8208 \begin_layout Standard
8212 \begin_layout Plain Layout
8224 \begin_layout Standard
8225 That is, all the major environments apart from the sectioning environments.
8226 Since foils are essentially self-contained sections, with a title and body,
8231 TeX provides specific commands for starting new foils and these are:
8234 \begin_layout Itemize
8240 \begin_layout Itemize
8246 \begin_layout Standard
8247 LyX also provides slightly modified versions of these two environments called:
8250 \begin_layout Itemize
8256 \begin_layout Itemize
8262 \begin_layout Standard
8263 and the differences will be explained in the next section.
8266 \begin_layout Standard
8267 Since foils are often used in presenting ideas or new theorems and such
8272 TeX also provides a comprehensive box of goodies for presenting them:
8275 \begin_layout Standard
8279 \begin_layout Plain Layout
8291 \begin_layout Itemize
8297 \begin_layout Itemize
8303 \begin_layout Itemize
8309 \begin_layout Itemize
8315 \begin_layout Itemize
8321 \begin_layout Itemize
8327 \begin_layout Itemize
8333 \begin_layout Itemize
8339 \begin_layout Itemize
8345 \begin_layout Itemize
8351 \begin_layout Itemize
8357 \begin_layout Standard
8361 \begin_layout Plain Layout
8373 \begin_layout Standard
8374 The starred versions are unnumbered while the unstarred versions are numbered.
8375 There are also two list environments added by LyX and these are:
8378 \begin_layout Itemize
8384 \begin_layout Itemize
8390 \begin_layout Standard
8395 TeX provides some powerful header and footer capabilities that are best
8396 set in the preamble although they may be set at any point in a document.
8397 If you want to change these settings in your document the best place to
8398 do so is at the very top of a foil, i.e.
8401 \begin_inset space \space{}
8406 straight after the foilhead.
8409 \begin_layout Standard
8410 For this purpose, the following command styles are provided [
8417 \begin_layout Standard
8421 \begin_layout Plain Layout
8433 \begin_layout Itemize
8437 \begin_inset space ~
8443 \begin_layout Itemize
8449 \begin_layout Itemize
8453 \begin_inset space ~
8459 \begin_layout Itemize
8463 \begin_inset space ~
8469 \begin_layout Itemize
8473 \begin_inset space ~
8480 \begin_layout Standard
8481 \begin_inset space ~
8488 \begin_layout Standard
8492 \begin_layout Plain Layout
8504 \begin_layout Standard
8505 There are also a few commands provided by
8509 TeX that aren't directly supported by LyX but I'll tell you what they do
8510 and how to use them in section
8511 \begin_inset space ~
8515 \begin_inset CommandInset ref
8517 reference "sec:unsuppfoils"
8524 \begin_layout Subsection
8525 Building a Set of Foils
8528 \begin_layout Standard
8529 This section will give a simple introduction to using the different environments
8530 to build a set of foils.
8531 If you want to see an example set of foils, take a look at the
8535 file you find in LyX's
8542 \begin_layout Subsubsection
8543 Give It a Title Page
8546 \begin_layout Standard
8547 Unlike other classes that provide
8567 creates the title on a page of its own.
8568 If you leave out the
8572 environment LaTeX will substitute the current date (every time you regenerate
8576 \begin_layout Subsubsection
8580 \begin_layout Standard
8581 As I mentioned earlier, there are four ways of starting a new foil.
8582 For portrait foils you should use
8591 The difference between these two environments is the amount of space between
8592 the title of the foil (the foilhead) and the body of the foil.
8595 \begin_layout Standard
8596 Landscape foils are generated using the
8605 Again the only difference is the spacing between foilhead and body.
8606 Both of the short versions have 0.5 inches less separation between the foilhead
8611 \begin_layout Standard
8612 One problem with the support for landscape foils is the requirement that
8617 driver to generate the PostScript output otherwise the foils won't be rotated.
8618 It is possible to get landscape foils even if you haven't got the
8622 driver provided you can feed your foils sideways through your printer ;-)
8625 \begin_layout Subsubsection
8626 Theorems, Lemmas, Proofs and more
8629 \begin_layout Standard
8630 Due to a small bug in LyX you can't have two of the same type of these environme
8631 nts directly following each other.
8632 They must be separated by something.
8633 If you try, you will just be extending the previous environment as if you
8634 had merged the two environments together.
8635 So, how do you get around this problem? The simplest option is to insert
8636 some text between the two environments or add a
8640 environment between the two with just a
8641 \begin_inset Quotes eld
8649 \begin_inset Quotes erd
8653 This will force LyX to produce two separate environments and hence the
8654 correct LaTeX output.
8655 An example is provided in the example file included with the LyX distribution.
8656 Remember, this problem only occurs if you are trying to place two of the
8657 same type of theorem-like environments one directly after the other.
8660 \begin_layout Subsubsection
8664 \begin_layout Standard
8665 You get all the commonly supported list styles found in other classes as
8666 well as two new ones.
8667 I'll only describe the new ones here.
8668 If you want to find out more about the other list environments check out
8674 If you intend to use itemized lists you might also want to read about the
8678 \begin_inset space ~
8682 \begin_inset space ~
8687 dialog described above in section
8688 \begin_inset space ~
8692 \begin_inset CommandInset ref
8694 reference "sec:bullet"
8701 \begin_layout Standard
8702 The two new list styles,
8710 , are designed to make it easier for you to create lists of do's and don'ts
8711 or right and wrong by providing dedicated environments that use a tick
8712 or a cross as the label of the list.
8713 These lists are in fact dedicated variants of the
8718 They do however require that you have the
8725 \begin_layout Subsubsection
8729 \begin_layout Standard
8734 TeX redefines the floating tables and figures so that they appear exactly
8735 where they are in the text rather than pushing them to the top of the page
8736 or to some user specified location.
8737 In fact if you change the float placement settings they are simply ignored.
8740 \begin_layout Subsubsection
8741 Page Headers and Footers
8742 \begin_inset CommandInset label
8751 \begin_layout Standard
8755 \begin_inset space ~
8764 are two commands used to control the left-footer text string.
8765 The first is meant to allow you to include a graphic logo on your foils
8767 \begin_inset Quotes eld
8775 \begin_inset Quotes erd
8779 While the second is meant to provide a classification for the audience,
8785 \begin_inset space \space{}
8789 It is empty by default.
8792 \begin_layout Standard
8793 The remaining page corners can be filled by
8796 \begin_inset space ~
8801 (which defaults to page numbers),
8804 \begin_inset space ~
8812 \begin_inset space ~
8820 \begin_layout Subsection
8826 \begin_inset CommandInset label
8828 name "sec:unsuppfoils"
8835 \begin_layout Standard
8836 All the commands mentioned below need to be set in a
8844 within another environment.
8847 \begin_layout Subsubsection
8851 \begin_layout Standard
8852 All lengths are adjusted using the
8875 should be replaced by the name given to the length you want to change and
8880 is the length value.
8881 All lengths should be specified in units of length such as inches (
8893 ) or relative to some document or font-based length such as
8903 \begin_layout Standard
8904 It's possible to change the spacing between a foilhead and the body of the
8905 foil by adjusting the length specified by
8912 For example, to make
8917 \begin_inset space \space{}
8920 in closer to their bodies put the following in the preamble:
8926 foilheadskip}{-0.5in}
8929 \begin_layout Standard
8930 The spacings around floats can be adjusted by setting these lengths:
8933 \begin_layout Labeling
8934 \labelwidthstring MMMMMMMMMMM
8941 Separation between the text and the top of the float
8944 \begin_layout Labeling
8945 \labelwidthstring MMMMMMMMMMM
8952 Separation between the float and the caption
8955 \begin_layout Labeling
8956 \labelwidthstring MMMMMMMMMMM
8963 Separation between the caption and the following text
8966 \begin_layout Labeling
8967 \labelwidthstring MMMMMMMMMMM
8974 You can make the captions narrower than the surrounding text by adjusting
8976 Best done relative to
8985 \begin_layout Standard
8986 There are also several title page related lengths that you may find useful
8987 if you have a long title or several authors:
8990 \begin_layout Labeling
8991 \labelwidthstring MMMMMMMMMMM
8998 Separation from headers to
9003 \begin_layout Labeling
9004 \labelwidthstring MMMMMMMMMMM
9022 \begin_layout Labeling
9023 \labelwidthstring MMMMMMMMMMM
9037 \begin_layout Labeling
9038 \labelwidthstring MMMMMMMMMMM
9054 \begin_layout Labeling
9055 \labelwidthstring MMMMMMMMMMM
9071 \begin_layout Standard
9072 The last length related command affects all the list environments.
9083 a list environment then all the vertical spacing between the list items
9085 Note that this is a command not a length so it doesn't require
9091 like the stuff mentioned above.
9094 \begin_layout Subsubsection
9098 \begin_layout Standard
9111 commands control whether the logo in the
9115 definition appear on a given page.
9122 in the preamble then none of the foils will have the logo on them.
9123 If you don't want the logo on a particular page place the
9129 directly after the foilhead of that page and the
9135 directly after the next foilhead.
9138 \begin_layout Standard
9139 If you decide to use the
9143 page style setting in the
9146 \begin_inset space ~
9151 dialog you should probably add
9161 to your preamble so headers and footers on landscape pages are correctly
9162 placed when rotated.
9163 This is due to some clashes between the page layouts provided by the
9174 \begin_layout Section
9175 Hollywood (Hollywood spec scripts)
9178 \begin_layout Standard
9184 \begin_layout Subsection
9188 \begin_layout Standard
9189 Getting the format of a Hollywood script right is a
9190 \begin_inset Quotes eld
9194 \begin_inset Quotes erd
9197 It is designed to make the readers focus on content and to be easy and
9198 familiar for the actors to read.
9199 Each page of a script should be one minute of film.
9200 Nothing goes in a script that you cannot see or hear on screen.
9201 The courier 12 pt font should be used throughout.
9205 \begin_layout Subsection
9209 \begin_layout Standard
9210 Speakers' lines should NEVER break in mid-sentence.
9211 If a speaker's lines continue over a page break, repeat the
9215 title followed by (Cont'd).
9218 \begin_layout Subsection
9222 \begin_layout Standard
9227 names as labels then cross-reference the label to insert the name.
9228 The cross-reference dialog will show the current cast of characters.
9229 You can use this to insert the speaker name in narratives also.
9232 \begin_layout Subsection
9233 Paper size and Margins
9236 \begin_layout Standard
9237 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9240 \begin_layout Subsection
9244 \begin_layout Standard
9245 The following environments are available.
9246 You can use hollywood.bind to get the bind keys shown at the right.
9249 \begin_layout Itemize
9253 \begin_inset Newline newline
9258 Used where nothing else works.
9262 \begin_layout Itemize
9268 \begin_inset space \hfill{}
9276 \begin_inset Newline newline
9279 Usually followed by something like
9280 \begin_inset Quotes eld
9284 \begin_inset Quotes erd
9290 \begin_layout Itemize
9294 \begin_inset space \hfill{}
9298 \begin_inset Newline newline
9303 Introduces a new INTERIOR camera set-up.
9304 Always followed by DAY or NIGHT, or something similar to define the lighting
9306 Everthing on this line in CAPS.
9309 \begin_layout Itemize
9313 \begin_inset space \hfill{}
9317 \begin_inset Newline newline
9322 Introduces a new EXTERIOR camera set-up.
9323 Everthing on this line in CAPS.
9326 \begin_layout Itemize
9330 \begin_inset space \hfill{}
9334 \begin_inset Newline newline
9339 The character speaking.
9342 \begin_layout Itemize
9346 \begin_inset space \hfill{}
9350 \begin_inset Newline newline
9355 Instructions to the speaker.
9356 The () are automatically inserted, but only the ( will show in LyX.
9357 Both will be printed.
9360 \begin_layout Itemize
9364 \begin_inset space \hfill{}
9368 \begin_inset Newline newline
9380 \begin_layout Itemize
9384 \begin_inset space \hfill{}
9388 \begin_inset Newline newline
9393 Camera movement instruction.
9395 \begin_inset space \space{}
9401 \begin_layout Itemize
9405 \begin_inset space \hfill{}
9411 \begin_layout Itemize
9415 \begin_inset space \hfill{}
9421 \begin_layout Itemize
9425 \begin_inset space \hfill{}
9431 \begin_layout Itemize
9435 \begin_inset space \hfill{}
9441 \begin_layout Subsection
9445 \begin_layout Itemize
9446 (O.S) --- off screen
9449 \begin_layout Itemize
9450 (V.0) --- voice over
9453 \begin_layout Itemize
9458 \begin_layout Itemize
9463 \begin_layout Itemize
9464 PAN --- camera movement
9467 \begin_layout Itemize
9468 INSERT --- cut to close-up of
9471 \begin_layout Section
9475 \begin_layout Standard
9478 Panayotis Papasotiriou
9481 \begin_layout Subsection
9485 \begin_layout Standard
9486 The ijmpc package is a set of macros that facilitates electronic manuscript
9489 International Journal of Modern Physics C
9492 Similarly, the ijmpd package is for creating manuscripts to be submitted
9495 International Journal of Modern Physics D
9498 Both journals are published by World Scientific.
9499 The corresponding document classes are named
9508 These files, together with instructions for the authors, can be downloaded
9510 \begin_inset Flex URL
9513 \begin_layout Plain Layout
9515 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9521 \begin_inset Flex URL
9524 \begin_layout Plain Layout
9526 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9532 Both packages are modified versions of the standard
9533 \begin_inset Quotes eld
9537 \begin_inset Quotes erd
9540 package, and they are almost (but not exactly) identical.
9541 Most of their features are supported by LyX.
9542 I have used LyX successfully to write articles submitted to both journals
9543 without any problem.
9546 \begin_layout Subsection
9550 \begin_layout Standard
9551 As usual, the easiest way to write a paper is to start with a template.
9557 ile\SpecialChar \menuseparator
9576 This will give an (almost) empty document that includes the most common
9577 fields found in a manuscript.
9578 Simply overwrite the existing text (including the brackets,
9583 You should keep in mind the following remarks.
9586 \begin_layout Enumerate
9587 LyX won't let you change the font size and the page style of the document,
9588 because such modifications are not allowed by both packages.
9591 \begin_layout Enumerate
9592 The language of the document should not be changed.
9593 Before previewing your paper, be sure that the babel package is not used.
9594 To do this, click on
9599 ools\SpecialChar \menuseparator
9617 checkbox in the language settings, and click on
9628 , if you wish to make this change permanent).
9631 \begin_layout Enumerate
9633 \begin_inset Quotes eld
9637 \begin_inset Quotes erd
9640 style must be used to define keywords.
9643 \begin_layout Enumerate
9644 The ijmpc package provides a style named
9645 \begin_inset Quotes eld
9648 Classification Codes
9649 \begin_inset Quotes erd
9652 , which can be used to define classification codes, such as PACS numbers.
9653 Note that this facility is not supported by the ijmpd package.
9656 \begin_layout Enumerate
9657 Several new environments are available:
9658 \begin_inset Quotes eld
9662 \begin_inset Quotes erd
9666 \begin_inset Quotes eld
9670 \begin_inset Quotes erd
9674 \begin_inset Quotes eld
9678 \begin_inset Quotes erd
9682 \begin_inset Quotes eld
9686 \begin_inset Quotes erd
9690 \begin_inset Quotes eld
9694 \begin_inset Quotes erd
9698 \begin_inset Quotes eld
9702 \begin_inset Quotes erd
9706 \begin_inset Quotes eld
9710 \begin_inset Quotes erd
9714 \begin_inset Quotes eld
9718 \begin_inset Quotes erd
9722 \begin_inset Quotes eld
9726 \begin_inset Quotes erd
9730 \begin_inset Quotes eld
9734 \begin_inset Quotes erd
9738 \begin_inset Quotes eld
9742 \begin_inset Quotes erd
9746 \begin_inset Quotes eld
9750 \begin_inset Quotes erd
9754 \begin_inset Quotes eld
9758 \begin_inset Quotes erd
9762 \begin_inset Quotes eld
9766 \begin_inset Quotes erd
9770 Their use is more or less obvious.
9771 LyX supports all these environments; it will use the proper label, text
9772 style, and numbering scheme for each of them.
9775 \begin_layout Enumerate
9776 Both packages use basic citations; the natbib package should not be used.
9777 In LyX, citation references are shown as usual; in the output, citations
9778 are shown as superscripts.
9779 If you want to use a citation as normal text, you should use the
9784 \begin_inset space \space{}
9788 \begin_inset Quotes eld
9792 \begin_inset space \space{}
9802 \begin_inset Quotes erd
9808 \begin_layout Enumerate
9810 \begin_inset Quotes eld
9814 \begin_inset Quotes erd
9817 section in both packages.
9818 To put acknowledgments, just use the
9819 \begin_inset Quotes eld
9823 \begin_inset Quotes erd
9829 \begin_layout Enumerate
9830 Appendices may be added to the paper,
9834 the Acknowledgments and
9839 LyX provides a special environment, called
9840 \begin_inset Quotes eld
9844 \begin_inset Quotes erd
9847 which marks the beginning of the appendices.
9848 This environment should be left blank; it just sends a LaTeX command, but
9849 nothing is really printed.
9851 \begin_inset Quotes eld
9855 \begin_inset Quotes erd
9858 is printed with blue letters, as a signal that all sections after that
9859 point are appendices.
9860 To write an appendix, use the
9861 \begin_inset Quotes eld
9865 \begin_inset Quotes erd
9869 LyX will number each appendix with capital letters, as required by both
9872 \begin_inset Quotes eld
9876 \begin_inset Quotes erd
9883 be present before the first appendix; if not, all appendices will be numbered
9884 as normal sections in the output.
9887 \begin_layout Enumerate
9888 The ijmpc and the ijmpd packages use the
9892 command to implement table captions.
9893 As a result, a table created by LyX is printed correctly, but its caption
9895 However, you can use some ERT to overpass this problem, so that captions
9896 are printed as expected.
9897 To do so, create a float table as usual, remove the caption, and replace
9908 (sic); you must also the ERT
9912 immediately after the tabular material.
9913 Study the example table included in the template files to see how this
9914 trick is implemented.
9915 Alternatively, If you need table captions, you should implement the whole
9920 file, then include this file to the LyX document (
9925 nsert\SpecialChar \menuseparator
9930 \SpecialChar \menuseparator
9936 \begin_inset space ~
9942 Details on how to create a table float can be found in the files
9950 , included in the corresponding packages.
9953 \begin_layout Subsection
9954 Preparing a paper for submission
9957 \begin_layout Standard
9958 Before you submit your paper you must export the LyX document as a LaTeX
9964 ile\SpecialChar \menuseparator
9969 xport\SpecialChar \menuseparator
9984 \begin_layout Plain Layout
9985 Actually you have the choice between LaTeX (plain) and pdflatex.
9986 If you intend to use pdflatex to prepare the paper, you should use the
9987 pdflatex option so that included graphics are converted to PDF format,
9988 ready for use by pdflatex.
9993 , then make the following changes to the resulting
10000 \begin_layout Enumerate
10001 Remove the comment lines before the
10010 \begin_layout Enumerate
10011 Remove everything between (and including) the
10023 commands, except for any commands you specifically put into the LaTeX preamble.
10026 \begin_layout Standard
10031 file should be saved and processed through LaTeX as many times as necessary.
10032 You may also want to check the resulting
10039 \begin_layout Subsection
10043 \begin_layout Standard
10044 The use of ERT is reduced to two commands, which must be placed at the top
10046 If you started writing your paper by using the
10054 template, the ERT needed is already in its place; you usually don't need
10056 You may only modify the first ERT to specify the information printed to
10057 the top of odd and even pages (authors' names and short paper's title,
10059 This ERT must have the form
10063 markboth{Authors' Names}{Short Paper's Title}
10068 \begin_layout Section
10072 \begin_layout Standard
10078 \begin_layout Subsection
10082 \begin_layout Standard
10083 The iopart package provides a document class to create electronic manuscript
10084 submission to the journals published by the Institute of Physics.
10085 Instructions for the authors how to create a paper using the iopart class
10086 can be downloaded together with the iopart package from the site
10087 \begin_inset Flex URL
10090 \begin_layout Plain Layout
10092 ftp://ftp.iop.org/pub/journals/latex2e
10100 \begin_layout Subsection
10104 \begin_layout Standard
10105 The easiest way to write a paper is to start with the file
10109 that is available in LyX's examples files folder.
10110 Open this file, save it under a new name, and start writing.
10111 The example file explains how to use the special text environments.
10112 Here are the most important advices:
10115 \begin_layout Itemize
10116 To be able to compile your document to a PDF, PS, or DVI, assure that the
10119 Use AMS math package
10121 in the document settings under
10128 \begin_layout Itemize
10131 The title environment defines the kind of your paper.
10132 So use one of the following environments for the title:
10136 \begin_layout Itemize
10145 \begin_layout Itemize
10154 \begin_layout Itemize
10160 for a Topical review
10163 \begin_layout Itemize
10172 \begin_layout Itemize
10181 \begin_layout Itemize
10187 for a Paper (same as Title)
10190 \begin_layout Itemize
10196 for a Preliminary communication
10199 \begin_layout Itemize
10205 for a Rapid communication
10208 \begin_layout Itemize
10214 for a Letter to the editor
10218 \begin_layout Itemize
10221 All title environments except of
10225 can have an optional short title.
10228 \begin_layout Itemize
10229 There is a general title environment
10233 which is not directly supported by the LyX.
10234 This can be used as ERT when your document doesn't fit into one of the
10238 \begin_layout Standard
10239 For more informations like hints for special table and formula formatting,
10240 look at the IOP author guidelines.
10243 \begin_layout Section
10247 \begin_layout Standard
10250 Panayotis Papasotiriou
10253 \begin_layout Subsection
10257 \begin_layout Standard
10258 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10259 that facilitates electronic manuscript submission to the journals they
10261 Most known of them (at least in my domain of interest) are
10263 Astrophysics and Space Science
10269 , but there are many others (see a complete list at
10270 \begin_inset Flex URL
10273 \begin_layout Plain Layout
10275 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10281 The Kluwer package may be downloaded from the site
10282 \begin_inset Flex URL
10285 \begin_layout Plain Layout
10287 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10293 A complete user guide is contained in that package (but it can also be
10294 downloaded separately).
10297 \begin_layout Standard
10298 LyX supports many features of the package but not everything.
10299 However, the ERT needed is reduced to some
10300 \begin_inset Quotes eld
10304 \begin_inset Quotes erd
10307 commands of the package (see
10308 \begin_inset space ~
10312 \begin_inset CommandInset ref
10314 reference "subsec:kluwer_peculiarities"
10319 I have recently used LyX to write an article submitted to the
10321 Astrophysics and Space Science
10323 without any problem.
10326 \begin_layout Subsection
10330 \begin_layout Standard
10331 The easiest way to write a paper is to start with the Kluwer template file.
10334 File\SpecialChar \menuseparator
10346 This will give an (almost) empty document that includes the most common
10347 fields found in a manuscript and a short description of their use.
10348 As in most templates, simply overwrite the existing text (including the
10353 ) with the correct information.
10356 \begin_layout Subsection
10357 Preparing a paper for submission
10360 \begin_layout Standard
10361 As in the AASTeX package, before you submit your paper to a journal you
10363 \begin_inset Quotes eld
10367 \begin_inset Quotes erd
10373 \begin_layout Enumerate
10374 Export your paper as a LaTeX file.
10375 To do this, click on
10377 File\SpecialChar \menuseparator
10378 Export\SpecialChar \menuseparator
10385 \begin_layout Enumerate
10390 file with a text editor and make the following changes
10394 \begin_layout Enumerate
10395 remove the comment lines before the
10404 \begin_layout Enumerate
10405 remove everything between (and including) the
10417 commands, except for any commands you specifically put into the LaTeX preamble.
10420 \begin_layout Standard
10429 \begin_layout Enumerate
10434 file through LaTeX as many times as necessary (usually up to three).
10437 \begin_layout Enumerate
10442 document using, e.g.
10443 \begin_inset space \space{}
10450 , and check if everything is OK (it should, if you didn't make any mistake).
10453 \begin_layout Subsection
10454 \begin_inset Quotes eld
10458 \begin_inset Quotes erd
10461 of the Kluwer package
10462 \begin_inset CommandInset label
10464 name "subsec:kluwer_peculiarities"
10471 \begin_layout Standard
10472 The Kluwer package has the following
10473 \begin_inset Quotes eld
10477 \begin_inset Quotes erd
10483 \begin_layout Enumerate
10484 It is possible to write multiple articles in the same LaTeX file
10488 \begin_layout Plain Layout
10489 I can't imagine any good reason to do this.
10495 Each article must be included in the environment
10496 \begin_inset Quotes eld
10500 \begin_inset Quotes erd
10504 Unfortunately, this environment cannot be omitted, even if you write just
10506 Therefore, each article starts with the command
10512 and, obviously, ends with the command
10519 Although this can be implemented in LyX, I didn't included it, since it
10520 looks ugly and can confuse the novice user.
10521 Therefore, you need to enter them directly and mark them as LaTeX code
10523 \begin_inset Quotes eld
10527 \begin_inset Quotes erd
10533 \begin_layout Enumerate
10534 Information given at the beginning of the article (i.e.
10535 \begin_inset space \space{}
10538 title, subtitle, author, institution, running title, running author, abstract
10539 and keywords) must be included in an environment called
10540 \begin_inset Quotes eld
10544 \begin_inset Quotes erd
10548 This is not implemented in LyX, so you must enter title, subtitle etc.
10549 \begin_inset space ~
10552 between two ERT lines (
10567 \begin_layout Enumerate
10568 According to the user manual, the label of each bibliography item must be
10592 \begin_layout Standard
10597 template takes care of all these
10598 \begin_inset Quotes eld
10602 \begin_inset Quotes erd
10606 If you start a new paper using this template you don't need to do anything
10611 \begin_layout Enumerate
10612 don't delete the ERT included in the template, and
10615 \begin_layout Enumerate
10616 copy the example bibliography item included in the template and modify it
10617 as necessary to enter new bibliography items.
10620 \begin_layout Section
10624 \begin_layout Standard
10630 \begin_layout Subsection
10634 \begin_layout Standard
10635 The LyX document classes
10637 article (koma-script)
10641 report (koma-script)
10659 correspond to the LaTeX document classes
10676 \begin_inset space ~
10679 of the Koma-Script family.
10680 They are replacements for the standard document classes
10696 , resp., and fit better to European typography conventions in a number of
10700 \begin_layout Itemize
10701 Standard character size is 11pt in
10703 article (koma-script)
10707 report (koma-script)
10715 letter (koma-script)
10720 \begin_layout Itemize
10721 Headings, labels of the description environment, and a number of elements
10724 letter (koma-script)
10726 document class are set in a bold sans serif font.
10730 \begin_layout Plain Layout
10731 There is a big difference between the bold sans serif old cm fonts and new
10732 ec fonts, especially in the appearance of headings.
10733 In comparison, the ec bold sans serif fonts look a bit thin.
10734 Here the LaTeX package
10742 helps to produce the
10743 \begin_inset Quotes eld
10747 \begin_inset Quotes erd
10750 appearance when using the ec fonts.
10755 The numbering of chapter headings is made in the same way as the numbering
10756 of section headings, that is without the extra line
10757 \begin_inset Quotes eld
10760 Chapter\SpecialChar \ldots{}
10762 \begin_inset Quotes erd
10766 In addition, the appearance of the headings can be modified by using a
10767 number of options (in LyX to be entered in the field
10774 \begin_inset space ~
10781 Layout\SpecialChar \menuseparator
10785 A detailed German description of these options can be found in the Koma-Script
10793 \begin_layout Itemize
10794 The main means in the Koma-Script document classes to design the type area
10803 (in LyX to be entered in the extra class options field in the dialog
10805 Document\SpecialChar \menuseparator
10809 They make a clearer modification of page margins possible as do the options
10812 Document\SpecialChar \menuseparator
10816 A detailed German description of these and other type area options can
10817 be found in the Koma-Script documentation
10824 \begin_layout Itemize
10825 The LaTeX document classes of the Koma-Script family define a number of
10826 additional commands.
10827 Those part of it which makes sense in LyX is implemented in corresponding
10831 \begin_layout Standard
10832 A detailed German description of the LaTeX document classes of the Koma-Script
10833 family can be found in the Koma-Script documentation
10841 \begin_layout Plain Layout
10842 There is an English translation
10846 , but it is not a complete one.
10851 The following sections describe only those aspects, which are relevant
10855 \begin_layout Subsection
10856 article (koma-script), report (koma-script), and book (koma-script)
10859 \begin_layout Standard
10860 The document classes
10862 article (koma-script)
10866 report (koma-script)
10876 are implemented in the layout files
10889 They contain all the paragraph types of the corresponding standard document
10902 , resp., partly modified, with the exception of the LyX specific
10906 -type, which is replaced by the new
10910 -type having the same functionality.
10915 -Type there is a number of new paragraph types added.
10922 letter (koma-script)
10927 \begin_layout Itemize
10936 : are equivalents to
10944 , resp., additionally inserting an entry in the table of contents.
10953 are not contained in
10955 article (koma-script)
10960 \begin_layout Itemize
10969 : behave exactly as
10977 , resp., additionally clearing running heads.
10982 is not contained in
10984 article (koma-script)
10990 \begin_layout Plain Layout
11003 report (koma-script)
11005 , but since this is identical to
11009 , is has not been implemented in LyX.
11017 \begin_layout Itemize
11022 : generates a heading directly above the following paragraph in the standard
11023 character size without affecting the structure of the document.
11026 \begin_layout Itemize
11035 are special captions which respect the different space settings needed
11036 for captions placed above or below an element (if you follow strict typographic
11037 rules, you might want to place table captions always above the table).
11038 You can also use the class option
11042 , which will switch
11055 You need at least Koma-Script version 2.8q to use this.
11058 \begin_layout Itemize
11063 : can be used to set a bonmot, e.g.
11064 \begin_inset space \space{}
11067 at the beginning of a chapter.
11068 If you use the optional argument (
11070 Insert\SpecialChar \menuseparator
11072 \begin_inset space ~
11077 ), you can insert the dictum's author there.
11078 Dictum and author are separated by a line.
11079 You need at least Koma-Script version 2.8q to use this.
11084 is not contained in
11086 article (koma-script)
11091 \begin_layout Standard
11092 The following types, together with the standard types
11104 , form the title area of the document.
11105 They must be entered ahead of the first
11106 \begin_inset Quotes eld
11110 \begin_inset Quotes erd
11117 \begin_layout Plain Layout
11118 The corresponding LaTeX commands must appear before the
11129 When such a type is used more than once, the latter usage overwrites the
11130 former one, that means, for every type only the latest usage is valid.
11131 The order of the different types however has, like
11143 , no effect on the appearance of the produced document.
11146 \begin_layout Itemize
11151 : produces a centered paragraph above the ordinary title (
11163 ) for the subject of the document.
11166 \begin_layout Itemize
11171 : produces a centered paragraph below the ordinary title (
11183 ) for the publishers' name.
11186 \begin_layout Itemize
11193 report (koma-script)
11199 produces a centered paragraph on its own page behind the title page, or
11202 article (koma-script)
11204 produces a centered paragraph below the ordinary title (
11220 ) for a dedication.
11223 \begin_layout Itemize
11228 : produces a left aligned paragraph above the ordinary title (
11244 ) for a document`s head.
11247 \begin_layout Itemize
11252 : produces in a double-sided print in
11254 report (koma-script)
11260 a left-aligned paragraph at the top of the title page`s back or has no
11261 effect in a single-sided print or in
11263 article (koma-script)
11268 \begin_layout Itemize
11273 : produces in a double-sided print in
11275 report (koma-script)
11281 a left-aligned paragraph at the bottom of the title page`s back or has
11282 no effect in a single-sided print or in
11284 article (koma-script)
11289 \begin_layout Itemize
11294 : produces a special
11295 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11302 page ahead of the actual document containing a paragraph without special
11306 \begin_layout Standard
11307 The layout files for the document classes
11309 article (koma-script)
11313 report (koma-script)
11319 do include the file
11324 This is thought of as a place to define your own types.
11329 in your personal layout directory and edit the file!
11332 \begin_layout Subsection
11333 letter (koma-script)
11336 \begin_layout Standard
11340 \begin_layout Plain Layout
11352 \begin_layout Standard
11356 letter (koma-script)
11358 is implemented in the layout file
11363 It contains all the paragraph types of the corresponding standard document
11368 , partly modified, with the exception of the LyX specific types
11380 type, which is replaced by the new
11385 In addition, it contains, in contrast to the standard document class, the
11403 Furthermore, there are a number of new letter specific types.
11406 \begin_layout Standard
11410 \begin_layout Plain Layout
11422 \begin_layout Standard
11423 The appearance of the letter produced by this document class can be controlled
11424 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11428 \begin_layout Plain Layout
11429 For example, the standard appearance of the letter`s heading, consisting
11430 of name and address, is quite self-willed.
11432 \begin_inset Quotes eld
11436 \begin_inset Quotes erd
11439 heading is produced by the following LaTeX commands in the preamble:
11442 \begin_layout LyX-Code
11452 \begin_layout LyX-Code
11468 \begin_layout LyX-Code
11478 \begin_layout LyX-Code
11498 A detailed German description of such LaTeX commands can be found in the
11499 Koma-Script documentation
11504 With it, the letter's author can produce his personal letter layout.
11507 \begin_layout Standard
11516 define the beginning of the letter and must be used in every letter.
11517 To emphasize them in the LyX document class, they are marked with the letter
11527 \begin_inset space ~
11530 in the left margin.
11531 It is possible to write any number of letters in one file.
11536 type produces a new letter using the same addressee and a
11540 type produces a new addressee.
11557 are ordinary paragraph types and can also be used several times in one
11558 and the same letter.
11561 \begin_layout Itemize
11566 : produces a paragraph for the addressee and implicitly defines the beginning
11570 \begin_layout Itemize
11575 : produces a paragraph for the form of address and implicitly produces a
11579 \begin_layout Itemize
11584 : produces a paragraph for a close.
11587 \begin_layout Itemize
11592 : produces a paragraph for a postscript.
11595 \begin_layout Itemize
11600 : produces a paragraph for a distribution list.
11603 \begin_layout Itemize
11608 : produces a paragraph for enclosures.
11611 \begin_layout Standard
11652 are input types provided with a label to enter information, which will
11653 be processed by the document class.
11657 \begin_layout Plain Layout
11658 It could be seen as a matter of inconsequence, that the types
11666 described above are not such input types as well.
11667 Because of the special meaning of those types, however, I have implemented
11668 them as ordinary paragraph types with a one letter mark in the left margin.
11669 Moreover, it would affect my feeling of symmetry, if the
11677 type had such a serious different appearance.
11682 The types must be used ahead of the corresponding
11689 \begin_layout Standard
11690 An implementation of these types in a WYSIWYG fashion does not seem to make
11691 sense, because the real appearance of the produced letter does not only
11692 depend on the usage of the particular type, but also on other factors.
11693 For example, a signature entered in the
11697 type will in the standard behavior appear in the produced letter only,
11698 when in the same letter also a
11703 The entered value of the
11707 type will in the standard behavior not appear in the produced letter at
11709 The possibility to design the letter`s heading freely is already indicated
11710 in a footnote above.
11713 \begin_layout Standard
11714 The input types can also be used as empty paragraphs.
11715 This makes sense e.g.
11716 \begin_inset space \space{}
11728 type is not used at all, in the standard behavior the value of the
11732 type is used as signature, whereas if an empty
11736 type is used, no signature value is defined.
11739 \begin_layout Standard
11740 By using the input types it is possible to write a letter template, containing
11741 filled input types with your personal dates (name, address, etc.) and empty
11742 input types for other dates you want to enter.
11745 \begin_layout Itemize
11750 : sender's name, in the standard behavior appears as a centered paragraph
11751 in small caps in the letter`s heading.
11754 \begin_layout Itemize
11759 : sender's signature, in the standard behavior appears below the
11768 type is used, the value of the
11772 type appears instead.
11775 \begin_layout Itemize
11780 : sender's address, in the standard behavior appears in a centered paragraph
11781 in the letter`s heading below the sender's name.
11784 \begin_layout Itemize
11789 : sender's telephone number, in the standard behavior only sets the LaTeX
11799 \begin_layout Itemize
11804 : place of the letter`s making.
11807 \begin_layout Itemize
11812 : date of the letter`s making.
11821 , in the standard behavior, produce the place and the date in a right-aligned
11822 line below the addressee's field.
11827 type is used, neither place nor date appear, independent of the value of
11837 type is used, the date of the letter `s production is used.
11840 \begin_layout Itemize
11845 : sender`s back address, in the standard behavior appears above the addressee's
11846 field in a small sans serif font.
11849 \begin_layout Itemize
11854 : special mail information, in the standard behavior appears underlined
11855 above the addressee's field below the back address.
11858 \begin_layout Itemize
11863 : additional information, in the standard behavior appears on right side
11864 below the addressee`s field.
11867 \begin_layout Itemize
11872 : the letter's title, in the standard behavior appears in a big, bold, sans
11873 serif font above the subject.
11876 \begin_layout Itemize
11881 : the letter's subject, in the standard behavior appears in a bold font
11889 \begin_layout Standard
11910 produce a business letter like line above the
11914 line containing the fields
11915 \begin_inset Quotes eld
11919 \begin_inset Quotes erd
11923 \begin_inset Quotes eld
11927 \begin_inset Quotes erd
11931 \begin_inset Quotes eld
11935 \begin_inset Quotes erd
11939 \begin_inset Quotes eld
11943 \begin_inset Quotes erd
11947 \begin_inset Quotes eld
11951 \begin_inset Quotes erd
11955 \begin_inset Quotes eld
11959 \begin_inset Quotes erd
11963 For the date field, the value of the
11969 \begin_inset Quotes eld
11972 business letter types
11973 \begin_inset Quotes erd
11976 is used, the value of the
11980 type however does not appear, but only the LaTeX variable
11987 The ordinary output of place and date in a right-aligned line below the
11988 addressee`s field is suppressed.
11989 The types are implemented as input types provided with a label and must
11990 be used ahead of the corresponding
11997 \begin_layout Itemize
12005 \begin_layout Itemize
12013 \begin_layout Itemize
12021 \begin_layout Itemize
12029 \begin_layout Itemize
12037 \begin_layout Subsection
12038 The new letter class: letter (koma-script v.2)
12041 \begin_layout Standard
12044 Jürgen Spitzmüller
12047 \begin_layout Standard
12048 \begin_inset VSpace medskip
12054 \begin_layout Standard
12056 Koma-Script version 2.8 has introduced a new letter class
12060 which supersedes the now unsupported
12065 It has --- on the LaTeX side --- a completely new interface and is not
12066 compatible with the old class.
12067 Therefore, LyX supports both, though it is recommended to use the new class.
12070 \begin_layout Standard
12071 This class covers the same functionality as
12073 letter (koma-script),
12076 The basic items are
12080 (receiver's address, same as
12084 in the old layout),
12097 will start a new letter (i.e.
12098 \begin_inset space \space{}
12101 you can write several letters per document).
12102 New elements are sender's
12118 and the possibility to use a
12124 Insert\SpecialChar \menuseparator
12130 \begin_layout Standard
12131 The biggest improvement is, though, that the letter's layout is configurable
12132 at almost any needs.
12133 This can be done via the preamble or with a special style file (Letter
12134 Class Option, extension
12138 ), that will be read in as a class option.
12142 \begin_layout Plain Layout
12143 The KOMA package comes with some default
12148 There is, for instance, a
12152 file that follows german typesetting rules, or a
12156 that provides the default layout of the old
12161 The latter can be loaded with the class option
12170 ayout\SpecialChar \menuseparator
12175 ocument\SpecialChar \menuseparator
12187 template that is included in LyX for examples.
12188 A detailed description is to be found in the Koma-Script documentation
12196 \begin_layout Subsection
12200 \begin_layout Standard
12201 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12205 \begin_layout Itemize
12206 The chapter number of a
12210 type appears on a line of its own above the chapter heading instead of
12211 appearing in the same line ahead of it.
12212 The cause for that is the LyX internal behavior for the labeltype
12216 in the layout file.
12219 \begin_layout Itemize
12220 The headings of the types
12228 are only put in the
12229 \begin_inset Quotes eld
12233 \begin_inset Quotes erd
12236 LaTeX table of contents, but not in the LyX table of contents (
12238 Document\SpecialChar \menuseparator
12240 \begin_inset space ~
12244 \begin_inset space ~
12252 \begin_layout Itemize
12253 The paragraphs in a
12257 document class appear in a skip separation mode, not indented.
12258 This is the standard behavior, no special LaTeX commands are needed for
12262 Document\SpecialChar \menuseparator
12265 dialog the corresponding radio button indicates
12274 value always has the effect that extra LaTeX commands are inserted in the
12275 document to produce the gap, which is not what is wanted in this case.
12278 \begin_layout Section
12279 Latex8 (IEEE Conference Papers)
12282 \begin_layout Standard
12288 \begin_layout Subsection
12292 \begin_layout Standard
12293 Since this class is specifically for writing submissions to IEEE sponsored
12294 conferences I strongly recommend that you get a copy of their Authors Kit.
12299 package and associated bibliography style file is included in the kit.
12300 The Authors Kit is usually sent out by email once your initial submission
12302 There is a lot of useful information in the Authors Kit explaining formatting
12303 restrictions and so on and I will assume you have read this since that
12304 means I don't have to repeat it all here.
12307 \begin_layout Subsection
12311 \begin_layout Standard
12312 [AR\SpecialChar \@.
12316 \begin_layout Subsection
12317 Supported Environments
12320 \begin_layout Itemize
12326 \begin_layout Itemize
12332 \begin_layout Itemize
12338 \begin_layout Itemize
12344 \begin_layout Itemize
12350 \begin_layout Itemize
12356 \begin_layout Itemize
12362 \begin_layout Itemize
12368 \begin_layout Itemize
12374 \begin_layout Subsection
12375 Differences Between Screen and Paper
12378 \begin_layout Standard
12379 There are slight differences in appearance mainly with the presentation
12380 of section counters.
12381 On screen the trailing period of the section counter is missing but it
12382 will appear in the output so don't let this worry you.
12385 \begin_layout Section
12389 \begin_layout Standard
12392 Jürgen Spitzmüller
12395 \begin_layout Subsection
12399 \begin_layout Standard
12400 Memoir is a very powerful and constantly evolving class.
12401 It has been designed with regard to fictional and non-fictional literature.
12402 Its aim is to let the user have maximum control over the typesetting of
12404 Memoir is based on the standard book class, but it can also emulate the
12405 article class (see below).
12408 \begin_layout Standard
12409 Peter Wilson, the developer of Memoir, is known as the author of lots of
12410 useful packages in the LaTeX world.
12411 Most of them have been merged with Memoir.
12412 Therefore, it is much easier to layout the table of contents, appendices,
12413 chapter designs and such.
12414 LyX, though, does not support all of these goodies natively.
12415 Some of them might be added to forthcoming releases
12419 \begin_layout Plain Layout
12420 You are invited to send suggestions to
12421 \begin_inset Flex URL
12424 \begin_layout Plain Layout
12426 lyx-devel@lists.lyx.org
12436 , lots will probably never, due to the limitations of LyX's framework.
12437 Of course you can still use all features with the help of some native LaTeX
12442 \begin_layout Plain Layout
12447 \begin_layout Plain Layout
12457 \begin_inset space ~
12461 \begin_inset CommandInset ref
12463 reference "sec:Inserting-TeX-Code"
12473 In this section, we can only list those features which are natively supported
12475 For detailed descriptions (and for the rest of features) we are recommending
12476 to have a look at the detailed manual of the Memoir class
12480 \begin_layout Plain Layout
12485 \begin_layout Plain Layout
12495 \begin_inset Flex URL
12498 \begin_layout Plain Layout
12500 CTAN:/macros/latex/memoir/memman.pdf
12510 , which is not only a user guide for the class, but also both a comprehensive
12511 description on good typesetting and a superb example for good typesetting
12515 \begin_layout Subsection
12516 Basic features and restrictions
12519 \begin_layout Standard
12520 Memoir supports basically all features of the standard book classes.
12521 There are, however, some differences, as follows:
12524 \begin_layout Description
12526 \begin_inset space ~
12529 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12532 \begin_layout Description
12534 \begin_inset space ~
12537 style: The fancy page style is not supported, due to a command clash between
12538 Memoir and the fancyhdr package (they are both defining a command with
12539 the same name, which confuses LaTeX).
12540 Instead, Memoir comes with a bunch of own page styles (see
12542 Layout\SpecialChar \menuseparator
12543 Document\SpecialChar \menuseparator
12545 \begin_inset space ~
12551 If you want to use these for the chapter pages, you have to use the command
12558 in the main text or in preamble (e.g.
12559 \begin_inset space \space{}
12566 chapterstyle{companion}
12571 \begin_layout Description
12572 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12573 an optional argument in the standard classes.
12574 With this, you can specify an alternative version of the title for the
12575 table of contents and the headers (for instance, if the title is too long).
12576 In LyX, you can do this via
12578 Insert\SpecialChar \menuseparator
12580 \begin_inset space ~
12585 at the beginning of a chapter/section.
12586 Memoir features a second optional argument and thus separates the table
12587 of contents from the header.
12588 You can define three variants of a title with this: one for the main text,
12589 one for the table of contents, and one for the headers.
12590 Simply insert two optional arguments if you need this feature, the first
12591 one containing the short title for the Table of Contents, the second one
12592 containing an alternative short title for the headers.
12595 \begin_layout Description
12596 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12597 of contents, the list of figures and the list of table start a new page
12599 Memoir does not follow this route.
12600 You have to insert a page break yourself, if you want to have one.
12603 \begin_layout Description
12604 Titlepage: For some unknown reason, Memoir uses pagination on the title
12605 page (in the standard classes, title pages are
12606 \begin_inset Quotes eld
12610 \begin_inset Quotes erd
12614 \begin_inset space \space{}
12618 If you want an empty title page, type
12622 aliaspagestyle{title}{empty}
12627 \begin_layout Description
12628 Article: With the class option
12634 Layout\SpecialChar \menuseparator
12635 Document\SpecialChar \menuseparator
12637 \begin_inset space ~
12642 ), you can emulate article style.
12643 That is, counters (footnotes, figures, tables etc.) will not be reset on
12644 new chapters, chapters don't start a new page (but are---in contrary to
12646 \begin_inset Quotes eld
12650 \begin_inset Quotes erd
12653 article classes---still allowed), parts, though, use their own page, as
12657 \begin_layout Description
12658 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12659 font commands, which have been used in the old LaTeX version 2.09 (e.g.
12660 \begin_inset space \space{}
12676 It produces an error and stops LaTeX whenever such a command appears.
12681 reallows the commands and spits out warnings instead (which does at least
12683 Since a lot of packages and particularly BibTeX style files are still using
12684 those commands, we have decided to use this option by default.
12687 \begin_layout Subsection
12691 \begin_layout Standard
12692 We will only describe the features supported by LyX (which is not much currently
12694 Please consult the Memoir manual
12698 \begin_layout Plain Layout
12703 \begin_layout Plain Layout
12713 \begin_inset Flex URL
12716 \begin_layout Plain Layout
12718 CTAN:/macros/latex/memoir/memman.pdf
12731 \begin_layout Description
12732 Abstract: You may wonder why an abstract is an extra feature.
12733 Well, it is in book class.
12734 Usually books don't have abstracts.
12735 Memoir, however, has.
12736 You can use it wherever and how often you like.
12739 \begin_layout Description
12740 Chapterprecis: You may know this from belletristic: The contents of a chapter
12741 is shortly described below the title and also in the table of contents
12743 \begin_inset space \space{}
12748 Our hero arrives in Troia; he loses some friends; he finds others
12751 Chapterprecis does exactly this.
12752 It is therefore only sensible below a chapter.
12755 \begin_layout Description
12756 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12757 The epigraph environment provides an elegant way of typesetting such a
12759 The motto itself (text) and its author (source) are divided by a short
12761 Unfortunately, we have to fool LyX a bit here again, since the environment
12762 needs two arguments (text and source).
12763 In this case, we have to use curly brackets (in TeX mode) between the two
12774 <author of the slogan>.
12777 \begin_layout Description
12778 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12779 complex figurative poems).
12780 LyX can only support a few of them.
12781 One is poemtitle, which is a centered title for poems, which will also
12782 be added to the table of contents (verse is the standard environment for
12784 Memoir has some enhanced versions of verse, but you need to use ERT, because
12785 they have to be nested inside regular verse environments, which is not
12786 possible with LyX).
12789 \begin_layout Description
12790 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12793 \begin_layout Section
12794 Article (mwart), book (mwbk) and report (mwrep)
12795 \begin_inset OptArg
12798 \begin_layout Plain Layout
12811 \begin_layout Standard
12817 \begin_layout Standard
12818 The LyX document classes
12834 correspond to the LaTeX document classes
12847 They are replacements for the standard document classes
12859 , resp., and fit better to Polish typography conventions in a number of points.
12863 \begin_layout Standard
12867 \begin_layout Itemize
12868 Unnumbered titles (with star, e.g.
12869 \begin_inset space \space{}
12876 ) are added into table of contents,
12879 \begin_layout Itemize
12880 Additional page styles:
12884 \begin_layout Description
12885 uheadings header with separated lines,
12888 \begin_layout Description
12889 myheadings custom header, contents headers via commands:
12904 \begin_layout Description
12905 myuheadings custom header with separated lines,
12908 \begin_layout Description
12909 outer page number is placed on outer side of page
12913 \begin_layout Itemize
12918 \begin_layout Description
12919 rmheadings serif titles --- default,
12922 \begin_layout Description
12923 sfheadings sansserif titles,
12926 \begin_layout Description
12927 authortitle on title page first placed is author next title --- default,
12930 \begin_layout Description
12931 titleauthor on title page first placed is title next author,
12934 \begin_layout Description
12935 withmarginpar reserve place on page for margins.
12939 \begin_layout Section
12943 \begin_layout Standard
12948 provides an alternative to the standard
12953 It provides similar functionality, but you might prefer this layout with
12954 sans serif sections, headings, and more.
12957 \begin_layout Section
12961 \begin_layout Standard
12967 \begin_layout Standard
12968 \begin_inset VSpace bigskip
12974 \begin_layout Standard
12979 \begin_inset space ~
12984 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12985 \begin_inset Formula $\beta$
12988 release of May, 1999) class.
12991 \begin_layout Standard
12996 textclass, which works with RevTeX 3.1.
12997 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12998 That means that it doesn't interact very well with LyX, which requires
12999 LaTeX2e, although it has been kludged to work.
13000 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13004 \begin_inset space ~
13009 textclass should also be pretty easy to use.
13012 \begin_layout Standard
13013 These documents are supposed to be used in
13017 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13018 macros, and assume you'll know what to put in the preamble if necessary.
13021 \begin_layout Subsection
13025 \begin_layout Standard
13026 All you need to do is install RevTeX 4, as described in the package's README
13028 The package can be found at The RevTeX 4 Web Site
13029 \begin_inset Flex URL
13032 \begin_layout Plain Layout
13034 http://publish.aps.org/revtex4/
13040 Install it somewhere that LaTeX can see it.
13041 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13043 \begin_inset space \space{}
13046 not the directory where you installed the class file.) Then, if you reconfigure
13047 LyX, it will find the class file and let you use the RevTeX4 textclass.
13050 \begin_layout Standard
13051 Probably the easiest way to get started is either to import a RevTeX 4 document
13059 \begin_inset space ~
13064 template, found in the templates directory.
13067 \begin_layout Subsection
13071 \begin_layout Standard
13072 Optional arguments to
13079 \begin_inset Quotes eld
13083 \begin_inset Quotes erd
13087 \begin_inset Quotes eld
13091 \begin_inset Quotes erd
13101 \begin_inset space ~
13109 \begin_inset space ~
13115 Remember that in RevTeX, at least one optional argument is required!
13118 \begin_layout Standard
13119 Other preamble matter, like
13126 \begin_inset space ~
13136 \begin_inset space ~
13141 dialog, also as usual.
13144 \begin_layout Subsection
13148 \begin_layout Standard
13149 The layouts basically correspond to the commands in RevTeX4.0.
13150 For example, the Email layout corresponds to
13157 Note that (at least as of RevTeX 4.0 Beta), the
13165 layouts are exactly equivalent, so you shouldn't need to use both.
13169 \begin_layout Plain Layout
13170 In case you're curious, both were included so that
13174 would be able to translate both
13194 \begin_layout Subsection
13198 \begin_layout Standard
13199 There are a couple of important unique aspects of RevTeX 4 which might cause
13200 bugs that will be even more confusing in LyX.
13203 \begin_layout Standard
13221 The LyX equivalent is that there is a separate Thanks layout.
13226 write footnotes in the
13230 layout, or weird things may happen.
13231 See the RevTeX 4 documentation for more details.
13234 \begin_layout Standard
13238 \begin_inset space ~
13246 \begin_inset space ~
13255 layouts must be placed
13263 layout and the corresponding
13280 , the LaTeX won't compile.
13283 \begin_layout Subsection
13287 \begin_layout Standard
13288 The main problem with this layout is that you can't use the optional arguments
13289 to layouts like Email and Title.
13290 (The problem is not unique to this layout; you can't use optional arguments
13291 to the Section layouts either.) This means that after you export that file
13292 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13293 need to edit the LaTeX file with a text editor to add the optional arguments
13295 \begin_inset space \space{}
13298 the running title for the page headers.
13299 Lacking these layouts makes the
13305 (and the equivalent
13311 ) useless, so the corresponding layouts don't exist, and will have to be
13316 \begin_layout Plain Layout
13321 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13322 has not been updated yet to take advantage of it.
13330 \begin_layout Section
13331 Springer Journals (
13338 \begin_layout Standard
13344 \begin_layout Subsection
13348 \begin_layout Standard
13349 These are the layout files for some of the journal formats used by Springer
13350 Verlag and listed on
13351 \begin_inset Flex URL
13354 \begin_layout Plain Layout
13356 http://www.springer.de/author/tex/help-journals.html
13361 , where you should also go to fetch the class files (yes, these are LaTeX2e
13363 It is a modular system: the things common to all journals are implemented
13368 , which journal-specific layout files (such as, e.g.
13369 \begin_inset space \space{}
13376 for Journal of Geodesy) can include.
13379 \begin_layout Standard
13380 This means that implementing support for any other Springer journal on this
13381 list is as simple as writing your own
13389 file following the outline given in
13397 \begin_layout Standard
13398 It is reasonably well tested only for the Journal of Geodesy.
13407 come with the standard LyX distribution.
13408 Install the relevant class file (downloaded from Springer) in a proper
13409 directory, reconfigure LaTeX (in the teTeX case by running
13413 , as root if necessary --- doesn't LyX take care of this?), reconfigure
13414 LyX and it should work.
13417 \begin_layout Subsection
13421 \begin_layout Standard
13422 A large number of theorem-like styles ---
13428 \SpecialChar \ldots{}
13434 \begin_layout Standard
13437 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13438 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13441 See the Springer class file documentation for details.
13444 \begin_layout Subsection
13448 \begin_layout Itemize
13460 \begin_layout Itemize
13463 Probability Theory and Related Fields
13469 --- Jean-Marc Lasgouttes
13472 \begin_layout Standard
13473 Add your own, it isn't so hard!
13476 \begin_layout Subsection
13480 \begin_layout Standard
13481 These files are partly based on the older
13485 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13486 file from Springer.
13491 layout, are now defunct.
13492 Jean-Marc Lasgouttes helped out big in making me find my way around the
13493 LyX layout file mechanism.
13496 \begin_layout Subsection
13500 \begin_layout Standard
13502 But probably less than in the old hacked-LaTeX
13509 \begin_layout Standard
13510 Limitations e.g.: does not display the number for theorem-like layouts, just
13514 \begin_layout Section
13520 \begin_inset CommandInset label
13529 \begin_layout Standard
13537 \begin_layout Subsection
13541 \begin_layout Standard
13542 This section describes how to use LyX to make slides for overhead projectors.
13543 There are two document classes that can do this: the default slides class
13549 This section documents the former.
13552 \begin_layout Standard
13553 I'm going to say this again, nice and clear, so that there's no misunderstanding
13557 \begin_layout Standard
13558 \begin_inset VSpace bigskip
13564 \begin_layout Standard
13568 This section documents the class
13569 \begin_inset Quotes eld
13577 \begin_inset Quotes erd
13585 \begin_layout Standard
13586 \begin_inset VSpace bigskip
13592 \begin_layout Standard
13593 If you're looking for the documentation for
13594 \begin_inset Quotes eld
13602 \begin_inset Quotes erd
13605 , check out section
13606 \begin_inset space ~
13610 \begin_inset CommandInset ref
13612 reference "sec:foiltex"
13622 \begin_inset Quotes eld
13630 \begin_inset Quotes erd
13633 ] is actually somewhat better than the default
13641 \begin_layout Plain Layout
13642 \SpecialChar \ldots{}
13643 or so I've been told repeatedly by its advocates.
13644 Having never used it, I have no idea if this claim is true or not.
13649 which this section documents.
13652 \begin_layout Standard
13653 This class is the LaTeX2e improvement of the old
13658 Every LaTeX2e distribution includes this class [which I'll just refer to
13660 \begin_inset Quotes eld
13668 \begin_inset Quotes erd
13671 from now on], so you're bound to have it.
13672 As I noted earlier, there are other classes, such as
13676 , which also produce slides for overhead projectors and do a better job
13678 However, there are some things which
13682 can do which the others can't, such as generate overlays.
13683 Read on to learn more!
13686 \begin_layout Subsection
13688 \begin_inset CommandInset label
13690 name "sec:slidesetup"
13697 \begin_layout Standard
13698 Obviously, to use this document class, you need to select
13699 \begin_inset Quotes eld
13707 \begin_inset Quotes erd
13710 from the class list in the
13712 Document\SpecialChar \menuseparator
13716 There are some other special things you should know about this class:
13719 \begin_layout Itemize
13720 Don't bother changing the options
13725 They're not supported by the
13732 \begin_layout Itemize
13736 \begin_inset space ~
13741 behaves a bit differently for this class.
13742 The possible choices and what they do are as follows:
13746 \begin_layout Description
13751 The final output contains page numbers in the lower right corner.
13754 \begin_layout Description
13763 , but also prints out any time markers you've put in.
13764 This is the default.
13767 \begin_layout Description
13772 The final output contains no page numbers, time markers, or alignment markers.
13776 \begin_layout Itemize
13781 class has an extra option:
13787 \begin_inset Quotes eld
13795 \begin_inset Quotes erd
13798 in the extra class options.
13802 \begin_layout Standard
13803 Using this options allows you to add time markers to
13809 \begin_inset space ~
13813 \begin_inset CommandInset ref
13815 reference "sec:slideNote"
13823 \begin_layout Standard
13824 You can also use the template file
13825 \begin_inset Quotes eld
13833 \begin_inset Quotes erd
13836 to automatically set up a document to use the
13842 File\SpecialChar \menuseparator
13844 \begin_inset space ~
13848 \begin_inset space ~
13853 to open your new document].
13854 The template file also contains some examples of the special paragraph
13855 environments used by this class.
13856 I'll describe those next.
13859 \begin_layout Subsection
13860 Paragraph Environments
13863 \begin_layout Subsubsection
13864 Supported Environments
13867 \begin_layout Standard
13868 The first thing you'll notice when you start up a new
13872 document is the font size and type: it's the equivalent of the size
13873 \begin_inset Quotes eld
13881 \begin_inset Quotes erd
13887 \begin_inset space ~
13893 This is also what's used in the output.
13895 \begin_inset Quotes eld
13899 \begin_inset Quotes erd
13902 to remind you that this is a slide.
13903 Your final slides will use a larger font; ergo, you'll have less space.
13904 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
13907 \begin_layout Standard
13908 The next thing that becomes obvious is the changes to the paragraph environment
13909 pull-down box [at the far-left end of the toolbar].
13910 Most of the paragraph environments you're used to seeing are missing.
13911 There are also five new ones.
13916 class itself only supports certain paragraph environments:
13919 \begin_layout Itemize
13925 \begin_layout Itemize
13931 \begin_layout Itemize
13937 \begin_layout Itemize
13943 \begin_layout Itemize
13949 \begin_layout Itemize
13955 \begin_layout Itemize
13961 \begin_layout Itemize
13967 \begin_layout Itemize
13973 \begin_layout Itemize
13979 \begin_layout Itemize
13985 \begin_layout Standard
13986 All of the other standard environments, including the section-heading environmen
13987 ts, aren't used in the
13994 \begin_layout Standard
13995 On the other hand, you'll notice the following new environments:
13998 \begin_layout Itemize
14004 \begin_layout Itemize
14010 \begin_layout Itemize
14016 \begin_layout Itemize
14022 \begin_layout Itemize
14028 \begin_layout Standard
14029 These five are kind of quirky, due to a
14030 \begin_inset Quotes eld
14034 \begin_inset Quotes erd
14038 You see, LyX doesn't permit you to nest any other paragraph environment
14039 into an empty environment.
14040 Now, that's fine and dandy, but it means that you wouldn't be able to start
14041 a slide with anything except plain text.
14042 To deal with this, I've performed a little
14043 \begin_inset Quotes eld
14047 \begin_inset Quotes erd
14053 \begin_layout Subsubsection
14054 Quirks of the New Environments
14055 \begin_inset CommandInset label
14057 name "sec:slideQuirk"
14064 \begin_layout Standard
14065 All five of the new paragraph environments are somewhat quirky due to inherent
14066 limitiations in the current version of LyX.
14067 As I just mentioned, LyX forbids environments that begin with another environme
14069 To get around this, the
14073 environment isn't a paragraph environment as described in the
14081 \begin_layout Standard
14082 You should consider
14095 \begin_inset Quotes eld
14098 pseudo-environments.
14099 \begin_inset Quotes erd
14102 They look like a section heading or a
14103 \begin_inset Quotes eld
14111 \begin_inset Quotes erd
14114 but really begin a [and, if necessary, end the previous] paragraph environment.
14124 \begin_inset Quotes eld
14128 \begin_inset Quotes erd
14131 These two perform some action.
14134 \begin_layout Standard
14135 A common feature of all five environments,
14155 , is a rather long-ish label.
14156 The text following this label --- ordinarily the contents of the paragraph
14157 environment --- is utterly irrelevant for
14178 LyX completely ignores it.
14179 In fact, you can leave these five environments completely empty.
14183 \begin_layout Standard
14188 to put any text after the rather long-ish label, you might want to.
14189 This could be a short description of the contents of the
14194 In that case, enter in your descriptive comment and hit
14198 as you normally would.
14201 \begin_layout Standard
14202 If, on the other hand, you don't want to enter in any descriptive text,
14203 you'll hit another LyX quirk.
14204 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14205 environment until you put something in the old one.
14209 \begin_layout Itemize
14210 Start entering the text that will
14238 \begin_layout Itemize
14239 Now move to the beginning of that paragraph.
14243 \begin_layout Itemize
14252 \begin_layout Itemize
14253 Finally, change this new, empty paragraph to a
14277 \begin_layout Standard
14278 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14282 \begin_layout Subsection
14283 Making a Presentation with
14296 \begin_layout Subsubsection
14304 \begin_layout Standard
14305 If you're expecting this section to teach you how to actually make a presentatio
14306 n, you'll be sorely disappointed.
14307 Naturally, I'll describe all of the ways the
14311 class can assist you in preparing the materials for a presentation.
14312 Filling in the contents, however, is up to you.
14317 the LyX philosophy.]
14320 \begin_layout Standard
14325 environment [in the manner described in section
14326 \begin_inset space ~
14330 \begin_inset CommandInset ref
14332 reference "sec:slideQuirk"
14336 ] tells LyX to begin a new slide [duh].
14337 The label for this environment/
14338 \begin_inset Quotes erd
14342 \begin_inset Quotes erd
14346 \begin_inset Quotes eld
14350 \begin_inset Quotes erd
14353 in cool blue, followed by the label,
14354 \begin_inset Quotes eld
14358 \begin_inset Quotes erd
14362 Any text or paragraph environments that follow this one go on the new slide.
14366 \begin_layout Standard
14367 Slides are probably the only time you'll need to forcibly end pages in LyX
14368 (this can be specified in the
14373 In fact, you'll want to, once you finish entering the contents of one slide.
14374 If you've entered more text than can physically fit on a slide, the extra
14375 overflows onto a new slide.
14376 I don't recommend doing this, however, since the overflow slide won't have
14377 any page number on it.
14378 Furthermore, it may interfere with any
14382 you've made to accompany the oversized
14389 \begin_layout Standard
14398 environments work the same way as the
14403 They both create an
14404 \begin_inset Quotes eld
14408 \begin_inset Quotes erd
14411 followed by a label [
14412 \begin_inset Quotes eld
14416 \begin_inset Quotes erd
14420 \begin_inset Quotes eld
14424 \begin_inset Quotes erd
14428 The color is a stunning magenta instead of blue, and the
14429 \begin_inset Quotes eld
14433 \begin_inset Quotes erd
14436 will look different, in style and in length.
14437 The label fonts of all three also differ from one another.
14440 \begin_layout Standard
14445 , if the contents of a
14453 exceed the physical size of a slide or sheet of paper, the extra will overflow
14455 Again, you should avoid this.
14456 It defeats the whole purpose of
14467 \begin_layout Subsubsection
14477 \begin_layout Standard
14482 is a slide that sits atop another slide.
14483 Perhaps you wish to discuss a figure on the main
14487 before displaying the text associated with it.
14488 One way to accomplish this is tape a flap of dark paper over the part of
14493 you want to display later.
14494 This method fails, however, if you wish to overlap one graph with another,
14496 You would then have to fumble while speaking to align the two separate,
14501 s to align the two graphs.
14506 environment in both cases makes life much easier.
14509 \begin_layout Standard
14514 receives the page number of its
14515 \begin_inset Quotes eld
14519 \begin_inset Quotes erd
14527 \begin_inset Quotes eld
14535 \begin_inset Quotes erd
14542 \begin_layout Plain Layout
14543 Presumably, mutliple
14548 \begin_inset Quotes eld
14556 \begin_inset Quotes erd
14560 \begin_inset Quotes eld
14568 \begin_inset Quotes erd
14572 \begin_inset Quotes eld
14580 \begin_inset Quotes erd
14584 \begin_inset space ~
14587 appended to the page number of the parent
14597 Clearly, you want the contents of both the
14605 to each fit on a single physical slide! You should probably consider an
14611 \begin_inset Quotes eld
14615 \begin_inset Quotes erd
14627 class provides a visual cue for this: the label at the start of an
14631 is shorter than that at the start of a
14636 Lastly, when you generate printable output, you'll find alignment markers
14637 in all four corners of both the
14641 page and its parent
14646 These will assist you in lining up the two physical slides.
14649 \begin_layout Standard
14650 The major problem in overlaying two slides is aligning the contents of the
14651 two transparencies.
14652 How much space should you leave for that graph on the second slide? Worse
14653 still, what if you want a graph and a sentence on second slide, but there
14654 is text on the main transparency that goes in between them? You could try
14655 and insert vertical space of the right size.
14656 The better way is to use
14667 \begin_layout Standard
14668 As their names imply,
14676 are two command-like paragraph environments that make all subsequent text
14677 invisible and visible, respectively.
14679 \begin_inset space ~
14683 \begin_inset CommandInset ref
14685 reference "sec:slideQuirk"
14689 that you don't place anything
14693 these two environments, however.
14698 , it inserts a centered, sky-blue label into the page reading
14699 \begin_inset Quotes eld
14702 <Invisible Text Follows>
14703 \begin_inset Quotes erd
14707 For paragraphs following this label, the parts of the
14715 ; it doesn't matter which] where they would be contain instead blank space.
14719 \begin_layout Standard
14724 , the corresponding centered label is
14725 \begin_inset Quotes eld
14728 <Visible Text Follows>
14729 \begin_inset Quotes erd
14733 Paragraphs following this label behave normally.
14734 Note that the beginning of a new
14746 automatically shuts off an
14751 It's therefore not necessary to use
14762 \begin_layout Standard
14763 By now, it should be obvious how to create overlay transparencies using
14764 the proper combination of
14783 \begin_layout Enumerate
14788 , including everything that will appear on it, whether on the main slide
14796 \begin_layout Enumerate
14797 Before each figure or paragraph that will appear only on the
14806 If necessary, insert a
14810 environment after the
14817 \begin_layout Enumerate
14822 immediately following the
14829 \begin_layout Enumerate
14830 Copy the contents of this
14841 \begin_layout Enumerate
14846 , change all of the
14857 \begin_layout Standard
14859 You've just made an
14866 \begin_layout Standard
14867 There's one problem with the way I've designed the LyX
14871 class: you can't make text in the middle of a paragraph invisible, nor
14872 make text in the middle of an invisible paragraph visible again.
14873 To accomplish this feat, you'll need to use some inlined LaTeX codes.
14877 \begin_layout Plain Layout
14878 The commands of interest are:
14881 \begin_layout Itemize
14886 invisible \SpecialChar \ldots{}
14890 \begin_layout Itemize
14895 visible \SpecialChar \ldots{}
14899 \begin_layout Plain Layout
14900 \SpecialChar \ldots{}
14901 and need to be marked as TeX.
14903 \begin_inset Quotes eld
14907 \begin_inset Quotes erd
14910 you wish to change goes in between the brackets [and after the
14923 If you don't know how to mark text as TeX, see the appropriate section
14936 \begin_layout Subsubsection
14946 \begin_inset CommandInset label
14948 name "sec:slideNote"
14955 \begin_layout Standard
14964 is associated with a
14965 \begin_inset Quotes eld
14969 \begin_inset Quotes erd
14981 class provides visual cues.
14986 is shorter than that of a
14990 [yet longer than that of an
14994 ] and, like the label of an
14998 is shockingly magenta.
14999 Additionally, the printed
15003 has the page number of its
15004 \begin_inset Quotes eld
15008 \begin_inset Quotes erd
15016 \begin_inset Quotes eld
15024 \begin_inset Quotes erd
15028 \begin_inset Quotes eld
15036 \begin_inset Quotes erd
15040 \begin_inset Quotes eld
15048 \begin_inset Quotes erd
15052 You can have multiple
15056 s associated with a single
15068 , you'll probably want to break up long
15072 s so that they fit on a single sheet of paper.
15075 \begin_layout Standard
15080 is obvious: it contains anything additional you might want to say about
15086 It could also be used as a sheet of reminders for a particular
15091 In the case of the latter, you might want to make use of time markers.
15097 \begin_inset Quotes eld
15101 \begin_inset Quotes erd
15104 support for time markers, a
15109 So, you'll have to resort to using the LaTeX codes.
15112 \begin_layout Standard
15113 To use time markers, you'll need to specify the extra class option
15114 \begin_inset Quotes eld
15122 \begin_inset Quotes erd
15126 \begin_inset space ~
15130 \begin_inset CommandInset ref
15132 reference "sec:slidesetup"
15137 This option turns on timing marks, which will appear in the lower-left-hand
15143 To set what appears in the time marker, you use the LaTeX commands
15144 \begin_inset Quotes eld
15154 \begin_inset Quotes erd
15158 \begin_inset Quotes eld
15168 \begin_inset Quotes erd
15172 The arguments of both commands are time measured in seconds.
15174 \begin_inset Quotes eld
15184 \begin_inset Quotes erd
15187 sets the time marker to a given time.
15189 \begin_inset Quotes eld
15199 \begin_inset Quotes erd
15202 increments the time marker by the specified amount.
15203 Using time markers and
15207 s in this fashion, you can remind yourself how much time to spend on a particula
15215 \begin_layout Standard
15216 There's one last feature to describe.
15217 Clearly, you'd like to print out all of your
15225 s on transparencies while printing all of your
15242 with which it is associated.
15243 What's a person to do?
15246 \begin_layout Standard
15247 Luckily, there are two LaTeX commands that allow you to select what to print
15249 Both must be placed into the preamble of your document.
15251 \begin_inset Quotes eld
15263 \begin_inset Quotes erd
15266 will cause the output to contain only the
15275 Correspondingly, the command
15276 \begin_inset Quotes eld
15288 \begin_inset Quotes erd
15291 prevents the output of anything but
15296 I'd advise placing both commands in the preamble and initially comment
15298 You can then preview your entire presentation as you write.
15299 When you're done writing, you can then uncomment one of the two to select
15300 what you want to print.
15301 I like to uncomment
15302 \begin_inset Quotes eld
15314 \begin_inset Quotes erd
15317 , print to a file with
15318 \begin_inset Quotes eld
15326 \begin_inset Quotes erd
15329 in its name, comment it back out, then uncomment
15330 \begin_inset Quotes eld
15342 \begin_inset Quotes erd
15346 \begin_inset Quotes eld
15354 \begin_inset Quotes erd
15358 I can then send either file to a printer, loading transparencies or plain
15359 paper as appropriate.
15362 \begin_layout Standard
15363 You can also provide other arguments to the
15364 \begin_inset Quotes eld
15374 \begin_inset Quotes erd
15378 \begin_inset Quotes eld
15388 \begin_inset Quotes erd
15392 See a good LaTeX book for details.
15395 \begin_layout Subsection
15400 Class Template File
15403 \begin_layout Standard
15404 I have also provided a template file,
15405 \begin_inset Quotes eld
15413 \begin_inset Quotes erd
15421 To use it, begin your new presentation with
15426 ile\SpecialChar \menuseparator
15428 \begin_inset space ~
15432 \begin_inset space ~
15442 Your new LyX presentation file will contain an example
15463 additionally contain an example of the use of
15472 Lastly, the preamble will contain:
15475 \begin_layout LyX-Code
15476 % Uncomment to print out only slides and overlays
15479 \begin_layout LyX-Code
15483 \begin_layout LyX-Code
15489 \begin_inset Newline newline
15495 \begin_layout LyX-Code
15496 % Uncomment to print out only notes
15499 \begin_layout LyX-Code
15503 \begin_layout LyX-Code
15511 \begin_layout Standard
15512 One final thing: I created this class to support the LaTeX2e
15513 \begin_inset Quotes eld
15521 \begin_inset Quotes erd
15524 class, one of the built-in LaTeX2e classes.
15525 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15526 built-in slide class.
15527 It's here if you want it or need it.
15528 There exist other LaTeX2e classes for creating presentations, such as the
15534 \begin_inset space ~
15538 \begin_inset CommandInset ref
15540 reference "sec:foiltex"
15545 \begin_inset Quotes eld
15553 \begin_inset Quotes erd
15556 package [present on some TeX distributions].
15557 The latter is not yet supported under LyX.
15561 \begin_layout Plain Layout
15562 Perhaps you can take on the task\SpecialChar \ldots{}
15568 I know nothing about these other classes.
15569 Try them out to see what sort of alternative they provide.
15572 \begin_layout Chapter
15573 LyX Features needing Extra Software
15576 \begin_layout Section
15580 \begin_layout Standard
15586 \begin_layout Subsection
15590 \begin_layout Standard
15595 program installed, you'll find in the
15602 \begin_inset space ~
15613 \begin_inset CommandInset href
15615 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15622 \begin_layout Standard
15627 package is a program that was written by
15628 \begin_inset Flex CharStyle:Noun
15631 \begin_layout Plain Layout
15633 \begin_inset space ~
15641 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15642 and easy to forget.
15643 The program runs over your LaTeX file, checks the integrity of the file,
15644 and flags some common errors.
15645 In other technical words, it is
15652 \begin_layout Standard
15653 Well, what is a syntax checker doing in LyX which is supposed to produce
15654 correct LaTeX anyways? The answer is simple: Just as
15658 not only checks the
15662 of C programs, but also does
15666 checks for type-errors,
15670 catches some common
15674 errors, in addition to the syntactical ones.
15679 is capable of detecting several common errors, such as
15682 \begin_layout Itemize
15683 Ellipsis detection:
15684 \begin_inset Newline newline
15687 Use \SpecialChar \ldots{}
15691 \begin_layout Itemize
15692 No space in front of/after parenthesis:
15693 \begin_inset Newline newline
15699 \begin_layout Itemize
15700 Enforcement of normal space after common abbreviations:
15701 \begin_inset Newline newline
15705 \begin_inset space \space{}
15708 is too wide spacing.
15711 \begin_layout Itemize
15712 Enforcement of end-of-sentence space when the last sentence ends with a
15714 \begin_inset Newline newline
15718 And this is wrong spacing.
15721 \begin_layout Itemize
15722 Space in front of labels and similar commands:
15723 \begin_inset Newline newline
15726 The label should stick right up to the text to avoid falling to a wrong
15729 \begin_inset CommandInset label
15739 \begin_layout Plain Layout
15740 This footnote is in danger of falling off to a wrong page
15745 The label is separated too much.
15748 \begin_layout Itemize
15749 Space in front of references, instead of hard spaces:
15750 \begin_inset Newline newline
15753 In you are in bad luck, the text will break right between the referenced
15754 text and reference number, and that's a pity.
15756 \begin_inset CommandInset ref
15758 reference "sec:chktex"
15765 \begin_layout Itemize
15767 \begin_inset Quotes eld
15771 \begin_inset Quotes erd
15775 \begin_inset Formula $\times$
15779 \begin_inset Newline newline
15782 2x2 looks cheap compared to
15783 \begin_inset Formula $2\times2$
15789 \begin_layout Standard
15790 and more \SpecialChar \ldots{}
15791 It is an invaluable tool when you are
15792 \begin_inset Quotes eld
15796 \begin_inset Quotes erd
15799 your document before printing, and you should run it right after the obligatory
15800 spelling check, and before you go fine tuning the typesetting.
15803 \begin_layout Subsection
15807 \begin_layout Standard
15808 If you have the program installed, usage is as simple as choosing
15810 Tools\SpecialChar \menuseparator
15812 \begin_inset space ~
15818 This will make LyX generate a LaTeX file of your document, start
15822 to check it, and then make LyX insert
15823 \begin_inset Quotes eld
15827 \begin_inset Quotes erd
15830 with the warnings from
15834 , if there were any.
15835 The warnings will be placed close to the point of the mistake, and you
15836 can quickly find them by using the
15838 Navigate\SpecialChar \menuseparator
15841 menu item, or the shortcut key
15850 Open the error boxes by clicking on them with the mouse, or use the shortcut
15859 bindings, or the corresponding
15868 Read the warning and correct the mistake, if it is a mistake.
15869 If you have trouble understanding what the warning is about, you can safely
15871 Remember that there is a hidden layer between the document on screen and
15872 the technical details in invoking
15876 , and this gap can make some warnings seem arcane or just right down plain
15880 \begin_layout Standard
15881 This document is an excellent testing bed for the feature, and it should
15882 provide quite a few warnings for you to fiddle with.
15883 Since computers are only so smart, expect most of the warnings to be false
15887 \begin_layout Subsection
15888 How to fine tune it
15891 \begin_layout Standard
15892 Sometimes, you'll find that
15896 makes more noise than suits your mood.
15897 Then you can choose not to use it, wait until your mood changes, or try
15902 to get better along with you.
15903 Another choice in the most desperate situations is to use
15905 View\SpecialChar \menuseparator
15907 \begin_inset space ~
15911 \begin_inset space ~
15915 \begin_inset space ~
15920 , which will get rid of all warnings instantly.
15923 \begin_layout Standard
15932 very configurable and extensible, you shouldn't expect to solve all problems
15938 Since LyX has to generate a somewhat special LaTeX file to be able to match
15939 the line numbers from the
15947 \begin_layout Plain Layout
15948 You can inspect the specific output from
15954 Edit\SpecialChar \menuseparator
15956 \begin_inset space ~
15960 \begin_inset space ~
15974 to the internal document structure, some of the warnings will not seen
15975 to appear correctly.
15976 There are two things you can do about this:
15979 \begin_layout Itemize
15984 invocation command line in
16000 installation configuration file (usually with the file
16005 See below to learn what warnings can be enabled and disabled on the command
16010 \begin_layout Itemize
16011 Export your document as a raw LaTeX file using
16013 File\SpecialChar \menuseparator
16014 Export\SpecialChar \menuseparator
16022 Invoked in this way, it can be a hassle to find the corresponding place
16023 in the document inside LyX, but with a little patience, you should be able
16027 \begin_layout Standard
16028 Here follows the warning messages that can be enabled and disabled in
16037 to disable a warning, and
16041 to enable a warning.
16042 The emphasized entries are disabled by default, because the default is
16045 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16050 \begin_layout Standard
16051 Notice that you should only use the options that enable and disable warnings,
16052 because LyX relies on some of the other command line parameters to be set
16053 in a specific way to have a chance to communicate with
16060 \begin_layout Enumerate
16064 Command terminated with space.
16067 \begin_layout Enumerate
16070 Non-breaking space (
16071 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16082 ) should have been used.
16085 \begin_layout Enumerate
16089 You should enclose the previous parenthesis with
16090 \begin_inset Quotes eld
16098 \begin_inset Quotes erd
16104 \begin_layout Enumerate
16107 Italic correction (
16108 \begin_inset Quotes eld
16118 \begin_inset Quotes erd
16121 ) found in non-italic buffer.
16124 \begin_layout Enumerate
16127 Italic correction (
16128 \begin_inset Quotes eld
16138 \begin_inset Quotes erd
16141 ) found more than once.
16144 \begin_layout Enumerate
16148 No italic correction (
16149 \begin_inset Quotes eld
16159 \begin_inset Quotes erd
16165 \begin_layout Enumerate
16169 \begin_inset Quotes eld
16177 \begin_inset Quotes erd
16181 \begin_inset Quotes eld
16189 \begin_inset Quotes erd
16195 \begin_layout Enumerate
16198 Wrong length of dash may have been used.
16201 \begin_layout Enumerate
16205 \begin_inset Quotes eld
16213 \begin_inset Quotes erd
16217 \begin_inset Quotes eld
16225 \begin_inset Quotes erd
16231 \begin_layout Enumerate
16235 \begin_inset Quotes eld
16243 \begin_inset Quotes erd
16249 \begin_layout Enumerate
16253 \begin_inset Quotes eld
16261 \begin_inset Quotes erd
16264 to achieve an ellipsis.
16267 \begin_layout Enumerate
16270 Inter-word spacing (
16271 \begin_inset Quotes eld
16281 \begin_inset Quotes eld
16284 ) should perhaps be used.
16287 \begin_layout Enumerate
16290 Inter-sentence spacing (
16291 \begin_inset Quotes eld
16301 \begin_inset Quotes erd
16304 ) should perhaps be used.
16307 \begin_layout Enumerate
16310 Could not find argument for command.
16313 \begin_layout Enumerate
16317 \begin_inset Quotes eld
16325 \begin_inset Quotes erd
16331 \begin_layout Enumerate
16334 Math mode still on at end of LaTeX file.
16337 \begin_layout Enumerate
16341 \begin_inset Quotes eld
16349 \begin_inset Quotes erd
16352 doesn't match the number of
16353 \begin_inset Quotes eld
16361 \begin_inset Quotes erd
16367 \begin_layout Enumerate
16370 You should use either
16373 \begin_inset Quotes eld
16381 \begin_inset Quotes erd
16386 as an alternative to
16387 \begin_inset Quotes eld
16395 \begin_inset Quotes erd
16401 \begin_layout Enumerate
16408 " (ASCII 39) instead of "
16415 \begin_layout Enumerate
16418 User-specified pattern found.
16421 \begin_layout Enumerate
16424 This command might not be intended.
16427 \begin_layout Enumerate
16434 \begin_layout Enumerate
16452 \begin_layout Enumerate
16455 Delete this space to maintain correct page references.
16458 \begin_layout Enumerate
16462 You might wish to put this between a pair of
16463 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16477 \begin_layout Enumerate
16480 You ought to remove spaces in front of punctuation.
16483 \begin_layout Enumerate
16486 Could not execute LaTeX command.
16489 \begin_layout Enumerate
16498 in front of small punctuation.
16501 \begin_layout Enumerate
16509 may look prettier here.
16512 \begin_layout Enumerate
16516 Multiple spaces detected in output.
16519 \begin_layout Enumerate
16522 This text may be ignored.
16525 \begin_layout Enumerate
16531 \begin_inset Quotes eld
16536 to begin quotation, not
16543 \begin_layout Enumerate
16550 to end quotation, not
16553 \begin_inset Quotes eld
16561 \begin_layout Enumerate
16567 \begin_layout Enumerate
16570 You should perhaps use
16571 \begin_inset Quotes eld
16579 \begin_inset Quotes erd
16585 \begin_layout Enumerate
16588 You should put a space in front of/after parenthesis.
16591 \begin_layout Enumerate
16594 You should avoid spaces in front of/after parenthesis.
16597 \begin_layout Enumerate
16601 You should not use punctuation in front of/after quotes.
16604 \begin_layout Enumerate
16607 Double space found.
16610 \begin_layout Enumerate
16613 You should put punctuation outside inner/inside display math mode.
16616 \begin_layout Enumerate
16619 You ought to not use primitive TeX in LaTeX code.
16622 \begin_layout Enumerate
16625 You should remove spaces in front of
16626 \begin_inset Quotes eld
16634 \begin_inset Quotes erd
16640 \begin_layout Enumerate
16643 \begin_inset Quotes eld
16651 \begin_inset Quotes erd
16654 is normally not followed by
16655 \begin_inset Quotes eld
16663 \begin_inset Quotes erd
16669 \begin_layout Standard
16670 In later versions of LyX, we hope to provide a more complete interface to
16671 this tool (and it's smaller cousin
16675 ) to exploit the full power of it.
16676 But it's not exactly useless as it is now: go try it on one of your existing
16677 documents of a certain length and be surprised.
16680 \begin_layout Section
16681 Version Control in LyX
16684 \begin_layout Standard
16687 Lars Gullik Bjønnes,
16694 \begin_layout Subsection
16698 \begin_layout Standard
16699 A friend of mine wanted to try LyX for a group project.
16700 When he didn't find support for version control or file locking, he dropped
16702 This angered me a bit, so I thought that I should at least make support
16703 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16704 This has now been done.
16705 LyX now supports some of the most basic RCS commands.
16706 If you need to something a bit more sophisticated you will have to do that
16707 manually in an xterm.
16710 \begin_layout Standard
16711 Before you begin to use the version control features in LyX, you should
16713 \begin_inset Quotes eld
16717 \begin_inset Quotes erd
16720 (a man file, read it with
16725 This file describes all the basic features of RCS.
16726 You should especially notice the comment about a RCS directory, and the
16727 notion of a master RCS file (the file ending in
16734 \begin_layout Standard
16735 Later basic CVS/SVN support was added.
16736 You should be familiar with CVS/SVN usage before start using it under LyX.
16737 Most of the log messages are not currently displayed after operations -
16738 you can check them in terminal window if unsure.
16741 \begin_layout Standard
16742 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16743 package---no guarantees are made for older versions.
16746 \begin_layout Subsection
16747 RCS commands in LyX
16750 \begin_layout Standard
16751 The following sections describe the RCS commands supported by LyX.
16752 You can find them in the
16757 ile\SpecialChar \menuseparator
16763 \begin_inset space ~
16771 \begin_layout Subsubsection
16777 \begin_layout Standard
16778 If your document is not under revision control, this is the only item shown
16780 And if it is under revision control, the
16787 item is not visible.
16791 \begin_layout Standard
16792 This command registers your document with RCS (unless you are under the
16793 directory managed by CVS)\SpecialChar \@.
16794 You are asked interactively to supply an initial
16795 description of the document.
16796 The document is now set in Read-Only mode and you have to
16799 \begin_inset space ~
16803 \begin_inset space ~
16807 \begin_inset space ~
16812 , before making any changes to it.
16813 A document under revision control has a
16814 \begin_inset Quotes eld
16817 [RCS:<version> <locker>]
16818 \begin_inset Quotes erd
16821 item tagged to the filename in the minibuffer.
16824 \begin_layout Standard
16825 RCS command that is run:
16827 ci -q -u -i -t-"<initial description>" <file-name>
16830 \begin_layout Standard
16835 to understand the switches.
16839 \begin_layout Subsubsection
16845 \begin_layout Standard
16846 When you are finished editing a file, you check in your changes.
16847 When you do this, you are asked for a description of the changes.
16848 This is stored in the history log.
16849 The version number is bumped, your changes are applied to the master RCS
16850 file, the document is unlocked and set to Read-Only mode.
16854 \begin_layout Standard
16857 ci -q -u -m"<description>" <file-name>
16860 \begin_layout Subsubsection
16866 \begin_layout Standard
16867 By doing this you lock the document so that only you can edit it.
16868 This will also make the document Read-Write only for you.
16869 You will usually continue editing for a while and when you are finished
16870 you check in your changes.
16871 The status line is changed to reflect that you have locked the file.
16875 \begin_layout Standard
16878 co -q -l <file-name>
16881 \begin_layout Subsubsection
16884 Revert To Repository Version
16887 \begin_layout Standard
16888 This will discard all changes made to the document since the last check
16890 You get a warning before changes are discarded.
16893 \begin_layout Standard
16896 co -f -u<version> <file-name>
16899 \begin_layout Subsubsection
16905 \begin_layout Standard
16906 This makes as if the last check in never happened.
16907 No changes are made to the document loaded into LyX, but the last version
16908 is removed from the master RCS file.
16912 \begin_layout Standard
16915 rcs -o<version> <file-name>
16918 \begin_layout Subsubsection
16924 \begin_layout Standard
16925 This show the complete history of the RCS document.
16930 is shown in a browser.
16938 \begin_layout Subsection
16939 CVS commands in LyX
16942 \begin_layout Standard
16943 CVS is now partially supported by LyX.
16944 You can find the commands in the
16949 ile\SpecialChar \menuseparator
16955 \begin_inset space ~
16963 \begin_layout Subsubsection
16969 \begin_layout Standard
16970 If your document is not under revision control, this is the only item shown
16972 And if it is under revision control, the
16979 item is not visible.
16983 \begin_layout Standard
16984 This command registers in CVS your document ONLY in case you have already
16985 the documents directory under CVS control (in particular
16990 This means you have to checkout the archive by yourself.
16994 \begin_layout Standard
16995 Then you are asked interactively to supply an initial description of the
16997 Don't forget that registered file is not yet commited.
17000 \begin_layout Standard
17001 CVS command that is run:
17004 \begin_inset Quotes erd
17008 \begin_inset Quotes eld
17012 \begin_inset Quotes erd
17018 \begin_layout Standard
17023 to understand the switches.
17027 \begin_layout Subsubsection
17033 \begin_layout Standard
17034 When you are finished editing a file, you commit your changes.
17035 When you do this, you are asked for a description of the changes.
17036 After that changes are commited.
17039 \begin_layout Standard
17042 cvs -q commit -m"<description>" <file-name>
17045 \begin_layout Subsubsection
17048 Revert To Repository Version
17051 \begin_layout Standard
17052 This will discard all changes made to the document since the last check
17054 You get a warning before changes are discarded.
17055 Firstly the file is deleted, secondly CVS update command is run.
17058 \begin_layout Standard
17062 \begin_inset Quotes eld
17066 \begin_inset Quotes erd
17072 \begin_layout Subsubsection
17078 \begin_layout Standard
17079 This show the complete history of the CVS document.
17083 \begin_inset Quotes eld
17087 \begin_inset Quotes erd
17092 is shown in a browser.
17095 \begin_layout Subsection
17096 SVN commands in LyX
17099 \begin_layout Standard
17100 SVN is now partially supported by LyX.
17101 You can find the commands in the
17106 ile\SpecialChar \menuseparator
17112 \begin_inset space ~
17118 Please note that if you use password protected access to repository via
17119 ssh, you will be asked in terminal window.
17122 \begin_layout Subsubsection
17128 \begin_layout Standard
17129 If your document is not under revision control, this is the only item shown
17131 And if it is under revision control, the
17138 item is not visible.
17142 \begin_layout Standard
17143 This command registers in SVN your document ONLY in case you have already
17144 the documents directory under SVN control (in particular
17149 This means you have to checkout the archive by yourself.
17153 \begin_layout Standard
17154 Then you are asked interactively to supply an initial description of the
17156 Don't forget that registered file is not yet commited.
17159 \begin_layout Standard
17160 SVN command that is run:
17163 \begin_inset Quotes eld
17167 \begin_inset Quotes erd
17173 \begin_layout Standard
17178 to understand the switches.
17182 \begin_layout Subsubsection
17188 \begin_layout Standard
17189 When you are finished editing a file, you commit your changes.
17190 When you do this, you are asked for a description of the changes.
17191 After that changes are commited.
17194 \begin_layout Standard
17197 svn commit -q -m"<description>" <file-name>
17200 \begin_layout Subsubsection
17206 \begin_layout Standard
17207 Updates the changes of this file from the repository.
17208 Be sure you understand SVN merging and conflicts resolving before using
17209 this function, because all conflicts has to be done manually by you!
17212 \begin_layout Standard
17216 \begin_inset Quotes eld
17220 \begin_inset Quotes erd
17226 \begin_layout Subsubsection
17229 Revert To Repository Version
17232 \begin_layout Standard
17233 This will discard all changes made to the document since the last check
17235 You get a warning before changes are discarded.
17239 \begin_layout Standard
17243 \begin_inset Quotes eld
17247 \begin_inset Quotes erd
17253 \begin_layout Subsubsection
17259 \begin_layout Standard
17260 This show the complete history of the SVN document.
17264 \begin_inset Quotes eld
17268 \begin_inset Quotes erd
17273 is shown in a browser.
17276 \begin_layout Section
17277 Literate Programming
17280 \begin_layout Standard
17285 (kayvan@sylvan.com)
17289 original documentation written by
17291 Edmar Wienskoski Jr.
17294 (edmar-w-jr@technologist.com)
17297 \begin_layout Subsection
17301 \begin_layout Standard
17302 The main purpose of this documentation is to show you how to use LyX for
17303 literate programming.
17304 Where it is assumed that you are familiar with this programming technique,
17306 \begin_inset Quotes eld
17310 \begin_inset Quotes erd
17314 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17322 If that is not the case, please follow the web links provided in the following
17324 There is a lot of good documentation out there covering old development
17325 history to the latest tools tips.
17328 \begin_layout Standard
17329 It is also assumed that you are familiar with LyX itself to a point that
17330 you are comfortable changing your LyX preferences, and X resources file.
17331 If that is not the case please refer to other LyX documentation to cover
17332 your specific needs.
17335 \begin_layout Subsection
17336 Literate Programming
17339 \begin_layout Standard
17340 From the Literate Programming FAQ:
17343 \begin_layout Quotation
17344 Literate programming is the combination of documentation and source together
17345 in a fashion suited for reading by human beings.
17346 In fact, literate programs should be enjoyable reading, even inviting!
17347 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17348 and documentation in a single file.
17349 Literate programming tools then parse the file to produce either readable
17350 documentation or compilable source.
17351 The WEB style of literate programming was created by D.E.
17352 Knuth during the development of his TeX typesetting software.
17356 \begin_layout Standard
17357 Another excerpt says:
17360 \begin_layout Quotation
17363 How is literate programming different from verbose commenting?
17366 \begin_layout Quotation
17367 There are three distinguishing characteristics.
17368 In order of importance, they are:
17372 \begin_layout Itemize
17373 flexible order of elaboration
17376 \begin_layout Itemize
17377 automatic support for browsing
17380 \begin_layout Itemize
17381 typeset documentation, especially diagrams and mathematics
17385 \begin_layout Standard
17386 Now that I sparked your curiosity, take a look in the references.
17389 \begin_layout Subsubsection
17393 \begin_layout Standard
17394 The complete Literate Programming FAQ can be found at:
17397 \begin_layout Quote
17398 Literate Programming FAQ
17399 \begin_inset Flex URL
17402 \begin_layout Plain Layout
17404 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17412 \begin_layout Standard
17413 The FAQ lists 23 (twenty three!) different literate programming tools.
17414 Where some are specialized or
17415 \begin_inset Quotes eld
17419 \begin_inset Quotes erd
17422 for particular programming languages, while other have general scope.
17427 for my own use for several reasons:
17430 \begin_layout Itemize
17431 It can generate the documentation either in LaTeX or HTML.
17434 \begin_layout Itemize
17435 It has a open architecture, i.e.
17436 \begin_inset space \space{}
17439 it is easy to plug in new filters and to perform special processing that
17444 \begin_layout Itemize
17445 There is a good selection of filters available already (the HTML is one
17449 \begin_layout Itemize
17453 \begin_layout Standard
17454 The Noweb web page can be found at:
17457 \begin_layout Quote
17459 \begin_inset Flex URL
17462 \begin_layout Plain Layout
17464 http://www.cs.virginia.edu/~nr/noweb/
17472 \begin_layout Standard
17473 Starting from there you can reach many other interesting links and even
17474 some literate program examples.
17477 \begin_layout Subsection
17478 LyX and Literate Programming
17481 \begin_layout Standard
17482 The LyX support for Literate Programming is provided by using the generic
17483 LyX converters mechanism.
17484 This support is provided in a
17485 \begin_inset Quotes eld
17489 \begin_inset Quotes erd
17493 \begin_inset space \space{}
17496 you will be able to use this new LyX feature with some other literate programmin
17497 g tool of your choice by just changing your LyX preferences.
17500 \begin_layout Subsubsection
17501 Generating documents and code (weaving and tangling)
17504 \begin_layout Paragraph
17505 Selecting the document class
17508 \begin_layout Standard
17509 If you have installed Noweb and LyX successfully, whenever you open a new
17510 document or try to change the document class of an existing one, you will
17511 find that there are three new document classes available:
17514 \begin_layout Itemize
17518 \begin_layout Itemize
17522 \begin_layout Itemize
17526 \begin_layout Standard
17527 You must select one of them to create your literate documents from.
17531 \begin_layout Standard
17532 Note that literate documents are not limited to these three classes.
17533 New classes can be generated from other styles like letter or in combination
17534 with other class variations like Article (AMS).
17535 If you have special needs that cannot be covered by one of the existing
17536 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17537 will arrange to insert a new entry, or teach you how to do it.
17541 \begin_layout Plain Layout
17542 It is very simple, it involves the creation of a file with four lines, and
17543 re-running of the auto configuration.
17548 Moreover, if you use a literate tool other than Noweb you may need to create
17549 a new set of document classes for it.
17552 \begin_layout Paragraph
17556 \begin_layout Standard
17557 LyX enables you to write code with a layout named
17565 \begin_layout Plain Layout
17566 The equivalent Noweb term is
17567 \begin_inset Quotes eld
17571 \begin_inset Quotes erd
17575 For historical reasons, I got used to the term
17576 \begin_inset Quotes eld
17580 \begin_inset Quotes erd
17583 introduced by other literate tool named Nuweb, which I used for many years
17584 before rendering myself to Noweb.
17589 Noweb delimits scraps like this:
17592 \begin_layout LyX-Code
17596 \begin_layout LyX-Code
17600 \begin_layout LyX-Code
17604 \begin_layout LyX-Code
17608 \begin_layout LyX-Code
17612 \begin_layout Standard
17613 The problem is that whatever is written in between the << and the
17617 must be taken literally, i.e.
17618 \begin_inset space \space{}
17621 LyX should be prevented from making any special interpretation of what has
17623 This is handled by a special layout named Scrap, that works like a normal
17624 paragraph but has a free spacing capability.
17627 \begin_layout Standard
17628 The down side of the Scrap paragraph layout is that consecutive paragraphs
17629 of code will be spaced with one empty line in the source code and also
17630 in the printed documentation.
17631 The work around is to enter each line of code within a single Scrap, with
17632 a newline (ctrl-return).
17633 The example above will look like this:
17637 \begin_layout Plain Layout
17638 If you have a printed version of this document you will not see any difference
17639 between the previous example and this one.
17647 \begin_layout LyX-Code
17649 \begin_inset Newline newline
17653 \begin_inset Newline newline
17657 \begin_inset Newline newline
17661 \begin_inset Newline newline
17667 \begin_layout Standard
17668 This layout works fine.
17669 The only real inconvenience is that you have to type ctrl-return instead
17674 \begin_layout Plain Layout
17675 It is in my list of
17676 \begin_inset Quotes eld
17680 \begin_inset Quotes erd
17691 \begin_layout Standard
17692 As a special note, you can also use the
17693 \begin_inset Quotes eld
17697 \begin_inset Quotes erd
17700 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17704 \begin_layout LyX-Code
17706 \begin_inset Newline newline
17709 def some_function(args):
17710 \begin_inset Newline newline
17713 "This is the doc string for this function."
17714 \begin_inset Newline newline
17717 print "My args: ", args
17720 \begin_layout LyX-Code
17721 @ %def some_function
17724 \begin_layout Standard
17725 For an example of this usage and the resulting cross-reference output, look
17726 at the Literate python program in
17728 LIBDIR/examples/listerrors.lyx
17730 which should make this all clear.
17733 \begin_layout Paragraph
17734 Generating the documentation
17737 \begin_layout Standard
17738 At this point you already have a new document file with a proper document
17739 class, and with some code and text on it.
17740 How do I print it? The answer is simple, you select
17745 iew\SpecialChar \menuseparator
17753 Just like you would do for a plain document.
17754 No special procedure is required.
17757 \begin_layout Standard
17758 To help orientate you, I will now explain what happens inside LyX:
17761 \begin_layout Enumerate
17764 Update\SpecialChar \menuseparator
17767 menu option is chosen, a LaTeX file is generated.
17772 \begin_layout Standard
17773 If the document is of any literate class the generated file will be named
17774 with an extension name defined by the
17775 \begin_inset Quotes eld
17779 \begin_inset Quotes erd
17782 format (defined in the Preferences panel), otherwise the file will have
17791 \begin_layout Enumerate
17792 Note that the only difference so far is in the name of the file, no special
17793 processing is required by LyX.
17794 Given that you formatted the code using the Scrap layout that, by itself,
17795 takes care of the business.
17798 \begin_layout Enumerate
17799 If the document is of any literate class LyX will then use the internal
17800 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17804 \begin_layout Plain Layout
17805 The converters are defined in the
17807 Tools\SpecialChar \menuseparator
17811 \begin_inset Quotes eld
17815 \begin_inset Quotes erd
17827 manual for general information about converters.
17832 to generate the LaTeX file.
17836 \begin_layout Standard
17837 Otherwise it will just skip this step.
17841 \begin_layout Enumerate
17842 Finally, LaTeX is invoked and the regular post processing continues as in
17846 \begin_layout Standard
17847 Independence from a particular
17848 \begin_inset Quotes eld
17852 \begin_inset Quotes erd
17855 is easily achieved by changing the commands that are run by the various
17859 \begin_layout Paragraph
17860 Generating the code
17863 \begin_layout Standard
17864 When the build menu option is chosen or the corresponding button in the
17865 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17866 Next, LyX invokes the
17871 This converter needs to be defined by the user and is not installed by
17872 default, though the Program format is.
17873 This converter (like any other converter) will have two parts:
17876 \begin_layout Enumerate
17877 The converter program itself.
17878 This program performs the conversion from the one format to the other (in
17879 this case, from the Noweb format to the Program pseudo-format).
17882 \begin_layout Enumerate
17883 The error log parser.
17884 This is a program whose sole purpose is to rewrite error messages in a
17885 format that LyX understands.
17886 This makes it possible for LyX to place error boxes in the right places
17887 in the file buffer.
17890 \begin_layout Standard
17891 The first part, the
17892 \begin_inset Quotes eld
17896 \begin_inset Quotes erd
17899 setting, should be set to
17900 \begin_inset Quotes eld
17908 \begin_inset Quotes erd
17912 This basically means that LyX will call
17913 \begin_inset Quotes eld
17917 \begin_inset Quotes erd
17920 (a program or script) with the name of the Noweb file (normally a file
17921 in the LyX temp directory).
17925 \begin_layout Standard
17926 This is an implementation of
17927 \begin_inset Quotes eld
17931 \begin_inset Quotes erd
17934 that you can place in a directory on your path:
17937 \begin_layout LyX-Code
17941 \begin_layout LyX-Code
17945 \begin_layout LyX-Code
17946 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17949 \begin_layout Standard
17950 The next part of the converter setting is the
17951 \begin_inset Quotes eld
17955 \begin_inset Quotes erd
17958 which is to be set to
17959 \begin_inset Quotes eld
17964 parselog=listerrors
17967 \begin_inset Quotes erd
17971 This will run any errors that are generated by the
17972 \begin_inset Quotes eld
17976 \begin_inset Quotes erd
17979 process through the
17980 \begin_inset Quotes eld
17984 \begin_inset Quotes erd
17990 \begin_layout Standard
17991 The converter code looks in
17999 then on the path for the
18000 \begin_inset Quotes eld
18004 \begin_inset Quotes erd
18010 \begin_layout Standard
18011 The build will normally take place in LyX's temporary directory, so the
18012 files produced by the conversion will be in that directory.
18013 LyX will copy out what it regards as the `main' file, but the
18017 conversion may produce several files, and so most of these would then be
18018 deleted when LyX was closed.
18019 The present solution is to use a `copier',
18023 \begin_layout Plain Layout
18032 manual for information on these.
18041 script in its default mode, so that the entire contents of the temporary
18042 directory is copied.
18043 More will get copied than is needed, to be sure, but nothing will be lost.
18044 If, however, you know what extensions the generated files will have, this
18045 can be improved by using the
18054 This option takes a comma-separated list of extensions to copy.
18055 So, for example, if the conversion will generate only files with the extensions
18064 , then the correct definition would be:
18067 \begin_layout LyX-Code
18068 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18071 \begin_layout Standard
18072 The result will be that only files with these two extensions will be copied
18076 \begin_layout Paragraph
18077 Build instructions in the document
18080 \begin_layout Standard
18081 The last piece of the integration between LyX and noweb is the
18082 \begin_inset Quotes eld
18086 \begin_inset Quotes erd
18090 Generally, the instructions for building your program should be embedded
18091 in a scrap of its own.
18093 \begin_inset Quotes eld
18097 \begin_inset Quotes erd
18100 above uses the notangle command to look for this scrap (called
18101 \begin_inset Quotes eld
18105 \begin_inset Quotes erd
18108 ) and runs its contents through
18109 \begin_inset Quotes eld
18113 \begin_inset Quotes erd
18119 \begin_layout Standard
18120 Typically, such a scrap would look something like this:
18123 \begin_layout LyX-Code
18125 \begin_inset Newline newline
18129 \begin_inset Newline newline
18133 \begin_inset Newline newline
18136 if [ -z "${NOWEB_SOURCE}" ]
18137 \begin_inset Newline newline
18141 \begin_inset Newline newline
18144 NOWEB_SOURCE=myfile.nw
18145 \begin_inset Newline newline
18149 \begin_inset Newline newline
18153 code to extract files ...]
18154 \begin_inset Newline newline
18158 code to compile files ...]
18159 \begin_inset Newline newline
18165 \begin_layout Standard
18168 LIBDIR/examples/listerrors.lyx
18172 LIBDIR/examples/Literate.lyx
18174 which implement two versions of the
18175 \begin_inset Quotes eld
18179 \begin_inset Quotes erd
18182 program for some illustrations of how all of these pieces go together or
18185 LIBDIR/examples/noweb2lyx.lyx.
18188 Interestingly, these three files show off the language-indepence of the
18189 LyX literate programming support since they are written in Python, C and
18193 \begin_layout Subsubsection
18197 \begin_layout Standard
18198 All the Literate Programming support is configured by the
18203 ools\SpecialChar \menuseparator
18211 \begin_inset Quotes eld
18215 \begin_inset Quotes erd
18219 The important parts are:
18222 \begin_layout Description
18224 \begin_inset space ~
18228 \begin_inset Quotes eld
18232 \begin_inset Quotes erd
18236 \begin_inset space ~
18239 format Set up via the Formats tab, this is where the Noweb-specific pieces
18249 , the file extension is set to
18254 This tells LyX to create a file with a
18258 extension in the first step of the conversion process.
18261 \begin_layout Description
18263 \begin_inset space ~
18271 \begin_inset space ~
18274 format This is an empty format whose sole purpose is to be the endpoint
18275 of a conversion (which then allows us to set up a converter for it).
18278 \begin_layout Description
18287 This converter performs the
18288 \begin_inset Quotes eld
18292 \begin_inset Quotes erd
18295 of the literate document.
18296 For Noweb, it is set to
18297 \begin_inset Quotes eld
18302 noweave -delay -index $$i > $$o
18305 \begin_inset Quotes erd
18311 \begin_layout Description
18321 \begin_inset Quotes eld
18325 \begin_inset Quotes erd
18329 As stated above, the Converter is set to
18330 \begin_inset Quotes eld
18338 \begin_inset Quotes erd
18341 , with Flags set to
18342 \begin_inset Quotes eld
18347 originaldir,parselog=listerrors
18350 \begin_inset Quotes erd
18356 \begin_layout Subsubsection
18360 \begin_layout Standard
18361 There is also a new function implemented in the LyX server, the
18362 \begin_inset Quotes eld
18365 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18369 \begin_layout Standard
18370 When debugging code with ddd/gdb, it is possible to invoke a text editor
18371 at the current execution position with a single key stroke.
18372 The default ddd configuration for that is shift-ctrl-V.
18373 It happens that you can define the editor command line invocation in ddd
18379 dit\SpecialChar \menuseparator
18384 references\SpecialChar \menuseparator
18391 dialog and changing the "Edit Sources" entry.
18394 \begin_layout Standard
18395 I take advantage of the new created LyX server function and this ddd feature,
18397 \begin_inset Quotes eld
18401 \begin_inset Quotes erd
18407 \begin_layout LyX-Code
18408 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18411 \begin_layout Standard
18412 With this, whenever you are using ddd and find a point in the program that
18413 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18414 ddd you forward this information to LyX through the LyX server and then
18415 the LyX window will show the same file with the cursor at the same position
18416 ddd was pointing to.
18417 No more guessing or long scrolling to locate a point in the program back
18421 \begin_layout Standard
18422 Note however that you must enable the LyX server to get this feature working
18423 (it is disabled by default).
18424 You can enable it in
18436 ) by entering in the
18441 \begin_inset Quotes eld
18446 /home/<your-home-directory>/.lyx/lyxpipe
18449 \begin_inset Quotes erd
18455 \begin_layout Standard
18456 Read the LyX server documentation in the
18458 Customization Manual
18460 for further information.
18463 \begin_layout Subsubsection
18467 \begin_layout Standard
18468 There are six new buttons that can be added to your LyX toolbar.
18469 Five of these buttons are short cuts to layout styles:
18490 The last one is a short cut to the
18491 \begin_inset Quotes eld
18495 \begin_inset Quotes erd
18502 \begin_layout Standard
18503 LyX has a range of buttons that are available for tool bar customization.
18504 In my toolbar I like to combine the six short cuts above with two more:
18512 \SpecialChar \menuseparator
18520 \SpecialChar \menuseparator
18533 iew\SpecialChar \menuseparator
18541 Here is how it looks like:
18544 \begin_layout LyX-Code
18548 \begin_layout LyX-Code
18552 \begin_layout LyX-Code
18553 Icon "layout Standard"
18556 \begin_layout LyX-Code
18557 Icon "layout Section"
18560 \begin_layout LyX-Code
18561 Icon "layout LaTeX"
18564 \begin_layout LyX-Code
18565 Icon "layout LyX-Code"
18568 \begin_layout LyX-Code
18569 Icon "layout Scrap"
18572 \begin_layout LyX-Code
18576 \begin_layout LyX-Code
18580 \begin_layout LyX-Code
18581 Icon "buffer-typeset"
18584 \begin_layout LyX-Code
18585 Icon "build-program"
18588 \begin_layout LyX-Code
18592 \begin_layout LyX-Code
18596 \begin_layout LyX-Code
18600 \begin_layout LyX-Code
18604 \begin_layout LyX-Code
18608 \begin_layout Subsubsection
18609 Colors customization
18612 \begin_layout Standard
18613 There are a number of colors in LyX that can be customized in
18618 One of the things that bothers people is the LaTeX font color.
18619 The default color is red, since the scraps uses LaTeX font, and there is
18620 a lot of scraps in literate documents, you may get tired of seeing everything
18622 You can change it by going to the tabs
18631 \begin_layout Standard
18632 The next thing is the visible presence of the newline character in the screen.
18633 You can choose the color of this particular character and make it blend
18635 I recommend you choosing a color that is close to the background but not
18636 equal, that way you still can see it is there, but it is not bothering
18641 \begin_layout Chapter
18642 Secrets of the LaTeX Masters
18643 \begin_inset CommandInset label
18652 \begin_layout Standard
18653 Though LyX is a powerful tool, it cannot hope to support everything that
18654 can be done with pure TeX/LaTeX.
18655 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18656 as long as you are not afraid to use that
18657 \begin_inset Quotes eld
18661 \begin_inset Quotes erd
18664 button on the toolbar or add things to the LaTeX preamble.
18665 This section lists some tips, tricks, and otherwise cool ideas to give
18666 your document that extra little flair.
18669 Do try this at home
18671 , just start with something a little smaller and less important than your
18675 \begin_layout Standard
18676 Most ideas in this section require less common files in your LaTeX installation.
18677 If you have a system like teTeX, most will already be available.
18678 A few, however, will need to be downloaded from one of the CTAN archives.
18679 Often, there are several ways to do something, or several LaTeX style files
18680 which do the same thing.
18681 We do not endorse one choice over another, we simply claim that we have
18682 done a particular task with a particular file.
18683 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18686 \begin_layout Section
18690 \begin_layout Standard
18693 Lars Gullik Bjønnes
18696 \begin_layout Subsection
18700 \begin_layout Standard
18701 The aim for this chapter
18705 \begin_layout Plain Layout
18706 Editor's note: Lars' original chapter was a masterful description of how
18712 However, it was too long to flow smoothly in this document.
18713 I have therefore chosen to excerpt the most important sections here (sorry,
18714 Lars); you can read the original chapter (and more of the story!) in the
18717 examples/multicol.lyx
18725 is to show how the LaTeX package
18729 can be used in a LyX document.
18730 As LyX doesn't support the
18734 package natively yet, we have to use some small hacks.
18735 By reading this section it should be obvious how to do this.
18738 \begin_layout Subsection
18742 \begin_layout Standard
18747 package allows switching between one and multicolumn format on the same
18749 Footnotes are handled correctly (for the most part), but will be placed
18750 at the bottom of the page and not under each column.
18751 LaTeX's float mechanism, however, is partly disabled in the current implementat
18753 At the moment only page-wide floats can be used within the scope of the
18757 \begin_layout Subsection
18761 \begin_layout Subsubsection
18765 \begin_layout Standard
18766 If you want to have two columns in your text, you have use LaTeX mode to
18771 begin{multicols}{2}
18773 at the point where you want the two column layout to start, and then
18779 where you want it to end.
18783 \begin_layout Standard
18787 \begin_layout Plain Layout
18791 begin{multicols}{2}
18799 \begin_layout Standard
18804 The Adventure of the Empty House
18807 \begin_inset Newline newline
18812 Sir Arthur Conan Doyle
18815 \begin_layout Standard
18818 It was in the spring of the year 1894 that all London was interested, and
18819 the fashionable world dismayed, by the murder of the Honourable Ronald
18820 Adair under most unusual and inexplicable circumstances.
18821 The public has already learned those particulars of the crime which came
18822 out in the police investigation, but a good deal was suppressed upon that
18823 occasion, since the case for the prosecution was so overwhelmingly strong
18824 that it was not necessary to bring forward all the facts.
18825 Only now, at the end of nearly ten years, am I allowed to supply those
18826 missing links which make up the whole of that remarkable chain.
18827 The crime was of interest in itself, but that interest was as nothing to
18828 me compared to the inconceivable sequel, which afforded me the greatest
18829 shock and surprise of any event in my adventurous life.
18830 Even now, after this long interval, I find myself thrilling as I think
18831 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18832 ty which utterly submerged my mind.
18833 Let me say to that public, which has shown some interest in those glimpses
18834 which I have occasionally given them of the thoughts and actions of a very
18835 remarkable man, that they are not to blame me if I have not shared my knowledge
18836 with them, for I should have considered it my first duty to do so, had
18837 I not been barred by a positive prohibition from his own lips, which was
18838 only withdrawn upon the third of last month.
18841 \begin_layout Standard
18845 \begin_layout Plain Layout
18857 \begin_layout Subsubsection
18861 \begin_layout Standard
18862 The same pattern is used when you want more than two columns:
18865 \begin_layout Standard
18869 \begin_layout Plain Layout
18873 begin{multicols}{3}
18881 \begin_layout Standard
18884 It can be imagined that my close intimacy with Sherlock Holmes had interested
18885 me deeply in crime, and that after his disappearance I never failed to
18886 read with care the various problems which came before the public.
18887 And I even attempted, more than once, for my own private satisfaction,
18888 to employ his methods in their solution, though with indifferent success.
18889 There was none, however, which appealed to me like this tragedy of Ronald
18891 As I read the evidence at the inquest, which led up to a verdict of willful
18892 murder against some person or persons unknown, I realized more clearly
18893 than I had ever done the loss which the community had sustained by the
18894 death of Sherlock Holmes.
18895 There were points about this strange business which would, I was sure,
18896 have specially appealed to him, and the efforts of the police would have
18897 been supplemented, or more probably anticipated, by the trained observation
18898 and the alert mind of the first criminal agent in Europe.
18899 All day, as I drove upon my round, I turned over the case in my mind and
18900 found no explanation which appeared to me to be adequate.
18901 At the risk of telling a twice-told tale, I will recapitulate the facts
18902 as they were known to the public at the conclusion of the inquest.
18905 \begin_layout Standard
18909 \begin_layout Plain Layout
18921 \begin_layout Standard
18922 You can have more than 3 columns if you want to, but that might not be very
18923 pleasant for the eye.
18926 \begin_layout Subsubsection
18927 Columns inside columns
18930 \begin_layout Standard
18931 You can even have columns inside columns:
18934 \begin_layout Standard
18938 \begin_layout Plain Layout
18942 begin{multicols}{2}
18950 \begin_layout Standard
18953 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18954 at that time governor of one of the Australian colonies.
18955 Adair's mother had returned from Australia to undergo the operation for
18956 cataract, and she, her son Ronald, and her daughter Hilda were living together
18960 \begin_layout Standard
18964 \begin_layout Plain Layout
18968 begin{multicols}{2}
18976 \begin_layout Standard
18979 The youth moved in the best society--had, so far as was known, no enemies
18980 and no particular vices.
18981 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18982 had been broken off by mutual consent some months before, and there was
18983 no sign that it had left any very profound feeling behind it.
18984 For the rest {sic} the man's life moved in a narrow and conventional circle,
18985 for his habits were quiet and his nature unemotional.
18986 Yet it was upon this easy-going young aristocrat that death came, in most
18987 strange and unexpected form, between the hours of ten and eleven-twenty
18988 on the night of March 30, 1894.
18991 \begin_layout Standard
18995 \begin_layout Plain Layout
19007 \begin_layout Standard
19010 Ronald Adair was fond of cards--playing continually, but never for such
19011 stakes as would hurt him.
19012 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19013 It was shown that, after dinner on the day of his death, he had played
19014 a rubber of whist at the latter club.
19015 He had also played there in the afternoon.
19020 The evidence of those who had played with him-- Mr.
19021 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19022 and that there was a fairly equal fall of the cards.
19023 Adair might have lost five pounds, but not more.
19024 His fortune was a considerable one, and such a loss could not in any way
19026 He had played nearly every day at one club or other, but he was a cautious
19027 player, and usually rose a winner.
19028 It came out in evidence that, in partnership with Colonel Moran, he had
19029 actually won as much as four hundred and twenty pounds in a sitting, some
19030 weeks before, from Godfrey Milner and Lord Balmoral.
19031 So much for his recent history as it came out at the inquest.
19034 \begin_layout Standard
19038 \begin_layout Plain Layout
19050 \begin_layout Standard
19051 Please do read the file
19053 examples/multicol.lyx
19055 for more advanced examples including column and header spacing, vertical
19056 separator lines, and more.
19059 \begin_layout Section
19064 Paragraph Environment
19065 \begin_inset OptArg
19068 \begin_layout Plain Layout
19069 Numbering in Enumerate
19077 \begin_layout Standard
19083 \begin_layout Standard
19084 \begin_inset VSpace bigskip
19090 \begin_layout Standard
19092 The default numbering for the
19096 paragraph environment begins with Arabic numbers and ends with uppercase
19098 Suppose, however, you wanted a different type of numbering scheme.
19099 Here's a quickie example of how to change the numbering scheme:
19102 \begin_layout LyX-Code
19112 \begin_layout LyX-Code
19122 \begin_layout LyX-Code
19132 \begin_layout LyX-Code
19142 \begin_layout Standard
19143 \SpecialChar \ldots{}
19144 which changes the numbering scheme to uppercase Roman numerals, uppercase
19145 letters, Arabic numbers, and lowercase letter.
19148 \begin_layout Standard
19149 Additionally, the previous example also adds a little bit extra to the numbering
19151 For example, the first level label actually looks like:
19152 \begin_inset Quotes eld
19156 \begin_inset Quotes erd
19160 For ease of reading, we'll describe what the numbering schemes look like
19161 using a notation something like this: <
19162 \begin_inset Quotes eld
19166 \begin_inset Quotes erd
19170 \begin_inset space ~
19174 \begin_inset Quotes erd
19178 \begin_inset Quotes erd
19182 \begin_inset space ~
19186 \begin_inset Quotes erd
19190 \begin_inset Quotes erd
19194 \begin_inset space ~
19198 \begin_inset Quotes eld
19202 \begin_inset Quotes erd
19209 \begin_layout Standard
19210 As you can see in the example, there is a label command for each nesting
19217 \SpecialChar \ldots{}
19224 , as well as a counter,
19228 \SpecialChar \ldots{}
19234 There are also five
19235 \begin_inset Quotes eld
19239 \begin_inset Quotes erd
19272 , each of which take one counter as an argument.
19273 You can add characters before or after these, but there's no need to add
19277 \begin_layout Standard
19278 You can get really fancy with these.
19282 \begin_layout LyX-Code
19296 \begin_layout LyX-Code
19308 \begin_layout LyX-Code
19318 \begin_layout LyX-Code
19328 \begin_layout Standard
19329 produces the somewhat out of hand numbering scheme: <
19330 \begin_inset Quotes eld
19334 \begin_inset Quotes erd
19338 \begin_inset space ~
19342 \begin_inset Quotes erd
19346 \begin_inset Quotes erd
19350 \begin_inset space ~
19354 \begin_inset Quotes erd
19358 \begin_inset Quotes erd
19362 \begin_inset space ~
19366 \begin_inset Quotes eld
19370 \begin_inset Quotes erd
19377 \begin_layout Standard
19381 \begin_layout Section
19385 \begin_layout Standard
19391 \begin_layout Standard
19392 \begin_inset VSpace bigskip
19398 \begin_layout Standard
19403 \begin_layout Plain Layout
19409 tmpfont}{cmr17 scaled 2500}{
19421 \begin_layout Standard
19426 \begin_layout Plain Layout
19437 hose of you who like the style of old books probably also like
19438 \begin_inset Quotes eld
19442 \begin_inset Quotes erd
19445 ---those large capital letters which begin each new chapter or section.
19446 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19447 know some plain TeX!) but does require a lot of work and many iterations,
19448 as you can see by all the ugly TeX-mode stuff at the beginning of this
19452 \begin_layout Standard
19456 \begin_layout Plain Layout
19462 bigdrop{-1em}{3}{ptmri}{T}+
19467 here is a much easier way of doing this, of course.
19476 ) package from CTAN allows a simple way to add such letters to your documents.
19477 Since this package is not a standard part of teTeX, I can't demonstrate
19478 it within this document, but if you copy this paragraph to a new document,
19480 \begin_inset Quotes eld
19490 \begin_inset Quotes erd
19493 and the pluses from the TeX code at the beginning of the paragraph, and
19498 usepackage{dropcaps}
19500 to your LaTeX preamble, you will get a nice Times Roman Italic
19501 \begin_inset Quotes eld
19505 \begin_inset Quotes erd
19508 , whose height is three lines of text and which protrudes 1 em into the
19510 (Make certain you have copied
19511 \begin_inset Quotes eld
19519 \begin_inset Quotes erd
19522 into a directory where TeX can see it.) The first argument is the amount
19523 of indentation; in this case the negative sign moves it into the margin.
19524 The second argument is the height of the letter in number of lines of text.
19525 The third argument is the font name: virtually anything which has a tfm
19526 file should work (wade through the
19528 .../texmf/fonts/tfm
19530 directory for possibilities).
19531 My personal favorite is
19532 \begin_inset Quotes eld
19540 \begin_inset Quotes erd
19543 , a fancy German font specifically designed for dropped capitals.
19544 The fourth argument is the letter (or letters) to be dropped.
19549 package also offers the
19555 command, as well as a slightly simplified
19564 \begin_layout Section
19565 Non-standard Paragraph Shapes
19568 \begin_layout Standard
19574 \begin_layout Standard
19575 \begin_inset VSpace bigskip
19581 \begin_layout Standard
19585 \begin_layout Plain Layout
19597 \begin_layout Standard
19601 \begin_layout Plain Layout
19610 \begin_layout Plain Layout
19624 \begin_layout Standard
19629 \begin_layout Plain Layout
19640 \begin_layout Plain Layout
19649 \begin_layout Plain Layout
19658 \begin_layout Plain Layout
19667 \begin_layout Plain Layout
19676 \begin_layout Plain Layout
19685 \begin_layout Plain Layout
19694 \begin_layout Plain Layout
19703 \begin_layout Plain Layout
19712 \begin_layout Plain Layout
19721 \begin_layout Plain Layout
19730 \begin_layout Plain Layout
19739 \begin_layout Plain Layout
19748 \begin_layout Plain Layout
19757 \begin_layout Plain Layout
19766 \begin_layout Plain Layout
19775 \begin_layout Plain Layout
19784 \begin_layout Plain Layout
19793 \begin_layout Plain Layout
19802 \begin_layout Plain Layout
19808 There are times when the tyranny of rectangular paragraphs must be overthrown.
19809 In such situations, a call to the delightful plain TeX command
19816 As you can see, completely arbitrary shapes can be laid out with a suitable
19817 set of linelength definitions.
19818 While this parshape may look a bit silly and useless, one could conceive
19819 of situations such as finely tuned dropped capitals, word wrapping around
19820 non-rectangular graphics, etc.
19821 which will benefit from such handcrafting.
19824 \begin_layout Standard
19825 \begin_inset VSpace bigskip
19831 \begin_layout Standard
19836 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19843 is the number of lines of text which define the paragraph.
19844 If there turn out to be fewer lines, the shape is truncated; if there are
19845 more, the excess lines have the same dimensions as the last line of the
19855 entries specify the indentation of the line from the left margin, and the
19856 length of the line as measured from that point.
19857 The shape applies only to the current paragraph; everything is reset to
19858 normal for the next paragraph.
19861 \begin_layout Standard
19865 \begin_layout Plain Layout
19877 \begin_layout Section
19881 \begin_layout Standard
19882 As you can see, the examples in this section range from the useful to the
19884 While I don't expect that anyone will ever need the paragraph shape demonstrate
19885 d in the last section, the important point is that you can do almost anything
19886 you want in LyX if you are willing to figure out how to do it in TeX and
19888 TeX is a fantastically powerful typesetting system and all that power is
19889 available to you since LyX uses it as its backend.