1 #LyX 1.6.0rc5 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 \thinspace{}
1288 \begin_inset space \space{}
1291 the page isn't shifted.
1292 Unfortunately, some DVI drivers always seem to shift the page.
1293 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1294 If you're using LyX on a system that you don't personally maintain, and
1295 your sysadmin is a doofus,
1296 \begin_inset Flex CharStyle:Code
1299 \begin_layout Plain Layout
1308 \begin_inset Flex CharStyle:Code
1311 \begin_layout Plain Layout
1320 Suppose you're left and top margins are always 0.5
1321 \begin_inset space \thinspace{}
1325 You can add this to the preamble:
1328 \begin_layout LyX-Code
1336 \begin_layout LyX-Code
1344 \begin_layout Standard
1345 and your margins should now be correct.
1348 \begin_layout Subsubsection
1352 \begin_layout Standard
1353 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1354 There's a rather nice package, available at your nearest CTAN archive,
1355 for printing sheets of labels:
1356 \begin_inset Flex CharStyle:Code
1359 \begin_layout Plain Layout
1366 Now, your system may not have this package installed by default.
1367 We leave that up to you to check.
1368 You'll also want to read the documentation for it; we're not going to do
1370 Since this is an example, however, we'll give you an example of how you
1374 \begin_layout Standard
1375 First, make sure you're using the
1376 \begin_inset Flex CharStyle:Code
1379 \begin_layout Plain Layout
1386 Next, you need to put the following in your preamble:
1389 \begin_layout LyX-Code
1395 \begin_layout LyX-Code
1401 \begin_layout LyX-Code
1407 \begin_layout LyX-Code
1413 \begin_layout LyX-Code
1419 \begin_layout LyX-Code
1425 \begin_layout LyX-Code
1431 \begin_layout Standard
1432 This sets things up for Avery label sheets, stock #5360.
1433 You're now ready to print labels, but you'll need to insert LaTeX code,
1434 placing the commands
1435 \begin_inset Flex CharStyle:Code
1438 \begin_layout Plain Layout
1447 \begin_inset Flex CharStyle:Code
1450 \begin_layout Plain Layout
1458 around each label text.
1459 This and other special features of
1460 \begin_inset Flex CharStyle:Code
1463 \begin_layout Plain Layout
1469 are explained in its documentation.
1472 \begin_layout Standard
1473 Someday, someone may write a LyX layout file to support this package directly.
1474 Maybe that someone is you.
1477 \begin_layout Subsubsection
1478 Example #3: Paragraph Indentation
1481 \begin_layout Standard
1482 Americans are trained to indent the first line of
1487 As with all of their other weird quirks, most Americans will whine and
1488 moan until they can have their way and indent the first line of all paragraphs.
1497 \begin_layout Standard
1498 Of course, this behavior isn't standard typography.
1499 In books, you typically only indent the first line of a paragraph
1503 it follows another one.
1504 The idea behind indenting the first line of a paragraph is to distinguish
1505 neighboring paragraphs from one another.
1506 If there is no previous paragraph---for example, if it follows a figure
1507 or is the first paragraph in a section---then there is no need for indentation.
1511 \begin_layout Standard
1512 If you're a typical American (we're still joking!), though, you don't care
1513 about such esoteric things; you want your indentation! Add this to the
1517 \begin_layout LyX-Code
1520 usepackage{indentfirst}
1523 \begin_layout Standard
1524 If your TeX distribution isn't braindead, you'll have this package, and
1525 all of your paragraphs will get the indentation the Founding Fathers intended
1529 \begin_layout Subsubsection
1530 Example #4: This Document
1533 \begin_layout Standard
1534 You can also check out the preamble of this document to get an idea of some
1535 of the advanced things you can do.
1536 Also, there are more examples and an assortment of LaTeX
1537 \begin_inset Quotes eld
1541 \begin_inset Quotes erd
1545 \begin_inset space ~
1549 \begin_inset CommandInset ref
1551 reference "cha:secrets"
1559 \begin_layout Section
1560 LyX and LaTeX Errors
1563 \begin_layout Standard
1564 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1566 It then uses the logfile from the LaTeX run to do a post-mortem.
1567 After analyzing the logfile,LyX displays a dialog listing the errors.
1568 Clicking on any one of them will take you to the position in your LyX file
1569 where the error occurred.
1573 \begin_layout Plain Layout
1575 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1577 There are also cases where LaTeX reports the error on one line, but the
1578 actual error is earlier.
1579 This is not unlike forgetting a closing brace in a program: You'll get
1580 an error, but only later.
1588 \begin_layout Standard
1589 Some folks also like to look at the log file directly: It is available from
1591 \begin_inset Flex CharStyle:MenuItem
1594 \begin_layout Plain Layout
1597 \SpecialChar \menuseparator
1601 \begin_inset space ~
1610 There are some fairly common error messages and warnings.
1611 We'll cover those here.
1612 You should look at a good LaTeX book for a complete listing.
1615 \begin_layout Itemize
1616 \begin_inset Flex CharStyle:Code
1619 \begin_layout Plain Layout
1626 \begin_inset Newline newline
1629 Anything beginning with these words is a warning message for the purpose
1631 \begin_inset Quotes eld
1635 \begin_inset Quotes erd
1638 the LaTeX code itself.
1639 You'll get messages like this if you added or changed cross-references
1640 or bibliography entries, in which case, LaTeX is trying to tell you that
1641 you need to make another run.
1642 You can by-and-large ignore these.
1645 \begin_layout Itemize
1646 \begin_inset Flex CharStyle:Code
1649 \begin_layout Plain Layout
1656 \begin_inset Newline newline
1659 Another warning message, this time about fonts which LaTeX couldn't find.
1660 The rest of the message will often say something about a replacement font
1662 You can safely ignore these, too.
1665 \begin_layout Itemize
1666 \begin_inset Flex CharStyle:Code
1669 \begin_layout Plain Layout
1678 \begin_inset Newline newline
1686 They are warnings about lines that were too long and run past the right
1688 Almost always, this is unnoticeable in the final output.
1689 (It can be just a point or two.) Or, only one or two characters extend past
1691 LaTeX seems to generate at least one of these messages for just about any
1693 \begin_inset Newline newline
1696 You can ignore these messages.
1697 Your eyes will tell you if there's a problem with something that's too
1698 wide; just look at the output.
1702 \begin_layout Plain Layout
1703 You can also enable the `draft' option in
1704 \begin_inset Flex CharStyle:MenuItem
1707 \begin_layout Plain Layout
1710 \SpecialChar \menuseparator
1718 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1726 \begin_layout Itemize
1727 \begin_inset Flex CharStyle:Code
1730 \begin_layout Plain Layout
1739 \begin_inset Newline newline
1742 Not quite as common as its cousin.
1743 LaTeX seems to like to print lines that are a bit too wide as opposed to
1744 ones that are a bit too narrow.
1745 We have no idea why.
1748 \begin_layout Itemize
1749 \begin_inset Flex CharStyle:Code
1752 \begin_layout Plain Layout
1761 \begin_inset Flex CharStyle:Code
1764 \begin_layout Plain Layout
1773 \begin_inset Newline newline
1776 Warnings about troubles breaking the page.
1777 Once again, just look at the output.
1778 Your eyes will tell you where something has gone wrong.
1781 \begin_layout Itemize
1782 \begin_inset Flex CharStyle:Code
1785 \begin_layout Plain Layout
1787 \begin_inset Quotes els
1791 \begin_inset Quotes ers
1800 \begin_inset Newline newline
1804 \begin_inset Quotes eld
1808 \begin_inset Quotes erd
1811 isn't installed on this system.
1812 This usually appears because some package your document needs isn't installed.
1813 If you didn't touch the preamble or didn't use the
1814 \begin_inset Flex CharStyle:Code
1817 \begin_layout Plain Layout
1825 command, then one of the packages LyX tried to load is missing.
1827 \begin_inset Flex CharStyle:MenuItem
1830 \begin_layout Plain Layout
1831 Help\SpecialChar \menuseparator
1837 to get a list of packages that LyX knows about.
1838 This file is updated whenever you reconfigure LyX (using
1839 \begin_inset Flex CharStyle:MenuItem
1842 \begin_layout Plain Layout
1843 Tools\SpecialChar \menuseparator
1849 ) and tells you which packages have been detected and what they do.
1850 \begin_inset Newline newline
1854 \begin_inset Flex CharStyle:Code
1857 \begin_layout Plain Layout
1865 command and the package in question isn't installed, then you'll need to
1866 install it yourself.
1869 \begin_layout Itemize
1870 \begin_inset Flex CharStyle:Code
1873 \begin_layout Plain Layout
1874 LaTeX Error: Unknown option
1880 \begin_inset Newline newline
1883 Error messages beginning with this are trying to tell you that you specified
1884 a bad or undefined option to a package.
1885 Check the package's documentation.
1888 \begin_layout Itemize
1889 \begin_inset Flex CharStyle:Code
1892 \begin_layout Plain Layout
1893 Undefined control sequence
1899 \begin_inset Newline newline
1902 If you've inserted LaTeX code into your document, but made a typo, you'll
1904 You may have forgotten to load a package.
1905 In any case, this error message usually means that you used an undefined
1910 \begin_layout Standard
1911 There are other error and warning messages.
1912 Some are self-explanatory.
1913 These are usually LaTeX messages.
1914 Others are downright cryptic.
1915 These are usually TeX error messages, and we really have
1919 what they mean or how to decipher them.
1923 \begin_layout Standard
1924 There's a general sequence you should follow if you get error messages:
1927 \begin_layout Enumerate
1928 Look at the LaTeX code you inserted for typos.
1931 \begin_layout Enumerate
1932 If there are no typos, check that you used the command(s) correctly.
1935 \begin_layout Enumerate
1936 If you get a bunch of error boxes piled up at the very top of the document---and
1937 especially if you see a
1938 \begin_inset Quotes eld
1942 \begin_inset Flex CharStyle:Code
1945 \begin_layout Plain Layout
1954 \begin_inset Quotes erd
1957 error---it means that there are errors in the preamble.
1958 Start debugging your preamble.
1961 \begin_layout Enumerate
1962 If you didn't add anything to the preamble and didn't add any LaTeX code
1963 to the document, the first suspect is your LaTeX distribution itself.
1964 Check for missing packages and install them.
1967 \begin_layout Enumerate
1968 Okay, so there are no missing packages.
1969 Did you use any of the fine-tuning options in LyX? Specifically, did you
1974 any of them, like trying to manually insert lots of
1975 \begin_inset Flex CharStyle:Code
1978 \begin_layout Plain Layout
1980 \begin_inset space ~
1989 \begin_inset Flex CharStyle:Code
1992 \begin_layout Plain Layout
1999 \begin_inset Flex CharStyle:Code
2002 \begin_layout Plain Layout
2008 ? Did you try to kludge something together with these instead of using the
2009 appropriate paragraph environment?
2012 \begin_layout Enumerate
2013 All right, you didn't use any of the fine-tuning options, you played by
2015 Did you try to pull a fancy maneuver? Did you do something funky inside
2016 a table or an equation, like inserting a graphic into a table cell?
2019 \begin_layout Enumerate
2020 Do you have long sections of text where LaTeX cannot find a place to break
2021 a line? By default, LaTeX is rather strict about how much extra inter-word
2022 spacing it will add in order to break a line.
2023 Preferably, you should rework the paragraph to avoid the problem.
2024 If this isn't an option, you can wrap your text in
2025 \begin_inset Flex CharStyle:Code
2028 \begin_layout Plain Layout
2036 to make LaTeX's line breaking more, well, sloppy.
2039 \begin_layout Enumerate
2040 Did you go overboard with the nesting? LyX (currently) doesn't check to
2041 make sure you're in the limits for nesting environments.
2042 If you nested a bunch of environments to the
2043 \begin_inset Formula $17^{\mathrm{th}}$
2046 level, that's the problem.
2047 (The limit in LaTeX is five.)
2050 \begin_layout Enumerate
2051 Okay, you didn't get any error messages, but your output looks awful.
2052 If you have a table or figure that's too wide or long for the page, you
2057 \begin_layout Enumerate
2058 rescale the figure so it fits.
2061 \begin_layout Enumerate
2062 trim down the table so it fits.
2066 \begin_layout Enumerate
2067 If something else is wrong with the output, and you didn't try to pull anything
2068 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2071 \begin_layout Standard
2072 If all this doesn't help---well, then
2076 you might have found a bug in LyX\SpecialChar \ldots{}
2080 \begin_layout Chapter
2084 \begin_layout Section
2085 Customizing Bibliographies with BibTeX
2088 \begin_layout Standard
2089 The basics how to use BibTeX are explained in section
2091 Bibliography databases (BibTeX)
2098 The following subsections explain special bibliography features supported
2102 \begin_layout Subsection
2103 Alternative Citation Styles
2106 \begin_layout Standard
2107 Standard BibTeX uses numbers (e.
2108 \begin_inset space \thinspace{}
2112 \begin_inset space \space{}
2116 \begin_inset Quotes eld
2120 \begin_inset Quotes erd
2123 ) to refer to a cited work.
2124 However, in many scientific disciplines, other citation styles are in use.
2125 The most common one is the author-year style (e.
2126 \begin_inset space \thinspace{}
2130 \begin_inset space \space{}
2134 \begin_inset Quotes eld
2138 \begin_inset Quotes erd
2142 LyX supports two packages that provide this style,
2143 \begin_inset Flex CharStyle:Code
2146 \begin_layout Plain Layout
2153 \begin_inset Flex CharStyle:Code
2156 \begin_layout Plain Layout
2163 Both packages have their pros and cons, which cannot be listed in detail.
2164 If you only want to have simple author-year (or author-numerical) style,
2165 or if you want to use one of the countless style files for
2166 \begin_inset Flex CharStyle:Code
2169 \begin_layout Plain Layout
2175 , than the established
2176 \begin_inset Flex CharStyle:Code
2179 \begin_layout Plain Layout
2185 package is probably your choice.
2186 If you need special features like short title references, ibidem etc., you
2188 \begin_inset Flex CharStyle:Code
2191 \begin_layout Plain Layout
2200 \begin_layout Standard
2201 The handling of both packages in LyX is basically the same.
2203 \begin_inset Flex CharStyle:MenuItem
2206 \begin_layout Plain Layout
2207 Document\SpecialChar \menuseparator
2214 \begin_inset Flex CharStyle:MenuItem
2217 \begin_layout Plain Layout
2224 \begin_inset Flex CharStyle:MenuItem
2227 \begin_layout Plain Layout
2234 \begin_inset Flex CharStyle:MenuItem
2237 \begin_layout Plain Layout
2244 With both packages, you will get some extra features in the citation dialog
2245 and you can select the style of the reference (
2246 \begin_inset Quotes eld
2250 \begin_inset Quotes erd
2254 \begin_inset Quotes eld
2258 \begin_inset Quotes erd
2262 \begin_inset Quotes eld
2266 \begin_inset Quotes erd
2270 \begin_inset Quotes eld
2274 \begin_inset Quotes erd
2278 Note that both packages need specifically designed style files.
2279 They both ship their own, but there are lots of additional style files,
2280 and there is even an interactive style file builder
2284 \begin_layout Plain Layout
2286 \begin_inset Flex URL
2289 \begin_layout Plain Layout
2291 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2302 \begin_inset Flex CharStyle:Code
2305 \begin_layout Plain Layout
2314 \begin_layout Subsection
2315 Sectioned Bibliographies
2318 \begin_layout Standard
2319 Sometimes you might need to divide your bibliography into several sections.
2320 If you are for instance a historian, the possibility to separate sources
2321 and scientific works is most likely a
2322 \begin_inset Quotes eld
2326 \begin_inset Quotes erd
2330 Unfortunately, BibTeX itself does not allow you to do this.
2331 But with the help of some LaTeX packages, BibTeX can be extended to fit
2335 \begin_layout Standard
2336 LyX provides native support for one of these packages,
2344 \begin_layout Plain Layout
2346 \begin_inset Flex URL
2349 \begin_layout Plain Layout
2351 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2361 The advantage of this package (compared to other packages like
2365 ) is that you don't need to define new citation commands.
2366 Instead, you need to prepare different bibliographic databases which include
2367 the entries for the different sections of the bibliography.
2368 For example: If you want to divide your bibliography into the sections
2370 \begin_inset Quotes eld
2374 \begin_inset Quotes erd
2378 \begin_inset Quotes eld
2382 \begin_inset Quotes erd
2385 , you first need to create two bibliographic databases, e.
2386 \begin_inset space \thinspace{}
2390 \begin_inset space \space{}
2394 \begin_inset Flex CharStyle:Code
2397 \begin_layout Plain Layout
2404 \begin_inset Flex CharStyle:Code
2407 \begin_layout Plain Layout
2417 \begin_layout Standard
2419 \begin_inset Flex CharStyle:MenuItem
2422 \begin_layout Plain Layout
2423 Document\SpecialChar \menuseparator
2430 \begin_inset Flex CharStyle:MenuItem
2433 \begin_layout Plain Layout
2440 \begin_inset Flex CharStyle:MenuItem
2443 \begin_layout Plain Layout
2444 Sectioned bibliography
2450 Now you can insert multiple BibTeX bibliographies, one for each section
2451 of your bibliography.
2452 Returning to our example: Insert the BibTeX bibliography
2453 \begin_inset Flex CharStyle:Code
2456 \begin_layout Plain Layout
2462 and a second one for the database
2463 \begin_inset Flex CharStyle:Code
2466 \begin_layout Plain Layout
2473 You are free to use the same or different styles for each section.
2474 Additionally, you can chose if the bibliography section should contain
2476 \begin_inset Quotes eld
2479 all cited references
2480 \begin_inset Quotes erd
2483 of the specified database(s) (which is the default),
2484 \begin_inset Quotes eld
2487 all uncited references
2488 \begin_inset Quotes erd
2492 \begin_inset Quotes eld
2496 \begin_inset Quotes erd
2500 This might be useful if you would like to separate your bibliography into
2502 \begin_inset Quotes eld
2506 \begin_inset Quotes erd
2510 \begin_inset Quotes eld
2514 \begin_inset Quotes erd
2518 \begin_inset Quotes eld
2522 \begin_inset Quotes erd
2526 The titles for the sections can be added as ordinary sections or subsections.
2528 \begin_inset Flex CharStyle:Code
2531 \begin_layout Plain Layout
2537 removes the bibliography title, you have manually re-add that, too (as
2538 a chapter* or section*, for instance).
2541 \begin_layout Subsection
2542 Multiple Bibliographies
2545 \begin_layout Standard
2546 Multiple bibliographies, e.
2547 \begin_inset space \thinspace{}
2551 \begin_inset space \space{}
2554 a bibliography for each section or chapter of the document, are not supported
2557 \begin_inset Flex CharStyle:Code
2560 \begin_layout Plain Layout
2566 package, which is used for the creation of sectioned bibliographies in
2567 LyX (see the previous section), provides an easy way to solve this task,
2568 if you are willing to use some
2569 \begin_inset Flex CharStyle:MenuItem
2572 \begin_layout Plain Layout
2579 \begin_inset space ~
2583 \begin_inset CommandInset ref
2585 reference "sec:Inserting-TeX-Code"
2593 \begin_layout Plain Layout
2594 An alternative approach is to use the
2595 \begin_inset Flex CharStyle:Code
2598 \begin_layout Plain Layout
2605 \begin_inset Flex CharStyle:Code
2608 \begin_layout Plain Layout
2614 package, respectively.
2622 \begin_layout Standard
2624 \begin_inset Flex CharStyle:MenuItem
2627 \begin_layout Plain Layout
2628 Document\SpecialChar \menuseparator
2635 \begin_inset Flex CharStyle:MenuItem
2638 \begin_layout Plain Layout
2645 \begin_inset Flex CharStyle:MenuItem
2648 \begin_layout Plain Layout
2649 Sectioned bibliography
2655 In the document, you have to enclose the sections, which shall contain
2656 their own bibliography (including the BibTeX bibliography itself), between
2658 \begin_inset Flex CharStyle:Code
2661 \begin_layout Plain Layout
2670 \begin_inset Flex CharStyle:Code
2673 \begin_layout Plain Layout
2681 (those commands have to be inserted as ERT).
2682 The bibliography will contain all references which have been cited in the
2684 \begin_inset Flex CharStyle:Code
2687 \begin_layout Plain Layout
2698 If you are using this approach, then every citation reference has to be
2700 \begin_inset Flex CharStyle:Code
2703 \begin_layout Plain Layout
2711 \begin_inset Flex CharStyle:Code
2714 \begin_layout Plain Layout
2723 \begin_layout Section
2727 \begin_layout Subsection
2731 \begin_layout Standard
2732 When you are working on a large file with many sections, it is often convenient
2733 to break up the document into several files, or perhaps you have something
2734 where a table may change from time to time, but the preceding text does
2736 In these cases, you should seriously consider using multipart documents.
2737 For example, scientific papers often have five major sections: the introduction
2738 , observations, results, discussion, and conclusion.
2739 Each of these could be its own separate LyX file, with one
2740 \begin_inset Quotes eld
2744 \begin_inset Quotes erd
2747 file which contains the title, authors, abstract, references, etc., plus
2748 the five included files.
2749 It is important to note that each of these files is a full LyX file which
2750 can be formatted and printed on its own, as well as included in a master
2752 Each of these files must have the same document class, however---don't
2753 attempt to mix book classes with article classes.
2754 You may also include LaTeX files; however, these files must not have their
2756 \begin_inset space \thinspace{}
2760 \begin_inset space \space{}
2763 everything up to and including the
2764 \begin_inset Flex CharStyle:Code
2767 \begin_layout Plain Layout
2776 \begin_inset Flex CharStyle:Code
2779 \begin_layout Plain Layout
2787 line must be deleted) or else errors will be generated when you try to
2791 \begin_layout Standard
2792 LyX allows you to include files quite easily with
2793 \begin_inset Flex CharStyle:MenuItem
2796 \begin_layout Plain Layout
2797 Insert\SpecialChar \menuseparator
2799 \begin_inset space ~
2808 When you click on this selection a small box is inserted into the file
2809 at the current cursor location.
2810 Clicking on the box raises a dialog which allows you to select the file
2811 to be included, and the method of its inclusion.
2815 \begin_layout Standard
2816 The file selection box should by now be obvious.
2817 The three inclusion methods are
2818 \begin_inset Quotes eld
2822 \begin_inset Quotes erd
2826 \begin_inset Quotes eld
2830 \begin_inset Quotes erd
2834 \begin_inset Quotes eld
2838 \begin_inset Quotes erd
2842 The difference between
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2851 \begin_inset Quotes eld
2855 \begin_inset Quotes erd
2858 is really only meaningful to LaTeXperts, but the practical difference is
2859 that files which are
2860 \begin_inset Quotes eld
2864 \begin_inset Quotes erd
2867 are typeset beginning on a new page, while files which are
2868 \begin_inset Quotes eld
2872 \begin_inset Quotes erd
2875 are typeset starting on the current page.
2878 \begin_layout Standard
2879 Generally, the master file is converted into a full LaTeX file before typesettin
2880 g, while the included files are converted to LaTeX files which do not have
2881 all the preamble information.
2884 \begin_layout Standard
2886 \begin_inset Quotes eld
2890 \begin_inset Quotes erd
2893 included file allows you to include a file typeset exactly as it appears
2895 \begin_inset space \thinspace{}
2899 \begin_inset space \space{}
2903 \begin_inset Flex CharStyle:Code
2906 \begin_layout Plain Layout
2912 mode, with the characters set in a fixed-width typewriter font.
2913 Normally, spaces in this file are invisible, though two consecutive spaces
2914 are conserved, unlike LyX's normal treatment of spaces.
2915 However, setting the
2916 \begin_inset Flex CharStyle:MenuItem
2919 \begin_layout Plain Layout
2921 \begin_inset space ~
2925 \begin_inset space ~
2929 \begin_inset space ~
2937 checkbox typesets a mark to unambiguously define the presence of a space.
2941 \begin_layout Subsection
2942 Cross-References Between Files
2945 \begin_layout Standard
2946 \begin_inset Box Shadowbox
2955 height_special "totalheight"
2958 \begin_layout Plain Layout
2959 This section is somewhat out of date.
2960 Need to describe default master documents and how children are opened when
2970 \begin_layout Standard
2971 It is possible to set up cross-references between the different files.
2972 First, open all the files in question: let's call them A and B in a two
2973 file example, where B is included in A.
2974 Let's say you insert a label in A, then want to reference it in B.
2975 Open the cross-reference dialog in whilst in document B, and you can select
2977 \begin_inset Quotes eld
2981 \begin_inset Quotes erd
2987 \begin_layout Subsection
2988 Bibliography Lists in all Subdocuments
2991 \begin_layout Standard
2992 \begin_inset Box Frameless
3001 height_special "totalheight"
3004 \begin_layout Plain Layout
3005 This section also needs updating.
3006 There is now material about this on the wiki, and it could be copied here.
3014 \begin_layout Standard
3015 Copy the bibliography list with all entries to all subdocuments and transform
3017 This way LyX will find the
3018 \begin_inset Flex CharStyle:Code
3021 \begin_layout Plain Layout
3027 -files and you can easily insert references without making the bibliography
3031 \begin_layout Standard
3032 As the bibliography list is in a comment, LaTeX won't use use it and the
3033 references will look like this: [?], instead of like this: [1].
3034 One solution is to use the LaTeX-package
3035 \begin_inset Flex CharStyle:Code
3038 \begin_layout Plain Layout
3044 that will only include comments by processing the files separately.
3045 To do this, add in the LaTeX preamble of every subdocument the following:
3048 \begin_layout LyX-Code
3054 \begin_layout LyX-Code
3057 includecomment{comment}
3060 \begin_layout Standard
3062 \begin_inset Flex URL
3065 \begin_layout Plain Layout
3067 http://wiki.lyx.org/FAQ/Unsorted#toc31
3075 \begin_layout Section
3076 Fancy Headers and Footers
3079 \begin_layout Standard
3080 The default page layout is rather plain; for an
3081 \begin_inset Flex CharStyle:Code
3084 \begin_layout Plain Layout
3090 document class, all you get is a centered page number at the bottom of
3092 This document uses KOMA-script's book class, so it appears to be a bit
3094 But to really put on a show, you need to set the document page style to
3096 \begin_inset Quotes eld
3100 \begin_inset Quotes erd
3103 , as mentioned in the
3108 This section describes the LaTeX code you need to insert in your LaTeX
3109 preamble in order to get the desired effects.
3112 \begin_layout Standard
3113 The page header is divided into three fields, not surprisingly labeled
3114 \begin_inset Quotes eld
3118 \begin_inset Quotes erd
3122 \begin_inset Quotes eld
3126 \begin_inset Quotes erd
3130 \begin_inset Quotes eld
3134 \begin_inset Quotes erd
3138 The footer is also divided into these three fields.
3139 The LaTeX commands to set these fields in the simplest manner are
3140 \begin_inset Flex CharStyle:Code
3143 \begin_layout Plain Layout
3152 \begin_inset Flex CharStyle:Code
3155 \begin_layout Plain Layout
3164 \begin_inset Flex CharStyle:Code
3167 \begin_layout Plain Layout
3176 \begin_inset Flex CharStyle:Code
3179 \begin_layout Plain Layout
3188 Suppose you wish to put your name in the upper left hand corner of each
3190 Simply insert the following command in the preamble:
3193 \begin_layout Standard
3202 \begin_layout Standard
3203 You will now see your name in the upper left.
3204 If a field has a default entry that you would like to get rid of (often
3205 the page number appears in the central footer, simply include a command
3206 with a blank argument, e.
3207 \begin_inset space \thinspace{}
3213 \begin_layout Standard
3221 \begin_layout Standard
3222 Let's get really fancy: lets put the section number with the word
3223 \begin_inset Quotes eld
3227 \begin_inset Quotes erd
3231 \begin_inset space \thinspace{}
3235 \begin_inset space \space{}
3238 Section 3) in the upper left, the page number (e.
3239 \begin_inset space \thinspace{}
3243 \begin_inset space \space{}
3246 Page 4) in the upper right, your name in the lower left, and the date in
3248 The following commands should now appear in the preamble:
3251 \begin_layout Standard
3261 \begin_layout Standard
3269 \begin_layout Standard
3279 \begin_layout Standard
3288 \begin_layout Standard
3296 \begin_layout Standard
3306 \begin_layout Standard
3308 \begin_inset Flex CharStyle:Code
3311 \begin_layout Plain Layout
3320 \begin_inset Flex CharStyle:Code
3323 \begin_layout Plain Layout
3331 access LaTeX's section and page counters, and so print out the current
3332 section and page numbers.
3334 \begin_inset Flex CharStyle:Code
3337 \begin_layout Plain Layout
3345 simply prints out today's date.
3348 \begin_layout Standard
3349 The thicknesses of the horizontal rules drawn beneath the header and above
3350 the footer can also be modified.
3351 If you don't want one of the rules, set its thickness to 0.
3352 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3358 \begin_inset Flex CharStyle:Code
3361 \begin_layout Plain Layout
3366 headrulewidth}{0.4pt}
3372 \begin_inset Flex CharStyle:Code
3375 \begin_layout Plain Layout
3380 footrulewidth}{0.4pt}
3385 to set the thicknesses.
3388 \begin_layout Standard
3389 You can switch the header/footer settings on and off for individual pages
3391 \begin_inset Flex CharStyle:Code
3394 \begin_layout Plain Layout
3397 thispagestyle{empty}
3403 \begin_inset Flex CharStyle:Code
3406 \begin_layout Plain Layout
3409 thispagestyle{plain}
3415 \begin_inset Flex CharStyle:Code
3418 \begin_layout Plain Layout
3421 thispagestyle{fancy}
3427 Simply insert them in the text on the page you want changed and mark them
3429 In fact, title pages are marked as plain by default, while following pages
3430 are marked fancy when using the global fancy setting.
3433 \begin_layout Standard
3434 There are more complex commands which will let you insert things in the
3435 upper left on odd numbered pages, etc., but we will refer you to the
3436 \begin_inset Flex CharStyle:Code
3439 \begin_layout Plain Layout
3445 package documentation for more information.
3447 \begin_inset Flex CharStyle:Code
3450 \begin_layout Plain Layout
3459 \begin_layout Standard
3460 As a final example, it is possible to include an image in the header or
3462 Suppose you want to put a company logo in the upper lefthand corner.
3463 You might try something like
3466 \begin_layout Standard
3475 includegraphics{logo.eps}}}
3478 \begin_layout Standard
3480 (you may need to preface this with
3481 \begin_inset Flex CharStyle:Code
3484 \begin_layout Plain Layout
3488 usepackage{graphics}
3493 if you don't include graphics elsewhere in your document).
3496 \begin_layout Section
3497 Itemize Bullet Selection
3498 \begin_inset CommandInset label
3507 \begin_layout Standard
3513 \begin_layout Subsection
3517 \begin_layout Standard
3518 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3519 Using this dialog you can easily specify what bullet shape to use at each
3520 level of an itemized list.
3521 These settings are document-wide so you won't be able to specify different
3522 sets of bullets for different paragraphs.
3526 \begin_layout Plain Layout
3527 Well, actually you can but you'll have to do it by hand.
3535 \begin_layout Subsection
3539 \begin_layout Standard
3540 Open the dialog by selecting the
3541 \begin_inset Flex CharStyle:MenuItem
3544 \begin_layout Plain Layout
3545 Document\SpecialChar \menuseparator
3551 menu item and then select the
3552 \begin_inset Flex CharStyle:MenuItem
3555 \begin_layout Plain Layout
3564 \begin_layout Standard
3565 The dialog provides you with a table of bullet shapes.
3566 A column of buttons on the left of the table provides access to the six
3567 different panels of bullet shapes.
3568 The row of buttons across the top is used to select which bullet depth
3570 A text entry under the table shows the currently selected bullet shape's
3571 LaTeX equivalent and this can be edited if desired.
3572 If you do modify the text you will also need to specify any needed packages
3573 in the LaTeX preamble.
3576 \begin_layout Standard
3577 The six panels are divided up by the packages they require.
3578 The following table shows the mappings from button name to LaTeX packages.
3581 \begin_layout Standard
3583 \begin_inset Tabular
3584 <lyxtabular version="3" rows="7" columns="2">
3586 <column alignment="center" valignment="top" width="0pt">
3587 <column alignment="center" valignment="top" width="0pt">
3589 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3592 \begin_layout Plain Layout
3607 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3610 \begin_layout Plain Layout
3627 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3630 \begin_layout Plain Layout
3645 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3648 \begin_layout Plain Layout
3664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3667 \begin_layout Plain Layout
3682 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3685 \begin_layout Plain Layout
3702 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3705 \begin_layout Plain Layout
3720 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3723 \begin_layout Plain Layout
3740 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3743 \begin_layout Plain Layout
3758 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3761 \begin_layout Plain Layout
3778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3781 \begin_layout Plain Layout
3796 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3799 \begin_layout Plain Layout
3816 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3819 \begin_layout Plain Layout
3834 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3837 \begin_layout Plain Layout
3860 \begin_layout Standard
3861 LyX doesn't stop you using bullets from packages you don't have.
3862 If you get errors from LaTeX when you try to view or print the file, then
3863 it is likely you are missing a package.
3867 \begin_layout Plain Layout
3868 LyX doesn't restrict your use since you may be editing locally and exporting
3877 \begin_layout Subsection
3881 \begin_layout Standard
3882 Select which bullet depth you want to change then select the bullet shape
3884 Any changes will not be visible in LyX, but are visible when viewing the
3888 \begin_layout Standard
3889 You can reset a bullet shape to the default simply by clicking your right
3890 mouse button on the appropriate bullet depth button.
3894 \begin_layout Plain Layout
3899 want to have multiple sets of paragraphs with different sets of bullets
3900 in each, then you're going to have to get your hands dirty with ERT.
3901 The bullet selection dialog can help though because it provides you with
3902 the LaTeX code for a wide range of bullet shapes.
3903 To make your own custom paragraphs you have the following options:
3906 \begin_layout Plain Layout
3910 \begin_layout Plain Layout
3926 \begin_layout Plain Layout
3930 \begin_layout Plain Layout
3952 \begin_layout Itemize
3953 Use the LaTeX command
3954 \begin_inset Flex CharStyle:Code
3957 \begin_layout Plain Layout
3965 to specify a new bullet shape for a given depth.
3966 You'll also need to save the current bullet shape so you can restore it
3968 In this itemized list the following LaTeX code was used to change the bullet
3969 used for the first depth.
3973 \begin_layout LyX-Code
3983 \begin_layout LyX-Code
4000 \begin_layout Itemize
4001 Note that the itemize depth is specified in Roman numerals as part of the
4011 \begin_layout Itemize
4015 \begin_layout Plain Layout
4028 Specify each individual entry by starting each item with the bullet shape
4029 enclosed in square brackets and set as
4030 \begin_inset Flex CharStyle:MenuItem
4033 \begin_layout Plain Layout
4040 For example, this item was started with
4041 \begin_inset Flex CharStyle:Code
4044 \begin_layout Plain Layout
4059 \begin_layout Plain Layout
4063 \begin_layout Plain Layout
4079 \begin_layout Plain Layout
4080 You'll also need to revert the labelitem back to its previous setting for
4081 the global bullet shape settings to remain in effect.
4082 The way used here was:
4085 \begin_layout LyX-Code
4100 \begin_layout Chapter
4104 \begin_layout Section
4108 \begin_layout Standard
4109 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4110 and retrieve information about the LyX internal state.
4111 This is only intended for advanced users, but they should find it useful.
4112 It is by writing to the LyX server, for example, that bibliography managers,
4113 such as JabRef, are able to
4114 \begin_inset Quotes eld
4118 \begin_inset Quotes erd
4124 \begin_layout Standard
4125 Please note that, at present,
4127 the server does not work on Windows
4133 \begin_layout Plain Layout
4134 There is no reason it cannot do so.
4135 But none of the developers on Windows have yet implemented this functionality
4144 \begin_layout Section
4145 Starting the LyX Server
4148 \begin_layout Standard
4149 The LyX server works through the use of a pair of named pipes.
4150 These are usually located in
4151 \begin_inset Flex CharStyle:Code
4154 \begin_layout Plain Layout
4161 \begin_inset Quotes eld
4165 \begin_inset Flex CharStyle:Code
4168 \begin_layout Plain Layout
4175 \begin_inset Quotes erd
4179 \begin_inset Quotes eld
4183 \begin_inset Flex CharStyle:Code
4186 \begin_layout Plain Layout
4193 \begin_inset Quotes erd
4197 External programs write into
4198 \begin_inset Flex CharStyle:Code
4201 \begin_layout Plain Layout
4207 and read back data from
4208 \begin_inset Flex CharStyle:Code
4211 \begin_layout Plain Layout
4218 The stem of the pipe names can be defined in the
4219 \begin_inset Flex CharStyle:MenuItem
4222 \begin_layout Plain Layout
4227 ools\SpecialChar \menuseparator
4238 \begin_inset Flex CharStyle:Code
4241 \begin_layout Plain Layout
4242 "/home/myhome/lyxpipe"
4252 configure this manually in order for the server to start.
4255 \begin_layout Standard
4257 \begin_inset Flex CharStyle:Code
4260 \begin_layout Plain Layout
4267 \begin_inset Flex CharStyle:Code
4270 \begin_layout Plain Layout
4276 ' to create the pipes.
4277 If one of the pipes already exists, LyX will assume that another LyX process
4278 is already running and will not start the server.
4279 This means that if LyX crashes, or if for some other reason, a
4280 \begin_inset Quotes eld
4284 \begin_inset Quotes erd
4287 pipe is left in existence when LyX closes, then LyX will not start the
4289 (This is bug 641.) You will need to delete the pipes manually and then restart
4293 \begin_layout Standard
4294 To have several LyX processes with servers at the same time, you have to
4295 use different configurations, perhaps by using separate user directories,
4297 \begin_inset Flex CharStyle:Code
4300 \begin_layout Plain Layout
4306 file, for each process.
4309 \begin_layout Standard
4310 If you are developing a client program, you might find it useful to enable
4311 debugging information from the LyX server.
4312 Do this by starting LyX as
4313 \begin_inset Flex CharStyle:Code
4316 \begin_layout Plain Layout
4325 \begin_layout Standard
4326 Other than this, there are a few points to consider:
4329 \begin_layout Itemize
4330 Both server and clients must run on UNIX or OS/2 machines.
4331 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4332 not possible right now.
4335 \begin_layout Itemize
4336 On OS/2, only one client can connect to LyXServer at a time.
4339 \begin_layout Itemize
4340 On OS/2, clients must open the input pipe with
4341 \begin_inset Flex CharStyle:Code
4344 \begin_layout Plain Layout
4353 \begin_layout Standard
4354 You can find a complete example client written in C in the source distribution
4356 \begin_inset Flex CharStyle:Code
4359 \begin_layout Plain Layout
4360 development/lyxserver/server_monitor.c
4368 \begin_layout Section
4369 Normal communication
4372 \begin_layout Standard
4373 To issue a LyX call, the client writes a line of ASCII text into the input
4375 This line has the following format:
4392 \begin_layout Description
4393 clientname is a name that the client can choose arbitrarily.
4394 Its only use is that LyX will echo it if it sends an answer---so a client
4395 can dispatch results from different requesters.
4398 \begin_layout Description
4399 function is the function you want LyX to perform.
4400 It is the same as the commands you'd use in the minibuffer.
4403 \begin_layout Description
4404 argument is an optional argument which is meaningful only to some functions
4406 \begin_inset Quotes eld
4410 \begin_inset Quotes erd
4413 LFUN will insert the argument as text at the cursor position).
4416 \begin_layout Standard
4417 The answer from LyX will arrive in the output pipe and be of the form
4434 \begin_layout Standard
4443 are just echoed from the command request, while
4447 is more or less useful information filled according to how the command
4448 execution worked out.
4449 Some commands, such as
4450 \begin_inset Quotes eld
4454 \begin_inset Quotes erd
4457 , will return information about the internal state of LyX, while other will
4458 return an empty data-response.
4459 This means that the command execution went fine.
4462 \begin_layout Standard
4463 In case of errors, the response from LyX will have this form
4480 \begin_layout Standard
4485 should contain an explanation of why the command failed.
4488 \begin_layout Standard
4492 \begin_layout LyX-Code
4493 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4496 \begin_layout LyX-Code
4497 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4498 \begin_inset Newline newline
4501 read a <~/.lyxpipe.out
4502 \begin_inset Newline newline
4508 \begin_layout Section
4512 \begin_layout Standard
4513 LyX can notify clients of events going on asynchronously.
4514 Currently it will only do this if the user binds a key sequence with the
4516 \begin_inset Quotes eld
4520 \begin_inset Quotes erd
4524 The format of the string LyX sends is as follows:
4528 \begin_inset Flex CharStyle:Code
4531 \begin_layout Plain Layout
4542 \begin_layout Standard
4547 is the printed representation of the key sequence that was actually typed
4551 \begin_layout Standard
4552 This mechanism can be used to extend LyX's command set and implement macros.
4553 Bind some key sequence to
4554 \begin_inset Quotes eld
4558 \begin_inset Quotes erd
4562 Then start a client that listens on the output pipe, dispatches the command
4563 according to the sequence, and starts a function that may use LyX calls
4564 and LyX requests to issue a command or a series of commands to LyX.
4567 \begin_layout Section
4568 The simple LyX Server Protocol
4571 \begin_layout Standard
4572 LyX implements a simple protocol that can be used for session management.
4573 All messages are of the form
4586 \begin_layout Standard
4592 \begin_inset Quotes eld
4596 \begin_inset Quotes erd
4600 \begin_inset Quotes eld
4604 \begin_inset Quotes erd
4609 \begin_inset Quotes eld
4613 \begin_inset Quotes erd
4616 is received from a client, LyX will report back to inform the client that
4617 it's listening to it's messages, while
4618 \begin_inset Quotes eld
4622 \begin_inset Quotes erd
4625 sent from LyX will inform clients that LyX is closing.
4628 \begin_layout Chapter
4629 Special Document Classes
4632 \begin_layout Section
4636 \begin_layout Standard
4642 \begin_layout Subsection
4646 \begin_layout Standard
4647 This section describes how LyX can be used to write articles for submission
4648 to the scientific journal
4650 Astronomy and Astrophysics
4652 (www.edpsciences.fr/aa/
4653 \begin_inset Flex URL
4656 \begin_layout Plain Layout
4658 http://www.edpsciences.fr/aa/
4663 ) using Version 5.01 of the document class
4668 This package can be downloaded from the ftp site
4671 \begin_layout Standard
4672 \begin_inset VSpace medskip
4678 \begin_layout Standard
4680 \begin_inset Flex URL
4683 \begin_layout Plain Layout
4685 ftp://ftp.edpsciences.org/pub/aa/readme.html
4693 \begin_layout Standard
4694 \begin_inset VSpace medskip
4700 \begin_layout Standard
4701 A manual comes together with that package, and this text is not meant to
4702 replace the original manual but merely a short guide how to realize the
4703 correct form of your paper.
4707 \begin_layout Standard
4708 Please note that the publisher of the journal was changed from Springer
4709 to EDP Sciences starting January 1, 2001.
4710 That change implicated also some slight changes of the style files, namely
4711 the removal of the thesaurus command.
4712 The LyX class aa supports the newest version of these style files, V 5.01.
4713 If you have an older version installed, please upgrade.
4714 For compatibility, the old (version 4) layout has been kept as
4719 Please refer to the comments in
4721 LyXDir/layouts/aapaper.layout
4726 \begin_layout Subsection
4730 \begin_layout Standard
4731 It is recommended you start from the example template distributed with LyX.
4732 If you are not using a template, note the following settings:
4735 \begin_layout Itemize
4745 ocument\SpecialChar \menuseparator
4752 dialog (OK, that one was obvious).
4755 \begin_layout Itemize
4756 Don't change the option
4759 \begin_inset space ~
4769 The whole layout is done by the macros, you shouldn't change anything.
4772 \begin_layout Subsection
4776 \begin_layout Standard
4777 First thing to enter is the header information.
4778 It consists of seven entries, of which some are optional.
4782 \begin_layout Itemize
4790 \begin_layout Itemize
4798 \begin_layout Itemize
4806 \begin_layout Itemize
4814 \begin_layout Itemize
4819 : [optional] if more than one author: whom to contact for offprint requests.
4822 \begin_layout Itemize
4827 : [optional] mail address for contacts.
4830 \begin_layout Itemize
4838 Received: <date>; Accepted <date>
4841 \begin_layout Standard
4842 There is no need to issue the
4848 command, this is done automatically by LyX when the header is finished.
4849 Although the order of the single header entries doesn't matter it is advised
4850 to keep the above sequence, just to get the best optics and meets the layout
4851 of the real document.
4854 \begin_layout Standard
4855 If you want to place footnotes in the header block, e.
4856 \begin_inset space \thinspace{}
4860 \begin_inset space \space{}
4863 to state your present address, just use the standard footnote via the menu
4866 Insert\SpecialChar \menuseparator
4870 LyX will automagically use the term
4879 \begin_layout Standard
4880 In addition to these topics, the macros use three additional LaTeX commands
4881 that have no counterpart in LyX:
4884 \begin_layout Itemize
4891 to separate different names for more than one author and institute, respectivel
4895 \begin_layout Itemize
4902 to mark corresponding author/institute pairs.
4903 The institutes are numbered sequentially as they appear in the
4907 field, so you have to put a marker to each author.
4910 \begin_layout Itemize
4917 to supply an email address for fast contact.
4920 \begin_layout Standard
4921 In all cases, the appropriate command has to be entered in LyX and marked
4927 \begin_layout Subsection
4931 \begin_layout Standard
4932 The abstract should immediately follow the header block.
4933 With version 5 the abstract environment was changed to a command, and there
4934 is now a resctriction to only one paragraph.
4935 In addition, it should contain an entry with the keywords.
4936 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4943 by hand and mark it as LaTeX code.
4944 Refer to the example paper.
4947 \begin_layout Subsection
4948 Supported environments
4951 \begin_layout Standard
4952 The A&A paper layout supports the following environments for structuring
4956 \begin_layout Itemize
4962 \begin_layout Itemize
4968 \begin_layout Itemize
4974 \begin_layout Itemize
4980 \begin_layout Itemize
4986 \begin_layout Itemize
4992 \begin_layout Itemize
4998 \begin_layout Itemize
5004 \begin_layout Itemize
5010 \begin_layout Itemize
5016 \begin_layout Itemize
5022 \begin_layout Itemize
5028 \begin_layout Subsection
5029 Commands not supported by LyX
5032 \begin_layout Standard
5033 Some commands are not yet supported by the
5038 Some have already been mentioned.
5039 For the sake of completeness, they are listed all together here:
5042 \begin_layout Itemize
5050 \begin_layout Itemize
5058 \begin_layout Itemize
5066 \begin_layout Itemize
5074 \begin_layout Itemize
5082 \begin_layout Itemize
5090 \begin_layout Itemize
5098 \begin_layout Itemize
5106 \begin_layout Standard
5107 If you want to use any of these commands, you have to enter them yourself.
5110 Do not forget to mark them as LaTeX code!
5113 \begin_layout Subsection
5114 Figure and Table Floats
5117 \begin_layout Standard
5118 LyX provides support for the necessary float environments
5120 figure, figure*, table
5126 , therefore we won't tell much about it here.
5130 \begin_inset space ~
5136 Just remember that tables should be left-aligned.
5137 For that, select the table and change the alignment in
5142 dit\SpecialChar \menuseparator
5148 \begin_inset space ~
5154 \begin_layout Standard
5155 There is only one special thing: the figures with caption besides the figure.
5156 To create such a figure, you have to do the following:
5159 \begin_layout Enumerate
5160 Create a wide figure float:
5165 nsert\SpecialChar \menuseparator
5170 t\SpecialChar \menuseparator
5173 , then right click in the figure and select
5179 \begin_inset space ~
5187 \begin_layout Enumerate
5188 Enter your caption text.
5191 \begin_layout Enumerate
5196 to move the cursor above the caption.
5199 \begin_layout Enumerate
5203 \begin_layout Enumerate
5204 Position the cursor behind the figure and insert a horizontal fill:
5209 nsert\SpecialChar \menuseparator
5215 \begin_inset space ~
5220 \SpecialChar \menuseparator
5224 \begin_inset space ~
5232 \begin_layout Enumerate
5233 Switch to LaTeX mode:
5236 \begin_inset space ~
5244 \begin_layout Enumerate
5254 Do not close the brace!
5257 \begin_layout Enumerate
5258 Position the cursor behind the caption text, switch to LaTeX mode and insert
5262 \begin_inset space ~
5274 \begin_layout Standard
5275 Also, refer to the figures in the example paper.
5278 \begin_layout Subsection
5282 \begin_layout Standard
5283 For submission, the paper has to be formated in a special double-spacing
5285 For this purpose, you have to give the option
5289 to the documentclass.
5290 This must be done using the extra class options field in the
5292 Document\SpecialChar \menuseparator
5296 Just enter the string
5303 \begin_layout Subsection
5307 \begin_layout Standard
5312 directory contains an example paper written with LyX.
5313 It is the example paper from the original macro package, translated to
5315 Use it for inspiration, and compare the original LaTeX code with LyX way
5319 \begin_layout Section
5323 \begin_layout Standard
5329 \begin_layout Subsection
5333 \begin_layout Standard
5334 AASTeX is a set of macros produced by the American Astronomical Society
5335 to facilitate electronic manuscript submission to the three journals they
5336 publish: the Astrophysical Journal (including the Letters and Supplement),
5337 the Astronomical Journal, and the Publications of the Astronomical Society
5339 LyX has proven to be an excellent tool for generating these documents,
5340 especially given its equation, citation, and figure handling capabilities.
5341 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5342 is the version described here, or higher.
5343 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5344 incompatible with LyX.
5345 The AASTeX package may be downloaded from the AASTeX Web site
5348 \begin_layout Standard
5349 \begin_inset VSpace medskip
5355 \begin_layout Standard
5357 \begin_inset Flex URL
5360 \begin_layout Plain Layout
5362 http://www.journals.uchicago.edu/AAS/AASTeX
5370 \begin_layout Standard
5371 \begin_inset VSpace medskip
5377 \begin_layout Standard
5378 A complete user guide is contained in that package and you should familiarize
5379 yourself with it thoroughly before embarking on writing a paper in LyX.
5380 LyX will not reduce the need to figure out all the AASTeX commands, it
5381 will only reduce the drudgery of typing everything in.
5382 It is your responsibility to ensure that the final exported LaTeX document
5383 conforms completely to the requirements of the journal to which you are
5384 submitting your paper.
5387 \begin_layout Subsection
5388 Starting a New Paper
5391 \begin_layout Standard
5392 I strongly suggest that you start with the AASTeX template file.
5398 ile\SpecialChar \menuseparator
5408 , enter the new file name, then choose the
5413 This will show the most common fields found in a manuscript.
5414 Simply overwrite the existing text (including the brackets,
5418 ) with the correct information.
5419 Many of the AASTeX commands and environments can be implemented directly
5420 in LyX, but some cannot: most noticeably
5432 , which should stick out like a sore thumb if you actually just opened the
5434 For commands such as these, the LaTeX code must be entered directly and
5436 Such commands are referred to as ERT, or Evil Red Text.
5437 I tried to minimize the amount of ERT needed in an AASTeX document, but
5438 there is still a bit more required than any of us would like.
5441 \begin_layout Subsection
5442 Finishing Your Paper
5445 \begin_layout Standard
5446 When the paper is finished to your satisfaction and previews/prints correctly,
5448 \begin_inset Quotes eld
5452 \begin_inset Quotes erd
5455 actions which need to be done before you submit it to the journals.
5459 \begin_layout Enumerate
5460 Export your paper as a LaTeX file (
5465 ile\SpecialChar \menuseparator
5470 xport\SpecialChar \menuseparator
5481 \begin_layout Enumerate
5486 file with your favorite text editor
5490 \begin_layout Enumerate
5491 remove the comment lines before the
5500 \begin_layout Enumerate
5505 usepackage...{fontenc}
5507 line if it appears (usually just after
5522 \begin_layout Enumerate
5523 remove everything between (and including) the
5535 commands, except for any commands you specifically put into the LaTeX preamble
5536 (which should appear immediately after the
5537 \begin_inset Quotes eld
5540 User specified LaTeX commands
5541 \begin_inset Quotes erd
5552 \begin_layout Enumerate
5553 Run the resulting file through LaTeX to make sure it still processes correctly.
5556 \begin_layout Enumerate
5557 Reread the journal requirements to make sure your filenames and formats
5561 \begin_layout Enumerate
5565 \begin_layout Subsection
5566 Comments On Specific Commands
5569 \begin_layout Standard
5570 I will not describe the detailed usage of the individual AASTeX commands:
5571 the AASTeX User Guide (
5575 ) gives a good description of each.
5576 Thus it's probably easiest for me to go down the list as found in the guide
5577 and offer comments where necessary.
5578 So let's begin \SpecialChar \ldots{}
5582 \begin_layout Subsubsection
5583 Things that work as expected
5586 \begin_layout Standard
5590 \begin_layout Plain Layout
5602 \begin_layout Standard
5603 Because they work as you might expect, I simply list them and the section
5704 begin{thebibliography}
5712 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5713 graphicx figure commands (2.14.1),
5737 (2.15.4, amongst other places),
5764 \begin_layout Standard
5765 The following style options also work correctly:
5786 Simply put them in the
5792 Layout\SpecialChar \menuseparator
5798 \begin_layout Standard
5802 \begin_layout Plain Layout
5814 \begin_layout Subsubsection
5815 Things that work, but require more comment
5818 \begin_layout Standard
5819 The following items work, but require a little more discussion:
5822 \begin_layout Itemize
5823 These items are reserved for use by the journal editors, but you can put
5824 them into the LaTeX preamble if you feel compelled to do so:
5857 \begin_layout Itemize
5858 These items may be placed in the LaTeX preamble, and are included as blanks
5859 in the template file:
5880 \begin_layout Itemize
5887 (2.3) -- can only be used
5888 \begin_inset Quotes eld
5892 \begin_inset Quotes erd
5895 , not in the middle of a paragraph.
5896 Use ERT if you need to embed it.
5899 \begin_layout Itemize
5906 (2.3) -- will have extra {} after it.
5907 This should not cause an error.
5910 \begin_layout Itemize
5917 (2.6) -- can only be used
5918 \begin_inset Quotes eld
5922 \begin_inset Quotes erd
5925 , not in the middle of a paragraph.
5926 Use ERT if you need to embed it.
5929 \begin_layout Itemize
5936 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5940 \begin_layout Itemize
5947 (2.8) -- same as for
5954 \begin_layout Itemize
5961 (2.9) -- will have extra {} after it.
5962 This should not cause an error.
5965 \begin_layout Itemize
5972 (2.11) -- will have extra {} after it.
5973 This should not cause an error.
5976 \begin_layout Itemize
5983 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5984 at the beginning of the text and selecting
5986 Insert\SpecialChar \menuseparator
5991 \begin_inset Quotes eld
5995 \begin_inset Quotes erd
5998 inserts an optional argument of the type needed by
6005 Hopefully it will be renamed someday.
6008 \begin_layout Itemize
6021 for the catalog ID optional parameter
6024 \begin_layout Itemize
6037 for the catalog ID optional parameter
6040 \begin_layout Subsubsection
6041 Things not implemented, use ERT
6044 \begin_layout Standard
6048 \begin_layout Plain Layout
6060 \begin_layout Standard
6083 setcounter{equation}
6085 (2.12), Journal name abbreviations (2.13.4),
6121 (2.15.4, insert it as the first element in the lefthand cell after where
6123 Don't use any of LyX's rules in the table),
6135 (2.15.5), much of Misc (2.17, except
6186 \begin_layout Standard
6190 \begin_layout Plain Layout
6202 \begin_layout Subsubsection
6203 Things that cannot be implemented
6206 \begin_layout Standard
6207 \SpecialChar \ldots{}
6208 at least in any meaningful sort of way, so I suggest ignoring them.
6209 They are the references environment (2.13.3), and the deluxetable environment
6211 If you really, really need to use deluxetable, I suggest editing it in
6212 a separate file with a text editor, then using
6217 nsert\SpecialChar \menuseparator
6223 \begin_inset space ~
6228 to include it in your LyX document.
6233 file to see an example of this.
6236 \begin_layout Subsection
6237 FAQs, Tips, Tricks, and Other Ruminations
6240 \begin_layout Subsubsection
6241 Getting LyX and AASTeX to cooperate
6244 \begin_layout Standard
6245 It can be a bit tricky to get LyX to recognize a new layout and document
6247 When all else fails, do this:
6250 \begin_layout Enumerate
6251 Make certain that LaTeX can find AASTeX.
6252 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6253 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6260 \begin_layout Enumerate
6272 \begin_layout Enumerate
6278 ools\SpecialChar \menuseparator
6285 in LyX, then restart LyX.
6288 \begin_layout Enumerate
6289 Open a regular new file, not from a template.
6290 Does AASTeX appear in the class list in
6295 ocument\SpecialChar \menuseparator
6305 \begin_layout Standard
6306 If you get a warning from an existing AASTeX document about not being able
6307 to find the AASTeX layout or a message about
6308 \begin_inset Quotes eld
6311 You should not mix title layouts with normal ones
6312 \begin_inset Quotes erd
6315 , things haven't been installed correctly.
6318 \begin_layout Subsubsection
6319 LaTeX error processing a table
6322 \begin_layout Standard
6323 LyX, by default, attempts to center the table caption/title.
6324 This seems to produce a bad interaction in AASTeX so you should click somewhere
6325 in the caption/title, then select
6330 dit\SpecialChar \menuseparator
6336 \begin_inset space ~
6353 This took care of it for me.
6356 \begin_layout Subsubsection
6360 \begin_layout Standard
6361 A couple of things: 1) I have noticed some funny spacing in the reference
6362 entries in the text.
6363 When you enter the bibliography item data, make sure their is
6367 space between the last author and the parenthesis setting off the year;
6371 \begin_inset space \thinspace{}
6375 \begin_inset space \space{}
6389 2) Entering the references at all is not obvious.
6390 The easiest thing is to start typing your first reference at the end of
6391 the document, then mark it as type
6396 That will put a small gray box in front of what you just typed.
6397 Click on the box to fill in the rest of the information.
6398 For new references, go to the end of an existing reference and press return.
6399 That will create a new line with its own box, etc.
6402 \begin_layout Subsubsection
6406 \begin_layout Standard
6407 Even though AASTeX provides its own figure commands (
6413 , for example), I much prefer LaTeX's standard figure commands (with the
6422 \begin_inset space ~
6425 commands as ERT into a Figure Float box if you desire, but I never have
6426 much luck getting the layout right.
6427 With the standard graphics, LyX will insert a
6431 usepackage{graphicx}
6433 command into the LaTeX preamble and handle the figures in the standard
6434 LaTeX2e way, interspersing the figures in the text.
6435 I believe ApJ accepts figures exactly this way now; AJ might still use
6437 \begin_inset Quotes eld
6440 stack everything at the end
6441 \begin_inset Quotes erd
6447 \begin_layout Subsubsection
6448 Things I could have done, but didn't
6451 \begin_layout Standard
6453 \begin_inset Quotes eld
6457 \begin_inset Quotes erd
6460 things I could have implemented, but chose not to.
6461 For instance, I saw no point in double-spacing the text in the LyX window,
6462 even though it is double-spaced in the paper manuscript.
6463 Also, I chose not to make separate layouts for the preprint and preprint2
6465 Since I assume you will spend most of your time in the plain manuscript
6466 mode anyway, I decided not to chew up more disk space with this.
6470 \begin_layout Subsection
6474 \begin_layout Standard
6475 Your mileage may vary.
6476 I've now had papers published by both ApJ and AJ that have had 98% of the
6477 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6479 I have had no trouble with the submission process, and I'm sure the journals
6480 were never aware that there might be a difference.
6481 So, go forth and publish!
6484 \begin_layout Section
6488 \begin_layout Standard
6491 David Johnson; updated by Richard Heck
6494 \begin_layout Standard
6495 \begin_inset VSpace bigskip
6501 \begin_layout Standard
6503 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6504 papers to be submitted to American Mathematical Society publications.
6505 The layouts are not tailored to a specific journal, but easily can be.
6506 You should refer to the AMS documentation for specific instructions for
6507 each journal (usually it will entail only changing a single line in the
6509 That documentation is available on the Web at
6510 \begin_inset Flex URL
6513 \begin_layout Plain Layout
6521 \begin_inset Flex URL
6524 \begin_layout Plain Layout
6526 ftp://ftp.ams.org/pub/tex/amslatex/
6532 These layouts are appropriate, and useful, for any mathematical writing.
6536 \begin_layout Standard
6537 There are two basic AMS LaTeX layouts:
6540 \begin_layout Itemize
6541 amsart: The standard AMS article format.
6544 \begin_layout Itemize
6545 amsbook: the standard AMS book (really, monograph) format.
6549 \begin_layout Standard
6550 The layouts themselves contain only the minimum necessary to use the AMS
6552 They do not, in particular, contain any of the `theorem' environments used
6553 for setting theorems, lemmas, and the like.
6554 These are contained, instead, in the
6555 \begin_inset Flex CharStyle:Code
6558 \begin_layout Plain Layout
6564 module, which is loaded by default when when you select one of the AMS
6566 (It can also be used with other classes and can be removed, if you would
6567 rather use something else.) Less commonly used environments are in the
6568 \begin_inset Flex CharStyle:Code
6571 \begin_layout Plain Layout
6572 Theorems (AMS-Extended)
6577 module, which must be loaded manually.
6580 \begin_layout Standard
6581 By default, theorems and the like are numbered consecutively throughout
6582 the document, but this may be modified by loading the module
6583 \begin_inset Flex CharStyle:Code
6586 \begin_layout Plain Layout
6587 Theorems (Order by Section)
6592 or, if you are using
6593 \begin_inset Flex CharStyle:Code
6596 \begin_layout Plain Layout
6603 \begin_inset Flex CharStyle:Code
6606 \begin_layout Plain Layout
6607 Theorems (Order by Chapter)
6613 These will number the results as
6614 \begin_inset Formula $n.m$
6617 , where the first number refers to the section (or chapter) and the second
6618 refers to the total number of results so far in that section (or chapter).
6619 Many environments are also available unnumbered.
6620 These are indicated by an asterisk at the end.
6621 If you happen to want
6625 unnumbered results, the the module
6626 \begin_inset Flex CharStyle:Code
6629 \begin_layout Plain Layout
6635 provides that option.
6638 \begin_layout Standard
6639 Note that these modules do not
6643 to be used with the AMS classes.
6644 It is perfectly possible to use the
6645 \begin_inset Flex CharStyle:Code
6648 \begin_layout Plain Layout
6654 module, and the others mentioned, with other classes, such as
6655 \begin_inset Flex CharStyle:Code
6658 \begin_layout Plain Layout
6665 \begin_inset Flex CharStyle:Code
6668 \begin_layout Plain Layout
6675 \begin_inset Flex CharStyle:Code
6678 \begin_layout Plain Layout
6687 \begin_layout Subsection
6688 What these layouts provide
6691 \begin_layout Standard
6692 There is a long list of included environments provided by these layouts.
6693 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6694 variety of `theorem' environments.
6695 However, the AMS recommends the environments that are available in LyX.
6699 \begin_layout Standard
6700 The following environments---as well as the standard environments, such
6702 \begin_inset Flex CharStyle:Noun
6705 \begin_layout Plain Layout
6712 \begin_inset Flex CharStyle:Noun
6715 \begin_layout Plain Layout
6722 \begin_inset Flex CharStyle:Noun
6725 \begin_layout Plain Layout
6732 \begin_inset Flex CharStyle:Noun
6735 \begin_layout Plain Layout
6742 \begin_inset Flex CharStyle:Noun
6745 \begin_layout Plain Layout
6752 \begin_inset Flex CharStyle:Code
6755 \begin_layout Plain Layout
6762 \begin_inset Flex CharStyle:Code
6765 \begin_layout Plain Layout
6774 \begin_layout Description
6775 Address This should be the author's permanent address.
6778 \begin_layout Description
6780 \begin_inset space ~
6783 Address This should be the author's temporary address at the time of submission,
6784 if different from the Address.
6787 \begin_layout Description
6788 Email Author's e-mail address
6791 \begin_layout Description
6792 URL Author's Web address, if desired.
6795 \begin_layout Description
6796 Keywords Key words or phrases used to identify specific topics discussed
6800 \begin_layout Description
6801 Subjectclass These refer to the AMS Subject Classifications, published and
6804 Mathematical Reviews
6807 These are also available online at the AMS cites listed above.
6810 \begin_layout Description
6814 \begin_layout Description
6818 \begin_layout Description
6822 \begin_layout Standard
6823 The following environments are provided by both the
6824 \begin_inset Flex CharStyle:Code
6827 \begin_layout Plain Layout
6834 \begin_inset Flex CharStyle:Code
6837 \begin_layout Plain Layout
6843 modules, in the latter case in both starred (unnumbered) and unstarred
6844 (numbered) versions.
6845 These same environments are provided only in the starred versions by the
6847 \begin_inset Flex CharStyle:Code
6850 \begin_layout Plain Layout
6859 \begin_layout Theorem
6860 This is typically used for the statements of major results.
6864 \begin_layout Corollary*
6865 This is used for statements which follow fairly directly from previous statement
6867 Again, these can be major results.
6872 These are smaller results needed to prove other statements.
6875 \begin_layout Proposition
6876 These are less major results which (hopefully) add to the general theory
6880 \begin_layout Conjecture
6881 These are statements provided without justification, which the author does
6882 not know how to prove, but which seem to be true (to the author, at least).
6885 \begin_layout Definition*
6886 Guess what this is for.
6887 The font is different for this environment than for the previous ones.
6891 \begin_layout Example*
6892 Used for examples illustrating proven results.
6895 \begin_layout Problem
6896 It's not really known what this is for.
6897 You should figure it out.
6900 \begin_layout Exercise*
6901 Write a description for this one.
6904 \begin_layout Remark
6905 This environment is also a type of theorem, usually a lesser sort of observation.
6908 \begin_layout Claim*
6909 Often used in the course of giving a proof of a larger result.
6913 Generally, these are used to break up long arguments, using specific instances
6919 The numbering scheme for cases is on its own, not together with other numbered
6925 At the end of this environment, a QED symbol (usually a square, but it can
6926 vary with different styles) is placed.
6927 If you want to have other environments within this one---for example, Case
6928 environments---and have the QED symbol appear only after them, then the
6929 other environments need to be nested within the proof environment.
6932 Nesting Environments
6938 for information on nesting.
6941 \begin_layout Standard
6942 And these environments are provided by
6943 \begin_inset Flex CharStyle:Code
6946 \begin_layout Plain Layout
6947 Theorems (AMS-Extended)
6955 \begin_layout Criterion*
6956 A required condition.
6959 \begin_layout Algorithm*
6960 A general procedure to be used.
6963 \begin_layout Axiom*
6964 This is a property or statement taken as true within the system being discussed.
6967 \begin_layout Condition*
6968 Sometimes used to state a condition assumed within the present context of
6973 Similar to a Remark.
6976 \begin_layout Notation*
6977 Used for the explanation of, yes, notation.
6980 \begin_layout Summary
6981 Do we really need to tell you?
6984 \begin_layout Acknowledgement*
6988 \begin_layout Conclusion*
6989 Sometimes used at the end of a long train of argument.
6993 Used in a way similar to Proposition, though perhaps lower on the scale.
6996 \begin_layout Standard
6997 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6999 They need to be available on your system in order to use these environments.
7002 \begin_layout Section
7010 \begin_layout Standard
7016 \begin_layout Subsection
7020 \begin_layout Standard
7021 These are the layout files for some of the journals of the American Geophysical
7023 It is assumed that you have both the AGU's own class files and AGUplus
7024 installed (everything to be found at
7025 \begin_inset Flex URL
7028 \begin_layout Plain Layout
7030 ftp://ftp.agu.org/journals/latex/journals
7038 \begin_layout Subsection
7042 \begin_layout Standard
7052 They are still called this in the LyX GUI, though their LaTeX equivalents
7053 in the AGU classes are
7064 \begin_layout Standard
7065 Newly defined styles are
7102 These are mostly manuscript attributes and defined in the AGU class documentati
7106 \begin_layout Standard
7107 I suspect this is still badly incomplete.
7110 \begin_layout Subsection
7114 \begin_layout Standard
7131 \begin_layout Subsection
7135 \begin_layout Itemize
7138 Journal of Geophysical Research
7147 \begin_layout Standard
7148 Add your own, it isn't so hard! Look at the
7159 \begin_layout Subsection
7160 Bugs and things to remember
7163 \begin_layout Standard
7164 In order to use the new layouts, you must remember to do the following for
7168 \begin_layout Enumerate
7174 This can be done in the
7176 layout\SpecialChar \menuseparator
7181 document\SpecialChar \menuseparator
7185 (AGU articles are always in English, right? So
7192 \begin_layout Enumerate
7202 (Yes, this is a bug.)
7205 \begin_layout Enumerate
7206 Make sure you use the
7210 bibliography style, by entering
7214 into the second field of the BibTeX inset.
7215 None of the standard styles will do.
7218 \begin_layout Section
7222 \begin_layout Standard
7228 \begin_layout Subsection
7232 \begin_layout Standard
7233 Broadway is for writing plays.
7234 The format is more decorative than Hollywood, and much less standardized.
7235 This format should be suitable for workshops.
7238 \begin_layout Subsection
7242 \begin_layout Standard
7243 The same as in Hollywood.
7246 \begin_layout Subsection
7250 \begin_layout Standard
7255 names as labels then cross-reference the label to insert the name.
7256 The cross-reference dialog will show the current cast of characters.
7259 \begin_layout Subsection
7260 Paper size and Margins
7263 \begin_layout Standard
7264 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7267 \begin_layout Subsection
7271 \begin_layout Standard
7272 The following environments are available.
7273 You can use broadway.bind to get the bind keys shown at the right.
7276 \begin_layout Itemize
7280 \begin_inset Newline newline
7285 You should not have to use this, but it is here for anything that does not
7289 \begin_layout Itemize
7293 \begin_inset space \hfill{}
7297 \begin_inset Newline newline
7302 Used to describe stage setting and the action.
7303 First use of speaker names in all CAPs.
7306 \begin_layout Itemize
7310 \begin_inset space \hfill{}
7314 \begin_inset Newline newline
7319 Automatically numbered.
7320 On screen it will be arabic, but will print as Roman.
7323 \begin_layout Itemize
7327 \begin_inset space \hfill{}
7331 \begin_inset Newline newline
7341 It is just centered text.
7344 \begin_layout Itemize
7348 \begin_inset space \hfill{}
7352 \begin_inset Newline newline
7357 Not automatically numbered.
7358 You supply the number.
7359 This is because I couldn't figure out how.
7362 \begin_layout Itemize
7366 \begin_inset space \hfill{}
7370 \begin_inset Newline newline
7375 A special case of Narrative to describe the setting and action as the curtain
7379 \begin_layout Itemize
7383 \begin_inset space \hfill{}
7387 \begin_inset Newline newline
7392 The speaker's (actor's) title, centered in all CAPS.
7395 \begin_layout Itemize
7399 \begin_inset space \hfill{}
7403 \begin_inset Newline newline
7408 Instructions to the speaker.
7409 The parentheses are automatically inserted.
7410 The ( will appear on screen, but both will be in the printed play.
7411 This environment is only used within
7418 \begin_layout Itemize
7422 \begin_inset space \hfill{}
7426 \begin_inset Newline newline
7431 What the Speaker says.
7434 \begin_layout Itemize
7438 \begin_inset space \hfill{}
7442 \begin_inset Newline newline
7447 The curtain comes down.
7450 \begin_layout Itemize
7454 \begin_inset space \hfill{}
7460 \begin_layout Itemize
7464 \begin_inset space \hfill{}
7470 \begin_layout Itemize
7474 \begin_inset space \hfill{}
7480 \begin_layout Standard
7484 \begin_layout Section
7488 \begin_layout Standard
7493 can be used to type letters according to German conventions.
7494 A template file is included in
7496 .../lyx/share/templates
7498 for you to use as a starting point.
7501 \begin_layout Section
7509 \begin_layout Standard
7515 \begin_layout Subsection
7519 \begin_layout Standard
7520 This is the layout file for the European Geophysical Society journals.
7525 can be downloaded from the web site of the EGS under
7526 \begin_inset Flex URL
7529 \begin_layout Plain Layout
7539 \begin_layout Subsection
7543 \begin_layout Standard
7546 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7554 The current layout file is unfortunately very unmodular and would benefit
7555 from using the various
7562 \begin_layout Section
7566 \begin_layout Standard
7572 \begin_layout Standard
7573 Elsevier Science Publishers B.V.
7574 provides a standard LaTeX document class (
7578 ) for submitting articles to their various journals.
7579 The style file can be downloaded directly from their web site:
7580 \begin_inset Flex URL
7583 \begin_layout Plain Layout
7585 http://authors.elsevier.com/
7591 Instructions are supplied along with the class file, which details the
7592 requirements of the publishers.
7593 LyX includes package that allows for the use of this class, by a layout
7594 and a template file.
7595 Installation of the class file is the same as for any other LaTeX package;
7596 instructions are provided in the Elsevier documentation.
7599 \begin_layout Standard
7609 As the Elsevier class file is based mainly on the standard article class,
7610 most of the normal functionality is provided.
7611 The Elsevier class defines a number of mathematical environments, which
7612 are similar to the AMS environments.
7613 These commands are all described in the Elsevier documentation, and are
7617 \begin_layout Standard
7618 The easiest way to use the Elsevier style is to base documents on the included
7620 It is best not to use options such as fancy headings or the geometry package,
7621 as elements such as these are defined by Elsevier in their style file.
7622 Ideally, no extra packages except those mentioned in the Elsevier documentation
7624 Essentially, Elsevier require as
7625 \begin_inset Quotes eld
7629 \begin_inset Quotes erd
7632 a LaTeX file as possible, as their intention is to take the supplied file
7633 and replace the class file with one for the particular journal to which
7634 the paper has been submitted.
7635 This also means that not too much time should be spent on the formating
7637 When it comes to be published, this will change anyway.
7638 The rest of the usage for this layout is substantially the same as for
7639 the normal article class.
7640 For details of what Elsevier do and don't allow, refer to their documentation.
7643 \begin_layout Section
7652 \begin_inset CommandInset label
7661 \begin_layout Standard
7667 \begin_layout Subsection
7671 \begin_layout Standard
7672 This section describes how to use LyX to make slides for overhead projectors.
7673 There are two document classes that can do this: the default slides class
7679 This section documents the latter.
7682 \begin_layout Standard
7683 I'm going to say this again, nice and clear, so that there's no misunderstanding
7687 \begin_layout Standard
7688 \begin_inset VSpace bigskip
7694 \begin_layout Standard
7698 This section documents the class
7699 \begin_inset Quotes eld
7707 \begin_inset Quotes erd
7715 \begin_layout Standard
7716 \begin_inset VSpace bigskip
7722 \begin_layout Standard
7723 If you're looking for the documentation for
7724 \begin_inset Quotes eld
7732 \begin_inset Quotes erd
7736 \begin_inset space ~
7740 \begin_inset CommandInset ref
7742 reference "sec:slitex"
7747 If your machine doesn't have the
7752 \begin_inset Quotes eld
7760 \begin_inset Quotes erd
7763 ] installed, you'll probably have to use the default
7767 class, which isn't quite as good as
7772 \begin_layout Standard
7777 class is designed for use with version 2.1 of the
7781 LaTeX class file which is now an integral part of LaTeX2e.
7784 \begin_layout Subsection
7788 \begin_layout Standard
7789 Obviously, to use this document class, you need to select
7790 \begin_inset Quotes eld
7798 \begin_inset Quotes erd
7808 \begin_inset space ~
7814 There are some settings in the
7817 \begin_inset space ~
7822 dialog that you should know about that are specific to this class:
7825 \begin_layout Itemize
7826 Don't change the options
7837 \begin_inset space ~
7843 They're ignored by the
7850 \begin_layout Itemize
7851 The default font size is 20
7852 \begin_inset space \thinspace{}
7855 pt with the other options being 17
7856 \begin_inset space \thinspace{}
7860 \begin_inset space \thinspace{}
7864 \begin_inset space \thinspace{}
7870 \begin_layout Itemize
7879 but all math equations are still typeset in the usual roman font.
7882 \begin_layout Itemize
7887 TeX supports A4 and Letter paper sizes as well as a special size for working
7889 \begin_inset space \thinspace{}
7893 It doesn't support A5, B5, legal or executive paper sizes.
7896 \begin_layout Itemize
7897 Don't bother changing the
7901 settings because they are ignored anyway.
7902 All floats appear where they are defined in the text.
7905 \begin_layout Itemize
7910 setting behaves a bit differently for this class.
7915 TeX provides extensive footer and header capabilities including a user-defined
7918 \begin_inset space ~
7922 \begin_inset CommandInset ref
7924 reference "sec:foilfoot"
7929 The title page is treated differently to all other pages in the document
7938 has the logo centered at the bottom of the page (if one is defined).
7939 The possible page style choices and what they do are as follows:
7943 \begin_layout Labeling
7944 \labelwidthstring MMMMMMM
7951 The final output contains no page numbers, or other headers or footers
7952 (except footnotes of course).
7956 \begin_layout Labeling
7957 \labelwidthstring MMMMMMM
7964 The final output contains page numbers centered at the bottom of the page.
7965 No other headings or footers (other than footnotes).
7968 \begin_layout Labeling
7969 \labelwidthstring MMMMMMM
7974 Page numbers in lower right corner.
7975 Additional headers and footers are also shown.
7976 This is also the default.
7979 \begin_layout Labeling
7980 \labelwidthstring MMMMMMM
7985 Gives you access to the
7989 package although its use with
7993 TeX is discouraged by the writer of the
7997 TeX package because of some potential page layout clashes.
8001 \begin_layout Subsubsection
8005 \begin_layout Standard
8006 The following options may be used in the extra class options in the
8008 Document\SpecialChar \menuseparator
8014 \begin_layout Labeling
8015 \labelwidthstring MMMMMMx
8020 This sets up the page layout for 7.33
8021 \begin_inset space \thinspace{}
8025 \begin_inset space \thinspace{}
8028 in paper, which is about the same aspect ratio as a 35
8029 \begin_inset space \thinspace{}
8032 mm slide, making it a bit easier to work with this medium.
8035 \begin_layout Labeling
8036 \labelwidthstring MMMMMMx
8041 Places a rule across the page below the header on every page except the
8045 \begin_layout Labeling
8046 \labelwidthstring MMMMMMx
8051 Places a rule across the page above the footer on every page except the
8055 \begin_layout Labeling
8056 \labelwidthstring MMMMMMx
8061 This is automatically set each time you create a new
8070 TeX to use the dvips driver to rotate those pages that are set as landscape
8074 \begin_layout Labeling
8075 \labelwidthstring MMMMMMx
8080 Simply changes the page dimensions to those of a landscape page but doesn't
8082 Thus if you use this option you need to use an external program to rotate
8083 each page or feed your paper through your printer as landscape.
8084 Note that this option effectively reverses the roles of the
8092 environments (don't worry these are described in the next section).
8095 \begin_layout Labeling
8096 \labelwidthstring MMMMMMx
8101 Equation numbers on the left.
8104 \begin_layout Labeling
8105 \labelwidthstring MMMMMMx
8110 Flush-left equations.
8113 \begin_layout Subsection
8114 Supported Environments
8117 \begin_layout Standard
8118 Most of the environments commonly supported in other classes are also supported
8124 There are several additional environments provided by
8128 TeX as well as a couple added by LyX.
8129 The following environments are shared with other classes:
8132 \begin_layout Standard
8136 \begin_layout Plain Layout
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 Itemize
8214 \begin_layout Itemize
8220 \begin_layout Itemize
8226 \begin_layout Itemize
8232 \begin_layout Itemize
8238 \begin_layout Itemize
8244 \begin_layout Itemize
8250 \begin_layout Itemize
8256 \begin_layout Standard
8260 \begin_layout Plain Layout
8272 \begin_layout Standard
8273 That is, all the major environments apart from the sectioning environments.
8274 Since foils are essentially self-contained sections, with a title and body,
8279 TeX provides specific commands for starting new foils and these are:
8282 \begin_layout Itemize
8288 \begin_layout Itemize
8294 \begin_layout Standard
8295 LyX also provides slightly modified versions of these two environments called:
8298 \begin_layout Itemize
8304 \begin_layout Itemize
8310 \begin_layout Standard
8311 and the differences will be explained in the next section.
8314 \begin_layout Standard
8315 Since foils are often used in presenting ideas or new theorems and such
8320 TeX also provides a comprehensive box of goodies for presenting them:
8323 \begin_layout Standard
8327 \begin_layout Plain Layout
8339 \begin_layout Itemize
8345 \begin_layout Itemize
8351 \begin_layout Itemize
8357 \begin_layout Itemize
8363 \begin_layout Itemize
8369 \begin_layout Itemize
8375 \begin_layout Itemize
8381 \begin_layout Itemize
8387 \begin_layout Itemize
8393 \begin_layout Itemize
8399 \begin_layout Itemize
8405 \begin_layout Standard
8409 \begin_layout Plain Layout
8421 \begin_layout Standard
8422 The starred versions are unnumbered while the unstarred versions are numbered.
8423 There are also two list environments added by LyX and these are:
8426 \begin_layout Itemize
8432 \begin_layout Itemize
8438 \begin_layout Standard
8443 TeX provides some powerful header and footer capabilities that are best
8444 set in the preamble although they may be set at any point in a document.
8445 If you want to change these settings in your document the best place to
8446 do so is at the very top of a foil, i.
8447 \begin_inset space \thinspace{}
8453 \begin_inset space \space{}
8458 straight after the foilhead.
8461 \begin_layout Standard
8462 For this purpose, the following command styles are provided [
8469 \begin_layout Standard
8473 \begin_layout Plain Layout
8485 \begin_layout Itemize
8489 \begin_inset space ~
8495 \begin_layout Itemize
8501 \begin_layout Itemize
8505 \begin_inset space ~
8511 \begin_layout Itemize
8515 \begin_inset space ~
8521 \begin_layout Itemize
8525 \begin_inset space ~
8532 \begin_layout Standard
8533 \begin_inset space ~
8540 \begin_layout Standard
8544 \begin_layout Plain Layout
8556 \begin_layout Standard
8557 There are also a few commands provided by
8561 TeX that aren't directly supported by LyX but I'll tell you what they do
8562 and how to use them in section
8563 \begin_inset space ~
8567 \begin_inset CommandInset ref
8569 reference "sec:unsuppfoils"
8576 \begin_layout Subsection
8577 Building a Set of Foils
8580 \begin_layout Standard
8581 This section will give a simple introduction to using the different environments
8582 to build a set of foils.
8583 If you want to see an example set of foils, take a look at the
8587 file you find in LyX's
8594 \begin_layout Subsubsection
8595 Give It a Title Page
8598 \begin_layout Standard
8599 Unlike other classes that provide
8619 creates the title on a page of its own.
8620 If you leave out the
8624 environment LaTeX will substitute the current date (every time you regenerate
8628 \begin_layout Subsubsection
8632 \begin_layout Standard
8633 As I mentioned earlier, there are four ways of starting a new foil.
8634 For portrait foils you should use
8643 The difference between these two environments is the amount of space between
8644 the title of the foil (the foilhead) and the body of the foil.
8647 \begin_layout Standard
8648 Landscape foils are generated using the
8657 Again the only difference is the spacing between foilhead and body.
8658 Both of the short versions have 0.5 inches less separation between the foilhead
8663 \begin_layout Standard
8664 One problem with the support for landscape foils is the requirement that
8669 driver to generate the PostScript output otherwise the foils won't be rotated.
8670 It is possible to get landscape foils even if you haven't got the
8674 driver provided you can feed your foils sideways through your printer ;-)
8677 \begin_layout Subsubsection
8678 Theorems, Lemmas, Proofs and more
8681 \begin_layout Standard
8682 Due to a small bug in LyX you can't have two of the same type of these environme
8683 nts directly following each other.
8684 They must be separated by something.
8685 If you try, you will just be extending the previous environment as if you
8686 had merged the two environments together.
8687 So, how do you get around this problem? The simplest option is to insert
8688 some text between the two environments or add a
8692 environment between the two with just a
8693 \begin_inset Quotes eld
8701 \begin_inset Quotes erd
8705 This will force LyX to produce two separate environments and hence the
8706 correct LaTeX output.
8707 An example is provided in the example file included with the LyX distribution.
8708 Remember, this problem only occurs if you are trying to place two of the
8709 same type of theorem-like environments one directly after the other.
8712 \begin_layout Subsubsection
8716 \begin_layout Standard
8717 You get all the commonly supported list styles found in other classes as
8718 well as two new ones.
8719 I'll only describe the new ones here.
8720 If you want to find out more about the other list environments check out
8726 If you intend to use itemized lists you might also want to read about the
8730 \begin_inset space ~
8734 \begin_inset space ~
8739 dialog described above in section
8740 \begin_inset space ~
8744 \begin_inset CommandInset ref
8746 reference "sec:bullet"
8753 \begin_layout Standard
8754 The two new list styles,
8762 , are designed to make it easier for you to create lists of do's and don'ts
8763 or right and wrong by providing dedicated environments that use a tick
8764 or a cross as the label of the list.
8765 These lists are in fact dedicated variants of the
8770 They do however require that you have the
8777 \begin_layout Subsubsection
8781 \begin_layout Standard
8786 TeX redefines the floating tables and figures so that they appear exactly
8787 where they are in the text rather than pushing them to the top of the page
8788 or to some user specified location.
8789 In fact if you change the float placement settings they are simply ignored.
8792 \begin_layout Subsubsection
8793 Page Headers and Footers
8794 \begin_inset CommandInset label
8803 \begin_layout Standard
8807 \begin_inset space ~
8816 are two commands used to control the left-footer text string.
8817 The first is meant to allow you to include a graphic logo on your foils
8819 \begin_inset Quotes eld
8827 \begin_inset Quotes erd
8831 While the second is meant to provide a classification for the audience,
8835 \begin_inset space \thinspace{}
8841 \begin_inset space \space{}
8845 It is empty by default.
8848 \begin_layout Standard
8849 The remaining page corners can be filled by
8852 \begin_inset space ~
8857 (which defaults to page numbers),
8860 \begin_inset space ~
8868 \begin_inset space ~
8876 \begin_layout Subsection
8882 \begin_inset CommandInset label
8884 name "sec:unsuppfoils"
8891 \begin_layout Standard
8892 All the commands mentioned below need to be set in a
8900 within another environment.
8903 \begin_layout Subsubsection
8907 \begin_layout Standard
8908 All lengths are adjusted using the
8931 should be replaced by the name given to the length you want to change and
8936 is the length value.
8937 All lengths should be specified in units of length such as inches (
8949 ) or relative to some document or font-based length such as
8959 \begin_layout Standard
8960 It's possible to change the spacing between a foilhead and the body of the
8961 foil by adjusting the length specified by
8968 For example, to make
8973 \begin_inset space \space{}
8976 in closer to their bodies put the following in the preamble:
8982 foilheadskip}{-0.5in}
8985 \begin_layout Standard
8986 The spacings around floats can be adjusted by setting these lengths:
8989 \begin_layout Labeling
8990 \labelwidthstring MMMMMMMMMMM
8997 Separation between the text and the top of the float
9000 \begin_layout Labeling
9001 \labelwidthstring MMMMMMMMMMM
9008 Separation between the float and the caption
9011 \begin_layout Labeling
9012 \labelwidthstring MMMMMMMMMMM
9019 Separation between the caption and the following text
9022 \begin_layout Labeling
9023 \labelwidthstring MMMMMMMMMMM
9030 You can make the captions narrower than the surrounding text by adjusting
9032 Best done relative to
9041 \begin_layout Standard
9042 There are also several title page related lengths that you may find useful
9043 if you have a long title or several authors:
9046 \begin_layout Labeling
9047 \labelwidthstring MMMMMMMMMMM
9054 Separation from headers to
9059 \begin_layout Labeling
9060 \labelwidthstring MMMMMMMMMMM
9078 \begin_layout Labeling
9079 \labelwidthstring MMMMMMMMMMM
9093 \begin_layout Labeling
9094 \labelwidthstring MMMMMMMMMMM
9110 \begin_layout Labeling
9111 \labelwidthstring MMMMMMMMMMM
9127 \begin_layout Standard
9128 The last length related command affects all the list environments.
9139 a list environment then all the vertical spacing between the list items
9141 Note that this is a command not a length so it doesn't require
9147 like the stuff mentioned above.
9150 \begin_layout Subsubsection
9154 \begin_layout Standard
9167 commands control whether the logo in the
9171 definition appear on a given page.
9178 in the preamble then none of the foils will have the logo on them.
9179 If you don't want the logo on a particular page place the
9185 directly after the foilhead of that page and the
9191 directly after the next foilhead.
9194 \begin_layout Standard
9195 If you decide to use the
9199 page style setting in the
9202 \begin_inset space ~
9207 dialog you should probably add
9217 to your preamble so headers and footers on landscape pages are correctly
9218 placed when rotated.
9219 This is due to some clashes between the page layouts provided by the
9230 \begin_layout Section
9231 Hollywood (Hollywood spec scripts)
9234 \begin_layout Standard
9240 \begin_layout Subsection
9244 \begin_layout Standard
9245 Getting the format of a Hollywood script right is a
9246 \begin_inset Quotes eld
9250 \begin_inset Quotes erd
9253 It is designed to make the readers focus on content and to be easy and
9254 familiar for the actors to read.
9255 Each page of a script should be one minute of film.
9256 Nothing goes in a script that you cannot see or hear on screen.
9257 The courier 12 pt font should be used throughout.
9261 \begin_layout Subsection
9265 \begin_layout Standard
9266 Speakers' lines should NEVER break in mid-sentence.
9267 If a speaker's lines continue over a page break, repeat the
9271 title followed by (Cont'd).
9274 \begin_layout Subsection
9278 \begin_layout Standard
9283 names as labels then cross-reference the label to insert the name.
9284 The cross-reference dialog will show the current cast of characters.
9285 You can use this to insert the speaker name in narratives also.
9288 \begin_layout Subsection
9289 Paper size and Margins
9292 \begin_layout Standard
9293 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9296 \begin_layout Subsection
9300 \begin_layout Standard
9301 The following environments are available.
9302 You can use hollywood.bind to get the bind keys shown at the right.
9305 \begin_layout Itemize
9309 \begin_inset Newline newline
9314 Used where nothing else works.
9318 \begin_layout Itemize
9324 \begin_inset space \hfill{}
9332 \begin_inset Newline newline
9335 Usually followed by something like
9336 \begin_inset Quotes eld
9340 \begin_inset Quotes erd
9346 \begin_layout Itemize
9350 \begin_inset space \hfill{}
9354 \begin_inset Newline newline
9359 Introduces a new INTERIOR camera set-up.
9360 Always followed by DAY or NIGHT, or something similar to define the lighting
9362 Everthing on this line in CAPS.
9365 \begin_layout Itemize
9369 \begin_inset space \hfill{}
9373 \begin_inset Newline newline
9378 Introduces a new EXTERIOR camera set-up.
9379 Everthing on this line in CAPS.
9382 \begin_layout Itemize
9386 \begin_inset space \hfill{}
9390 \begin_inset Newline newline
9395 The character speaking.
9398 \begin_layout Itemize
9402 \begin_inset space \hfill{}
9406 \begin_inset Newline newline
9411 Instructions to the speaker.
9412 The () are automatically inserted, but only the ( will show in LyX.
9413 Both will be printed.
9416 \begin_layout Itemize
9420 \begin_inset space \hfill{}
9424 \begin_inset Newline newline
9436 \begin_layout Itemize
9440 \begin_inset space \hfill{}
9444 \begin_inset Newline newline
9449 Camera movement instruction.
9451 \begin_inset space \thinspace{}
9455 \begin_inset space \space{}
9461 \begin_layout Itemize
9465 \begin_inset space \hfill{}
9471 \begin_layout Itemize
9475 \begin_inset space \hfill{}
9481 \begin_layout Itemize
9485 \begin_inset space \hfill{}
9491 \begin_layout Itemize
9495 \begin_inset space \hfill{}
9501 \begin_layout Subsection
9505 \begin_layout Itemize
9506 (O.S) --- off screen
9509 \begin_layout Itemize
9510 (V.0) --- voice over
9513 \begin_layout Itemize
9515 \begin_inset space \thinspace{}
9522 \begin_layout Itemize
9527 \begin_layout Itemize
9528 PAN --- camera movement
9531 \begin_layout Itemize
9532 INSERT --- cut to close-up of
9535 \begin_layout Section
9539 \begin_layout Standard
9542 Panayotis Papasotiriou
9545 \begin_layout Subsection
9549 \begin_layout Standard
9550 The ijmpc package is a set of macros that facilitates electronic manuscript
9553 International Journal of Modern Physics C
9556 Similarly, the ijmpd package is for creating manuscripts to be submitted
9559 International Journal of Modern Physics D
9562 Both journals are published by World Scientific.
9563 The corresponding document classes are named
9572 These files, together with instructions for the authors, can be downloaded
9574 \begin_inset Flex URL
9577 \begin_layout Plain Layout
9579 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9585 \begin_inset Flex URL
9588 \begin_layout Plain Layout
9590 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9596 Both packages are modified versions of the standard
9597 \begin_inset Quotes eld
9601 \begin_inset Quotes erd
9604 package, and they are almost (but not exactly) identical.
9605 Most of their features are supported by LyX.
9606 I have used LyX successfully to write articles submitted to both journals
9607 without any problem.
9610 \begin_layout Subsection
9614 \begin_layout Standard
9615 As usual, the easiest way to write a paper is to start with a template.
9621 ile\SpecialChar \menuseparator
9640 This will give an (almost) empty document that includes the most common
9641 fields found in a manuscript.
9642 Simply overwrite the existing text (including the brackets,
9647 You should keep in mind the following remarks.
9650 \begin_layout Enumerate
9651 LyX won't let you change the font size and the page style of the document,
9652 because such modifications are not allowed by both packages.
9655 \begin_layout Enumerate
9656 The language of the document should not be changed.
9657 Before previewing your paper, be sure that the babel package is not used.
9658 To do this, click on
9663 ools\SpecialChar \menuseparator
9681 checkbox in the language settings, and click on
9692 , if you wish to make this change permanent).
9695 \begin_layout Enumerate
9697 \begin_inset Quotes eld
9701 \begin_inset Quotes erd
9704 style must be used to define keywords.
9707 \begin_layout Enumerate
9708 The ijmpc package provides a style named
9709 \begin_inset Quotes eld
9712 Classification Codes
9713 \begin_inset Quotes erd
9716 , which can be used to define classification codes, such as PACS numbers.
9717 Note that this facility is not supported by the ijmpd package.
9720 \begin_layout Enumerate
9721 Several new environments are available:
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 \begin_inset Quotes eld
9774 \begin_inset Quotes erd
9778 \begin_inset Quotes eld
9782 \begin_inset Quotes erd
9786 \begin_inset Quotes eld
9790 \begin_inset Quotes erd
9794 \begin_inset Quotes eld
9798 \begin_inset Quotes erd
9802 \begin_inset Quotes eld
9806 \begin_inset Quotes erd
9810 \begin_inset Quotes eld
9814 \begin_inset Quotes erd
9818 \begin_inset Quotes eld
9822 \begin_inset Quotes erd
9826 \begin_inset Quotes eld
9830 \begin_inset Quotes erd
9834 Their use is more or less obvious.
9835 LyX supports all these environments; it will use the proper label, text
9836 style, and numbering scheme for each of them.
9839 \begin_layout Enumerate
9840 Both packages use basic citations; the natbib package should not be used.
9841 In LyX, citation references are shown as usual; in the output, citations
9842 are shown as superscripts.
9843 If you want to use a citation as normal text, you should use the
9848 \begin_inset space \thinspace{}
9852 \begin_inset space \space{}
9856 \begin_inset Quotes eld
9860 \begin_inset space \space{}
9870 \begin_inset Quotes erd
9876 \begin_layout Enumerate
9878 \begin_inset Quotes eld
9882 \begin_inset Quotes erd
9885 section in both packages.
9886 To put acknowledgments, just use the
9887 \begin_inset Quotes eld
9891 \begin_inset Quotes erd
9897 \begin_layout Enumerate
9898 Appendices may be added to the paper,
9902 the Acknowledgments and
9907 LyX provides a special environment, called
9908 \begin_inset Quotes eld
9912 \begin_inset Quotes erd
9915 which marks the beginning of the appendices.
9916 This environment should be left blank; it just sends a LaTeX command, but
9917 nothing is really printed.
9919 \begin_inset Quotes eld
9923 \begin_inset Quotes erd
9926 is printed with blue letters, as a signal that all sections after that
9927 point are appendices.
9928 To write an appendix, use the
9929 \begin_inset Quotes eld
9933 \begin_inset Quotes erd
9937 LyX will number each appendix with capital letters, as required by both
9940 \begin_inset Quotes eld
9944 \begin_inset Quotes erd
9951 be present before the first appendix; if not, all appendices will be numbered
9952 as normal sections in the output.
9955 \begin_layout Enumerate
9956 The ijmpc and the ijmpd packages use the
9960 command to implement table captions.
9961 As a result, a table created by LyX is printed correctly, but its caption
9963 However, you can use some ERT to overpass this problem, so that captions
9964 are printed as expected.
9965 To do so, create a float table as usual, remove the caption, and replace
9976 (sic); you must also the ERT
9980 immediately after the tabular material.
9981 Study the example table included in the template files to see how this
9982 trick is implemented.
9983 Alternatively, If you need table captions, you should implement the whole
9988 file, then include this file to the LyX document (
9993 nsert\SpecialChar \menuseparator
9998 \SpecialChar \menuseparator
10004 \begin_inset space ~
10010 Details on how to create a table float can be found in the files
10018 , included in the corresponding packages.
10021 \begin_layout Subsection
10022 Preparing a paper for submission
10025 \begin_layout Standard
10026 Before you submit your paper you must export the LyX document as a LaTeX
10032 ile\SpecialChar \menuseparator
10037 xport\SpecialChar \menuseparator
10052 \begin_layout Plain Layout
10053 Actually you have the choice between LaTeX (plain) and pdflatex.
10054 If you intend to use pdflatex to prepare the paper, you should use the
10055 pdflatex option so that included graphics are converted to PDF format,
10056 ready for use by pdflatex.
10061 , then make the following changes to the resulting
10068 \begin_layout Enumerate
10069 Remove the comment lines before the
10078 \begin_layout Enumerate
10079 Remove everything between (and including) the
10091 commands, except for any commands you specifically put into the LaTeX preamble.
10094 \begin_layout Standard
10099 file should be saved and processed through LaTeX as many times as necessary.
10100 You may also want to check the resulting
10107 \begin_layout Subsection
10111 \begin_layout Standard
10112 The use of ERT is reduced to two commands, which must be placed at the top
10114 If you started writing your paper by using the
10122 template, the ERT needed is already in its place; you usually don't need
10124 You may only modify the first ERT to specify the information printed to
10125 the top of odd and even pages (authors' names and short paper's title,
10127 This ERT must have the form
10131 markboth{Authors' Names}{Short Paper's Title}
10136 \begin_layout Section
10140 \begin_layout Standard
10146 \begin_layout Subsection
10150 \begin_layout Standard
10151 The iopart package provides a document class to create electronic manuscript
10152 submission to the journals published by the Institute of Physics.
10153 Instructions for the authors how to create a paper using the iopart class
10154 can be downloaded together with the iopart package from the site
10155 \begin_inset Flex URL
10158 \begin_layout Plain Layout
10160 ftp://ftp.iop.org/pub/journals/latex2e
10168 \begin_layout Subsection
10172 \begin_layout Standard
10173 The easiest way to write a paper is to start with the file
10177 that is available in LyX's examples files folder.
10178 Open this file, save it under a new name, and start writing.
10179 The example file explains how to use the special text environments.
10180 Here are the most important advices:
10183 \begin_layout Itemize
10184 To be able to compile your document to a PDF, PS, or DVI, assure that the
10187 Use AMS math package
10189 in the document settings under
10196 \begin_layout Itemize
10199 The title environment defines the kind of your paper.
10200 So use one of the following environments for the title:
10204 \begin_layout Itemize
10213 \begin_layout Itemize
10222 \begin_layout Itemize
10228 for a Topical review
10231 \begin_layout Itemize
10240 \begin_layout Itemize
10249 \begin_layout Itemize
10255 for a Paper (same as Title)
10258 \begin_layout Itemize
10264 for a Preliminary communication
10267 \begin_layout Itemize
10273 for a Rapid communication
10276 \begin_layout Itemize
10282 for a Letter to the editor
10286 \begin_layout Itemize
10289 All title environments except of
10293 can have an optional short title.
10296 \begin_layout Itemize
10297 There is a general title environment
10301 which is not directly supported by the LyX.
10302 This can be used as ERT when your document doesn't fit into one of the
10306 \begin_layout Standard
10307 For more informations like hints for special table and formula formatting,
10308 look at the IOP author guidelines.
10311 \begin_layout Section
10315 \begin_layout Standard
10318 Panayotis Papasotiriou
10321 \begin_layout Subsection
10325 \begin_layout Standard
10326 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10327 that facilitates electronic manuscript submission to the journals they
10329 Most known of them (at least in my domain of interest) are
10331 Astrophysics and Space Science
10337 , but there are many others (see a complete list at
10338 \begin_inset Flex URL
10341 \begin_layout Plain Layout
10343 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10349 The Kluwer package may be downloaded from the site
10350 \begin_inset Flex URL
10353 \begin_layout Plain Layout
10355 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10361 A complete user guide is contained in that package (but it can also be
10362 downloaded separately).
10365 \begin_layout Standard
10366 LyX supports many features of the package but not everything.
10367 However, the ERT needed is reduced to some
10368 \begin_inset Quotes eld
10372 \begin_inset Quotes erd
10375 commands of the package (see
10376 \begin_inset space ~
10380 \begin_inset CommandInset ref
10382 reference "subsec:kluwer_peculiarities"
10387 I have recently used LyX to write an article submitted to the
10389 Astrophysics and Space Science
10391 without any problem.
10394 \begin_layout Subsection
10398 \begin_layout Standard
10399 The easiest way to write a paper is to start with the Kluwer template file.
10402 File\SpecialChar \menuseparator
10414 This will give an (almost) empty document that includes the most common
10415 fields found in a manuscript and a short description of their use.
10416 As in most templates, simply overwrite the existing text (including the
10421 ) with the correct information.
10424 \begin_layout Subsection
10425 Preparing a paper for submission
10428 \begin_layout Standard
10429 As in the AASTeX package, before you submit your paper to a journal you
10431 \begin_inset Quotes eld
10435 \begin_inset Quotes erd
10441 \begin_layout Enumerate
10442 Export your paper as a LaTeX file.
10443 To do this, click on
10445 File\SpecialChar \menuseparator
10446 Export\SpecialChar \menuseparator
10453 \begin_layout Enumerate
10458 file with a text editor and make the following changes
10462 \begin_layout Enumerate
10463 remove the comment lines before the
10472 \begin_layout Enumerate
10473 remove everything between (and including) the
10485 commands, except for any commands you specifically put into the LaTeX preamble.
10488 \begin_layout Standard
10497 \begin_layout Enumerate
10502 file through LaTeX as many times as necessary (usually up to three).
10505 \begin_layout Enumerate
10511 \begin_inset space \thinspace{}
10515 \begin_inset space \space{}
10522 , and check if everything is OK (it should, if you didn't make any mistake).
10525 \begin_layout Subsection
10526 \begin_inset Quotes eld
10530 \begin_inset Quotes erd
10533 of the Kluwer package
10534 \begin_inset CommandInset label
10536 name "subsec:kluwer_peculiarities"
10543 \begin_layout Standard
10544 The Kluwer package has the following
10545 \begin_inset Quotes eld
10549 \begin_inset Quotes erd
10555 \begin_layout Enumerate
10556 It is possible to write multiple articles in the same LaTeX file
10560 \begin_layout Plain Layout
10561 I can't imagine any good reason to do this.
10567 Each article must be included in the environment
10568 \begin_inset Quotes eld
10572 \begin_inset Quotes erd
10576 Unfortunately, this environment cannot be omitted, even if you write just
10578 Therefore, each article starts with the command
10584 and, obviously, ends with the command
10591 Although this can be implemented in LyX, I didn't included it, since it
10592 looks ugly and can confuse the novice user.
10593 Therefore, you need to enter them directly and mark them as LaTeX code
10595 \begin_inset Quotes eld
10599 \begin_inset Quotes erd
10605 \begin_layout Enumerate
10606 Information given at the beginning of the article (i.
10607 \begin_inset space \thinspace{}
10611 \begin_inset space \space{}
10614 title, subtitle, author, institution, running title, running author, abstract
10615 and keywords) must be included in an environment called
10616 \begin_inset Quotes eld
10620 \begin_inset Quotes erd
10624 This is not implemented in LyX, so you must enter title, subtitle etc.
10625 \begin_inset space ~
10628 between two ERT lines (
10643 \begin_layout Enumerate
10644 According to the user manual, the label of each bibliography item must be
10668 \begin_layout Standard
10673 template takes care of all these
10674 \begin_inset Quotes eld
10678 \begin_inset Quotes erd
10682 If you start a new paper using this template you don't need to do anything
10687 \begin_layout Enumerate
10688 don't delete the ERT included in the template, and
10691 \begin_layout Enumerate
10692 copy the example bibliography item included in the template and modify it
10693 as necessary to enter new bibliography items.
10696 \begin_layout Section
10700 \begin_layout Standard
10706 \begin_layout Subsection
10710 \begin_layout Standard
10711 The LyX document classes
10713 article (koma-script)
10717 report (koma-script)
10735 correspond to the LaTeX document classes
10752 \begin_inset space ~
10755 of the Koma-Script family.
10756 They are replacements for the standard document classes
10772 , resp., and fit better to European typography conventions in a number of
10776 \begin_layout Itemize
10777 Standard character size is 11pt in
10779 article (koma-script)
10783 report (koma-script)
10791 letter (koma-script)
10796 \begin_layout Itemize
10797 Headings, labels of the description environment, and a number of elements
10800 letter (koma-script)
10802 document class are set in a bold sans serif font.
10806 \begin_layout Plain Layout
10807 There is a big difference between the bold sans serif old cm fonts and new
10808 ec fonts, especially in the appearance of headings.
10809 In comparison, the ec bold sans serif fonts look a bit thin.
10810 Here the LaTeX package
10818 helps to produce the
10819 \begin_inset Quotes eld
10823 \begin_inset Quotes erd
10826 appearance when using the ec fonts.
10831 The numbering of chapter headings is made in the same way as the numbering
10832 of section headings, that is without the extra line
10833 \begin_inset Quotes eld
10836 Chapter\SpecialChar \ldots{}
10838 \begin_inset Quotes erd
10842 In addition, the appearance of the headings can be modified by using a
10843 number of options (in LyX to be entered in the field
10850 \begin_inset space ~
10857 Layout\SpecialChar \menuseparator
10861 A detailed German description of these options can be found in the Koma-Script
10869 \begin_layout Itemize
10870 The main means in the Koma-Script document classes to design the type area
10879 (in LyX to be entered in the extra class options field in the dialog
10881 Document\SpecialChar \menuseparator
10885 They make a clearer modification of page margins possible as do the options
10888 Document\SpecialChar \menuseparator
10892 A detailed German description of these and other type area options can
10893 be found in the Koma-Script documentation
10900 \begin_layout Itemize
10901 The LaTeX document classes of the Koma-Script family define a number of
10902 additional commands.
10903 Those part of it which makes sense in LyX is implemented in corresponding
10907 \begin_layout Standard
10908 A detailed German description of the LaTeX document classes of the Koma-Script
10909 family can be found in the Koma-Script documentation
10917 \begin_layout Plain Layout
10918 There is an English translation
10922 , but it is not a complete one.
10927 The following sections describe only those aspects, which are relevant
10931 \begin_layout Subsection
10932 article (koma-script), report (koma-script), and book (koma-script)
10935 \begin_layout Standard
10936 The document classes
10938 article (koma-script)
10942 report (koma-script)
10952 are implemented in the layout files
10965 They contain all the paragraph types of the corresponding standard document
10978 , resp., partly modified, with the exception of the LyX specific
10982 -type, which is replaced by the new
10986 -type having the same functionality.
10991 -Type there is a number of new paragraph types added.
10998 letter (koma-script)
11003 \begin_layout Itemize
11012 : are equivalents to
11020 , resp., additionally inserting an entry in the table of contents.
11029 are not contained in
11031 article (koma-script)
11036 \begin_layout Itemize
11045 : behave exactly as
11053 , resp., additionally clearing running heads.
11058 is not contained in
11060 article (koma-script)
11066 \begin_layout Plain Layout
11079 report (koma-script)
11081 , but since this is identical to
11085 , is has not been implemented in LyX.
11093 \begin_layout Itemize
11098 : generates a heading directly above the following paragraph in the standard
11099 character size without affecting the structure of the document.
11102 \begin_layout Itemize
11111 are special captions which respect the different space settings needed
11112 for captions placed above or below an element (if you follow strict typographic
11113 rules, you might want to place table captions always above the table).
11114 You can also use the class option
11118 , which will switch
11131 You need at least Koma-Script version 2.8q to use this.
11134 \begin_layout Itemize
11139 : can be used to set a bonmot, e.
11140 \begin_inset space \thinspace{}
11144 \begin_inset space \space{}
11147 at the beginning of a chapter.
11148 If you use the optional argument (
11150 Insert\SpecialChar \menuseparator
11152 \begin_inset space ~
11157 ), you can insert the dictum's author there.
11158 Dictum and author are separated by a line.
11159 You need at least Koma-Script version 2.8q to use this.
11164 is not contained in
11166 article (koma-script)
11171 \begin_layout Standard
11172 The following types, together with the standard types
11184 , form the title area of the document.
11185 They must be entered ahead of the first
11186 \begin_inset Quotes eld
11190 \begin_inset Quotes erd
11197 \begin_layout Plain Layout
11198 The corresponding LaTeX commands must appear before the
11209 When such a type is used more than once, the latter usage overwrites the
11210 former one, that means, for every type only the latest usage is valid.
11211 The order of the different types however has, like
11223 , no effect on the appearance of the produced document.
11226 \begin_layout Itemize
11231 : produces a centered paragraph above the ordinary title (
11243 ) for the subject of the document.
11246 \begin_layout Itemize
11251 : produces a centered paragraph below the ordinary title (
11263 ) for the publishers' name.
11266 \begin_layout Itemize
11273 report (koma-script)
11279 produces a centered paragraph on its own page behind the title page, or
11282 article (koma-script)
11284 produces a centered paragraph below the ordinary title (
11300 ) for a dedication.
11303 \begin_layout Itemize
11308 : produces a left aligned paragraph above the ordinary title (
11324 ) for a document`s head.
11327 \begin_layout Itemize
11332 : produces in a double-sided print in
11334 report (koma-script)
11340 a left-aligned paragraph at the top of the title page`s back or has no
11341 effect in a single-sided print or in
11343 article (koma-script)
11348 \begin_layout Itemize
11353 : produces in a double-sided print in
11355 report (koma-script)
11361 a left-aligned paragraph at the bottom of the title page`s back or has
11362 no effect in a single-sided print or in
11364 article (koma-script)
11369 \begin_layout Itemize
11374 : produces a special
11375 \begin_inset Quotes eld
11379 \begin_inset Quotes erd
11382 page ahead of the actual document containing a paragraph without special
11386 \begin_layout Standard
11387 The layout files for the document classes
11389 article (koma-script)
11393 report (koma-script)
11399 do include the file
11404 This is thought of as a place to define your own types.
11409 in your personal layout directory and edit the file!
11412 \begin_layout Subsection
11413 letter (koma-script)
11416 \begin_layout Standard
11420 \begin_layout Plain Layout
11432 \begin_layout Standard
11436 letter (koma-script)
11438 is implemented in the layout file
11443 It contains all the paragraph types of the corresponding standard document
11448 , partly modified, with the exception of the LyX specific types
11460 type, which is replaced by the new
11465 In addition, it contains, in contrast to the standard document class, the
11483 Furthermore, there are a number of new letter specific types.
11486 \begin_layout Standard
11490 \begin_layout Plain Layout
11502 \begin_layout Standard
11503 The appearance of the letter produced by this document class can be controlled
11504 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11508 \begin_layout Plain Layout
11509 For example, the standard appearance of the letter`s heading, consisting
11510 of name and address, is quite self-willed.
11512 \begin_inset Quotes eld
11516 \begin_inset Quotes erd
11519 heading is produced by the following LaTeX commands in the preamble:
11522 \begin_layout LyX-Code
11532 \begin_layout LyX-Code
11548 \begin_layout LyX-Code
11558 \begin_layout LyX-Code
11578 A detailed German description of such LaTeX commands can be found in the
11579 Koma-Script documentation
11584 With it, the letter's author can produce his personal letter layout.
11587 \begin_layout Standard
11596 define the beginning of the letter and must be used in every letter.
11597 To emphasize them in the LyX document class, they are marked with the letter
11607 \begin_inset space ~
11610 in the left margin.
11611 It is possible to write any number of letters in one file.
11616 type produces a new letter using the same addressee and a
11620 type produces a new addressee.
11637 are ordinary paragraph types and can also be used several times in one
11638 and the same letter.
11641 \begin_layout Itemize
11646 : produces a paragraph for the addressee and implicitly defines the beginning
11650 \begin_layout Itemize
11655 : produces a paragraph for the form of address and implicitly produces a
11659 \begin_layout Itemize
11664 : produces a paragraph for a close.
11667 \begin_layout Itemize
11672 : produces a paragraph for a postscript.
11675 \begin_layout Itemize
11680 : produces a paragraph for a distribution list.
11683 \begin_layout Itemize
11688 : produces a paragraph for enclosures.
11691 \begin_layout Standard
11732 are input types provided with a label to enter information, which will
11733 be processed by the document class.
11737 \begin_layout Plain Layout
11738 It could be seen as a matter of inconsequence, that the types
11746 described above are not such input types as well.
11747 Because of the special meaning of those types, however, I have implemented
11748 them as ordinary paragraph types with a one letter mark in the left margin.
11749 Moreover, it would affect my feeling of symmetry, if the
11757 type had such a serious different appearance.
11762 The types must be used ahead of the corresponding
11769 \begin_layout Standard
11770 An implementation of these types in a WYSIWYG fashion does not seem to make
11771 sense, because the real appearance of the produced letter does not only
11772 depend on the usage of the particular type, but also on other factors.
11773 For example, a signature entered in the
11777 type will in the standard behavior appear in the produced letter only,
11778 when in the same letter also a
11783 The entered value of the
11787 type will in the standard behavior not appear in the produced letter at
11789 The possibility to design the letter`s heading freely is already indicated
11790 in a footnote above.
11793 \begin_layout Standard
11794 The input types can also be used as empty paragraphs.
11795 This makes sense e.
11796 \begin_inset space \thinspace{}
11800 \begin_inset space \space{}
11812 type is not used at all, in the standard behavior the value of the
11816 type is used as signature, whereas if an empty
11820 type is used, no signature value is defined.
11823 \begin_layout Standard
11824 By using the input types it is possible to write a letter template, containing
11825 filled input types with your personal dates (name, address, etc.) and empty
11826 input types for other dates you want to enter.
11829 \begin_layout Itemize
11834 : sender's name, in the standard behavior appears as a centered paragraph
11835 in small caps in the letter`s heading.
11838 \begin_layout Itemize
11843 : sender's signature, in the standard behavior appears below the
11852 type is used, the value of the
11856 type appears instead.
11859 \begin_layout Itemize
11864 : sender's address, in the standard behavior appears in a centered paragraph
11865 in the letter`s heading below the sender's name.
11868 \begin_layout Itemize
11873 : sender's telephone number, in the standard behavior only sets the LaTeX
11883 \begin_layout Itemize
11888 : place of the letter`s making.
11891 \begin_layout Itemize
11896 : date of the letter`s making.
11905 , in the standard behavior, produce the place and the date in a right-aligned
11906 line below the addressee's field.
11911 type is used, neither place nor date appear, independent of the value of
11921 type is used, the date of the letter `s production is used.
11924 \begin_layout Itemize
11929 : sender`s back address, in the standard behavior appears above the addressee's
11930 field in a small sans serif font.
11933 \begin_layout Itemize
11938 : special mail information, in the standard behavior appears underlined
11939 above the addressee's field below the back address.
11942 \begin_layout Itemize
11947 : additional information, in the standard behavior appears on right side
11948 below the addressee`s field.
11951 \begin_layout Itemize
11956 : the letter's title, in the standard behavior appears in a big, bold, sans
11957 serif font above the subject.
11960 \begin_layout Itemize
11965 : the letter's subject, in the standard behavior appears in a bold font
11973 \begin_layout Standard
11994 produce a business letter like line above the
11998 line containing the fields
11999 \begin_inset Quotes eld
12003 \begin_inset Quotes erd
12007 \begin_inset Quotes eld
12011 \begin_inset Quotes erd
12015 \begin_inset Quotes eld
12019 \begin_inset Quotes erd
12023 \begin_inset Quotes eld
12027 \begin_inset Quotes erd
12031 \begin_inset Quotes eld
12035 \begin_inset Quotes erd
12039 \begin_inset Quotes eld
12043 \begin_inset Quotes erd
12047 For the date field, the value of the
12053 \begin_inset Quotes eld
12056 business letter types
12057 \begin_inset Quotes erd
12060 is used, the value of the
12064 type however does not appear, but only the LaTeX variable
12071 The ordinary output of place and date in a right-aligned line below the
12072 addressee`s field is suppressed.
12073 The types are implemented as input types provided with a label and must
12074 be used ahead of the corresponding
12081 \begin_layout Itemize
12089 \begin_layout Itemize
12097 \begin_layout Itemize
12105 \begin_layout Itemize
12113 \begin_layout Itemize
12121 \begin_layout Subsection
12122 The new letter class: letter (koma-script v.2)
12125 \begin_layout Standard
12128 Jürgen Spitzmüller
12131 \begin_layout Standard
12132 \begin_inset VSpace medskip
12138 \begin_layout Standard
12140 Koma-Script version 2.8 has introduced a new letter class
12144 which supersedes the now unsupported
12149 It has --- on the LaTeX side --- a completely new interface and is not
12150 compatible with the old class.
12151 Therefore, LyX supports both, though it is recommended to use the new class.
12154 \begin_layout Standard
12155 This class covers the same functionality as
12157 letter (koma-script),
12160 The basic items are
12164 (receiver's address, same as
12168 in the old layout),
12181 will start a new letter (i.
12182 \begin_inset space \thinspace{}
12186 \begin_inset space \space{}
12189 you can write several letters per document).
12190 New elements are sender's
12206 and the possibility to use a
12212 Insert\SpecialChar \menuseparator
12218 \begin_layout Standard
12219 The biggest improvement is, though, that the letter's layout is configurable
12220 at almost any needs.
12221 This can be done via the preamble or with a special style file (Letter
12222 Class Option, extension
12226 ), that will be read in as a class option.
12230 \begin_layout Plain Layout
12231 The KOMA package comes with some default
12236 There is, for instance, a
12240 file that follows german typesetting rules, or a
12244 that provides the default layout of the old
12249 The latter can be loaded with the class option
12258 ayout\SpecialChar \menuseparator
12263 ocument\SpecialChar \menuseparator
12275 template that is included in LyX for examples.
12276 A detailed description is to be found in the Koma-Script documentation
12284 \begin_layout Subsection
12288 \begin_layout Standard
12289 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12293 \begin_layout Itemize
12294 The chapter number of a
12298 type appears on a line of its own above the chapter heading instead of
12299 appearing in the same line ahead of it.
12300 The cause for that is the LyX internal behavior for the labeltype
12304 in the layout file.
12307 \begin_layout Itemize
12308 The headings of the types
12316 are only put in the
12317 \begin_inset Quotes eld
12321 \begin_inset Quotes erd
12324 LaTeX table of contents, but not in the LyX table of contents (
12326 Document\SpecialChar \menuseparator
12328 \begin_inset space ~
12332 \begin_inset space ~
12340 \begin_layout Itemize
12341 The paragraphs in a
12345 document class appear in a skip separation mode, not indented.
12346 This is the standard behavior, no special LaTeX commands are needed for
12350 Document\SpecialChar \menuseparator
12353 dialog the corresponding radio button indicates
12362 value always has the effect that extra LaTeX commands are inserted in the
12363 document to produce the gap, which is not what is wanted in this case.
12366 \begin_layout Section
12367 Latex8 (IEEE Conference Papers)
12370 \begin_layout Standard
12376 \begin_layout Subsection
12380 \begin_layout Standard
12381 Since this class is specifically for writing submissions to IEEE sponsored
12382 conferences I strongly recommend that you get a copy of their Authors Kit.
12387 package and associated bibliography style file is included in the kit.
12388 The Authors Kit is usually sent out by email once your initial submission
12390 There is a lot of useful information in the Authors Kit explaining formatting
12391 restrictions and so on and I will assume you have read this since that
12392 means I don't have to repeat it all here.
12395 \begin_layout Subsection
12399 \begin_layout Standard
12400 [AR\SpecialChar \@.
12404 \begin_layout Subsection
12405 Supported Environments
12408 \begin_layout Itemize
12414 \begin_layout Itemize
12420 \begin_layout Itemize
12426 \begin_layout Itemize
12432 \begin_layout Itemize
12438 \begin_layout Itemize
12444 \begin_layout Itemize
12450 \begin_layout Itemize
12456 \begin_layout Itemize
12462 \begin_layout Subsection
12463 Differences Between Screen and Paper
12466 \begin_layout Standard
12467 There are slight differences in appearance mainly with the presentation
12468 of section counters.
12469 On screen the trailing period of the section counter is missing but it
12470 will appear in the output so don't let this worry you.
12473 \begin_layout Section
12477 \begin_layout Standard
12480 Jürgen Spitzmüller
12483 \begin_layout Subsection
12487 \begin_layout Standard
12488 Memoir is a very powerful and constantly evolving class.
12489 It has been designed with regard to fictional and non-fictional literature.
12490 Its aim is to let the user have maximum control over the typesetting of
12492 Memoir is based on the standard book class, but it can also emulate the
12493 article class (see below).
12496 \begin_layout Standard
12497 Peter Wilson, the developer of Memoir, is known as the author of lots of
12498 useful packages in the LaTeX world.
12499 Most of them have been merged with Memoir.
12500 Therefore, it is much easier to layout the table of contents, appendices,
12501 chapter designs and such.
12502 LyX, though, does not support all of these goodies natively.
12503 Some of them might be added to forthcoming releases
12507 \begin_layout Plain Layout
12508 You are invited to send suggestions to
12509 \begin_inset Flex URL
12512 \begin_layout Plain Layout
12514 lyx-devel@lists.lyx.org
12524 , lots will probably never, due to the limitations of LyX's framework.
12525 Of course you can still use all features with the help of some native LaTeX
12530 \begin_layout Plain Layout
12535 \begin_layout Plain Layout
12545 \begin_inset space ~
12549 \begin_inset CommandInset ref
12551 reference "sec:Inserting-TeX-Code"
12561 In this section, we can only list those features which are natively supported
12563 For detailed descriptions (and for the rest of features) we are recommending
12564 to have a look at the detailed manual of the Memoir class
12568 \begin_layout Plain Layout
12573 \begin_layout Plain Layout
12583 \begin_inset Flex URL
12586 \begin_layout Plain Layout
12588 CTAN:/macros/latex/memoir/memman.pdf
12598 , which is not only a user guide for the class, but also both a comprehensive
12599 description on good typesetting and a superb example for good typesetting
12603 \begin_layout Subsection
12604 Basic features and restrictions
12607 \begin_layout Standard
12608 Memoir supports basically all features of the standard book classes.
12609 There are, however, some differences, as follows:
12612 \begin_layout Description
12614 \begin_inset space ~
12617 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12620 \begin_layout Description
12622 \begin_inset space ~
12625 style: The fancy page style is not supported, due to a command clash between
12626 Memoir and the fancyhdr package (they are both defining a command with
12627 the same name, which confuses LaTeX).
12628 Instead, Memoir comes with a bunch of own page styles (see
12630 Layout\SpecialChar \menuseparator
12631 Document\SpecialChar \menuseparator
12633 \begin_inset space ~
12639 If you want to use these for the chapter pages, you have to use the command
12646 in the main text or in preamble (e.
12647 \begin_inset space \thinspace{}
12651 \begin_inset space \space{}
12658 chapterstyle{companion}
12663 \begin_layout Description
12664 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12665 an optional argument in the standard classes.
12666 With this, you can specify an alternative version of the title for the
12667 table of contents and the headers (for instance, if the title is too long).
12668 In LyX, you can do this via
12670 Insert\SpecialChar \menuseparator
12672 \begin_inset space ~
12677 at the beginning of a chapter/section.
12678 Memoir features a second optional argument and thus separates the table
12679 of contents from the header.
12680 You can define three variants of a title with this: one for the main text,
12681 one for the table of contents, and one for the headers.
12682 Simply insert two optional arguments if you need this feature, the first
12683 one containing the short title for the Table of Contents, the second one
12684 containing an alternative short title for the headers.
12687 \begin_layout Description
12688 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12689 of contents, the list of figures and the list of table start a new page
12691 Memoir does not follow this route.
12692 You have to insert a page break yourself, if you want to have one.
12695 \begin_layout Description
12696 Titlepage: For some unknown reason, Memoir uses pagination on the title
12697 page (in the standard classes, title pages are
12698 \begin_inset Quotes eld
12702 \begin_inset Quotes erd
12706 \begin_inset space \thinspace{}
12710 \begin_inset space \space{}
12714 If you want an empty title page, type
12718 aliaspagestyle{title}{empty}
12723 \begin_layout Description
12724 Article: With the class option
12730 Layout\SpecialChar \menuseparator
12731 Document\SpecialChar \menuseparator
12733 \begin_inset space ~
12738 ), you can emulate article style.
12739 That is, counters (footnotes, figures, tables etc.) will not be reset on
12740 new chapters, chapters don't start a new page (but are---in contrary to
12742 \begin_inset Quotes eld
12746 \begin_inset Quotes erd
12749 article classes---still allowed), parts, though, use their own page, as
12753 \begin_layout Description
12754 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12755 font commands, which have been used in the old LaTeX version 2.09 (e.
12756 \begin_inset space \thinspace{}
12760 \begin_inset space \space{}
12776 It produces an error and stops LaTeX whenever such a command appears.
12781 reallows the commands and spits out warnings instead (which does at least
12783 Since a lot of packages and particularly BibTeX style files are still using
12784 those commands, we have decided to use this option by default.
12787 \begin_layout Subsection
12791 \begin_layout Standard
12792 We will only describe the features supported by LyX (which is not much currently
12794 Please consult the Memoir manual
12798 \begin_layout Plain Layout
12803 \begin_layout Plain Layout
12813 \begin_inset Flex URL
12816 \begin_layout Plain Layout
12818 CTAN:/macros/latex/memoir/memman.pdf
12831 \begin_layout Description
12832 Abstract: You may wonder why an abstract is an extra feature.
12833 Well, it is in book class.
12834 Usually books don't have abstracts.
12835 Memoir, however, has.
12836 You can use it wherever and how often you like.
12839 \begin_layout Description
12840 Chapterprecis: You may know this from belletristic: The contents of a chapter
12841 is shortly described below the title and also in the table of contents
12843 \begin_inset space \thinspace{}
12847 \begin_inset space \space{}
12852 Our hero arrives in Troia; he loses some friends; he finds others
12855 Chapterprecis does exactly this.
12856 It is therefore only sensible below a chapter.
12859 \begin_layout Description
12860 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12861 The epigraph environment provides an elegant way of typesetting such a
12863 The motto itself (text) and its author (source) are divided by a short
12865 Unfortunately, we have to fool LyX a bit here again, since the environment
12866 needs two arguments (text and source).
12867 In this case, we have to use curly brackets (in TeX mode) between the two
12878 <author of the slogan>.
12881 \begin_layout Description
12882 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12883 complex figurative poems).
12884 LyX can only support a few of them.
12885 One is poemtitle, which is a centered title for poems, which will also
12886 be added to the table of contents (verse is the standard environment for
12888 Memoir has some enhanced versions of verse, but you need to use ERT, because
12889 they have to be nested inside regular verse environments, which is not
12890 possible with LyX).
12893 \begin_layout Description
12894 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12897 \begin_layout Section
12898 Article (mwart), book (mwbk) and report (mwrep)
12899 \begin_inset OptArg
12902 \begin_layout Plain Layout
12915 \begin_layout Standard
12921 \begin_layout Standard
12922 The LyX document classes
12938 correspond to the LaTeX document classes
12951 They are replacements for the standard document classes
12963 , resp., and fit better to Polish typography conventions in a number of points.
12967 \begin_layout Standard
12971 \begin_layout Itemize
12972 Unnumbered titles (with star, e.
12973 \begin_inset space \thinspace{}
12977 \begin_inset space \space{}
12984 ) are added into table of contents,
12987 \begin_layout Itemize
12988 Additional page styles:
12992 \begin_layout Description
12993 uheadings header with separated lines,
12996 \begin_layout Description
12997 myheadings custom header, contents headers via commands:
13012 \begin_layout Description
13013 myuheadings custom header with separated lines,
13016 \begin_layout Description
13017 outer page number is placed on outer side of page
13021 \begin_layout Itemize
13026 \begin_layout Description
13027 rmheadings serif titles --- default,
13030 \begin_layout Description
13031 sfheadings sansserif titles,
13034 \begin_layout Description
13035 authortitle on title page first placed is author next title --- default,
13038 \begin_layout Description
13039 titleauthor on title page first placed is title next author,
13042 \begin_layout Description
13043 withmarginpar reserve place on page for margins.
13047 \begin_layout Section
13051 \begin_layout Standard
13056 provides an alternative to the standard
13061 It provides similar functionality, but you might prefer this layout with
13062 sans serif sections, headings, and more.
13065 \begin_layout Section
13069 \begin_layout Standard
13075 \begin_layout Standard
13076 \begin_inset VSpace bigskip
13082 \begin_layout Standard
13087 \begin_inset space ~
13092 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13093 \begin_inset Formula $\beta$
13096 release of May, 1999) class.
13099 \begin_layout Standard
13104 textclass, which works with RevTeX 3.1.
13105 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13106 That means that it doesn't interact very well with LyX, which requires
13107 LaTeX2e, although it has been kludged to work.
13108 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13112 \begin_inset space ~
13117 textclass should also be pretty easy to use.
13120 \begin_layout Standard
13121 These documents are supposed to be used in
13125 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13126 macros, and assume you'll know what to put in the preamble if necessary.
13129 \begin_layout Subsection
13133 \begin_layout Standard
13134 All you need to do is install RevTeX 4, as described in the package's README
13136 The package can be found at The RevTeX 4 Web Site
13137 \begin_inset Flex URL
13140 \begin_layout Plain Layout
13142 http://publish.aps.org/revtex4/
13148 Install it somewhere that LaTeX can see it.
13149 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13151 \begin_inset space \thinspace{}
13155 \begin_inset space \space{}
13158 not the directory where you installed the class file.) Then, if you reconfigure
13159 LyX, it will find the class file and let you use the RevTeX4 textclass.
13162 \begin_layout Standard
13163 Probably the easiest way to get started is either to import a RevTeX 4 document
13171 \begin_inset space ~
13176 template, found in the templates directory.
13179 \begin_layout Subsection
13183 \begin_layout Standard
13184 Optional arguments to
13191 \begin_inset Quotes eld
13195 \begin_inset Quotes erd
13199 \begin_inset Quotes eld
13203 \begin_inset Quotes erd
13213 \begin_inset space ~
13221 \begin_inset space ~
13227 Remember that in RevTeX, at least one optional argument is required!
13230 \begin_layout Standard
13231 Other preamble matter, like
13238 \begin_inset space ~
13248 \begin_inset space ~
13253 dialog, also as usual.
13256 \begin_layout Subsection
13260 \begin_layout Standard
13261 The layouts basically correspond to the commands in RevTeX4.0.
13262 For example, the Email layout corresponds to
13269 Note that (at least as of RevTeX 4.0 Beta), the
13277 layouts are exactly equivalent, so you shouldn't need to use both.
13281 \begin_layout Plain Layout
13282 In case you're curious, both were included so that
13286 would be able to translate both
13306 \begin_layout Subsection
13310 \begin_layout Standard
13311 There are a couple of important unique aspects of RevTeX 4 which might cause
13312 bugs that will be even more confusing in LyX.
13315 \begin_layout Standard
13333 The LyX equivalent is that there is a separate Thanks layout.
13338 write footnotes in the
13342 layout, or weird things may happen.
13343 See the RevTeX 4 documentation for more details.
13346 \begin_layout Standard
13350 \begin_inset space ~
13358 \begin_inset space ~
13367 layouts must be placed
13375 layout and the corresponding
13392 , the LaTeX won't compile.
13395 \begin_layout Subsection
13399 \begin_layout Standard
13400 The main problem with this layout is that you can't use the optional arguments
13401 to layouts like Email and Title.
13402 (The problem is not unique to this layout; you can't use optional arguments
13403 to the Section layouts either.) This means that after you export that file
13404 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13405 need to edit the LaTeX file with a text editor to add the optional arguments
13407 \begin_inset space \thinspace{}
13411 \begin_inset space \space{}
13414 the running title for the page headers.
13415 Lacking these layouts makes the
13421 (and the equivalent
13427 ) useless, so the corresponding layouts don't exist, and will have to be
13432 \begin_layout Plain Layout
13437 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13438 has not been updated yet to take advantage of it.
13446 \begin_layout Section
13447 Springer Journals (
13454 \begin_layout Standard
13460 \begin_layout Subsection
13464 \begin_layout Standard
13465 These are the layout files for some of the journal formats used by Springer
13466 Verlag and listed on
13467 \begin_inset Flex URL
13470 \begin_layout Plain Layout
13472 http://www.springer.de/author/tex/help-journals.html
13477 , where you should also go to fetch the class files (yes, these are LaTeX2e
13479 It is a modular system: the things common to all journals are implemented
13484 , which journal-specific layout files (such as, e.
13485 \begin_inset space \thinspace{}
13489 \begin_inset space \space{}
13496 for Journal of Geodesy) can include.
13499 \begin_layout Standard
13500 This means that implementing support for any other Springer journal on this
13501 list is as simple as writing your own
13509 file following the outline given in
13517 \begin_layout Standard
13518 It is reasonably well tested only for the Journal of Geodesy.
13527 come with the standard LyX distribution.
13528 Install the relevant class file (downloaded from Springer) in a proper
13529 directory, reconfigure LaTeX (in the teTeX case by running
13533 , as root if necessary --- doesn't LyX take care of this?), reconfigure
13534 LyX and it should work.
13537 \begin_layout Subsection
13541 \begin_layout Standard
13542 A large number of theorem-like styles ---
13548 \SpecialChar \ldots{}
13554 \begin_layout Standard
13557 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13558 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13561 See the Springer class file documentation for details.
13564 \begin_layout Subsection
13568 \begin_layout Itemize
13580 \begin_layout Itemize
13583 Probability Theory and Related Fields
13589 --- Jean-Marc Lasgouttes
13592 \begin_layout Standard
13593 Add your own, it isn't so hard!
13596 \begin_layout Subsection
13600 \begin_layout Standard
13601 These files are partly based on the older
13605 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13606 file from Springer.
13611 layout, are now defunct.
13612 Jean-Marc Lasgouttes helped out big in making me find my way around the
13613 LyX layout file mechanism.
13616 \begin_layout Subsection
13620 \begin_layout Standard
13622 But probably less than in the old hacked-LaTeX
13629 \begin_layout Standard
13631 \begin_inset space \thinspace{}
13634 g.: does not display the number for theorem-like layouts, just #.
13637 \begin_layout Section
13643 \begin_inset CommandInset label
13652 \begin_layout Standard
13660 \begin_layout Subsection
13664 \begin_layout Standard
13665 This section describes how to use LyX to make slides for overhead projectors.
13666 There are two document classes that can do this: the default slides class
13672 This section documents the former.
13675 \begin_layout Standard
13676 I'm going to say this again, nice and clear, so that there's no misunderstanding
13680 \begin_layout Standard
13681 \begin_inset VSpace bigskip
13687 \begin_layout Standard
13691 This section documents the class
13692 \begin_inset Quotes eld
13700 \begin_inset Quotes erd
13708 \begin_layout Standard
13709 \begin_inset VSpace bigskip
13715 \begin_layout Standard
13716 If you're looking for the documentation for
13717 \begin_inset Quotes eld
13725 \begin_inset Quotes erd
13728 , check out section
13729 \begin_inset space ~
13733 \begin_inset CommandInset ref
13735 reference "sec:foiltex"
13745 \begin_inset Quotes eld
13753 \begin_inset Quotes erd
13756 ] is actually somewhat better than the default
13764 \begin_layout Plain Layout
13765 \SpecialChar \ldots{}
13766 or so I've been told repeatedly by its advocates.
13767 Having never used it, I have no idea if this claim is true or not.
13772 which this section documents.
13775 \begin_layout Standard
13776 This class is the LaTeX2e improvement of the old
13781 Every LaTeX2e distribution includes this class [which I'll just refer to
13783 \begin_inset Quotes eld
13791 \begin_inset Quotes erd
13794 from now on], so you're bound to have it.
13795 As I noted earlier, there are other classes, such as
13799 , which also produce slides for overhead projectors and do a better job
13801 However, there are some things which
13805 can do which the others can't, such as generate overlays.
13806 Read on to learn more!
13809 \begin_layout Subsection
13811 \begin_inset CommandInset label
13813 name "sec:slidesetup"
13820 \begin_layout Standard
13821 Obviously, to use this document class, you need to select
13822 \begin_inset Quotes eld
13830 \begin_inset Quotes erd
13833 from the class list in the
13835 Document\SpecialChar \menuseparator
13839 There are some other special things you should know about this class:
13842 \begin_layout Itemize
13843 Don't bother changing the options
13848 They're not supported by the
13855 \begin_layout Itemize
13859 \begin_inset space ~
13864 behaves a bit differently for this class.
13865 The possible choices and what they do are as follows:
13869 \begin_layout Description
13874 The final output contains page numbers in the lower right corner.
13877 \begin_layout Description
13886 , but also prints out any time markers you've put in.
13887 This is the default.
13890 \begin_layout Description
13895 The final output contains no page numbers, time markers, or alignment markers.
13899 \begin_layout Itemize
13904 class has an extra option:
13910 \begin_inset Quotes eld
13918 \begin_inset Quotes erd
13921 in the extra class options.
13925 \begin_layout Standard
13926 Using this options allows you to add time markers to
13932 \begin_inset space ~
13936 \begin_inset CommandInset ref
13938 reference "sec:slideNote"
13946 \begin_layout Standard
13947 You can also use the template file
13948 \begin_inset Quotes eld
13956 \begin_inset Quotes erd
13959 to automatically set up a document to use the
13965 File\SpecialChar \menuseparator
13967 \begin_inset space ~
13971 \begin_inset space ~
13976 to open your new document].
13977 The template file also contains some examples of the special paragraph
13978 environments used by this class.
13979 I'll describe those next.
13982 \begin_layout Subsection
13983 Paragraph Environments
13986 \begin_layout Subsubsection
13987 Supported Environments
13990 \begin_layout Standard
13991 The first thing you'll notice when you start up a new
13995 document is the font size and type: it's the equivalent of the size
13996 \begin_inset Quotes eld
14004 \begin_inset Quotes erd
14010 \begin_inset space ~
14016 This is also what's used in the output.
14018 \begin_inset Quotes eld
14022 \begin_inset Quotes erd
14025 to remind you that this is a slide.
14026 Your final slides will use a larger font; ergo, you'll have less space.
14027 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14030 \begin_layout Standard
14031 The next thing that becomes obvious is the changes to the paragraph environment
14032 pull-down box [at the far-left end of the toolbar].
14033 Most of the paragraph environments you're used to seeing are missing.
14034 There are also five new ones.
14039 class itself only supports certain paragraph environments:
14042 \begin_layout Itemize
14048 \begin_layout Itemize
14054 \begin_layout Itemize
14060 \begin_layout Itemize
14066 \begin_layout Itemize
14072 \begin_layout Itemize
14078 \begin_layout Itemize
14084 \begin_layout Itemize
14090 \begin_layout Itemize
14096 \begin_layout Itemize
14102 \begin_layout Itemize
14108 \begin_layout Standard
14109 All of the other standard environments, including the section-heading environmen
14110 ts, aren't used in the
14117 \begin_layout Standard
14118 On the other hand, you'll notice the following new environments:
14121 \begin_layout Itemize
14127 \begin_layout Itemize
14133 \begin_layout Itemize
14139 \begin_layout Itemize
14145 \begin_layout Itemize
14151 \begin_layout Standard
14152 These five are kind of quirky, due to a
14153 \begin_inset Quotes eld
14157 \begin_inset Quotes erd
14161 You see, LyX doesn't permit you to nest any other paragraph environment
14162 into an empty environment.
14163 Now, that's fine and dandy, but it means that you wouldn't be able to start
14164 a slide with anything except plain text.
14165 To deal with this, I've performed a little
14166 \begin_inset Quotes eld
14170 \begin_inset Quotes erd
14176 \begin_layout Subsubsection
14177 Quirks of the New Environments
14178 \begin_inset CommandInset label
14180 name "sec:slideQuirk"
14187 \begin_layout Standard
14188 All five of the new paragraph environments are somewhat quirky due to inherent
14189 limitiations in the current version of LyX.
14190 As I just mentioned, LyX forbids environments that begin with another environme
14192 To get around this, the
14196 environment isn't a paragraph environment as described in the
14204 \begin_layout Standard
14205 You should consider
14218 \begin_inset Quotes eld
14221 pseudo-environments.
14222 \begin_inset Quotes erd
14225 They look like a section heading or a
14226 \begin_inset Quotes eld
14234 \begin_inset Quotes erd
14237 but really begin a [and, if necessary, end the previous] paragraph environment.
14247 \begin_inset Quotes eld
14251 \begin_inset Quotes erd
14254 These two perform some action.
14257 \begin_layout Standard
14258 A common feature of all five environments,
14278 , is a rather long-ish label.
14279 The text following this label --- ordinarily the contents of the paragraph
14280 environment --- is utterly irrelevant for
14301 LyX completely ignores it.
14302 In fact, you can leave these five environments completely empty.
14306 \begin_layout Standard
14311 to put any text after the rather long-ish label, you might want to.
14312 This could be a short description of the contents of the
14317 In that case, enter in your descriptive comment and hit
14321 as you normally would.
14324 \begin_layout Standard
14325 If, on the other hand, you don't want to enter in any descriptive text,
14326 you'll hit another LyX quirk.
14327 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14328 environment until you put something in the old one.
14332 \begin_layout Itemize
14333 Start entering the text that will
14361 \begin_layout Itemize
14362 Now move to the beginning of that paragraph.
14366 \begin_layout Itemize
14375 \begin_layout Itemize
14376 Finally, change this new, empty paragraph to a
14400 \begin_layout Standard
14401 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14405 \begin_layout Subsection
14406 Making a Presentation with
14419 \begin_layout Subsubsection
14427 \begin_layout Standard
14428 If you're expecting this section to teach you how to actually make a presentatio
14429 n, you'll be sorely disappointed.
14430 Naturally, I'll describe all of the ways the
14434 class can assist you in preparing the materials for a presentation.
14435 Filling in the contents, however, is up to you.
14440 the LyX philosophy.]
14443 \begin_layout Standard
14448 environment [in the manner described in section
14449 \begin_inset space ~
14453 \begin_inset CommandInset ref
14455 reference "sec:slideQuirk"
14459 ] tells LyX to begin a new slide [duh].
14460 The label for this environment/
14461 \begin_inset Quotes erd
14465 \begin_inset Quotes erd
14469 \begin_inset Quotes eld
14473 \begin_inset Quotes erd
14476 in cool blue, followed by the label,
14477 \begin_inset Quotes eld
14481 \begin_inset Quotes erd
14485 Any text or paragraph environments that follow this one go on the new slide.
14489 \begin_layout Standard
14490 Slides are probably the only time you'll need to forcibly end pages in LyX
14491 (this can be specified in the
14496 In fact, you'll want to, once you finish entering the contents of one slide.
14497 If you've entered more text than can physically fit on a slide, the extra
14498 overflows onto a new slide.
14499 I don't recommend doing this, however, since the overflow slide won't have
14500 any page number on it.
14501 Furthermore, it may interfere with any
14505 you've made to accompany the oversized
14512 \begin_layout Standard
14521 environments work the same way as the
14526 They both create an
14527 \begin_inset Quotes eld
14531 \begin_inset Quotes erd
14534 followed by a label [
14535 \begin_inset Quotes eld
14539 \begin_inset Quotes erd
14543 \begin_inset Quotes eld
14547 \begin_inset Quotes erd
14551 The color is a stunning magenta instead of blue, and the
14552 \begin_inset Quotes eld
14556 \begin_inset Quotes erd
14559 will look different, in style and in length.
14560 The label fonts of all three also differ from one another.
14563 \begin_layout Standard
14568 , if the contents of a
14576 exceed the physical size of a slide or sheet of paper, the extra will overflow
14578 Again, you should avoid this.
14579 It defeats the whole purpose of
14590 \begin_layout Subsubsection
14600 \begin_layout Standard
14605 is a slide that sits atop another slide.
14606 Perhaps you wish to discuss a figure on the main
14610 before displaying the text associated with it.
14611 One way to accomplish this is tape a flap of dark paper over the part of
14616 you want to display later.
14617 This method fails, however, if you wish to overlap one graph with another,
14619 You would then have to fumble while speaking to align the two separate,
14624 s to align the two graphs.
14629 environment in both cases makes life much easier.
14632 \begin_layout Standard
14637 receives the page number of its
14638 \begin_inset Quotes eld
14642 \begin_inset Quotes erd
14650 \begin_inset Quotes eld
14658 \begin_inset Quotes erd
14665 \begin_layout Plain Layout
14666 Presumably, mutliple
14671 \begin_inset Quotes eld
14679 \begin_inset Quotes erd
14683 \begin_inset Quotes eld
14691 \begin_inset Quotes erd
14695 \begin_inset Quotes eld
14703 \begin_inset Quotes erd
14707 \begin_inset space ~
14710 appended to the page number of the parent
14720 Clearly, you want the contents of both the
14728 to each fit on a single physical slide! You should probably consider an
14734 \begin_inset Quotes eld
14738 \begin_inset Quotes erd
14750 class provides a visual cue for this: the label at the start of an
14754 is shorter than that at the start of a
14759 Lastly, when you generate printable output, you'll find alignment markers
14760 in all four corners of both the
14764 page and its parent
14769 These will assist you in lining up the two physical slides.
14772 \begin_layout Standard
14773 The major problem in overlaying two slides is aligning the contents of the
14774 two transparencies.
14775 How much space should you leave for that graph on the second slide? Worse
14776 still, what if you want a graph and a sentence on second slide, but there
14777 is text on the main transparency that goes in between them? You could try
14778 and insert vertical space of the right size.
14779 The better way is to use
14790 \begin_layout Standard
14791 As their names imply,
14799 are two command-like paragraph environments that make all subsequent text
14800 invisible and visible, respectively.
14802 \begin_inset space ~
14806 \begin_inset CommandInset ref
14808 reference "sec:slideQuirk"
14812 that you don't place anything
14816 these two environments, however.
14821 , it inserts a centered, sky-blue label into the page reading
14822 \begin_inset Quotes eld
14825 <Invisible Text Follows>
14826 \begin_inset Quotes erd
14830 For paragraphs following this label, the parts of the
14838 ; it doesn't matter which] where they would be contain instead blank space.
14842 \begin_layout Standard
14847 , the corresponding centered label is
14848 \begin_inset Quotes eld
14851 <Visible Text Follows>
14852 \begin_inset Quotes erd
14856 Paragraphs following this label behave normally.
14857 Note that the beginning of a new
14869 automatically shuts off an
14874 It's therefore not necessary to use
14885 \begin_layout Standard
14886 By now, it should be obvious how to create overlay transparencies using
14887 the proper combination of
14906 \begin_layout Enumerate
14911 , including everything that will appear on it, whether on the main slide
14919 \begin_layout Enumerate
14920 Before each figure or paragraph that will appear only on the
14929 If necessary, insert a
14933 environment after the
14940 \begin_layout Enumerate
14945 immediately following the
14952 \begin_layout Enumerate
14953 Copy the contents of this
14964 \begin_layout Enumerate
14969 , change all of the
14980 \begin_layout Standard
14982 You've just made an
14989 \begin_layout Standard
14990 There's one problem with the way I've designed the LyX
14994 class: you can't make text in the middle of a paragraph invisible, nor
14995 make text in the middle of an invisible paragraph visible again.
14996 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15000 \begin_layout Plain Layout
15001 The commands of interest are:
15004 \begin_layout Itemize
15009 invisible \SpecialChar \ldots{}
15013 \begin_layout Itemize
15018 visible \SpecialChar \ldots{}
15022 \begin_layout Plain Layout
15023 \SpecialChar \ldots{}
15024 and need to be marked as TeX.
15026 \begin_inset Quotes eld
15030 \begin_inset Quotes erd
15033 you wish to change goes in between the brackets [and after the
15046 If you don't know how to mark text as TeX, see the appropriate section
15059 \begin_layout Subsubsection
15069 \begin_inset CommandInset label
15071 name "sec:slideNote"
15078 \begin_layout Standard
15087 is associated with a
15088 \begin_inset Quotes eld
15092 \begin_inset Quotes erd
15104 class provides visual cues.
15109 is shorter than that of a
15113 [yet longer than that of an
15117 ] and, like the label of an
15121 is shockingly magenta.
15122 Additionally, the printed
15126 has the page number of its
15127 \begin_inset Quotes eld
15131 \begin_inset Quotes erd
15139 \begin_inset Quotes eld
15147 \begin_inset Quotes erd
15151 \begin_inset Quotes eld
15159 \begin_inset Quotes erd
15163 \begin_inset Quotes eld
15171 \begin_inset Quotes erd
15175 You can have multiple
15179 s associated with a single
15191 , you'll probably want to break up long
15195 s so that they fit on a single sheet of paper.
15198 \begin_layout Standard
15203 is obvious: it contains anything additional you might want to say about
15209 It could also be used as a sheet of reminders for a particular
15214 In the case of the latter, you might want to make use of time markers.
15220 \begin_inset Quotes eld
15224 \begin_inset Quotes erd
15227 support for time markers, a
15232 So, you'll have to resort to using the LaTeX codes.
15235 \begin_layout Standard
15236 To use time markers, you'll need to specify the extra class option
15237 \begin_inset Quotes eld
15245 \begin_inset Quotes erd
15249 \begin_inset space ~
15253 \begin_inset CommandInset ref
15255 reference "sec:slidesetup"
15260 This option turns on timing marks, which will appear in the lower-left-hand
15266 To set what appears in the time marker, you use the LaTeX commands
15267 \begin_inset Quotes eld
15277 \begin_inset Quotes erd
15281 \begin_inset Quotes eld
15291 \begin_inset Quotes erd
15295 The arguments of both commands are time measured in seconds.
15297 \begin_inset Quotes eld
15307 \begin_inset Quotes erd
15310 sets the time marker to a given time.
15312 \begin_inset Quotes eld
15322 \begin_inset Quotes erd
15325 increments the time marker by the specified amount.
15326 Using time markers and
15330 s in this fashion, you can remind yourself how much time to spend on a particula
15338 \begin_layout Standard
15339 There's one last feature to describe.
15340 Clearly, you'd like to print out all of your
15348 s on transparencies while printing all of your
15365 with which it is associated.
15366 What's a person to do?
15369 \begin_layout Standard
15370 Luckily, there are two LaTeX commands that allow you to select what to print
15372 Both must be placed into the preamble of your document.
15374 \begin_inset Quotes eld
15386 \begin_inset Quotes erd
15389 will cause the output to contain only the
15398 Correspondingly, the command
15399 \begin_inset Quotes eld
15411 \begin_inset Quotes erd
15414 prevents the output of anything but
15419 I'd advise placing both commands in the preamble and initially comment
15421 You can then preview your entire presentation as you write.
15422 When you're done writing, you can then uncomment one of the two to select
15423 what you want to print.
15424 I like to uncomment
15425 \begin_inset Quotes eld
15437 \begin_inset Quotes erd
15440 , print to a file with
15441 \begin_inset Quotes eld
15449 \begin_inset Quotes erd
15452 in its name, comment it back out, then uncomment
15453 \begin_inset Quotes eld
15465 \begin_inset Quotes erd
15469 \begin_inset Quotes eld
15477 \begin_inset Quotes erd
15481 I can then send either file to a printer, loading transparencies or plain
15482 paper as appropriate.
15485 \begin_layout Standard
15486 You can also provide other arguments to the
15487 \begin_inset Quotes eld
15497 \begin_inset Quotes erd
15501 \begin_inset Quotes eld
15511 \begin_inset Quotes erd
15515 See a good LaTeX book for details.
15518 \begin_layout Subsection
15523 Class Template File
15526 \begin_layout Standard
15527 I have also provided a template file,
15528 \begin_inset Quotes eld
15536 \begin_inset Quotes erd
15544 To use it, begin your new presentation with
15549 ile\SpecialChar \menuseparator
15551 \begin_inset space ~
15555 \begin_inset space ~
15565 Your new LyX presentation file will contain an example
15586 additionally contain an example of the use of
15595 Lastly, the preamble will contain:
15598 \begin_layout LyX-Code
15599 % Uncomment to print out only slides and overlays
15602 \begin_layout LyX-Code
15606 \begin_layout LyX-Code
15612 \begin_inset Newline newline
15618 \begin_layout LyX-Code
15619 % Uncomment to print out only notes
15622 \begin_layout LyX-Code
15626 \begin_layout LyX-Code
15634 \begin_layout Standard
15635 One final thing: I created this class to support the LaTeX2e
15636 \begin_inset Quotes eld
15644 \begin_inset Quotes erd
15647 class, one of the built-in LaTeX2e classes.
15648 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15649 built-in slide class.
15650 It's here if you want it or need it.
15651 There exist other LaTeX2e classes for creating presentations, such as the
15657 \begin_inset space ~
15661 \begin_inset CommandInset ref
15663 reference "sec:foiltex"
15668 \begin_inset Quotes eld
15676 \begin_inset Quotes erd
15679 package [present on some TeX distributions].
15680 The latter is not yet supported under LyX.
15684 \begin_layout Plain Layout
15685 Perhaps you can take on the task\SpecialChar \ldots{}
15691 I know nothing about these other classes.
15692 Try them out to see what sort of alternative they provide.
15695 \begin_layout Chapter
15696 LyX Features needing Extra Software
15699 \begin_layout Section
15703 \begin_layout Standard
15709 \begin_layout Subsection
15713 \begin_layout Standard
15722 \begin_layout Plain Layout
15727 is not available for Windows.
15732 , you'll find in the
15739 \begin_inset space ~
15750 \begin_inset CommandInset href
15752 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15759 \begin_layout Standard
15764 package is a program that was written by
15765 \begin_inset Flex CharStyle:Noun
15768 \begin_layout Plain Layout
15770 \begin_inset space ~
15778 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15779 and easy to forget.
15780 The program runs over your LaTeX file, checks the integrity of the file,
15781 and flags some common errors.
15782 In other technical words, it is
15789 \begin_layout Standard
15790 Well, what is a syntax checker doing in LyX which is supposed to produce
15791 correct LaTeX anyways? The answer is simple: Just as
15795 not only checks the
15799 of C programs, but also does
15803 checks for type-errors,
15807 catches some common
15811 errors, in addition to the syntactical ones.
15816 is capable of detecting several common errors, such as
15819 \begin_layout Itemize
15820 Ellipsis detection:
15821 \begin_inset Newline newline
15824 Use \SpecialChar \ldots{}
15828 \begin_layout Itemize
15829 No space in front of/after parenthesis:
15830 \begin_inset Newline newline
15836 \begin_layout Itemize
15837 Enforcement of normal space after common abbreviations:
15838 \begin_inset Newline newline
15842 \begin_inset space \thinspace{}
15846 \begin_inset space \space{}
15849 is too wide spacing.
15852 \begin_layout Itemize
15853 Enforcement of end-of-sentence space when the last sentence ends with a
15855 \begin_inset Newline newline
15859 And this is wrong spacing.
15862 \begin_layout Itemize
15863 Space in front of labels and similar commands:
15864 \begin_inset Newline newline
15867 The label should stick right up to the text to avoid falling to a wrong
15870 \begin_inset CommandInset label
15880 \begin_layout Plain Layout
15881 This footnote is in danger of falling off to a wrong page
15886 The label is separated too much.
15889 \begin_layout Itemize
15890 Space in front of references, instead of hard spaces:
15891 \begin_inset Newline newline
15894 In you are in bad luck, the text will break right between the referenced
15895 text and reference number, and that's a pity.
15897 \begin_inset CommandInset ref
15899 reference "sec:chktex"
15906 \begin_layout Itemize
15908 \begin_inset Quotes eld
15912 \begin_inset Quotes erd
15916 \begin_inset Formula $\times$
15920 \begin_inset Newline newline
15923 2x2 looks cheap compared to
15924 \begin_inset Formula $2\times2$
15930 \begin_layout Standard
15931 and more \SpecialChar \ldots{}
15932 It is an invaluable tool when you are
15933 \begin_inset Quotes eld
15937 \begin_inset Quotes erd
15940 your document before printing, and you should run it right after the obligatory
15941 spelling check, and before you go fine tuning the typesetting.
15944 \begin_layout Subsection
15948 \begin_layout Standard
15949 If you have the program installed, usage is as simple as choosing
15951 Tools\SpecialChar \menuseparator
15953 \begin_inset space ~
15959 This will make LyX generate a LaTeX file of your document, start
15963 to check it, and then make LyX insert
15964 \begin_inset Quotes eld
15968 \begin_inset Quotes erd
15971 with the warnings from
15975 , if there were any.
15976 The warnings will be placed close to the point of the mistake, and you
15977 can quickly find them by using the
15979 Navigate\SpecialChar \menuseparator
15982 menu item, or the shortcut key
15991 Open the error boxes by clicking on them with the mouse, or use the shortcut
16000 bindings, or the corresponding
16009 Read the warning and correct the mistake, if it is a mistake.
16010 If you have trouble understanding what the warning is about, you can safely
16012 Remember that there is a hidden layer between the document on screen and
16013 the technical details in invoking
16017 , and this gap can make some warnings seem arcane or just right down plain
16021 \begin_layout Standard
16022 This document is an excellent testing bed for the feature, and it should
16023 provide quite a few warnings for you to fiddle with.
16024 Since computers are only so smart, expect most of the warnings to be false
16028 \begin_layout Subsection
16029 How to fine tune it
16032 \begin_layout Standard
16033 Sometimes, you'll find that
16037 makes more noise than suits your mood.
16038 Then you can choose not to use it, wait until your mood changes, or try
16043 to get better along with you.
16044 Another choice in the most desperate situations is to use
16046 View\SpecialChar \menuseparator
16048 \begin_inset space ~
16052 \begin_inset space ~
16056 \begin_inset space ~
16061 , which will get rid of all warnings instantly.
16064 \begin_layout Standard
16073 very configurable and extensible, you shouldn't expect to solve all problems
16079 Since LyX has to generate a somewhat special LaTeX file to be able to match
16080 the line numbers from the
16088 \begin_layout Plain Layout
16089 You can inspect the specific output from
16095 Edit\SpecialChar \menuseparator
16097 \begin_inset space ~
16101 \begin_inset space ~
16115 to the internal document structure, some of the warnings will not seen
16116 to appear correctly.
16117 There are two things you can do about this:
16120 \begin_layout Itemize
16125 invocation command line in
16141 installation configuration file (usually with the file
16146 See below to learn what warnings can be enabled and disabled on the command
16151 \begin_layout Itemize
16152 Export your document as a raw LaTeX file using
16154 File\SpecialChar \menuseparator
16155 Export\SpecialChar \menuseparator
16163 Invoked in this way, it can be a hassle to find the corresponding place
16164 in the document inside LyX, but with a little patience, you should be able
16168 \begin_layout Standard
16169 Here follows the warning messages that can be enabled and disabled in
16178 to disable a warning, and
16182 to enable a warning.
16183 The emphasized entries are disabled by default, because the default is
16186 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16191 \begin_layout Standard
16192 Notice that you should only use the options that enable and disable warnings,
16193 because LyX relies on some of the other command line parameters to be set
16194 in a specific way to have a chance to communicate with
16201 \begin_layout Enumerate
16205 Command terminated with space.
16208 \begin_layout Enumerate
16211 Non-breaking space (
16212 \begin_inset Quotes eld
16220 \begin_inset Quotes erd
16223 ) should have been used.
16226 \begin_layout Enumerate
16230 You should enclose the previous parenthesis with
16231 \begin_inset Quotes eld
16239 \begin_inset Quotes erd
16245 \begin_layout Enumerate
16248 Italic correction (
16249 \begin_inset Quotes eld
16259 \begin_inset Quotes erd
16262 ) found in non-italic buffer.
16265 \begin_layout Enumerate
16268 Italic correction (
16269 \begin_inset Quotes eld
16279 \begin_inset Quotes erd
16282 ) found more than once.
16285 \begin_layout Enumerate
16289 No italic correction (
16290 \begin_inset Quotes eld
16300 \begin_inset Quotes erd
16306 \begin_layout Enumerate
16310 \begin_inset Quotes eld
16318 \begin_inset Quotes erd
16322 \begin_inset Quotes eld
16330 \begin_inset Quotes erd
16336 \begin_layout Enumerate
16339 Wrong length of dash may have been used.
16342 \begin_layout Enumerate
16346 \begin_inset Quotes eld
16354 \begin_inset Quotes erd
16358 \begin_inset Quotes eld
16366 \begin_inset Quotes erd
16372 \begin_layout Enumerate
16376 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16390 \begin_layout Enumerate
16394 \begin_inset Quotes eld
16402 \begin_inset Quotes erd
16405 to achieve an ellipsis.
16408 \begin_layout Enumerate
16411 Inter-word spacing (
16412 \begin_inset Quotes eld
16422 \begin_inset Quotes eld
16425 ) should perhaps be used.
16428 \begin_layout Enumerate
16431 Inter-sentence spacing (
16432 \begin_inset Quotes eld
16442 \begin_inset Quotes erd
16445 ) should perhaps be used.
16448 \begin_layout Enumerate
16451 Could not find argument for command.
16454 \begin_layout Enumerate
16458 \begin_inset Quotes eld
16466 \begin_inset Quotes erd
16472 \begin_layout Enumerate
16475 Math mode still on at end of LaTeX file.
16478 \begin_layout Enumerate
16482 \begin_inset Quotes eld
16490 \begin_inset Quotes erd
16493 doesn't match the number of
16494 \begin_inset Quotes eld
16502 \begin_inset Quotes erd
16508 \begin_layout Enumerate
16511 You should use either
16514 \begin_inset Quotes eld
16522 \begin_inset Quotes erd
16527 as an alternative to
16528 \begin_inset Quotes eld
16536 \begin_inset Quotes erd
16542 \begin_layout Enumerate
16549 " (ASCII 39) instead of "
16556 \begin_layout Enumerate
16559 User-specified pattern found.
16562 \begin_layout Enumerate
16565 This command might not be intended.
16568 \begin_layout Enumerate
16575 \begin_layout Enumerate
16593 \begin_layout Enumerate
16596 Delete this space to maintain correct page references.
16599 \begin_layout Enumerate
16603 You might wish to put this between a pair of
16604 \begin_inset Quotes eld
16612 \begin_inset Quotes erd
16618 \begin_layout Enumerate
16621 You ought to remove spaces in front of punctuation.
16624 \begin_layout Enumerate
16627 Could not execute LaTeX command.
16630 \begin_layout Enumerate
16639 in front of small punctuation.
16642 \begin_layout Enumerate
16650 may look prettier here.
16653 \begin_layout Enumerate
16657 Multiple spaces detected in output.
16660 \begin_layout Enumerate
16663 This text may be ignored.
16666 \begin_layout Enumerate
16672 \begin_inset Quotes eld
16677 to begin quotation, not
16684 \begin_layout Enumerate
16691 to end quotation, not
16694 \begin_inset Quotes eld
16702 \begin_layout Enumerate
16708 \begin_layout Enumerate
16711 You should perhaps use
16712 \begin_inset Quotes eld
16720 \begin_inset Quotes erd
16726 \begin_layout Enumerate
16729 You should put a space in front of/after parenthesis.
16732 \begin_layout Enumerate
16735 You should avoid spaces in front of/after parenthesis.
16738 \begin_layout Enumerate
16742 You should not use punctuation in front of/after quotes.
16745 \begin_layout Enumerate
16748 Double space found.
16751 \begin_layout Enumerate
16754 You should put punctuation outside inner/inside display math mode.
16757 \begin_layout Enumerate
16760 You ought to not use primitive TeX in LaTeX code.
16763 \begin_layout Enumerate
16766 You should remove spaces in front of
16767 \begin_inset Quotes eld
16775 \begin_inset Quotes erd
16781 \begin_layout Enumerate
16784 \begin_inset Quotes eld
16792 \begin_inset Quotes erd
16795 is normally not followed by
16796 \begin_inset Quotes eld
16804 \begin_inset Quotes erd
16810 \begin_layout Standard
16811 In later versions of LyX, we hope to provide a more complete interface to
16812 this tool (and it's smaller cousin
16816 ) to exploit the full power of it.
16817 But it's not exactly useless as it is now: go try it on one of your existing
16818 documents of a certain length and be surprised.
16821 \begin_layout Section
16822 Version Control in LyX
16825 \begin_layout Standard
16828 Lars Gullik Bjønnes,
16835 \begin_layout Subsection
16839 \begin_layout Standard
16840 A friend of mine wanted to try LyX for a group project.
16841 When he didn't find support for version control or file locking, he dropped
16843 This angered me a bit, so I thought that I should at least make support
16844 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16845 This has now been done.
16846 LyX now supports some of the most basic RCS commands.
16847 If you need to something a bit more sophisticated you will have to do that
16848 manually in an xterm.
16851 \begin_layout Standard
16852 Before you begin to use the version control features in LyX, you should
16854 \begin_inset Quotes eld
16858 \begin_inset Quotes erd
16861 (a man file, read it with
16866 This file describes all the basic features of RCS.
16867 You should especially notice the comment about a RCS directory, and the
16868 notion of a master RCS file (the file ending in
16875 \begin_layout Standard
16876 Later basic CVS/SVN support was added.
16877 You should be familiar with CVS/SVN usage before start using it under LyX.
16878 Most of the log messages are not currently displayed after operations -
16879 you can check them in terminal window if unsure.
16882 \begin_layout Standard
16883 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16884 package---no guarantees are made for older versions.
16887 \begin_layout Subsection
16888 RCS commands in LyX
16891 \begin_layout Standard
16892 The following sections describe the RCS commands supported by LyX.
16893 You can find them in the
16898 ile\SpecialChar \menuseparator
16904 \begin_inset space ~
16912 \begin_layout Subsubsection
16918 \begin_layout Standard
16919 If your document is not under revision control, this is the only item shown
16921 And if it is under revision control, the
16928 item is not visible.
16932 \begin_layout Standard
16933 This command registers your document with RCS (unless you are under the
16934 directory managed by CVS)\SpecialChar \@.
16935 You are asked interactively to supply an initial
16936 description of the document.
16937 The document is now set in Read-Only mode and you have to
16940 \begin_inset space ~
16944 \begin_inset space ~
16948 \begin_inset space ~
16953 , before making any changes to it.
16954 A document under revision control has a
16955 \begin_inset Quotes eld
16958 [RCS:<version> <locker>]
16959 \begin_inset Quotes erd
16962 item tagged to the filename in the minibuffer.
16965 \begin_layout Standard
16966 RCS command that is run:
16968 ci -q -u -i -t-"<initial description>" <file-name>
16971 \begin_layout Standard
16976 to understand the switches.
16980 \begin_layout Subsubsection
16986 \begin_layout Standard
16987 When you are finished editing a file, you check in your changes.
16988 When you do this, you are asked for a description of the changes.
16989 This is stored in the history log.
16990 The version number is bumped, your changes are applied to the master RCS
16991 file, the document is unlocked and set to Read-Only mode.
16995 \begin_layout Standard
16998 ci -q -u -m"<description>" <file-name>
17001 \begin_layout Subsubsection
17007 \begin_layout Standard
17008 By doing this you lock the document so that only you can edit it.
17009 This will also make the document Read-Write only for you.
17010 You will usually continue editing for a while and when you are finished
17011 you check in your changes.
17012 The status line is changed to reflect that you have locked the file.
17016 \begin_layout Standard
17019 co -q -l <file-name>
17022 \begin_layout Subsubsection
17025 Revert To Repository Version
17028 \begin_layout Standard
17029 This will discard all changes made to the document since the last check
17031 You get a warning before changes are discarded.
17034 \begin_layout Standard
17037 co -f -u<version> <file-name>
17040 \begin_layout Subsubsection
17046 \begin_layout Standard
17047 This makes as if the last check in never happened.
17048 No changes are made to the document loaded into LyX, but the last version
17049 is removed from the master RCS file.
17053 \begin_layout Standard
17056 rcs -o<version> <file-name>
17059 \begin_layout Subsubsection
17065 \begin_layout Standard
17066 This show the complete history of the RCS document.
17071 is shown in a browser.
17079 \begin_layout Subsection
17080 CVS commands in LyX
17083 \begin_layout Standard
17084 CVS is now partially supported by LyX.
17085 You can find the commands in the
17090 ile\SpecialChar \menuseparator
17096 \begin_inset space ~
17104 \begin_layout Subsubsection
17110 \begin_layout Standard
17111 If your document is not under revision control, this is the only item shown
17113 And if it is under revision control, the
17120 item is not visible.
17124 \begin_layout Standard
17125 This command registers in CVS your document ONLY in case you have already
17126 the documents directory under CVS control (in particular
17131 This means you have to checkout the archive by yourself.
17135 \begin_layout Standard
17136 Then you are asked interactively to supply an initial description of the
17138 Don't forget that registered file is not yet commited.
17141 \begin_layout Standard
17142 CVS command that is run:
17145 \begin_inset Quotes erd
17149 \begin_inset Quotes eld
17153 \begin_inset Quotes erd
17159 \begin_layout Standard
17164 to understand the switches.
17168 \begin_layout Subsubsection
17174 \begin_layout Standard
17175 When you are finished editing a file, you commit your changes.
17176 When you do this, you are asked for a description of the changes.
17177 After that changes are commited.
17180 \begin_layout Standard
17183 cvs -q commit -m"<description>" <file-name>
17186 \begin_layout Subsubsection
17189 Revert To Repository Version
17192 \begin_layout Standard
17193 This will discard all changes made to the document since the last check
17195 You get a warning before changes are discarded.
17196 Firstly the file is deleted, secondly CVS update command is run.
17199 \begin_layout Standard
17203 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17213 \begin_layout Subsubsection
17219 \begin_layout Standard
17220 This show the complete history of the CVS document.
17224 \begin_inset Quotes eld
17228 \begin_inset Quotes erd
17233 is shown in a browser.
17236 \begin_layout Subsection
17237 SVN commands in LyX
17240 \begin_layout Standard
17241 SVN is now partially supported by LyX.
17242 You can find the commands in the
17247 ile\SpecialChar \menuseparator
17253 \begin_inset space ~
17259 Please note that if you use password protected access to repository via
17260 ssh, you will be asked in terminal window.
17263 \begin_layout Subsubsection
17269 \begin_layout Standard
17270 If your document is not under revision control, this is the only item shown
17272 And if it is under revision control, the
17279 item is not visible.
17283 \begin_layout Standard
17284 This command registers in SVN your document ONLY in case you have already
17285 the documents directory under SVN control (in particular
17290 This means you have to checkout the archive by yourself.
17294 \begin_layout Standard
17295 Then you are asked interactively to supply an initial description of the
17297 Don't forget that registered file is not yet commited.
17300 \begin_layout Standard
17301 SVN command that is run:
17304 \begin_inset Quotes eld
17308 \begin_inset Quotes erd
17314 \begin_layout Standard
17319 to understand the switches.
17323 \begin_layout Subsubsection
17329 \begin_layout Standard
17330 When you are finished editing a file, you commit your changes.
17331 When you do this, you are asked for a description of the changes.
17332 After that changes are commited.
17335 \begin_layout Standard
17338 svn commit -q -m"<description>" <file-name>
17341 \begin_layout Subsubsection
17347 \begin_layout Standard
17348 Updates the changes of this file from the repository.
17349 Be sure you understand SVN merging and conflicts resolving before using
17350 this function, because all conflicts has to be done manually by you!
17353 \begin_layout Standard
17357 \begin_inset Quotes eld
17361 \begin_inset Quotes erd
17367 \begin_layout Subsubsection
17370 Revert To Repository Version
17373 \begin_layout Standard
17374 This will discard all changes made to the document since the last check
17376 You get a warning before changes are discarded.
17380 \begin_layout Standard
17384 \begin_inset Quotes eld
17388 \begin_inset Quotes erd
17394 \begin_layout Subsubsection
17400 \begin_layout Standard
17401 This show the complete history of the SVN document.
17405 \begin_inset Quotes eld
17409 \begin_inset Quotes erd
17414 is shown in a browser.
17417 \begin_layout Section
17418 Literate Programming
17421 \begin_layout Standard
17426 (kayvan@sylvan.com)
17430 original documentation written by
17432 Edmar Wienskoski Jr.
17435 (edmar-w-jr@technologist.com)
17438 \begin_layout Subsection
17442 \begin_layout Standard
17443 The main purpose of this documentation is to show you how to use LyX for
17444 literate programming.
17445 Where it is assumed that you are familiar with this programming technique,
17447 \begin_inset Quotes eld
17451 \begin_inset Quotes erd
17455 \begin_inset Quotes eld
17459 \begin_inset Quotes erd
17463 If that is not the case, please follow the web links provided in the following
17465 There is a lot of good documentation out there covering old development
17466 history to the latest tools tips.
17469 \begin_layout Standard
17470 It is also assumed that you are familiar with LyX itself to a point that
17471 you are comfortable changing your LyX preferences, and X resources file.
17472 If that is not the case please refer to other LyX documentation to cover
17473 your specific needs.
17476 \begin_layout Subsection
17477 Literate Programming
17480 \begin_layout Standard
17481 From the Literate Programming FAQ:
17484 \begin_layout Quotation
17485 Literate programming is the combination of documentation and source together
17486 in a fashion suited for reading by human beings.
17487 In fact, literate programs should be enjoyable reading, even inviting!
17488 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17489 and documentation in a single file.
17490 Literate programming tools then parse the file to produce either readable
17491 documentation or compilable source.
17492 The WEB style of literate programming was created by D.
17493 \begin_inset space \thinspace{}
17497 Knuth during the development of his TeX typesetting software.
17501 \begin_layout Standard
17502 Another excerpt says:
17505 \begin_layout Quotation
17508 How is literate programming different from verbose commenting?
17511 \begin_layout Quotation
17512 There are three distinguishing characteristics.
17513 In order of importance, they are:
17517 \begin_layout Itemize
17518 flexible order of elaboration
17521 \begin_layout Itemize
17522 automatic support for browsing
17525 \begin_layout Itemize
17526 typeset documentation, especially diagrams and mathematics
17530 \begin_layout Standard
17531 Now that I sparked your curiosity, take a look in the references.
17534 \begin_layout Subsubsection
17538 \begin_layout Standard
17539 The complete Literate Programming FAQ can be found at:
17542 \begin_layout Quote
17543 Literate Programming FAQ
17544 \begin_inset Flex URL
17547 \begin_layout Plain Layout
17549 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17557 \begin_layout Standard
17558 The FAQ lists 23 (twenty three!) different literate programming tools.
17559 Where some are specialized or
17560 \begin_inset Quotes eld
17564 \begin_inset Quotes erd
17567 for particular programming languages, while other have general scope.
17572 for my own use for several reasons:
17575 \begin_layout Itemize
17576 It can generate the documentation either in LaTeX or HTML.
17579 \begin_layout Itemize
17580 It has a open architecture, i.
17581 \begin_inset space \thinspace{}
17585 \begin_inset space \space{}
17588 it is easy to plug in new filters and to perform special processing that
17593 \begin_layout Itemize
17594 There is a good selection of filters available already (the HTML is one
17598 \begin_layout Itemize
17602 \begin_layout Standard
17603 The Noweb web page can be found at:
17606 \begin_layout Quote
17608 \begin_inset Flex URL
17611 \begin_layout Plain Layout
17613 http://www.cs.virginia.edu/~nr/noweb/
17621 \begin_layout Standard
17622 Starting from there you can reach many other interesting links and even
17623 some literate program examples.
17626 \begin_layout Subsection
17627 LyX and Literate Programming
17630 \begin_layout Standard
17631 The LyX support for Literate Programming is provided by using the generic
17632 LyX converters mechanism.
17633 This support is provided in a
17634 \begin_inset Quotes eld
17638 \begin_inset Quotes erd
17642 \begin_inset space \thinspace{}
17646 \begin_inset space \space{}
17649 you will be able to use this new LyX feature with some other literate programmin
17650 g tool of your choice by just changing your LyX preferences.
17653 \begin_layout Subsubsection
17654 Generating documents and code (weaving and tangling)
17657 \begin_layout Paragraph
17658 Selecting the document class
17661 \begin_layout Standard
17662 If you have installed Noweb and LyX successfully, whenever you open a new
17663 document or try to change the document class of an existing one, you will
17664 find that there are three new document classes available:
17667 \begin_layout Itemize
17671 \begin_layout Itemize
17675 \begin_layout Itemize
17679 \begin_layout Standard
17680 You must select one of them to create your literate documents from.
17684 \begin_layout Standard
17685 Note that literate documents are not limited to these three classes.
17686 New classes can be generated from other styles like letter or in combination
17687 with other class variations like Article (AMS).
17688 If you have special needs that cannot be covered by one of the existing
17689 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17690 will arrange to insert a new entry, or teach you how to do it.
17694 \begin_layout Plain Layout
17695 It is very simple, it involves the creation of a file with four lines, and
17696 re-running of the auto configuration.
17701 Moreover, if you use a literate tool other than Noweb you may need to create
17702 a new set of document classes for it.
17705 \begin_layout Paragraph
17709 \begin_layout Standard
17710 LyX enables you to write code with a layout named
17718 \begin_layout Plain Layout
17719 The equivalent Noweb term is
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17728 For historical reasons, I got used to the term
17729 \begin_inset Quotes eld
17733 \begin_inset Quotes erd
17736 introduced by other literate tool named Nuweb, which I used for many years
17737 before rendering myself to Noweb.
17742 Noweb delimits scraps like this:
17745 \begin_layout LyX-Code
17749 \begin_layout LyX-Code
17753 \begin_layout LyX-Code
17757 \begin_layout LyX-Code
17761 \begin_layout LyX-Code
17765 \begin_layout Standard
17766 The problem is that whatever is written in between the << and the
17770 must be taken literally, i.
17771 \begin_inset space \thinspace{}
17775 \begin_inset space \space{}
17778 LyX should be prevented from making any special interpretation of what has
17780 This is handled by a special layout named Scrap, that works like a normal
17781 paragraph but has a free spacing capability.
17784 \begin_layout Standard
17785 The down side of the Scrap paragraph layout is that consecutive paragraphs
17786 of code will be spaced with one empty line in the source code and also
17787 in the printed documentation.
17788 The work around is to enter each line of code within a single Scrap, with
17789 a newline (ctrl-return).
17790 The example above will look like this:
17794 \begin_layout Plain Layout
17795 If you have a printed version of this document you will not see any difference
17796 between the previous example and this one.
17804 \begin_layout LyX-Code
17806 \begin_inset Newline newline
17810 \begin_inset Newline newline
17814 \begin_inset Newline newline
17818 \begin_inset Newline newline
17824 \begin_layout Standard
17825 This layout works fine.
17826 The only real inconvenience is that you have to type ctrl-return instead
17831 \begin_layout Plain Layout
17832 It is in my list of
17833 \begin_inset Quotes eld
17837 \begin_inset Quotes erd
17848 \begin_layout Standard
17849 As a special note, you can also use the
17850 \begin_inset Quotes eld
17854 \begin_inset Quotes erd
17857 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17861 \begin_layout LyX-Code
17863 \begin_inset Newline newline
17866 def some_function(args):
17867 \begin_inset Newline newline
17870 "This is the doc string for this function."
17871 \begin_inset Newline newline
17874 print "My args: ", args
17877 \begin_layout LyX-Code
17878 @ %def some_function
17881 \begin_layout Standard
17882 For an example of this usage and the resulting cross-reference output, look
17883 at the Literate python program in
17885 LIBDIR/examples/listerrors.lyx
17887 which should make this all clear.
17890 \begin_layout Paragraph
17891 Generating the documentation
17894 \begin_layout Standard
17895 At this point you already have a new document file with a proper document
17896 class, and with some code and text on it.
17897 How do I print it? The answer is simple, you select
17902 iew\SpecialChar \menuseparator
17910 Just like you would do for a plain document.
17911 No special procedure is required.
17914 \begin_layout Standard
17915 To help orientate you, I will now explain what happens inside LyX:
17918 \begin_layout Enumerate
17921 Update\SpecialChar \menuseparator
17924 menu option is chosen, a LaTeX file is generated.
17929 \begin_layout Standard
17930 If the document is of any literate class the generated file will be named
17931 with an extension name defined by the
17932 \begin_inset Quotes eld
17936 \begin_inset Quotes erd
17939 format (defined in the Preferences panel), otherwise the file will have
17948 \begin_layout Enumerate
17949 Note that the only difference so far is in the name of the file, no special
17950 processing is required by LyX.
17951 Given that you formatted the code using the Scrap layout that, by itself,
17952 takes care of the business.
17955 \begin_layout Enumerate
17956 If the document is of any literate class LyX will then use the internal
17957 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17961 \begin_layout Plain Layout
17962 The converters are defined in the
17964 Tools\SpecialChar \menuseparator
17968 \begin_inset Quotes eld
17972 \begin_inset Quotes erd
17984 manual for general information about converters.
17989 to generate the LaTeX file.
17993 \begin_layout Standard
17994 Otherwise it will just skip this step.
17998 \begin_layout Enumerate
17999 Finally, LaTeX is invoked and the regular post processing continues as in
18003 \begin_layout Standard
18004 Independence from a particular
18005 \begin_inset Quotes eld
18009 \begin_inset Quotes erd
18012 is easily achieved by changing the commands that are run by the various
18016 \begin_layout Paragraph
18017 Generating the code
18020 \begin_layout Standard
18021 When the build menu option is chosen or the corresponding button in the
18022 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18023 Next, LyX invokes the
18028 This converter needs to be defined by the user and is not installed by
18029 default, though the Program format is.
18030 This converter (like any other converter) will have two parts:
18033 \begin_layout Enumerate
18034 The converter program itself.
18035 This program performs the conversion from the one format to the other (in
18036 this case, from the Noweb format to the Program pseudo-format).
18039 \begin_layout Enumerate
18040 The error log parser.
18041 This is a program whose sole purpose is to rewrite error messages in a
18042 format that LyX understands.
18043 This makes it possible for LyX to place error boxes in the right places
18044 in the file buffer.
18047 \begin_layout Standard
18048 The first part, the
18049 \begin_inset Quotes eld
18053 \begin_inset Quotes erd
18056 setting, should be set to
18057 \begin_inset Quotes eld
18065 \begin_inset Quotes erd
18069 This basically means that LyX will call
18070 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18077 (a program or script) with the name of the Noweb file (normally a file
18078 in the LyX temp directory).
18082 \begin_layout Standard
18083 This is an implementation of
18084 \begin_inset Quotes eld
18088 \begin_inset Quotes erd
18091 that you can place in a directory on your path:
18094 \begin_layout LyX-Code
18098 \begin_layout LyX-Code
18102 \begin_layout LyX-Code
18103 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18106 \begin_layout Standard
18107 The next part of the converter setting is the
18108 \begin_inset Quotes eld
18112 \begin_inset Quotes erd
18115 which is to be set to
18116 \begin_inset Quotes eld
18121 parselog=listerrors
18124 \begin_inset Quotes erd
18128 This will run any errors that are generated by the
18129 \begin_inset Quotes eld
18133 \begin_inset Quotes erd
18136 process through the
18137 \begin_inset Quotes eld
18141 \begin_inset Quotes erd
18147 \begin_layout Standard
18148 The converter code looks in
18156 then on the path for the
18157 \begin_inset Quotes eld
18161 \begin_inset Quotes erd
18167 \begin_layout Standard
18168 The build will normally take place in LyX's temporary directory, so the
18169 files produced by the conversion will be in that directory.
18170 LyX will copy out what it regards as the `main' file, but the
18174 conversion may produce several files, and so most of these would then be
18175 deleted when LyX was closed.
18176 The present solution is to use a `copier',
18180 \begin_layout Plain Layout
18189 manual for information on these.
18198 script in its default mode, so that the entire contents of the temporary
18199 directory is copied.
18200 More will get copied than is needed, to be sure, but nothing will be lost.
18201 If, however, you know what extensions the generated files will have, this
18202 can be improved by using the
18211 This option takes a comma-separated list of extensions to copy.
18212 So, for example, if the conversion will generate only files with the extensions
18221 , then the correct definition would be:
18224 \begin_layout LyX-Code
18225 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18228 \begin_layout Standard
18229 The result will be that only files with these two extensions will be copied
18233 \begin_layout Paragraph
18234 Build instructions in the document
18237 \begin_layout Standard
18238 The last piece of the integration between LyX and noweb is the
18239 \begin_inset Quotes eld
18243 \begin_inset Quotes erd
18247 Generally, the instructions for building your program should be embedded
18248 in a scrap of its own.
18250 \begin_inset Quotes eld
18254 \begin_inset Quotes erd
18257 above uses the notangle command to look for this scrap (called
18258 \begin_inset Quotes eld
18262 \begin_inset Quotes erd
18265 ) and runs its contents through
18266 \begin_inset Quotes eld
18270 \begin_inset Quotes erd
18276 \begin_layout Standard
18277 Typically, such a scrap would look something like this:
18280 \begin_layout LyX-Code
18282 \begin_inset Newline newline
18286 \begin_inset Newline newline
18290 \begin_inset Newline newline
18293 if [ -z "${NOWEB_SOURCE}" ]
18294 \begin_inset Newline newline
18298 \begin_inset Newline newline
18301 NOWEB_SOURCE=myfile.nw
18302 \begin_inset Newline newline
18306 \begin_inset Newline newline
18310 code to extract files ...]
18311 \begin_inset Newline newline
18315 code to compile files ...]
18316 \begin_inset Newline newline
18322 \begin_layout Standard
18325 LIBDIR/examples/listerrors.lyx
18329 LIBDIR/examples/Literate.lyx
18331 which implement two versions of the
18332 \begin_inset Quotes eld
18336 \begin_inset Quotes erd
18339 program for some illustrations of how all of these pieces go together or
18342 LIBDIR/examples/noweb2lyx.lyx.
18345 Interestingly, these three files show off the language-indepence of the
18346 LyX literate programming support since they are written in Python, C and
18350 \begin_layout Subsubsection
18354 \begin_layout Standard
18355 All the Literate Programming support is configured by the
18360 ools\SpecialChar \menuseparator
18368 \begin_inset Quotes eld
18372 \begin_inset Quotes erd
18376 The important parts are:
18379 \begin_layout Description
18381 \begin_inset space ~
18385 \begin_inset Quotes eld
18389 \begin_inset Quotes erd
18393 \begin_inset space ~
18396 format Set up via the Formats tab, this is where the Noweb-specific pieces
18406 , the file extension is set to
18411 This tells LyX to create a file with a
18415 extension in the first step of the conversion process.
18418 \begin_layout Description
18420 \begin_inset space ~
18428 \begin_inset space ~
18431 format This is an empty format whose sole purpose is to be the endpoint
18432 of a conversion (which then allows us to set up a converter for it).
18435 \begin_layout Description
18444 This converter performs the
18445 \begin_inset Quotes eld
18449 \begin_inset Quotes erd
18452 of the literate document.
18453 For Noweb, it is set to
18454 \begin_inset Quotes eld
18459 noweave -delay -index $$i > $$o
18462 \begin_inset Quotes erd
18468 \begin_layout Description
18478 \begin_inset Quotes eld
18482 \begin_inset Quotes erd
18486 As stated above, the Converter is set to
18487 \begin_inset Quotes eld
18495 \begin_inset Quotes erd
18498 , with Flags set to
18499 \begin_inset Quotes eld
18504 originaldir,parselog=listerrors
18507 \begin_inset Quotes erd
18513 \begin_layout Subsubsection
18517 \begin_layout Standard
18518 There is also a new function implemented in the LyX server, the
18519 \begin_inset Quotes eld
18522 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18526 \begin_layout Standard
18527 When debugging code with ddd/gdb, it is possible to invoke a text editor
18528 at the current execution position with a single key stroke.
18529 The default ddd configuration for that is shift-ctrl-V.
18530 It happens that you can define the editor command line invocation in ddd
18536 dit\SpecialChar \menuseparator
18541 references\SpecialChar \menuseparator
18548 dialog and changing the "Edit Sources" entry.
18551 \begin_layout Standard
18552 I take advantage of the new created LyX server function and this ddd feature,
18554 \begin_inset Quotes eld
18558 \begin_inset Quotes erd
18564 \begin_layout LyX-Code
18565 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18568 \begin_layout Standard
18569 With this, whenever you are using ddd and find a point in the program that
18570 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18571 ddd you forward this information to LyX through the LyX server and then
18572 the LyX window will show the same file with the cursor at the same position
18573 ddd was pointing to.
18574 No more guessing or long scrolling to locate a point in the program back
18578 \begin_layout Standard
18579 Note however that you must enable the LyX server to get this feature working
18580 (it is disabled by default).
18581 You can enable it in
18593 ) by entering in the
18598 \begin_inset Quotes eld
18603 /home/<your-home-directory>/.lyx/lyxpipe
18606 \begin_inset Quotes erd
18612 \begin_layout Standard
18613 Read the LyX server documentation in the
18615 Customization Manual
18617 for further information.
18620 \begin_layout Subsubsection
18624 \begin_layout Standard
18625 There are six new buttons that can be added to your LyX toolbar.
18626 Five of these buttons are short cuts to layout styles:
18647 The last one is a short cut to the
18648 \begin_inset Quotes eld
18652 \begin_inset Quotes erd
18659 \begin_layout Standard
18660 LyX has a range of buttons that are available for tool bar customization.
18661 In my toolbar I like to combine the six short cuts above with two more:
18669 \SpecialChar \menuseparator
18677 \SpecialChar \menuseparator
18690 iew\SpecialChar \menuseparator
18698 Here is how it looks like:
18701 \begin_layout LyX-Code
18705 \begin_layout LyX-Code
18709 \begin_layout LyX-Code
18710 Icon "layout Standard"
18713 \begin_layout LyX-Code
18714 Icon "layout Section"
18717 \begin_layout LyX-Code
18718 Icon "layout LaTeX"
18721 \begin_layout LyX-Code
18722 Icon "layout LyX-Code"
18725 \begin_layout LyX-Code
18726 Icon "layout Scrap"
18729 \begin_layout LyX-Code
18733 \begin_layout LyX-Code
18737 \begin_layout LyX-Code
18738 Icon "buffer-typeset"
18741 \begin_layout LyX-Code
18742 Icon "build-program"
18745 \begin_layout LyX-Code
18749 \begin_layout LyX-Code
18753 \begin_layout LyX-Code
18757 \begin_layout LyX-Code
18761 \begin_layout LyX-Code
18765 \begin_layout Subsubsection
18766 Colors customization
18769 \begin_layout Standard
18770 There are a number of colors in LyX that can be customized in
18775 One of the things that bothers people is the LaTeX font color.
18776 The default color is red, since the scraps uses LaTeX font, and there is
18777 a lot of scraps in literate documents, you may get tired of seeing everything
18779 You can change it by going to the tabs
18788 \begin_layout Standard
18789 The next thing is the visible presence of the newline character in the screen.
18790 You can choose the color of this particular character and make it blend
18792 I recommend you choosing a color that is close to the background but not
18793 equal, that way you still can see it is there, but it is not bothering
18798 \begin_layout Chapter
18799 Secrets of the LaTeX Masters
18800 \begin_inset CommandInset label
18809 \begin_layout Standard
18810 Though LyX is a powerful tool, it cannot hope to support everything that
18811 can be done with pure TeX/LaTeX.
18812 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18813 as long as you are not afraid to use that
18814 \begin_inset Quotes eld
18818 \begin_inset Quotes erd
18821 button on the toolbar or add things to the LaTeX preamble.
18822 This section lists some tips, tricks, and otherwise cool ideas to give
18823 your document that extra little flair.
18826 Do try this at home
18828 , just start with something a little smaller and less important than your
18832 \begin_layout Standard
18833 Most ideas in this section require less common files in your LaTeX installation.
18834 If you have a system like teTeX, most will already be available.
18835 A few, however, will need to be downloaded from one of the CTAN archives.
18836 Often, there are several ways to do something, or several LaTeX style files
18837 which do the same thing.
18838 We do not endorse one choice over another, we simply claim that we have
18839 done a particular task with a particular file.
18840 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18843 \begin_layout Section
18847 \begin_layout Standard
18850 Lars Gullik Bjønnes
18853 \begin_layout Subsection
18857 \begin_layout Standard
18858 The aim for this chapter
18862 \begin_layout Plain Layout
18863 Editor's note: Lars' original chapter was a masterful description of how
18869 However, it was too long to flow smoothly in this document.
18870 I have therefore chosen to excerpt the most important sections here (sorry,
18871 Lars); you can read the original chapter (and more of the story!) in the
18874 examples/multicol.lyx
18882 is to show how the LaTeX package
18886 can be used in a LyX document.
18887 As LyX doesn't support the
18891 package natively yet, we have to use some small hacks.
18892 By reading this section it should be obvious how to do this.
18895 \begin_layout Subsection
18899 \begin_layout Standard
18904 package allows switching between one and multicolumn format on the same
18906 Footnotes are handled correctly (for the most part), but will be placed
18907 at the bottom of the page and not under each column.
18908 LaTeX's float mechanism, however, is partly disabled in the current implementat
18910 At the moment only page-wide floats can be used within the scope of the
18914 \begin_layout Subsection
18918 \begin_layout Subsubsection
18922 \begin_layout Standard
18923 If you want to have two columns in your text, you have use LaTeX mode to
18928 begin{multicols}{2}
18930 at the point where you want the two column layout to start, and then
18936 where you want it to end.
18940 \begin_layout Standard
18944 \begin_layout Plain Layout
18948 begin{multicols}{2}
18956 \begin_layout Standard
18961 The Adventure of the Empty House
18964 \begin_inset Newline newline
18969 Sir Arthur Conan Doyle
18972 \begin_layout Standard
18975 It was in the spring of the year 1894 that all London was interested, and
18976 the fashionable world dismayed, by the murder of the Honourable Ronald
18977 Adair under most unusual and inexplicable circumstances.
18978 The public has already learned those particulars of the crime which came
18979 out in the police investigation, but a good deal was suppressed upon that
18980 occasion, since the case for the prosecution was so overwhelmingly strong
18981 that it was not necessary to bring forward all the facts.
18982 Only now, at the end of nearly ten years, am I allowed to supply those
18983 missing links which make up the whole of that remarkable chain.
18984 The crime was of interest in itself, but that interest was as nothing to
18985 me compared to the inconceivable sequel, which afforded me the greatest
18986 shock and surprise of any event in my adventurous life.
18987 Even now, after this long interval, I find myself thrilling as I think
18988 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18989 ty which utterly submerged my mind.
18990 Let me say to that public, which has shown some interest in those glimpses
18991 which I have occasionally given them of the thoughts and actions of a very
18992 remarkable man, that they are not to blame me if I have not shared my knowledge
18993 with them, for I should have considered it my first duty to do so, had
18994 I not been barred by a positive prohibition from his own lips, which was
18995 only withdrawn upon the third of last month.
18998 \begin_layout Standard
19002 \begin_layout Plain Layout
19014 \begin_layout Subsubsection
19018 \begin_layout Standard
19019 The same pattern is used when you want more than two columns:
19022 \begin_layout Standard
19026 \begin_layout Plain Layout
19030 begin{multicols}{3}
19038 \begin_layout Standard
19041 It can be imagined that my close intimacy with Sherlock Holmes had interested
19042 me deeply in crime, and that after his disappearance I never failed to
19043 read with care the various problems which came before the public.
19044 And I even attempted, more than once, for my own private satisfaction,
19045 to employ his methods in their solution, though with indifferent success.
19046 There was none, however, which appealed to me like this tragedy of Ronald
19048 As I read the evidence at the inquest, which led up to a verdict of willful
19049 murder against some person or persons unknown, I realized more clearly
19050 than I had ever done the loss which the community had sustained by the
19051 death of Sherlock Holmes.
19052 There were points about this strange business which would, I was sure,
19053 have specially appealed to him, and the efforts of the police would have
19054 been supplemented, or more probably anticipated, by the trained observation
19055 and the alert mind of the first criminal agent in Europe.
19056 All day, as I drove upon my round, I turned over the case in my mind and
19057 found no explanation which appeared to me to be adequate.
19058 At the risk of telling a twice-told tale, I will recapitulate the facts
19059 as they were known to the public at the conclusion of the inquest.
19062 \begin_layout Standard
19066 \begin_layout Plain Layout
19078 \begin_layout Standard
19079 You can have more than 3 columns if you want to, but that might not be very
19080 pleasant for the eye.
19083 \begin_layout Subsubsection
19084 Columns inside columns
19087 \begin_layout Standard
19088 You can even have columns inside columns:
19091 \begin_layout Standard
19095 \begin_layout Plain Layout
19099 begin{multicols}{2}
19107 \begin_layout Standard
19110 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19111 at that time governor of one of the Australian colonies.
19112 Adair's mother had returned from Australia to undergo the operation for
19113 cataract, and she, her son Ronald, and her daughter Hilda were living together
19117 \begin_layout Standard
19121 \begin_layout Plain Layout
19125 begin{multicols}{2}
19133 \begin_layout Standard
19136 The youth moved in the best society--had, so far as was known, no enemies
19137 and no particular vices.
19138 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19139 had been broken off by mutual consent some months before, and there was
19140 no sign that it had left any very profound feeling behind it.
19141 For the rest {sic} the man's life moved in a narrow and conventional circle,
19142 for his habits were quiet and his nature unemotional.
19143 Yet it was upon this easy-going young aristocrat that death came, in most
19144 strange and unexpected form, between the hours of ten and eleven-twenty
19145 on the night of March 30, 1894.
19148 \begin_layout Standard
19152 \begin_layout Plain Layout
19164 \begin_layout Standard
19167 Ronald Adair was fond of cards--playing continually, but never for such
19168 stakes as would hurt him.
19169 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19170 It was shown that, after dinner on the day of his death, he had played
19171 a rubber of whist at the latter club.
19172 He had also played there in the afternoon.
19177 The evidence of those who had played with him-- Mr.
19178 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19179 and that there was a fairly equal fall of the cards.
19180 Adair might have lost five pounds, but not more.
19181 His fortune was a considerable one, and such a loss could not in any way
19183 He had played nearly every day at one club or other, but he was a cautious
19184 player, and usually rose a winner.
19185 It came out in evidence that, in partnership with Colonel Moran, he had
19186 actually won as much as four hundred and twenty pounds in a sitting, some
19187 weeks before, from Godfrey Milner and Lord Balmoral.
19188 So much for his recent history as it came out at the inquest.
19191 \begin_layout Standard
19195 \begin_layout Plain Layout
19207 \begin_layout Standard
19208 Please do read the file
19210 examples/multicol.lyx
19212 for more advanced examples including column and header spacing, vertical
19213 separator lines, and more.
19216 \begin_layout Section
19221 Paragraph Environment
19222 \begin_inset OptArg
19225 \begin_layout Plain Layout
19226 Numbering in Enumerate
19234 \begin_layout Standard
19240 \begin_layout Standard
19241 \begin_inset VSpace bigskip
19247 \begin_layout Standard
19249 The default numbering for the
19253 paragraph environment begins with Arabic numbers and ends with uppercase
19255 Suppose, however, you wanted a different type of numbering scheme.
19256 Here's a quickie example of how to change the numbering scheme:
19259 \begin_layout LyX-Code
19269 \begin_layout LyX-Code
19279 \begin_layout LyX-Code
19289 \begin_layout LyX-Code
19299 \begin_layout Standard
19300 \SpecialChar \ldots{}
19301 which changes the numbering scheme to uppercase Roman numerals, uppercase
19302 letters, Arabic numbers, and lowercase letter.
19305 \begin_layout Standard
19306 Additionally, the previous example also adds a little bit extra to the numbering
19308 For example, the first level label actually looks like:
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19317 For ease of reading, we'll describe what the numbering schemes look like
19318 using a notation something like this: <
19319 \begin_inset Quotes eld
19323 \begin_inset Quotes erd
19327 \begin_inset space ~
19331 \begin_inset Quotes erd
19335 \begin_inset Quotes erd
19339 \begin_inset space ~
19343 \begin_inset Quotes erd
19347 \begin_inset Quotes erd
19351 \begin_inset space ~
19355 \begin_inset Quotes eld
19359 \begin_inset Quotes erd
19366 \begin_layout Standard
19367 As you can see in the example, there is a label command for each nesting
19374 \SpecialChar \ldots{}
19381 , as well as a counter,
19385 \SpecialChar \ldots{}
19391 There are also five
19392 \begin_inset Quotes eld
19396 \begin_inset Quotes erd
19429 , each of which take one counter as an argument.
19430 You can add characters before or after these, but there's no need to add
19434 \begin_layout Standard
19435 You can get really fancy with these.
19439 \begin_layout LyX-Code
19453 \begin_layout LyX-Code
19465 \begin_layout LyX-Code
19475 \begin_layout LyX-Code
19485 \begin_layout Standard
19486 produces the somewhat out of hand numbering scheme: <
19487 \begin_inset Quotes eld
19491 \begin_inset Quotes erd
19495 \begin_inset space ~
19499 \begin_inset Quotes erd
19503 \begin_inset Quotes erd
19507 \begin_inset space ~
19511 \begin_inset Quotes erd
19515 \begin_inset Quotes erd
19519 \begin_inset space ~
19523 \begin_inset Quotes eld
19527 \begin_inset Quotes erd
19534 \begin_layout Standard
19538 \begin_layout Section
19542 \begin_layout Standard
19548 \begin_layout Standard
19549 \begin_inset VSpace bigskip
19555 \begin_layout Standard
19560 \begin_layout Plain Layout
19566 tmpfont}{cmr17 scaled 2500}{
19578 \begin_layout Standard
19583 \begin_layout Plain Layout
19594 hose of you who like the style of old books probably also like
19595 \begin_inset Quotes eld
19599 \begin_inset Quotes erd
19602 ---those large capital letters which begin each new chapter or section.
19603 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19604 know some plain TeX!) but does require a lot of work and many iterations,
19605 as you can see by all the ugly TeX-mode stuff at the beginning of this
19609 \begin_layout Standard
19613 \begin_layout Plain Layout
19619 bigdrop{-1em}{3}{ptmri}{T}+
19624 here is a much easier way of doing this, of course.
19633 ) package from CTAN allows a simple way to add such letters to your documents.
19634 Since this package is not a standard part of teTeX, I can't demonstrate
19635 it within this document, but if you copy this paragraph to a new document,
19637 \begin_inset Quotes eld
19647 \begin_inset Quotes erd
19650 and the pluses from the TeX code at the beginning of the paragraph, and
19655 usepackage{dropcaps}
19657 to your LaTeX preamble, you will get a nice Times Roman Italic
19658 \begin_inset Quotes eld
19662 \begin_inset Quotes erd
19665 , whose height is three lines of text and which protrudes 1 em into the
19667 (Make certain you have copied
19668 \begin_inset Quotes eld
19676 \begin_inset Quotes erd
19679 into a directory where TeX can see it.) The first argument is the amount
19680 of indentation; in this case the negative sign moves it into the margin.
19681 The second argument is the height of the letter in number of lines of text.
19682 The third argument is the font name: virtually anything which has a tfm
19683 file should work (wade through the
19685 .../texmf/fonts/tfm
19687 directory for possibilities).
19688 My personal favorite is
19689 \begin_inset Quotes eld
19697 \begin_inset Quotes erd
19700 , a fancy German font specifically designed for dropped capitals.
19701 The fourth argument is the letter (or letters) to be dropped.
19706 package also offers the
19712 command, as well as a slightly simplified
19721 \begin_layout Section
19722 Non-standard Paragraph Shapes
19725 \begin_layout Standard
19731 \begin_layout Standard
19732 \begin_inset VSpace bigskip
19738 \begin_layout Standard
19742 \begin_layout Plain Layout
19754 \begin_layout Standard
19758 \begin_layout Plain Layout
19767 \begin_layout Plain Layout
19781 \begin_layout Standard
19786 \begin_layout Plain Layout
19797 \begin_layout Plain Layout
19806 \begin_layout Plain Layout
19815 \begin_layout Plain Layout
19824 \begin_layout Plain Layout
19833 \begin_layout Plain Layout
19842 \begin_layout Plain Layout
19851 \begin_layout Plain Layout
19860 \begin_layout Plain Layout
19869 \begin_layout Plain Layout
19878 \begin_layout Plain Layout
19887 \begin_layout Plain Layout
19896 \begin_layout Plain Layout
19905 \begin_layout Plain Layout
19914 \begin_layout Plain Layout
19923 \begin_layout Plain Layout
19932 \begin_layout Plain Layout
19941 \begin_layout Plain Layout
19950 \begin_layout Plain Layout
19959 \begin_layout Plain Layout
19965 There are times when the tyranny of rectangular paragraphs must be overthrown.
19966 In such situations, a call to the delightful plain TeX command
19973 As you can see, completely arbitrary shapes can be laid out with a suitable
19974 set of linelength definitions.
19975 While this parshape may look a bit silly and useless, one could conceive
19976 of situations such as finely tuned dropped capitals, word wrapping around
19977 non-rectangular graphics, etc.
19978 which will benefit from such handcrafting.
19981 \begin_layout Standard
19982 \begin_inset VSpace bigskip
19988 \begin_layout Standard
19993 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20000 is the number of lines of text which define the paragraph.
20001 If there turn out to be fewer lines, the shape is truncated; if there are
20002 more, the excess lines have the same dimensions as the last line of the
20012 entries specify the indentation of the line from the left margin, and the
20013 length of the line as measured from that point.
20014 The shape applies only to the current paragraph; everything is reset to
20015 normal for the next paragraph.
20018 \begin_layout Standard
20022 \begin_layout Plain Layout
20034 \begin_layout Section
20038 \begin_layout Standard
20039 As you can see, the examples in this section range from the useful to the
20041 While I don't expect that anyone will ever need the paragraph shape demonstrate
20042 d in the last section, the important point is that you can do almost anything
20043 you want in LyX if you are willing to figure out how to do it in TeX and
20045 TeX is a fantastically powerful typesetting system and all that power is
20046 available to you since LyX uses it as its backend.