1 #LyX 1.6.0 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
83 \pdf_title "LyX's Extended manual"
84 \pdf_author "LyX Team"
85 \pdf_subject "LyX's extended documentation"
86 \pdf_keywords "LyX, Documentation, Extended"
88 \pdf_bookmarksnumbered true
89 \pdf_bookmarksopen false
90 \pdf_bookmarksopenlevel 1
95 \pdf_pdfusetitle false
96 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
103 \paperorientation portrait
106 \paragraph_separation indent
108 \quotes_language english
111 \paperpagestyle headings
112 \tracking_changes false
113 \output_changes false
121 Additional LyX Features
129 \begin_layout Plain Layout
131 Principal maintainer of this file is
136 If you have comments or error corrections, please send them to the LyX
137 Documentation mailing list,
138 \begin_inset Flex CharStyle:Code
141 \begin_layout Plain Layout
143 <lyx-docs@lists.lyx.org>
156 \begin_layout Standard
157 \begin_inset CommandInset toc
158 LatexCommand tableofcontents
165 \begin_layout Chapter
169 \begin_layout Standard
170 This manual is essentially Part II of the
172 User's Guide\SpecialChar \@.
175 The reason for separating this document out is simple: the
179 is already quite lengthy, and it contains information on all of the basic
180 features one needs to know in order to prepare most documents.
181 However, the LyX Team has worked to LyX extensible through various configuratio
182 n files and external packages.
183 That means that if you want to support the Fizzwizzle LaTeX package, you
184 can create a layout file (or module) for it without having to alter LyX
186 We've already had contributions of several new features this way.
187 This is the place where all of those get documented.
190 \begin_layout Standard
191 This manual also documents some special features, like fax support, version
192 control, and SGML support, which require additional software to work properly.
193 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
194 spruce up your documents by directly using the powerful features of LaTeX.
199 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
202 \begin_layout Standard
203 If you haven't read the
207 yet, you are definitely in the wrong manual.
212 is the first place to go, since it describes the notation and format of
214 You should also be thoroughly familiar with the
218 and all of the basic features of LyX before attempting to read this one.
221 \begin_layout Standard
222 Since all the topics in this manual depend heavily on LyX's interaction
223 with LaTeX, this first chapter covers the inner workings of LyX and how
224 to direct LyX to generate exactly the LaTeX code you want.
225 It is obviously for more seasoned LyX users.
228 \begin_layout Chapter
232 \begin_layout Section
236 \begin_layout Standard
237 This chapter is for both TeX-nicians and the LaTeX-curious.
238 In it, we'll explain how LyX and LaTeX work together to produce printable
240 This is the only place in any of the manuals where we assume you know something
244 \begin_layout Standard
245 At one time, LyX was called a
246 \begin_inset Quotes eld
249 WYSIWYM frontend to LaTeX,
250 \begin_inset Quotes erd
253 but that's no longer true.
254 There are frontends to LaTeX out there.
258 \begin_layout Plain Layout
259 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
260 There are also the LaTeX modes for vi and emacs, of course.
265 These are basically text editors with the ability to run LaTeX and mark
266 any errors in the file you're editing.
275 run LaTeX, and it also indicates errors in the file, it also does much,
277 For one thing, you don't need to know LaTeX to use LyX effectively.
278 And LyX has added its own extensions to LaTeX.
279 Try the following sometime: select
280 \begin_inset Flex CharStyle:MenuItem
283 \begin_layout Plain Layout
284 Export\SpecialChar \menuseparator
291 \begin_inset Flex CharStyle:MenuItem
294 \begin_layout Plain Layout
301 \begin_inset Flex CharStyle:MenuItem
304 \begin_layout Plain Layout
305 View\SpecialChar \menuseparator
311 ), then look at the preamble of the resulting
312 \begin_inset Flex CharStyle:Code
315 \begin_layout Plain Layout
322 You'll notice a variety of new macros defined specifically by LyX.
323 These macros are defined automatically, according to the features you use
327 \begin_layout Standard
328 There are several commands that automatically invoke LaTeX.
332 \begin_layout Itemize
333 \begin_inset Flex CharStyle:MenuItem
336 \begin_layout Plain Layout
337 View\SpecialChar \menuseparator
346 \begin_layout Itemize
347 \begin_inset Flex CharStyle:MenuItem
350 \begin_layout Plain Layout
351 View\SpecialChar \menuseparator
352 Update\SpecialChar \menuseparator
361 \begin_layout Itemize
362 \begin_inset Flex CharStyle:MenuItem
365 \begin_layout Plain Layout
366 File\SpecialChar \menuseparator
375 \begin_layout Itemize
376 \begin_inset Flex CharStyle:MenuItem
379 \begin_layout Plain Layout
380 File\SpecialChar \menuseparator
389 \begin_layout Standard
390 They will only invoke LaTeX if the file has changed since the last time
395 \begin_layout Standard
396 When LyX runs LaTeX on the file you're editing, it performs these steps:
399 \begin_layout Enumerate
400 Convert the document to LaTeX and save to a file with the extension
401 \begin_inset Flex CharStyle:Code
404 \begin_layout Plain Layout
411 \begin_inset Flex CharStyle:Code
414 \begin_layout Plain Layout
423 \begin_layout Enumerate
425 \begin_inset Flex CharStyle:Code
428 \begin_layout Plain Layout
434 file (maybe several times), and run any other commands (such as
435 \begin_inset Flex CharStyle:Code
438 \begin_layout Plain Layout
445 \begin_inset Flex CharStyle:Code
448 \begin_layout Plain Layout
454 ) needed to compile the LaTeX file.
457 \begin_layout Enumerate
458 If there are any errors, show the error log.
461 \begin_layout Standard
462 If you've run LaTeX using
463 \begin_inset Flex CharStyle:MenuItem
466 \begin_layout Plain Layout
469 \SpecialChar \menuseparator
477 , LyX then runs a DVI viewer to display the DVI-file.
479 \begin_inset Flex CharStyle:MenuItem
482 \begin_layout Plain Layout
485 \SpecialChar \menuseparator
493 , LyX performs further steps:
496 \begin_layout Itemize
498 \begin_inset Flex CharStyle:Code
501 \begin_layout Plain Layout
507 to convert the DVI file to PostScript.
510 \begin_layout Itemize
511 Run a PostScript viewer, such as
512 \begin_inset Flex CharStyle:Code
515 \begin_layout Plain Layout
521 , to display the PostScript file.
524 \begin_layout Standard
525 LyX does similar things when viewing, or exporting, other formats.
528 \begin_layout Section
529 Translating LaTeX files into LyX
532 \begin_layout Standard
533 You can import a LaTeX file into LyX by using the
534 \begin_inset Flex CharStyle:MenuItem
537 \begin_layout Plain Layout
538 File\SpecialChar \menuseparator
539 Import\SpecialChar \menuseparator
546 This will call a program named
547 \begin_inset Flex CharStyle:Code
550 \begin_layout Plain Layout
556 which will create a file
557 \begin_inset Flex CharStyle:Code
560 \begin_layout Plain Layout
567 \begin_inset Flex CharStyle:Code
570 \begin_layout Plain Layout
577 LyX will then open that file.
581 \begin_layout Plain Layout
582 \begin_inset Flex CharStyle:Code
585 \begin_layout Plain Layout
591 can also be run from the command line, of course.
599 \begin_layout Standard
600 \begin_inset Flex CharStyle:Code
603 \begin_layout Plain Layout
609 will translate most legal LaTeX, but not everything.
610 It will put things it doesn't understand into ERT, so after translating
612 \begin_inset Flex CharStyle:Code
615 \begin_layout Plain Layout
621 , you can look for ERT and hand-edit it until it looks right.
624 \begin_layout Standard
625 If you don't know what ERT is, read the next section.
628 \begin_layout Section
629 \begin_inset CommandInset label
631 name "sec:Inserting-TeX-Code"
635 Inserting TeX Code into LyX Documents
638 \begin_layout Standard
639 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
640 You can always insert TeX code into any LyX document.
641 LyX cannot, and will never be able to, display every possible LaTeX construct.
642 If ever you need to insert LaTeX commands into your LyX document, you can
644 \begin_inset Flex CharStyle:Code
647 \begin_layout Plain Layout
653 box, which you can insert into your document with
654 \begin_inset Flex CharStyle:MenuItem
657 \begin_layout Plain Layout
658 Insert\SpecialChar \menuseparator
667 \begin_layout Standard
668 Here's an example of inserting LaTeX commands in a LyX document.
669 The code looks like this:
672 \begin_layout LyX-Code
676 \begin_inset Newline newline
682 \begin_inset Newline newline
685 This is an example for a minipage environment.
687 \begin_inset Newline newline
690 can put nearly everything in it, even (non-floating)
691 \begin_inset Newline newline
696 \begin_inset Newline newline
702 \begin_inset Newline newline
706 \begin_inset Newline newline
712 \begin_inset Newline newline
718 \begin_inset Newline newline
724 \begin_inset Newline newline
729 \begin_inset Newline newline
735 \begin_inset Newline newline
741 \begin_inset Newline newline
747 \begin_inset Newline newline
755 \begin_layout LyX-Code
759 \begin_layout Standard
761 \begin_inset Flex CharStyle:Code
764 \begin_layout Plain Layout
770 box containing this text is directly after this paragraph.
771 Those of you reading the manual in LyX will only see the ERT inset.
772 Those reading a printed version of the manuals will see the actual results:
775 \begin_layout Standard
779 \begin_layout Plain Layout
786 \begin_layout Plain Layout
793 \begin_layout Plain Layout
795 This is an example for a minipage environment.
796 You can put nearly everything in it, even (non-floating) figures and tables.
800 \begin_layout Plain Layout
807 \begin_layout Plain Layout
812 \begin_layout Plain Layout
819 \begin_layout Plain Layout
826 \begin_layout Plain Layout
833 \begin_layout Plain Layout
839 \begin_layout Plain Layout
846 \begin_layout Plain Layout
853 \begin_layout Plain Layout
860 \begin_layout Plain Layout
872 \begin_layout Standard
873 In addition to using ERT, you can also create a separate file containing
874 some complex LaTeX structure and then use
875 \begin_inset Flex CharStyle:MenuItem
878 \begin_layout Plain Layout
879 Insert\SpecialChar \menuseparator
889 to include your file (you should select the type
890 \begin_inset Flex CharStyle:Code
893 \begin_layout Plain Layout
900 We recommend that you only do this if you have a
901 \begin_inset Flex CharStyle:Code
904 \begin_layout Plain Layout
915 Otherwise, you'll have a big job tracking down LaTeX errors.
918 \begin_layout Standard
919 There are a few last points to emphasize:
922 \begin_layout Itemize
927 check if your LaTeX code is correct.
930 \begin_layout Itemize
931 Beware reinventing the wheel.
934 \begin_layout Standard
935 On that last point, LyX does have quite a few features tucked into it, and
937 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
938 feature before you decide you have to do it by hand.
939 Moreover, there are numerous LaTeX packages out there to do all sorts of
940 things, from labels to envelopes to fancy multipage tables.
942 \begin_inset CommandInset href
945 target "http://www.ctan.org/"
949 for details, and see chapter
950 \begin_inset CommandInset ref
952 reference "cha:secrets"
959 \begin_layout Standard
960 If you do need to do some wild and fancy things within your document, be
961 sure to check out a good LaTeX book for assistance.
962 There are a number of them listed in the bibliography of the
969 \begin_layout Section
970 LyX and the LaTeX Preamble
973 \begin_layout Subsection
974 About the LaTeX Preamble
977 \begin_layout Standard
978 If you already know LaTeX, there is no need to explain here what the preamble
980 If you don't, the following will give you some ideas---we recommend again
981 that you consult a LaTeX book for further information.
982 In any case, you should read the points below, because they explain what
983 you can do and what you don't need to do in the LaTeX preamble of a LyX
987 \begin_layout Standard
988 The LaTeX preamble comes at the very beginning of a document,
996 \begin_layout Itemize
997 Declare the document class.
999 \begin_inset Newline newline
1002 LyX already does this for you.
1003 If you're a seasoned LaTeX-nician, and you have a custom document class
1004 you want to use, check out the
1006 Customization Manual
1008 for information on how to make LyX interface to it.
1011 \begin_layout Itemize
1012 Declare the usage of packages.
1014 \begin_inset Newline newline
1017 LaTeX packages provide special commands, which are only available within
1018 a document when the package has been declared in the preamble.
1019 For example, the package
1020 \begin_inset Flex CharStyle:Code
1023 \begin_layout Plain Layout
1029 forces all paragraphs to be indented.
1030 There are other packages for labels, envelopes, margins, etc.
1034 \begin_layout Itemize
1035 Set counters, variables, lengths and widths.
1037 \begin_inset Newline newline
1040 There are several LaTeX counters and variables which
1044 be set globally from within the preamble in order to have the desired effect.
1045 (There are variables which you can set and reset inside the document, too.)
1046 Margins are a good example of something which must be set in the preamble.
1047 Another example is the label format for lists.
1048 You can actually set these just about anywhere, but it's best to do it
1049 just once, inside the preamble.
1052 \begin_layout Itemize
1053 Declare user defined commands (with
1054 \begin_inset Flex CharStyle:Code
1057 \begin_layout Plain Layout
1066 \begin_inset Flex CharStyle:Code
1069 \begin_layout Plain Layout
1078 \begin_inset Newline newline
1081 These are abbreviations for LaTeX commands which appear very often inside
1083 Although the preamble is a good place to declare such commands, they
1087 be declared anywhere (before they are used for the first time, of course).
1088 This can be useful if there is a lot of raw LaTeX code in your document,
1089 which normally should not be the case.
1092 \begin_layout Standard
1093 LyX adds its own set of definitions to the preamble of the
1094 \begin_inset Flex CharStyle:Code
1097 \begin_layout Plain Layout
1104 This makes LaTeX files generated by LyX portable.
1107 \begin_layout Subsection
1108 Changing the Preamble
1111 \begin_layout Standard
1112 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1113 can't change them without patching LyX itself.
1114 You can, however, add your own stuff to the preamble by selecting
1115 \begin_inset Flex CharStyle:MenuItem
1118 \begin_layout Plain Layout
1120 \begin_inset space ~
1129 \begin_inset Flex CharStyle:MenuItem
1132 \begin_layout Plain Layout
1133 Document\SpecialChar \menuseparator
1140 LyX adds anything in the
1141 \begin_inset Flex CharStyle:MenuItem
1144 \begin_layout Plain Layout
1150 dialog to its own built-in preamble.
1151 Before adding your own declarations in the preamble, you should make sure
1152 that LyX doesn't already support what you want to do.
1153 (Remember what we said about reinventing the wheel?) Also,
1155 make sure your preamble code is correct
1158 LyX doesn't check it for you.
1159 If there is an error, you're likely to get an error like
1160 \begin_inset Quotes eld
1164 \begin_inset Flex CharStyle:Code
1167 \begin_layout Plain Layout
1176 \begin_inset Quotes erd
1180 If you see this error, check your preamble.
1183 \begin_layout Subsection
1187 \begin_layout Standard
1188 Here are some examples of what you can add to a preamble, and what they
1192 \begin_layout Subsubsection
1196 \begin_layout Standard
1197 There are two variables under LaTeX that control page position:
1198 \begin_inset Flex CharStyle:Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex CharStyle:Code
1213 \begin_layout Plain Layout
1222 Their names should be self-explanatory.
1223 These variables are useful if you think for a moment about computer labels.
1224 Sometimes, the size of a print medium and the area of the medium that you
1225 can actually print on aren't the same.
1227 \begin_inset Flex CharStyle:Code
1230 \begin_layout Plain Layout
1239 \begin_inset Flex CharStyle:Code
1242 \begin_layout Plain Layout
1253 \begin_layout Standard
1254 The default values for
1255 \begin_inset Flex CharStyle:Code
1258 \begin_layout Plain Layout
1267 \begin_inset Flex CharStyle:Code
1270 \begin_layout Plain Layout
1279 \begin_inset space \thinspace{}
1283 \begin_inset space \thinspace{}
1287 \begin_inset space \space{}
1290 the page isn't shifted.
1291 Unfortunately, some DVI drivers always seem to shift the page.
1292 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1293 If you're using LyX on a system that you don't personally maintain, and
1294 your sysadmin is a doofus,
1295 \begin_inset Flex CharStyle:Code
1298 \begin_layout Plain Layout
1307 \begin_inset Flex CharStyle:Code
1310 \begin_layout Plain Layout
1319 Suppose you're left and top margins are always 0.5
1320 \begin_inset space \thinspace{}
1324 You can add this to the preamble:
1327 \begin_layout LyX-Code
1335 \begin_layout LyX-Code
1343 \begin_layout Standard
1344 and your margins should now be correct.
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1353 There's a rather nice package, available at your nearest CTAN archive,
1354 for printing sheets of labels:
1355 \begin_inset Flex CharStyle:Code
1358 \begin_layout Plain Layout
1365 Now, your system may not have this package installed by default.
1366 We leave that up to you to check.
1367 You'll also want to read the documentation for it; we're not going to do
1369 Since this is an example, however, we'll give you an example of how you
1373 \begin_layout Standard
1374 First, make sure you're using the
1375 \begin_inset Flex CharStyle:Code
1378 \begin_layout Plain Layout
1385 Next, you need to put the following in your preamble:
1388 \begin_layout LyX-Code
1394 \begin_layout LyX-Code
1400 \begin_layout LyX-Code
1406 \begin_layout LyX-Code
1412 \begin_layout LyX-Code
1418 \begin_layout LyX-Code
1424 \begin_layout LyX-Code
1430 \begin_layout Standard
1431 This sets things up for Avery label sheets, stock #5360.
1432 You're now ready to print labels, but you'll need to insert LaTeX code,
1433 placing the commands
1434 \begin_inset Flex CharStyle:Code
1437 \begin_layout Plain Layout
1446 \begin_inset Flex CharStyle:Code
1449 \begin_layout Plain Layout
1457 around each label text.
1458 This and other special features of
1459 \begin_inset Flex CharStyle:Code
1462 \begin_layout Plain Layout
1468 are explained in its documentation.
1471 \begin_layout Standard
1472 Someday, someone may write a LyX layout file to support this package directly.
1473 Maybe that someone is you.
1476 \begin_layout Subsubsection
1477 Example #3: Paragraph Indentation
1480 \begin_layout Standard
1481 Americans are trained to indent the first line of
1486 As with all of their other weird quirks, most Americans will whine and
1487 moan until they can have their way and indent the first line of all paragraphs.
1496 \begin_layout Standard
1497 Of course, this behavior isn't standard typography.
1498 In books, you typically only indent the first line of a paragraph
1502 it follows another one.
1503 The idea behind indenting the first line of a paragraph is to distinguish
1504 neighboring paragraphs from one another.
1505 If there is no previous paragraph---for example, if it follows a figure
1506 or is the first paragraph in a section---then there is no need for indentation.
1510 \begin_layout Standard
1511 If you're a typical American (we're still joking!), though, you don't care
1512 about such esoteric things; you want your indentation! Add this to the
1516 \begin_layout LyX-Code
1519 usepackage{indentfirst}
1522 \begin_layout Standard
1523 If your TeX distribution isn't braindead, you'll have this package, and
1524 all of your paragraphs will get the indentation the Founding Fathers intended
1528 \begin_layout Subsubsection
1529 Example #4: This Document
1532 \begin_layout Standard
1533 You can also check out the preamble of this document to get an idea of some
1534 of the advanced things you can do.
1535 Also, there are more examples and an assortment of LaTeX
1536 \begin_inset Quotes eld
1540 \begin_inset Quotes erd
1544 \begin_inset space ~
1548 \begin_inset CommandInset ref
1550 reference "cha:secrets"
1558 \begin_layout Section
1559 LyX and LaTeX Errors
1562 \begin_layout Standard
1563 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1565 It then uses the logfile from the LaTeX run to do a post-mortem.
1566 After analyzing the logfile,LyX displays a dialog listing the errors.
1567 Clicking on any one of them will take you to the position in your LyX file
1568 where the error occurred.
1572 \begin_layout Plain Layout
1574 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1576 There are also cases where LaTeX reports the error on one line, but the
1577 actual error is earlier.
1578 This is not unlike forgetting a closing brace in a program: You'll get
1579 an error, but only later.
1587 \begin_layout Standard
1588 Some folks also like to look at the log file directly: It is available from
1590 \begin_inset Flex CharStyle:MenuItem
1593 \begin_layout Plain Layout
1596 \SpecialChar \menuseparator
1600 \begin_inset space ~
1609 There are some fairly common error messages and warnings.
1610 We'll cover those here.
1611 You should look at a good LaTeX book for a complete listing.
1614 \begin_layout Itemize
1615 \begin_inset Flex CharStyle:Code
1618 \begin_layout Plain Layout
1625 \begin_inset Newline newline
1628 Anything beginning with these words is a warning message for the purpose
1630 \begin_inset Quotes eld
1634 \begin_inset Quotes erd
1637 the LaTeX code itself.
1638 You'll get messages like this if you added or changed cross-references
1639 or bibliography entries, in which case, LaTeX is trying to tell you that
1640 you need to make another run.
1641 You can by-and-large ignore these.
1644 \begin_layout Itemize
1645 \begin_inset Flex CharStyle:Code
1648 \begin_layout Plain Layout
1655 \begin_inset Newline newline
1658 Another warning message, this time about fonts which LaTeX couldn't find.
1659 The rest of the message will often say something about a replacement font
1661 You can safely ignore these, too.
1664 \begin_layout Itemize
1665 \begin_inset Flex CharStyle:Code
1668 \begin_layout Plain Layout
1677 \begin_inset Newline newline
1685 They are warnings about lines that were too long and run past the right
1687 Almost always, this is unnoticeable in the final output.
1688 (It can be just a point or two.) Or, only one or two characters extend past
1690 LaTeX seems to generate at least one of these messages for just about any
1692 \begin_inset Newline newline
1695 You can ignore these messages.
1696 Your eyes will tell you if there's a problem with something that's too
1697 wide; just look at the output.
1701 \begin_layout Plain Layout
1702 You can also enable the `draft' option in
1703 \begin_inset Flex CharStyle:MenuItem
1706 \begin_layout Plain Layout
1709 \SpecialChar \menuseparator
1717 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1725 \begin_layout Itemize
1726 \begin_inset Flex CharStyle:Code
1729 \begin_layout Plain Layout
1738 \begin_inset Newline newline
1741 Not quite as common as its cousin.
1742 LaTeX seems to like to print lines that are a bit too wide as opposed to
1743 ones that are a bit too narrow.
1744 We have no idea why.
1747 \begin_layout Itemize
1748 \begin_inset Flex CharStyle:Code
1751 \begin_layout Plain Layout
1760 \begin_inset Flex CharStyle:Code
1763 \begin_layout Plain Layout
1772 \begin_inset Newline newline
1775 Warnings about troubles breaking the page.
1776 Once again, just look at the output.
1777 Your eyes will tell you where something has gone wrong.
1780 \begin_layout Itemize
1781 \begin_inset Flex CharStyle:Code
1784 \begin_layout Plain Layout
1786 \begin_inset Quotes els
1790 \begin_inset Quotes ers
1799 \begin_inset Newline newline
1803 \begin_inset Quotes eld
1807 \begin_inset Quotes erd
1810 isn't installed on this system.
1811 This usually appears because some package your document needs isn't installed.
1812 If you didn't touch the preamble or didn't use the
1813 \begin_inset Flex CharStyle:Code
1816 \begin_layout Plain Layout
1824 command, then one of the packages LyX tried to load is missing.
1826 \begin_inset Flex CharStyle:MenuItem
1829 \begin_layout Plain Layout
1830 Help\SpecialChar \menuseparator
1836 to get a list of packages that LyX knows about.
1837 This file is updated whenever you reconfigure LyX (using
1838 \begin_inset Flex CharStyle:MenuItem
1841 \begin_layout Plain Layout
1842 Tools\SpecialChar \menuseparator
1848 ) and tells you which packages have been detected and what they do.
1849 \begin_inset Newline newline
1853 \begin_inset Flex CharStyle:Code
1856 \begin_layout Plain Layout
1864 command and the package in question isn't installed, then you'll need to
1865 install it yourself.
1868 \begin_layout Itemize
1869 \begin_inset Flex CharStyle:Code
1872 \begin_layout Plain Layout
1873 LaTeX Error: Unknown option
1879 \begin_inset Newline newline
1882 Error messages beginning with this are trying to tell you that you specified
1883 a bad or undefined option to a package.
1884 Check the package's documentation.
1887 \begin_layout Itemize
1888 \begin_inset Flex CharStyle:Code
1891 \begin_layout Plain Layout
1892 Undefined control sequence
1898 \begin_inset Newline newline
1901 If you've inserted LaTeX code into your document, but made a typo, you'll
1903 You may have forgotten to load a package.
1904 In any case, this error message usually means that you used an undefined
1909 \begin_layout Standard
1910 There are other error and warning messages.
1911 Some are self-explanatory.
1912 These are usually LaTeX messages.
1913 Others are downright cryptic.
1914 These are usually TeX error messages, and we really have
1918 what they mean or how to decipher them.
1922 \begin_layout Standard
1923 There's a general sequence you should follow if you get error messages:
1926 \begin_layout Enumerate
1927 Look at the LaTeX code you inserted for typos.
1930 \begin_layout Enumerate
1931 If there are no typos, check that you used the command(s) correctly.
1934 \begin_layout Enumerate
1935 If you get a bunch of error boxes piled up at the very top of the document---and
1936 especially if you see a
1937 \begin_inset Quotes eld
1941 \begin_inset Flex CharStyle:Code
1944 \begin_layout Plain Layout
1953 \begin_inset Quotes erd
1956 error---it means that there are errors in the preamble.
1957 Start debugging your preamble.
1960 \begin_layout Enumerate
1961 If you didn't add anything to the preamble and didn't add any LaTeX code
1962 to the document, the first suspect is your LaTeX distribution itself.
1963 Check for missing packages and install them.
1966 \begin_layout Enumerate
1967 Okay, so there are no missing packages.
1968 Did you use any of the fine-tuning options in LyX? Specifically, did you
1973 any of them, like trying to manually insert lots of
1974 \begin_inset Flex CharStyle:Code
1977 \begin_layout Plain Layout
1979 \begin_inset space ~
1988 \begin_inset Flex CharStyle:Code
1991 \begin_layout Plain Layout
1998 \begin_inset Flex CharStyle:Code
2001 \begin_layout Plain Layout
2007 ? Did you try to kludge something together with these instead of using the
2008 appropriate paragraph environment?
2011 \begin_layout Enumerate
2012 All right, you didn't use any of the fine-tuning options, you played by
2014 Did you try to pull a fancy maneuver? Did you do something funky inside
2015 a table or an equation, like inserting a graphic into a table cell?
2018 \begin_layout Enumerate
2019 Do you have long sections of text where LaTeX cannot find a place to break
2020 a line? By default, LaTeX is rather strict about how much extra inter-word
2021 spacing it will add in order to break a line.
2022 Preferably, you should rework the paragraph to avoid the problem.
2023 If this isn't an option, you can wrap your text in
2024 \begin_inset Flex CharStyle:Code
2027 \begin_layout Plain Layout
2035 to make LaTeX's line breaking more, well, sloppy.
2038 \begin_layout Enumerate
2039 Did you go overboard with the nesting? LyX (currently) doesn't check to
2040 make sure you're in the limits for nesting environments.
2041 If you nested a bunch of environments to the
2042 \begin_inset Formula $17^{\mathrm{th}}$
2045 level, that's the problem.
2046 (The limit in LaTeX is five.)
2049 \begin_layout Enumerate
2050 Okay, you didn't get any error messages, but your output looks awful.
2051 If you have a table or figure that's too wide or long for the page, you
2056 \begin_layout Enumerate
2057 rescale the figure so it fits.
2060 \begin_layout Enumerate
2061 trim down the table so it fits.
2065 \begin_layout Enumerate
2066 If something else is wrong with the output, and you didn't try to pull anything
2067 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2070 \begin_layout Standard
2071 If all this doesn't help---well, then
2075 you might have found a bug in LyX\SpecialChar \ldots{}
2079 \begin_layout Chapter
2083 \begin_layout Section
2084 Customizing Bibliographies with BibTeX
2087 \begin_layout Standard
2088 The basics how to use BibTeX are explained in section
2090 Bibliography databases (BibTeX)
2097 The following subsections explain special bibliography features supported
2101 \begin_layout Subsection
2102 Alternative Citation Styles
2105 \begin_layout Standard
2106 Standard BibTeX uses numbers (e.
2107 \begin_inset space \thinspace{}
2111 \begin_inset space \space{}
2115 \begin_inset Quotes eld
2119 \begin_inset Quotes erd
2122 ) to refer to a cited work.
2123 However, in many scientific disciplines, other citation styles are in use.
2124 The most common one is the author-year style (e.
2125 \begin_inset space \thinspace{}
2129 \begin_inset space \space{}
2133 \begin_inset Quotes eld
2137 \begin_inset Quotes erd
2141 LyX supports two packages that provide this style,
2142 \begin_inset Flex CharStyle:Code
2145 \begin_layout Plain Layout
2152 \begin_inset Flex CharStyle:Code
2155 \begin_layout Plain Layout
2162 Both packages have their pros and cons, which cannot be listed in detail.
2163 If you only want to have simple author-year (or author-numerical) style,
2164 or if you want to use one of the countless style files for
2165 \begin_inset Flex CharStyle:Code
2168 \begin_layout Plain Layout
2174 , than the established
2175 \begin_inset Flex CharStyle:Code
2178 \begin_layout Plain Layout
2184 package is probably your choice.
2185 If you need special features like short title references, ibidem etc., you
2187 \begin_inset Flex CharStyle:Code
2190 \begin_layout Plain Layout
2199 \begin_layout Standard
2200 The handling of both packages in LyX is basically the same.
2202 \begin_inset Flex CharStyle:MenuItem
2205 \begin_layout Plain Layout
2206 Document\SpecialChar \menuseparator
2213 \begin_inset Flex CharStyle:MenuItem
2216 \begin_layout Plain Layout
2223 \begin_inset Flex CharStyle:MenuItem
2226 \begin_layout Plain Layout
2233 \begin_inset Flex CharStyle:MenuItem
2236 \begin_layout Plain Layout
2243 With both packages, you will get some extra features in the citation dialog
2244 and you can select the style of the reference (
2245 \begin_inset Quotes eld
2249 \begin_inset Quotes erd
2253 \begin_inset Quotes eld
2257 \begin_inset Quotes erd
2261 \begin_inset Quotes eld
2265 \begin_inset Quotes erd
2269 \begin_inset Quotes eld
2273 \begin_inset Quotes erd
2277 Note that both packages need specifically designed style files.
2278 They both ship their own, but there are lots of additional style files,
2279 and there is even an interactive style file builder
2283 \begin_layout Plain Layout
2285 \begin_inset Flex URL
2288 \begin_layout Plain Layout
2290 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2301 \begin_inset Flex CharStyle:Code
2304 \begin_layout Plain Layout
2313 \begin_layout Subsection
2314 Sectioned Bibliographies
2317 \begin_layout Standard
2318 Sometimes you might need to divide your bibliography into several sections.
2319 If you are for instance a historian, the possibility to separate sources
2320 and scientific works is most likely a
2321 \begin_inset Quotes eld
2325 \begin_inset Quotes erd
2329 Unfortunately, BibTeX itself does not allow you to do this.
2330 But with the help of some LaTeX packages, BibTeX can be extended to fit
2334 \begin_layout Standard
2335 LyX provides native support for one of these packages,
2343 \begin_layout Plain Layout
2345 \begin_inset Flex URL
2348 \begin_layout Plain Layout
2350 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2360 The advantage of this package (compared to other packages like
2364 ) is that you don't need to define new citation commands.
2365 Instead, you need to prepare different bibliographic databases which include
2366 the entries for the different sections of the bibliography.
2367 For example: If you want to divide your bibliography into the sections
2369 \begin_inset Quotes eld
2373 \begin_inset Quotes erd
2377 \begin_inset Quotes eld
2381 \begin_inset Quotes erd
2384 , you first need to create two bibliographic databases, e.
2385 \begin_inset space \thinspace{}
2389 \begin_inset space \space{}
2393 \begin_inset Flex CharStyle:Code
2396 \begin_layout Plain Layout
2403 \begin_inset Flex CharStyle:Code
2406 \begin_layout Plain Layout
2416 \begin_layout Standard
2418 \begin_inset Flex CharStyle:MenuItem
2421 \begin_layout Plain Layout
2422 Document\SpecialChar \menuseparator
2429 \begin_inset Flex CharStyle:MenuItem
2432 \begin_layout Plain Layout
2439 \begin_inset Flex CharStyle:MenuItem
2442 \begin_layout Plain Layout
2443 Sectioned bibliography
2449 Now you can insert multiple BibTeX bibliographies, one for each section
2450 of your bibliography.
2451 Returning to our example: Insert the BibTeX bibliography
2452 \begin_inset Flex CharStyle:Code
2455 \begin_layout Plain Layout
2461 and a second one for the database
2462 \begin_inset Flex CharStyle:Code
2465 \begin_layout Plain Layout
2472 You are free to use the same or different styles for each section.
2473 Additionally, you can chose if the bibliography section should contain
2475 \begin_inset Quotes eld
2478 all cited references
2479 \begin_inset Quotes erd
2482 of the specified database(s) (which is the default),
2483 \begin_inset Quotes eld
2486 all uncited references
2487 \begin_inset Quotes erd
2491 \begin_inset Quotes eld
2495 \begin_inset Quotes erd
2499 This might be useful if you would like to separate your bibliography into
2501 \begin_inset Quotes eld
2505 \begin_inset Quotes erd
2509 \begin_inset Quotes eld
2513 \begin_inset Quotes erd
2517 \begin_inset Quotes eld
2521 \begin_inset Quotes erd
2525 The titles for the sections can be added as ordinary sections or subsections.
2527 \begin_inset Flex CharStyle:Code
2530 \begin_layout Plain Layout
2536 removes the bibliography title, you have manually re-add that, too (as
2537 a chapter* or section*, for instance).
2540 \begin_layout Subsection
2541 Multiple Bibliographies
2544 \begin_layout Standard
2545 Multiple bibliographies, e.
2546 \begin_inset space \thinspace{}
2550 \begin_inset space \space{}
2553 a bibliography for each section or chapter of the document, are not supported
2556 \begin_inset Flex CharStyle:Code
2559 \begin_layout Plain Layout
2565 package, which is used for the creation of sectioned bibliographies in
2566 LyX (see the previous section), provides an easy way to solve this task,
2567 if you are willing to use some
2568 \begin_inset Flex CharStyle:MenuItem
2571 \begin_layout Plain Layout
2578 \begin_inset space ~
2582 \begin_inset CommandInset ref
2584 reference "sec:Inserting-TeX-Code"
2592 \begin_layout Plain Layout
2593 An alternative approach is to use the
2594 \begin_inset Flex CharStyle:Code
2597 \begin_layout Plain Layout
2604 \begin_inset Flex CharStyle:Code
2607 \begin_layout Plain Layout
2613 package, respectively.
2621 \begin_layout Standard
2623 \begin_inset Flex CharStyle:MenuItem
2626 \begin_layout Plain Layout
2627 Document\SpecialChar \menuseparator
2634 \begin_inset Flex CharStyle:MenuItem
2637 \begin_layout Plain Layout
2644 \begin_inset Flex CharStyle:MenuItem
2647 \begin_layout Plain Layout
2648 Sectioned bibliography
2654 In the document, you have to enclose the sections, which shall contain
2655 their own bibliography (including the BibTeX bibliography itself), between
2657 \begin_inset Flex CharStyle:Code
2660 \begin_layout Plain Layout
2669 \begin_inset Flex CharStyle:Code
2672 \begin_layout Plain Layout
2680 (those commands have to be inserted as ERT).
2681 The bibliography will contain all references which have been cited in the
2683 \begin_inset Flex CharStyle:Code
2686 \begin_layout Plain Layout
2697 If you are using this approach, then every citation reference has to be
2699 \begin_inset Flex CharStyle:Code
2702 \begin_layout Plain Layout
2710 \begin_inset Flex CharStyle:Code
2713 \begin_layout Plain Layout
2722 \begin_layout Section
2726 \begin_layout Subsection
2730 \begin_layout Standard
2731 When you are working on a large file with many sections, it is often convenient
2732 to break up the document into several files, or perhaps you have something
2733 where a table may change from time to time, but the preceding text does
2735 In these cases, you should seriously consider using multipart documents.
2736 For example, scientific papers often have five major sections: the introduction
2737 , observations, results, discussion, and conclusion.
2738 Each of these could be its own separate LyX file, with one
2739 \begin_inset Quotes eld
2743 \begin_inset Quotes erd
2746 file which contains the title, authors, abstract, references, etc., plus
2747 the five included files.
2748 It is important to note that each of these files is a full LyX file which
2749 can be formatted and printed on its own, as well as included in a master
2751 Each of these files must have the same document class, however---don't
2752 attempt to mix book classes with article classes.
2753 You may also include LaTeX files; however, these files must not have their
2755 \begin_inset space \thinspace{}
2759 \begin_inset space \space{}
2762 everything up to and including the
2763 \begin_inset Flex CharStyle:Code
2766 \begin_layout Plain Layout
2775 \begin_inset Flex CharStyle:Code
2778 \begin_layout Plain Layout
2786 line must be deleted) or else errors will be generated when you try to
2790 \begin_layout Standard
2791 LyX allows you to include files quite easily with
2792 \begin_inset Flex CharStyle:MenuItem
2795 \begin_layout Plain Layout
2796 Insert\SpecialChar \menuseparator
2798 \begin_inset space ~
2807 When you click on this selection a small box is inserted into the file
2808 at the current cursor location.
2809 Clicking on the box raises a dialog which allows you to select the file
2810 to be included, and the method of its inclusion.
2814 \begin_layout Standard
2815 The file selection box should by now be obvious.
2816 The three inclusion methods are
2817 \begin_inset Quotes eld
2821 \begin_inset Quotes erd
2825 \begin_inset Quotes eld
2829 \begin_inset Quotes erd
2833 \begin_inset Quotes eld
2837 \begin_inset Quotes erd
2841 The difference between
2842 \begin_inset Quotes eld
2846 \begin_inset Quotes erd
2850 \begin_inset Quotes eld
2854 \begin_inset Quotes erd
2857 is really only meaningful to LaTeXperts, but the practical difference is
2858 that files which are
2859 \begin_inset Quotes eld
2863 \begin_inset Quotes erd
2866 are typeset beginning on a new page, while files which are
2867 \begin_inset Quotes eld
2871 \begin_inset Quotes erd
2874 are typeset starting on the current page.
2877 \begin_layout Standard
2878 Generally, the master file is converted into a full LaTeX file before typesettin
2879 g, while the included files are converted to LaTeX files which do not have
2880 all the preamble information.
2883 \begin_layout Standard
2885 \begin_inset Quotes eld
2889 \begin_inset Quotes erd
2892 included file allows you to include a file typeset exactly as it appears
2894 \begin_inset space \thinspace{}
2898 \begin_inset space \space{}
2902 \begin_inset Flex CharStyle:Code
2905 \begin_layout Plain Layout
2911 mode, with the characters set in a fixed-width typewriter font.
2912 Normally, spaces in this file are invisible, though two consecutive spaces
2913 are conserved, unlike LyX's normal treatment of spaces.
2914 However, setting the
2915 \begin_inset Flex CharStyle:MenuItem
2918 \begin_layout Plain Layout
2920 \begin_inset space ~
2924 \begin_inset space ~
2928 \begin_inset space ~
2936 checkbox typesets a mark to unambiguously define the presence of a space.
2940 \begin_layout Subsection
2941 Cross-References Between Files
2944 \begin_layout Standard
2945 \begin_inset Box Shadowbox
2954 height_special "totalheight"
2957 \begin_layout Plain Layout
2958 This section is somewhat out of date.
2959 Need to describe default master documents and how children are opened when
2969 \begin_layout Standard
2970 It is possible to set up cross-references between the different files.
2971 First, open all the files in question: let's call them A and B in a two
2972 file example, where B is included in A.
2973 Let's say you insert a label in A, then want to reference it in B.
2974 Open the cross-reference dialog in whilst in document B, and you can select
2976 \begin_inset Quotes eld
2980 \begin_inset Quotes erd
2986 \begin_layout Subsection
2987 Bibliography Lists in all Subdocuments
2990 \begin_layout Standard
2991 \begin_inset Box Frameless
3000 height_special "totalheight"
3003 \begin_layout Plain Layout
3004 This section also needs updating.
3005 There is now material about this on the wiki, and it could be copied here.
3013 \begin_layout Standard
3014 Copy the bibliography list with all entries to all subdocuments and transform
3016 This way LyX will find the
3017 \begin_inset Flex CharStyle:Code
3020 \begin_layout Plain Layout
3026 -files and you can easily insert references without making the bibliography
3030 \begin_layout Standard
3031 As the bibliography list is in a comment, LaTeX won't use use it and the
3032 references will look like this: [?], instead of like this: [1].
3033 One solution is to use the LaTeX-package
3034 \begin_inset Flex CharStyle:Code
3037 \begin_layout Plain Layout
3043 that will only include comments by processing the files separately.
3044 To do this, add in the LaTeX preamble of every subdocument the following:
3047 \begin_layout LyX-Code
3053 \begin_layout LyX-Code
3056 includecomment{comment}
3059 \begin_layout Standard
3061 \begin_inset Flex URL
3064 \begin_layout Plain Layout
3066 http://wiki.lyx.org/FAQ/Unsorted#toc31
3074 \begin_layout Section
3075 Fancy Headers and Footers
3078 \begin_layout Standard
3079 The default page layout is rather plain; for an
3080 \begin_inset Flex CharStyle:Code
3083 \begin_layout Plain Layout
3089 document class, all you get is a centered page number at the bottom of
3091 This document uses KOMA-script's book class, so it appears to be a bit
3093 But to really put on a show, you need to set the document page style to
3095 \begin_inset Quotes eld
3099 \begin_inset Quotes erd
3102 , as mentioned in the
3107 This section describes the LaTeX code you need to insert in your LaTeX
3108 preamble in order to get the desired effects.
3111 \begin_layout Standard
3112 The page header is divided into three fields, not surprisingly labeled
3113 \begin_inset Quotes eld
3117 \begin_inset Quotes erd
3121 \begin_inset Quotes eld
3125 \begin_inset Quotes erd
3129 \begin_inset Quotes eld
3133 \begin_inset Quotes erd
3137 The footer is also divided into these three fields.
3138 The LaTeX commands to set these fields in the simplest manner are
3139 \begin_inset Flex CharStyle:Code
3142 \begin_layout Plain Layout
3151 \begin_inset Flex CharStyle:Code
3154 \begin_layout Plain Layout
3163 \begin_inset Flex CharStyle:Code
3166 \begin_layout Plain Layout
3175 \begin_inset Flex CharStyle:Code
3178 \begin_layout Plain Layout
3187 Suppose you wish to put your name in the upper left hand corner of each
3189 Simply insert the following command in the preamble:
3192 \begin_layout Standard
3201 \begin_layout Standard
3202 You will now see your name in the upper left.
3203 If a field has a default entry that you would like to get rid of (often
3204 the page number appears in the central footer, simply include a command
3205 with a blank argument, e.
3206 \begin_inset space \thinspace{}
3212 \begin_layout Standard
3220 \begin_layout Standard
3221 Let's get really fancy: lets put the section number with the word
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3230 \begin_inset space \thinspace{}
3234 \begin_inset space \space{}
3237 Section 3) in the upper left, the page number (e.
3238 \begin_inset space \thinspace{}
3242 \begin_inset space \space{}
3245 Page 4) in the upper right, your name in the lower left, and the date in
3247 The following commands should now appear in the preamble:
3250 \begin_layout Standard
3260 \begin_layout Standard
3268 \begin_layout Standard
3278 \begin_layout Standard
3287 \begin_layout Standard
3295 \begin_layout Standard
3305 \begin_layout Standard
3307 \begin_inset Flex CharStyle:Code
3310 \begin_layout Plain Layout
3319 \begin_inset Flex CharStyle:Code
3322 \begin_layout Plain Layout
3330 access LaTeX's section and page counters, and so print out the current
3331 section and page numbers.
3333 \begin_inset Flex CharStyle:Code
3336 \begin_layout Plain Layout
3344 simply prints out today's date.
3347 \begin_layout Standard
3348 The thicknesses of the horizontal rules drawn beneath the header and above
3349 the footer can also be modified.
3350 If you don't want one of the rules, set its thickness to 0.
3351 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3357 \begin_inset Flex CharStyle:Code
3360 \begin_layout Plain Layout
3365 headrulewidth}{0.4pt}
3371 \begin_inset Flex CharStyle:Code
3374 \begin_layout Plain Layout
3379 footrulewidth}{0.4pt}
3384 to set the thicknesses.
3387 \begin_layout Standard
3388 You can switch the header/footer settings on and off for individual pages
3390 \begin_inset Flex CharStyle:Code
3393 \begin_layout Plain Layout
3396 thispagestyle{empty}
3402 \begin_inset Flex CharStyle:Code
3405 \begin_layout Plain Layout
3408 thispagestyle{plain}
3414 \begin_inset Flex CharStyle:Code
3417 \begin_layout Plain Layout
3420 thispagestyle{fancy}
3426 Simply insert them in the text on the page you want changed and mark them
3428 In fact, title pages are marked as plain by default, while following pages
3429 are marked fancy when using the global fancy setting.
3432 \begin_layout Standard
3433 There are more complex commands which will let you insert things in the
3434 upper left on odd numbered pages, etc., but we will refer you to the
3435 \begin_inset Flex CharStyle:Code
3438 \begin_layout Plain Layout
3444 package documentation for more information.
3446 \begin_inset Flex CharStyle:Code
3449 \begin_layout Plain Layout
3458 \begin_layout Standard
3459 As a final example, it is possible to include an image in the header or
3461 Suppose you want to put a company logo in the upper lefthand corner.
3462 You might try something like
3465 \begin_layout Standard
3474 includegraphics{logo.eps}}}
3477 \begin_layout Standard
3479 (you may need to preface this with
3480 \begin_inset Flex CharStyle:Code
3483 \begin_layout Plain Layout
3487 usepackage{graphics}
3492 if you don't include graphics elsewhere in your document).
3495 \begin_layout Section
3496 Itemize Bullet Selection
3497 \begin_inset CommandInset label
3506 \begin_layout Standard
3512 \begin_layout Subsection
3516 \begin_layout Standard
3517 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3518 Using this dialog you can easily specify what bullet shape to use at each
3519 level of an itemized list.
3520 These settings are document-wide so you won't be able to specify different
3521 sets of bullets for different paragraphs.
3525 \begin_layout Plain Layout
3526 Well, actually you can but you'll have to do it by hand.
3534 \begin_layout Subsection
3538 \begin_layout Standard
3539 Open the dialog by selecting the
3540 \begin_inset Flex CharStyle:MenuItem
3543 \begin_layout Plain Layout
3544 Document\SpecialChar \menuseparator
3550 menu item and then select the
3551 \begin_inset Flex CharStyle:MenuItem
3554 \begin_layout Plain Layout
3563 \begin_layout Standard
3564 The dialog provides you with a table of bullet shapes.
3565 A column of buttons on the left of the table provides access to the six
3566 different panels of bullet shapes.
3567 The row of buttons across the top is used to select which bullet depth
3569 A text entry under the table shows the currently selected bullet shape's
3570 LaTeX equivalent and this can be edited if desired.
3571 If you do modify the text you will also need to specify any needed packages
3572 in the LaTeX preamble.
3575 \begin_layout Standard
3576 The six panels are divided up by the packages they require.
3577 The following table shows the mappings from button name to LaTeX packages.
3580 \begin_layout Standard
3582 \begin_inset Tabular
3583 <lyxtabular version="3" rows="7" columns="2">
3585 <column alignment="center" valignment="top" width="0pt">
3586 <column alignment="center" valignment="top" width="0pt">
3588 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3591 \begin_layout Plain Layout
3606 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3609 \begin_layout Plain Layout
3626 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3629 \begin_layout Plain Layout
3644 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3647 \begin_layout Plain Layout
3663 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3666 \begin_layout Plain Layout
3681 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3684 \begin_layout Plain Layout
3701 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3704 \begin_layout Plain Layout
3719 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3722 \begin_layout Plain Layout
3739 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3742 \begin_layout Plain Layout
3757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3760 \begin_layout Plain Layout
3777 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3780 \begin_layout Plain Layout
3795 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3798 \begin_layout Plain Layout
3815 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3818 \begin_layout Plain Layout
3833 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3836 \begin_layout Plain Layout
3859 \begin_layout Standard
3860 LyX doesn't stop you using bullets from packages you don't have.
3861 If you get errors from LaTeX when you try to view or print the file, then
3862 it is likely you are missing a package.
3866 \begin_layout Plain Layout
3867 LyX doesn't restrict your use since you may be editing locally and exporting
3876 \begin_layout Subsection
3880 \begin_layout Standard
3881 Select which bullet depth you want to change then select the bullet shape
3883 Any changes will not be visible in LyX, but are visible when viewing the
3887 \begin_layout Standard
3888 You can reset a bullet shape to the default simply by clicking your right
3889 mouse button on the appropriate bullet depth button.
3893 \begin_layout Plain Layout
3898 want to have multiple sets of paragraphs with different sets of bullets
3899 in each, then you're going to have to get your hands dirty with ERT.
3900 The bullet selection dialog can help though because it provides you with
3901 the LaTeX code for a wide range of bullet shapes.
3902 To make your own custom paragraphs you have the following options:
3905 \begin_layout Plain Layout
3909 \begin_layout Plain Layout
3925 \begin_layout Plain Layout
3929 \begin_layout Plain Layout
3951 \begin_layout Itemize
3952 Use the LaTeX command
3953 \begin_inset Flex CharStyle:Code
3956 \begin_layout Plain Layout
3964 to specify a new bullet shape for a given depth.
3965 You'll also need to save the current bullet shape so you can restore it
3967 In this itemized list the following LaTeX code was used to change the bullet
3968 used for the first depth.
3972 \begin_layout LyX-Code
3982 \begin_layout LyX-Code
3999 \begin_layout Itemize
4000 Note that the itemize depth is specified in Roman numerals as part of the
4010 \begin_layout Itemize
4014 \begin_layout Plain Layout
4027 Specify each individual entry by starting each item with the bullet shape
4028 enclosed in square brackets and set as
4029 \begin_inset Flex CharStyle:MenuItem
4032 \begin_layout Plain Layout
4039 For example, this item was started with
4040 \begin_inset Flex CharStyle:Code
4043 \begin_layout Plain Layout
4058 \begin_layout Plain Layout
4062 \begin_layout Plain Layout
4078 \begin_layout Plain Layout
4079 You'll also need to revert the labelitem back to its previous setting for
4080 the global bullet shape settings to remain in effect.
4081 The way used here was:
4084 \begin_layout LyX-Code
4099 \begin_layout Chapter
4103 \begin_layout Section
4107 \begin_layout Standard
4108 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4109 and retrieve information about the LyX internal state.
4110 This is only intended for advanced users, but they should find it useful.
4111 It is by writing to the LyX server, for example, that bibliography managers,
4112 such as JabRef, are able to
4113 \begin_inset Quotes eld
4117 \begin_inset Quotes erd
4123 \begin_layout Standard
4124 Please note that, at present,
4126 the server does not work on Windows
4132 \begin_layout Plain Layout
4133 There is no reason it cannot do so.
4134 But none of the developers on Windows have yet implemented this functionality
4143 \begin_layout Section
4144 Starting the LyX Server
4147 \begin_layout Standard
4148 The LyX server works through the use of a pair of named pipes.
4149 These are usually located in
4150 \begin_inset Flex CharStyle:Code
4153 \begin_layout Plain Layout
4160 \begin_inset Quotes eld
4164 \begin_inset Flex CharStyle:Code
4167 \begin_layout Plain Layout
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Flex CharStyle:Code
4185 \begin_layout Plain Layout
4192 \begin_inset Quotes erd
4196 External programs write into
4197 \begin_inset Flex CharStyle:Code
4200 \begin_layout Plain Layout
4206 and read back data from
4207 \begin_inset Flex CharStyle:Code
4210 \begin_layout Plain Layout
4217 The stem of the pipe names can be defined in the
4218 \begin_inset Flex CharStyle:MenuItem
4221 \begin_layout Plain Layout
4226 ools\SpecialChar \menuseparator
4237 \begin_inset Flex CharStyle:Code
4240 \begin_layout Plain Layout
4241 "/home/myhome/lyxpipe"
4251 configure this manually in order for the server to start.
4254 \begin_layout Standard
4256 \begin_inset Flex CharStyle:Code
4259 \begin_layout Plain Layout
4266 \begin_inset Flex CharStyle:Code
4269 \begin_layout Plain Layout
4275 ' to create the pipes.
4276 If one of the pipes already exists, LyX will assume that another LyX process
4277 is already running and will not start the server.
4278 This means that if LyX crashes, or if for some other reason, a
4279 \begin_inset Quotes eld
4283 \begin_inset Quotes erd
4286 pipe is left in existence when LyX closes, then LyX will not start the
4288 (This is bug 641.) You will need to delete the pipes manually and then restart
4292 \begin_layout Standard
4293 To have several LyX processes with servers at the same time, you have to
4294 use different configurations, perhaps by using separate user directories,
4296 \begin_inset Flex CharStyle:Code
4299 \begin_layout Plain Layout
4305 file, for each process.
4308 \begin_layout Standard
4309 If you are developing a client program, you might find it useful to enable
4310 debugging information from the LyX server.
4311 Do this by starting LyX as
4312 \begin_inset Flex CharStyle:Code
4315 \begin_layout Plain Layout
4324 \begin_layout Standard
4325 Other than this, there are a few points to consider:
4328 \begin_layout Itemize
4329 Both server and clients must run on UNIX or OS/2 machines.
4330 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4331 not possible right now.
4334 \begin_layout Itemize
4335 On OS/2, only one client can connect to LyXServer at a time.
4338 \begin_layout Itemize
4339 On OS/2, clients must open the input pipe with
4340 \begin_inset Flex CharStyle:Code
4343 \begin_layout Plain Layout
4352 \begin_layout Standard
4353 You can find a complete example client written in C in the source distribution
4355 \begin_inset Flex CharStyle:Code
4358 \begin_layout Plain Layout
4359 development/lyxserver/server_monitor.c
4367 \begin_layout Section
4368 Normal communication
4371 \begin_layout Standard
4372 To issue a LyX call, the client writes a line of ASCII text into the input
4374 This line has the following format:
4391 \begin_layout Description
4392 clientname is a name that the client can choose arbitrarily.
4393 Its only use is that LyX will echo it if it sends an answer---so a client
4394 can dispatch results from different requesters.
4397 \begin_layout Description
4398 function is the function you want LyX to perform.
4399 It is the same as the commands you'd use in the minibuffer.
4402 \begin_layout Description
4403 argument is an optional argument which is meaningful only to some functions
4405 \begin_inset Quotes eld
4409 \begin_inset Quotes erd
4412 LFUN will insert the argument as text at the cursor position).
4415 \begin_layout Standard
4416 The answer from LyX will arrive in the output pipe and be of the form
4433 \begin_layout Standard
4442 are just echoed from the command request, while
4446 is more or less useful information filled according to how the command
4447 execution worked out.
4448 Some commands, such as
4449 \begin_inset Quotes eld
4453 \begin_inset Quotes erd
4456 , will return information about the internal state of LyX, while other will
4457 return an empty data-response.
4458 This means that the command execution went fine.
4461 \begin_layout Standard
4462 In case of errors, the response from LyX will have this form
4479 \begin_layout Standard
4484 should contain an explanation of why the command failed.
4487 \begin_layout Standard
4491 \begin_layout LyX-Code
4492 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4495 \begin_layout LyX-Code
4496 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4497 \begin_inset Newline newline
4500 read a <~/.lyxpipe.out
4501 \begin_inset Newline newline
4507 \begin_layout Section
4511 \begin_layout Standard
4512 LyX can notify clients of events going on asynchronously.
4513 Currently it will only do this if the user binds a key sequence with the
4515 \begin_inset Quotes eld
4519 \begin_inset Quotes erd
4523 The format of the string LyX sends is as follows:
4527 \begin_inset Flex CharStyle:Code
4530 \begin_layout Plain Layout
4541 \begin_layout Standard
4546 is the printed representation of the key sequence that was actually typed
4550 \begin_layout Standard
4551 This mechanism can be used to extend LyX's command set and implement macros.
4552 Bind some key sequence to
4553 \begin_inset Quotes eld
4557 \begin_inset Quotes erd
4561 Then start a client that listens on the output pipe, dispatches the command
4562 according to the sequence, and starts a function that may use LyX calls
4563 and LyX requests to issue a command or a series of commands to LyX.
4566 \begin_layout Section
4567 The simple LyX Server Protocol
4570 \begin_layout Standard
4571 LyX implements a simple protocol that can be used for session management.
4572 All messages are of the form
4585 \begin_layout Standard
4591 \begin_inset Quotes eld
4595 \begin_inset Quotes erd
4599 \begin_inset Quotes eld
4603 \begin_inset Quotes erd
4608 \begin_inset Quotes eld
4612 \begin_inset Quotes erd
4615 is received from a client, LyX will report back to inform the client that
4616 it's listening to it's messages, while
4617 \begin_inset Quotes eld
4621 \begin_inset Quotes erd
4624 sent from LyX will inform clients that LyX is closing.
4627 \begin_layout Chapter
4628 Special Document Classes
4631 \begin_layout Section
4635 \begin_layout Standard
4641 \begin_layout Subsection
4645 \begin_layout Standard
4646 This section describes how LyX can be used to write articles for submission
4647 to the scientific journal
4649 Astronomy and Astrophysics
4651 (www.edpsciences.fr/aa/
4652 \begin_inset Flex URL
4655 \begin_layout Plain Layout
4657 http://www.edpsciences.fr/aa/
4662 ) using Version 5.01 of the document class
4667 This package can be downloaded from the ftp site
4670 \begin_layout Standard
4671 \begin_inset VSpace medskip
4677 \begin_layout Standard
4679 \begin_inset Flex URL
4682 \begin_layout Plain Layout
4684 ftp://ftp.edpsciences.org/pub/aa/readme.html
4692 \begin_layout Standard
4693 \begin_inset VSpace medskip
4699 \begin_layout Standard
4700 A manual comes together with that package, and this text is not meant to
4701 replace the original manual but merely a short guide how to realize the
4702 correct form of your paper.
4706 \begin_layout Standard
4707 Please note that the publisher of the journal was changed from Springer
4708 to EDP Sciences starting January 1, 2001.
4709 That change implicated also some slight changes of the style files, namely
4710 the removal of the thesaurus command.
4711 The LyX class aa supports the newest version of these style files, V 5.01.
4712 If you have an older version installed, please upgrade.
4713 For compatibility, the old (version 4) layout has been kept as
4718 Please refer to the comments in
4720 LyXDir/layouts/aapaper.layout
4725 \begin_layout Subsection
4729 \begin_layout Standard
4730 It is recommended you start from the example template distributed with LyX.
4731 If you are not using a template, note the following settings:
4734 \begin_layout Itemize
4744 ocument\SpecialChar \menuseparator
4751 dialog (OK, that one was obvious).
4754 \begin_layout Itemize
4755 Don't change the option
4758 \begin_inset space ~
4768 The whole layout is done by the macros, you shouldn't change anything.
4771 \begin_layout Subsection
4775 \begin_layout Standard
4776 First thing to enter is the header information.
4777 It consists of seven entries, of which some are optional.
4781 \begin_layout Itemize
4789 \begin_layout Itemize
4797 \begin_layout Itemize
4805 \begin_layout Itemize
4813 \begin_layout Itemize
4818 : [optional] if more than one author: whom to contact for offprint requests.
4821 \begin_layout Itemize
4826 : [optional] mail address for contacts.
4829 \begin_layout Itemize
4837 Received: <date>; Accepted <date>
4840 \begin_layout Standard
4841 There is no need to issue the
4847 command, this is done automatically by LyX when the header is finished.
4848 Although the order of the single header entries doesn't matter it is advised
4849 to keep the above sequence, just to get the best optics and meets the layout
4850 of the real document.
4853 \begin_layout Standard
4854 If you want to place footnotes in the header block, e.
4855 \begin_inset space \thinspace{}
4859 \begin_inset space \space{}
4862 to state your present address, just use the standard footnote via the menu
4865 Insert\SpecialChar \menuseparator
4869 LyX will automagically use the term
4878 \begin_layout Standard
4879 In addition to these topics, the macros use three additional LaTeX commands
4880 that have no counterpart in LyX:
4883 \begin_layout Itemize
4890 to separate different names for more than one author and institute, respectivel
4894 \begin_layout Itemize
4901 to mark corresponding author/institute pairs.
4902 The institutes are numbered sequentially as they appear in the
4906 field, so you have to put a marker to each author.
4909 \begin_layout Itemize
4916 to supply an email address for fast contact.
4919 \begin_layout Standard
4920 In all cases, the appropriate command has to be entered in LyX and marked
4926 \begin_layout Subsection
4930 \begin_layout Standard
4931 The abstract should immediately follow the header block.
4932 With version 5 the abstract environment was changed to a command, and there
4933 is now a resctriction to only one paragraph.
4934 In addition, it should contain an entry with the keywords.
4935 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4942 by hand and mark it as LaTeX code.
4943 Refer to the example paper.
4946 \begin_layout Subsection
4947 Supported environments
4950 \begin_layout Standard
4951 The A&A paper layout supports the following environments for structuring
4955 \begin_layout Itemize
4961 \begin_layout Itemize
4967 \begin_layout Itemize
4973 \begin_layout Itemize
4979 \begin_layout Itemize
4985 \begin_layout Itemize
4991 \begin_layout Itemize
4997 \begin_layout Itemize
5003 \begin_layout Itemize
5009 \begin_layout Itemize
5015 \begin_layout Itemize
5021 \begin_layout Itemize
5027 \begin_layout Subsection
5028 Commands not supported by LyX
5031 \begin_layout Standard
5032 Some commands are not yet supported by the
5037 Some have already been mentioned.
5038 For the sake of completeness, they are listed all together here:
5041 \begin_layout Itemize
5049 \begin_layout Itemize
5057 \begin_layout Itemize
5065 \begin_layout Itemize
5073 \begin_layout Itemize
5081 \begin_layout Itemize
5089 \begin_layout Itemize
5097 \begin_layout Itemize
5105 \begin_layout Standard
5106 If you want to use any of these commands, you have to enter them yourself.
5109 Do not forget to mark them as LaTeX code!
5112 \begin_layout Subsection
5113 Figure and Table Floats
5116 \begin_layout Standard
5117 LyX provides support for the necessary float environments
5119 figure, figure*, table
5125 , therefore we won't tell much about it here.
5129 \begin_inset space ~
5135 Just remember that tables should be left-aligned.
5136 For that, select the table and change the alignment in
5141 dit\SpecialChar \menuseparator
5147 \begin_inset space ~
5153 \begin_layout Standard
5154 There is only one special thing: the figures with caption besides the figure.
5155 To create such a figure, you have to do the following:
5158 \begin_layout Enumerate
5159 Create a wide figure float:
5164 nsert\SpecialChar \menuseparator
5169 t\SpecialChar \menuseparator
5172 , then right click in the figure and select
5178 \begin_inset space ~
5186 \begin_layout Enumerate
5187 Enter your caption text.
5190 \begin_layout Enumerate
5195 to move the cursor above the caption.
5198 \begin_layout Enumerate
5202 \begin_layout Enumerate
5203 Position the cursor behind the figure and insert a horizontal fill:
5208 nsert\SpecialChar \menuseparator
5214 \begin_inset space ~
5219 \SpecialChar \menuseparator
5223 \begin_inset space ~
5231 \begin_layout Enumerate
5232 Switch to LaTeX mode:
5235 \begin_inset space ~
5243 \begin_layout Enumerate
5253 Do not close the brace!
5256 \begin_layout Enumerate
5257 Position the cursor behind the caption text, switch to LaTeX mode and insert
5261 \begin_inset space ~
5273 \begin_layout Standard
5274 Also, refer to the figures in the example paper.
5277 \begin_layout Subsection
5281 \begin_layout Standard
5282 For submission, the paper has to be formated in a special double-spacing
5284 For this purpose, you have to give the option
5288 to the documentclass.
5289 This must be done using the extra class options field in the
5291 Document\SpecialChar \menuseparator
5295 Just enter the string
5302 \begin_layout Subsection
5306 \begin_layout Standard
5311 directory contains an example paper written with LyX.
5312 It is the example paper from the original macro package, translated to
5314 Use it for inspiration, and compare the original LaTeX code with LyX way
5318 \begin_layout Section
5322 \begin_layout Standard
5328 \begin_layout Subsection
5332 \begin_layout Standard
5333 AASTeX is a set of macros produced by the American Astronomical Society
5334 to facilitate electronic manuscript submission to the three journals they
5335 publish: the Astrophysical Journal (including the Letters and Supplement),
5336 the Astronomical Journal, and the Publications of the Astronomical Society
5338 LyX has proven to be an excellent tool for generating these documents,
5339 especially given its equation, citation, and figure handling capabilities.
5340 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5341 is the version described here, or higher.
5342 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5343 incompatible with LyX.
5344 The AASTeX package may be downloaded from the AASTeX Web site
5347 \begin_layout Standard
5348 \begin_inset VSpace medskip
5354 \begin_layout Standard
5356 \begin_inset Flex URL
5359 \begin_layout Plain Layout
5361 http://www.journals.uchicago.edu/AAS/AASTeX
5369 \begin_layout Standard
5370 \begin_inset VSpace medskip
5376 \begin_layout Standard
5377 A complete user guide is contained in that package and you should familiarize
5378 yourself with it thoroughly before embarking on writing a paper in LyX.
5379 LyX will not reduce the need to figure out all the AASTeX commands, it
5380 will only reduce the drudgery of typing everything in.
5381 It is your responsibility to ensure that the final exported LaTeX document
5382 conforms completely to the requirements of the journal to which you are
5383 submitting your paper.
5386 \begin_layout Subsection
5387 Starting a New Paper
5390 \begin_layout Standard
5391 I strongly suggest that you start with the AASTeX template file.
5397 ile\SpecialChar \menuseparator
5407 , enter the new file name, then choose the
5412 This will show the most common fields found in a manuscript.
5413 Simply overwrite the existing text (including the brackets,
5417 ) with the correct information.
5418 Many of the AASTeX commands and environments can be implemented directly
5419 in LyX, but some cannot: most noticeably
5431 , which should stick out like a sore thumb if you actually just opened the
5433 For commands such as these, the LaTeX code must be entered directly and
5435 Such commands are referred to as ERT, or Evil Red Text.
5436 I tried to minimize the amount of ERT needed in an AASTeX document, but
5437 there is still a bit more required than any of us would like.
5440 \begin_layout Subsection
5441 Finishing Your Paper
5444 \begin_layout Standard
5445 When the paper is finished to your satisfaction and previews/prints correctly,
5447 \begin_inset Quotes eld
5451 \begin_inset Quotes erd
5454 actions which need to be done before you submit it to the journals.
5458 \begin_layout Enumerate
5459 Export your paper as a LaTeX file (
5464 ile\SpecialChar \menuseparator
5469 xport\SpecialChar \menuseparator
5480 \begin_layout Enumerate
5485 file with your favorite text editor
5489 \begin_layout Enumerate
5490 remove the comment lines before the
5499 \begin_layout Enumerate
5504 usepackage...{fontenc}
5506 line if it appears (usually just after
5521 \begin_layout Enumerate
5522 remove everything between (and including) the
5534 commands, except for any commands you specifically put into the LaTeX preamble
5535 (which should appear immediately after the
5536 \begin_inset Quotes eld
5539 User specified LaTeX commands
5540 \begin_inset Quotes erd
5551 \begin_layout Enumerate
5552 Run the resulting file through LaTeX to make sure it still processes correctly.
5555 \begin_layout Enumerate
5556 Reread the journal requirements to make sure your filenames and formats
5560 \begin_layout Enumerate
5564 \begin_layout Subsection
5565 Comments On Specific Commands
5568 \begin_layout Standard
5569 I will not describe the detailed usage of the individual AASTeX commands:
5570 the AASTeX User Guide (
5574 ) gives a good description of each.
5575 Thus it's probably easiest for me to go down the list as found in the guide
5576 and offer comments where necessary.
5577 So let's begin \SpecialChar \ldots{}
5581 \begin_layout Subsubsection
5582 Things that work as expected
5585 \begin_layout Standard
5589 \begin_layout Plain Layout
5601 \begin_layout Standard
5602 Because they work as you might expect, I simply list them and the section
5703 begin{thebibliography}
5711 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5712 graphicx figure commands (2.14.1),
5736 (2.15.4, amongst other places),
5763 \begin_layout Standard
5764 The following style options also work correctly:
5785 Simply put them in the
5791 Layout\SpecialChar \menuseparator
5797 \begin_layout Standard
5801 \begin_layout Plain Layout
5813 \begin_layout Subsubsection
5814 Things that work, but require more comment
5817 \begin_layout Standard
5818 The following items work, but require a little more discussion:
5821 \begin_layout Itemize
5822 These items are reserved for use by the journal editors, but you can put
5823 them into the LaTeX preamble if you feel compelled to do so:
5856 \begin_layout Itemize
5857 These items may be placed in the LaTeX preamble, and are included as blanks
5858 in the template file:
5879 \begin_layout Itemize
5886 (2.3) -- can only be used
5887 \begin_inset Quotes eld
5891 \begin_inset Quotes erd
5894 , not in the middle of a paragraph.
5895 Use ERT if you need to embed it.
5898 \begin_layout Itemize
5905 (2.3) -- will have extra {} after it.
5906 This should not cause an error.
5909 \begin_layout Itemize
5916 (2.6) -- can only be used
5917 \begin_inset Quotes eld
5921 \begin_inset Quotes erd
5924 , not in the middle of a paragraph.
5925 Use ERT if you need to embed it.
5928 \begin_layout Itemize
5935 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5939 \begin_layout Itemize
5946 (2.8) -- same as for
5953 \begin_layout Itemize
5960 (2.9) -- will have extra {} after it.
5961 This should not cause an error.
5964 \begin_layout Itemize
5971 (2.11) -- will have extra {} after it.
5972 This should not cause an error.
5975 \begin_layout Itemize
5982 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5983 at the beginning of the text and selecting
5985 Insert\SpecialChar \menuseparator
5990 \begin_inset Quotes eld
5994 \begin_inset Quotes erd
5997 inserts an optional argument of the type needed by
6004 Hopefully it will be renamed someday.
6007 \begin_layout Itemize
6020 for the catalog ID optional parameter
6023 \begin_layout Itemize
6036 for the catalog ID optional parameter
6039 \begin_layout Subsubsection
6040 Things not implemented, use ERT
6043 \begin_layout Standard
6047 \begin_layout Plain Layout
6059 \begin_layout Standard
6082 setcounter{equation}
6084 (2.12), Journal name abbreviations (2.13.4),
6120 (2.15.4, insert it as the first element in the lefthand cell after where
6122 Don't use any of LyX's rules in the table),
6134 (2.15.5), much of Misc (2.17, except
6185 \begin_layout Standard
6189 \begin_layout Plain Layout
6201 \begin_layout Subsubsection
6202 Things that cannot be implemented
6205 \begin_layout Standard
6206 \SpecialChar \ldots{}
6207 at least in any meaningful sort of way, so I suggest ignoring them.
6208 They are the references environment (2.13.3), and the deluxetable environment
6210 If you really, really need to use deluxetable, I suggest editing it in
6211 a separate file with a text editor, then using
6216 nsert\SpecialChar \menuseparator
6222 \begin_inset space ~
6227 to include it in your LyX document.
6232 file to see an example of this.
6235 \begin_layout Subsection
6236 FAQs, Tips, Tricks, and Other Ruminations
6239 \begin_layout Subsubsection
6240 Getting LyX and AASTeX to cooperate
6243 \begin_layout Standard
6244 It can be a bit tricky to get LyX to recognize a new layout and document
6246 When all else fails, do this:
6249 \begin_layout Enumerate
6250 Make certain that LaTeX can find AASTeX.
6251 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6252 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6259 \begin_layout Enumerate
6271 \begin_layout Enumerate
6277 ools\SpecialChar \menuseparator
6284 in LyX, then restart LyX.
6287 \begin_layout Enumerate
6288 Open a regular new file, not from a template.
6289 Does AASTeX appear in the class list in
6294 ocument\SpecialChar \menuseparator
6304 \begin_layout Standard
6305 If you get a warning from an existing AASTeX document about not being able
6306 to find the AASTeX layout or a message about
6307 \begin_inset Quotes eld
6310 You should not mix title layouts with normal ones
6311 \begin_inset Quotes erd
6314 , things haven't been installed correctly.
6317 \begin_layout Subsubsection
6318 LaTeX error processing a table
6321 \begin_layout Standard
6322 LyX, by default, attempts to center the table caption/title.
6323 This seems to produce a bad interaction in AASTeX so you should click somewhere
6324 in the caption/title, then select
6329 dit\SpecialChar \menuseparator
6335 \begin_inset space ~
6352 This took care of it for me.
6355 \begin_layout Subsubsection
6359 \begin_layout Standard
6360 A couple of things: 1) I have noticed some funny spacing in the reference
6361 entries in the text.
6362 When you enter the bibliography item data, make sure their is
6366 space between the last author and the parenthesis setting off the year;
6370 \begin_inset space \thinspace{}
6374 \begin_inset space \space{}
6388 2) Entering the references at all is not obvious.
6389 The easiest thing is to start typing your first reference at the end of
6390 the document, then mark it as type
6395 That will put a small gray box in front of what you just typed.
6396 Click on the box to fill in the rest of the information.
6397 For new references, go to the end of an existing reference and press return.
6398 That will create a new line with its own box, etc.
6401 \begin_layout Subsubsection
6405 \begin_layout Standard
6406 Even though AASTeX provides its own figure commands (
6412 , for example), I much prefer LaTeX's standard figure commands (with the
6421 \begin_inset space ~
6424 commands as ERT into a Figure Float box if you desire, but I never have
6425 much luck getting the layout right.
6426 With the standard graphics, LyX will insert a
6430 usepackage{graphicx}
6432 command into the LaTeX preamble and handle the figures in the standard
6433 LaTeX2e way, interspersing the figures in the text.
6434 I believe ApJ accepts figures exactly this way now; AJ might still use
6436 \begin_inset Quotes eld
6439 stack everything at the end
6440 \begin_inset Quotes erd
6446 \begin_layout Subsubsection
6447 Things I could have done, but didn't
6450 \begin_layout Standard
6452 \begin_inset Quotes eld
6456 \begin_inset Quotes erd
6459 things I could have implemented, but chose not to.
6460 For instance, I saw no point in double-spacing the text in the LyX window,
6461 even though it is double-spaced in the paper manuscript.
6462 Also, I chose not to make separate layouts for the preprint and preprint2
6464 Since I assume you will spend most of your time in the plain manuscript
6465 mode anyway, I decided not to chew up more disk space with this.
6469 \begin_layout Subsection
6473 \begin_layout Standard
6474 Your mileage may vary.
6475 I've now had papers published by both ApJ and AJ that have had 98% of the
6476 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6478 I have had no trouble with the submission process, and I'm sure the journals
6479 were never aware that there might be a difference.
6480 So, go forth and publish!
6483 \begin_layout Section
6487 \begin_layout Standard
6490 David Johnson; updated by Richard Heck
6493 \begin_layout Standard
6494 \begin_inset VSpace bigskip
6500 \begin_layout Standard
6502 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6503 papers to be submitted to American Mathematical Society publications.
6504 The layouts are not tailored to a specific journal, but easily can be.
6505 You should refer to the AMS documentation for specific instructions for
6506 each journal (usually it will entail only changing a single line in the
6508 That documentation is available on the Web at
6509 \begin_inset Flex URL
6512 \begin_layout Plain Layout
6520 \begin_inset Flex URL
6523 \begin_layout Plain Layout
6525 ftp://ftp.ams.org/pub/tex/amslatex/
6531 These layouts are appropriate, and useful, for any mathematical writing.
6535 \begin_layout Standard
6536 There are two basic AMS LaTeX layouts:
6539 \begin_layout Itemize
6540 amsart: The standard AMS article format.
6543 \begin_layout Itemize
6544 amsbook: the standard AMS book (really, monograph) format.
6548 \begin_layout Standard
6549 The layouts themselves contain only the minimum necessary to use the AMS
6551 They do not, in particular, contain any of the `theorem' environments used
6552 for setting theorems, lemmas, and the like.
6553 These are contained, instead, in the
6554 \begin_inset Flex CharStyle:Code
6557 \begin_layout Plain Layout
6563 module, which is loaded by default when when you select one of the AMS
6565 (It can also be used with other classes and can be removed, if you would
6566 rather use something else.) Less commonly used environments are in the
6567 \begin_inset Flex CharStyle:Code
6570 \begin_layout Plain Layout
6571 Theorems (AMS-Extended)
6576 module, which must be loaded manually.
6579 \begin_layout Standard
6580 By default, theorems and the like are numbered consecutively throughout
6581 the document, but this may be modified by loading the module
6582 \begin_inset Flex CharStyle:Code
6585 \begin_layout Plain Layout
6586 Theorems (Order by Section)
6591 or, if you are using
6592 \begin_inset Flex CharStyle:Code
6595 \begin_layout Plain Layout
6602 \begin_inset Flex CharStyle:Code
6605 \begin_layout Plain Layout
6606 Theorems (Order by Chapter)
6612 These will number the results as
6613 \begin_inset Formula $n.m$
6616 , where the first number refers to the section (or chapter) and the second
6617 refers to the total number of results so far in that section (or chapter).
6618 Many environments are also available unnumbered.
6619 These are indicated by an asterisk at the end.
6620 If you happen to want
6624 unnumbered results, the the module
6625 \begin_inset Flex CharStyle:Code
6628 \begin_layout Plain Layout
6634 provides that option.
6637 \begin_layout Standard
6638 Note that these modules do not
6642 to be used with the AMS classes.
6643 It is perfectly possible to use the
6644 \begin_inset Flex CharStyle:Code
6647 \begin_layout Plain Layout
6653 module, and the others mentioned, with other classes, such as
6654 \begin_inset Flex CharStyle:Code
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 Subsection
6687 What these layouts provide
6690 \begin_layout Standard
6691 There is a long list of included environments provided by these layouts.
6692 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6693 variety of `theorem' environments.
6694 However, the AMS recommends the environments that are available in LyX.
6698 \begin_layout Standard
6699 The following environments---as well as the standard environments, such
6701 \begin_inset Flex CharStyle:Noun
6704 \begin_layout Plain Layout
6711 \begin_inset Flex CharStyle:Noun
6714 \begin_layout Plain Layout
6721 \begin_inset Flex CharStyle:Noun
6724 \begin_layout Plain Layout
6731 \begin_inset Flex CharStyle:Noun
6734 \begin_layout Plain Layout
6741 \begin_inset Flex CharStyle:Noun
6744 \begin_layout Plain Layout
6751 \begin_inset Flex CharStyle:Code
6754 \begin_layout Plain Layout
6761 \begin_inset Flex CharStyle:Code
6764 \begin_layout Plain Layout
6773 \begin_layout Description
6774 Address This should be the author's permanent address.
6777 \begin_layout Description
6779 \begin_inset space ~
6782 Address This should be the author's temporary address at the time of submission,
6783 if different from the Address.
6786 \begin_layout Description
6787 Email Author's e-mail address
6790 \begin_layout Description
6791 URL Author's Web address, if desired.
6794 \begin_layout Description
6795 Keywords Key words or phrases used to identify specific topics discussed
6799 \begin_layout Description
6800 Subjectclass These refer to the AMS Subject Classifications, published and
6803 Mathematical Reviews
6806 These are also available online at the AMS cites listed above.
6809 \begin_layout Description
6813 \begin_layout Description
6817 \begin_layout Description
6821 \begin_layout Standard
6822 The following environments are provided by both the
6823 \begin_inset Flex CharStyle:Code
6826 \begin_layout Plain Layout
6833 \begin_inset Flex CharStyle:Code
6836 \begin_layout Plain Layout
6842 modules, in the latter case in both starred (unnumbered) and unstarred
6843 (numbered) versions.
6844 These same environments are provided only in the starred versions by the
6846 \begin_inset Flex CharStyle:Code
6849 \begin_layout Plain Layout
6858 \begin_layout Theorem
6859 This is typically used for the statements of major results.
6863 \begin_layout Corollary*
6864 This is used for statements which follow fairly directly from previous statement
6866 Again, these can be major results.
6871 These are smaller results needed to prove other statements.
6874 \begin_layout Proposition
6875 These are less major results which (hopefully) add to the general theory
6879 \begin_layout Conjecture
6880 These are statements provided without justification, which the author does
6881 not know how to prove, but which seem to be true (to the author, at least).
6884 \begin_layout Definition*
6885 Guess what this is for.
6886 The font is different for this environment than for the previous ones.
6890 \begin_layout Example*
6891 Used for examples illustrating proven results.
6894 \begin_layout Problem
6895 It's not really known what this is for.
6896 You should figure it out.
6899 \begin_layout Exercise*
6900 Write a description for this one.
6903 \begin_layout Remark
6904 This environment is also a type of theorem, usually a lesser sort of observation.
6907 \begin_layout Claim*
6908 Often used in the course of giving a proof of a larger result.
6912 Generally, these are used to break up long arguments, using specific instances
6918 The numbering scheme for cases is on its own, not together with other numbered
6924 At the end of this environment, a QED symbol (usually a square, but it can
6925 vary with different styles) is placed.
6926 If you want to have other environments within this one---for example, Case
6927 environments---and have the QED symbol appear only after them, then the
6928 other environments need to be nested within the proof environment.
6931 Nesting Environments
6937 for information on nesting.
6940 \begin_layout Standard
6941 And these environments are provided by
6942 \begin_inset Flex CharStyle:Code
6945 \begin_layout Plain Layout
6946 Theorems (AMS-Extended)
6954 \begin_layout Criterion*
6955 A required condition.
6958 \begin_layout Algorithm*
6959 A general procedure to be used.
6962 \begin_layout Axiom*
6963 This is a property or statement taken as true within the system being discussed.
6966 \begin_layout Condition*
6967 Sometimes used to state a condition assumed within the present context of
6972 Similar to a Remark.
6975 \begin_layout Notation*
6976 Used for the explanation of, yes, notation.
6979 \begin_layout Summary
6980 Do we really need to tell you?
6983 \begin_layout Acknowledgement*
6987 \begin_layout Conclusion*
6988 Sometimes used at the end of a long train of argument.
6992 Used in a way similar to Proposition, though perhaps lower on the scale.
6995 \begin_layout Standard
6996 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6998 They need to be available on your system in order to use these environments.
7001 \begin_layout Section
7009 \begin_layout Standard
7015 \begin_layout Subsection
7019 \begin_layout Standard
7020 These are the layout files for some of the journals of the American Geophysical
7022 It is assumed that you have both the AGU's own class files and AGUplus
7023 installed (everything to be found at
7024 \begin_inset Flex URL
7027 \begin_layout Plain Layout
7029 ftp://ftp.agu.org/journals/latex/journals
7037 \begin_layout Subsection
7041 \begin_layout Standard
7051 They are still called this in the LyX GUI, though their LaTeX equivalents
7052 in the AGU classes are
7063 \begin_layout Standard
7064 Newly defined styles are
7101 These are mostly manuscript attributes and defined in the AGU class documentati
7105 \begin_layout Standard
7106 I suspect this is still badly incomplete.
7109 \begin_layout Subsection
7113 \begin_layout Standard
7130 \begin_layout Subsection
7134 \begin_layout Itemize
7137 Journal of Geophysical Research
7146 \begin_layout Standard
7147 Add your own, it isn't so hard! Look at the
7158 \begin_layout Subsection
7159 Bugs and things to remember
7162 \begin_layout Standard
7163 In order to use the new layouts, you must remember to do the following for
7167 \begin_layout Enumerate
7173 This can be done in the
7175 layout\SpecialChar \menuseparator
7180 document\SpecialChar \menuseparator
7184 (AGU articles are always in English, right? So
7191 \begin_layout Enumerate
7201 (Yes, this is a bug.)
7204 \begin_layout Enumerate
7205 Make sure you use the
7209 bibliography style, by entering
7213 into the second field of the BibTeX inset.
7214 None of the standard styles will do.
7217 \begin_layout Section
7221 \begin_layout Standard
7227 \begin_layout Subsection
7231 \begin_layout Standard
7232 Broadway is for writing plays.
7233 The format is more decorative than Hollywood, and much less standardized.
7234 This format should be suitable for workshops.
7237 \begin_layout Subsection
7241 \begin_layout Standard
7242 The same as in Hollywood.
7245 \begin_layout Subsection
7249 \begin_layout Standard
7254 names as labels then cross-reference the label to insert the name.
7255 The cross-reference dialog will show the current cast of characters.
7258 \begin_layout Subsection
7259 Paper size and Margins
7262 \begin_layout Standard
7263 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7266 \begin_layout Subsection
7270 \begin_layout Standard
7271 The following environments are available.
7272 You can use broadway.bind to get the bind keys shown at the right.
7275 \begin_layout Itemize
7279 \begin_inset Newline newline
7284 You should not have to use this, but it is here for anything that does not
7288 \begin_layout Itemize
7292 \begin_inset space \hfill{}
7296 \begin_inset Newline newline
7301 Used to describe stage setting and the action.
7302 First use of speaker names in all CAPs.
7305 \begin_layout Itemize
7309 \begin_inset space \hfill{}
7313 \begin_inset Newline newline
7318 Automatically numbered.
7319 On screen it will be arabic, but will print as Roman.
7322 \begin_layout Itemize
7326 \begin_inset space \hfill{}
7330 \begin_inset Newline newline
7340 It is just centered text.
7343 \begin_layout Itemize
7347 \begin_inset space \hfill{}
7351 \begin_inset Newline newline
7356 Not automatically numbered.
7357 You supply the number.
7358 This is because I couldn't figure out how.
7361 \begin_layout Itemize
7365 \begin_inset space \hfill{}
7369 \begin_inset Newline newline
7374 A special case of Narrative to describe the setting and action as the curtain
7378 \begin_layout Itemize
7382 \begin_inset space \hfill{}
7386 \begin_inset Newline newline
7391 The speaker's (actor's) title, centered in all CAPS.
7394 \begin_layout Itemize
7398 \begin_inset space \hfill{}
7402 \begin_inset Newline newline
7407 Instructions to the speaker.
7408 The parentheses are automatically inserted.
7409 The ( will appear on screen, but both will be in the printed play.
7410 This environment is only used within
7417 \begin_layout Itemize
7421 \begin_inset space \hfill{}
7425 \begin_inset Newline newline
7430 What the Speaker says.
7433 \begin_layout Itemize
7437 \begin_inset space \hfill{}
7441 \begin_inset Newline newline
7446 The curtain comes down.
7449 \begin_layout Itemize
7453 \begin_inset space \hfill{}
7459 \begin_layout Itemize
7463 \begin_inset space \hfill{}
7469 \begin_layout Itemize
7473 \begin_inset space \hfill{}
7479 \begin_layout Standard
7483 \begin_layout Section
7487 \begin_layout Standard
7492 can be used to type letters according to German conventions.
7493 A template file is included in
7495 .../lyx/share/templates
7497 for you to use as a starting point.
7500 \begin_layout Section
7508 \begin_layout Standard
7514 \begin_layout Subsection
7518 \begin_layout Standard
7519 This is the layout file for the European Geophysical Society journals.
7524 can be downloaded from the web site of the EGS under
7525 \begin_inset Flex URL
7528 \begin_layout Plain Layout
7538 \begin_layout Subsection
7542 \begin_layout Standard
7545 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7553 The current layout file is unfortunately very unmodular and would benefit
7554 from using the various
7561 \begin_layout Section
7565 \begin_layout Standard
7571 \begin_layout Standard
7572 Elsevier Science Publishers B.V.
7573 provides a standard LaTeX document class (
7577 ) for submitting articles to their various journals.
7578 The style file can be downloaded directly from their web site:
7579 \begin_inset Flex URL
7582 \begin_layout Plain Layout
7584 http://authors.elsevier.com/
7590 Instructions are supplied along with the class file, which details the
7591 requirements of the publishers.
7592 LyX includes package that allows for the use of this class, by a layout
7593 and a template file.
7594 Installation of the class file is the same as for any other LaTeX package;
7595 instructions are provided in the Elsevier documentation.
7598 \begin_layout Standard
7608 As the Elsevier class file is based mainly on the standard article class,
7609 most of the normal functionality is provided.
7610 The Elsevier class defines a number of mathematical environments, which
7611 are similar to the AMS environments.
7612 These commands are all described in the Elsevier documentation, and are
7616 \begin_layout Standard
7617 The easiest way to use the Elsevier style is to base documents on the included
7619 It is best not to use options such as fancy headings or the geometry package,
7620 as elements such as these are defined by Elsevier in their style file.
7621 Ideally, no extra packages except those mentioned in the Elsevier documentation
7623 Essentially, Elsevier require as
7624 \begin_inset Quotes eld
7628 \begin_inset Quotes erd
7631 a LaTeX file as possible, as their intention is to take the supplied file
7632 and replace the class file with one for the particular journal to which
7633 the paper has been submitted.
7634 This also means that not too much time should be spent on the formating
7636 When it comes to be published, this will change anyway.
7637 The rest of the usage for this layout is substantially the same as for
7638 the normal article class.
7639 For details of what Elsevier do and don't allow, refer to their documentation.
7642 \begin_layout Section
7651 \begin_inset CommandInset label
7660 \begin_layout Standard
7666 \begin_layout Subsection
7670 \begin_layout Standard
7671 This section describes how to use LyX to make slides for overhead projectors.
7672 There are two document classes that can do this: the default slides class
7678 This section documents the latter.
7681 \begin_layout Standard
7682 I'm going to say this again, nice and clear, so that there's no misunderstanding
7686 \begin_layout Standard
7687 \begin_inset VSpace bigskip
7693 \begin_layout Standard
7697 This section documents the class
7698 \begin_inset Quotes eld
7706 \begin_inset Quotes erd
7714 \begin_layout Standard
7715 \begin_inset VSpace bigskip
7721 \begin_layout Standard
7722 If you're looking for the documentation for
7723 \begin_inset Quotes eld
7731 \begin_inset Quotes erd
7735 \begin_inset space ~
7739 \begin_inset CommandInset ref
7741 reference "sec:slitex"
7746 If your machine doesn't have the
7751 \begin_inset Quotes eld
7759 \begin_inset Quotes erd
7762 ] installed, you'll probably have to use the default
7766 class, which isn't quite as good as
7771 \begin_layout Standard
7776 class is designed for use with version 2.1 of the
7780 LaTeX class file which is now an integral part of LaTeX2e.
7783 \begin_layout Subsection
7787 \begin_layout Standard
7788 Obviously, to use this document class, you need to select
7789 \begin_inset Quotes eld
7797 \begin_inset Quotes erd
7807 \begin_inset space ~
7813 There are some settings in the
7816 \begin_inset space ~
7821 dialog that you should know about that are specific to this class:
7824 \begin_layout Itemize
7825 Don't change the options
7836 \begin_inset space ~
7842 They're ignored by the
7849 \begin_layout Itemize
7850 The default font size is 20
7851 \begin_inset space \thinspace{}
7854 pt with the other options being 17
7855 \begin_inset space \thinspace{}
7859 \begin_inset space \thinspace{}
7863 \begin_inset space \thinspace{}
7869 \begin_layout Itemize
7878 but all math equations are still typeset in the usual roman font.
7881 \begin_layout Itemize
7886 TeX supports A4 and Letter paper sizes as well as a special size for working
7888 \begin_inset space \thinspace{}
7892 It doesn't support A5, B5, legal or executive paper sizes.
7895 \begin_layout Itemize
7896 Don't bother changing the
7900 settings because they are ignored anyway.
7901 All floats appear where they are defined in the text.
7904 \begin_layout Itemize
7909 setting behaves a bit differently for this class.
7914 TeX provides extensive footer and header capabilities including a user-defined
7917 \begin_inset space ~
7921 \begin_inset CommandInset ref
7923 reference "sec:foilfoot"
7928 The title page is treated differently to all other pages in the document
7937 has the logo centered at the bottom of the page (if one is defined).
7938 The possible page style choices and what they do are as follows:
7942 \begin_layout Labeling
7943 \labelwidthstring MMMMMMM
7950 The final output contains no page numbers, or other headers or footers
7951 (except footnotes of course).
7955 \begin_layout Labeling
7956 \labelwidthstring MMMMMMM
7963 The final output contains page numbers centered at the bottom of the page.
7964 No other headings or footers (other than footnotes).
7967 \begin_layout Labeling
7968 \labelwidthstring MMMMMMM
7973 Page numbers in lower right corner.
7974 Additional headers and footers are also shown.
7975 This is also the default.
7978 \begin_layout Labeling
7979 \labelwidthstring MMMMMMM
7984 Gives you access to the
7988 package although its use with
7992 TeX is discouraged by the writer of the
7996 TeX package because of some potential page layout clashes.
8000 \begin_layout Subsubsection
8004 \begin_layout Standard
8005 The following options may be used in the extra class options in the
8007 Document\SpecialChar \menuseparator
8013 \begin_layout Labeling
8014 \labelwidthstring MMMMMMx
8019 This sets up the page layout for 7.33
8020 \begin_inset space \thinspace{}
8024 \begin_inset space \thinspace{}
8027 in paper, which is about the same aspect ratio as a 35
8028 \begin_inset space \thinspace{}
8031 mm slide, making it a bit easier to work with this medium.
8034 \begin_layout Labeling
8035 \labelwidthstring MMMMMMx
8040 Places a rule across the page below the header on every page except the
8044 \begin_layout Labeling
8045 \labelwidthstring MMMMMMx
8050 Places a rule across the page above the footer on every page except the
8054 \begin_layout Labeling
8055 \labelwidthstring MMMMMMx
8060 This is automatically set each time you create a new
8069 TeX to use the dvips driver to rotate those pages that are set as landscape
8073 \begin_layout Labeling
8074 \labelwidthstring MMMMMMx
8079 Simply changes the page dimensions to those of a landscape page but doesn't
8081 Thus if you use this option you need to use an external program to rotate
8082 each page or feed your paper through your printer as landscape.
8083 Note that this option effectively reverses the roles of the
8091 environments (don't worry these are described in the next section).
8094 \begin_layout Labeling
8095 \labelwidthstring MMMMMMx
8100 Equation numbers on the left.
8103 \begin_layout Labeling
8104 \labelwidthstring MMMMMMx
8109 Flush-left equations.
8112 \begin_layout Subsection
8113 Supported Environments
8116 \begin_layout Standard
8117 Most of the environments commonly supported in other classes are also supported
8123 There are several additional environments provided by
8127 TeX as well as a couple added by LyX.
8128 The following environments are shared with other classes:
8131 \begin_layout Standard
8135 \begin_layout Plain Layout
8147 \begin_layout Itemize
8153 \begin_layout Itemize
8159 \begin_layout Itemize
8165 \begin_layout Itemize
8171 \begin_layout Itemize
8177 \begin_layout Itemize
8183 \begin_layout Itemize
8189 \begin_layout Itemize
8195 \begin_layout Itemize
8201 \begin_layout Itemize
8207 \begin_layout Itemize
8213 \begin_layout Itemize
8219 \begin_layout Itemize
8225 \begin_layout Itemize
8231 \begin_layout Itemize
8237 \begin_layout Itemize
8243 \begin_layout Itemize
8249 \begin_layout Itemize
8255 \begin_layout Standard
8259 \begin_layout Plain Layout
8271 \begin_layout Standard
8272 That is, all the major environments apart from the sectioning environments.
8273 Since foils are essentially self-contained sections, with a title and body,
8278 TeX provides specific commands for starting new foils and these are:
8281 \begin_layout Itemize
8287 \begin_layout Itemize
8293 \begin_layout Standard
8294 LyX also provides slightly modified versions of these two environments called:
8297 \begin_layout Itemize
8303 \begin_layout Itemize
8309 \begin_layout Standard
8310 and the differences will be explained in the next section.
8313 \begin_layout Standard
8314 Since foils are often used in presenting ideas or new theorems and such
8319 TeX also provides a comprehensive box of goodies for presenting them:
8322 \begin_layout Standard
8326 \begin_layout Plain Layout
8338 \begin_layout Itemize
8344 \begin_layout Itemize
8350 \begin_layout Itemize
8356 \begin_layout Itemize
8362 \begin_layout Itemize
8368 \begin_layout Itemize
8374 \begin_layout Itemize
8380 \begin_layout Itemize
8386 \begin_layout Itemize
8392 \begin_layout Itemize
8398 \begin_layout Itemize
8404 \begin_layout Standard
8408 \begin_layout Plain Layout
8420 \begin_layout Standard
8421 The starred versions are unnumbered while the unstarred versions are numbered.
8422 There are also two list environments added by LyX and these are:
8425 \begin_layout Itemize
8431 \begin_layout Itemize
8437 \begin_layout Standard
8442 TeX provides some powerful header and footer capabilities that are best
8443 set in the preamble although they may be set at any point in a document.
8444 If you want to change these settings in your document the best place to
8445 do so is at the very top of a foil, i.
8446 \begin_inset space \thinspace{}
8452 \begin_inset space \space{}
8457 straight after the foilhead.
8460 \begin_layout Standard
8461 For this purpose, the following command styles are provided [
8468 \begin_layout Standard
8472 \begin_layout Plain Layout
8484 \begin_layout Itemize
8488 \begin_inset space ~
8494 \begin_layout Itemize
8500 \begin_layout Itemize
8504 \begin_inset space ~
8510 \begin_layout Itemize
8514 \begin_inset space ~
8520 \begin_layout Itemize
8524 \begin_inset space ~
8531 \begin_layout Standard
8532 \begin_inset space ~
8539 \begin_layout Standard
8543 \begin_layout Plain Layout
8555 \begin_layout Standard
8556 There are also a few commands provided by
8560 TeX that aren't directly supported by LyX but I'll tell you what they do
8561 and how to use them in section
8562 \begin_inset space ~
8566 \begin_inset CommandInset ref
8568 reference "sec:unsuppfoils"
8575 \begin_layout Subsection
8576 Building a Set of Foils
8579 \begin_layout Standard
8580 This section will give a simple introduction to using the different environments
8581 to build a set of foils.
8582 If you want to see an example set of foils, take a look at the
8586 file you find in LyX's
8593 \begin_layout Subsubsection
8594 Give It a Title Page
8597 \begin_layout Standard
8598 Unlike other classes that provide
8618 creates the title on a page of its own.
8619 If you leave out the
8623 environment LaTeX will substitute the current date (every time you regenerate
8627 \begin_layout Subsubsection
8631 \begin_layout Standard
8632 As I mentioned earlier, there are four ways of starting a new foil.
8633 For portrait foils you should use
8642 The difference between these two environments is the amount of space between
8643 the title of the foil (the foilhead) and the body of the foil.
8646 \begin_layout Standard
8647 Landscape foils are generated using the
8656 Again the only difference is the spacing between foilhead and body.
8657 Both of the short versions have 0.5 inches less separation between the foilhead
8662 \begin_layout Standard
8663 One problem with the support for landscape foils is the requirement that
8668 driver to generate the PostScript output otherwise the foils won't be rotated.
8669 It is possible to get landscape foils even if you haven't got the
8673 driver provided you can feed your foils sideways through your printer ;-)
8676 \begin_layout Subsubsection
8677 Theorems, Lemmas, Proofs and more
8680 \begin_layout Standard
8681 Due to a small bug in LyX you can't have two of the same type of these environme
8682 nts directly following each other.
8683 They must be separated by something.
8684 If you try, you will just be extending the previous environment as if you
8685 had merged the two environments together.
8686 So, how do you get around this problem? The simplest option is to insert
8687 some text between the two environments or add a
8691 environment between the two with just a
8692 \begin_inset Quotes eld
8700 \begin_inset Quotes erd
8704 This will force LyX to produce two separate environments and hence the
8705 correct LaTeX output.
8706 An example is provided in the example file included with the LyX distribution.
8707 Remember, this problem only occurs if you are trying to place two of the
8708 same type of theorem-like environments one directly after the other.
8711 \begin_layout Subsubsection
8715 \begin_layout Standard
8716 You get all the commonly supported list styles found in other classes as
8717 well as two new ones.
8718 I'll only describe the new ones here.
8719 If you want to find out more about the other list environments check out
8725 If you intend to use itemized lists you might also want to read about the
8729 \begin_inset space ~
8733 \begin_inset space ~
8738 dialog described above in section
8739 \begin_inset space ~
8743 \begin_inset CommandInset ref
8745 reference "sec:bullet"
8752 \begin_layout Standard
8753 The two new list styles,
8761 , are designed to make it easier for you to create lists of do's and don'ts
8762 or right and wrong by providing dedicated environments that use a tick
8763 or a cross as the label of the list.
8764 These lists are in fact dedicated variants of the
8769 They do however require that you have the
8776 \begin_layout Subsubsection
8780 \begin_layout Standard
8785 TeX redefines the floating tables and figures so that they appear exactly
8786 where they are in the text rather than pushing them to the top of the page
8787 or to some user specified location.
8788 In fact if you change the float placement settings they are simply ignored.
8791 \begin_layout Subsubsection
8792 Page Headers and Footers
8793 \begin_inset CommandInset label
8802 \begin_layout Standard
8806 \begin_inset space ~
8815 are two commands used to control the left-footer text string.
8816 The first is meant to allow you to include a graphic logo on your foils
8818 \begin_inset Quotes eld
8826 \begin_inset Quotes erd
8830 While the second is meant to provide a classification for the audience,
8834 \begin_inset space \thinspace{}
8840 \begin_inset space \space{}
8844 It is empty by default.
8847 \begin_layout Standard
8848 The remaining page corners can be filled by
8851 \begin_inset space ~
8856 (which defaults to page numbers),
8859 \begin_inset space ~
8867 \begin_inset space ~
8875 \begin_layout Subsection
8881 \begin_inset CommandInset label
8883 name "sec:unsuppfoils"
8890 \begin_layout Standard
8891 All the commands mentioned below need to be set in a
8899 within another environment.
8902 \begin_layout Subsubsection
8906 \begin_layout Standard
8907 All lengths are adjusted using the
8930 should be replaced by the name given to the length you want to change and
8935 is the length value.
8936 All lengths should be specified in units of length such as inches (
8948 ) or relative to some document or font-based length such as
8958 \begin_layout Standard
8959 It's possible to change the spacing between a foilhead and the body of the
8960 foil by adjusting the length specified by
8967 For example, to make
8972 \begin_inset space \space{}
8975 in closer to their bodies put the following in the preamble:
8981 foilheadskip}{-0.5in}
8984 \begin_layout Standard
8985 The spacings around floats can be adjusted by setting these lengths:
8988 \begin_layout Labeling
8989 \labelwidthstring MMMMMMMMMMM
8996 Separation between the text and the top of the float
8999 \begin_layout Labeling
9000 \labelwidthstring MMMMMMMMMMM
9007 Separation between the float and the caption
9010 \begin_layout Labeling
9011 \labelwidthstring MMMMMMMMMMM
9018 Separation between the caption and the following text
9021 \begin_layout Labeling
9022 \labelwidthstring MMMMMMMMMMM
9029 You can make the captions narrower than the surrounding text by adjusting
9031 Best done relative to
9040 \begin_layout Standard
9041 There are also several title page related lengths that you may find useful
9042 if you have a long title or several authors:
9045 \begin_layout Labeling
9046 \labelwidthstring MMMMMMMMMMM
9053 Separation from headers to
9058 \begin_layout Labeling
9059 \labelwidthstring MMMMMMMMMMM
9077 \begin_layout Labeling
9078 \labelwidthstring MMMMMMMMMMM
9092 \begin_layout Labeling
9093 \labelwidthstring MMMMMMMMMMM
9109 \begin_layout Labeling
9110 \labelwidthstring MMMMMMMMMMM
9126 \begin_layout Standard
9127 The last length related command affects all the list environments.
9138 a list environment then all the vertical spacing between the list items
9140 Note that this is a command not a length so it doesn't require
9146 like the stuff mentioned above.
9149 \begin_layout Subsubsection
9153 \begin_layout Standard
9166 commands control whether the logo in the
9170 definition appear on a given page.
9177 in the preamble then none of the foils will have the logo on them.
9178 If you don't want the logo on a particular page place the
9184 directly after the foilhead of that page and the
9190 directly after the next foilhead.
9193 \begin_layout Standard
9194 If you decide to use the
9198 page style setting in the
9201 \begin_inset space ~
9206 dialog you should probably add
9216 to your preamble so headers and footers on landscape pages are correctly
9217 placed when rotated.
9218 This is due to some clashes between the page layouts provided by the
9229 \begin_layout Section
9230 Hollywood (Hollywood spec scripts)
9233 \begin_layout Standard
9239 \begin_layout Subsection
9243 \begin_layout Standard
9244 Getting the format of a Hollywood script right is a
9245 \begin_inset Quotes eld
9249 \begin_inset Quotes erd
9252 It is designed to make the readers focus on content and to be easy and
9253 familiar for the actors to read.
9254 Each page of a script should be one minute of film.
9255 Nothing goes in a script that you cannot see or hear on screen.
9256 The courier 12 pt font should be used throughout.
9260 \begin_layout Subsection
9264 \begin_layout Standard
9265 Speakers' lines should NEVER break in mid-sentence.
9266 If a speaker's lines continue over a page break, repeat the
9270 title followed by (Cont'd).
9273 \begin_layout Subsection
9277 \begin_layout Standard
9282 names as labels then cross-reference the label to insert the name.
9283 The cross-reference dialog will show the current cast of characters.
9284 You can use this to insert the speaker name in narratives also.
9287 \begin_layout Subsection
9288 Paper size and Margins
9291 \begin_layout Standard
9292 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9295 \begin_layout Subsection
9299 \begin_layout Standard
9300 The following environments are available.
9301 You can use hollywood.bind to get the bind keys shown at the right.
9304 \begin_layout Itemize
9308 \begin_inset Newline newline
9313 Used where nothing else works.
9317 \begin_layout Itemize
9323 \begin_inset space \hfill{}
9331 \begin_inset Newline newline
9334 Usually followed by something like
9335 \begin_inset Quotes eld
9339 \begin_inset Quotes erd
9345 \begin_layout Itemize
9349 \begin_inset space \hfill{}
9353 \begin_inset Newline newline
9358 Introduces a new INTERIOR camera set-up.
9359 Always followed by DAY or NIGHT, or something similar to define the lighting
9361 Everthing on this line in CAPS.
9364 \begin_layout Itemize
9368 \begin_inset space \hfill{}
9372 \begin_inset Newline newline
9377 Introduces a new EXTERIOR camera set-up.
9378 Everthing on this line in CAPS.
9381 \begin_layout Itemize
9385 \begin_inset space \hfill{}
9389 \begin_inset Newline newline
9394 The character speaking.
9397 \begin_layout Itemize
9401 \begin_inset space \hfill{}
9405 \begin_inset Newline newline
9410 Instructions to the speaker.
9411 The () are automatically inserted, but only the ( will show in LyX.
9412 Both will be printed.
9415 \begin_layout Itemize
9419 \begin_inset space \hfill{}
9423 \begin_inset Newline newline
9435 \begin_layout Itemize
9439 \begin_inset space \hfill{}
9443 \begin_inset Newline newline
9448 Camera movement instruction.
9450 \begin_inset space \thinspace{}
9454 \begin_inset space \space{}
9460 \begin_layout Itemize
9464 \begin_inset space \hfill{}
9470 \begin_layout Itemize
9474 \begin_inset space \hfill{}
9480 \begin_layout Itemize
9484 \begin_inset space \hfill{}
9490 \begin_layout Itemize
9494 \begin_inset space \hfill{}
9500 \begin_layout Subsection
9504 \begin_layout Itemize
9505 (O.S) --- off screen
9508 \begin_layout Itemize
9509 (V.0) --- voice over
9512 \begin_layout Itemize
9514 \begin_inset space \thinspace{}
9521 \begin_layout Itemize
9526 \begin_layout Itemize
9527 PAN --- camera movement
9530 \begin_layout Itemize
9531 INSERT --- cut to close-up of
9534 \begin_layout Section
9538 \begin_layout Standard
9541 Panayotis Papasotiriou
9544 \begin_layout Subsection
9548 \begin_layout Standard
9549 The ijmpc package is a set of macros that facilitates electronic manuscript
9552 International Journal of Modern Physics C
9555 Similarly, the ijmpd package is for creating manuscripts to be submitted
9558 International Journal of Modern Physics D
9561 Both journals are published by World Scientific.
9562 The corresponding document classes are named
9571 These files, together with instructions for the authors, can be downloaded
9573 \begin_inset Flex URL
9576 \begin_layout Plain Layout
9578 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9584 \begin_inset Flex URL
9587 \begin_layout Plain Layout
9589 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9595 Both packages are modified versions of the standard
9596 \begin_inset Quotes eld
9600 \begin_inset Quotes erd
9603 package, and they are almost (but not exactly) identical.
9604 Most of their features are supported by LyX.
9605 I have used LyX successfully to write articles submitted to both journals
9606 without any problem.
9609 \begin_layout Subsection
9613 \begin_layout Standard
9614 As usual, the easiest way to write a paper is to start with a template.
9620 ile\SpecialChar \menuseparator
9639 This will give an (almost) empty document that includes the most common
9640 fields found in a manuscript.
9641 Simply overwrite the existing text (including the brackets,
9646 You should keep in mind the following remarks.
9649 \begin_layout Enumerate
9650 LyX won't let you change the font size and the page style of the document,
9651 because such modifications are not allowed by both packages.
9654 \begin_layout Enumerate
9655 The language of the document should not be changed.
9656 Before previewing your paper, be sure that the babel package is not used.
9657 To do this, click on
9662 ools\SpecialChar \menuseparator
9680 checkbox in the language settings, and click on
9691 , if you wish to make this change permanent).
9694 \begin_layout Enumerate
9696 \begin_inset Quotes eld
9700 \begin_inset Quotes erd
9703 style must be used to define keywords.
9706 \begin_layout Enumerate
9707 The ijmpc package provides a style named
9708 \begin_inset Quotes eld
9711 Classification Codes
9712 \begin_inset Quotes erd
9715 , which can be used to define classification codes, such as PACS numbers.
9716 Note that this facility is not supported by the ijmpd package.
9719 \begin_layout Enumerate
9720 Several new environments are available:
9721 \begin_inset Quotes eld
9725 \begin_inset Quotes erd
9729 \begin_inset Quotes eld
9733 \begin_inset Quotes erd
9737 \begin_inset Quotes eld
9741 \begin_inset Quotes erd
9745 \begin_inset Quotes eld
9749 \begin_inset Quotes erd
9753 \begin_inset Quotes eld
9757 \begin_inset Quotes erd
9761 \begin_inset Quotes eld
9765 \begin_inset Quotes erd
9769 \begin_inset Quotes eld
9773 \begin_inset Quotes erd
9777 \begin_inset Quotes eld
9781 \begin_inset Quotes erd
9785 \begin_inset Quotes eld
9789 \begin_inset Quotes erd
9793 \begin_inset Quotes eld
9797 \begin_inset Quotes erd
9801 \begin_inset Quotes eld
9805 \begin_inset Quotes erd
9809 \begin_inset Quotes eld
9813 \begin_inset Quotes erd
9817 \begin_inset Quotes eld
9821 \begin_inset Quotes erd
9825 \begin_inset Quotes eld
9829 \begin_inset Quotes erd
9833 Their use is more or less obvious.
9834 LyX supports all these environments; it will use the proper label, text
9835 style, and numbering scheme for each of them.
9838 \begin_layout Enumerate
9839 Both packages use basic citations; the natbib package should not be used.
9840 In LyX, citation references are shown as usual; in the output, citations
9841 are shown as superscripts.
9842 If you want to use a citation as normal text, you should use the
9847 \begin_inset space \thinspace{}
9851 \begin_inset space \space{}
9855 \begin_inset Quotes eld
9859 \begin_inset space \space{}
9869 \begin_inset Quotes erd
9875 \begin_layout Enumerate
9877 \begin_inset Quotes eld
9881 \begin_inset Quotes erd
9884 section in both packages.
9885 To put acknowledgments, just use the
9886 \begin_inset Quotes eld
9890 \begin_inset Quotes erd
9896 \begin_layout Enumerate
9897 Appendices may be added to the paper,
9901 the Acknowledgments and
9906 LyX provides a special environment, called
9907 \begin_inset Quotes eld
9911 \begin_inset Quotes erd
9914 which marks the beginning of the appendices.
9915 This environment should be left blank; it just sends a LaTeX command, but
9916 nothing is really printed.
9918 \begin_inset Quotes eld
9922 \begin_inset Quotes erd
9925 is printed with blue letters, as a signal that all sections after that
9926 point are appendices.
9927 To write an appendix, use the
9928 \begin_inset Quotes eld
9932 \begin_inset Quotes erd
9936 LyX will number each appendix with capital letters, as required by both
9939 \begin_inset Quotes eld
9943 \begin_inset Quotes erd
9950 be present before the first appendix; if not, all appendices will be numbered
9951 as normal sections in the output.
9954 \begin_layout Enumerate
9955 The ijmpc and the ijmpd packages use the
9959 command to implement table captions.
9960 As a result, a table created by LyX is printed correctly, but its caption
9962 However, you can use some ERT to overpass this problem, so that captions
9963 are printed as expected.
9964 To do so, create a float table as usual, remove the caption, and replace
9975 (sic); you must also the ERT
9979 immediately after the tabular material.
9980 Study the example table included in the template files to see how this
9981 trick is implemented.
9982 Alternatively, If you need table captions, you should implement the whole
9987 file, then include this file to the LyX document (
9992 nsert\SpecialChar \menuseparator
9997 \SpecialChar \menuseparator
10003 \begin_inset space ~
10009 Details on how to create a table float can be found in the files
10017 , included in the corresponding packages.
10020 \begin_layout Subsection
10021 Preparing a paper for submission
10024 \begin_layout Standard
10025 Before you submit your paper you must export the LyX document as a LaTeX
10031 ile\SpecialChar \menuseparator
10036 xport\SpecialChar \menuseparator
10051 \begin_layout Plain Layout
10052 Actually you have the choice between LaTeX (plain) and pdflatex.
10053 If you intend to use pdflatex to prepare the paper, you should use the
10054 pdflatex option so that included graphics are converted to PDF format,
10055 ready for use by pdflatex.
10060 , then make the following changes to the resulting
10067 \begin_layout Enumerate
10068 Remove the comment lines before the
10077 \begin_layout Enumerate
10078 Remove everything between (and including) the
10090 commands, except for any commands you specifically put into the LaTeX preamble.
10093 \begin_layout Standard
10098 file should be saved and processed through LaTeX as many times as necessary.
10099 You may also want to check the resulting
10106 \begin_layout Subsection
10110 \begin_layout Standard
10111 The use of ERT is reduced to two commands, which must be placed at the top
10113 If you started writing your paper by using the
10121 template, the ERT needed is already in its place; you usually don't need
10123 You may only modify the first ERT to specify the information printed to
10124 the top of odd and even pages (authors' names and short paper's title,
10126 This ERT must have the form
10130 markboth{Authors' Names}{Short Paper's Title}
10135 \begin_layout Section
10139 \begin_layout Standard
10145 \begin_layout Subsection
10149 \begin_layout Standard
10150 The iopart package provides a document class to create electronic manuscript
10151 submission to the journals published by the Institute of Physics.
10152 Instructions for the authors how to create a paper using the iopart class
10153 can be downloaded together with the iopart package from the site
10154 \begin_inset Flex URL
10157 \begin_layout Plain Layout
10159 ftp://ftp.iop.org/pub/journals/latex2e
10167 \begin_layout Subsection
10171 \begin_layout Standard
10172 The easiest way to write a paper is to start with the file
10176 that is available in LyX's examples files folder.
10177 Open this file, save it under a new name, and start writing.
10178 The example file explains how to use the special text environments.
10179 Here are the most important advices:
10182 \begin_layout Itemize
10183 To be able to compile your document to a PDF, PS, or DVI, assure that the
10186 Use AMS math package
10188 in the document settings under
10195 \begin_layout Itemize
10198 The title environment defines the kind of your paper.
10199 So use one of the following environments for the title:
10203 \begin_layout Itemize
10212 \begin_layout Itemize
10221 \begin_layout Itemize
10227 for a Topical review
10230 \begin_layout Itemize
10239 \begin_layout Itemize
10248 \begin_layout Itemize
10254 for a Paper (same as Title)
10257 \begin_layout Itemize
10263 for a Preliminary communication
10266 \begin_layout Itemize
10272 for a Rapid communication
10275 \begin_layout Itemize
10281 for a Letter to the editor
10285 \begin_layout Itemize
10288 All title environments except of
10292 can have an optional short title.
10295 \begin_layout Itemize
10296 There is a general title environment
10300 which is not directly supported by the LyX.
10301 This can be used as ERT when your document doesn't fit into one of the
10305 \begin_layout Standard
10306 For more informations like hints for special table and formula formatting,
10307 look at the IOP author guidelines.
10310 \begin_layout Section
10314 \begin_layout Standard
10317 Panayotis Papasotiriou
10320 \begin_layout Subsection
10324 \begin_layout Standard
10325 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10326 that facilitates electronic manuscript submission to the journals they
10328 Most known of them (at least in my domain of interest) are
10330 Astrophysics and Space Science
10336 , but there are many others (see a complete list at
10337 \begin_inset Flex URL
10340 \begin_layout Plain Layout
10342 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10348 The Kluwer package may be downloaded from the site
10349 \begin_inset Flex URL
10352 \begin_layout Plain Layout
10354 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10360 A complete user guide is contained in that package (but it can also be
10361 downloaded separately).
10364 \begin_layout Standard
10365 LyX supports many features of the package but not everything.
10366 However, the ERT needed is reduced to some
10367 \begin_inset Quotes eld
10371 \begin_inset Quotes erd
10374 commands of the package (see
10375 \begin_inset space ~
10379 \begin_inset CommandInset ref
10381 reference "subsec:kluwer_peculiarities"
10386 I have recently used LyX to write an article submitted to the
10388 Astrophysics and Space Science
10390 without any problem.
10393 \begin_layout Subsection
10397 \begin_layout Standard
10398 The easiest way to write a paper is to start with the Kluwer template file.
10401 File\SpecialChar \menuseparator
10413 This will give an (almost) empty document that includes the most common
10414 fields found in a manuscript and a short description of their use.
10415 As in most templates, simply overwrite the existing text (including the
10420 ) with the correct information.
10423 \begin_layout Subsection
10424 Preparing a paper for submission
10427 \begin_layout Standard
10428 As in the AASTeX package, before you submit your paper to a journal you
10430 \begin_inset Quotes eld
10434 \begin_inset Quotes erd
10440 \begin_layout Enumerate
10441 Export your paper as a LaTeX file.
10442 To do this, click on
10444 File\SpecialChar \menuseparator
10445 Export\SpecialChar \menuseparator
10452 \begin_layout Enumerate
10457 file with a text editor and make the following changes
10461 \begin_layout Enumerate
10462 remove the comment lines before the
10471 \begin_layout Enumerate
10472 remove everything between (and including) the
10484 commands, except for any commands you specifically put into the LaTeX preamble.
10487 \begin_layout Standard
10496 \begin_layout Enumerate
10501 file through LaTeX as many times as necessary (usually up to three).
10504 \begin_layout Enumerate
10510 \begin_inset space \thinspace{}
10514 \begin_inset space \space{}
10521 , and check if everything is OK (it should, if you didn't make any mistake).
10524 \begin_layout Subsection
10525 \begin_inset Quotes eld
10529 \begin_inset Quotes erd
10532 of the Kluwer package
10533 \begin_inset CommandInset label
10535 name "subsec:kluwer_peculiarities"
10542 \begin_layout Standard
10543 The Kluwer package has the following
10544 \begin_inset Quotes eld
10548 \begin_inset Quotes erd
10554 \begin_layout Enumerate
10555 It is possible to write multiple articles in the same LaTeX file
10559 \begin_layout Plain Layout
10560 I can't imagine any good reason to do this.
10566 Each article must be included in the environment
10567 \begin_inset Quotes eld
10571 \begin_inset Quotes erd
10575 Unfortunately, this environment cannot be omitted, even if you write just
10577 Therefore, each article starts with the command
10583 and, obviously, ends with the command
10590 Although this can be implemented in LyX, I didn't included it, since it
10591 looks ugly and can confuse the novice user.
10592 Therefore, you need to enter them directly and mark them as LaTeX code
10594 \begin_inset Quotes eld
10598 \begin_inset Quotes erd
10604 \begin_layout Enumerate
10605 Information given at the beginning of the article (i.
10606 \begin_inset space \thinspace{}
10610 \begin_inset space \space{}
10613 title, subtitle, author, institution, running title, running author, abstract
10614 and keywords) must be included in an environment called
10615 \begin_inset Quotes eld
10619 \begin_inset Quotes erd
10623 This is not implemented in LyX, so you must enter title, subtitle etc.
10624 \begin_inset space ~
10627 between two ERT lines (
10642 \begin_layout Enumerate
10643 According to the user manual, the label of each bibliography item must be
10667 \begin_layout Standard
10672 template takes care of all these
10673 \begin_inset Quotes eld
10677 \begin_inset Quotes erd
10681 If you start a new paper using this template you don't need to do anything
10686 \begin_layout Enumerate
10687 don't delete the ERT included in the template, and
10690 \begin_layout Enumerate
10691 copy the example bibliography item included in the template and modify it
10692 as necessary to enter new bibliography items.
10695 \begin_layout Section
10699 \begin_layout Standard
10705 \begin_layout Subsection
10709 \begin_layout Standard
10710 The LyX document classes
10712 article (koma-script)
10716 report (koma-script)
10734 correspond to the LaTeX document classes
10751 \begin_inset space ~
10754 of the Koma-Script family.
10755 They are replacements for the standard document classes
10771 , resp., and fit better to European typography conventions in a number of
10775 \begin_layout Itemize
10776 Standard character size is 11pt in
10778 article (koma-script)
10782 report (koma-script)
10790 letter (koma-script)
10795 \begin_layout Itemize
10796 Headings, labels of the description environment, and a number of elements
10799 letter (koma-script)
10801 document class are set in a bold sans serif font.
10805 \begin_layout Plain Layout
10806 There is a big difference between the bold sans serif old cm fonts and new
10807 ec fonts, especially in the appearance of headings.
10808 In comparison, the ec bold sans serif fonts look a bit thin.
10809 Here the LaTeX package
10817 helps to produce the
10818 \begin_inset Quotes eld
10822 \begin_inset Quotes erd
10825 appearance when using the ec fonts.
10830 The numbering of chapter headings is made in the same way as the numbering
10831 of section headings, that is without the extra line
10832 \begin_inset Quotes eld
10835 Chapter\SpecialChar \ldots{}
10837 \begin_inset Quotes erd
10841 In addition, the appearance of the headings can be modified by using a
10842 number of options (in LyX to be entered in the field
10849 \begin_inset space ~
10856 Layout\SpecialChar \menuseparator
10860 A detailed German description of these options can be found in the Koma-Script
10868 \begin_layout Itemize
10869 The main means in the Koma-Script document classes to design the type area
10878 (in LyX to be entered in the extra class options field in the dialog
10880 Document\SpecialChar \menuseparator
10884 They make a clearer modification of page margins possible as do the options
10887 Document\SpecialChar \menuseparator
10891 A detailed German description of these and other type area options can
10892 be found in the Koma-Script documentation
10899 \begin_layout Itemize
10900 The LaTeX document classes of the Koma-Script family define a number of
10901 additional commands.
10902 Those part of it which makes sense in LyX is implemented in corresponding
10906 \begin_layout Standard
10907 A detailed German description of the LaTeX document classes of the Koma-Script
10908 family can be found in the Koma-Script documentation
10916 \begin_layout Plain Layout
10917 There is an English translation
10921 , but it is not a complete one.
10926 The following sections describe only those aspects, which are relevant
10930 \begin_layout Subsection
10931 article (koma-script), report (koma-script), and book (koma-script)
10934 \begin_layout Standard
10935 The document classes
10937 article (koma-script)
10941 report (koma-script)
10951 are implemented in the layout files
10964 They contain all the paragraph types of the corresponding standard document
10977 , resp., partly modified, with the exception of the LyX specific
10981 -type, which is replaced by the new
10985 -type having the same functionality.
10990 -Type there is a number of new paragraph types added.
10997 letter (koma-script)
11002 \begin_layout Itemize
11011 : are equivalents to
11019 , resp., additionally inserting an entry in the table of contents.
11028 are not contained in
11030 article (koma-script)
11035 \begin_layout Itemize
11044 : behave exactly as
11052 , resp., additionally clearing running heads.
11057 is not contained in
11059 article (koma-script)
11065 \begin_layout Plain Layout
11078 report (koma-script)
11080 , but since this is identical to
11084 , is has not been implemented in LyX.
11092 \begin_layout Itemize
11097 : generates a heading directly above the following paragraph in the standard
11098 character size without affecting the structure of the document.
11101 \begin_layout Itemize
11110 are special captions which respect the different space settings needed
11111 for captions placed above or below an element (if you follow strict typographic
11112 rules, you might want to place table captions always above the table).
11113 You can also use the class option
11117 , which will switch
11130 You need at least Koma-Script version 2.8q to use this.
11133 \begin_layout Itemize
11138 : can be used to set a bonmot, e.
11139 \begin_inset space \thinspace{}
11143 \begin_inset space \space{}
11146 at the beginning of a chapter.
11147 If you use the optional argument (
11149 Insert\SpecialChar \menuseparator
11151 \begin_inset space ~
11156 ), you can insert the dictum's author there.
11157 Dictum and author are separated by a line.
11158 You need at least Koma-Script version 2.8q to use this.
11163 is not contained in
11165 article (koma-script)
11170 \begin_layout Standard
11171 The following types, together with the standard types
11183 , form the title area of the document.
11184 They must be entered ahead of the first
11185 \begin_inset Quotes eld
11189 \begin_inset Quotes erd
11196 \begin_layout Plain Layout
11197 The corresponding LaTeX commands must appear before the
11208 When such a type is used more than once, the latter usage overwrites the
11209 former one, that means, for every type only the latest usage is valid.
11210 The order of the different types however has, like
11222 , no effect on the appearance of the produced document.
11225 \begin_layout Itemize
11230 : produces a centered paragraph above the ordinary title (
11242 ) for the subject of the document.
11245 \begin_layout Itemize
11250 : produces a centered paragraph below the ordinary title (
11262 ) for the publishers' name.
11265 \begin_layout Itemize
11272 report (koma-script)
11278 produces a centered paragraph on its own page behind the title page, or
11281 article (koma-script)
11283 produces a centered paragraph below the ordinary title (
11299 ) for a dedication.
11302 \begin_layout Itemize
11307 : produces a left aligned paragraph above the ordinary title (
11323 ) for a document`s head.
11326 \begin_layout Itemize
11331 : produces in a double-sided print in
11333 report (koma-script)
11339 a left-aligned paragraph at the top of the title page`s back or has no
11340 effect in a single-sided print or in
11342 article (koma-script)
11347 \begin_layout Itemize
11352 : produces in a double-sided print in
11354 report (koma-script)
11360 a left-aligned paragraph at the bottom of the title page`s back or has
11361 no effect in a single-sided print or in
11363 article (koma-script)
11368 \begin_layout Itemize
11373 : produces a special
11374 \begin_inset Quotes eld
11378 \begin_inset Quotes erd
11381 page ahead of the actual document containing a paragraph without special
11385 \begin_layout Standard
11386 The layout files for the document classes
11388 article (koma-script)
11392 report (koma-script)
11398 do include the file
11403 This is thought of as a place to define your own types.
11408 in your personal layout directory and edit the file!
11411 \begin_layout Subsection
11412 letter (koma-script)
11415 \begin_layout Standard
11419 \begin_layout Plain Layout
11431 \begin_layout Standard
11435 letter (koma-script)
11437 is implemented in the layout file
11442 It contains all the paragraph types of the corresponding standard document
11447 , partly modified, with the exception of the LyX specific types
11459 type, which is replaced by the new
11464 In addition, it contains, in contrast to the standard document class, the
11482 Furthermore, there are a number of new letter specific types.
11485 \begin_layout Standard
11489 \begin_layout Plain Layout
11501 \begin_layout Standard
11502 The appearance of the letter produced by this document class can be controlled
11503 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11507 \begin_layout Plain Layout
11508 For example, the standard appearance of the letter`s heading, consisting
11509 of name and address, is quite self-willed.
11511 \begin_inset Quotes eld
11515 \begin_inset Quotes erd
11518 heading is produced by the following LaTeX commands in the preamble:
11521 \begin_layout LyX-Code
11531 \begin_layout LyX-Code
11547 \begin_layout LyX-Code
11557 \begin_layout LyX-Code
11577 A detailed German description of such LaTeX commands can be found in the
11578 Koma-Script documentation
11583 With it, the letter's author can produce his personal letter layout.
11586 \begin_layout Standard
11595 define the beginning of the letter and must be used in every letter.
11596 To emphasize them in the LyX document class, they are marked with the letter
11606 \begin_inset space ~
11609 in the left margin.
11610 It is possible to write any number of letters in one file.
11615 type produces a new letter using the same addressee and a
11619 type produces a new addressee.
11636 are ordinary paragraph types and can also be used several times in one
11637 and the same letter.
11640 \begin_layout Itemize
11645 : produces a paragraph for the addressee and implicitly defines the beginning
11649 \begin_layout Itemize
11654 : produces a paragraph for the form of address and implicitly produces a
11658 \begin_layout Itemize
11663 : produces a paragraph for a close.
11666 \begin_layout Itemize
11671 : produces a paragraph for a postscript.
11674 \begin_layout Itemize
11679 : produces a paragraph for a distribution list.
11682 \begin_layout Itemize
11687 : produces a paragraph for enclosures.
11690 \begin_layout Standard
11731 are input types provided with a label to enter information, which will
11732 be processed by the document class.
11736 \begin_layout Plain Layout
11737 It could be seen as a matter of inconsequence, that the types
11745 described above are not such input types as well.
11746 Because of the special meaning of those types, however, I have implemented
11747 them as ordinary paragraph types with a one letter mark in the left margin.
11748 Moreover, it would affect my feeling of symmetry, if the
11756 type had such a serious different appearance.
11761 The types must be used ahead of the corresponding
11768 \begin_layout Standard
11769 An implementation of these types in a WYSIWYG fashion does not seem to make
11770 sense, because the real appearance of the produced letter does not only
11771 depend on the usage of the particular type, but also on other factors.
11772 For example, a signature entered in the
11776 type will in the standard behavior appear in the produced letter only,
11777 when in the same letter also a
11782 The entered value of the
11786 type will in the standard behavior not appear in the produced letter at
11788 The possibility to design the letter`s heading freely is already indicated
11789 in a footnote above.
11792 \begin_layout Standard
11793 The input types can also be used as empty paragraphs.
11794 This makes sense e.
11795 \begin_inset space \thinspace{}
11799 \begin_inset space \space{}
11811 type is not used at all, in the standard behavior the value of the
11815 type is used as signature, whereas if an empty
11819 type is used, no signature value is defined.
11822 \begin_layout Standard
11823 By using the input types it is possible to write a letter template, containing
11824 filled input types with your personal dates (name, address, etc.) and empty
11825 input types for other dates you want to enter.
11828 \begin_layout Itemize
11833 : sender's name, in the standard behavior appears as a centered paragraph
11834 in small caps in the letter`s heading.
11837 \begin_layout Itemize
11842 : sender's signature, in the standard behavior appears below the
11851 type is used, the value of the
11855 type appears instead.
11858 \begin_layout Itemize
11863 : sender's address, in the standard behavior appears in a centered paragraph
11864 in the letter`s heading below the sender's name.
11867 \begin_layout Itemize
11872 : sender's telephone number, in the standard behavior only sets the LaTeX
11882 \begin_layout Itemize
11887 : place of the letter`s making.
11890 \begin_layout Itemize
11895 : date of the letter`s making.
11904 , in the standard behavior, produce the place and the date in a right-aligned
11905 line below the addressee's field.
11910 type is used, neither place nor date appear, independent of the value of
11920 type is used, the date of the letter `s production is used.
11923 \begin_layout Itemize
11928 : sender`s back address, in the standard behavior appears above the addressee's
11929 field in a small sans serif font.
11932 \begin_layout Itemize
11937 : special mail information, in the standard behavior appears underlined
11938 above the addressee's field below the back address.
11941 \begin_layout Itemize
11946 : additional information, in the standard behavior appears on right side
11947 below the addressee`s field.
11950 \begin_layout Itemize
11955 : the letter's title, in the standard behavior appears in a big, bold, sans
11956 serif font above the subject.
11959 \begin_layout Itemize
11964 : the letter's subject, in the standard behavior appears in a bold font
11972 \begin_layout Standard
11993 produce a business letter like line above the
11997 line containing the fields
11998 \begin_inset Quotes eld
12002 \begin_inset Quotes erd
12006 \begin_inset Quotes eld
12010 \begin_inset Quotes erd
12014 \begin_inset Quotes eld
12018 \begin_inset Quotes erd
12022 \begin_inset Quotes eld
12026 \begin_inset Quotes erd
12030 \begin_inset Quotes eld
12034 \begin_inset Quotes erd
12038 \begin_inset Quotes eld
12042 \begin_inset Quotes erd
12046 For the date field, the value of the
12052 \begin_inset Quotes eld
12055 business letter types
12056 \begin_inset Quotes erd
12059 is used, the value of the
12063 type however does not appear, but only the LaTeX variable
12070 The ordinary output of place and date in a right-aligned line below the
12071 addressee`s field is suppressed.
12072 The types are implemented as input types provided with a label and must
12073 be used ahead of the corresponding
12080 \begin_layout Itemize
12088 \begin_layout Itemize
12096 \begin_layout Itemize
12104 \begin_layout Itemize
12112 \begin_layout Itemize
12120 \begin_layout Subsection
12121 The new letter class: letter (koma-script v.2)
12124 \begin_layout Standard
12127 Jürgen Spitzmüller
12130 \begin_layout Standard
12131 \begin_inset VSpace medskip
12137 \begin_layout Standard
12139 Koma-Script version 2.8 has introduced a new letter class
12143 which supersedes the now unsupported
12148 It has --- on the LaTeX side --- a completely new interface and is not
12149 compatible with the old class.
12150 Therefore, LyX supports both, though it is recommended to use the new class.
12153 \begin_layout Standard
12154 This class covers the same functionality as
12156 letter (koma-script),
12159 The basic items are
12163 (receiver's address, same as
12167 in the old layout),
12180 will start a new letter (i.
12181 \begin_inset space \thinspace{}
12185 \begin_inset space \space{}
12188 you can write several letters per document).
12189 New elements are sender's
12205 and the possibility to use a
12211 Insert\SpecialChar \menuseparator
12217 \begin_layout Standard
12218 The biggest improvement is, though, that the letter's layout is configurable
12219 at almost any needs.
12220 This can be done via the preamble or with a special style file (Letter
12221 Class Option, extension
12225 ), that will be read in as a class option.
12229 \begin_layout Plain Layout
12230 The KOMA package comes with some default
12235 There is, for instance, a
12239 file that follows german typesetting rules, or a
12243 that provides the default layout of the old
12248 The latter can be loaded with the class option
12257 ayout\SpecialChar \menuseparator
12262 ocument\SpecialChar \menuseparator
12274 template that is included in LyX for examples.
12275 A detailed description is to be found in the Koma-Script documentation
12283 \begin_layout Subsection
12287 \begin_layout Standard
12288 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12292 \begin_layout Itemize
12293 The chapter number of a
12297 type appears on a line of its own above the chapter heading instead of
12298 appearing in the same line ahead of it.
12299 The cause for that is the LyX internal behavior for the labeltype
12303 in the layout file.
12306 \begin_layout Itemize
12307 The headings of the types
12315 are only put in the
12316 \begin_inset Quotes eld
12320 \begin_inset Quotes erd
12323 LaTeX table of contents, but not in the LyX table of contents (
12325 Document\SpecialChar \menuseparator
12327 \begin_inset space ~
12331 \begin_inset space ~
12339 \begin_layout Itemize
12340 The paragraphs in a
12344 document class appear in a skip separation mode, not indented.
12345 This is the standard behavior, no special LaTeX commands are needed for
12349 Document\SpecialChar \menuseparator
12352 dialog the corresponding radio button indicates
12361 value always has the effect that extra LaTeX commands are inserted in the
12362 document to produce the gap, which is not what is wanted in this case.
12365 \begin_layout Section
12366 Latex8 (IEEE Conference Papers)
12369 \begin_layout Standard
12375 \begin_layout Subsection
12379 \begin_layout Standard
12380 Since this class is specifically for writing submissions to IEEE sponsored
12381 conferences I strongly recommend that you get a copy of their Authors Kit.
12386 package and associated bibliography style file is included in the kit.
12387 The Authors Kit is usually sent out by email once your initial submission
12389 There is a lot of useful information in the Authors Kit explaining formatting
12390 restrictions and so on and I will assume you have read this since that
12391 means I don't have to repeat it all here.
12394 \begin_layout Subsection
12398 \begin_layout Standard
12399 [AR\SpecialChar \@.
12403 \begin_layout Subsection
12404 Supported Environments
12407 \begin_layout Itemize
12413 \begin_layout Itemize
12419 \begin_layout Itemize
12425 \begin_layout Itemize
12431 \begin_layout Itemize
12437 \begin_layout Itemize
12443 \begin_layout Itemize
12449 \begin_layout Itemize
12455 \begin_layout Itemize
12461 \begin_layout Subsection
12462 Differences Between Screen and Paper
12465 \begin_layout Standard
12466 There are slight differences in appearance mainly with the presentation
12467 of section counters.
12468 On screen the trailing period of the section counter is missing but it
12469 will appear in the output so don't let this worry you.
12472 \begin_layout Section
12476 \begin_layout Standard
12479 Jürgen Spitzmüller
12482 \begin_layout Subsection
12486 \begin_layout Standard
12487 Memoir is a very powerful and constantly evolving class.
12488 It has been designed with regard to fictional and non-fictional literature.
12489 Its aim is to let the user have maximum control over the typesetting of
12491 Memoir is based on the standard book class, but it can also emulate the
12492 article class (see below).
12495 \begin_layout Standard
12496 Peter Wilson, the developer of Memoir, is known as the author of lots of
12497 useful packages in the LaTeX world.
12498 Most of them have been merged with Memoir.
12499 Therefore, it is much easier to layout the table of contents, appendices,
12500 chapter designs and such.
12501 LyX, though, does not support all of these goodies natively.
12502 Some of them might be added to forthcoming releases
12506 \begin_layout Plain Layout
12507 You are invited to send suggestions to
12508 \begin_inset Flex URL
12511 \begin_layout Plain Layout
12513 lyx-devel@lists.lyx.org
12523 , lots will probably never, due to the limitations of LyX's framework.
12524 Of course you can still use all features with the help of some native LaTeX
12529 \begin_layout Plain Layout
12534 \begin_layout Plain Layout
12544 \begin_inset space ~
12548 \begin_inset CommandInset ref
12550 reference "sec:Inserting-TeX-Code"
12560 In this section, we can only list those features which are natively supported
12562 For detailed descriptions (and for the rest of features) we are recommending
12563 to have a look at the detailed manual of the Memoir class
12567 \begin_layout Plain Layout
12572 \begin_layout Plain Layout
12582 \begin_inset Flex URL
12585 \begin_layout Plain Layout
12587 CTAN:/macros/latex/memoir/memman.pdf
12597 , which is not only a user guide for the class, but also both a comprehensive
12598 description on good typesetting and a superb example for good typesetting
12602 \begin_layout Subsection
12603 Basic features and restrictions
12606 \begin_layout Standard
12607 Memoir supports basically all features of the standard book classes.
12608 There are, however, some differences, as follows:
12611 \begin_layout Description
12613 \begin_inset space ~
12616 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12619 \begin_layout Description
12621 \begin_inset space ~
12624 style: The fancy page style is not supported, due to a command clash between
12625 Memoir and the fancyhdr package (they are both defining a command with
12626 the same name, which confuses LaTeX).
12627 Instead, Memoir comes with a bunch of own page styles (see
12629 Layout\SpecialChar \menuseparator
12630 Document\SpecialChar \menuseparator
12632 \begin_inset space ~
12638 If you want to use these for the chapter pages, you have to use the command
12645 in the main text or in preamble (e.
12646 \begin_inset space \thinspace{}
12650 \begin_inset space \space{}
12657 chapterstyle{companion}
12662 \begin_layout Description
12663 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12664 an optional argument in the standard classes.
12665 With this, you can specify an alternative version of the title for the
12666 table of contents and the headers (for instance, if the title is too long).
12667 In LyX, you can do this via
12669 Insert\SpecialChar \menuseparator
12671 \begin_inset space ~
12676 at the beginning of a chapter/section.
12677 Memoir features a second optional argument and thus separates the table
12678 of contents from the header.
12679 You can define three variants of a title with this: one for the main text,
12680 one for the table of contents, and one for the headers.
12681 Simply insert two optional arguments if you need this feature, the first
12682 one containing the short title for the Table of Contents, the second one
12683 containing an alternative short title for the headers.
12686 \begin_layout Description
12687 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12688 of contents, the list of figures and the list of table start a new page
12690 Memoir does not follow this route.
12691 You have to insert a page break yourself, if you want to have one.
12694 \begin_layout Description
12695 Titlepage: For some unknown reason, Memoir uses pagination on the title
12696 page (in the standard classes, title pages are
12697 \begin_inset Quotes eld
12701 \begin_inset Quotes erd
12705 \begin_inset space \thinspace{}
12709 \begin_inset space \space{}
12713 If you want an empty title page, type
12717 aliaspagestyle{title}{empty}
12722 \begin_layout Description
12723 Article: With the class option
12729 Layout\SpecialChar \menuseparator
12730 Document\SpecialChar \menuseparator
12732 \begin_inset space ~
12737 ), you can emulate article style.
12738 That is, counters (footnotes, figures, tables etc.) will not be reset on
12739 new chapters, chapters don't start a new page (but are---in contrary to
12741 \begin_inset Quotes eld
12745 \begin_inset Quotes erd
12748 article classes---still allowed), parts, though, use their own page, as
12752 \begin_layout Description
12753 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12754 font commands, which have been used in the old LaTeX version 2.09 (e.
12755 \begin_inset space \thinspace{}
12759 \begin_inset space \space{}
12775 It produces an error and stops LaTeX whenever such a command appears.
12780 reallows the commands and spits out warnings instead (which does at least
12782 Since a lot of packages and particularly BibTeX style files are still using
12783 those commands, we have decided to use this option by default.
12786 \begin_layout Subsection
12790 \begin_layout Standard
12791 We will only describe the features supported by LyX (which is not much currently
12793 Please consult the Memoir manual
12797 \begin_layout Plain Layout
12802 \begin_layout Plain Layout
12812 \begin_inset Flex URL
12815 \begin_layout Plain Layout
12817 CTAN:/macros/latex/memoir/memman.pdf
12830 \begin_layout Description
12831 Abstract: You may wonder why an abstract is an extra feature.
12832 Well, it is in book class.
12833 Usually books don't have abstracts.
12834 Memoir, however, has.
12835 You can use it wherever and how often you like.
12838 \begin_layout Description
12839 Chapterprecis: You may know this from belletristic: The contents of a chapter
12840 is shortly described below the title and also in the table of contents
12842 \begin_inset space \thinspace{}
12846 \begin_inset space \space{}
12851 Our hero arrives in Troia; he loses some friends; he finds others
12854 Chapterprecis does exactly this.
12855 It is therefore only sensible below a chapter.
12858 \begin_layout Description
12859 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12860 The epigraph environment provides an elegant way of typesetting such a
12862 The motto itself (text) and its author (source) are divided by a short
12864 Unfortunately, we have to fool LyX a bit here again, since the environment
12865 needs two arguments (text and source).
12866 In this case, we have to use curly brackets (in TeX mode) between the two
12877 <author of the slogan>.
12880 \begin_layout Description
12881 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12882 complex figurative poems).
12883 LyX can only support a few of them.
12884 One is poemtitle, which is a centered title for poems, which will also
12885 be added to the table of contents (verse is the standard environment for
12887 Memoir has some enhanced versions of verse, but you need to use ERT, because
12888 they have to be nested inside regular verse environments, which is not
12889 possible with LyX).
12892 \begin_layout Description
12893 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12896 \begin_layout Section
12897 Article (mwart), book (mwbk) and report (mwrep)
12898 \begin_inset OptArg
12901 \begin_layout Plain Layout
12914 \begin_layout Standard
12920 \begin_layout Standard
12921 The LyX document classes
12937 correspond to the LaTeX document classes
12950 They are replacements for the standard document classes
12962 , resp., and fit better to Polish typography conventions in a number of points.
12966 \begin_layout Standard
12970 \begin_layout Itemize
12971 Unnumbered titles (with star, e.
12972 \begin_inset space \thinspace{}
12976 \begin_inset space \space{}
12983 ) are added into table of contents,
12986 \begin_layout Itemize
12987 Additional page styles:
12991 \begin_layout Description
12992 uheadings header with separated lines,
12995 \begin_layout Description
12996 myheadings custom header, contents headers via commands:
13011 \begin_layout Description
13012 myuheadings custom header with separated lines,
13015 \begin_layout Description
13016 outer page number is placed on outer side of page
13020 \begin_layout Itemize
13025 \begin_layout Description
13026 rmheadings serif titles --- default,
13029 \begin_layout Description
13030 sfheadings sansserif titles,
13033 \begin_layout Description
13034 authortitle on title page first placed is author next title --- default,
13037 \begin_layout Description
13038 titleauthor on title page first placed is title next author,
13041 \begin_layout Description
13042 withmarginpar reserve place on page for margins.
13046 \begin_layout Section
13050 \begin_layout Standard
13055 provides an alternative to the standard
13060 It provides similar functionality, but you might prefer this layout with
13061 sans serif sections, headings, and more.
13064 \begin_layout Section
13068 \begin_layout Standard
13074 \begin_layout Standard
13075 \begin_inset VSpace bigskip
13081 \begin_layout Standard
13086 \begin_inset space ~
13091 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13092 \begin_inset Formula $\beta$
13095 release of May, 1999) class.
13098 \begin_layout Standard
13103 textclass, which works with RevTeX 3.1.
13104 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13105 That means that it doesn't interact very well with LyX, which requires
13106 LaTeX2e, although it has been kludged to work.
13107 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13111 \begin_inset space ~
13116 textclass should also be pretty easy to use.
13119 \begin_layout Standard
13120 These documents are supposed to be used in
13124 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13125 macros, and assume you'll know what to put in the preamble if necessary.
13128 \begin_layout Subsection
13132 \begin_layout Standard
13133 All you need to do is install RevTeX 4, as described in the package's README
13135 The package can be found at The RevTeX 4 Web Site
13136 \begin_inset Flex URL
13139 \begin_layout Plain Layout
13141 http://publish.aps.org/revtex4/
13147 Install it somewhere that LaTeX can see it.
13148 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13150 \begin_inset space \thinspace{}
13154 \begin_inset space \space{}
13157 not the directory where you installed the class file.) Then, if you reconfigure
13158 LyX, it will find the class file and let you use the RevTeX4 textclass.
13161 \begin_layout Standard
13162 Probably the easiest way to get started is either to import a RevTeX 4 document
13170 \begin_inset space ~
13175 template, found in the templates directory.
13178 \begin_layout Subsection
13182 \begin_layout Standard
13183 Optional arguments to
13190 \begin_inset Quotes eld
13194 \begin_inset Quotes erd
13198 \begin_inset Quotes eld
13202 \begin_inset Quotes erd
13212 \begin_inset space ~
13220 \begin_inset space ~
13226 Remember that in RevTeX, at least one optional argument is required!
13229 \begin_layout Standard
13230 Other preamble matter, like
13237 \begin_inset space ~
13247 \begin_inset space ~
13252 dialog, also as usual.
13255 \begin_layout Subsection
13259 \begin_layout Standard
13260 The layouts basically correspond to the commands in RevTeX4.0.
13261 For example, the Email layout corresponds to
13268 Note that (at least as of RevTeX 4.0 Beta), the
13276 layouts are exactly equivalent, so you shouldn't need to use both.
13280 \begin_layout Plain Layout
13281 In case you're curious, both were included so that
13285 would be able to translate both
13305 \begin_layout Subsection
13309 \begin_layout Standard
13310 There are a couple of important unique aspects of RevTeX 4 which might cause
13311 bugs that will be even more confusing in LyX.
13314 \begin_layout Standard
13332 The LyX equivalent is that there is a separate Thanks layout.
13337 write footnotes in the
13341 layout, or weird things may happen.
13342 See the RevTeX 4 documentation for more details.
13345 \begin_layout Standard
13349 \begin_inset space ~
13357 \begin_inset space ~
13366 layouts must be placed
13374 layout and the corresponding
13391 , the LaTeX won't compile.
13394 \begin_layout Subsection
13398 \begin_layout Standard
13399 The main problem with this layout is that you can't use the optional arguments
13400 to layouts like Email and Title.
13401 (The problem is not unique to this layout; you can't use optional arguments
13402 to the Section layouts either.) This means that after you export that file
13403 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13404 need to edit the LaTeX file with a text editor to add the optional arguments
13406 \begin_inset space \thinspace{}
13410 \begin_inset space \space{}
13413 the running title for the page headers.
13414 Lacking these layouts makes the
13420 (and the equivalent
13426 ) useless, so the corresponding layouts don't exist, and will have to be
13431 \begin_layout Plain Layout
13436 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13437 has not been updated yet to take advantage of it.
13445 \begin_layout Section
13446 Springer Journals (
13453 \begin_layout Standard
13459 \begin_layout Subsection
13463 \begin_layout Standard
13464 These are the layout files for some of the journal formats used by Springer
13465 Verlag and listed on
13466 \begin_inset Flex URL
13469 \begin_layout Plain Layout
13471 http://www.springer.de/author/tex/help-journals.html
13476 , where you should also go to fetch the class files (yes, these are LaTeX2e
13478 It is a modular system: the things common to all journals are implemented
13483 , which journal-specific layout files (such as, e.
13484 \begin_inset space \thinspace{}
13488 \begin_inset space \space{}
13495 for Journal of Geodesy) can include.
13498 \begin_layout Standard
13499 This means that implementing support for any other Springer journal on this
13500 list is as simple as writing your own
13508 file following the outline given in
13516 \begin_layout Standard
13517 It is reasonably well tested only for the Journal of Geodesy.
13526 come with the standard LyX distribution.
13527 Install the relevant class file (downloaded from Springer) in a proper
13528 directory, reconfigure LaTeX (in the teTeX case by running
13532 , as root if necessary --- doesn't LyX take care of this?), reconfigure
13533 LyX and it should work.
13536 \begin_layout Subsection
13540 \begin_layout Standard
13541 A large number of theorem-like styles ---
13547 \SpecialChar \ldots{}
13553 \begin_layout Standard
13556 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13557 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13560 See the Springer class file documentation for details.
13563 \begin_layout Subsection
13567 \begin_layout Itemize
13579 \begin_layout Itemize
13582 Probability Theory and Related Fields
13588 --- Jean-Marc Lasgouttes
13591 \begin_layout Standard
13592 Add your own, it isn't so hard!
13595 \begin_layout Subsection
13599 \begin_layout Standard
13600 These files are partly based on the older
13604 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13605 file from Springer.
13610 layout, are now defunct.
13611 Jean-Marc Lasgouttes helped out big in making me find my way around the
13612 LyX layout file mechanism.
13615 \begin_layout Subsection
13619 \begin_layout Standard
13621 But probably less than in the old hacked-LaTeX
13628 \begin_layout Standard
13630 \begin_inset space \thinspace{}
13633 g.: does not display the number for theorem-like layouts, just #.
13636 \begin_layout Section
13642 \begin_inset CommandInset label
13651 \begin_layout Standard
13659 \begin_layout Subsection
13663 \begin_layout Standard
13664 This section describes how to use LyX to make slides for overhead projectors.
13665 There are two document classes that can do this: the default slides class
13671 This section documents the former.
13674 \begin_layout Standard
13675 I'm going to say this again, nice and clear, so that there's no misunderstanding
13679 \begin_layout Standard
13680 \begin_inset VSpace bigskip
13686 \begin_layout Standard
13690 This section documents the class
13691 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13707 \begin_layout Standard
13708 \begin_inset VSpace bigskip
13714 \begin_layout Standard
13715 If you're looking for the documentation for
13716 \begin_inset Quotes eld
13724 \begin_inset Quotes erd
13727 , check out section
13728 \begin_inset space ~
13732 \begin_inset CommandInset ref
13734 reference "sec:foiltex"
13744 \begin_inset Quotes eld
13752 \begin_inset Quotes erd
13755 ] is actually somewhat better than the default
13763 \begin_layout Plain Layout
13764 \SpecialChar \ldots{}
13765 or so I've been told repeatedly by its advocates.
13766 Having never used it, I have no idea if this claim is true or not.
13771 which this section documents.
13774 \begin_layout Standard
13775 This class is the LaTeX2e improvement of the old
13780 Every LaTeX2e distribution includes this class [which I'll just refer to
13782 \begin_inset Quotes eld
13790 \begin_inset Quotes erd
13793 from now on], so you're bound to have it.
13794 As I noted earlier, there are other classes, such as
13798 , which also produce slides for overhead projectors and do a better job
13800 However, there are some things which
13804 can do which the others can't, such as generate overlays.
13805 Read on to learn more!
13808 \begin_layout Subsection
13810 \begin_inset CommandInset label
13812 name "sec:slidesetup"
13819 \begin_layout Standard
13820 Obviously, to use this document class, you need to select
13821 \begin_inset Quotes eld
13829 \begin_inset Quotes erd
13832 from the class list in the
13834 Document\SpecialChar \menuseparator
13838 There are some other special things you should know about this class:
13841 \begin_layout Itemize
13842 Don't bother changing the options
13847 They're not supported by the
13854 \begin_layout Itemize
13858 \begin_inset space ~
13863 behaves a bit differently for this class.
13864 The possible choices and what they do are as follows:
13868 \begin_layout Description
13873 The final output contains page numbers in the lower right corner.
13876 \begin_layout Description
13885 , but also prints out any time markers you've put in.
13886 This is the default.
13889 \begin_layout Description
13894 The final output contains no page numbers, time markers, or alignment markers.
13898 \begin_layout Itemize
13903 class has an extra option:
13909 \begin_inset Quotes eld
13917 \begin_inset Quotes erd
13920 in the extra class options.
13924 \begin_layout Standard
13925 Using this options allows you to add time markers to
13931 \begin_inset space ~
13935 \begin_inset CommandInset ref
13937 reference "sec:slideNote"
13945 \begin_layout Standard
13946 You can also use the template file
13947 \begin_inset Quotes eld
13955 \begin_inset Quotes erd
13958 to automatically set up a document to use the
13964 File\SpecialChar \menuseparator
13966 \begin_inset space ~
13970 \begin_inset space ~
13975 to open your new document].
13976 The template file also contains some examples of the special paragraph
13977 environments used by this class.
13978 I'll describe those next.
13981 \begin_layout Subsection
13982 Paragraph Environments
13985 \begin_layout Subsubsection
13986 Supported Environments
13989 \begin_layout Standard
13990 The first thing you'll notice when you start up a new
13994 document is the font size and type: it's the equivalent of the size
13995 \begin_inset Quotes eld
14003 \begin_inset Quotes erd
14009 \begin_inset space ~
14015 This is also what's used in the output.
14017 \begin_inset Quotes eld
14021 \begin_inset Quotes erd
14024 to remind you that this is a slide.
14025 Your final slides will use a larger font; ergo, you'll have less space.
14026 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14029 \begin_layout Standard
14030 The next thing that becomes obvious is the changes to the paragraph environment
14031 pull-down box [at the far-left end of the toolbar].
14032 Most of the paragraph environments you're used to seeing are missing.
14033 There are also five new ones.
14038 class itself only supports certain paragraph environments:
14041 \begin_layout Itemize
14047 \begin_layout Itemize
14053 \begin_layout Itemize
14059 \begin_layout Itemize
14065 \begin_layout Itemize
14071 \begin_layout Itemize
14077 \begin_layout Itemize
14083 \begin_layout Itemize
14089 \begin_layout Itemize
14095 \begin_layout Itemize
14101 \begin_layout Itemize
14107 \begin_layout Standard
14108 All of the other standard environments, including the section-heading environmen
14109 ts, aren't used in the
14116 \begin_layout Standard
14117 On the other hand, you'll notice the following new environments:
14120 \begin_layout Itemize
14126 \begin_layout Itemize
14132 \begin_layout Itemize
14138 \begin_layout Itemize
14144 \begin_layout Itemize
14150 \begin_layout Standard
14151 These five are kind of quirky, due to a
14152 \begin_inset Quotes eld
14156 \begin_inset Quotes erd
14160 You see, LyX doesn't permit you to nest any other paragraph environment
14161 into an empty environment.
14162 Now, that's fine and dandy, but it means that you wouldn't be able to start
14163 a slide with anything except plain text.
14164 To deal with this, I've performed a little
14165 \begin_inset Quotes eld
14169 \begin_inset Quotes erd
14175 \begin_layout Subsubsection
14176 Quirks of the New Environments
14177 \begin_inset CommandInset label
14179 name "sec:slideQuirk"
14186 \begin_layout Standard
14187 All five of the new paragraph environments are somewhat quirky due to inherent
14188 limitiations in the current version of LyX.
14189 As I just mentioned, LyX forbids environments that begin with another environme
14191 To get around this, the
14195 environment isn't a paragraph environment as described in the
14203 \begin_layout Standard
14204 You should consider
14217 \begin_inset Quotes eld
14220 pseudo-environments.
14221 \begin_inset Quotes erd
14224 They look like a section heading or a
14225 \begin_inset Quotes eld
14233 \begin_inset Quotes erd
14236 but really begin a [and, if necessary, end the previous] paragraph environment.
14246 \begin_inset Quotes eld
14250 \begin_inset Quotes erd
14253 These two perform some action.
14256 \begin_layout Standard
14257 A common feature of all five environments,
14277 , is a rather long-ish label.
14278 The text following this label --- ordinarily the contents of the paragraph
14279 environment --- is utterly irrelevant for
14300 LyX completely ignores it.
14301 In fact, you can leave these five environments completely empty.
14305 \begin_layout Standard
14310 to put any text after the rather long-ish label, you might want to.
14311 This could be a short description of the contents of the
14316 In that case, enter in your descriptive comment and hit
14320 as you normally would.
14323 \begin_layout Standard
14324 If, on the other hand, you don't want to enter in any descriptive text,
14325 you'll hit another LyX quirk.
14326 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14327 environment until you put something in the old one.
14331 \begin_layout Itemize
14332 Start entering the text that will
14360 \begin_layout Itemize
14361 Now move to the beginning of that paragraph.
14365 \begin_layout Itemize
14374 \begin_layout Itemize
14375 Finally, change this new, empty paragraph to a
14399 \begin_layout Standard
14400 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14404 \begin_layout Subsection
14405 Making a Presentation with
14418 \begin_layout Subsubsection
14426 \begin_layout Standard
14427 If you're expecting this section to teach you how to actually make a presentatio
14428 n, you'll be sorely disappointed.
14429 Naturally, I'll describe all of the ways the
14433 class can assist you in preparing the materials for a presentation.
14434 Filling in the contents, however, is up to you.
14439 the LyX philosophy.]
14442 \begin_layout Standard
14447 environment [in the manner described in section
14448 \begin_inset space ~
14452 \begin_inset CommandInset ref
14454 reference "sec:slideQuirk"
14458 ] tells LyX to begin a new slide [duh].
14459 The label for this environment/
14460 \begin_inset Quotes erd
14464 \begin_inset Quotes erd
14468 \begin_inset Quotes eld
14472 \begin_inset Quotes erd
14475 in cool blue, followed by the label,
14476 \begin_inset Quotes eld
14480 \begin_inset Quotes erd
14484 Any text or paragraph environments that follow this one go on the new slide.
14488 \begin_layout Standard
14489 Slides are probably the only time you'll need to forcibly end pages in LyX
14490 (this can be specified in the
14495 In fact, you'll want to, once you finish entering the contents of one slide.
14496 If you've entered more text than can physically fit on a slide, the extra
14497 overflows onto a new slide.
14498 I don't recommend doing this, however, since the overflow slide won't have
14499 any page number on it.
14500 Furthermore, it may interfere with any
14504 you've made to accompany the oversized
14511 \begin_layout Standard
14520 environments work the same way as the
14525 They both create an
14526 \begin_inset Quotes eld
14530 \begin_inset Quotes erd
14533 followed by a label [
14534 \begin_inset Quotes eld
14538 \begin_inset Quotes erd
14542 \begin_inset Quotes eld
14546 \begin_inset Quotes erd
14550 The color is a stunning magenta instead of blue, and the
14551 \begin_inset Quotes eld
14555 \begin_inset Quotes erd
14558 will look different, in style and in length.
14559 The label fonts of all three also differ from one another.
14562 \begin_layout Standard
14567 , if the contents of a
14575 exceed the physical size of a slide or sheet of paper, the extra will overflow
14577 Again, you should avoid this.
14578 It defeats the whole purpose of
14589 \begin_layout Subsubsection
14599 \begin_layout Standard
14604 is a slide that sits atop another slide.
14605 Perhaps you wish to discuss a figure on the main
14609 before displaying the text associated with it.
14610 One way to accomplish this is tape a flap of dark paper over the part of
14615 you want to display later.
14616 This method fails, however, if you wish to overlap one graph with another,
14618 You would then have to fumble while speaking to align the two separate,
14623 s to align the two graphs.
14628 environment in both cases makes life much easier.
14631 \begin_layout Standard
14636 receives the page number of its
14637 \begin_inset Quotes eld
14641 \begin_inset Quotes erd
14649 \begin_inset Quotes eld
14657 \begin_inset Quotes erd
14664 \begin_layout Plain Layout
14665 Presumably, mutliple
14670 \begin_inset Quotes eld
14678 \begin_inset Quotes erd
14682 \begin_inset Quotes eld
14690 \begin_inset Quotes erd
14694 \begin_inset Quotes eld
14702 \begin_inset Quotes erd
14706 \begin_inset space ~
14709 appended to the page number of the parent
14719 Clearly, you want the contents of both the
14727 to each fit on a single physical slide! You should probably consider an
14733 \begin_inset Quotes eld
14737 \begin_inset Quotes erd
14749 class provides a visual cue for this: the label at the start of an
14753 is shorter than that at the start of a
14758 Lastly, when you generate printable output, you'll find alignment markers
14759 in all four corners of both the
14763 page and its parent
14768 These will assist you in lining up the two physical slides.
14771 \begin_layout Standard
14772 The major problem in overlaying two slides is aligning the contents of the
14773 two transparencies.
14774 How much space should you leave for that graph on the second slide? Worse
14775 still, what if you want a graph and a sentence on second slide, but there
14776 is text on the main transparency that goes in between them? You could try
14777 and insert vertical space of the right size.
14778 The better way is to use
14789 \begin_layout Standard
14790 As their names imply,
14798 are two command-like paragraph environments that make all subsequent text
14799 invisible and visible, respectively.
14801 \begin_inset space ~
14805 \begin_inset CommandInset ref
14807 reference "sec:slideQuirk"
14811 that you don't place anything
14815 these two environments, however.
14820 , it inserts a centered, sky-blue label into the page reading
14821 \begin_inset Quotes eld
14824 <Invisible Text Follows>
14825 \begin_inset Quotes erd
14829 For paragraphs following this label, the parts of the
14837 ; it doesn't matter which] where they would be contain instead blank space.
14841 \begin_layout Standard
14846 , the corresponding centered label is
14847 \begin_inset Quotes eld
14850 <Visible Text Follows>
14851 \begin_inset Quotes erd
14855 Paragraphs following this label behave normally.
14856 Note that the beginning of a new
14868 automatically shuts off an
14873 It's therefore not necessary to use
14884 \begin_layout Standard
14885 By now, it should be obvious how to create overlay transparencies using
14886 the proper combination of
14905 \begin_layout Enumerate
14910 , including everything that will appear on it, whether on the main slide
14918 \begin_layout Enumerate
14919 Before each figure or paragraph that will appear only on the
14928 If necessary, insert a
14932 environment after the
14939 \begin_layout Enumerate
14944 immediately following the
14951 \begin_layout Enumerate
14952 Copy the contents of this
14963 \begin_layout Enumerate
14968 , change all of the
14979 \begin_layout Standard
14981 You've just made an
14988 \begin_layout Standard
14989 There's one problem with the way I've designed the LyX
14993 class: you can't make text in the middle of a paragraph invisible, nor
14994 make text in the middle of an invisible paragraph visible again.
14995 To accomplish this feat, you'll need to use some inlined LaTeX codes.
14999 \begin_layout Plain Layout
15000 The commands of interest are:
15003 \begin_layout Itemize
15008 invisible \SpecialChar \ldots{}
15012 \begin_layout Itemize
15017 visible \SpecialChar \ldots{}
15021 \begin_layout Plain Layout
15022 \SpecialChar \ldots{}
15023 and need to be marked as TeX.
15025 \begin_inset Quotes eld
15029 \begin_inset Quotes erd
15032 you wish to change goes in between the brackets [and after the
15045 If you don't know how to mark text as TeX, see the appropriate section
15058 \begin_layout Subsubsection
15068 \begin_inset CommandInset label
15070 name "sec:slideNote"
15077 \begin_layout Standard
15086 is associated with a
15087 \begin_inset Quotes eld
15091 \begin_inset Quotes erd
15103 class provides visual cues.
15108 is shorter than that of a
15112 [yet longer than that of an
15116 ] and, like the label of an
15120 is shockingly magenta.
15121 Additionally, the printed
15125 has the page number of its
15126 \begin_inset Quotes eld
15130 \begin_inset Quotes erd
15138 \begin_inset Quotes eld
15146 \begin_inset Quotes erd
15150 \begin_inset Quotes eld
15158 \begin_inset Quotes erd
15162 \begin_inset Quotes eld
15170 \begin_inset Quotes erd
15174 You can have multiple
15178 s associated with a single
15190 , you'll probably want to break up long
15194 s so that they fit on a single sheet of paper.
15197 \begin_layout Standard
15202 is obvious: it contains anything additional you might want to say about
15208 It could also be used as a sheet of reminders for a particular
15213 In the case of the latter, you might want to make use of time markers.
15219 \begin_inset Quotes eld
15223 \begin_inset Quotes erd
15226 support for time markers, a
15231 So, you'll have to resort to using the LaTeX codes.
15234 \begin_layout Standard
15235 To use time markers, you'll need to specify the extra class option
15236 \begin_inset Quotes eld
15244 \begin_inset Quotes erd
15248 \begin_inset space ~
15252 \begin_inset CommandInset ref
15254 reference "sec:slidesetup"
15259 This option turns on timing marks, which will appear in the lower-left-hand
15265 To set what appears in the time marker, you use the LaTeX commands
15266 \begin_inset Quotes eld
15276 \begin_inset Quotes erd
15280 \begin_inset Quotes eld
15290 \begin_inset Quotes erd
15294 The arguments of both commands are time measured in seconds.
15296 \begin_inset Quotes eld
15306 \begin_inset Quotes erd
15309 sets the time marker to a given time.
15311 \begin_inset Quotes eld
15321 \begin_inset Quotes erd
15324 increments the time marker by the specified amount.
15325 Using time markers and
15329 s in this fashion, you can remind yourself how much time to spend on a particula
15337 \begin_layout Standard
15338 There's one last feature to describe.
15339 Clearly, you'd like to print out all of your
15347 s on transparencies while printing all of your
15364 with which it is associated.
15365 What's a person to do?
15368 \begin_layout Standard
15369 Luckily, there are two LaTeX commands that allow you to select what to print
15371 Both must be placed into the preamble of your document.
15373 \begin_inset Quotes eld
15385 \begin_inset Quotes erd
15388 will cause the output to contain only the
15397 Correspondingly, the command
15398 \begin_inset Quotes eld
15410 \begin_inset Quotes erd
15413 prevents the output of anything but
15418 I'd advise placing both commands in the preamble and initially comment
15420 You can then preview your entire presentation as you write.
15421 When you're done writing, you can then uncomment one of the two to select
15422 what you want to print.
15423 I like to uncomment
15424 \begin_inset Quotes eld
15436 \begin_inset Quotes erd
15439 , print to a file with
15440 \begin_inset Quotes eld
15448 \begin_inset Quotes erd
15451 in its name, comment it back out, then uncomment
15452 \begin_inset Quotes eld
15464 \begin_inset Quotes erd
15468 \begin_inset Quotes eld
15476 \begin_inset Quotes erd
15480 I can then send either file to a printer, loading transparencies or plain
15481 paper as appropriate.
15484 \begin_layout Standard
15485 You can also provide other arguments to the
15486 \begin_inset Quotes eld
15496 \begin_inset Quotes erd
15500 \begin_inset Quotes eld
15510 \begin_inset Quotes erd
15514 See a good LaTeX book for details.
15517 \begin_layout Subsection
15522 Class Template File
15525 \begin_layout Standard
15526 I have also provided a template file,
15527 \begin_inset Quotes eld
15535 \begin_inset Quotes erd
15543 To use it, begin your new presentation with
15548 ile\SpecialChar \menuseparator
15550 \begin_inset space ~
15554 \begin_inset space ~
15564 Your new LyX presentation file will contain an example
15585 additionally contain an example of the use of
15594 Lastly, the preamble will contain:
15597 \begin_layout LyX-Code
15598 % Uncomment to print out only slides and overlays
15601 \begin_layout LyX-Code
15605 \begin_layout LyX-Code
15611 \begin_inset Newline newline
15617 \begin_layout LyX-Code
15618 % Uncomment to print out only notes
15621 \begin_layout LyX-Code
15625 \begin_layout LyX-Code
15633 \begin_layout Standard
15634 One final thing: I created this class to support the LaTeX2e
15635 \begin_inset Quotes eld
15643 \begin_inset Quotes erd
15646 class, one of the built-in LaTeX2e classes.
15647 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15648 built-in slide class.
15649 It's here if you want it or need it.
15650 There exist other LaTeX2e classes for creating presentations, such as the
15656 \begin_inset space ~
15660 \begin_inset CommandInset ref
15662 reference "sec:foiltex"
15667 \begin_inset Quotes eld
15675 \begin_inset Quotes erd
15678 package [present on some TeX distributions].
15679 The latter is not yet supported under LyX.
15683 \begin_layout Plain Layout
15684 Perhaps you can take on the task\SpecialChar \ldots{}
15690 I know nothing about these other classes.
15691 Try them out to see what sort of alternative they provide.
15694 \begin_layout Chapter
15695 LyX Features needing Extra Software
15698 \begin_layout Section
15702 \begin_layout Standard
15708 \begin_layout Subsection
15712 \begin_layout Standard
15721 \begin_layout Plain Layout
15726 is not yet available when you are using the LaTeX distribution MiKTeX.
15731 , you'll find in the
15738 \begin_inset space ~
15749 \begin_inset CommandInset href
15751 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15758 \begin_layout Standard
15763 package is a program that was written by
15764 \begin_inset Flex CharStyle:Noun
15767 \begin_layout Plain Layout
15769 \begin_inset space ~
15777 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15778 and easy to forget.
15779 The program runs over your LaTeX file, checks the integrity of the file,
15780 and flags some common errors.
15781 In other technical words, it is
15788 \begin_layout Standard
15789 Well, what is a syntax checker doing in LyX which is supposed to produce
15790 correct LaTeX anyways? The answer is simple: Just as
15794 not only checks the
15798 of C programs, but also does
15802 checks for type-errors,
15806 catches some common
15810 errors, in addition to the syntactical ones.
15815 is capable of detecting several common errors, such as
15818 \begin_layout Itemize
15819 Ellipsis detection:
15820 \begin_inset Newline newline
15823 Use \SpecialChar \ldots{}
15827 \begin_layout Itemize
15828 No space in front of/after parenthesis:
15829 \begin_inset Newline newline
15835 \begin_layout Itemize
15836 Enforcement of normal space after common abbreviations:
15837 \begin_inset Newline newline
15841 \begin_inset space \thinspace{}
15845 \begin_inset space \space{}
15848 is too wide spacing.
15851 \begin_layout Itemize
15852 Enforcement of end-of-sentence space when the last sentence ends with a
15854 \begin_inset Newline newline
15858 And this is wrong spacing.
15861 \begin_layout Itemize
15862 Space in front of labels and similar commands:
15863 \begin_inset Newline newline
15866 The label should stick right up to the text to avoid falling to a wrong
15869 \begin_inset CommandInset label
15879 \begin_layout Plain Layout
15880 This footnote is in danger of falling off to a wrong page
15885 The label is separated too much.
15888 \begin_layout Itemize
15889 Space in front of references, instead of hard spaces:
15890 \begin_inset Newline newline
15893 In you are in bad luck, the text will break right between the referenced
15894 text and reference number, and that's a pity.
15896 \begin_inset CommandInset ref
15898 reference "sec:chktex"
15905 \begin_layout Itemize
15907 \begin_inset Quotes eld
15911 \begin_inset Quotes erd
15915 \begin_inset Formula $\times$
15919 \begin_inset Newline newline
15922 2x2 looks cheap compared to
15923 \begin_inset Formula $2\times2$
15929 \begin_layout Standard
15930 and more \SpecialChar \ldots{}
15931 It is an invaluable tool when you are
15932 \begin_inset Quotes eld
15936 \begin_inset Quotes erd
15939 your document before printing, and you should run it right after the obligatory
15940 spelling check, and before you go fine tuning the typesetting.
15943 \begin_layout Subsection
15947 \begin_layout Standard
15948 If you have the program installed, usage is as simple as choosing
15950 Tools\SpecialChar \menuseparator
15952 \begin_inset space ~
15958 This will make LyX generate a LaTeX file of your document, start
15962 to check it, and then make LyX insert
15963 \begin_inset Quotes eld
15967 \begin_inset Quotes erd
15970 with the warnings from
15974 , if there were any.
15975 The warnings will be placed close to the point of the mistake, and you
15976 can quickly find them by using the
15978 Navigate\SpecialChar \menuseparator
15981 menu item, or the shortcut key
15990 Open the error boxes by clicking on them with the mouse, or use the shortcut
15999 bindings, or the corresponding
16008 Read the warning and correct the mistake, if it is a mistake.
16009 If you have trouble understanding what the warning is about, you can safely
16011 Remember that there is a hidden layer between the document on screen and
16012 the technical details in invoking
16016 , and this gap can make some warnings seem arcane or just right down plain
16020 \begin_layout Standard
16021 This document is an excellent testing bed for the feature, and it should
16022 provide quite a few warnings for you to fiddle with.
16023 Since computers are only so smart, expect most of the warnings to be false
16027 \begin_layout Subsection
16028 How to fine tune it
16031 \begin_layout Standard
16032 Sometimes, you'll find that
16036 makes more noise than suits your mood.
16037 Then you can choose not to use it, wait until your mood changes, or try
16042 to get better along with you.
16043 Another choice in the most desperate situations is to use
16045 View\SpecialChar \menuseparator
16047 \begin_inset space ~
16051 \begin_inset space ~
16055 \begin_inset space ~
16060 , which will get rid of all warnings instantly.
16063 \begin_layout Standard
16072 very configurable and extensible, you shouldn't expect to solve all problems
16078 Since LyX has to generate a somewhat special LaTeX file to be able to match
16079 the line numbers from the
16087 \begin_layout Plain Layout
16088 You can inspect the specific output from
16094 Edit\SpecialChar \menuseparator
16096 \begin_inset space ~
16100 \begin_inset space ~
16114 to the internal document structure, some of the warnings will not seen
16115 to appear correctly.
16116 There are two things you can do about this:
16119 \begin_layout Itemize
16124 invocation command line in
16140 installation configuration file (usually with the file
16145 See below to learn what warnings can be enabled and disabled on the command
16150 \begin_layout Itemize
16151 Export your document as a raw LaTeX file using
16153 File\SpecialChar \menuseparator
16154 Export\SpecialChar \menuseparator
16162 Invoked in this way, it can be a hassle to find the corresponding place
16163 in the document inside LyX, but with a little patience, you should be able
16167 \begin_layout Standard
16168 Here follows the warning messages that can be enabled and disabled in
16177 to disable a warning, and
16181 to enable a warning.
16182 The emphasized entries are disabled by default, because the default is
16185 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16190 \begin_layout Standard
16191 Notice that you should only use the options that enable and disable warnings,
16192 because LyX relies on some of the other command line parameters to be set
16193 in a specific way to have a chance to communicate with
16200 \begin_layout Enumerate
16204 Command terminated with space.
16207 \begin_layout Enumerate
16210 Non-breaking space (
16211 \begin_inset Quotes eld
16219 \begin_inset Quotes erd
16222 ) should have been used.
16225 \begin_layout Enumerate
16229 You should enclose the previous parenthesis with
16230 \begin_inset Quotes eld
16238 \begin_inset Quotes erd
16244 \begin_layout Enumerate
16247 Italic correction (
16248 \begin_inset Quotes eld
16258 \begin_inset Quotes erd
16261 ) found in non-italic buffer.
16264 \begin_layout Enumerate
16267 Italic correction (
16268 \begin_inset Quotes eld
16278 \begin_inset Quotes erd
16281 ) found more than once.
16284 \begin_layout Enumerate
16288 No italic correction (
16289 \begin_inset Quotes eld
16299 \begin_inset Quotes erd
16305 \begin_layout Enumerate
16309 \begin_inset Quotes eld
16317 \begin_inset Quotes erd
16321 \begin_inset Quotes eld
16329 \begin_inset Quotes erd
16335 \begin_layout Enumerate
16338 Wrong length of dash may have been used.
16341 \begin_layout Enumerate
16345 \begin_inset Quotes eld
16353 \begin_inset Quotes erd
16357 \begin_inset Quotes eld
16365 \begin_inset Quotes erd
16371 \begin_layout Enumerate
16375 \begin_inset Quotes eld
16383 \begin_inset Quotes erd
16389 \begin_layout Enumerate
16393 \begin_inset Quotes eld
16401 \begin_inset Quotes erd
16404 to achieve an ellipsis.
16407 \begin_layout Enumerate
16410 Inter-word spacing (
16411 \begin_inset Quotes eld
16421 \begin_inset Quotes eld
16424 ) should perhaps be used.
16427 \begin_layout Enumerate
16430 Inter-sentence spacing (
16431 \begin_inset Quotes eld
16441 \begin_inset Quotes erd
16444 ) should perhaps be used.
16447 \begin_layout Enumerate
16450 Could not find argument for command.
16453 \begin_layout Enumerate
16457 \begin_inset Quotes eld
16465 \begin_inset Quotes erd
16471 \begin_layout Enumerate
16474 Math mode still on at end of LaTeX file.
16477 \begin_layout Enumerate
16481 \begin_inset Quotes eld
16489 \begin_inset Quotes erd
16492 doesn't match the number of
16493 \begin_inset Quotes eld
16501 \begin_inset Quotes erd
16507 \begin_layout Enumerate
16510 You should use either
16513 \begin_inset Quotes eld
16521 \begin_inset Quotes erd
16526 as an alternative to
16527 \begin_inset Quotes eld
16535 \begin_inset Quotes erd
16541 \begin_layout Enumerate
16548 " (ASCII 39) instead of "
16555 \begin_layout Enumerate
16558 User-specified pattern found.
16561 \begin_layout Enumerate
16564 This command might not be intended.
16567 \begin_layout Enumerate
16574 \begin_layout Enumerate
16592 \begin_layout Enumerate
16595 Delete this space to maintain correct page references.
16598 \begin_layout Enumerate
16602 You might wish to put this between a pair of
16603 \begin_inset Quotes eld
16611 \begin_inset Quotes erd
16617 \begin_layout Enumerate
16620 You ought to remove spaces in front of punctuation.
16623 \begin_layout Enumerate
16626 Could not execute LaTeX command.
16629 \begin_layout Enumerate
16638 in front of small punctuation.
16641 \begin_layout Enumerate
16649 may look prettier here.
16652 \begin_layout Enumerate
16656 Multiple spaces detected in output.
16659 \begin_layout Enumerate
16662 This text may be ignored.
16665 \begin_layout Enumerate
16671 \begin_inset Quotes eld
16676 to begin quotation, not
16683 \begin_layout Enumerate
16690 to end quotation, not
16693 \begin_inset Quotes eld
16701 \begin_layout Enumerate
16707 \begin_layout Enumerate
16710 You should perhaps use
16711 \begin_inset Quotes eld
16719 \begin_inset Quotes erd
16725 \begin_layout Enumerate
16728 You should put a space in front of/after parenthesis.
16731 \begin_layout Enumerate
16734 You should avoid spaces in front of/after parenthesis.
16737 \begin_layout Enumerate
16741 You should not use punctuation in front of/after quotes.
16744 \begin_layout Enumerate
16747 Double space found.
16750 \begin_layout Enumerate
16753 You should put punctuation outside inner/inside display math mode.
16756 \begin_layout Enumerate
16759 You ought to not use primitive TeX in LaTeX code.
16762 \begin_layout Enumerate
16765 You should remove spaces in front of
16766 \begin_inset Quotes eld
16774 \begin_inset Quotes erd
16780 \begin_layout Enumerate
16783 \begin_inset Quotes eld
16791 \begin_inset Quotes erd
16794 is normally not followed by
16795 \begin_inset Quotes eld
16803 \begin_inset Quotes erd
16809 \begin_layout Standard
16810 In later versions of LyX, we hope to provide a more complete interface to
16811 this tool (and it's smaller cousin
16815 ) to exploit the full power of it.
16816 But it's not exactly useless as it is now: go try it on one of your existing
16817 documents of a certain length and be surprised.
16820 \begin_layout Section
16821 Version Control in LyX
16824 \begin_layout Standard
16827 Lars Gullik Bjønnes,
16834 \begin_layout Subsection
16838 \begin_layout Standard
16839 A friend of mine wanted to try LyX for a group project.
16840 When he didn't find support for version control or file locking, he dropped
16842 This angered me a bit, so I thought that I should at least make support
16843 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16844 This has now been done.
16845 LyX now supports some of the most basic RCS commands.
16846 If you need to something a bit more sophisticated you will have to do that
16847 manually in an xterm.
16850 \begin_layout Standard
16851 Before you begin to use the version control features in LyX, you should
16853 \begin_inset Quotes eld
16857 \begin_inset Quotes erd
16860 (a man file, read it with
16865 This file describes all the basic features of RCS.
16866 You should especially notice the comment about a RCS directory, and the
16867 notion of a master RCS file (the file ending in
16874 \begin_layout Standard
16875 Later basic CVS/SVN support was added.
16876 You should be familiar with CVS/SVN usage before start using it under LyX.
16877 Most of the log messages are not currently displayed after operations -
16878 you can check them in terminal window if unsure.
16881 \begin_layout Standard
16882 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16883 package---no guarantees are made for older versions.
16886 \begin_layout Subsection
16887 RCS commands in LyX
16890 \begin_layout Standard
16891 The following sections describe the RCS commands supported by LyX.
16892 You can find them in the
16897 ile\SpecialChar \menuseparator
16903 \begin_inset space ~
16911 \begin_layout Subsubsection
16917 \begin_layout Standard
16918 If your document is not under revision control, this is the only item shown
16920 And if it is under revision control, the
16927 item is not visible.
16931 \begin_layout Standard
16932 This command registers your document with RCS (unless you are under the
16933 directory managed by CVS)\SpecialChar \@.
16934 You are asked interactively to supply an initial
16935 description of the document.
16936 The document is now set in Read-Only mode and you have to
16939 \begin_inset space ~
16943 \begin_inset space ~
16947 \begin_inset space ~
16952 , before making any changes to it.
16953 A document under revision control has a
16954 \begin_inset Quotes eld
16957 [RCS:<version> <locker>]
16958 \begin_inset Quotes erd
16961 item tagged to the filename in the minibuffer.
16964 \begin_layout Standard
16965 RCS command that is run:
16967 ci -q -u -i -t-"<initial description>" <file-name>
16970 \begin_layout Standard
16975 to understand the switches.
16979 \begin_layout Subsubsection
16985 \begin_layout Standard
16986 When you are finished editing a file, you check in your changes.
16987 When you do this, you are asked for a description of the changes.
16988 This is stored in the history log.
16989 The version number is bumped, your changes are applied to the master RCS
16990 file, the document is unlocked and set to Read-Only mode.
16994 \begin_layout Standard
16997 ci -q -u -m"<description>" <file-name>
17000 \begin_layout Subsubsection
17006 \begin_layout Standard
17007 By doing this you lock the document so that only you can edit it.
17008 This will also make the document Read-Write only for you.
17009 You will usually continue editing for a while and when you are finished
17010 you check in your changes.
17011 The status line is changed to reflect that you have locked the file.
17015 \begin_layout Standard
17018 co -q -l <file-name>
17021 \begin_layout Subsubsection
17024 Revert To Repository Version
17027 \begin_layout Standard
17028 This will discard all changes made to the document since the last check
17030 You get a warning before changes are discarded.
17033 \begin_layout Standard
17036 co -f -u<version> <file-name>
17039 \begin_layout Subsubsection
17045 \begin_layout Standard
17046 This makes as if the last check in never happened.
17047 No changes are made to the document loaded into LyX, but the last version
17048 is removed from the master RCS file.
17052 \begin_layout Standard
17055 rcs -o<version> <file-name>
17058 \begin_layout Subsubsection
17064 \begin_layout Standard
17065 This show the complete history of the RCS document.
17070 is shown in a browser.
17078 \begin_layout Subsection
17079 CVS commands in LyX
17082 \begin_layout Standard
17083 CVS is now partially supported by LyX.
17084 You can find the commands in the
17089 ile\SpecialChar \menuseparator
17095 \begin_inset space ~
17103 \begin_layout Subsubsection
17109 \begin_layout Standard
17110 If your document is not under revision control, this is the only item shown
17112 And if it is under revision control, the
17119 item is not visible.
17123 \begin_layout Standard
17124 This command registers in CVS your document ONLY in case you have already
17125 the documents directory under CVS control (in particular
17130 This means you have to checkout the archive by yourself.
17134 \begin_layout Standard
17135 Then you are asked interactively to supply an initial description of the
17137 Don't forget that registered file is not yet commited.
17140 \begin_layout Standard
17141 CVS command that is run:
17144 \begin_inset Quotes erd
17148 \begin_inset Quotes eld
17152 \begin_inset Quotes erd
17158 \begin_layout Standard
17163 to understand the switches.
17167 \begin_layout Subsubsection
17173 \begin_layout Standard
17174 When you are finished editing a file, you commit your changes.
17175 When you do this, you are asked for a description of the changes.
17176 After that changes are commited.
17179 \begin_layout Standard
17182 cvs -q commit -m"<description>" <file-name>
17185 \begin_layout Subsubsection
17188 Revert To Repository Version
17191 \begin_layout Standard
17192 This will discard all changes made to the document since the last check
17194 You get a warning before changes are discarded.
17195 Firstly the file is deleted, secondly CVS update command is run.
17198 \begin_layout Standard
17202 \begin_inset Quotes eld
17206 \begin_inset Quotes erd
17212 \begin_layout Subsubsection
17218 \begin_layout Standard
17219 This show the complete history of the CVS document.
17223 \begin_inset Quotes eld
17227 \begin_inset Quotes erd
17232 is shown in a browser.
17235 \begin_layout Subsection
17236 SVN commands in LyX
17239 \begin_layout Standard
17240 SVN is now partially supported by LyX.
17241 You can find the commands in the
17246 ile\SpecialChar \menuseparator
17252 \begin_inset space ~
17258 Please note that if you use password protected access to repository via
17259 ssh, you will be asked in terminal window.
17262 \begin_layout Subsubsection
17268 \begin_layout Standard
17269 If your document is not under revision control, this is the only item shown
17271 And if it is under revision control, the
17278 item is not visible.
17282 \begin_layout Standard
17283 This command registers in SVN your document ONLY in case you have already
17284 the documents directory under SVN control (in particular
17289 This means you have to checkout the archive by yourself.
17293 \begin_layout Standard
17294 Then you are asked interactively to supply an initial description of the
17296 Don't forget that registered file is not yet commited.
17299 \begin_layout Standard
17300 SVN command that is run:
17303 \begin_inset Quotes eld
17307 \begin_inset Quotes erd
17313 \begin_layout Standard
17318 to understand the switches.
17322 \begin_layout Subsubsection
17328 \begin_layout Standard
17329 When you are finished editing a file, you commit your changes.
17330 When you do this, you are asked for a description of the changes.
17331 After that changes are commited.
17334 \begin_layout Standard
17337 svn commit -q -m"<description>" <file-name>
17340 \begin_layout Subsubsection
17346 \begin_layout Standard
17347 Updates the changes of this file from the repository.
17348 Be sure you understand SVN merging and conflicts resolving before using
17349 this function, because all conflicts has to be done manually by you!
17352 \begin_layout Standard
17356 \begin_inset Quotes eld
17360 \begin_inset Quotes erd
17366 \begin_layout Subsubsection
17369 Revert To Repository Version
17372 \begin_layout Standard
17373 This will discard all changes made to the document since the last check
17375 You get a warning before changes are discarded.
17379 \begin_layout Standard
17383 \begin_inset Quotes eld
17387 \begin_inset Quotes erd
17393 \begin_layout Subsubsection
17399 \begin_layout Standard
17400 This show the complete history of the SVN document.
17404 \begin_inset Quotes eld
17408 \begin_inset Quotes erd
17413 is shown in a browser.
17416 \begin_layout Section
17417 Literate Programming
17420 \begin_layout Standard
17425 (kayvan@sylvan.com)
17429 original documentation written by
17431 Edmar Wienskoski Jr.
17434 (edmar-w-jr@technologist.com)
17437 \begin_layout Subsection
17441 \begin_layout Standard
17442 The main purpose of this documentation is to show you how to use LyX for
17443 literate programming.
17444 Where it is assumed that you are familiar with this programming technique,
17446 \begin_inset Quotes eld
17450 \begin_inset Quotes erd
17454 \begin_inset Quotes eld
17458 \begin_inset Quotes erd
17462 If that is not the case, please follow the web links provided in the following
17464 There is a lot of good documentation out there covering old development
17465 history to the latest tools tips.
17468 \begin_layout Standard
17469 It is also assumed that you are familiar with LyX itself to a point that
17470 you are comfortable changing your LyX preferences, and X resources file.
17471 If that is not the case please refer to other LyX documentation to cover
17472 your specific needs.
17475 \begin_layout Subsection
17476 Literate Programming
17479 \begin_layout Standard
17480 From the Literate Programming FAQ:
17483 \begin_layout Quotation
17484 Literate programming is the combination of documentation and source together
17485 in a fashion suited for reading by human beings.
17486 In fact, literate programs should be enjoyable reading, even inviting!
17487 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17488 and documentation in a single file.
17489 Literate programming tools then parse the file to produce either readable
17490 documentation or compilable source.
17491 The WEB style of literate programming was created by D.
17492 \begin_inset space \thinspace{}
17496 Knuth during the development of his TeX typesetting software.
17500 \begin_layout Standard
17501 Another excerpt says:
17504 \begin_layout Quotation
17507 How is literate programming different from verbose commenting?
17510 \begin_layout Quotation
17511 There are three distinguishing characteristics.
17512 In order of importance, they are:
17516 \begin_layout Itemize
17517 flexible order of elaboration
17520 \begin_layout Itemize
17521 automatic support for browsing
17524 \begin_layout Itemize
17525 typeset documentation, especially diagrams and mathematics
17529 \begin_layout Standard
17530 Now that I sparked your curiosity, take a look in the references.
17533 \begin_layout Subsubsection
17537 \begin_layout Standard
17538 The complete Literate Programming FAQ can be found at:
17541 \begin_layout Quote
17542 Literate Programming FAQ
17543 \begin_inset Flex URL
17546 \begin_layout Plain Layout
17548 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17556 \begin_layout Standard
17557 The FAQ lists 23 (twenty three!) different literate programming tools.
17558 Where some are specialized or
17559 \begin_inset Quotes eld
17563 \begin_inset Quotes erd
17566 for particular programming languages, while other have general scope.
17571 for my own use for several reasons:
17574 \begin_layout Itemize
17575 It can generate the documentation either in LaTeX or HTML.
17578 \begin_layout Itemize
17579 It has a open architecture, i.
17580 \begin_inset space \thinspace{}
17584 \begin_inset space \space{}
17587 it is easy to plug in new filters and to perform special processing that
17592 \begin_layout Itemize
17593 There is a good selection of filters available already (the HTML is one
17597 \begin_layout Itemize
17601 \begin_layout Standard
17602 The Noweb web page can be found at:
17605 \begin_layout Quote
17607 \begin_inset Flex URL
17610 \begin_layout Plain Layout
17612 http://www.cs.virginia.edu/~nr/noweb/
17620 \begin_layout Standard
17621 Starting from there you can reach many other interesting links and even
17622 some literate program examples.
17625 \begin_layout Subsection
17626 LyX and Literate Programming
17629 \begin_layout Standard
17630 The LyX support for Literate Programming is provided by using the generic
17631 LyX converters mechanism.
17632 This support is provided in a
17633 \begin_inset Quotes eld
17637 \begin_inset Quotes erd
17641 \begin_inset space \thinspace{}
17645 \begin_inset space \space{}
17648 you will be able to use this new LyX feature with some other literate programmin
17649 g tool of your choice by just changing your LyX preferences.
17652 \begin_layout Subsubsection
17653 Generating documents and code (weaving and tangling)
17656 \begin_layout Paragraph
17657 Selecting the document class
17660 \begin_layout Standard
17661 If you have installed Noweb and LyX successfully, whenever you open a new
17662 document or try to change the document class of an existing one, you will
17663 find that there are three new document classes available:
17666 \begin_layout Itemize
17670 \begin_layout Itemize
17674 \begin_layout Itemize
17678 \begin_layout Standard
17679 You must select one of them to create your literate documents from.
17683 \begin_layout Standard
17684 Note that literate documents are not limited to these three classes.
17685 New classes can be generated from other styles like letter or in combination
17686 with other class variations like Article (AMS).
17687 If you have special needs that cannot be covered by one of the existing
17688 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17689 will arrange to insert a new entry, or teach you how to do it.
17693 \begin_layout Plain Layout
17694 It is very simple, it involves the creation of a file with four lines, and
17695 re-running of the auto configuration.
17700 Moreover, if you use a literate tool other than Noweb you may need to create
17701 a new set of document classes for it.
17704 \begin_layout Paragraph
17708 \begin_layout Standard
17709 LyX enables you to write code with a layout named
17717 \begin_layout Plain Layout
17718 The equivalent Noweb term is
17719 \begin_inset Quotes eld
17723 \begin_inset Quotes erd
17727 For historical reasons, I got used to the term
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17735 introduced by other literate tool named Nuweb, which I used for many years
17736 before rendering myself to Noweb.
17741 Noweb delimits scraps like this:
17744 \begin_layout LyX-Code
17748 \begin_layout LyX-Code
17752 \begin_layout LyX-Code
17756 \begin_layout LyX-Code
17760 \begin_layout LyX-Code
17764 \begin_layout Standard
17765 The problem is that whatever is written in between the << and the
17769 must be taken literally, i.
17770 \begin_inset space \thinspace{}
17774 \begin_inset space \space{}
17777 LyX should be prevented from making any special interpretation of what has
17779 This is handled by a special layout named Scrap, that works like a normal
17780 paragraph but has a free spacing capability.
17783 \begin_layout Standard
17784 The down side of the Scrap paragraph layout is that consecutive paragraphs
17785 of code will be spaced with one empty line in the source code and also
17786 in the printed documentation.
17787 The work around is to enter each line of code within a single Scrap, with
17788 a newline (ctrl-return).
17789 The example above will look like this:
17793 \begin_layout Plain Layout
17794 If you have a printed version of this document you will not see any difference
17795 between the previous example and this one.
17803 \begin_layout LyX-Code
17805 \begin_inset Newline newline
17809 \begin_inset Newline newline
17813 \begin_inset Newline newline
17817 \begin_inset Newline newline
17823 \begin_layout Standard
17824 This layout works fine.
17825 The only real inconvenience is that you have to type ctrl-return instead
17830 \begin_layout Plain Layout
17831 It is in my list of
17832 \begin_inset Quotes eld
17836 \begin_inset Quotes erd
17847 \begin_layout Standard
17848 As a special note, you can also use the
17849 \begin_inset Quotes eld
17853 \begin_inset Quotes erd
17856 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17860 \begin_layout LyX-Code
17862 \begin_inset Newline newline
17865 def some_function(args):
17866 \begin_inset Newline newline
17869 "This is the doc string for this function."
17870 \begin_inset Newline newline
17873 print "My args: ", args
17876 \begin_layout LyX-Code
17877 @ %def some_function
17880 \begin_layout Standard
17881 For an example of this usage and the resulting cross-reference output, look
17882 at the Literate python program in
17884 LIBDIR/examples/listerrors.lyx
17886 which should make this all clear.
17889 \begin_layout Paragraph
17890 Generating the documentation
17893 \begin_layout Standard
17894 At this point you already have a new document file with a proper document
17895 class, and with some code and text on it.
17896 How do I print it? The answer is simple, you select
17901 iew\SpecialChar \menuseparator
17909 Just like you would do for a plain document.
17910 No special procedure is required.
17913 \begin_layout Standard
17914 To help orientate you, I will now explain what happens inside LyX:
17917 \begin_layout Enumerate
17920 Update\SpecialChar \menuseparator
17923 menu option is chosen, a LaTeX file is generated.
17928 \begin_layout Standard
17929 If the document is of any literate class the generated file will be named
17930 with an extension name defined by the
17931 \begin_inset Quotes eld
17935 \begin_inset Quotes erd
17938 format (defined in the Preferences panel), otherwise the file will have
17947 \begin_layout Enumerate
17948 Note that the only difference so far is in the name of the file, no special
17949 processing is required by LyX.
17950 Given that you formatted the code using the Scrap layout that, by itself,
17951 takes care of the business.
17954 \begin_layout Enumerate
17955 If the document is of any literate class LyX will then use the internal
17956 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17960 \begin_layout Plain Layout
17961 The converters are defined in the
17963 Tools\SpecialChar \menuseparator
17967 \begin_inset Quotes eld
17971 \begin_inset Quotes erd
17983 manual for general information about converters.
17988 to generate the LaTeX file.
17992 \begin_layout Standard
17993 Otherwise it will just skip this step.
17997 \begin_layout Enumerate
17998 Finally, LaTeX is invoked and the regular post processing continues as in
18002 \begin_layout Standard
18003 Independence from a particular
18004 \begin_inset Quotes eld
18008 \begin_inset Quotes erd
18011 is easily achieved by changing the commands that are run by the various
18015 \begin_layout Paragraph
18016 Generating the code
18019 \begin_layout Standard
18020 When the build menu option is chosen or the corresponding button in the
18021 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18022 Next, LyX invokes the
18027 This converter needs to be defined by the user and is not installed by
18028 default, though the Program format is.
18029 This converter (like any other converter) will have two parts:
18032 \begin_layout Enumerate
18033 The converter program itself.
18034 This program performs the conversion from the one format to the other (in
18035 this case, from the Noweb format to the Program pseudo-format).
18038 \begin_layout Enumerate
18039 The error log parser.
18040 This is a program whose sole purpose is to rewrite error messages in a
18041 format that LyX understands.
18042 This makes it possible for LyX to place error boxes in the right places
18043 in the file buffer.
18046 \begin_layout Standard
18047 The first part, the
18048 \begin_inset Quotes eld
18052 \begin_inset Quotes erd
18055 setting, should be set to
18056 \begin_inset Quotes eld
18064 \begin_inset Quotes erd
18068 This basically means that LyX will call
18069 \begin_inset Quotes eld
18073 \begin_inset Quotes erd
18076 (a program or script) with the name of the Noweb file (normally a file
18077 in the LyX temp directory).
18081 \begin_layout Standard
18082 This is an implementation of
18083 \begin_inset Quotes eld
18087 \begin_inset Quotes erd
18090 that you can place in a directory on your path:
18093 \begin_layout LyX-Code
18097 \begin_layout LyX-Code
18101 \begin_layout LyX-Code
18102 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18105 \begin_layout Standard
18106 The next part of the converter setting is the
18107 \begin_inset Quotes eld
18111 \begin_inset Quotes erd
18114 which is to be set to
18115 \begin_inset Quotes eld
18120 parselog=listerrors
18123 \begin_inset Quotes erd
18127 This will run any errors that are generated by the
18128 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 process through the
18136 \begin_inset Quotes eld
18140 \begin_inset Quotes erd
18146 \begin_layout Standard
18147 The converter code looks in
18155 then on the path for the
18156 \begin_inset Quotes eld
18160 \begin_inset Quotes erd
18166 \begin_layout Standard
18167 The build will normally take place in LyX's temporary directory, so the
18168 files produced by the conversion will be in that directory.
18169 LyX will copy out what it regards as the `main' file, but the
18173 conversion may produce several files, and so most of these would then be
18174 deleted when LyX was closed.
18175 The present solution is to use a `copier',
18179 \begin_layout Plain Layout
18188 manual for information on these.
18197 script in its default mode, so that the entire contents of the temporary
18198 directory is copied.
18199 More will get copied than is needed, to be sure, but nothing will be lost.
18200 If, however, you know what extensions the generated files will have, this
18201 can be improved by using the
18210 This option takes a comma-separated list of extensions to copy.
18211 So, for example, if the conversion will generate only files with the extensions
18220 , then the correct definition would be:
18223 \begin_layout LyX-Code
18224 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18227 \begin_layout Standard
18228 The result will be that only files with these two extensions will be copied
18232 \begin_layout Paragraph
18233 Build instructions in the document
18236 \begin_layout Standard
18237 The last piece of the integration between LyX and noweb is the
18238 \begin_inset Quotes eld
18242 \begin_inset Quotes erd
18246 Generally, the instructions for building your program should be embedded
18247 in a scrap of its own.
18249 \begin_inset Quotes eld
18253 \begin_inset Quotes erd
18256 above uses the notangle command to look for this scrap (called
18257 \begin_inset Quotes eld
18261 \begin_inset Quotes erd
18264 ) and runs its contents through
18265 \begin_inset Quotes eld
18269 \begin_inset Quotes erd
18275 \begin_layout Standard
18276 Typically, such a scrap would look something like this:
18279 \begin_layout LyX-Code
18281 \begin_inset Newline newline
18285 \begin_inset Newline newline
18289 \begin_inset Newline newline
18292 if [ -z "${NOWEB_SOURCE}" ]
18293 \begin_inset Newline newline
18297 \begin_inset Newline newline
18300 NOWEB_SOURCE=myfile.nw
18301 \begin_inset Newline newline
18305 \begin_inset Newline newline
18309 code to extract files ...]
18310 \begin_inset Newline newline
18314 code to compile files ...]
18315 \begin_inset Newline newline
18321 \begin_layout Standard
18324 LIBDIR/examples/listerrors.lyx
18328 LIBDIR/examples/Literate.lyx
18330 which implement two versions of the
18331 \begin_inset Quotes eld
18335 \begin_inset Quotes erd
18338 program for some illustrations of how all of these pieces go together or
18341 LIBDIR/examples/noweb2lyx.lyx.
18344 Interestingly, these three files show off the language-indepence of the
18345 LyX literate programming support since they are written in Python, C and
18349 \begin_layout Subsubsection
18353 \begin_layout Standard
18354 All the Literate Programming support is configured by the
18359 ools\SpecialChar \menuseparator
18367 \begin_inset Quotes eld
18371 \begin_inset Quotes erd
18375 The important parts are:
18378 \begin_layout Description
18380 \begin_inset space ~
18384 \begin_inset Quotes eld
18388 \begin_inset Quotes erd
18392 \begin_inset space ~
18395 format Set up via the Formats tab, this is where the Noweb-specific pieces
18405 , the file extension is set to
18410 This tells LyX to create a file with a
18414 extension in the first step of the conversion process.
18417 \begin_layout Description
18419 \begin_inset space ~
18427 \begin_inset space ~
18430 format This is an empty format whose sole purpose is to be the endpoint
18431 of a conversion (which then allows us to set up a converter for it).
18434 \begin_layout Description
18443 This converter performs the
18444 \begin_inset Quotes eld
18448 \begin_inset Quotes erd
18451 of the literate document.
18452 For Noweb, it is set to
18453 \begin_inset Quotes eld
18458 noweave -delay -index $$i > $$o
18461 \begin_inset Quotes erd
18467 \begin_layout Description
18477 \begin_inset Quotes eld
18481 \begin_inset Quotes erd
18485 As stated above, the Converter is set to
18486 \begin_inset Quotes eld
18494 \begin_inset Quotes erd
18497 , with Flags set to
18498 \begin_inset Quotes eld
18503 originaldir,parselog=listerrors
18506 \begin_inset Quotes erd
18512 \begin_layout Subsubsection
18516 \begin_layout Standard
18517 There is also a new function implemented in the LyX server, the
18518 \begin_inset Quotes eld
18521 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18525 \begin_layout Standard
18526 When debugging code with ddd/gdb, it is possible to invoke a text editor
18527 at the current execution position with a single key stroke.
18528 The default ddd configuration for that is shift-ctrl-V.
18529 It happens that you can define the editor command line invocation in ddd
18535 dit\SpecialChar \menuseparator
18540 references\SpecialChar \menuseparator
18547 dialog and changing the "Edit Sources" entry.
18550 \begin_layout Standard
18551 I take advantage of the new created LyX server function and this ddd feature,
18553 \begin_inset Quotes eld
18557 \begin_inset Quotes erd
18563 \begin_layout LyX-Code
18564 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18567 \begin_layout Standard
18568 With this, whenever you are using ddd and find a point in the program that
18569 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18570 ddd you forward this information to LyX through the LyX server and then
18571 the LyX window will show the same file with the cursor at the same position
18572 ddd was pointing to.
18573 No more guessing or long scrolling to locate a point in the program back
18577 \begin_layout Standard
18578 Note however that you must enable the LyX server to get this feature working
18579 (it is disabled by default).
18580 You can enable it in
18592 ) by entering in the
18597 \begin_inset Quotes eld
18602 /home/<your-home-directory>/.lyx/lyxpipe
18605 \begin_inset Quotes erd
18611 \begin_layout Standard
18612 Read the LyX server documentation in the
18614 Customization Manual
18616 for further information.
18619 \begin_layout Subsubsection
18623 \begin_layout Standard
18624 There are six new buttons that can be added to your LyX toolbar.
18625 Five of these buttons are short cuts to layout styles:
18646 The last one is a short cut to the
18647 \begin_inset Quotes eld
18651 \begin_inset Quotes erd
18658 \begin_layout Standard
18659 LyX has a range of buttons that are available for tool bar customization.
18660 In my toolbar I like to combine the six short cuts above with two more:
18668 \SpecialChar \menuseparator
18676 \SpecialChar \menuseparator
18689 iew\SpecialChar \menuseparator
18697 Here is how it looks like:
18700 \begin_layout LyX-Code
18704 \begin_layout LyX-Code
18708 \begin_layout LyX-Code
18709 Icon "layout Standard"
18712 \begin_layout LyX-Code
18713 Icon "layout Section"
18716 \begin_layout LyX-Code
18717 Icon "layout LaTeX"
18720 \begin_layout LyX-Code
18721 Icon "layout LyX-Code"
18724 \begin_layout LyX-Code
18725 Icon "layout Scrap"
18728 \begin_layout LyX-Code
18732 \begin_layout LyX-Code
18736 \begin_layout LyX-Code
18737 Icon "buffer-typeset"
18740 \begin_layout LyX-Code
18741 Icon "build-program"
18744 \begin_layout LyX-Code
18748 \begin_layout LyX-Code
18752 \begin_layout LyX-Code
18756 \begin_layout LyX-Code
18760 \begin_layout LyX-Code
18764 \begin_layout Subsubsection
18765 Colors customization
18768 \begin_layout Standard
18769 There are a number of colors in LyX that can be customized in
18774 One of the things that bothers people is the LaTeX font color.
18775 The default color is red, since the scraps uses LaTeX font, and there is
18776 a lot of scraps in literate documents, you may get tired of seeing everything
18778 You can change it by going to the tabs
18787 \begin_layout Standard
18788 The next thing is the visible presence of the newline character in the screen.
18789 You can choose the color of this particular character and make it blend
18791 I recommend you choosing a color that is close to the background but not
18792 equal, that way you still can see it is there, but it is not bothering
18797 \begin_layout Chapter
18798 Secrets of the LaTeX Masters
18799 \begin_inset CommandInset label
18808 \begin_layout Standard
18809 Though LyX is a powerful tool, it cannot hope to support everything that
18810 can be done with pure TeX/LaTeX.
18811 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18812 as long as you are not afraid to use that
18813 \begin_inset Quotes eld
18817 \begin_inset Quotes erd
18820 button on the toolbar or add things to the LaTeX preamble.
18821 This section lists some tips, tricks, and otherwise cool ideas to give
18822 your document that extra little flair.
18825 Do try this at home
18827 , just start with something a little smaller and less important than your
18831 \begin_layout Standard
18832 Most ideas in this section require less common files in your LaTeX installation.
18833 If you have a system like teTeX, most will already be available.
18834 A few, however, will need to be downloaded from one of the CTAN archives.
18835 Often, there are several ways to do something, or several LaTeX style files
18836 which do the same thing.
18837 We do not endorse one choice over another, we simply claim that we have
18838 done a particular task with a particular file.
18839 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18842 \begin_layout Section
18846 \begin_layout Standard
18849 Lars Gullik Bjønnes
18852 \begin_layout Subsection
18856 \begin_layout Standard
18857 The aim for this chapter
18861 \begin_layout Plain Layout
18862 Editor's note: Lars' original chapter was a masterful description of how
18868 However, it was too long to flow smoothly in this document.
18869 I have therefore chosen to excerpt the most important sections here (sorry,
18870 Lars); you can read the original chapter (and more of the story!) in the
18873 examples/multicol.lyx
18881 is to show how the LaTeX package
18885 can be used in a LyX document.
18886 As LyX doesn't support the
18890 package natively yet, we have to use some small hacks.
18891 By reading this section it should be obvious how to do this.
18894 \begin_layout Subsection
18898 \begin_layout Standard
18903 package allows switching between one and multicolumn format on the same
18905 Footnotes are handled correctly (for the most part), but will be placed
18906 at the bottom of the page and not under each column.
18907 LaTeX's float mechanism, however, is partly disabled in the current implementat
18909 At the moment only page-wide floats can be used within the scope of the
18913 \begin_layout Subsection
18917 \begin_layout Subsubsection
18921 \begin_layout Standard
18922 If you want to have two columns in your text, you have use LaTeX mode to
18927 begin{multicols}{2}
18929 at the point where you want the two column layout to start, and then
18935 where you want it to end.
18939 \begin_layout Standard
18943 \begin_layout Plain Layout
18947 begin{multicols}{2}
18955 \begin_layout Standard
18960 The Adventure of the Empty House
18963 \begin_inset Newline newline
18968 Sir Arthur Conan Doyle
18971 \begin_layout Standard
18974 It was in the spring of the year 1894 that all London was interested, and
18975 the fashionable world dismayed, by the murder of the Honourable Ronald
18976 Adair under most unusual and inexplicable circumstances.
18977 The public has already learned those particulars of the crime which came
18978 out in the police investigation, but a good deal was suppressed upon that
18979 occasion, since the case for the prosecution was so overwhelmingly strong
18980 that it was not necessary to bring forward all the facts.
18981 Only now, at the end of nearly ten years, am I allowed to supply those
18982 missing links which make up the whole of that remarkable chain.
18983 The crime was of interest in itself, but that interest was as nothing to
18984 me compared to the inconceivable sequel, which afforded me the greatest
18985 shock and surprise of any event in my adventurous life.
18986 Even now, after this long interval, I find myself thrilling as I think
18987 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18988 ty which utterly submerged my mind.
18989 Let me say to that public, which has shown some interest in those glimpses
18990 which I have occasionally given them of the thoughts and actions of a very
18991 remarkable man, that they are not to blame me if I have not shared my knowledge
18992 with them, for I should have considered it my first duty to do so, had
18993 I not been barred by a positive prohibition from his own lips, which was
18994 only withdrawn upon the third of last month.
18997 \begin_layout Standard
19001 \begin_layout Plain Layout
19013 \begin_layout Subsubsection
19017 \begin_layout Standard
19018 The same pattern is used when you want more than two columns:
19021 \begin_layout Standard
19025 \begin_layout Plain Layout
19029 begin{multicols}{3}
19037 \begin_layout Standard
19040 It can be imagined that my close intimacy with Sherlock Holmes had interested
19041 me deeply in crime, and that after his disappearance I never failed to
19042 read with care the various problems which came before the public.
19043 And I even attempted, more than once, for my own private satisfaction,
19044 to employ his methods in their solution, though with indifferent success.
19045 There was none, however, which appealed to me like this tragedy of Ronald
19047 As I read the evidence at the inquest, which led up to a verdict of willful
19048 murder against some person or persons unknown, I realized more clearly
19049 than I had ever done the loss which the community had sustained by the
19050 death of Sherlock Holmes.
19051 There were points about this strange business which would, I was sure,
19052 have specially appealed to him, and the efforts of the police would have
19053 been supplemented, or more probably anticipated, by the trained observation
19054 and the alert mind of the first criminal agent in Europe.
19055 All day, as I drove upon my round, I turned over the case in my mind and
19056 found no explanation which appeared to me to be adequate.
19057 At the risk of telling a twice-told tale, I will recapitulate the facts
19058 as they were known to the public at the conclusion of the inquest.
19061 \begin_layout Standard
19065 \begin_layout Plain Layout
19077 \begin_layout Standard
19078 You can have more than 3 columns if you want to, but that might not be very
19079 pleasant for the eye.
19082 \begin_layout Subsubsection
19083 Columns inside columns
19086 \begin_layout Standard
19087 You can even have columns inside columns:
19090 \begin_layout Standard
19094 \begin_layout Plain Layout
19098 begin{multicols}{2}
19106 \begin_layout Standard
19109 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19110 at that time governor of one of the Australian colonies.
19111 Adair's mother had returned from Australia to undergo the operation for
19112 cataract, and she, her son Ronald, and her daughter Hilda were living together
19116 \begin_layout Standard
19120 \begin_layout Plain Layout
19124 begin{multicols}{2}
19132 \begin_layout Standard
19135 The youth moved in the best society--had, so far as was known, no enemies
19136 and no particular vices.
19137 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19138 had been broken off by mutual consent some months before, and there was
19139 no sign that it had left any very profound feeling behind it.
19140 For the rest {sic} the man's life moved in a narrow and conventional circle,
19141 for his habits were quiet and his nature unemotional.
19142 Yet it was upon this easy-going young aristocrat that death came, in most
19143 strange and unexpected form, between the hours of ten and eleven-twenty
19144 on the night of March 30, 1894.
19147 \begin_layout Standard
19151 \begin_layout Plain Layout
19163 \begin_layout Standard
19166 Ronald Adair was fond of cards--playing continually, but never for such
19167 stakes as would hurt him.
19168 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19169 It was shown that, after dinner on the day of his death, he had played
19170 a rubber of whist at the latter club.
19171 He had also played there in the afternoon.
19176 The evidence of those who had played with him-- Mr.
19177 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19178 and that there was a fairly equal fall of the cards.
19179 Adair might have lost five pounds, but not more.
19180 His fortune was a considerable one, and such a loss could not in any way
19182 He had played nearly every day at one club or other, but he was a cautious
19183 player, and usually rose a winner.
19184 It came out in evidence that, in partnership with Colonel Moran, he had
19185 actually won as much as four hundred and twenty pounds in a sitting, some
19186 weeks before, from Godfrey Milner and Lord Balmoral.
19187 So much for his recent history as it came out at the inquest.
19190 \begin_layout Standard
19194 \begin_layout Plain Layout
19206 \begin_layout Standard
19207 Please do read the file
19209 examples/multicol.lyx
19211 for more advanced examples including column and header spacing, vertical
19212 separator lines, and more.
19215 \begin_layout Section
19220 Paragraph Environment
19221 \begin_inset OptArg
19224 \begin_layout Plain Layout
19225 Numbering in Enumerate
19233 \begin_layout Standard
19239 \begin_layout Standard
19240 \begin_inset VSpace bigskip
19246 \begin_layout Standard
19248 The default numbering for the
19252 paragraph environment begins with Arabic numbers and ends with uppercase
19254 Suppose, however, you wanted a different type of numbering scheme.
19255 Here's a quickie example of how to change the numbering scheme:
19258 \begin_layout LyX-Code
19268 \begin_layout LyX-Code
19278 \begin_layout LyX-Code
19288 \begin_layout LyX-Code
19298 \begin_layout Standard
19299 \SpecialChar \ldots{}
19300 which changes the numbering scheme to uppercase Roman numerals, uppercase
19301 letters, Arabic numbers, and lowercase letter.
19304 \begin_layout Standard
19305 Additionally, the previous example also adds a little bit extra to the numbering
19307 For example, the first level label actually looks like:
19308 \begin_inset Quotes eld
19312 \begin_inset Quotes erd
19316 For ease of reading, we'll describe what the numbering schemes look like
19317 using a notation something like this: <
19318 \begin_inset Quotes eld
19322 \begin_inset Quotes erd
19326 \begin_inset space ~
19330 \begin_inset Quotes erd
19334 \begin_inset Quotes erd
19338 \begin_inset space ~
19342 \begin_inset Quotes erd
19346 \begin_inset Quotes erd
19350 \begin_inset space ~
19354 \begin_inset Quotes eld
19358 \begin_inset Quotes erd
19365 \begin_layout Standard
19366 As you can see in the example, there is a label command for each nesting
19373 \SpecialChar \ldots{}
19380 , as well as a counter,
19384 \SpecialChar \ldots{}
19390 There are also five
19391 \begin_inset Quotes eld
19395 \begin_inset Quotes erd
19428 , each of which take one counter as an argument.
19429 You can add characters before or after these, but there's no need to add
19433 \begin_layout Standard
19434 You can get really fancy with these.
19438 \begin_layout LyX-Code
19452 \begin_layout LyX-Code
19464 \begin_layout LyX-Code
19474 \begin_layout LyX-Code
19484 \begin_layout Standard
19485 produces the somewhat out of hand numbering scheme: <
19486 \begin_inset Quotes eld
19490 \begin_inset Quotes erd
19494 \begin_inset space ~
19498 \begin_inset Quotes erd
19502 \begin_inset Quotes erd
19506 \begin_inset space ~
19510 \begin_inset Quotes erd
19514 \begin_inset Quotes erd
19518 \begin_inset space ~
19522 \begin_inset Quotes eld
19526 \begin_inset Quotes erd
19533 \begin_layout Standard
19537 \begin_layout Section
19541 \begin_layout Standard
19547 \begin_layout Standard
19548 \begin_inset VSpace bigskip
19554 \begin_layout Standard
19559 \begin_layout Plain Layout
19565 tmpfont}{cmr17 scaled 2500}{
19577 \begin_layout Standard
19582 \begin_layout Plain Layout
19593 hose of you who like the style of old books probably also like
19594 \begin_inset Quotes eld
19598 \begin_inset Quotes erd
19601 ---those large capital letters which begin each new chapter or section.
19602 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19603 know some plain TeX!) but does require a lot of work and many iterations,
19604 as you can see by all the ugly TeX-mode stuff at the beginning of this
19608 \begin_layout Standard
19612 \begin_layout Plain Layout
19618 bigdrop{-1em}{3}{ptmri}{T}+
19623 here is a much easier way of doing this, of course.
19632 ) package from CTAN allows a simple way to add such letters to your documents.
19633 Since this package is not a standard part of teTeX, I can't demonstrate
19634 it within this document, but if you copy this paragraph to a new document,
19636 \begin_inset Quotes eld
19646 \begin_inset Quotes erd
19649 and the pluses from the TeX code at the beginning of the paragraph, and
19654 usepackage{dropcaps}
19656 to your LaTeX preamble, you will get a nice Times Roman Italic
19657 \begin_inset Quotes eld
19661 \begin_inset Quotes erd
19664 , whose height is three lines of text and which protrudes 1 em into the
19666 (Make certain you have copied
19667 \begin_inset Quotes eld
19675 \begin_inset Quotes erd
19678 into a directory where TeX can see it.) The first argument is the amount
19679 of indentation; in this case the negative sign moves it into the margin.
19680 The second argument is the height of the letter in number of lines of text.
19681 The third argument is the font name: virtually anything which has a tfm
19682 file should work (wade through the
19684 .../texmf/fonts/tfm
19686 directory for possibilities).
19687 My personal favorite is
19688 \begin_inset Quotes eld
19696 \begin_inset Quotes erd
19699 , a fancy German font specifically designed for dropped capitals.
19700 The fourth argument is the letter (or letters) to be dropped.
19705 package also offers the
19711 command, as well as a slightly simplified
19720 \begin_layout Section
19721 Non-standard Paragraph Shapes
19724 \begin_layout Standard
19730 \begin_layout Standard
19731 \begin_inset VSpace bigskip
19737 \begin_layout Standard
19741 \begin_layout Plain Layout
19753 \begin_layout Standard
19757 \begin_layout Plain Layout
19766 \begin_layout Plain Layout
19780 \begin_layout Standard
19785 \begin_layout Plain Layout
19796 \begin_layout Plain Layout
19805 \begin_layout Plain Layout
19814 \begin_layout Plain Layout
19823 \begin_layout Plain Layout
19832 \begin_layout Plain Layout
19841 \begin_layout Plain Layout
19850 \begin_layout Plain Layout
19859 \begin_layout Plain Layout
19868 \begin_layout Plain Layout
19877 \begin_layout Plain Layout
19886 \begin_layout Plain Layout
19895 \begin_layout Plain Layout
19904 \begin_layout Plain Layout
19913 \begin_layout Plain Layout
19922 \begin_layout Plain Layout
19931 \begin_layout Plain Layout
19940 \begin_layout Plain Layout
19949 \begin_layout Plain Layout
19958 \begin_layout Plain Layout
19964 There are times when the tyranny of rectangular paragraphs must be overthrown.
19965 In such situations, a call to the delightful plain TeX command
19972 As you can see, completely arbitrary shapes can be laid out with a suitable
19973 set of linelength definitions.
19974 While this parshape may look a bit silly and useless, one could conceive
19975 of situations such as finely tuned dropped capitals, word wrapping around
19976 non-rectangular graphics, etc.
19977 which will benefit from such handcrafting.
19980 \begin_layout Standard
19981 \begin_inset VSpace bigskip
19987 \begin_layout Standard
19992 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19999 is the number of lines of text which define the paragraph.
20000 If there turn out to be fewer lines, the shape is truncated; if there are
20001 more, the excess lines have the same dimensions as the last line of the
20011 entries specify the indentation of the line from the left margin, and the
20012 length of the line as measured from that point.
20013 The shape applies only to the current paragraph; everything is reset to
20014 normal for the next paragraph.
20017 \begin_layout Standard
20021 \begin_layout Plain Layout
20033 \begin_layout Section
20037 \begin_layout Standard
20038 As you can see, the examples in this section range from the useful to the
20040 While I don't expect that anyone will ever need the paragraph shape demonstrate
20041 d in the last section, the important point is that you can do almost anything
20042 you want in LyX if you are willing to figure out how to do it in TeX and
20044 TeX is a fantastically powerful typesetting system and all that power is
20045 available to you since LyX uses it as its backend.