1 #LyX 1.6.1 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 TeX code, so after translating
613 \begin_inset Flex CharStyle:Code
616 \begin_layout Plain Layout
622 , you can look for TeX code and hand-edit it until it looks right.
625 \begin_layout Standard
626 If you don't know what TeX code 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 TeX code 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 TeX code, 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 or
1507 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 TeX code).
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 attempt
2753 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 TeX code.
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
4223 Tools\SpecialChar \menuseparator
4230 \begin_inset Flex CharStyle:Code
4233 \begin_layout Plain Layout
4234 "/home/myhome/lyxpipe"
4244 configure this manually in order for the server to start.
4247 \begin_layout Standard
4249 \begin_inset Flex CharStyle:Code
4252 \begin_layout Plain Layout
4259 \begin_inset Flex CharStyle:Code
4262 \begin_layout Plain Layout
4268 ' to create the pipes.
4269 If one of the pipes already exists, LyX will assume that another LyX process
4270 is already running and will not start the server.
4271 This means that if LyX crashes, or if for some other reason, a
4272 \begin_inset Quotes eld
4276 \begin_inset Quotes erd
4279 pipe is left in existence when LyX closes, then LyX will not start the
4281 (This is bug 641.) You will need to delete the pipes manually and then restart
4285 \begin_layout Standard
4286 To have several LyX processes with servers at the same time, you have to
4287 use different configurations, perhaps by using separate user directories,
4289 \begin_inset Flex CharStyle:Code
4292 \begin_layout Plain Layout
4298 file, for each process.
4301 \begin_layout Standard
4302 If you are developing a client program, you might find it useful to enable
4303 debugging information from the LyX server.
4304 Do this by starting LyX as
4305 \begin_inset Flex CharStyle:Code
4308 \begin_layout Plain Layout
4317 \begin_layout Standard
4318 Other than this, there are a few points to consider:
4321 \begin_layout Itemize
4322 Both server and clients must run on UNIX or OS/2 machines.
4323 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4324 not possible right now.
4327 \begin_layout Itemize
4328 On OS/2, only one client can connect to LyXServer at a time.
4331 \begin_layout Itemize
4332 On OS/2, clients must open the input pipe with
4333 \begin_inset Flex CharStyle:Code
4336 \begin_layout Plain Layout
4345 \begin_layout Standard
4346 You can find a complete example client written in C in the source distribution
4348 \begin_inset Flex CharStyle:Code
4351 \begin_layout Plain Layout
4352 development/lyxserver/server_monitor.c
4360 \begin_layout Section
4361 Normal communication
4364 \begin_layout Standard
4365 To issue a LyX call, the client writes a line of ASCII text into the input
4367 This line has the following format:
4384 \begin_layout Description
4385 clientname is a name that the client can choose arbitrarily.
4386 Its only use is that LyX will echo it if it sends an answer—so a client
4387 can dispatch results from different requesters.
4390 \begin_layout Description
4391 function is the function you want LyX to perform.
4392 It is the same as the commands you'd use in the minibuffer.
4395 \begin_layout Description
4396 argument is an optional argument which is meaningful only to some functions
4398 \begin_inset Quotes eld
4402 \begin_inset Quotes erd
4405 LFUN will insert the argument as text at the cursor position).
4408 \begin_layout Standard
4409 The answer from LyX will arrive in the output pipe and be of the form
4426 \begin_layout Standard
4435 are just echoed from the command request, while
4439 is more or less useful information filled according to how the command
4440 execution worked out.
4441 Some commands, such as
4442 \begin_inset Quotes eld
4446 \begin_inset Quotes erd
4449 , will return information about the internal state of LyX, while other will
4450 return an empty data-response.
4451 This means that the command execution went fine.
4454 \begin_layout Standard
4455 In case of errors, the response from LyX will have this form
4472 \begin_layout Standard
4477 should contain an explanation of why the command failed.
4480 \begin_layout Standard
4484 \begin_layout LyX-Code
4485 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4488 \begin_layout LyX-Code
4489 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4490 \begin_inset Newline newline
4493 read a <~/.lyxpipe.out
4494 \begin_inset Newline newline
4500 \begin_layout Section
4504 \begin_layout Standard
4505 LyX can notify clients of events going on asynchronously.
4506 Currently it will only do this if the user binds a key sequence with the
4508 \begin_inset Quotes eld
4512 \begin_inset Quotes erd
4516 The format of the string LyX sends is as follows:
4520 \begin_inset Flex CharStyle:Code
4523 \begin_layout Plain Layout
4534 \begin_layout Standard
4539 is the printed representation of the key sequence that was actually typed
4543 \begin_layout Standard
4544 This mechanism can be used to extend LyX's command set and implement macros.
4545 Bind some key sequence to
4546 \begin_inset Quotes eld
4550 \begin_inset Quotes erd
4554 Then start a client that listens on the output pipe, dispatches the command
4555 according to the sequence, and starts a function that may use LyX calls
4556 and LyX requests to issue a command or a series of commands to LyX.
4559 \begin_layout Section
4560 The simple LyX Server Protocol
4563 \begin_layout Standard
4564 LyX implements a simple protocol that can be used for session management.
4565 All messages are of the form
4578 \begin_layout Standard
4584 \begin_inset Quotes eld
4588 \begin_inset Quotes erd
4592 \begin_inset Quotes eld
4596 \begin_inset Quotes erd
4601 \begin_inset Quotes eld
4605 \begin_inset Quotes erd
4608 is received from a client, LyX will report back to inform the client that
4609 it's listening to it's messages, while
4610 \begin_inset Quotes eld
4614 \begin_inset Quotes erd
4617 sent from LyX will inform clients that LyX is closing.
4620 \begin_layout Chapter
4621 Special Document Classes
4624 \begin_layout Section
4628 \begin_layout Standard
4634 \begin_layout Subsection
4638 \begin_layout Standard
4639 This section describes how LyX can be used to write articles for submission
4640 to the scientific journal
4642 Astronomy and Astrophysics
4644 (www.edpsciences.fr/aa/
4645 \begin_inset Flex URL
4648 \begin_layout Plain Layout
4650 http://www.edpsciences.fr/aa/
4655 ) using Version 5.01 of the document class
4660 This package can be downloaded from the ftp site
4663 \begin_layout Standard
4664 \begin_inset VSpace medskip
4670 \begin_layout Standard
4672 \begin_inset Flex URL
4675 \begin_layout Plain Layout
4677 ftp://ftp.edpsciences.org/pub/aa/readme.html
4685 \begin_layout Standard
4686 \begin_inset VSpace medskip
4692 \begin_layout Standard
4693 A manual comes together with that package, and this text is not meant to
4694 replace the original manual but merely a short guide how to realize the
4695 correct form of your paper.
4699 \begin_layout Standard
4700 Please note that the publisher of the journal was changed from Springer
4701 to EDP Sciences starting January 1, 2001.
4702 That change implicated also some slight changes of the style files, namely
4703 the removal of the thesaurus command.
4704 The LyX class aa supports the newest version of these style files, V 5.01.
4705 If you have an older version installed, please upgrade.
4706 For compatibility, the old (version 4) layout has been kept as
4711 Please refer to the comments in
4713 LyXDir/layouts/aapaper.layout
4718 \begin_layout Subsection
4722 \begin_layout Standard
4723 It is recommended you start from the example template distributed with LyX.
4724 If you are not using a template, note the following settings:
4727 \begin_layout Itemize
4734 Document\SpecialChar \menuseparator
4737 dialog (OK, that one was obvious).
4740 \begin_layout Itemize
4741 Don't change the option
4744 \begin_inset space ~
4754 The whole layout is done by the macros, you shouldn't change anything.
4757 \begin_layout Subsection
4761 \begin_layout Standard
4762 First thing to enter is the header information.
4763 It consists of seven entries, of which some are optional.
4767 \begin_layout Itemize
4775 \begin_layout Itemize
4783 \begin_layout Itemize
4791 \begin_layout Itemize
4799 \begin_layout Itemize
4804 : [optional] if more than one author: whom to contact for offprint requests.
4807 \begin_layout Itemize
4812 : [optional] mail address for contacts.
4815 \begin_layout Itemize
4823 Received: <date>; Accepted <date>
4826 \begin_layout Standard
4827 There is no need to issue the
4833 command, this is done automatically by LyX when the header is finished.
4834 Although the order of the single header entries doesn't matter it is advised
4835 to keep the above sequence, just to get the best optics and meets the layout
4836 of the real document.
4839 \begin_layout Standard
4840 If you want to place footnotes in the header block, e.
4841 \begin_inset space \thinspace{}
4845 \begin_inset space \space{}
4848 to state your present address, just use the standard footnote via the menu
4851 Insert\SpecialChar \menuseparator
4855 LyX will automagically use the term
4864 \begin_layout Standard
4865 In addition to these topics, the macros use three additional LaTeX commands
4866 that have no counterpart in LyX:
4869 \begin_layout Itemize
4876 to separate different names for more than one author and institute, respectivel
4880 \begin_layout Itemize
4887 to mark corresponding author/institute pairs.
4888 The institutes are numbered sequentially as they appear in the
4892 field, so you have to put a marker to each author.
4895 \begin_layout Itemize
4902 to supply an email address for fast contact.
4905 \begin_layout Standard
4906 In all cases, the appropriate command has to be entered in LyX and marked
4912 \begin_layout Subsection
4916 \begin_layout Standard
4917 The abstract should immediately follow the header block.
4918 With version 5 the abstract environment was changed to a command, and there
4919 is now a resctriction to only one paragraph.
4920 In addition, it should contain an entry with the keywords.
4921 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4928 by hand and mark it as LaTeX code.
4929 Refer to the example paper.
4932 \begin_layout Subsection
4933 Supported environments
4936 \begin_layout Standard
4937 The A&A paper layout supports the following environments for structuring
4941 \begin_layout Itemize
4947 \begin_layout Itemize
4953 \begin_layout Itemize
4959 \begin_layout Itemize
4965 \begin_layout Itemize
4971 \begin_layout Itemize
4977 \begin_layout Itemize
4983 \begin_layout Itemize
4989 \begin_layout Itemize
4995 \begin_layout Itemize
5001 \begin_layout Itemize
5007 \begin_layout Itemize
5013 \begin_layout Subsection
5014 Commands not supported by LyX
5017 \begin_layout Standard
5018 Some commands are not yet supported by the
5023 Some have already been mentioned.
5024 For the sake of completeness, they are listed all together here:
5027 \begin_layout Itemize
5035 \begin_layout Itemize
5043 \begin_layout Itemize
5051 \begin_layout Itemize
5059 \begin_layout Itemize
5067 \begin_layout Itemize
5075 \begin_layout Itemize
5083 \begin_layout Itemize
5091 \begin_layout Standard
5092 If you want to use any of these commands, you have to enter them yourself.
5095 Do not forget to mark them as LaTeX code!
5098 \begin_layout Subsection
5099 Figure and Table Floats
5102 \begin_layout Standard
5103 LyX provides support for the necessary float environments
5105 figure, figure*, table
5111 , therefore we won't tell much about it here.
5115 \begin_inset space ~
5121 Just remember that tables should be left-aligned.
5122 For that, select the table and change the alignment in
5124 Edit\SpecialChar \menuseparator
5126 \begin_inset space ~
5132 \begin_layout Standard
5133 There is only one special thing: the figures with caption besides the figure.
5134 To create such a figure, you have to do the following:
5137 \begin_layout Enumerate
5138 Create a wide figure float:
5140 Insert\SpecialChar \menuseparator
5141 Float\SpecialChar \menuseparator
5144 , then right click in the figure and select
5150 \begin_inset space ~
5158 \begin_layout Enumerate
5159 Enter your caption text.
5162 \begin_layout Enumerate
5167 to move the cursor above the caption.
5170 \begin_layout Enumerate
5174 \begin_layout Enumerate
5175 Position the cursor behind the figure and insert a horizontal fill:
5177 Insert\SpecialChar \menuseparator
5179 \begin_inset space ~
5182 Character\SpecialChar \menuseparator
5184 \begin_inset space ~
5192 \begin_layout Enumerate
5193 Switch to LaTeX mode:
5196 \begin_inset space ~
5204 \begin_layout Enumerate
5214 Do not close the brace!
5217 \begin_layout Enumerate
5218 Position the cursor behind the caption text, switch to LaTeX mode and insert
5222 \begin_inset space ~
5234 \begin_layout Standard
5235 Also, refer to the figures in the example paper.
5238 \begin_layout Subsection
5242 \begin_layout Standard
5243 For submission, the paper has to be formated in a special double-spacing
5245 For this purpose, you have to give the option
5249 to the documentclass.
5250 This must be done using the extra class options field in the
5252 Document\SpecialChar \menuseparator
5256 Just enter the string
5263 \begin_layout Subsection
5267 \begin_layout Standard
5272 directory contains an example paper written with LyX.
5273 It is the example paper from the original macro package, translated to
5275 Use it for inspiration, and compare the original LaTeX code with LyX way
5279 \begin_layout Section
5283 \begin_layout Standard
5289 \begin_layout Subsection
5293 \begin_layout Standard
5294 AASTeX is a set of macros produced by the American Astronomical Society
5295 to facilitate electronic manuscript submission to the three journals they
5296 publish: the Astrophysical Journal (including the Letters and Supplement),
5297 the Astronomical Journal, and the Publications of the Astronomical Society
5299 LyX has proven to be an excellent tool for generating these documents,
5300 especially given its equation, citation, and figure handling capabilities.
5301 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5302 is the version described here, or higher.
5303 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5304 incompatible with LyX.
5305 The AASTeX package may be downloaded from the AASTeX Web site
5308 \begin_layout Standard
5309 \begin_inset VSpace medskip
5315 \begin_layout Standard
5317 \begin_inset Flex URL
5320 \begin_layout Plain Layout
5322 http://www.journals.uchicago.edu/AAS/AASTeX
5330 \begin_layout Standard
5331 \begin_inset VSpace medskip
5337 \begin_layout Standard
5338 A complete user guide is contained in that package and you should familiarize
5339 yourself with it thoroughly before embarking on writing a paper in LyX.
5340 LyX will not reduce the need to figure out all the AASTeX commands, it
5341 will only reduce the drudgery of typing everything in.
5342 It is your responsibility to ensure that the final exported LaTeX document
5343 conforms completely to the requirements of the journal to which you are
5344 submitting your paper.
5347 \begin_layout Subsection
5348 Starting a New Paper
5351 \begin_layout Standard
5352 I strongly suggest that you start with the AASTeX template file.
5355 File\SpecialChar \menuseparator
5362 , enter the new file name, then choose the
5367 This will show the most common fields found in a manuscript.
5368 Simply overwrite the existing text (including the brackets,
5372 ) with the correct information.
5373 Many of the AASTeX commands and environments can be implemented directly
5374 in LyX, but some cannot: most noticeably
5386 , which should stick out like a sore thumb if you actually just opened the
5388 For commands such as these, the LaTeX code must be entered directly and
5390 Such commands are referred to as TeX code, or Evil Red Text.
5391 I tried to minimize the amount of TeX code needed in an AASTeX document,
5392 but there is still a bit more required than any of us would like.
5395 \begin_layout Subsection
5396 Finishing Your Paper
5399 \begin_layout Standard
5400 When the paper is finished to your satisfaction and previews/prints correctly,
5402 \begin_inset Quotes eld
5406 \begin_inset Quotes erd
5409 actions which need to be done before you submit it to the journals.
5413 \begin_layout Enumerate
5414 Export your paper as a LaTeX file (
5416 File\SpecialChar \menuseparator
5417 Export\SpecialChar \menuseparator
5424 \begin_layout Enumerate
5429 file with your favorite text editor
5433 \begin_layout Enumerate
5434 remove the comment lines before the
5443 \begin_layout Enumerate
5448 usepackage...{fontenc}
5450 line if it appears (usually just after
5465 \begin_layout Enumerate
5466 remove everything between (and including) the
5478 commands, except for any commands you specifically put into the LaTeX preamble
5479 (which should appear immediately after the
5480 \begin_inset Quotes eld
5483 User specified LaTeX commands
5484 \begin_inset Quotes erd
5495 \begin_layout Enumerate
5496 Run the resulting file through LaTeX to make sure it still processes correctly.
5499 \begin_layout Enumerate
5500 Reread the journal requirements to make sure your filenames and formats
5504 \begin_layout Enumerate
5508 \begin_layout Subsection
5509 Comments On Specific Commands
5512 \begin_layout Standard
5513 I will not describe the detailed usage of the individual AASTeX commands:
5514 the AASTeX User Guide (
5518 ) gives a good description of each.
5519 Thus it's probably easiest for me to go down the list as found in the guide
5520 and offer comments where necessary.
5521 So let's begin \SpecialChar \ldots{}
5525 \begin_layout Subsubsection
5526 Things that work as expected
5529 \begin_layout Standard
5533 \begin_layout Plain Layout
5545 \begin_layout Standard
5546 Because they work as you might expect, I simply list them and the section
5647 begin{thebibliography}
5655 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5656 graphicx figure commands (2.14.1),
5680 (2.15.4, amongst other places),
5707 \begin_layout Standard
5708 The following style options also work correctly:
5729 Simply put them in the
5735 Layout\SpecialChar \menuseparator
5741 \begin_layout Standard
5745 \begin_layout Plain Layout
5757 \begin_layout Subsubsection
5758 Things that work, but require more comment
5761 \begin_layout Standard
5762 The following items work, but require a little more discussion:
5765 \begin_layout Itemize
5766 These items are reserved for use by the journal editors, but you can put
5767 them into the LaTeX preamble if you feel compelled to do so:
5800 \begin_layout Itemize
5801 These items may be placed in the LaTeX preamble, and are included as blanks
5802 in the template file:
5823 \begin_layout Itemize
5830 (2.3) – can only be used
5831 \begin_inset Quotes eld
5835 \begin_inset Quotes erd
5838 , not in the middle of a paragraph.
5839 Use TeX code if you need to embed it.
5842 \begin_layout Itemize
5849 (2.3) – will have extra {} after it.
5850 This should not cause an error.
5853 \begin_layout Itemize
5860 (2.6) – can only be used
5861 \begin_inset Quotes eld
5865 \begin_inset Quotes erd
5868 , not in the middle of a paragraph.
5869 Use TeX code if you need to embed it.
5872 \begin_layout Itemize
5879 (2.8) – can't insert a cross-reference tag, you must type the tag name by
5883 \begin_layout Itemize
5890 (2.8) – same as for
5897 \begin_layout Itemize
5904 (2.9) – will have extra {} after it.
5905 This should not cause an error.
5908 \begin_layout Itemize
5915 (2.11) – will have extra {} after it.
5916 This should not cause an error.
5919 \begin_layout Itemize
5926 (2.14.2) – you can insert an optional filename argument by placing the cursor
5927 at the beginning of the text and selecting
5929 Insert\SpecialChar \menuseparator
5934 \begin_inset Quotes eld
5938 \begin_inset Quotes erd
5941 inserts an optional argument of the type needed by
5948 Hopefully it will be renamed someday.
5951 \begin_layout Itemize
5958 (2.17.1) – same as
5964 for the catalog ID optional parameter
5967 \begin_layout Itemize
5974 (2.17.1) – same as
5980 for the catalog ID optional parameter
5983 \begin_layout Subsubsection
5984 Things not implemented, use TeX code
5987 \begin_layout Standard
5991 \begin_layout Plain Layout
6003 \begin_layout Standard
6026 setcounter{equation}
6028 (2.12), Journal name abbreviations (2.13.4),
6064 (2.15.4, insert it as the first element in the lefthand cell after where
6066 Don't use any of LyX's rules in the table),
6078 (2.15.5), much of Misc (2.17, except
6129 \begin_layout Standard
6133 \begin_layout Plain Layout
6145 \begin_layout Subsubsection
6146 Things that cannot be implemented
6149 \begin_layout Standard
6150 \SpecialChar \ldots{}
6151 at least in any meaningful sort of way, so I suggest ignoring them.
6152 They are the references environment (2.13.3), and the deluxetable environment
6154 If you really, really need to use deluxetable, I suggest editing it in
6155 a separate file with a text editor, then using
6157 Insert\SpecialChar \menuseparator
6159 \begin_inset space ~
6164 to include it in your LyX document.
6169 file to see an example of this.
6172 \begin_layout Subsection
6173 FAQs, Tips, Tricks, and Other Ruminations
6176 \begin_layout Subsubsection
6177 Getting LyX and AASTeX to cooperate
6180 \begin_layout Standard
6181 It can be a bit tricky to get LyX to recognize a new layout and document
6183 When all else fails, do this:
6186 \begin_layout Enumerate
6187 Make certain that LaTeX can find AASTeX.
6188 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6189 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6196 \begin_layout Enumerate
6208 \begin_layout Enumerate
6211 Tools\SpecialChar \menuseparator
6214 in LyX, then restart LyX.
6217 \begin_layout Enumerate
6218 Open a regular new file, not from a template.
6219 Does AASTeX appear in the class list in
6221 Document\SpecialChar \menuseparator
6227 \begin_layout Standard
6228 If you get a warning from an existing AASTeX document about not being able
6229 to find the AASTeX layout or a message about
6230 \begin_inset Quotes eld
6233 You should not mix title layouts with normal ones
6234 \begin_inset Quotes erd
6237 , things haven't been installed correctly.
6240 \begin_layout Subsubsection
6241 LaTeX error processing a table
6244 \begin_layout Standard
6245 LyX, by default, attempts to center the table caption/title.
6246 This seems to produce a bad interaction in AASTeX so you should click somewhere
6247 in the caption/title, then select
6249 Edit\SpecialChar \menuseparator
6251 \begin_inset space ~
6265 This took care of it for me.
6268 \begin_layout Subsubsection
6272 \begin_layout Standard
6273 A couple of things: 1) I have noticed some funny spacing in the reference
6274 entries in the text.
6275 When you enter the bibliography item data, make sure their is
6279 space between the last author and the parenthesis setting off the year;
6283 \begin_inset space \thinspace{}
6287 \begin_inset space \space{}
6301 2) Entering the references at all is not obvious.
6302 The easiest thing is to start typing your first reference at the end of
6303 the document, then mark it as type
6308 That will put a small gray box in front of what you just typed.
6309 Click on the box to fill in the rest of the information.
6310 For new references, go to the end of an existing reference and press return.
6311 That will create a new line with its own box, etc.
6314 \begin_layout Subsubsection
6318 \begin_layout Standard
6319 Even though AASTeX provides its own figure commands (
6325 , for example), I much prefer LaTeX's standard figure commands (with the
6334 \begin_inset space ~
6337 commands as TeX code into a Figure Float box if you desire, but I never
6338 have much luck getting the layout right.
6339 With the standard graphics, LyX will insert a
6343 usepackage{graphicx}
6345 command into the LaTeX preamble and handle the figures in the standard
6346 LaTeX2e way, interspersing the figures in the text.
6347 I believe ApJ accepts figures exactly this way now; AJ might still use
6349 \begin_inset Quotes eld
6352 stack everything at the end
6353 \begin_inset Quotes erd
6359 \begin_layout Subsubsection
6360 Things I could have done, but didn't
6363 \begin_layout Standard
6365 \begin_inset Quotes eld
6369 \begin_inset Quotes erd
6372 things I could have implemented, but chose not to.
6373 For instance, I saw no point in double-spacing the text in the LyX window,
6374 even though it is double-spaced in the paper manuscript.
6375 Also, I chose not to make separate layouts for the preprint and preprint2
6377 Since I assume you will spend most of your time in the plain manuscript
6378 mode anyway, I decided not to chew up more disk space with this.
6382 \begin_layout Subsection
6386 \begin_layout Standard
6387 Your mileage may vary.
6388 I've now had papers published by both ApJ and AJ that have had 98% of the
6389 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6391 I have had no trouble with the submission process, and I'm sure the journals
6392 were never aware that there might be a difference.
6393 So, go forth and publish!
6396 \begin_layout Section
6400 \begin_layout Standard
6403 David Johnson; updated by Richard Heck
6406 \begin_layout Standard
6407 \begin_inset VSpace bigskip
6413 \begin_layout Standard
6415 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6416 papers to be submitted to American Mathematical Society publications.
6417 The layouts are not tailored to a specific journal, but easily can be.
6418 You should refer to the AMS documentation for specific instructions for
6419 each journal (usually it will entail only changing a single line in the
6421 That documentation is available on the Web at
6422 \begin_inset Flex URL
6425 \begin_layout Plain Layout
6433 \begin_inset Flex URL
6436 \begin_layout Plain Layout
6438 ftp://ftp.ams.org/pub/tex/amslatex/
6444 These layouts are appropriate, and useful, for any mathematical writing.
6448 \begin_layout Standard
6449 There are two basic AMS LaTeX layouts:
6452 \begin_layout Itemize
6453 amsart: The standard AMS article format.
6456 \begin_layout Itemize
6457 amsbook: the standard AMS book (really, monograph) format.
6461 \begin_layout Standard
6462 The layouts themselves contain only the minimum necessary to use the AMS
6464 They do not, in particular, contain any of the `theorem' environments used
6465 for setting theorems, lemmas, and the like.
6466 These are contained, instead, in the
6467 \begin_inset Flex CharStyle:Code
6470 \begin_layout Plain Layout
6476 module, which is loaded by default when when you select one of the AMS
6478 (It can also be used with other classes and can be removed, if you would
6479 rather use something else.) Less commonly used environments are in the
6480 \begin_inset Flex CharStyle:Code
6483 \begin_layout Plain Layout
6484 Theorems (AMS-Extended)
6489 module, which must be loaded manually.
6492 \begin_layout Standard
6493 By default, theorems and the like are numbered consecutively throughout
6494 the document, but this may be modified by loading the module
6495 \begin_inset Flex CharStyle:Code
6498 \begin_layout Plain Layout
6499 Theorems (Order by Section)
6504 or, if you are using
6505 \begin_inset Flex CharStyle:Code
6508 \begin_layout Plain Layout
6515 \begin_inset Flex CharStyle:Code
6518 \begin_layout Plain Layout
6519 Theorems (Order by Chapter)
6525 These will number the results as
6526 \begin_inset Formula $n.m$
6529 , where the first number refers to the section (or chapter) and the second
6530 refers to the total number of results so far in that section (or chapter).
6531 Many environments are also available unnumbered.
6532 These are indicated by an asterisk at the end.
6533 If you happen to want
6537 unnumbered results, the the module
6538 \begin_inset Flex CharStyle:Code
6541 \begin_layout Plain Layout
6547 provides that option.
6550 \begin_layout Standard
6551 Note that these modules do not
6555 to be used with the AMS classes.
6556 It is perfectly possible to use the
6557 \begin_inset Flex CharStyle:Code
6560 \begin_layout Plain Layout
6566 module, and the others mentioned, with other classes, such as
6567 \begin_inset Flex CharStyle:Code
6570 \begin_layout Plain Layout
6577 \begin_inset Flex CharStyle:Code
6580 \begin_layout Plain Layout
6587 \begin_inset Flex CharStyle:Code
6590 \begin_layout Plain Layout
6599 \begin_layout Subsection
6600 What these layouts provide
6603 \begin_layout Standard
6604 There is a long list of included environments provided by these layouts.
6605 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6606 variety of `theorem' environments.
6607 However, the AMS recommends the environments that are available in LyX.
6611 \begin_layout Standard
6612 The following environments—as well as the standard environments, such as
6614 \begin_inset Flex CharStyle:Noun
6617 \begin_layout Plain Layout
6624 \begin_inset Flex CharStyle:Noun
6627 \begin_layout Plain Layout
6634 \begin_inset Flex CharStyle:Noun
6637 \begin_layout Plain Layout
6644 \begin_inset Flex CharStyle:Noun
6647 \begin_layout Plain Layout
6654 \begin_inset Flex CharStyle:Noun
6657 \begin_layout Plain Layout
6664 \begin_inset Flex CharStyle:Code
6667 \begin_layout Plain Layout
6674 \begin_inset Flex CharStyle:Code
6677 \begin_layout Plain Layout
6686 \begin_layout Description
6687 Address This should be the author's permanent address.
6690 \begin_layout Description
6692 \begin_inset space ~
6695 Address This should be the author's temporary address at the time of submission,
6696 if different from the Address.
6699 \begin_layout Description
6700 Email Author's e-mail address
6703 \begin_layout Description
6704 URL Author's Web address, if desired.
6707 \begin_layout Description
6708 Keywords Key words or phrases used to identify specific topics discussed
6712 \begin_layout Description
6713 Subjectclass These refer to the AMS Subject Classifications, published and
6716 Mathematical Reviews
6719 These are also available online at the AMS cites listed above.
6722 \begin_layout Description
6726 \begin_layout Description
6730 \begin_layout Description
6734 \begin_layout Standard
6735 The following environments are provided by both the
6736 \begin_inset Flex CharStyle:Code
6739 \begin_layout Plain Layout
6746 \begin_inset Flex CharStyle:Code
6749 \begin_layout Plain Layout
6755 modules, in the latter case in both starred (unnumbered) and unstarred
6756 (numbered) versions.
6757 These same environments are provided only in the starred versions by the
6759 \begin_inset Flex CharStyle:Code
6762 \begin_layout Plain Layout
6771 \begin_layout Theorem
6772 This is typically used for the statements of major results.
6776 \begin_layout Corollary*
6777 This is used for statements which follow fairly directly from previous statement
6779 Again, these can be major results.
6784 These are smaller results needed to prove other statements.
6787 \begin_layout Proposition
6788 These are less major results which (hopefully) add to the general theory
6792 \begin_layout Conjecture
6793 These are statements provided without justification, which the author does
6794 not know how to prove, but which seem to be true (to the author, at least).
6797 \begin_layout Definition*
6798 Guess what this is for.
6799 The font is different for this environment than for the previous ones.
6803 \begin_layout Example*
6804 Used for examples illustrating proven results.
6807 \begin_layout Problem
6808 It's not really known what this is for.
6809 You should figure it out.
6812 \begin_layout Exercise*
6813 Write a description for this one.
6816 \begin_layout Remark
6817 This environment is also a type of theorem, usually a lesser sort of observation.
6820 \begin_layout Claim*
6821 Often used in the course of giving a proof of a larger result.
6825 Generally, these are used to break up long arguments, using specific instances
6831 The numbering scheme for cases is on its own, not together with other numbered
6837 At the end of this environment, a QED symbol (usually a square, but it can
6838 vary with different styles) is placed.
6839 If you want to have other environments within this one—for example, Case
6840 environments—and have the QED symbol appear only after them, then the other
6841 environments need to be nested within the proof environment.
6844 Nesting Environments
6850 for information on nesting.
6853 \begin_layout Standard
6854 And these environments are provided by
6855 \begin_inset Flex CharStyle:Code
6858 \begin_layout Plain Layout
6859 Theorems (AMS-Extended)
6867 \begin_layout Criterion*
6868 A required condition.
6871 \begin_layout Algorithm*
6872 A general procedure to be used.
6875 \begin_layout Axiom*
6876 This is a property or statement taken as true within the system being discussed.
6879 \begin_layout Condition*
6880 Sometimes used to state a condition assumed within the present context of
6885 Similar to a Remark.
6888 \begin_layout Notation*
6889 Used for the explanation of, yes, notation.
6892 \begin_layout Summary
6893 Do we really need to tell you?
6896 \begin_layout Acknowledgement*
6900 \begin_layout Conclusion*
6901 Sometimes used at the end of a long train of argument.
6905 Used in a way similar to Proposition, though perhaps lower on the scale.
6908 \begin_layout Standard
6909 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6911 They need to be available on your system in order to use these environments.
6914 \begin_layout Section
6922 \begin_layout Standard
6928 \begin_layout Subsection
6932 \begin_layout Standard
6933 These are the layout files for some of the journals of the American Geophysical
6935 It is assumed that you have both the AGU's own class files and AGUplus
6936 installed (everything to be found at
6937 \begin_inset Flex URL
6940 \begin_layout Plain Layout
6942 ftp://ftp.agu.org/journals/latex/journals
6950 \begin_layout Subsection
6954 \begin_layout Standard
6964 They are still called this in the LyX GUI, though their LaTeX equivalents
6965 in the AGU classes are
6976 \begin_layout Standard
6977 Newly defined styles are
7014 These are mostly manuscript attributes and defined in the AGU class documentati
7018 \begin_layout Standard
7019 I suspect this is still badly incomplete.
7022 \begin_layout Subsection
7026 \begin_layout Standard
7043 \begin_layout Subsection
7047 \begin_layout Itemize
7050 Journal of Geophysical Research
7059 \begin_layout Standard
7060 Add your own, it isn't so hard! Look at the
7071 \begin_layout Subsection
7072 Bugs and things to remember
7075 \begin_layout Standard
7076 In order to use the new layouts, you must remember to do the following for
7080 \begin_layout Enumerate
7086 This can be done in the
7088 Layout\SpecialChar \menuseparator
7093 Document\SpecialChar \menuseparator
7097 (AGU articles are always in English, right? So
7104 \begin_layout Enumerate
7114 (Yes, this is a bug.)
7117 \begin_layout Enumerate
7118 Make sure you use the
7122 bibliography style, by entering
7126 into the second field of the BibTeX inset.
7127 None of the standard styles will do.
7130 \begin_layout Section
7134 \begin_layout Standard
7140 \begin_layout Subsection
7144 \begin_layout Standard
7145 Broadway is for writing plays.
7146 The format is more decorative than Hollywood, and much less standardized.
7147 This format should be suitable for workshops.
7150 \begin_layout Subsection
7154 \begin_layout Standard
7155 The same as in Hollywood.
7158 \begin_layout Subsection
7162 \begin_layout Standard
7167 names as labels then cross-reference the label to insert the name.
7168 The cross-reference dialog will show the current cast of characters.
7171 \begin_layout Subsection
7172 Paper size and Margins
7175 \begin_layout Standard
7176 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7179 \begin_layout Subsection
7183 \begin_layout Standard
7184 The following environments are available.
7185 You can use broadway.bind to get the bind keys shown at the right.
7188 \begin_layout Itemize
7192 \begin_inset Newline newline
7197 You should not have to use this, but it is here for anything that does not
7201 \begin_layout Itemize
7205 \begin_inset space \hfill{}
7209 \begin_inset Newline newline
7214 Used to describe stage setting and the action.
7215 First use of speaker names in all CAPs.
7218 \begin_layout Itemize
7222 \begin_inset space \hfill{}
7226 \begin_inset Newline newline
7231 Automatically numbered.
7232 On screen it will be arabic, but will print as Roman.
7235 \begin_layout Itemize
7239 \begin_inset space \hfill{}
7243 \begin_inset Newline newline
7253 It is just centered text.
7256 \begin_layout Itemize
7260 \begin_inset space \hfill{}
7264 \begin_inset Newline newline
7269 Not automatically numbered.
7270 You supply the number.
7271 This is because I couldn't figure out how.
7274 \begin_layout Itemize
7278 \begin_inset space \hfill{}
7282 \begin_inset Newline newline
7287 A special case of Narrative to describe the setting and action as the curtain
7291 \begin_layout Itemize
7295 \begin_inset space \hfill{}
7299 \begin_inset Newline newline
7304 The speaker's (actor's) title, centered in all CAPS.
7307 \begin_layout Itemize
7311 \begin_inset space \hfill{}
7315 \begin_inset Newline newline
7320 Instructions to the speaker.
7321 The parentheses are automatically inserted.
7322 The ( will appear on screen, but both will be in the printed play.
7323 This environment is only used within
7330 \begin_layout Itemize
7334 \begin_inset space \hfill{}
7338 \begin_inset Newline newline
7343 What the Speaker says.
7346 \begin_layout Itemize
7350 \begin_inset space \hfill{}
7354 \begin_inset Newline newline
7359 The curtain comes down.
7362 \begin_layout Itemize
7366 \begin_inset space \hfill{}
7372 \begin_layout Itemize
7376 \begin_inset space \hfill{}
7382 \begin_layout Itemize
7386 \begin_inset space \hfill{}
7392 \begin_layout Standard
7396 \begin_layout Section
7400 \begin_layout Standard
7405 can be used to type letters according to German conventions.
7406 A template file is included in
7408 .../lyx/share/templates
7410 for you to use as a starting point.
7413 \begin_layout Section
7421 \begin_layout Standard
7427 \begin_layout Subsection
7431 \begin_layout Standard
7432 This is the layout file for the European Geophysical Society journals.
7437 can be downloaded from the web site of the EGS under
7438 \begin_inset Flex URL
7441 \begin_layout Plain Layout
7451 \begin_layout Subsection
7455 \begin_layout Standard
7458 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7466 The current layout file is unfortunately very unmodular and would benefit
7467 from using the various
7474 \begin_layout Section
7478 \begin_layout Standard
7484 \begin_layout Standard
7485 Elsevier Science Publishers B.V.
7486 provides a standard LaTeX document class (
7490 ) for submitting articles to their various journals.
7491 The style file can be downloaded directly from their web site:
7492 \begin_inset Flex URL
7495 \begin_layout Plain Layout
7497 http://authors.elsevier.com/
7503 Instructions are supplied along with the class file, which details the
7504 requirements of the publishers.
7505 LyX includes package that allows for the use of this class, by a layout
7506 and a template file.
7507 Installation of the class file is the same as for any other LaTeX package;
7508 instructions are provided in the Elsevier documentation.
7511 \begin_layout Standard
7521 As the Elsevier class file is based mainly on the standard article class,
7522 most of the normal functionality is provided.
7523 The Elsevier class defines a number of mathematical environments, which
7524 are similar to the AMS environments.
7525 These commands are all described in the Elsevier documentation, and are
7529 \begin_layout Standard
7530 The easiest way to use the Elsevier style is to base documents on the included
7532 It is best not to use options such as fancy headings or the geometry package,
7533 as elements such as these are defined by Elsevier in their style file.
7534 Ideally, no extra packages except those mentioned in the Elsevier documentation
7536 Essentially, Elsevier require as
7537 \begin_inset Quotes eld
7541 \begin_inset Quotes erd
7544 a LaTeX file as possible, as their intention is to take the supplied file
7545 and replace the class file with one for the particular journal to which
7546 the paper has been submitted.
7547 This also means that not too much time should be spent on the formating
7549 When it comes to be published, this will change anyway.
7550 The rest of the usage for this layout is substantially the same as for
7551 the normal article class.
7552 For details of what Elsevier do and don't allow, refer to their documentation.
7555 \begin_layout Section
7564 \begin_inset CommandInset label
7573 \begin_layout Standard
7579 \begin_layout Subsection
7583 \begin_layout Standard
7584 This section describes how to use LyX to make slides for overhead projectors.
7585 There are two document classes that can do this: the default slides class
7591 This section documents the latter.
7594 \begin_layout Standard
7595 I'm going to say this again, nice and clear, so that there's no misunderstanding
7599 \begin_layout Standard
7600 \begin_inset VSpace bigskip
7606 \begin_layout Standard
7610 This section documents the class
7611 \begin_inset Quotes eld
7619 \begin_inset Quotes erd
7627 \begin_layout Standard
7628 \begin_inset VSpace bigskip
7634 \begin_layout Standard
7635 If you're looking for the documentation for
7636 \begin_inset Quotes eld
7644 \begin_inset Quotes erd
7648 \begin_inset space ~
7652 \begin_inset CommandInset ref
7654 reference "sec:slitex"
7659 If your machine doesn't have the
7664 \begin_inset Quotes eld
7672 \begin_inset Quotes erd
7675 ] installed, you'll probably have to use the default
7679 class, which isn't quite as good as
7684 \begin_layout Standard
7689 class is designed for use with version 2.1 of the
7693 LaTeX class file which is now an integral part of LaTeX2e.
7696 \begin_layout Subsection
7700 \begin_layout Standard
7701 Obviously, to use this document class, you need to select
7702 \begin_inset Quotes eld
7710 \begin_inset Quotes erd
7720 \begin_inset space ~
7726 There are some settings in the
7729 \begin_inset space ~
7734 dialog that you should know about that are specific to this class:
7737 \begin_layout Itemize
7738 Don't change the options
7749 \begin_inset space ~
7755 They're ignored by the
7762 \begin_layout Itemize
7763 The default font size is 20
7764 \begin_inset space \thinspace{}
7767 pt with the other options being 17
7768 \begin_inset space \thinspace{}
7772 \begin_inset space \thinspace{}
7776 \begin_inset space \thinspace{}
7782 \begin_layout Itemize
7791 but all math equations are still typeset in the usual roman font.
7794 \begin_layout Itemize
7799 TeX supports A4 and Letter paper sizes as well as a special size for working
7801 \begin_inset space \thinspace{}
7805 It doesn't support A5, B5, legal or executive paper sizes.
7808 \begin_layout Itemize
7809 Don't bother changing the
7813 settings because they are ignored anyway.
7814 All floats appear where they are defined in the text.
7817 \begin_layout Itemize
7822 setting behaves a bit differently for this class.
7827 TeX provides extensive footer and header capabilities including a user-defined
7830 \begin_inset space ~
7834 \begin_inset CommandInset ref
7836 reference "sec:foilfoot"
7841 The title page is treated differently to all other pages in the document
7850 has the logo centered at the bottom of the page (if one is defined).
7851 The possible page style choices and what they do are as follows:
7855 \begin_layout Labeling
7856 \labelwidthstring MMMMMMM
7863 The final output contains no page numbers, or other headers or footers
7864 (except footnotes of course).
7868 \begin_layout Labeling
7869 \labelwidthstring MMMMMMM
7876 The final output contains page numbers centered at the bottom of the page.
7877 No other headings or footers (other than footnotes).
7880 \begin_layout Labeling
7881 \labelwidthstring MMMMMMM
7886 Page numbers in lower right corner.
7887 Additional headers and footers are also shown.
7888 This is also the default.
7891 \begin_layout Labeling
7892 \labelwidthstring MMMMMMM
7897 Gives you access to the
7901 package although its use with
7905 TeX is discouraged by the writer of the
7909 TeX package because of some potential page layout clashes.
7913 \begin_layout Subsubsection
7917 \begin_layout Standard
7918 The following options may be used in the extra class options in the
7920 Document\SpecialChar \menuseparator
7926 \begin_layout Labeling
7927 \labelwidthstring MMMMMMx
7932 This sets up the page layout for 7.33
7933 \begin_inset space \thinspace{}
7937 \begin_inset space \thinspace{}
7940 in paper, which is about the same aspect ratio as a 35
7941 \begin_inset space \thinspace{}
7944 mm slide, making it a bit easier to work with this medium.
7947 \begin_layout Labeling
7948 \labelwidthstring MMMMMMx
7953 Places a rule across the page below the header on every page except the
7957 \begin_layout Labeling
7958 \labelwidthstring MMMMMMx
7963 Places a rule across the page above the footer on every page except the
7967 \begin_layout Labeling
7968 \labelwidthstring MMMMMMx
7973 This is automatically set each time you create a new
7982 TeX to use the dvips driver to rotate those pages that are set as landscape
7986 \begin_layout Labeling
7987 \labelwidthstring MMMMMMx
7992 Simply changes the page dimensions to those of a landscape page but doesn't
7994 Thus if you use this option you need to use an external program to rotate
7995 each page or feed your paper through your printer as landscape.
7996 Note that this option effectively reverses the roles of the
8004 environments (don't worry these are described in the next section).
8007 \begin_layout Labeling
8008 \labelwidthstring MMMMMMx
8013 Equation numbers on the left.
8016 \begin_layout Labeling
8017 \labelwidthstring MMMMMMx
8022 Flush-left equations.
8025 \begin_layout Subsection
8026 Supported Environments
8029 \begin_layout Standard
8030 Most of the environments commonly supported in other classes are also supported
8036 There are several additional environments provided by
8040 TeX as well as a couple added by LyX.
8041 The following environments are shared with other classes:
8044 \begin_layout Standard
8048 \begin_layout Plain Layout
8060 \begin_layout Itemize
8066 \begin_layout Itemize
8072 \begin_layout Itemize
8078 \begin_layout Itemize
8084 \begin_layout Itemize
8090 \begin_layout Itemize
8096 \begin_layout Itemize
8102 \begin_layout Itemize
8108 \begin_layout Itemize
8114 \begin_layout Itemize
8120 \begin_layout Itemize
8126 \begin_layout Itemize
8132 \begin_layout Itemize
8138 \begin_layout Itemize
8144 \begin_layout Itemize
8150 \begin_layout Itemize
8156 \begin_layout Itemize
8162 \begin_layout Itemize
8168 \begin_layout Standard
8172 \begin_layout Plain Layout
8184 \begin_layout Standard
8185 That is, all the major environments apart from the sectioning environments.
8186 Since foils are essentially self-contained sections, with a title and body,
8191 TeX provides specific commands for starting new foils and these are:
8194 \begin_layout Itemize
8200 \begin_layout Itemize
8206 \begin_layout Standard
8207 LyX also provides slightly modified versions of these two environments called:
8210 \begin_layout Itemize
8216 \begin_layout Itemize
8222 \begin_layout Standard
8223 and the differences will be explained in the next section.
8226 \begin_layout Standard
8227 Since foils are often used in presenting ideas or new theorems and such
8232 TeX also provides a comprehensive box of goodies for presenting them:
8235 \begin_layout Standard
8239 \begin_layout Plain Layout
8251 \begin_layout Itemize
8257 \begin_layout Itemize
8263 \begin_layout Itemize
8269 \begin_layout Itemize
8275 \begin_layout Itemize
8281 \begin_layout Itemize
8287 \begin_layout Itemize
8293 \begin_layout Itemize
8299 \begin_layout Itemize
8305 \begin_layout Itemize
8311 \begin_layout Itemize
8317 \begin_layout Standard
8321 \begin_layout Plain Layout
8333 \begin_layout Standard
8334 The starred versions are unnumbered while the unstarred versions are numbered.
8335 There are also two list environments added by LyX and these are:
8338 \begin_layout Itemize
8344 \begin_layout Itemize
8350 \begin_layout Standard
8355 TeX provides some powerful header and footer capabilities that are best
8356 set in the preamble although they may be set at any point in a document.
8357 If you want to change these settings in your document the best place to
8358 do so is at the very top of a foil, i.
8359 \begin_inset space \thinspace{}
8365 \begin_inset space \space{}
8370 straight after the foilhead.
8373 \begin_layout Standard
8374 For this purpose, the following command styles are provided [
8381 \begin_layout Standard
8385 \begin_layout Plain Layout
8397 \begin_layout Itemize
8401 \begin_inset space ~
8407 \begin_layout Itemize
8413 \begin_layout Itemize
8417 \begin_inset space ~
8423 \begin_layout Itemize
8427 \begin_inset space ~
8433 \begin_layout Itemize
8437 \begin_inset space ~
8444 \begin_layout Standard
8445 \begin_inset space ~
8452 \begin_layout Standard
8456 \begin_layout Plain Layout
8468 \begin_layout Standard
8469 There are also a few commands provided by
8473 TeX that aren't directly supported by LyX but I'll tell you what they do
8474 and how to use them in section
8475 \begin_inset space ~
8479 \begin_inset CommandInset ref
8481 reference "sec:unsuppfoils"
8488 \begin_layout Subsection
8489 Building a Set of Foils
8492 \begin_layout Standard
8493 This section will give a simple introduction to using the different environments
8494 to build a set of foils.
8495 If you want to see an example set of foils, take a look at the
8499 file you find in LyX's
8506 \begin_layout Subsubsection
8507 Give It a Title Page
8510 \begin_layout Standard
8511 Unlike other classes that provide
8531 creates the title on a page of its own.
8532 If you leave out the
8536 environment LaTeX will substitute the current date (every time you regenerate
8540 \begin_layout Subsubsection
8544 \begin_layout Standard
8545 As I mentioned earlier, there are four ways of starting a new foil.
8546 For portrait foils you should use
8555 The difference between these two environments is the amount of space between
8556 the title of the foil (the foilhead) and the body of the foil.
8559 \begin_layout Standard
8560 Landscape foils are generated using the
8569 Again the only difference is the spacing between foilhead and body.
8570 Both of the short versions have 0.5 inches less separation between the foilhead
8575 \begin_layout Standard
8576 One problem with the support for landscape foils is the requirement that
8581 driver to generate the PostScript output otherwise the foils won't be rotated.
8582 It is possible to get landscape foils even if you haven't got the
8586 driver provided you can feed your foils sideways through your printer ;-)
8589 \begin_layout Subsubsection
8590 Theorems, Lemmas, Proofs and more
8593 \begin_layout Standard
8594 Due to a small bug in LyX you can't have two of the same type of these environme
8595 nts directly following each other.
8596 They must be separated by something.
8597 If you try, you will just be extending the previous environment as if you
8598 had merged the two environments together.
8599 So, how do you get around this problem? The simplest option is to insert
8600 some text between the two environments or add a
8604 environment between the two with just a
8605 \begin_inset Quotes eld
8613 \begin_inset Quotes erd
8617 This will force LyX to produce two separate environments and hence the
8618 correct LaTeX output.
8619 An example is provided in the example file included with the LyX distribution.
8620 Remember, this problem only occurs if you are trying to place two of the
8621 same type of theorem-like environments one directly after the other.
8624 \begin_layout Subsubsection
8628 \begin_layout Standard
8629 You get all the commonly supported list styles found in other classes as
8630 well as two new ones.
8631 I'll only describe the new ones here.
8632 If you want to find out more about the other list environments check out
8638 If you intend to use itemized lists you might also want to read about the
8642 \begin_inset space ~
8646 \begin_inset space ~
8651 dialog described above in section
8652 \begin_inset space ~
8656 \begin_inset CommandInset ref
8658 reference "sec:bullet"
8665 \begin_layout Standard
8666 The two new list styles,
8674 , are designed to make it easier for you to create lists of do's and don'ts
8675 or right and wrong by providing dedicated environments that use a tick
8676 or a cross as the label of the list.
8677 These lists are in fact dedicated variants of the
8682 They do however require that you have the
8689 \begin_layout Subsubsection
8693 \begin_layout Standard
8698 TeX redefines the floating tables and figures so that they appear exactly
8699 where they are in the text rather than pushing them to the top of the page
8700 or to some user specified location.
8701 In fact if you change the float placement settings they are simply ignored.
8704 \begin_layout Subsubsection
8705 Page Headers and Footers
8706 \begin_inset CommandInset label
8715 \begin_layout Standard
8719 \begin_inset space ~
8728 are two commands used to control the left-footer text string.
8729 The first is meant to allow you to include a graphic logo on your foils
8731 \begin_inset Quotes eld
8739 \begin_inset Quotes erd
8743 While the second is meant to provide a classification for the audience,
8747 \begin_inset space \thinspace{}
8753 \begin_inset space \space{}
8757 It is empty by default.
8760 \begin_layout Standard
8761 The remaining page corners can be filled by
8764 \begin_inset space ~
8769 (which defaults to page numbers),
8772 \begin_inset space ~
8780 \begin_inset space ~
8788 \begin_layout Subsection
8794 \begin_inset CommandInset label
8796 name "sec:unsuppfoils"
8803 \begin_layout Standard
8804 All the commands mentioned below need to be set in a
8812 within another environment.
8815 \begin_layout Subsubsection
8819 \begin_layout Standard
8820 All lengths are adjusted using the
8843 should be replaced by the name given to the length you want to change and
8848 is the length value.
8849 All lengths should be specified in units of length such as inches (
8861 ) or relative to some document or font-based length such as
8871 \begin_layout Standard
8872 It's possible to change the spacing between a foilhead and the body of the
8873 foil by adjusting the length specified by
8880 For example, to make
8885 \begin_inset space \space{}
8888 in closer to their bodies put the following in the preamble:
8894 foilheadskip}{-0.5in}
8897 \begin_layout Standard
8898 The spacings around floats can be adjusted by setting these lengths:
8901 \begin_layout Labeling
8902 \labelwidthstring MMMMMMMMMMM
8909 Separation between the text and the top of the float
8912 \begin_layout Labeling
8913 \labelwidthstring MMMMMMMMMMM
8920 Separation between the float and the caption
8923 \begin_layout Labeling
8924 \labelwidthstring MMMMMMMMMMM
8931 Separation between the caption and the following text
8934 \begin_layout Labeling
8935 \labelwidthstring MMMMMMMMMMM
8942 You can make the captions narrower than the surrounding text by adjusting
8944 Best done relative to
8953 \begin_layout Standard
8954 There are also several title page related lengths that you may find useful
8955 if you have a long title or several authors:
8958 \begin_layout Labeling
8959 \labelwidthstring MMMMMMMMMMM
8966 Separation from headers to
8971 \begin_layout Labeling
8972 \labelwidthstring MMMMMMMMMMM
8990 \begin_layout Labeling
8991 \labelwidthstring MMMMMMMMMMM
9005 \begin_layout Labeling
9006 \labelwidthstring MMMMMMMMMMM
9022 \begin_layout Labeling
9023 \labelwidthstring MMMMMMMMMMM
9039 \begin_layout Standard
9040 The last length related command affects all the list environments.
9051 a list environment then all the vertical spacing between the list items
9053 Note that this is a command not a length so it doesn't require
9059 like the stuff mentioned above.
9062 \begin_layout Subsubsection
9066 \begin_layout Standard
9079 commands control whether the logo in the
9083 definition appear on a given page.
9090 in the preamble then none of the foils will have the logo on them.
9091 If you don't want the logo on a particular page place the
9097 directly after the foilhead of that page and the
9103 directly after the next foilhead.
9106 \begin_layout Standard
9107 If you decide to use the
9111 page style setting in the
9114 \begin_inset space ~
9119 dialog you should probably add
9129 to your preamble so headers and footers on landscape pages are correctly
9130 placed when rotated.
9131 This is due to some clashes between the page layouts provided by the
9142 \begin_layout Section
9143 Hollywood (Hollywood spec scripts)
9146 \begin_layout Standard
9152 \begin_layout Subsection
9156 \begin_layout Standard
9157 Getting the format of a Hollywood script right is a
9158 \begin_inset Quotes eld
9162 \begin_inset Quotes erd
9165 It is designed to make the readers focus on content and to be easy and
9166 familiar for the actors to read.
9167 Each page of a script should be one minute of film.
9168 Nothing goes in a script that you cannot see or hear on screen.
9169 The courier 12 pt font should be used throughout.
9173 \begin_layout Subsection
9177 \begin_layout Standard
9178 Speakers' lines should NEVER break in mid-sentence.
9179 If a speaker's lines continue over a page break, repeat the
9183 title followed by (Cont'd).
9186 \begin_layout Subsection
9190 \begin_layout Standard
9195 names as labels then cross-reference the label to insert the name.
9196 The cross-reference dialog will show the current cast of characters.
9197 You can use this to insert the speaker name in narratives also.
9200 \begin_layout Subsection
9201 Paper size and Margins
9204 \begin_layout Standard
9205 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9208 \begin_layout Subsection
9212 \begin_layout Standard
9213 The following environments are available.
9214 You can use hollywood.bind to get the bind keys shown at the right.
9217 \begin_layout Itemize
9221 \begin_inset Newline newline
9226 Used where nothing else works.
9230 \begin_layout Itemize
9236 \begin_inset space \hfill{}
9244 \begin_inset Newline newline
9247 Usually followed by something like
9248 \begin_inset Quotes eld
9252 \begin_inset Quotes erd
9258 \begin_layout Itemize
9262 \begin_inset space \hfill{}
9266 \begin_inset Newline newline
9271 Introduces a new INTERIOR camera set-up.
9272 Always followed by DAY or NIGHT, or something similar to define the lighting
9274 Everthing on this line in CAPS.
9277 \begin_layout Itemize
9281 \begin_inset space \hfill{}
9285 \begin_inset Newline newline
9290 Introduces a new EXTERIOR camera set-up.
9291 Everthing on this line in CAPS.
9294 \begin_layout Itemize
9298 \begin_inset space \hfill{}
9302 \begin_inset Newline newline
9307 The character speaking.
9310 \begin_layout Itemize
9314 \begin_inset space \hfill{}
9318 \begin_inset Newline newline
9323 Instructions to the speaker.
9324 The () are automatically inserted, but only the ( will show in LyX.
9325 Both will be printed.
9328 \begin_layout Itemize
9332 \begin_inset space \hfill{}
9336 \begin_inset Newline newline
9348 \begin_layout Itemize
9352 \begin_inset space \hfill{}
9356 \begin_inset Newline newline
9361 Camera movement instruction.
9363 \begin_inset space \thinspace{}
9367 \begin_inset space \space{}
9373 \begin_layout Itemize
9377 \begin_inset space \hfill{}
9383 \begin_layout Itemize
9387 \begin_inset space \hfill{}
9393 \begin_layout Itemize
9397 \begin_inset space \hfill{}
9403 \begin_layout Itemize
9407 \begin_inset space \hfill{}
9413 \begin_layout Subsection
9417 \begin_layout Itemize
9418 (O.S) — off screen
9421 \begin_layout Itemize
9422 (V.0) — voice over
9425 \begin_layout Itemize
9427 \begin_inset space \thinspace{}
9434 \begin_layout Itemize
9439 \begin_layout Itemize
9440 PAN — camera movement
9443 \begin_layout Itemize
9444 INSERT — cut to close-up of
9447 \begin_layout Section
9451 \begin_layout Standard
9454 Panayotis Papasotiriou
9457 \begin_layout Subsection
9461 \begin_layout Standard
9462 The ijmpc package is a set of macros that facilitates electronic manuscript
9465 International Journal of Modern Physics C
9468 Similarly, the ijmpd package is for creating manuscripts to be submitted
9471 International Journal of Modern Physics D
9474 Both journals are published by World Scientific.
9475 The corresponding document classes are named
9484 These files, together with instructions for the authors, can be downloaded
9486 \begin_inset Flex URL
9489 \begin_layout Plain Layout
9491 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9497 \begin_inset Flex URL
9500 \begin_layout Plain Layout
9502 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9508 Both packages are modified versions of the standard
9509 \begin_inset Quotes eld
9513 \begin_inset Quotes erd
9516 package, and they are almost (but not exactly) identical.
9517 Most of their features are supported by LyX.
9518 I have used LyX successfully to write articles submitted to both journals
9519 without any problem.
9522 \begin_layout Subsection
9526 \begin_layout Standard
9527 As usual, the easiest way to write a paper is to start with a template.
9530 File\SpecialChar \menuseparator
9549 This will give an (almost) empty document that includes the most common
9550 fields found in a manuscript.
9551 Simply overwrite the existing text (including the brackets,
9556 You should keep in mind the following remarks.
9559 \begin_layout Enumerate
9560 LyX won't let you change the font size and the page style of the document,
9561 because such modifications are not allowed by both packages.
9564 \begin_layout Enumerate
9565 The language of the document should not be changed.
9566 Before previewing your paper, be sure that the babel package is not used.
9567 To do this, click on
9569 Tools\SpecialChar \menuseparator
9580 checkbox in the language settings, and click on
9588 , if you wish to make this change permanent).
9591 \begin_layout Enumerate
9593 \begin_inset Quotes eld
9597 \begin_inset Quotes erd
9600 style must be used to define keywords.
9603 \begin_layout Enumerate
9604 The ijmpc package provides a style named
9605 \begin_inset Quotes eld
9608 Classification Codes
9609 \begin_inset Quotes erd
9612 , which can be used to define classification codes, such as PACS numbers.
9613 Note that this facility is not supported by the ijmpd package.
9616 \begin_layout Enumerate
9617 Several new environments are available:
9618 \begin_inset Quotes eld
9622 \begin_inset Quotes erd
9626 \begin_inset Quotes eld
9630 \begin_inset Quotes erd
9634 \begin_inset Quotes eld
9638 \begin_inset Quotes erd
9642 \begin_inset Quotes eld
9646 \begin_inset Quotes erd
9650 \begin_inset Quotes eld
9654 \begin_inset Quotes erd
9658 \begin_inset Quotes eld
9662 \begin_inset Quotes erd
9666 \begin_inset Quotes eld
9670 \begin_inset Quotes erd
9674 \begin_inset Quotes eld
9678 \begin_inset Quotes erd
9682 \begin_inset Quotes eld
9686 \begin_inset Quotes erd
9690 \begin_inset Quotes eld
9694 \begin_inset Quotes erd
9698 \begin_inset Quotes eld
9702 \begin_inset Quotes erd
9706 \begin_inset Quotes eld
9710 \begin_inset Quotes erd
9714 \begin_inset Quotes eld
9718 \begin_inset Quotes erd
9722 \begin_inset Quotes eld
9726 \begin_inset Quotes erd
9730 Their use is more or less obvious.
9731 LyX supports all these environments; it will use the proper label, text
9732 style, and numbering scheme for each of them.
9735 \begin_layout Enumerate
9736 Both packages use basic citations; the natbib package should not be used.
9737 In LyX, citation references are shown as usual; in the output, citations
9738 are shown as superscripts.
9739 If you want to use a citation as normal text, you should use the
9744 \begin_inset space \thinspace{}
9748 \begin_inset space \space{}
9752 \begin_inset Quotes eld
9756 \begin_inset space \space{}
9766 \begin_inset Quotes erd
9772 \begin_layout Enumerate
9774 \begin_inset Quotes eld
9778 \begin_inset Quotes erd
9781 section in both packages.
9782 To put acknowledgments, just use the
9783 \begin_inset Quotes eld
9787 \begin_inset Quotes erd
9793 \begin_layout Enumerate
9794 Appendices may be added to the paper,
9798 the Acknowledgments and
9803 LyX provides a special environment, called
9804 \begin_inset Quotes eld
9808 \begin_inset Quotes erd
9811 which marks the beginning of the appendices.
9812 This environment should be left blank; it just sends a LaTeX command, but
9813 nothing is really printed.
9815 \begin_inset Quotes eld
9819 \begin_inset Quotes erd
9822 is printed with blue letters, as a signal that all sections after that
9823 point are appendices.
9824 To write an appendix, use the
9825 \begin_inset Quotes eld
9829 \begin_inset Quotes erd
9833 LyX will number each appendix with capital letters, as required by both
9836 \begin_inset Quotes eld
9840 \begin_inset Quotes erd
9847 be present before the first appendix; if not, all appendices will be numbered
9848 as normal sections in the output.
9851 \begin_layout Enumerate
9852 The ijmpc and the ijmpd packages use the
9856 command to implement table captions.
9857 As a result, a table created by LyX is printed correctly, but its caption
9859 However, you can use some TeX code to overpass this problem, so that captions
9860 are printed as expected.
9861 To do so, create a float table as usual, remove the caption, and replace
9862 it with the TeX code
9872 (sic); you must also the TeX code
9876 immediately after the tabular material.
9877 Study the example table included in the template files to see how this
9878 trick is implemented.
9879 Alternatively, If you need table captions, you should implement the whole
9884 file, then include this file to the LyX document (
9886 Insert\SpecialChar \menuseparator
9887 File\SpecialChar \menuseparator
9889 \begin_inset space ~
9895 Details on how to create a table float can be found in the files
9903 , included in the corresponding packages.
9906 \begin_layout Subsection
9907 Preparing a paper for submission
9910 \begin_layout Standard
9911 Before you submit your paper you must export the LyX document as a LaTeX
9914 File\SpecialChar \menuseparator
9915 Export\SpecialChar \menuseparator
9926 \begin_layout Plain Layout
9927 Actually you have the choice between LaTeX (plain) and pdflatex.
9928 If you intend to use pdflatex to prepare the paper, you should use the
9929 pdflatex option so that included graphics are converted to PDF format,
9930 ready for use by pdflatex.
9935 , then make the following changes to the resulting
9942 \begin_layout Enumerate
9943 Remove the comment lines before the
9952 \begin_layout Enumerate
9953 Remove everything between (and including) the
9965 commands, except for any commands you specifically put into the LaTeX preamble.
9968 \begin_layout Standard
9973 file should be saved and processed through LaTeX as many times as necessary.
9974 You may also want to check the resulting
9981 \begin_layout Subsection
9985 \begin_layout Standard
9986 The use of TeX code is reduced to two commands, which must be placed at
9987 the top of the document.
9988 If you started writing your paper by using the
9996 template, the TeX code needed is already in its place; you usually don't
9998 You may only modify the first TeX code to specify the information printed
9999 to the top of odd and even pages (authors' names and short paper's title,
10001 This TeX code must have the form
10005 markboth{Authors' Names}{Short Paper's Title}
10010 \begin_layout Section
10014 \begin_layout Standard
10020 \begin_layout Subsection
10024 \begin_layout Standard
10025 The iopart package provides a document class to create electronic manuscript
10026 submission to the journals published by the Institute of Physics.
10027 Instructions for the authors how to create a paper using the iopart class
10028 can be downloaded together with the iopart package from the site
10029 \begin_inset Flex URL
10032 \begin_layout Plain Layout
10034 ftp://ftp.iop.org/pub/journals/latex2e
10042 \begin_layout Subsection
10046 \begin_layout Standard
10047 The easiest way to write a paper is to start with the file
10051 that is available in LyX's examples files folder.
10052 Open this file, save it under a new name, and start writing.
10053 The example file explains how to use the special text environments.
10054 Here are the most important advices:
10057 \begin_layout Itemize
10058 To be able to compile your document to a PDF, PS, or DVI, assure that the
10061 Use AMS math package
10063 in the document settings under
10070 \begin_layout Itemize
10073 The title environment defines the kind of your paper.
10074 So use one of the following environments for the title:
10078 \begin_layout Itemize
10087 \begin_layout Itemize
10096 \begin_layout Itemize
10102 for a Topical review
10105 \begin_layout Itemize
10114 \begin_layout Itemize
10123 \begin_layout Itemize
10129 for a Paper (same as Title)
10132 \begin_layout Itemize
10138 for a Preliminary communication
10141 \begin_layout Itemize
10147 for a Rapid communication
10150 \begin_layout Itemize
10156 for a Letter to the editor
10160 \begin_layout Itemize
10163 All title environments except of
10167 can have an optional short title.
10170 \begin_layout Itemize
10171 There is a general title environment
10175 which is not directly supported by the LyX.
10176 This can be used as TeX code when your document doesn't fit into one of
10177 the other title types.
10180 \begin_layout Standard
10181 For more informations like hints for special table and formula formatting,
10182 look at the IOP author guidelines.
10185 \begin_layout Section
10189 \begin_layout Standard
10192 Panayotis Papasotiriou
10195 \begin_layout Subsection
10199 \begin_layout Standard
10200 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10201 that facilitates electronic manuscript submission to the journals they
10203 Most known of them (at least in my domain of interest) are
10205 Astrophysics and Space Science
10211 , but there are many others (see a complete list at
10212 \begin_inset Flex URL
10215 \begin_layout Plain Layout
10217 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10223 The Kluwer package may be downloaded from the site
10224 \begin_inset Flex URL
10227 \begin_layout Plain Layout
10229 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10235 A complete user guide is contained in that package (but it can also be
10236 downloaded separately).
10239 \begin_layout Standard
10240 LyX supports many features of the package but not everything.
10241 However, the TeX code needed is reduced to some
10242 \begin_inset Quotes eld
10246 \begin_inset Quotes erd
10249 commands of the package (see
10250 \begin_inset space ~
10254 \begin_inset CommandInset ref
10256 reference "subsec:kluwer_peculiarities"
10261 I have recently used LyX to write an article submitted to the
10263 Astrophysics and Space Science
10265 without any problem.
10268 \begin_layout Subsection
10272 \begin_layout Standard
10273 The easiest way to write a paper is to start with the Kluwer template file.
10276 File\SpecialChar \menuseparator
10288 This will give an (almost) empty document that includes the most common
10289 fields found in a manuscript and a short description of their use.
10290 As in most templates, simply overwrite the existing text (including the
10295 ) with the correct information.
10298 \begin_layout Subsection
10299 Preparing a paper for submission
10302 \begin_layout Standard
10303 As in the AASTeX package, before you submit your paper to a journal you
10305 \begin_inset Quotes eld
10309 \begin_inset Quotes erd
10315 \begin_layout Enumerate
10316 Export your paper as a LaTeX file.
10317 To do this, click on
10319 File\SpecialChar \menuseparator
10320 Export\SpecialChar \menuseparator
10327 \begin_layout Enumerate
10332 file with a text editor and make the following changes
10336 \begin_layout Enumerate
10337 remove the comment lines before the
10346 \begin_layout Enumerate
10347 remove everything between (and including) the
10359 commands, except for any commands you specifically put into the LaTeX preamble.
10362 \begin_layout Standard
10371 \begin_layout Enumerate
10376 file through LaTeX as many times as necessary (usually up to three).
10379 \begin_layout Enumerate
10385 \begin_inset space \thinspace{}
10389 \begin_inset space \space{}
10396 , and check if everything is OK (it should, if you didn't make any mistake).
10399 \begin_layout Subsection
10400 \begin_inset Quotes eld
10404 \begin_inset Quotes erd
10407 of the Kluwer package
10408 \begin_inset CommandInset label
10410 name "subsec:kluwer_peculiarities"
10417 \begin_layout Standard
10418 The Kluwer package has the following
10419 \begin_inset Quotes eld
10423 \begin_inset Quotes erd
10429 \begin_layout Enumerate
10430 It is possible to write multiple articles in the same LaTeX file
10434 \begin_layout Plain Layout
10435 I can't imagine any good reason to do this.
10441 Each article must be included in the environment
10442 \begin_inset Quotes eld
10446 \begin_inset Quotes erd
10450 Unfortunately, this environment cannot be omitted, even if you write just
10452 Therefore, each article starts with the command
10458 and, obviously, ends with the command
10465 Although this can be implemented in LyX, I didn't included it, since it
10466 looks ugly and can confuse the novice user.
10467 Therefore, you need to enter them directly and mark them as LaTeX code
10469 \begin_inset Quotes eld
10473 \begin_inset Quotes erd
10479 \begin_layout Enumerate
10480 Information given at the beginning of the article (i.
10481 \begin_inset space \thinspace{}
10485 \begin_inset space \space{}
10488 title, subtitle, author, institution, running title, running author, abstract
10489 and keywords) must be included in an environment called
10490 \begin_inset Quotes eld
10494 \begin_inset Quotes erd
10498 This is not implemented in LyX, so you must enter title, subtitle etc.
10499 \begin_inset space ~
10502 between two TeX code lines (
10517 \begin_layout Enumerate
10518 According to the user manual, the label of each bibliography item must be
10542 \begin_layout Standard
10547 template takes care of all these
10548 \begin_inset Quotes eld
10552 \begin_inset Quotes erd
10556 If you start a new paper using this template you don't need to do anything
10561 \begin_layout Enumerate
10562 don't delete the TeX code included in the template, and
10565 \begin_layout Enumerate
10566 copy the example bibliography item included in the template and modify it
10567 as necessary to enter new bibliography items.
10570 \begin_layout Section
10574 \begin_layout Standard
10580 \begin_layout Subsection
10584 \begin_layout Standard
10585 The LyX document classes
10587 article (koma-script)
10591 report (koma-script)
10609 correspond to the LaTeX document classes
10626 \begin_inset space ~
10629 of the Koma-Script family.
10630 They are replacements for the standard document classes
10646 , resp., and fit better to European typography conventions in a number of
10650 \begin_layout Itemize
10651 Standard character size is 11pt in
10653 article (koma-script)
10657 report (koma-script)
10665 letter (koma-script)
10670 \begin_layout Itemize
10671 Headings, labels of the description environment, and a number of elements
10674 letter (koma-script)
10676 document class are set in a bold sans serif font.
10680 \begin_layout Plain Layout
10681 There is a big difference between the bold sans serif old cm fonts and new
10682 ec fonts, especially in the appearance of headings.
10683 In comparison, the ec bold sans serif fonts look a bit thin.
10684 Here the LaTeX package
10692 helps to produce the
10693 \begin_inset Quotes eld
10697 \begin_inset Quotes erd
10700 appearance when using the ec fonts.
10705 The numbering of chapter headings is made in the same way as the numbering
10706 of section headings, that is without the extra line
10707 \begin_inset Quotes eld
10710 Chapter\SpecialChar \ldots{}
10712 \begin_inset Quotes erd
10716 In addition, the appearance of the headings can be modified by using a
10717 number of options (in LyX to be entered in the field
10720 \begin_inset space ~
10727 Layout\SpecialChar \menuseparator
10731 A detailed German description of these options can be found in the Koma-Script
10739 \begin_layout Itemize
10740 The main means in the Koma-Script document classes to design the type area
10749 (in LyX to be entered in the extra class options field in the dialog
10751 Document\SpecialChar \menuseparator
10755 They make a clearer modification of page margins possible as do the options
10758 Document\SpecialChar \menuseparator
10762 A detailed German description of these and other type area options can
10763 be found in the Koma-Script documentation
10770 \begin_layout Itemize
10771 The LaTeX document classes of the Koma-Script family define a number of
10772 additional commands.
10773 Those part of it which makes sense in LyX is implemented in corresponding
10777 \begin_layout Standard
10778 A detailed German description of the LaTeX document classes of the Koma-Script
10779 family can be found in the Koma-Script documentation
10787 \begin_layout Plain Layout
10788 There is an English translation
10792 , but it is not a complete one.
10797 The following sections describe only those aspects, which are relevant
10801 \begin_layout Subsection
10802 article (koma-script), report (koma-script), and book (koma-script)
10805 \begin_layout Standard
10806 The document classes
10808 article (koma-script)
10812 report (koma-script)
10822 are implemented in the layout files
10835 They contain all the paragraph types of the corresponding standard document
10848 , resp., partly modified, with the exception of the LyX specific
10852 -type, which is replaced by the new
10856 -type having the same functionality.
10861 -Type there is a number of new paragraph types added.
10868 letter (koma-script)
10873 \begin_layout Itemize
10882 : are equivalents to
10890 , resp., additionally inserting an entry in the table of contents.
10899 are not contained in
10901 article (koma-script)
10906 \begin_layout Itemize
10915 : behave exactly as
10923 , resp., additionally clearing running heads.
10928 is not contained in
10930 article (koma-script)
10936 \begin_layout Plain Layout
10949 report (koma-script)
10951 , but since this is identical to
10955 , is has not been implemented in LyX.
10963 \begin_layout Itemize
10968 : generates a heading directly above the following paragraph in the standard
10969 character size without affecting the structure of the document.
10972 \begin_layout Itemize
10981 are special captions which respect the different space settings needed
10982 for captions placed above or below an element (if you follow strict typographic
10983 rules, you might want to place table captions always above the table).
10984 You can also use the class option
10988 , which will switch
11001 You need at least Koma-Script version 2.8q to use this.
11004 \begin_layout Itemize
11009 : can be used to set a bonmot, e.
11010 \begin_inset space \thinspace{}
11014 \begin_inset space \space{}
11017 at the beginning of a chapter.
11018 If you use the optional argument (
11020 Insert\SpecialChar \menuseparator
11022 \begin_inset space ~
11027 ), you can insert the dictum's author there.
11028 Dictum and author are separated by a line.
11029 You need at least Koma-Script version 2.8q to use this.
11034 is not contained in
11036 article (koma-script)
11041 \begin_layout Standard
11042 The following types, together with the standard types
11054 , form the title area of the document.
11055 They must be entered ahead of the first
11056 \begin_inset Quotes eld
11060 \begin_inset Quotes erd
11067 \begin_layout Plain Layout
11068 The corresponding LaTeX commands must appear before the
11079 When such a type is used more than once, the latter usage overwrites the
11080 former one, that means, for every type only the latest usage is valid.
11081 The order of the different types however has, like
11093 , no effect on the appearance of the produced document.
11096 \begin_layout Itemize
11101 : produces a centered paragraph above the ordinary title (
11113 ) for the subject of the document.
11116 \begin_layout Itemize
11121 : produces a centered paragraph below the ordinary title (
11133 ) for the publishers' name.
11136 \begin_layout Itemize
11143 report (koma-script)
11149 produces a centered paragraph on its own page behind the title page, or
11152 article (koma-script)
11154 produces a centered paragraph below the ordinary title (
11170 ) for a dedication.
11173 \begin_layout Itemize
11178 : produces a left aligned paragraph above the ordinary title (
11194 ) for a document`s head.
11197 \begin_layout Itemize
11202 : produces in a double-sided print in
11204 report (koma-script)
11210 a left-aligned paragraph at the top of the title page`s back or has no
11211 effect in a single-sided print or in
11213 article (koma-script)
11218 \begin_layout Itemize
11223 : produces in a double-sided print in
11225 report (koma-script)
11231 a left-aligned paragraph at the bottom of the title page`s back or has
11232 no effect in a single-sided print or in
11234 article (koma-script)
11239 \begin_layout Itemize
11244 : produces a special
11245 \begin_inset Quotes eld
11249 \begin_inset Quotes erd
11252 page ahead of the actual document containing a paragraph without special
11256 \begin_layout Standard
11257 The layout files for the document classes
11259 article (koma-script)
11263 report (koma-script)
11269 do include the file
11274 This is thought of as a place to define your own types.
11279 in your personal layout directory and edit the file!
11282 \begin_layout Subsection
11283 letter (koma-script)
11286 \begin_layout Standard
11290 \begin_layout Plain Layout
11302 \begin_layout Standard
11306 letter (koma-script)
11308 is implemented in the layout file
11313 It contains all the paragraph types of the corresponding standard document
11318 , partly modified, with the exception of the LyX specific types
11330 type, which is replaced by the new
11335 In addition, it contains, in contrast to the standard document class, the
11353 Furthermore, there are a number of new letter specific types.
11356 \begin_layout Standard
11360 \begin_layout Plain Layout
11372 \begin_layout Standard
11373 The appearance of the letter produced by this document class can be controlled
11374 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11378 \begin_layout Plain Layout
11379 For example, the standard appearance of the letter`s heading, consisting
11380 of name and address, is quite self-willed.
11382 \begin_inset Quotes eld
11386 \begin_inset Quotes erd
11389 heading is produced by the following LaTeX commands in the preamble:
11392 \begin_layout LyX-Code
11402 \begin_layout LyX-Code
11418 \begin_layout LyX-Code
11428 \begin_layout LyX-Code
11448 A detailed German description of such LaTeX commands can be found in the
11449 Koma-Script documentation
11454 With it, the letter's author can produce his personal letter layout.
11457 \begin_layout Standard
11466 define the beginning of the letter and must be used in every letter.
11467 To emphasize them in the LyX document class, they are marked with the letter
11477 \begin_inset space ~
11480 in the left margin.
11481 It is possible to write any number of letters in one file.
11486 type produces a new letter using the same addressee and a
11490 type produces a new addressee.
11507 are ordinary paragraph types and can also be used several times in one
11508 and the same letter.
11511 \begin_layout Itemize
11516 : produces a paragraph for the addressee and implicitly defines the beginning
11520 \begin_layout Itemize
11525 : produces a paragraph for the form of address and implicitly produces a
11529 \begin_layout Itemize
11534 : produces a paragraph for a close.
11537 \begin_layout Itemize
11542 : produces a paragraph for a postscript.
11545 \begin_layout Itemize
11550 : produces a paragraph for a distribution list.
11553 \begin_layout Itemize
11558 : produces a paragraph for enclosures.
11561 \begin_layout Standard
11602 are input types provided with a label to enter information, which will
11603 be processed by the document class.
11607 \begin_layout Plain Layout
11608 It could be seen as a matter of inconsequence, that the types
11616 described above are not such input types as well.
11617 Because of the special meaning of those types, however, I have implemented
11618 them as ordinary paragraph types with a one letter mark in the left margin.
11619 Moreover, it would affect my feeling of symmetry, if the
11627 type had such a serious different appearance.
11632 The types must be used ahead of the corresponding
11639 \begin_layout Standard
11640 An implementation of these types in a WYSIWYG fashion does not seem to make
11641 sense, because the real appearance of the produced letter does not only
11642 depend on the usage of the particular type, but also on other factors.
11643 For example, a signature entered in the
11647 type will in the standard behavior appear in the produced letter only,
11648 when in the same letter also a
11653 The entered value of the
11657 type will in the standard behavior not appear in the produced letter at
11659 The possibility to design the letter`s heading freely is already indicated
11660 in a footnote above.
11663 \begin_layout Standard
11664 The input types can also be used as empty paragraphs.
11665 This makes sense e.
11666 \begin_inset space \thinspace{}
11670 \begin_inset space \space{}
11682 type is not used at all, in the standard behavior the value of the
11686 type is used as signature, whereas if an empty
11690 type is used, no signature value is defined.
11693 \begin_layout Standard
11694 By using the input types it is possible to write a letter template, containing
11695 filled input types with your personal dates (name, address, etc.) and empty
11696 input types for other dates you want to enter.
11699 \begin_layout Itemize
11704 : sender's name, in the standard behavior appears as a centered paragraph
11705 in small caps in the letter`s heading.
11708 \begin_layout Itemize
11713 : sender's signature, in the standard behavior appears below the
11722 type is used, the value of the
11726 type appears instead.
11729 \begin_layout Itemize
11734 : sender's address, in the standard behavior appears in a centered paragraph
11735 in the letter`s heading below the sender's name.
11738 \begin_layout Itemize
11743 : sender's telephone number, in the standard behavior only sets the LaTeX
11753 \begin_layout Itemize
11758 : place of the letter`s making.
11761 \begin_layout Itemize
11766 : date of the letter`s making.
11775 , in the standard behavior, produce the place and the date in a right-aligned
11776 line below the addressee's field.
11781 type is used, neither place nor date appear, independent of the value of
11791 type is used, the date of the letter `s production is used.
11794 \begin_layout Itemize
11799 : sender`s back address, in the standard behavior appears above the addressee's
11800 field in a small sans serif font.
11803 \begin_layout Itemize
11808 : special mail information, in the standard behavior appears underlined
11809 above the addressee's field below the back address.
11812 \begin_layout Itemize
11817 : additional information, in the standard behavior appears on right side
11818 below the addressee`s field.
11821 \begin_layout Itemize
11826 : the letter's title, in the standard behavior appears in a big, bold, sans
11827 serif font above the subject.
11830 \begin_layout Itemize
11835 : the letter's subject, in the standard behavior appears in a bold font
11843 \begin_layout Standard
11864 produce a business letter like line above the
11868 line containing the fields
11869 \begin_inset Quotes eld
11873 \begin_inset Quotes erd
11877 \begin_inset Quotes eld
11881 \begin_inset Quotes erd
11885 \begin_inset Quotes eld
11889 \begin_inset Quotes erd
11893 \begin_inset Quotes eld
11897 \begin_inset Quotes erd
11901 \begin_inset Quotes eld
11905 \begin_inset Quotes erd
11909 \begin_inset Quotes eld
11913 \begin_inset Quotes erd
11917 For the date field, the value of the
11923 \begin_inset Quotes eld
11926 business letter types
11927 \begin_inset Quotes erd
11930 is used, the value of the
11934 type however does not appear, but only the LaTeX variable
11941 The ordinary output of place and date in a right-aligned line below the
11942 addressee`s field is suppressed.
11943 The types are implemented as input types provided with a label and must
11944 be used ahead of the corresponding
11951 \begin_layout Itemize
11959 \begin_layout Itemize
11967 \begin_layout Itemize
11975 \begin_layout Itemize
11983 \begin_layout Itemize
11991 \begin_layout Subsection
11992 The new letter class: letter (koma-script v.2)
11995 \begin_layout Standard
11998 Jürgen Spitzmüller
12001 \begin_layout Standard
12002 \begin_inset VSpace medskip
12008 \begin_layout Standard
12010 Koma-Script version 2.8 has introduced a new letter class
12014 which supersedes the now unsupported
12019 It has — on the LaTeX side — a completely new interface and is not compatible
12020 with the old class.
12021 Therefore, LyX supports both, though it is recommended to use the new class.
12024 \begin_layout Standard
12025 This class covers the same functionality as
12027 letter (koma-script),
12030 The basic items are
12034 (receiver's address, same as
12038 in the old layout),
12051 will start a new letter (i.
12052 \begin_inset space \thinspace{}
12056 \begin_inset space \space{}
12059 you can write several letters per document).
12060 New elements are sender's
12076 and the possibility to use a
12082 Insert\SpecialChar \menuseparator
12088 \begin_layout Standard
12089 The biggest improvement is, though, that the letter's layout is configurable
12090 at almost any needs.
12091 This can be done via the preamble or with a special style file (Letter
12092 Class Option, extension
12096 ), that will be read in as a class option.
12100 \begin_layout Plain Layout
12101 The KOMA package comes with some default
12106 There is, for instance, a
12110 file that follows german typesetting rules, or a
12114 that provides the default layout of the old
12119 The latter can be loaded with the class option
12128 ayout\SpecialChar \menuseparator
12133 ocument\SpecialChar \menuseparator
12145 template that is included in LyX for examples.
12146 A detailed description is to be found in the Koma-Script documentation
12154 \begin_layout Subsection
12158 \begin_layout Standard
12159 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12163 \begin_layout Itemize
12164 The chapter number of a
12168 type appears on a line of its own above the chapter heading instead of
12169 appearing in the same line ahead of it.
12170 The cause for that is the LyX internal behavior for the labeltype
12174 in the layout file.
12177 \begin_layout Itemize
12178 The headings of the types
12186 are only put in the
12187 \begin_inset Quotes eld
12191 \begin_inset Quotes erd
12194 LaTeX table of contents, but not in the LyX table of contents (
12196 Document\SpecialChar \menuseparator
12198 \begin_inset space ~
12202 \begin_inset space ~
12210 \begin_layout Itemize
12211 The paragraphs in a
12215 document class appear in a skip separation mode, not indented.
12216 This is the standard behavior, no special LaTeX commands are needed for
12220 Document\SpecialChar \menuseparator
12223 dialog the corresponding radio button indicates
12232 value always has the effect that extra LaTeX commands are inserted in the
12233 document to produce the gap, which is not what is wanted in this case.
12236 \begin_layout Section
12237 Latex8 (IEEE Conference Papers)
12240 \begin_layout Standard
12246 \begin_layout Subsection
12250 \begin_layout Standard
12251 Since this class is specifically for writing submissions to IEEE sponsored
12252 conferences I strongly recommend that you get a copy of their Authors Kit.
12257 package and associated bibliography style file is included in the kit.
12258 The Authors Kit is usually sent out by email once your initial submission
12260 There is a lot of useful information in the Authors Kit explaining formatting
12261 restrictions and so on and I will assume you have read this since that
12262 means I don't have to repeat it all here.
12265 \begin_layout Subsection
12269 \begin_layout Standard
12270 [AR\SpecialChar \@.
12274 \begin_layout Subsection
12275 Supported Environments
12278 \begin_layout Itemize
12284 \begin_layout Itemize
12290 \begin_layout Itemize
12296 \begin_layout Itemize
12302 \begin_layout Itemize
12308 \begin_layout Itemize
12314 \begin_layout Itemize
12320 \begin_layout Itemize
12326 \begin_layout Itemize
12332 \begin_layout Subsection
12333 Differences Between Screen and Paper
12336 \begin_layout Standard
12337 There are slight differences in appearance mainly with the presentation
12338 of section counters.
12339 On screen the trailing period of the section counter is missing but it
12340 will appear in the output so don't let this worry you.
12343 \begin_layout Section
12347 \begin_layout Standard
12350 Jürgen Spitzmüller
12353 \begin_layout Subsection
12357 \begin_layout Standard
12358 Memoir is a very powerful and constantly evolving class.
12359 It has been designed with regard to fictional and non-fictional literature.
12360 Its aim is to let the user have maximum control over the typesetting of
12362 Memoir is based on the standard book class, but it can also emulate the
12363 article class (see below).
12366 \begin_layout Standard
12367 Peter Wilson, the developer of Memoir, is known as the author of lots of
12368 useful packages in the LaTeX world.
12369 Most of them have been merged with Memoir.
12370 Therefore, it is much easier to layout the table of contents, appendices,
12371 chapter designs and such.
12372 LyX, though, does not support all of these goodies natively.
12373 Some of them might be added to forthcoming releases
12377 \begin_layout Plain Layout
12378 You are invited to send suggestions to
12379 \begin_inset Flex URL
12382 \begin_layout Plain Layout
12384 lyx-devel@lists.lyx.org
12394 , lots will probably never, due to the limitations of LyX's framework.
12395 Of course you can still use all features with the help of some native LaTeX
12400 \begin_layout Plain Layout
12405 \begin_layout Plain Layout
12415 \begin_inset space ~
12419 \begin_inset CommandInset ref
12421 reference "sec:Inserting-TeX-Code"
12431 In this section, we can only list those features which are natively supported
12433 For detailed descriptions (and for the rest of features) we are recommending
12434 to have a look at the detailed manual of the Memoir class
12438 \begin_layout Plain Layout
12443 \begin_layout Plain Layout
12453 \begin_inset Flex URL
12456 \begin_layout Plain Layout
12458 CTAN:/macros/latex/memoir/memman.pdf
12468 , which is not only a user guide for the class, but also both a comprehensive
12469 description on good typesetting and a superb example for good typesetting
12473 \begin_layout Subsection
12474 Basic features and restrictions
12477 \begin_layout Standard
12478 Memoir supports basically all features of the standard book classes.
12479 There are, however, some differences, as follows:
12482 \begin_layout Description
12484 \begin_inset space ~
12487 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12490 \begin_layout Description
12492 \begin_inset space ~
12495 style: The fancy page style is not supported, due to a command clash between
12496 Memoir and the fancyhdr package (they are both defining a command with
12497 the same name, which confuses LaTeX).
12498 Instead, Memoir comes with a bunch of own page styles (see
12500 Layout\SpecialChar \menuseparator
12501 Document\SpecialChar \menuseparator
12503 \begin_inset space ~
12509 If you want to use these for the chapter pages, you have to use the command
12516 in the main text or in preamble (e.
12517 \begin_inset space \thinspace{}
12521 \begin_inset space \space{}
12528 chapterstyle{companion}
12533 \begin_layout Description
12534 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12535 an optional argument in the standard classes.
12536 With this, you can specify an alternative version of the title for the
12537 table of contents and the headers (for instance, if the title is too long).
12538 In LyX, you can do this via
12540 Insert\SpecialChar \menuseparator
12542 \begin_inset space ~
12547 at the beginning of a chapter/section.
12548 Memoir features a second optional argument and thus separates the table
12549 of contents from the header.
12550 You can define three variants of a title with this: one for the main text,
12551 one for the table of contents, and one for the headers.
12552 Simply insert two optional arguments if you need this feature, the first
12553 one containing the short title for the Table of Contents, the second one
12554 containing an alternative short title for the headers.
12557 \begin_layout Description
12558 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12559 of contents, the list of figures and the list of table start a new page
12561 Memoir does not follow this route.
12562 You have to insert a page break yourself, if you want to have one.
12565 \begin_layout Description
12566 Titlepage: For some unknown reason, Memoir uses pagination on the title
12567 page (in the standard classes, title pages are
12568 \begin_inset Quotes eld
12572 \begin_inset Quotes erd
12576 \begin_inset space \thinspace{}
12580 \begin_inset space \space{}
12584 If you want an empty title page, type
12588 aliaspagestyle{title}{empty}
12593 \begin_layout Description
12594 Article: With the class option
12600 Layout\SpecialChar \menuseparator
12601 Document\SpecialChar \menuseparator
12603 \begin_inset space ~
12608 ), you can emulate article style.
12609 That is, counters (footnotes, figures, tables etc.) will not be reset on
12610 new chapters, chapters don't start a new page (but are—in contrary to
12611 \begin_inset Quotes eld
12615 \begin_inset Quotes erd
12618 article classes—still allowed), parts, though, use their own page, as in
12622 \begin_layout Description
12623 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12624 font commands, which have been used in the old LaTeX version 2.09 (e.
12625 \begin_inset space \thinspace{}
12629 \begin_inset space \space{}
12645 It produces an error and stops LaTeX whenever such a command appears.
12650 reallows the commands and spits out warnings instead (which does at least
12652 Since a lot of packages and particularly BibTeX style files are still using
12653 those commands, we have decided to use this option by default.
12656 \begin_layout Subsection
12660 \begin_layout Standard
12661 We will only describe the features supported by LyX (which is not much currently
12663 Please consult the Memoir manual
12667 \begin_layout Plain Layout
12672 \begin_layout Plain Layout
12682 \begin_inset Flex URL
12685 \begin_layout Plain Layout
12687 CTAN:/macros/latex/memoir/memman.pdf
12700 \begin_layout Description
12701 Abstract: You may wonder why an abstract is an extra feature.
12702 Well, it is in book class.
12703 Usually books don't have abstracts.
12704 Memoir, however, has.
12705 You can use it wherever and how often you like.
12708 \begin_layout Description
12709 Chapterprecis: You may know this from belletristic: The contents of a chapter
12710 is shortly described below the title and also in the table of contents
12712 \begin_inset space \thinspace{}
12716 \begin_inset space \space{}
12721 Our hero arrives in Troia; he loses some friends; he finds others
12724 Chapterprecis does exactly this.
12725 It is therefore only sensible below a chapter.
12728 \begin_layout Description
12729 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12730 The epigraph environment provides an elegant way of typesetting such a
12732 The motto itself (text) and its author (source) are divided by a short
12734 Unfortunately, we have to fool LyX a bit here again, since the environment
12735 needs two arguments (text and source).
12736 In this case, we have to use curly brackets (in TeX mode) between the two
12747 <author of the slogan>.
12750 \begin_layout Description
12751 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12752 complex figurative poems).
12753 LyX can only support a few of them.
12754 One is poemtitle, which is a centered title for poems, which will also
12755 be added to the table of contents (verse is the standard environment for
12757 Memoir has some enhanced versions of verse, but you need to use TeX code,
12758 because they have to be nested inside regular verse environments, which
12759 is not possible with LyX).
12762 \begin_layout Description
12763 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12766 \begin_layout Section
12767 Article (mwart), book (mwbk) and report (mwrep)
12768 \begin_inset OptArg
12771 \begin_layout Plain Layout
12784 \begin_layout Standard
12790 \begin_layout Standard
12791 The LyX document classes
12807 correspond to the LaTeX document classes
12820 They are replacements for the standard document classes
12832 , resp., and fit better to Polish typography conventions in a number of points.
12836 \begin_layout Standard
12840 \begin_layout Itemize
12841 Unnumbered titles (with star, e.
12842 \begin_inset space \thinspace{}
12846 \begin_inset space \space{}
12853 ) are added into table of contents,
12856 \begin_layout Itemize
12857 Additional page styles:
12861 \begin_layout Description
12862 uheadings header with separated lines,
12865 \begin_layout Description
12866 myheadings custom header, contents headers via commands:
12881 \begin_layout Description
12882 myuheadings custom header with separated lines,
12885 \begin_layout Description
12886 outer page number is placed on outer side of page
12890 \begin_layout Itemize
12895 \begin_layout Description
12896 rmheadings serif titles — default,
12899 \begin_layout Description
12900 sfheadings sansserif titles,
12903 \begin_layout Description
12904 authortitle on title page first placed is author next title — default,
12907 \begin_layout Description
12908 titleauthor on title page first placed is title next author,
12911 \begin_layout Description
12912 withmarginpar reserve place on page for margins.
12916 \begin_layout Section
12920 \begin_layout Standard
12925 provides an alternative to the standard
12930 It provides similar functionality, but you might prefer this layout with
12931 sans serif sections, headings, and more.
12934 \begin_layout Section
12938 \begin_layout Standard
12944 \begin_layout Standard
12945 \begin_inset VSpace bigskip
12951 \begin_layout Standard
12956 \begin_inset space ~
12961 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12962 \begin_inset Formula $\beta$
12965 release of May, 1999) class.
12968 \begin_layout Standard
12973 textclass, which works with RevTeX 3.1.
12974 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12975 That means that it doesn't interact very well with LyX, which requires
12976 LaTeX2e, although it has been kludged to work.
12977 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
12981 \begin_inset space ~
12986 textclass should also be pretty easy to use.
12989 \begin_layout Standard
12990 These documents are supposed to be used in
12994 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
12995 macros, and assume you'll know what to put in the preamble if necessary.
12998 \begin_layout Subsection
13002 \begin_layout Standard
13003 All you need to do is install RevTeX 4, as described in the package's README
13005 The package can be found at The RevTeX 4 Web Site
13006 \begin_inset Flex URL
13009 \begin_layout Plain Layout
13011 http://publish.aps.org/revtex4/
13017 Install it somewhere that LaTeX can see it.
13018 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13020 \begin_inset space \thinspace{}
13024 \begin_inset space \space{}
13027 not the directory where you installed the class file.) Then, if you reconfigure
13028 LyX, it will find the class file and let you use the RevTeX4 textclass.
13031 \begin_layout Standard
13032 Probably the easiest way to get started is either to import a RevTeX 4 document
13040 \begin_inset space ~
13045 template, found in the templates directory.
13048 \begin_layout Subsection
13052 \begin_layout Standard
13053 Optional arguments to
13060 \begin_inset Quotes eld
13064 \begin_inset Quotes erd
13068 \begin_inset Quotes eld
13072 \begin_inset Quotes erd
13082 \begin_inset space ~
13090 \begin_inset space ~
13096 Remember that in RevTeX, at least one optional argument is required!
13099 \begin_layout Standard
13100 Other preamble matter, like
13107 \begin_inset space ~
13117 \begin_inset space ~
13122 dialog, also as usual.
13125 \begin_layout Subsection
13129 \begin_layout Standard
13130 The layouts basically correspond to the commands in RevTeX4.0.
13131 For example, the Email layout corresponds to
13138 Note that (at least as of RevTeX 4.0 Beta), the
13146 layouts are exactly equivalent, so you shouldn't need to use both.
13150 \begin_layout Plain Layout
13151 In case you're curious, both were included so that
13155 would be able to translate both
13175 \begin_layout Subsection
13179 \begin_layout Standard
13180 There are a couple of important unique aspects of RevTeX 4 which might cause
13181 bugs that will be even more confusing in LyX.
13184 \begin_layout Standard
13202 The LyX equivalent is that there is a separate Thanks layout.
13207 write footnotes in the
13211 layout, or weird things may happen.
13212 See the RevTeX 4 documentation for more details.
13215 \begin_layout Standard
13219 \begin_inset space ~
13227 \begin_inset space ~
13236 layouts must be placed
13244 layout and the corresponding
13261 , the LaTeX won't compile.
13264 \begin_layout Subsection
13268 \begin_layout Standard
13269 The main problem with this layout is that you can't use the optional arguments
13270 to layouts like Email and Title.
13271 (The problem is not unique to this layout; you can't use optional arguments
13272 to the Section layouts either.) This means that after you export that file
13273 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13274 need to edit the LaTeX file with a text editor to add the optional arguments
13276 \begin_inset space \thinspace{}
13280 \begin_inset space \space{}
13283 the running title for the page headers.
13284 Lacking these layouts makes the
13290 (and the equivalent
13296 ) useless, so the corresponding layouts don't exist, and will have to be
13301 \begin_layout Plain Layout
13306 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13307 has not been updated yet to take advantage of it.
13315 \begin_layout Section
13316 Springer Journals (
13323 \begin_layout Standard
13329 \begin_layout Subsection
13333 \begin_layout Standard
13334 These are the layout files for some of the journal formats used by Springer
13335 Verlag and listed on
13336 \begin_inset Flex URL
13339 \begin_layout Plain Layout
13341 http://www.springer.de/author/tex/help-journals.html
13346 , where you should also go to fetch the class files (yes, these are LaTeX2e
13348 It is a modular system: the things common to all journals are implemented
13353 , which journal-specific layout files (such as, e.
13354 \begin_inset space \thinspace{}
13358 \begin_inset space \space{}
13365 for Journal of Geodesy) can include.
13368 \begin_layout Standard
13369 This means that implementing support for any other Springer journal on this
13370 list is as simple as writing your own
13378 file following the outline given in
13386 \begin_layout Standard
13387 It is reasonably well tested only for the Journal of Geodesy.
13396 come with the standard LyX distribution.
13397 Install the relevant class file (downloaded from Springer) in a proper
13398 directory, reconfigure LaTeX (in the teTeX case by running
13402 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
13403 and it should work.
13406 \begin_layout Subsection
13410 \begin_layout Standard
13411 A large number of theorem-like styles —
13417 \SpecialChar \ldots{}
13423 \begin_layout Standard
13426 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13427 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13430 See the Springer class file documentation for details.
13433 \begin_layout Subsection
13437 \begin_layout Itemize
13449 \begin_layout Itemize
13452 Probability Theory and Related Fields
13458 — Jean-Marc Lasgouttes
13461 \begin_layout Standard
13462 Add your own, it isn't so hard!
13465 \begin_layout Subsection
13469 \begin_layout Standard
13470 These files are partly based on the older
13474 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13475 file from Springer.
13480 layout, are now defunct.
13481 Jean-Marc Lasgouttes helped out big in making me find my way around the
13482 LyX layout file mechanism.
13485 \begin_layout Subsection
13489 \begin_layout Standard
13491 But probably less than in the old hacked-LaTeX
13498 \begin_layout Standard
13500 \begin_inset space \thinspace{}
13503 g.: does not display the number for theorem-like layouts, just #.
13506 \begin_layout Section
13512 \begin_inset CommandInset label
13521 \begin_layout Standard
13529 \begin_layout Subsection
13533 \begin_layout Standard
13534 This section describes how to use LyX to make slides for overhead projectors.
13535 There are two document classes that can do this: the default slides class
13541 This section documents the former.
13544 \begin_layout Standard
13545 I'm going to say this again, nice and clear, so that there's no misunderstanding
13549 \begin_layout Standard
13550 \begin_inset VSpace bigskip
13556 \begin_layout Standard
13560 This section documents the class
13561 \begin_inset Quotes eld
13569 \begin_inset Quotes erd
13577 \begin_layout Standard
13578 \begin_inset VSpace bigskip
13584 \begin_layout Standard
13585 If you're looking for the documentation for
13586 \begin_inset Quotes eld
13594 \begin_inset Quotes erd
13597 , check out section
13598 \begin_inset space ~
13602 \begin_inset CommandInset ref
13604 reference "sec:foiltex"
13614 \begin_inset Quotes eld
13622 \begin_inset Quotes erd
13625 ] is actually somewhat better than the default
13633 \begin_layout Plain Layout
13634 \SpecialChar \ldots{}
13635 or so I've been told repeatedly by its advocates.
13636 Having never used it, I have no idea if this claim is true or not.
13641 which this section documents.
13644 \begin_layout Standard
13645 This class is the LaTeX2e improvement of the old
13650 Every LaTeX2e distribution includes this class [which I'll just refer to
13652 \begin_inset Quotes eld
13660 \begin_inset Quotes erd
13663 from now on], so you're bound to have it.
13664 As I noted earlier, there are other classes, such as
13668 , which also produce slides for overhead projectors and do a better job
13670 However, there are some things which
13674 can do which the others can't, such as generate overlays.
13675 Read on to learn more!
13678 \begin_layout Subsection
13680 \begin_inset CommandInset label
13682 name "sec:slidesetup"
13689 \begin_layout Standard
13690 Obviously, to use this document class, you need to select
13691 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13702 from the class list in the
13704 Document\SpecialChar \menuseparator
13708 There are some other special things you should know about this class:
13711 \begin_layout Itemize
13712 Don't bother changing the options
13717 They're not supported by the
13724 \begin_layout Itemize
13728 \begin_inset space ~
13733 behaves a bit differently for this class.
13734 The possible choices and what they do are as follows:
13738 \begin_layout Description
13743 The final output contains page numbers in the lower right corner.
13746 \begin_layout Description
13755 , but also prints out any time markers you've put in.
13756 This is the default.
13759 \begin_layout Description
13764 The final output contains no page numbers, time markers, or alignment markers.
13768 \begin_layout Itemize
13773 class has an extra option:
13779 \begin_inset Quotes eld
13787 \begin_inset Quotes erd
13790 in the extra class options.
13794 \begin_layout Standard
13795 Using this options allows you to add time markers to
13801 \begin_inset space ~
13805 \begin_inset CommandInset ref
13807 reference "sec:slideNote"
13815 \begin_layout Standard
13816 You can also use the template file
13817 \begin_inset Quotes eld
13825 \begin_inset Quotes erd
13828 to automatically set up a document to use the
13834 File\SpecialChar \menuseparator
13836 \begin_inset space ~
13840 \begin_inset space ~
13845 to open your new document].
13846 The template file also contains some examples of the special paragraph
13847 environments used by this class.
13848 I'll describe those next.
13851 \begin_layout Subsection
13852 Paragraph Environments
13855 \begin_layout Subsubsection
13856 Supported Environments
13859 \begin_layout Standard
13860 The first thing you'll notice when you start up a new
13864 document is the font size and type: it's the equivalent of the size
13865 \begin_inset Quotes eld
13873 \begin_inset Quotes erd
13879 \begin_inset space ~
13885 This is also what's used in the output.
13887 \begin_inset Quotes eld
13891 \begin_inset Quotes erd
13894 to remind you that this is a slide.
13895 Your final slides will use a larger font; ergo, you'll have less space.
13896 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
13899 \begin_layout Standard
13900 The next thing that becomes obvious is the changes to the paragraph environment
13901 pull-down box [at the far-left end of the toolbar].
13902 Most of the paragraph environments you're used to seeing are missing.
13903 There are also five new ones.
13908 class itself only supports certain paragraph environments:
13911 \begin_layout Itemize
13917 \begin_layout Itemize
13923 \begin_layout Itemize
13929 \begin_layout Itemize
13935 \begin_layout Itemize
13941 \begin_layout Itemize
13947 \begin_layout Itemize
13953 \begin_layout Itemize
13959 \begin_layout Itemize
13965 \begin_layout Itemize
13971 \begin_layout Itemize
13977 \begin_layout Standard
13978 All of the other standard environments, including the section-heading environmen
13979 ts, aren't used in the
13986 \begin_layout Standard
13987 On the other hand, you'll notice the following new environments:
13990 \begin_layout Itemize
13996 \begin_layout Itemize
14002 \begin_layout Itemize
14008 \begin_layout Itemize
14014 \begin_layout Itemize
14020 \begin_layout Standard
14021 These five are kind of quirky, due to a
14022 \begin_inset Quotes eld
14026 \begin_inset Quotes erd
14030 You see, LyX doesn't permit you to nest any other paragraph environment
14031 into an empty environment.
14032 Now, that's fine and dandy, but it means that you wouldn't be able to start
14033 a slide with anything except plain text.
14034 To deal with this, I've performed a little
14035 \begin_inset Quotes eld
14039 \begin_inset Quotes erd
14045 \begin_layout Subsubsection
14046 Quirks of the New Environments
14047 \begin_inset CommandInset label
14049 name "sec:slideQuirk"
14056 \begin_layout Standard
14057 All five of the new paragraph environments are somewhat quirky due to inherent
14058 limitiations in the current version of LyX.
14059 As I just mentioned, LyX forbids environments that begin with another environme
14061 To get around this, the
14065 environment isn't a paragraph environment as described in the
14073 \begin_layout Standard
14074 You should consider
14087 \begin_inset Quotes eld
14090 pseudo-environments.
14091 \begin_inset Quotes erd
14094 They look like a section heading or a
14095 \begin_inset Quotes eld
14103 \begin_inset Quotes erd
14106 but really begin a [and, if necessary, end the previous] paragraph environment.
14116 \begin_inset Quotes eld
14120 \begin_inset Quotes erd
14123 These two perform some action.
14126 \begin_layout Standard
14127 A common feature of all five environments,
14147 , is a rather long-ish label.
14148 The text following this label — ordinarily the contents of the paragraph
14149 environment — is utterly irrelevant for
14170 LyX completely ignores it.
14171 In fact, you can leave these five environments completely empty.
14175 \begin_layout Standard
14180 to put any text after the rather long-ish label, you might want to.
14181 This could be a short description of the contents of the
14186 In that case, enter in your descriptive comment and hit
14190 as you normally would.
14193 \begin_layout Standard
14194 If, on the other hand, you don't want to enter in any descriptive text,
14195 you'll hit another LyX quirk.
14196 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14197 environment until you put something in the old one.
14201 \begin_layout Itemize
14202 Start entering the text that will
14230 \begin_layout Itemize
14231 Now move to the beginning of that paragraph.
14235 \begin_layout Itemize
14244 \begin_layout Itemize
14245 Finally, change this new, empty paragraph to a
14269 \begin_layout Standard
14270 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14274 \begin_layout Subsection
14275 Making a Presentation with
14288 \begin_layout Subsubsection
14296 \begin_layout Standard
14297 If you're expecting this section to teach you how to actually make a presentatio
14298 n, you'll be sorely disappointed.
14299 Naturally, I'll describe all of the ways the
14303 class can assist you in preparing the materials for a presentation.
14304 Filling in the contents, however, is up to you.
14309 the LyX philosophy.]
14312 \begin_layout Standard
14317 environment [in the manner described in section
14318 \begin_inset space ~
14322 \begin_inset CommandInset ref
14324 reference "sec:slideQuirk"
14328 ] tells LyX to begin a new slide [duh].
14329 The label for this environment/
14330 \begin_inset Quotes erd
14334 \begin_inset Quotes erd
14338 \begin_inset Quotes eld
14342 \begin_inset Quotes erd
14345 in cool blue, followed by the label,
14346 \begin_inset Quotes eld
14350 \begin_inset Quotes erd
14354 Any text or paragraph environments that follow this one go on the new slide.
14358 \begin_layout Standard
14359 Slides are probably the only time you'll need to forcibly end pages in LyX
14360 (this can be specified in the
14365 In fact, you'll want to, once you finish entering the contents of one slide.
14366 If you've entered more text than can physically fit on a slide, the extra
14367 overflows onto a new slide.
14368 I don't recommend doing this, however, since the overflow slide won't have
14369 any page number on it.
14370 Furthermore, it may interfere with any
14374 you've made to accompany the oversized
14381 \begin_layout Standard
14390 environments work the same way as the
14395 They both create an
14396 \begin_inset Quotes eld
14400 \begin_inset Quotes erd
14403 followed by a label [
14404 \begin_inset Quotes eld
14408 \begin_inset Quotes erd
14412 \begin_inset Quotes eld
14416 \begin_inset Quotes erd
14420 The color is a stunning magenta instead of blue, and the
14421 \begin_inset Quotes eld
14425 \begin_inset Quotes erd
14428 will look different, in style and in length.
14429 The label fonts of all three also differ from one another.
14432 \begin_layout Standard
14437 , if the contents of a
14445 exceed the physical size of a slide or sheet of paper, the extra will overflow
14447 Again, you should avoid this.
14448 It defeats the whole purpose of
14459 \begin_layout Subsubsection
14469 \begin_layout Standard
14474 is a slide that sits atop another slide.
14475 Perhaps you wish to discuss a figure on the main
14479 before displaying the text associated with it.
14480 One way to accomplish this is tape a flap of dark paper over the part of
14485 you want to display later.
14486 This method fails, however, if you wish to overlap one graph with another,
14488 You would then have to fumble while speaking to align the two separate,
14493 s to align the two graphs.
14498 environment in both cases makes life much easier.
14501 \begin_layout Standard
14506 receives the page number of its
14507 \begin_inset Quotes eld
14511 \begin_inset Quotes erd
14519 \begin_inset Quotes eld
14527 \begin_inset Quotes erd
14534 \begin_layout Plain Layout
14535 Presumably, mutliple
14540 \begin_inset Quotes eld
14548 \begin_inset Quotes erd
14552 \begin_inset Quotes eld
14560 \begin_inset Quotes erd
14564 \begin_inset Quotes eld
14572 \begin_inset Quotes erd
14576 \begin_inset space ~
14579 appended to the page number of the parent
14589 Clearly, you want the contents of both the
14597 to each fit on a single physical slide! You should probably consider an
14603 \begin_inset Quotes eld
14607 \begin_inset Quotes erd
14619 class provides a visual cue for this: the label at the start of an
14623 is shorter than that at the start of a
14628 Lastly, when you generate printable output, you'll find alignment markers
14629 in all four corners of both the
14633 page and its parent
14638 These will assist you in lining up the two physical slides.
14641 \begin_layout Standard
14642 The major problem in overlaying two slides is aligning the contents of the
14643 two transparencies.
14644 How much space should you leave for that graph on the second slide? Worse
14645 still, what if you want a graph and a sentence on second slide, but there
14646 is text on the main transparency that goes in between them? You could try
14647 and insert vertical space of the right size.
14648 The better way is to use
14659 \begin_layout Standard
14660 As their names imply,
14668 are two command-like paragraph environments that make all subsequent text
14669 invisible and visible, respectively.
14671 \begin_inset space ~
14675 \begin_inset CommandInset ref
14677 reference "sec:slideQuirk"
14681 that you don't place anything
14685 these two environments, however.
14690 , it inserts a centered, sky-blue label into the page reading
14691 \begin_inset Quotes eld
14694 <Invisible Text Follows>
14695 \begin_inset Quotes erd
14699 For paragraphs following this label, the parts of the
14707 ; it doesn't matter which] where they would be contain instead blank space.
14711 \begin_layout Standard
14716 , the corresponding centered label is
14717 \begin_inset Quotes eld
14720 <Visible Text Follows>
14721 \begin_inset Quotes erd
14725 Paragraphs following this label behave normally.
14726 Note that the beginning of a new
14738 automatically shuts off an
14743 It's therefore not necessary to use
14754 \begin_layout Standard
14755 By now, it should be obvious how to create overlay transparencies using
14756 the proper combination of
14775 \begin_layout Enumerate
14780 , including everything that will appear on it, whether on the main slide
14788 \begin_layout Enumerate
14789 Before each figure or paragraph that will appear only on the
14798 If necessary, insert a
14802 environment after the
14809 \begin_layout Enumerate
14814 immediately following the
14821 \begin_layout Enumerate
14822 Copy the contents of this
14833 \begin_layout Enumerate
14838 , change all of the
14849 \begin_layout Standard
14851 You've just made an
14858 \begin_layout Standard
14859 There's one problem with the way I've designed the LyX
14863 class: you can't make text in the middle of a paragraph invisible, nor
14864 make text in the middle of an invisible paragraph visible again.
14865 To accomplish this feat, you'll need to use some inlined LaTeX codes.
14869 \begin_layout Plain Layout
14870 The commands of interest are:
14873 \begin_layout Itemize
14878 invisible \SpecialChar \ldots{}
14882 \begin_layout Itemize
14887 visible \SpecialChar \ldots{}
14891 \begin_layout Plain Layout
14892 \SpecialChar \ldots{}
14893 and need to be marked as TeX.
14895 \begin_inset Quotes eld
14899 \begin_inset Quotes erd
14902 you wish to change goes in between the brackets [and after the
14915 If you don't know how to mark text as TeX, see the appropriate section
14928 \begin_layout Subsubsection
14938 \begin_inset CommandInset label
14940 name "sec:slideNote"
14947 \begin_layout Standard
14956 is associated with a
14957 \begin_inset Quotes eld
14961 \begin_inset Quotes erd
14973 class provides visual cues.
14978 is shorter than that of a
14982 [yet longer than that of an
14986 ] and, like the label of an
14990 is shockingly magenta.
14991 Additionally, the printed
14995 has the page number of its
14996 \begin_inset Quotes eld
15000 \begin_inset Quotes erd
15008 \begin_inset Quotes eld
15016 \begin_inset Quotes erd
15020 \begin_inset Quotes eld
15028 \begin_inset Quotes erd
15032 \begin_inset Quotes eld
15040 \begin_inset Quotes erd
15044 You can have multiple
15048 s associated with a single
15060 , you'll probably want to break up long
15064 s so that they fit on a single sheet of paper.
15067 \begin_layout Standard
15072 is obvious: it contains anything additional you might want to say about
15078 It could also be used as a sheet of reminders for a particular
15083 In the case of the latter, you might want to make use of time markers.
15089 \begin_inset Quotes eld
15093 \begin_inset Quotes erd
15096 support for time markers, a
15101 So, you'll have to resort to using the LaTeX codes.
15104 \begin_layout Standard
15105 To use time markers, you'll need to specify the extra class option
15106 \begin_inset Quotes eld
15114 \begin_inset Quotes erd
15118 \begin_inset space ~
15122 \begin_inset CommandInset ref
15124 reference "sec:slidesetup"
15129 This option turns on timing marks, which will appear in the lower-left-hand
15135 To set what appears in the time marker, you use the LaTeX commands
15136 \begin_inset Quotes eld
15146 \begin_inset Quotes erd
15150 \begin_inset Quotes eld
15160 \begin_inset Quotes erd
15164 The arguments of both commands are time measured in seconds.
15166 \begin_inset Quotes eld
15176 \begin_inset Quotes erd
15179 sets the time marker to a given time.
15181 \begin_inset Quotes eld
15191 \begin_inset Quotes erd
15194 increments the time marker by the specified amount.
15195 Using time markers and
15199 s in this fashion, you can remind yourself how much time to spend on a particula
15207 \begin_layout Standard
15208 There's one last feature to describe.
15209 Clearly, you'd like to print out all of your
15217 s on transparencies while printing all of your
15234 with which it is associated.
15235 What's a person to do?
15238 \begin_layout Standard
15239 Luckily, there are two LaTeX commands that allow you to select what to print
15241 Both must be placed into the preamble of your document.
15243 \begin_inset Quotes eld
15255 \begin_inset Quotes erd
15258 will cause the output to contain only the
15267 Correspondingly, the command
15268 \begin_inset Quotes eld
15280 \begin_inset Quotes erd
15283 prevents the output of anything but
15288 I'd advise placing both commands in the preamble and initially comment
15290 You can then preview your entire presentation as you write.
15291 When you're done writing, you can then uncomment one of the two to select
15292 what you want to print.
15293 I like to uncomment
15294 \begin_inset Quotes eld
15306 \begin_inset Quotes erd
15309 , print to a file with
15310 \begin_inset Quotes eld
15318 \begin_inset Quotes erd
15321 in its name, comment it back out, then uncomment
15322 \begin_inset Quotes eld
15334 \begin_inset Quotes erd
15338 \begin_inset Quotes eld
15346 \begin_inset Quotes erd
15350 I can then send either file to a printer, loading transparencies or plain
15351 paper as appropriate.
15354 \begin_layout Standard
15355 You can also provide other arguments to the
15356 \begin_inset Quotes eld
15366 \begin_inset Quotes erd
15370 \begin_inset Quotes eld
15380 \begin_inset Quotes erd
15384 See a good LaTeX book for details.
15387 \begin_layout Subsection
15392 Class Template File
15395 \begin_layout Standard
15396 I have also provided a template file,
15397 \begin_inset Quotes eld
15405 \begin_inset Quotes erd
15413 To use it, begin your new presentation with
15418 ile\SpecialChar \menuseparator
15420 \begin_inset space ~
15424 \begin_inset space ~
15434 Your new LyX presentation file will contain an example
15455 additionally contain an example of the use of
15464 Lastly, the preamble will contain:
15467 \begin_layout LyX-Code
15468 % Uncomment to print out only slides and overlays
15471 \begin_layout LyX-Code
15475 \begin_layout LyX-Code
15481 \begin_inset Newline newline
15487 \begin_layout LyX-Code
15488 % Uncomment to print out only notes
15491 \begin_layout LyX-Code
15495 \begin_layout LyX-Code
15503 \begin_layout Standard
15504 One final thing: I created this class to support the LaTeX2e
15505 \begin_inset Quotes eld
15513 \begin_inset Quotes erd
15516 class, one of the built-in LaTeX2e classes.
15517 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15518 built-in slide class.
15519 It's here if you want it or need it.
15520 There exist other LaTeX2e classes for creating presentations, such as the
15526 \begin_inset space ~
15530 \begin_inset CommandInset ref
15532 reference "sec:foiltex"
15537 \begin_inset Quotes eld
15545 \begin_inset Quotes erd
15548 package [present on some TeX distributions].
15549 The latter is not yet supported under LyX.
15553 \begin_layout Plain Layout
15554 Perhaps you can take on the task\SpecialChar \ldots{}
15560 I know nothing about these other classes.
15561 Try them out to see what sort of alternative they provide.
15564 \begin_layout Chapter
15565 LyX Features needing Extra Software
15568 \begin_layout Section
15572 \begin_layout Standard
15578 \begin_layout Subsection
15582 \begin_layout Standard
15591 \begin_layout Plain Layout
15596 is not yet available when you are using the LaTeX distribution MiKTeX.
15601 , you'll find in the
15608 \begin_inset space ~
15619 \begin_inset CommandInset href
15621 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15628 \begin_layout Standard
15633 package is a program that was written by
15634 \begin_inset Flex CharStyle:Noun
15637 \begin_layout Plain Layout
15639 \begin_inset space ~
15647 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15648 and easy to forget.
15649 The program runs over your LaTeX file, checks the integrity of the file,
15650 and flags some common errors.
15651 In other technical words, it is
15658 \begin_layout Standard
15659 Well, what is a syntax checker doing in LyX which is supposed to produce
15660 correct LaTeX anyways? The answer is simple: Just as
15664 not only checks the
15668 of C programs, but also does
15672 checks for type-errors,
15676 catches some common
15680 errors, in addition to the syntactical ones.
15685 is capable of detecting several common errors, such as
15688 \begin_layout Itemize
15689 Ellipsis detection:
15690 \begin_inset Newline newline
15693 Use \SpecialChar \ldots{}
15697 \begin_layout Itemize
15698 No space in front of/after parenthesis:
15699 \begin_inset Newline newline
15705 \begin_layout Itemize
15706 Enforcement of normal space after common abbreviations:
15707 \begin_inset Newline newline
15711 \begin_inset space \thinspace{}
15715 \begin_inset space \space{}
15718 is too wide spacing.
15721 \begin_layout Itemize
15722 Enforcement of end-of-sentence space when the last sentence ends with a
15724 \begin_inset Newline newline
15728 And this is wrong spacing.
15731 \begin_layout Itemize
15732 Space in front of labels and similar commands:
15733 \begin_inset Newline newline
15736 The label should stick right up to the text to avoid falling to a wrong
15739 \begin_inset CommandInset label
15749 \begin_layout Plain Layout
15750 This footnote is in danger of falling off to a wrong page
15755 The label is separated too much.
15758 \begin_layout Itemize
15759 Space in front of references, instead of hard spaces:
15760 \begin_inset Newline newline
15763 In you are in bad luck, the text will break right between the referenced
15764 text and reference number, and that's a pity.
15766 \begin_inset CommandInset ref
15768 reference "sec:chktex"
15775 \begin_layout Itemize
15777 \begin_inset Quotes eld
15781 \begin_inset Quotes erd
15785 \begin_inset Formula $\times$
15789 \begin_inset Newline newline
15792 2x2 looks cheap compared to
15793 \begin_inset Formula $2\times2$
15799 \begin_layout Standard
15800 and more \SpecialChar \ldots{}
15801 It is an invaluable tool when you are
15802 \begin_inset Quotes eld
15806 \begin_inset Quotes erd
15809 your document before printing, and you should run it right after the obligatory
15810 spelling check, and before you go fine tuning the typesetting.
15813 \begin_layout Subsection
15817 \begin_layout Standard
15818 If you have the program installed, usage is as simple as choosing
15820 Tools\SpecialChar \menuseparator
15822 \begin_inset space ~
15828 This will make LyX generate a LaTeX file of your document, start
15832 to check it, and then make LyX insert
15833 \begin_inset Quotes eld
15837 \begin_inset Quotes erd
15840 with the warnings from
15844 , if there were any.
15845 The warnings will be placed close to the point of the mistake, and you
15846 can quickly find them by using the
15848 Navigate\SpecialChar \menuseparator
15851 menu item, or the shortcut key
15860 Open the error boxes by clicking on them with the mouse, or use the shortcut
15869 bindings, or the corresponding
15878 Read the warning and correct the mistake, if it is a mistake.
15879 If you have trouble understanding what the warning is about, you can safely
15881 Remember that there is a hidden layer between the document on screen and
15882 the technical details in invoking
15886 , and this gap can make some warnings seem arcane or just right down plain
15890 \begin_layout Standard
15891 This document is an excellent testing bed for the feature, and it should
15892 provide quite a few warnings for you to fiddle with.
15893 Since computers are only so smart, expect most of the warnings to be false
15897 \begin_layout Subsection
15898 How to fine tune it
15901 \begin_layout Standard
15902 Sometimes, you'll find that
15906 makes more noise than suits your mood.
15907 Then you can choose not to use it, wait until your mood changes, or try
15912 to get better along with you.
15913 Another choice in the most desperate situations is to use
15915 View\SpecialChar \menuseparator
15917 \begin_inset space ~
15921 \begin_inset space ~
15925 \begin_inset space ~
15930 , which will get rid of all warnings instantly.
15933 \begin_layout Standard
15942 very configurable and extensible, you shouldn't expect to solve all problems
15948 Since LyX has to generate a somewhat special LaTeX file to be able to match
15949 the line numbers from the
15957 \begin_layout Plain Layout
15958 You can inspect the specific output from
15964 Edit\SpecialChar \menuseparator
15966 \begin_inset space ~
15970 \begin_inset space ~
15984 to the internal document structure, some of the warnings will not seen
15985 to appear correctly.
15986 There are two things you can do about this:
15989 \begin_layout Itemize
15994 invocation command line in
16010 installation configuration file (usually with the file
16015 See below to learn what warnings can be enabled and disabled on the command
16020 \begin_layout Itemize
16021 Export your document as a raw LaTeX file using
16023 File\SpecialChar \menuseparator
16024 Export\SpecialChar \menuseparator
16032 Invoked in this way, it can be a hassle to find the corresponding place
16033 in the document inside LyX, but with a little patience, you should be able
16037 \begin_layout Standard
16038 Here follows the warning messages that can be enabled and disabled in
16047 to disable a warning, and
16051 to enable a warning.
16052 The emphasized entries are disabled by default, because the default is
16055 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16060 \begin_layout Standard
16061 Notice that you should only use the options that enable and disable warnings,
16062 because LyX relies on some of the other command line parameters to be set
16063 in a specific way to have a chance to communicate with
16070 \begin_layout Enumerate
16074 Command terminated with space.
16077 \begin_layout Enumerate
16080 Non-breaking space (
16081 \begin_inset Quotes eld
16089 \begin_inset Quotes erd
16092 ) should have been used.
16095 \begin_layout Enumerate
16099 You should enclose the previous parenthesis with
16100 \begin_inset Quotes eld
16108 \begin_inset Quotes erd
16114 \begin_layout Enumerate
16117 Italic correction (
16118 \begin_inset Quotes eld
16128 \begin_inset Quotes erd
16131 ) found in non-italic buffer.
16134 \begin_layout Enumerate
16137 Italic correction (
16138 \begin_inset Quotes eld
16148 \begin_inset Quotes erd
16151 ) found more than once.
16154 \begin_layout Enumerate
16158 No italic correction (
16159 \begin_inset Quotes eld
16169 \begin_inset Quotes erd
16175 \begin_layout Enumerate
16179 \begin_inset Quotes eld
16187 \begin_inset Quotes erd
16191 \begin_inset Quotes eld
16199 \begin_inset Quotes erd
16205 \begin_layout Enumerate
16208 Wrong length of dash may have been used.
16211 \begin_layout Enumerate
16215 \begin_inset Quotes eld
16223 \begin_inset Quotes erd
16227 \begin_inset Quotes eld
16235 \begin_inset Quotes erd
16241 \begin_layout Enumerate
16245 \begin_inset Quotes eld
16253 \begin_inset Quotes erd
16259 \begin_layout Enumerate
16263 \begin_inset Quotes eld
16271 \begin_inset Quotes erd
16274 to achieve an ellipsis.
16277 \begin_layout Enumerate
16280 Inter-word spacing (
16281 \begin_inset Quotes eld
16291 \begin_inset Quotes eld
16294 ) should perhaps be used.
16297 \begin_layout Enumerate
16300 Inter-sentence spacing (
16301 \begin_inset Quotes eld
16311 \begin_inset Quotes erd
16314 ) should perhaps be used.
16317 \begin_layout Enumerate
16320 Could not find argument for command.
16323 \begin_layout Enumerate
16327 \begin_inset Quotes eld
16335 \begin_inset Quotes erd
16341 \begin_layout Enumerate
16344 Math mode still on at end of LaTeX file.
16347 \begin_layout Enumerate
16351 \begin_inset Quotes eld
16359 \begin_inset Quotes erd
16362 doesn't match the number of
16363 \begin_inset Quotes eld
16371 \begin_inset Quotes erd
16377 \begin_layout Enumerate
16380 You should use either
16383 \begin_inset Quotes eld
16391 \begin_inset Quotes erd
16396 as an alternative to
16397 \begin_inset Quotes eld
16405 \begin_inset Quotes erd
16411 \begin_layout Enumerate
16418 " (ASCII 39) instead of "
16425 \begin_layout Enumerate
16428 User-specified pattern found.
16431 \begin_layout Enumerate
16434 This command might not be intended.
16437 \begin_layout Enumerate
16444 \begin_layout Enumerate
16462 \begin_layout Enumerate
16465 Delete this space to maintain correct page references.
16468 \begin_layout Enumerate
16472 You might wish to put this between a pair of
16473 \begin_inset Quotes eld
16481 \begin_inset Quotes erd
16487 \begin_layout Enumerate
16490 You ought to remove spaces in front of punctuation.
16493 \begin_layout Enumerate
16496 Could not execute LaTeX command.
16499 \begin_layout Enumerate
16508 in front of small punctuation.
16511 \begin_layout Enumerate
16519 may look prettier here.
16522 \begin_layout Enumerate
16526 Multiple spaces detected in output.
16529 \begin_layout Enumerate
16532 This text may be ignored.
16535 \begin_layout Enumerate
16541 \begin_inset Quotes eld
16546 to begin quotation, not
16553 \begin_layout Enumerate
16560 to end quotation, not
16563 \begin_inset Quotes eld
16571 \begin_layout Enumerate
16577 \begin_layout Enumerate
16580 You should perhaps use
16581 \begin_inset Quotes eld
16589 \begin_inset Quotes erd
16595 \begin_layout Enumerate
16598 You should put a space in front of/after parenthesis.
16601 \begin_layout Enumerate
16604 You should avoid spaces in front of/after parenthesis.
16607 \begin_layout Enumerate
16611 You should not use punctuation in front of/after quotes.
16614 \begin_layout Enumerate
16617 Double space found.
16620 \begin_layout Enumerate
16623 You should put punctuation outside inner/inside display math mode.
16626 \begin_layout Enumerate
16629 You ought to not use primitive TeX in LaTeX code.
16632 \begin_layout Enumerate
16635 You should remove spaces in front of
16636 \begin_inset Quotes eld
16644 \begin_inset Quotes erd
16650 \begin_layout Enumerate
16653 \begin_inset Quotes eld
16661 \begin_inset Quotes erd
16664 is normally not followed by
16665 \begin_inset Quotes eld
16673 \begin_inset Quotes erd
16679 \begin_layout Standard
16680 In later versions of LyX, we hope to provide a more complete interface to
16681 this tool (and it's smaller cousin
16685 ) to exploit the full power of it.
16686 But it's not exactly useless as it is now: go try it on one of your existing
16687 documents of a certain length and be surprised.
16690 \begin_layout Section
16691 Version Control in LyX
16694 \begin_layout Standard
16697 Lars Gullik Bjønnes,
16704 \begin_layout Subsection
16708 \begin_layout Standard
16709 A friend of mine wanted to try LyX for a group project.
16710 When he didn't find support for version control or file locking, he dropped
16712 This angered me a bit, so I thought that I should at least make support
16713 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16714 This has now been done.
16715 LyX now supports some of the most basic RCS commands.
16716 If you need to something a bit more sophisticated you will have to do that
16717 manually in an xterm.
16720 \begin_layout Standard
16721 Before you begin to use the version control features in LyX, you should
16723 \begin_inset Quotes eld
16727 \begin_inset Quotes erd
16730 (a man file, read it with
16735 This file describes all the basic features of RCS.
16736 You should especially notice the comment about a RCS directory, and the
16737 notion of a master RCS file (the file ending in
16744 \begin_layout Standard
16745 Later basic CVS/SVN support was added.
16746 You should be familiar with CVS/SVN usage before start using it under LyX.
16747 Most of the log messages are not currently displayed after operations -
16748 you can check them in terminal window if unsure.
16751 \begin_layout Standard
16752 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16753 package—no guarantees are made for older versions.
16756 \begin_layout Standard
16757 For introducing your own external commands consult vc-command in the manual
16761 \begin_layout Subsection
16762 RCS commands in LyX
16765 \begin_layout Standard
16766 The following sections describe the RCS commands supported by LyX.
16767 You can find them in the
16769 File\SpecialChar \menuseparator
16771 \begin_inset space ~
16779 \begin_layout Subsubsection
16785 \begin_layout Standard
16786 If your document is not under revision control, this is the only item shown
16788 And if it is under revision control, the
16792 item is not visible.
16796 \begin_layout Standard
16797 This command registers your document with RCS (unless you are under the
16798 directory managed by CVS)\SpecialChar \@.
16799 You are asked interactively to supply an initial
16800 description of the document.
16801 The document is now set in Read-Only mode and you have to
16804 \begin_inset space ~
16808 \begin_inset space ~
16812 \begin_inset space ~
16817 , before making any changes to it.
16818 A document under revision control has a
16819 \begin_inset Quotes eld
16822 [RCS:<version> <locker>]
16823 \begin_inset Quotes erd
16826 item tagged to the filename in the minibuffer.
16829 \begin_layout Standard
16830 RCS command that is run:
16832 ci -q -u -i -t-"<initial description>" <file-name>
16835 \begin_layout Standard
16840 to understand the switches.
16844 \begin_layout Subsubsection
16850 \begin_layout Standard
16851 When you are finished editing a file, you check in your changes.
16852 When you do this, you are asked for a description of the changes.
16853 This is stored in the history log.
16854 The version number is bumped, your changes are applied to the master RCS
16855 file, the document is unlocked and set to Read-Only mode.
16859 \begin_layout Standard
16862 ci -q -u -m"<description>" <file-name>
16865 \begin_layout Subsubsection
16871 \begin_layout Standard
16872 By doing this you lock the document so that only you can edit it.
16873 This will also make the document Read-Write only for you.
16874 You will usually continue editing for a while and when you are finished
16875 you check in your changes.
16876 The status line is changed to reflect that you have locked the file.
16880 \begin_layout Standard
16883 co -q -l <file-name>
16886 \begin_layout Subsubsection
16889 Revert To Repository Version
16892 \begin_layout Standard
16893 This will discard all changes made to the document since the last check
16895 You get a warning before changes are discarded.
16898 \begin_layout Standard
16901 co -f -u<version> <file-name>
16904 \begin_layout Subsubsection
16910 \begin_layout Standard
16911 This makes as if the last check in never happened.
16912 No changes are made to the document loaded into LyX, but the last version
16913 is removed from the master RCS file.
16917 \begin_layout Standard
16920 rcs -o<version> <file-name>
16923 \begin_layout Subsubsection
16929 \begin_layout Standard
16930 This show the complete history of the RCS document.
16935 is shown in a browser.
16943 \begin_layout Subsection
16944 CVS commands in LyX
16947 \begin_layout Standard
16948 CVS is now partially supported by LyX.
16949 You can find the commands in the
16951 File\SpecialChar \menuseparator
16953 \begin_inset space ~
16961 \begin_layout Subsubsection
16967 \begin_layout Standard
16968 If your document is not under revision control, this is the only item shown
16970 And if it is under revision control, the
16977 item is not visible.
16981 \begin_layout Standard
16982 This command registers in CVS your document ONLY in case you have already
16983 the documents directory under CVS control (in particular
16988 This means you have to checkout the archive by yourself.
16992 \begin_layout Standard
16993 Then you are asked interactively to supply an initial description of the
16995 Don't forget that registered file is not yet commited.
16998 \begin_layout Standard
16999 CVS command that is run:
17002 \begin_inset Quotes erd
17006 \begin_inset Quotes eld
17010 \begin_inset Quotes erd
17016 \begin_layout Standard
17021 to understand the switches.
17025 \begin_layout Subsubsection
17031 \begin_layout Standard
17032 When you are finished editing a file, you commit your changes.
17033 When you do this, you are asked for a description of the changes.
17034 After that changes are commited.
17037 \begin_layout Standard
17040 cvs -q commit -m"<description>" <file-name>
17043 \begin_layout Subsubsection
17046 Revert To Repository Version
17049 \begin_layout Standard
17050 This will discard all changes made to the document since the last check
17052 You get a warning before changes are discarded.
17053 Firstly the file is deleted, secondly CVS update command is run.
17056 \begin_layout Standard
17060 \begin_inset Quotes eld
17064 \begin_inset Quotes erd
17070 \begin_layout Subsubsection
17076 \begin_layout Standard
17077 This show the complete history of the CVS document.
17081 \begin_inset Quotes eld
17085 \begin_inset Quotes erd
17090 is shown in a browser.
17093 \begin_layout Subsection
17094 SVN commands in LyX
17097 \begin_layout Standard
17098 SVN is now partially supported by LyX.
17099 You can find the commands in the
17101 File\SpecialChar \menuseparator
17103 \begin_inset space ~
17109 Please note that if you use password protected access to repository via
17110 ssh, you will be asked in terminal window.
17113 \begin_layout Subsubsection
17119 \begin_layout Standard
17120 If your document is not under revision control, this is the only item shown
17122 And if it is under revision control, the
17129 item is not visible.
17133 \begin_layout Standard
17134 This command registers in SVN your document ONLY in case you have already
17135 the documents directory under SVN control (in particular
17140 This means you have to checkout the archive by yourself.
17144 \begin_layout Standard
17145 Then you are asked interactively to supply an initial description of the
17147 Don't forget that registered file is not yet commited.
17150 \begin_layout Standard
17151 SVN command that is run:
17154 \begin_inset Quotes eld
17158 \begin_inset Quotes erd
17164 \begin_layout Standard
17169 to understand the switches.
17173 \begin_layout Subsubsection
17179 \begin_layout Standard
17180 When you are finished editing a file, you commit your changes.
17181 When you do this, you are asked for a description of the changes.
17182 After that changes are commited.
17185 \begin_layout Standard
17188 svn commit -q -m"<description>" <file-name>
17191 \begin_layout Subsubsection
17197 \begin_layout Standard
17198 Updates the changes of this file from the repository.
17199 Be sure you understand SVN merging and conflicts resolving before using
17200 this function, because all conflicts has to be done manually by you!
17203 \begin_layout Standard
17207 \begin_inset Quotes eld
17211 \begin_inset Quotes erd
17217 \begin_layout Subsubsection
17220 Revert To Repository Version
17223 \begin_layout Standard
17224 This will discard all changes made to the document since the last check
17226 You get a warning before changes are discarded.
17230 \begin_layout Standard
17234 \begin_inset Quotes eld
17238 \begin_inset Quotes erd
17244 \begin_layout Subsubsection
17250 \begin_layout Standard
17251 This show the complete history of the SVN document.
17255 \begin_inset Quotes eld
17259 \begin_inset Quotes erd
17264 is shown in a browser.
17267 \begin_layout Subsection
17268 SVN and Windows Environment
17271 \begin_layout Quote
17272 My inclination is to say that if the user cannot figure out the command
17273 line operations on their own fairly quickly, they would be well advised
17274 to use TortoiseSVN.
17280 \begin_layout Subsubsection
17284 \begin_layout Standard
17285 In addition to installing LyX, and having access to a Subversion repository,
17286 the user will need to install the Subversion client program.
17287 A Windows installer for the client program is available from
17288 \begin_inset CommandInset href
17291 target "http://www.collab.net/nonav/downloads/subversion/"
17296 The user may also want to install
17297 \begin_inset CommandInset href
17300 target "http://tortoisesvn.tigris.org/"
17304 , which integrates Subversion operations into the context (rightclick) menu
17305 of Windows Explorer.
17306 Operations done outside LyX will typically be more convenient using the
17307 Explorer context menu.
17308 Note that TortoiseSVN is not a replacement for the client program, which
17309 is what LyX itself will use.
17312 \begin_layout Subsubsection
17313 Bringing a document under Subversion control
17316 \begin_layout Standard
17317 Before a LyX document can be brought under version control in Subversion,
17318 its parent directory needs to be under version control.
17319 If the document is being added to a project already in the repository,
17320 this is accomplished by checking the project out to the directory where
17321 the new document will be placed.
17322 If the project itself is not yet under version control (for instance, if
17323 this document starts a new project), the directory must be imported into
17325 This is done outside LyX.
17326 Both import and checkout are easily accomplished from the Explorer context
17327 menu using TortoiseSVN, or alternatively can be done using the command
17328 line client at a DOS prompt.
17329 The procedure for importing the project using TortoiseSVN is described
17330 below, assuming an existing repository and a new project being started
17338 For information on using the Subversion client program, run
17345 \begin_layout Enumerate
17352 in Windows Explorer, right click it, and select
17354 TortoiseSVN > Repo-browser
17357 If necessary, adjust the URL for the repository, then click OK.
17360 \begin_layout Enumerate
17361 Right click the level of the repository under which you want to place the
17362 new project folder (typically the top level) and click
17364 Create folder\SpecialChar \ldots{}
17367 Supply a name for the project folder and click OK.
17368 Add a message for the log file if desired, then click OK again.
17369 The new project folder should appear in the repository.
17370 Finally, click OK again to exit the repository browser.
17373 \begin_layout Enumerate
17374 Once again right click
17380 , this time selecting SVN Checkout\SpecialChar \ldots{}
17381 Select the URL of the project folder
17382 you just created in the repository, and set the checkout directory to
17390 You will be warned about a non-empty folder; click OK to proceed.
17391 You should now have a
17402 \begin_layout Enumerate
17403 Create or open your document in LyX and click
17408 ile\SpecialChar \menuseparator
17414 \begin_inset space ~
17417 Control\SpecialChar \menuseparator
17425 Add a log message and click OK to commit the document to version control.
17428 \begin_layout Standard
17429 From this point onward, you should have full functionality in the
17434 ile\SpecialChar \menuseparator
17440 \begin_inset space ~
17446 You also have the option of checking the document in and out, viewing its
17448 using the TortoiseSVN context menu in Windows Explorer or the Subversion
17449 client program from a command prompt.
17452 \begin_layout Subsection
17456 \begin_layout Standard
17457 With the recent addition of the vc-command function LyX power users are
17458 allowed to create their own commands for revision control.
17461 \begin_layout Standard
17462 As an example you can see how two TortoiseSVN commands could be integrated
17466 \begin_layout Description
17468 \begin_inset Flex CharStyle:Code
17471 \begin_layout Plain Layout
17472 vc-command DS "." "TortoiseProc /command:commit /path:$$p"
17480 \begin_layout Description
17482 \begin_inset Flex CharStyle:Code
17485 \begin_layout Plain Layout
17486 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
17494 \begin_layout Section
17495 Literate Programming
17498 \begin_layout Standard
17503 (kayvan@sylvan.com)
17507 original documentation written by
17509 Edmar Wienskoski Jr.
17512 (edmar-w-jr@technologist.com)
17515 \begin_layout Subsection
17519 \begin_layout Standard
17520 The main purpose of this documentation is to show you how to use LyX for
17521 literate programming.
17522 Where it is assumed that you are familiar with this programming technique,
17524 \begin_inset Quotes eld
17528 \begin_inset Quotes erd
17532 \begin_inset Quotes eld
17536 \begin_inset Quotes erd
17540 If that is not the case, please follow the web links provided in the following
17542 There is a lot of good documentation out there covering old development
17543 history to the latest tools tips.
17546 \begin_layout Standard
17547 It is also assumed that you are familiar with LyX itself to a point that
17548 you are comfortable changing your LyX preferences, and X resources file.
17549 If that is not the case please refer to other LyX documentation to cover
17550 your specific needs.
17553 \begin_layout Subsection
17554 Literate Programming
17557 \begin_layout Standard
17558 From the Literate Programming FAQ:
17561 \begin_layout Quotation
17562 Literate programming is the combination of documentation and source together
17563 in a fashion suited for reading by human beings.
17564 In fact, literate programs should be enjoyable reading, even inviting!
17565 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17566 and documentation in a single file.
17567 Literate programming tools then parse the file to produce either readable
17568 documentation or compilable source.
17569 The WEB style of literate programming was created by D.
17570 \begin_inset space \thinspace{}
17574 Knuth during the development of his TeX typesetting software.
17578 \begin_layout Standard
17579 Another excerpt says:
17582 \begin_layout Quotation
17585 How is literate programming different from verbose commenting?
17588 \begin_layout Quotation
17589 There are three distinguishing characteristics.
17590 In order of importance, they are:
17594 \begin_layout Itemize
17595 flexible order of elaboration
17598 \begin_layout Itemize
17599 automatic support for browsing
17602 \begin_layout Itemize
17603 typeset documentation, especially diagrams and mathematics
17607 \begin_layout Standard
17608 Now that I sparked your curiosity, take a look in the references.
17611 \begin_layout Subsubsection
17615 \begin_layout Standard
17616 The complete Literate Programming FAQ can be found at:
17619 \begin_layout Quote
17620 Literate Programming FAQ
17621 \begin_inset Flex URL
17624 \begin_layout Plain Layout
17626 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17634 \begin_layout Standard
17635 The FAQ lists 23 (twenty three!) different literate programming tools.
17636 Where some are specialized or
17637 \begin_inset Quotes eld
17641 \begin_inset Quotes erd
17644 for particular programming languages, while other have general scope.
17649 for my own use for several reasons:
17652 \begin_layout Itemize
17653 It can generate the documentation either in LaTeX or HTML.
17656 \begin_layout Itemize
17657 It has a open architecture, i.
17658 \begin_inset space \thinspace{}
17662 \begin_inset space \space{}
17665 it is easy to plug in new filters and to perform special processing that
17670 \begin_layout Itemize
17671 There is a good selection of filters available already (the HTML is one
17675 \begin_layout Itemize
17679 \begin_layout Standard
17680 The Noweb web page can be found at:
17683 \begin_layout Quote
17685 \begin_inset Flex URL
17688 \begin_layout Plain Layout
17690 http://www.cs.virginia.edu/~nr/noweb/
17698 \begin_layout Standard
17699 Starting from there you can reach many other interesting links and even
17700 some literate program examples.
17703 \begin_layout Subsection
17704 LyX and Literate Programming
17707 \begin_layout Standard
17708 The LyX support for Literate Programming is provided by using the generic
17709 LyX converters mechanism.
17710 This support is provided in a
17711 \begin_inset Quotes eld
17715 \begin_inset Quotes erd
17719 \begin_inset space \thinspace{}
17723 \begin_inset space \space{}
17726 you will be able to use this new LyX feature with some other literate programmin
17727 g tool of your choice by just changing your LyX preferences.
17730 \begin_layout Subsubsection
17731 Generating documents and code (weaving and tangling)
17734 \begin_layout Paragraph
17735 Selecting the document class
17738 \begin_layout Standard
17739 If you have installed Noweb and LyX successfully, whenever you open a new
17740 document or try to change the document class of an existing one, you will
17741 find that there are three new document classes available:
17744 \begin_layout Itemize
17748 \begin_layout Itemize
17752 \begin_layout Itemize
17756 \begin_layout Standard
17757 You must select one of them to create your literate documents from.
17761 \begin_layout Standard
17762 Note that literate documents are not limited to these three classes.
17763 New classes can be generated from other styles like letter or in combination
17764 with other class variations like Article (AMS).
17765 If you have special needs that cannot be covered by one of the existing
17766 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17767 will arrange to insert a new entry, or teach you how to do it.
17771 \begin_layout Plain Layout
17772 It is very simple, it involves the creation of a file with four lines, and
17773 re-running of the auto configuration.
17778 Moreover, if you use a literate tool other than Noweb you may need to create
17779 a new set of document classes for it.
17782 \begin_layout Paragraph
17786 \begin_layout Standard
17787 LyX enables you to write code with a layout named
17795 \begin_layout Plain Layout
17796 The equivalent Noweb term is
17797 \begin_inset Quotes eld
17801 \begin_inset Quotes erd
17805 For historical reasons, I got used to the term
17806 \begin_inset Quotes eld
17810 \begin_inset Quotes erd
17813 introduced by other literate tool named Nuweb, which I used for many years
17814 before rendering myself to Noweb.
17819 Noweb delimits scraps like this:
17822 \begin_layout LyX-Code
17826 \begin_layout LyX-Code
17830 \begin_layout LyX-Code
17834 \begin_layout LyX-Code
17838 \begin_layout LyX-Code
17842 \begin_layout Standard
17843 The problem is that whatever is written in between the << and the
17847 must be taken literally, i.
17848 \begin_inset space \thinspace{}
17852 \begin_inset space \space{}
17855 LyX should be prevented from making any special interpretation of what has
17857 This is handled by a special layout named Scrap, that works like a normal
17858 paragraph but has a free spacing capability.
17861 \begin_layout Standard
17862 The down side of the Scrap paragraph layout is that consecutive paragraphs
17863 of code will be spaced with one empty line in the source code and also
17864 in the printed documentation.
17865 The work around is to enter each line of code within a single Scrap, with
17866 a newline (ctrl-return).
17867 The example above will look like this:
17871 \begin_layout Plain Layout
17872 If you have a printed version of this document you will not see any difference
17873 between the previous example and this one.
17881 \begin_layout LyX-Code
17883 \begin_inset Newline newline
17887 \begin_inset Newline newline
17891 \begin_inset Newline newline
17895 \begin_inset Newline newline
17901 \begin_layout Standard
17902 This layout works fine.
17903 The only real inconvenience is that you have to type ctrl-return instead
17908 \begin_layout Plain Layout
17909 It is in my list of
17910 \begin_inset Quotes eld
17914 \begin_inset Quotes erd
17925 \begin_layout Standard
17926 As a special note, you can also use the
17927 \begin_inset Quotes eld
17931 \begin_inset Quotes erd
17934 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17938 \begin_layout LyX-Code
17940 \begin_inset Newline newline
17943 def some_function(args):
17944 \begin_inset Newline newline
17947 "This is the doc string for this function."
17948 \begin_inset Newline newline
17951 print "My args: ", args
17954 \begin_layout LyX-Code
17955 @ %def some_function
17958 \begin_layout Standard
17959 For an example of this usage and the resulting cross-reference output, look
17960 at the Literate python program in
17962 LIBDIR/examples/listerrors.lyx
17964 which should make this all clear.
17967 \begin_layout Paragraph
17968 Generating the documentation
17971 \begin_layout Standard
17972 At this point you already have a new document file with a proper document
17973 class, and with some code and text on it.
17974 How do I print it? The answer is simple, you select
17976 View\SpecialChar \menuseparator
17980 Just like you would do for a plain document.
17981 No special procedure is required.
17984 \begin_layout Standard
17985 To help orientate you, I will now explain what happens inside LyX:
17988 \begin_layout Enumerate
17991 Update\SpecialChar \menuseparator
17994 menu option is chosen, a LaTeX file is generated.
17999 \begin_layout Standard
18000 If the document is of any literate class the generated file will be named
18001 with an extension name defined by the
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18009 format (defined in the Preferences panel), otherwise the file will have
18018 \begin_layout Enumerate
18019 Note that the only difference so far is in the name of the file, no special
18020 processing is required by LyX.
18021 Given that you formatted the code using the Scrap layout that, by itself,
18022 takes care of the business.
18025 \begin_layout Enumerate
18026 If the document is of any literate class LyX will then use the internal
18027 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18031 \begin_layout Plain Layout
18032 The converters are defined in the
18034 Tools\SpecialChar \menuseparator
18038 \begin_inset Quotes eld
18042 \begin_inset Quotes erd
18054 manual for general information about converters.
18059 to generate the LaTeX file.
18063 \begin_layout Standard
18064 Otherwise it will just skip this step.
18068 \begin_layout Enumerate
18069 Finally, LaTeX is invoked and the regular post processing continues as in
18073 \begin_layout Standard
18074 Independence from a particular
18075 \begin_inset Quotes eld
18079 \begin_inset Quotes erd
18082 is easily achieved by changing the commands that are run by the various
18086 \begin_layout Paragraph
18087 Generating the code
18090 \begin_layout Standard
18091 When the build menu option is chosen or the corresponding button in the
18092 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18093 Next, LyX invokes the
18098 This converter needs to be defined by the user and is not installed by
18099 default, though the Program format is.
18100 This converter (like any other converter) will have two parts:
18103 \begin_layout Enumerate
18104 The converter program itself.
18105 This program performs the conversion from the one format to the other (in
18106 this case, from the Noweb format to the Program pseudo-format).
18109 \begin_layout Enumerate
18110 The error log parser.
18111 This is a program whose sole purpose is to rewrite error messages in a
18112 format that LyX understands.
18113 This makes it possible for LyX to place error boxes in the right places
18114 in the file buffer.
18117 \begin_layout Standard
18118 The first part, the
18119 \begin_inset Quotes eld
18123 \begin_inset Quotes erd
18126 setting, should be set to
18127 \begin_inset Quotes eld
18135 \begin_inset Quotes erd
18139 This basically means that LyX will call
18140 \begin_inset Quotes eld
18144 \begin_inset Quotes erd
18147 (a program or script) with the name of the Noweb file (normally a file
18148 in the LyX temp directory).
18152 \begin_layout Standard
18153 This is an implementation of
18154 \begin_inset Quotes eld
18158 \begin_inset Quotes erd
18161 that you can place in a directory on your path:
18164 \begin_layout LyX-Code
18168 \begin_layout LyX-Code
18172 \begin_layout LyX-Code
18173 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18176 \begin_layout Standard
18177 The next part of the converter setting is the
18178 \begin_inset Quotes eld
18182 \begin_inset Quotes erd
18185 which is to be set to
18186 \begin_inset Quotes eld
18191 parselog=listerrors
18194 \begin_inset Quotes erd
18198 This will run any errors that are generated by the
18199 \begin_inset Quotes eld
18203 \begin_inset Quotes erd
18206 process through the
18207 \begin_inset Quotes eld
18211 \begin_inset Quotes erd
18217 \begin_layout Standard
18218 The converter code looks in
18226 then on the path for the
18227 \begin_inset Quotes eld
18231 \begin_inset Quotes erd
18237 \begin_layout Standard
18238 The build will normally take place in LyX's temporary directory, so the
18239 files produced by the conversion will be in that directory.
18240 LyX will copy out what it regards as the `main' file, but the
18244 conversion may produce several files, and so most of these would then be
18245 deleted when LyX was closed.
18246 The present solution is to use a `copier',
18250 \begin_layout Plain Layout
18259 manual for information on these.
18268 script in its default mode, so that the entire contents of the temporary
18269 directory is copied.
18270 More will get copied than is needed, to be sure, but nothing will be lost.
18271 If, however, you know what extensions the generated files will have, this
18272 can be improved by using the
18281 This option takes a comma-separated list of extensions to copy.
18282 So, for example, if the conversion will generate only files with the extensions
18291 , then the correct definition would be:
18294 \begin_layout LyX-Code
18295 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18298 \begin_layout Standard
18299 The result will be that only files with these two extensions will be copied
18303 \begin_layout Paragraph
18304 Build instructions in the document
18307 \begin_layout Standard
18308 The last piece of the integration between LyX and noweb is the
18309 \begin_inset Quotes eld
18313 \begin_inset Quotes erd
18317 Generally, the instructions for building your program should be embedded
18318 in a scrap of its own.
18320 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18327 above uses the notangle command to look for this scrap (called
18328 \begin_inset Quotes eld
18332 \begin_inset Quotes erd
18335 ) and runs its contents through
18336 \begin_inset Quotes eld
18340 \begin_inset Quotes erd
18346 \begin_layout Standard
18347 Typically, such a scrap would look something like this:
18350 \begin_layout LyX-Code
18352 \begin_inset Newline newline
18356 \begin_inset Newline newline
18360 \begin_inset Newline newline
18363 if [ -z "${NOWEB_SOURCE}" ]
18364 \begin_inset Newline newline
18368 \begin_inset Newline newline
18371 NOWEB_SOURCE=myfile.nw
18372 \begin_inset Newline newline
18376 \begin_inset Newline newline
18380 code to extract files ...]
18381 \begin_inset Newline newline
18385 code to compile files ...]
18386 \begin_inset Newline newline
18392 \begin_layout Standard
18395 LIBDIR/examples/listerrors.lyx
18399 LIBDIR/examples/Literate.lyx
18401 which implement two versions of the
18402 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18409 program for some illustrations of how all of these pieces go together or
18412 LIBDIR/examples/noweb2lyx.lyx.
18415 Interestingly, these three files show off the language-indepence of the
18416 LyX literate programming support since they are written in Python, C and
18420 \begin_layout Subsubsection
18424 \begin_layout Standard
18425 All the Literate Programming support is configured by the
18427 Tools\SpecialChar \menuseparator
18431 \begin_inset Quotes eld
18435 \begin_inset Quotes erd
18439 The important parts are:
18442 \begin_layout Description
18444 \begin_inset space ~
18448 \begin_inset Quotes eld
18452 \begin_inset Quotes erd
18456 \begin_inset space ~
18459 format Set up via the Formats tab, this is where the Noweb-specific pieces
18469 , the file extension is set to
18474 This tells LyX to create a file with a
18478 extension in the first step of the conversion process.
18481 \begin_layout Description
18483 \begin_inset space ~
18491 \begin_inset space ~
18494 format This is an empty format whose sole purpose is to be the endpoint
18495 of a conversion (which then allows us to set up a converter for it).
18498 \begin_layout Description
18507 This converter performs the
18508 \begin_inset Quotes eld
18512 \begin_inset Quotes erd
18515 of the literate document.
18516 For Noweb, it is set to
18517 \begin_inset Quotes eld
18522 noweave -delay -index $$i > $$o
18525 \begin_inset Quotes erd
18531 \begin_layout Description
18541 \begin_inset Quotes eld
18545 \begin_inset Quotes erd
18549 As stated above, the Converter is set to
18550 \begin_inset Quotes eld
18558 \begin_inset Quotes erd
18561 , with Flags set to
18562 \begin_inset Quotes eld
18567 originaldir,parselog=listerrors
18570 \begin_inset Quotes erd
18576 \begin_layout Subsubsection
18580 \begin_layout Standard
18581 There is also a new function implemented in the LyX server, the
18582 \begin_inset Quotes eld
18585 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18589 \begin_layout Standard
18590 When debugging code with ddd/gdb, it is possible to invoke a text editor
18591 at the current execution position with a single key stroke.
18592 The default ddd configuration for that is shift-ctrl-V.
18593 It happens that you can define the editor command line invocation in ddd
18596 Edit\SpecialChar \menuseparator
18597 Preferences\SpecialChar \menuseparator
18600 dialog and changing the "Edit Sources" entry.
18603 \begin_layout Standard
18604 I take advantage of the new created LyX server function and this ddd feature,
18606 \begin_inset Quotes eld
18610 \begin_inset Quotes erd
18616 \begin_layout LyX-Code
18617 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18620 \begin_layout Standard
18621 With this, whenever you are using ddd and find a point in the program that
18622 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18623 ddd you forward this information to LyX through the LyX server and then
18624 the LyX window will show the same file with the cursor at the same position
18625 ddd was pointing to.
18626 No more guessing or long scrolling to locate a point in the program back
18630 \begin_layout Standard
18631 Note however that you must enable the LyX server to get this feature working
18632 (it is disabled by default).
18633 You can enable it in
18645 ) by entering in the
18650 \begin_inset Quotes eld
18655 /home/<your-home-directory>/.lyx/lyxpipe
18658 \begin_inset Quotes erd
18664 \begin_layout Standard
18665 Read the LyX server documentation in the
18667 Customization Manual
18669 for further information.
18672 \begin_layout Subsubsection
18676 \begin_layout Standard
18677 There are six new buttons that can be added to your LyX toolbar.
18678 Five of these buttons are short cuts to layout styles:
18699 The last one is a short cut to the
18700 \begin_inset Quotes eld
18704 \begin_inset Quotes erd
18711 \begin_layout Standard
18712 LyX has a range of buttons that are available for tool bar customization.
18713 In my toolbar I like to combine the six short cuts above with two more:
18718 \SpecialChar \menuseparator
18723 \SpecialChar \menuseparator
18730 View\SpecialChar \menuseparator
18734 Here is how it looks like:
18737 \begin_layout LyX-Code
18741 \begin_layout LyX-Code
18745 \begin_layout LyX-Code
18746 Icon "layout Standard"
18749 \begin_layout LyX-Code
18750 Icon "layout Section"
18753 \begin_layout LyX-Code
18754 Icon "layout LaTeX"
18757 \begin_layout LyX-Code
18758 Icon "layout LyX-Code"
18761 \begin_layout LyX-Code
18762 Icon "layout Scrap"
18765 \begin_layout LyX-Code
18769 \begin_layout LyX-Code
18773 \begin_layout LyX-Code
18774 Icon "buffer-typeset"
18777 \begin_layout LyX-Code
18778 Icon "build-program"
18781 \begin_layout LyX-Code
18785 \begin_layout LyX-Code
18789 \begin_layout LyX-Code
18793 \begin_layout LyX-Code
18797 \begin_layout LyX-Code
18801 \begin_layout Subsubsection
18802 Colors customization
18805 \begin_layout Standard
18806 There are a number of colors in LyX that can be customized in
18811 One of the things that bothers people is the LaTeX font color.
18812 The default color is red, since the scraps uses LaTeX font, and there is
18813 a lot of scraps in literate documents, you may get tired of seeing everything
18815 You can change it by going to the tabs
18824 \begin_layout Standard
18825 The next thing is the visible presence of the newline character in the screen.
18826 You can choose the color of this particular character and make it blend
18828 I recommend you choosing a color that is close to the background but not
18829 equal, that way you still can see it is there, but it is not bothering
18834 \begin_layout Chapter
18835 Secrets of the LaTeX Masters
18836 \begin_inset CommandInset label
18845 \begin_layout Standard
18846 Though LyX is a powerful tool, it cannot hope to support everything that
18847 can be done with pure TeX/LaTeX.
18848 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18849 as long as you are not afraid to use that
18850 \begin_inset Quotes eld
18854 \begin_inset Quotes erd
18857 button on the toolbar or add things to the LaTeX preamble.
18858 This section lists some tips, tricks, and otherwise cool ideas to give
18859 your document that extra little flair.
18862 Do try this at home
18864 , just start with something a little smaller and less important than your
18868 \begin_layout Standard
18869 Most ideas in this section require less common files in your LaTeX installation.
18870 If you have a system like teTeX, most will already be available.
18871 A few, however, will need to be downloaded from one of the CTAN archives.
18872 Often, there are several ways to do something, or several LaTeX style files
18873 which do the same thing.
18874 We do not endorse one choice over another, we simply claim that we have
18875 done a particular task with a particular file.
18876 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18879 \begin_layout Section
18883 \begin_layout Standard
18886 Lars Gullik Bjønnes
18889 \begin_layout Subsection
18893 \begin_layout Standard
18894 The aim for this chapter
18898 \begin_layout Plain Layout
18899 Editor's note: Lars' original chapter was a masterful description of how
18905 However, it was too long to flow smoothly in this document.
18906 I have therefore chosen to excerpt the most important sections here (sorry,
18907 Lars); you can read the original chapter (and more of the story!) in the
18910 examples/multicol.lyx
18918 is to show how the LaTeX package
18922 can be used in a LyX document.
18923 As LyX doesn't support the
18927 package natively yet, we have to use some small hacks.
18928 By reading this section it should be obvious how to do this.
18931 \begin_layout Subsection
18935 \begin_layout Standard
18940 package allows switching between one and multicolumn format on the same
18942 Footnotes are handled correctly (for the most part), but will be placed
18943 at the bottom of the page and not under each column.
18944 LaTeX's float mechanism, however, is partly disabled in the current implementat
18946 At the moment only page-wide floats can be used within the scope of the
18950 \begin_layout Subsection
18954 \begin_layout Subsubsection
18958 \begin_layout Standard
18959 If you want to have two columns in your text, you have use LaTeX mode to
18964 begin{multicols}{2}
18966 at the point where you want the two column layout to start, and then
18972 where you want it to end.
18976 \begin_layout Standard
18980 \begin_layout Plain Layout
18984 begin{multicols}{2}
18992 \begin_layout Standard
18997 The Adventure of the Empty House
19000 \begin_inset Newline newline
19005 Sir Arthur Conan Doyle
19008 \begin_layout Standard
19011 It was in the spring of the year 1894 that all London was interested, and
19012 the fashionable world dismayed, by the murder of the Honourable Ronald
19013 Adair under most unusual and inexplicable circumstances.
19014 The public has already learned those particulars of the crime which came
19015 out in the police investigation, but a good deal was suppressed upon that
19016 occasion, since the case for the prosecution was so overwhelmingly strong
19017 that it was not necessary to bring forward all the facts.
19018 Only now, at the end of nearly ten years, am I allowed to supply those
19019 missing links which make up the whole of that remarkable chain.
19020 The crime was of interest in itself, but that interest was as nothing to
19021 me compared to the inconceivable sequel, which afforded me the greatest
19022 shock and surprise of any event in my adventurous life.
19023 Even now, after this long interval, I find myself thrilling as I think
19024 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19025 ty which utterly submerged my mind.
19026 Let me say to that public, which has shown some interest in those glimpses
19027 which I have occasionally given them of the thoughts and actions of a very
19028 remarkable man, that they are not to blame me if I have not shared my knowledge
19029 with them, for I should have considered it my first duty to do so, had
19030 I not been barred by a positive prohibition from his own lips, which was
19031 only withdrawn upon the third of last month.
19034 \begin_layout Standard
19038 \begin_layout Plain Layout
19050 \begin_layout Subsubsection
19054 \begin_layout Standard
19055 The same pattern is used when you want more than two columns:
19058 \begin_layout Standard
19062 \begin_layout Plain Layout
19066 begin{multicols}{3}
19074 \begin_layout Standard
19077 It can be imagined that my close intimacy with Sherlock Holmes had interested
19078 me deeply in crime, and that after his disappearance I never failed to
19079 read with care the various problems which came before the public.
19080 And I even attempted, more than once, for my own private satisfaction,
19081 to employ his methods in their solution, though with indifferent success.
19082 There was none, however, which appealed to me like this tragedy of Ronald
19084 As I read the evidence at the inquest, which led up to a verdict of willful
19085 murder against some person or persons unknown, I realized more clearly
19086 than I had ever done the loss which the community had sustained by the
19087 death of Sherlock Holmes.
19088 There were points about this strange business which would, I was sure,
19089 have specially appealed to him, and the efforts of the police would have
19090 been supplemented, or more probably anticipated, by the trained observation
19091 and the alert mind of the first criminal agent in Europe.
19092 All day, as I drove upon my round, I turned over the case in my mind and
19093 found no explanation which appeared to me to be adequate.
19094 At the risk of telling a twice-told tale, I will recapitulate the facts
19095 as they were known to the public at the conclusion of the inquest.
19098 \begin_layout Standard
19102 \begin_layout Plain Layout
19114 \begin_layout Standard
19115 You can have more than 3 columns if you want to, but that might not be very
19116 pleasant for the eye.
19119 \begin_layout Subsubsection
19120 Columns inside columns
19123 \begin_layout Standard
19124 You can even have columns inside columns:
19127 \begin_layout Standard
19131 \begin_layout Plain Layout
19135 begin{multicols}{2}
19143 \begin_layout Standard
19146 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19147 at that time governor of one of the Australian colonies.
19148 Adair's mother had returned from Australia to undergo the operation for
19149 cataract, and she, her son Ronald, and her daughter Hilda were living together
19153 \begin_layout Standard
19157 \begin_layout Plain Layout
19161 begin{multicols}{2}
19169 \begin_layout Standard
19172 The youth moved in the best society–had, so far as was known, no enemies
19173 and no particular vices.
19174 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19175 had been broken off by mutual consent some months before, and there was
19176 no sign that it had left any very profound feeling behind it.
19177 For the rest {sic} the man's life moved in a narrow and conventional circle,
19178 for his habits were quiet and his nature unemotional.
19179 Yet it was upon this easy-going young aristocrat that death came, in most
19180 strange and unexpected form, between the hours of ten and eleven-twenty
19181 on the night of March 30, 1894.
19184 \begin_layout Standard
19188 \begin_layout Plain Layout
19200 \begin_layout Standard
19203 Ronald Adair was fond of cards–playing continually, but never for such stakes
19205 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19206 It was shown that, after dinner on the day of his death, he had played
19207 a rubber of whist at the latter club.
19208 He had also played there in the afternoon.
19213 The evidence of those who had played with him– Mr.
19214 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
19215 and that there was a fairly equal fall of the cards.
19216 Adair might have lost five pounds, but not more.
19217 His fortune was a considerable one, and such a loss could not in any way
19219 He had played nearly every day at one club or other, but he was a cautious
19220 player, and usually rose a winner.
19221 It came out in evidence that, in partnership with Colonel Moran, he had
19222 actually won as much as four hundred and twenty pounds in a sitting, some
19223 weeks before, from Godfrey Milner and Lord Balmoral.
19224 So much for his recent history as it came out at the inquest.
19227 \begin_layout Standard
19231 \begin_layout Plain Layout
19243 \begin_layout Standard
19244 Please do read the file
19246 examples/multicol.lyx
19248 for more advanced examples including column and header spacing, vertical
19249 separator lines, and more.
19252 \begin_layout Section
19257 Paragraph Environment
19258 \begin_inset OptArg
19261 \begin_layout Plain Layout
19262 Numbering in Enumerate
19270 \begin_layout Standard
19276 \begin_layout Standard
19277 \begin_inset VSpace bigskip
19283 \begin_layout Standard
19285 The default numbering for the
19289 paragraph environment begins with Arabic numbers and ends with uppercase
19291 Suppose, however, you wanted a different type of numbering scheme.
19292 Here's a quickie example of how to change the numbering scheme:
19295 \begin_layout LyX-Code
19305 \begin_layout LyX-Code
19315 \begin_layout LyX-Code
19325 \begin_layout LyX-Code
19335 \begin_layout Standard
19336 \SpecialChar \ldots{}
19337 which changes the numbering scheme to uppercase Roman numerals, uppercase
19338 letters, Arabic numbers, and lowercase letter.
19341 \begin_layout Standard
19342 Additionally, the previous example also adds a little bit extra to the numbering
19344 For example, the first level label actually looks like:
19345 \begin_inset Quotes eld
19349 \begin_inset Quotes erd
19353 For ease of reading, we'll describe what the numbering schemes look like
19354 using a notation something like this: <
19355 \begin_inset Quotes eld
19359 \begin_inset Quotes erd
19363 \begin_inset space ~
19367 \begin_inset Quotes erd
19371 \begin_inset Quotes erd
19375 \begin_inset space ~
19379 \begin_inset Quotes erd
19383 \begin_inset Quotes erd
19387 \begin_inset space ~
19391 \begin_inset Quotes eld
19395 \begin_inset Quotes erd
19402 \begin_layout Standard
19403 As you can see in the example, there is a label command for each nesting
19410 \SpecialChar \ldots{}
19417 , as well as a counter,
19421 \SpecialChar \ldots{}
19427 There are also five
19428 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19465 , each of which take one counter as an argument.
19466 You can add characters before or after these, but there's no need to add
19470 \begin_layout Standard
19471 You can get really fancy with these.
19475 \begin_layout LyX-Code
19489 \begin_layout LyX-Code
19501 \begin_layout LyX-Code
19511 \begin_layout LyX-Code
19521 \begin_layout Standard
19522 produces the somewhat out of hand numbering scheme: <
19523 \begin_inset Quotes eld
19527 \begin_inset Quotes erd
19531 \begin_inset space ~
19535 \begin_inset Quotes erd
19539 \begin_inset Quotes erd
19543 \begin_inset space ~
19547 \begin_inset Quotes erd
19551 \begin_inset Quotes erd
19555 \begin_inset space ~
19559 \begin_inset Quotes eld
19563 \begin_inset Quotes erd
19570 \begin_layout Standard
19574 \begin_layout Section
19578 \begin_layout Standard
19584 \begin_layout Standard
19585 \begin_inset VSpace bigskip
19591 \begin_layout Standard
19596 \begin_layout Plain Layout
19602 tmpfont}{cmr17 scaled 2500}{
19614 \begin_layout Standard
19619 \begin_layout Plain Layout
19630 hose of you who like the style of old books probably also like
19631 \begin_inset Quotes eld
19635 \begin_inset Quotes erd
19638 —those large capital letters which begin each new chapter or section.
19639 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19640 know some plain TeX!) but does require a lot of work and many iterations,
19641 as you can see by all the ugly TeX-mode stuff at the beginning of this
19645 \begin_layout Standard
19649 \begin_layout Plain Layout
19655 bigdrop{-1em}{3}{ptmri}{T}+
19660 here is a much easier way of doing this, of course.
19669 ) package from CTAN allows a simple way to add such letters to your documents.
19670 Since this package is not a standard part of teTeX, I can't demonstrate
19671 it within this document, but if you copy this paragraph to a new document,
19673 \begin_inset Quotes eld
19683 \begin_inset Quotes erd
19686 and the pluses from the TeX code at the beginning of the paragraph, and
19691 usepackage{dropcaps}
19693 to your LaTeX preamble, you will get a nice Times Roman Italic
19694 \begin_inset Quotes eld
19698 \begin_inset Quotes erd
19701 , whose height is three lines of text and which protrudes 1 em into the
19703 (Make certain you have copied
19704 \begin_inset Quotes eld
19712 \begin_inset Quotes erd
19715 into a directory where TeX can see it.) The first argument is the amount
19716 of indentation; in this case the negative sign moves it into the margin.
19717 The second argument is the height of the letter in number of lines of text.
19718 The third argument is the font name: virtually anything which has a tfm
19719 file should work (wade through the
19721 .../texmf/fonts/tfm
19723 directory for possibilities).
19724 My personal favorite is
19725 \begin_inset Quotes eld
19733 \begin_inset Quotes erd
19736 , a fancy German font specifically designed for dropped capitals.
19737 The fourth argument is the letter (or letters) to be dropped.
19742 package also offers the
19748 command, as well as a slightly simplified
19757 \begin_layout Section
19758 Non-standard Paragraph Shapes
19761 \begin_layout Standard
19767 \begin_layout Standard
19768 \begin_inset VSpace bigskip
19774 \begin_layout Standard
19778 \begin_layout Plain Layout
19790 \begin_layout Standard
19794 \begin_layout Plain Layout
19803 \begin_layout Plain Layout
19817 \begin_layout Standard
19822 \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
19968 \begin_layout Plain Layout
19977 \begin_layout Plain Layout
19986 \begin_layout Plain Layout
19995 \begin_layout Plain Layout
20001 There are times when the tyranny of rectangular paragraphs must be overthrown.
20002 In such situations, a call to the delightful plain TeX command
20009 As you can see, completely arbitrary shapes can be laid out with a suitable
20010 set of linelength definitions.
20011 While this parshape may look a bit silly and useless, one could conceive
20012 of situations such as finely tuned dropped capitals, word wrapping around
20013 non-rectangular graphics, etc.
20014 which will benefit from such handcrafting.
20017 \begin_layout Standard
20018 \begin_inset VSpace bigskip
20024 \begin_layout Standard
20029 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20036 is the number of lines of text which define the paragraph.
20037 If there turn out to be fewer lines, the shape is truncated; if there are
20038 more, the excess lines have the same dimensions as the last line of the
20048 entries specify the indentation of the line from the left margin, and the
20049 length of the line as measured from that point.
20050 The shape applies only to the current paragraph; everything is reset to
20051 normal for the next paragraph.
20054 \begin_layout Standard
20058 \begin_layout Plain Layout
20070 \begin_layout Section
20074 \begin_layout Standard
20075 As you can see, the examples in this section range from the useful to the
20077 While I don't expect that anyone will ever need the paragraph shape demonstrate
20078 d in the last section, the important point is that you can do almost anything
20079 you want in LyX if you are willing to figure out how to do it in TeX and
20081 TeX is a fantastically powerful typesetting system and all that power is
20082 available to you since LyX uses it as its backend.