1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \use_default_options false
56 InsetLayout CharStyle:MenuItem
65 \newcommand*{\menuitem}[1]{{\sffamily #1}}
73 \font_typewriter default
74 \font_default_family default
84 \pdf_title "LyX's Extended manual"
85 \pdf_author "LyX Team"
86 \pdf_subject "LyX's extended documentation"
87 \pdf_keywords "LyX, Documentation, Extended"
89 \pdf_bookmarksnumbered true
90 \pdf_bookmarksopen false
91 \pdf_bookmarksopenlevel 1
96 \pdf_pdfusetitle false
97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
104 \paperorientation portrait
107 \paragraph_separation indent
109 \quotes_language english
112 \paperpagestyle headings
113 \tracking_changes false
114 \output_changes false
122 Additional LyX Features
130 \begin_layout Plain Layout
132 Principal maintainer of this file is
137 If you have comments or error corrections, please send them to the LyX
138 Documentation mailing list,
139 \begin_inset Flex CharStyle:Code
142 \begin_layout Plain Layout
144 <lyx-docs@lists.lyx.org>
157 \begin_layout Standard
158 \begin_inset CommandInset toc
159 LatexCommand tableofcontents
166 \begin_layout Chapter
170 \begin_layout Standard
171 This manual is essentially Part II of the
173 User's Guide\SpecialChar \@.
176 The reason for separating this document out is simple: the
180 is already quite lengthy, and it contains information on all of the basic
181 features one needs to know in order to prepare most documents.
182 However, the LyX Team has worked to LyX extensible through various configuratio
183 n files and external packages.
184 That means that if you want to support the Fizzwizzle LaTeX package, you
185 can create a layout file (or module) for it without having to alter LyX
187 We've already had contributions of several new features this way.
188 This is the place where all of those get documented.
191 \begin_layout Standard
192 This manual also documents some special features, like fax support, version
193 control, and SGML support, which require additional software to work properly.
194 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
195 spruce up your documents by directly using the powerful features of LaTeX.
200 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
203 \begin_layout Standard
204 If you haven't read the
208 yet, you are definitely in the wrong manual.
213 is the first place to go, since it describes the notation and format of
215 You should also be thoroughly familiar with the
219 and all of the basic features of LyX before attempting to read this one.
222 \begin_layout Standard
223 Since all the topics in this manual depend heavily on LyX's interaction
224 with LaTeX, this first chapter covers the inner workings of LyX and how
225 to direct LyX to generate exactly the LaTeX code you want.
226 It is obviously for more seasoned LyX users.
229 \begin_layout Chapter
233 \begin_layout Section
237 \begin_layout Standard
238 This chapter is for both TeX-nicians and the LaTeX-curious.
239 In it, we'll explain how LyX and LaTeX work together to produce printable
241 This is the only place in any of the manuals where we assume you know something
245 \begin_layout Standard
246 At one time, LyX was called a
247 \begin_inset Quotes eld
250 WYSIWYM frontend to LaTeX,
251 \begin_inset Quotes erd
254 but that's no longer true.
255 There are frontends to LaTeX out there.
259 \begin_layout Plain Layout
260 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
261 There are also the LaTeX modes for vi and emacs, of course.
266 These are basically text editors with the ability to run LaTeX and mark
267 any errors in the file you're editing.
276 run LaTeX, and it also indicates errors in the file, it also does much,
278 For one thing, you don't need to know LaTeX to use LyX effectively.
279 And LyX has added its own extensions to LaTeX.
280 Try the following sometime: select
281 \begin_inset Flex CharStyle:MenuItem
284 \begin_layout Plain Layout
285 Export\SpecialChar \menuseparator
292 \begin_inset Flex CharStyle:MenuItem
295 \begin_layout Plain Layout
306 \begin_inset Flex CharStyle:MenuItem
309 \begin_layout Plain Layout
310 View\SpecialChar \menuseparator
316 ), then look at the preamble of the resulting
317 \begin_inset Flex CharStyle:Code
320 \begin_layout Plain Layout
327 You'll notice a variety of new macros defined specifically by LyX.
328 These macros are defined automatically, according to the features you use
332 \begin_layout Standard
333 There are several commands that automatically invoke LaTeX.
337 \begin_layout Itemize
340 \begin_inset Flex CharStyle:MenuItem
343 \begin_layout Plain Layout
348 iew\SpecialChar \menuseparator
359 \begin_layout Itemize
362 \begin_inset Flex CharStyle:MenuItem
365 \begin_layout Plain Layout
370 iew\SpecialChar \menuseparator
375 pdate\SpecialChar \menuseparator
386 \begin_layout Itemize
389 \begin_inset Flex CharStyle:MenuItem
392 \begin_layout Plain Layout
399 \SpecialChar \menuseparator
410 \begin_layout Itemize
413 \begin_inset Flex CharStyle:MenuItem
416 \begin_layout Plain Layout
423 \SpecialChar \menuseparator
434 \begin_layout Standard
435 They will only invoke LaTeX if the file has changed since the last time
440 \begin_layout Standard
441 When LyX runs LaTeX on the file you're editing, it performs these steps:
444 \begin_layout Enumerate
445 Convert the document to LaTeX and save to a file with the extension
446 \begin_inset Flex CharStyle:Code
449 \begin_layout Plain Layout
456 \begin_inset Flex CharStyle:Code
459 \begin_layout Plain Layout
468 \begin_layout Enumerate
470 \begin_inset Flex CharStyle:Code
473 \begin_layout Plain Layout
479 file (maybe several times), and run any other commands (such as
480 \begin_inset Flex CharStyle:Code
483 \begin_layout Plain Layout
490 \begin_inset Flex CharStyle:Code
493 \begin_layout Plain Layout
499 ) needed to compile the LaTeX file.
502 \begin_layout Enumerate
503 If there are any errors, show the error log.
506 \begin_layout Standard
507 If you've run LaTeX using
508 \begin_inset Flex CharStyle:MenuItem
511 \begin_layout Plain Layout
514 \SpecialChar \menuseparator
522 , LyX then runs a DVI viewer to display the DVI-file.
524 \begin_inset Flex CharStyle:MenuItem
527 \begin_layout Plain Layout
530 \SpecialChar \menuseparator
538 , LyX performs further steps:
541 \begin_layout Itemize
543 \begin_inset Flex CharStyle:Code
546 \begin_layout Plain Layout
552 to convert the DVI file to PostScript®.
555 \begin_layout Itemize
556 Run a PostScript® viewer, such as
557 \begin_inset Flex CharStyle:Code
560 \begin_layout Plain Layout
566 , to display the PostScript® file.
569 \begin_layout Standard
570 LyX does similar things when viewing, or exporting, other formats.
573 \begin_layout Section
574 Translating LaTeX files into LyX
577 \begin_layout Standard
578 You can import a LaTeX file into LyX by using the
579 \begin_inset Flex CharStyle:MenuItem
582 \begin_layout Plain Layout
587 ile\SpecialChar \menuseparator
592 mport\SpecialChar \menuseparator
603 This will call a program named
604 \begin_inset Flex CharStyle:Code
607 \begin_layout Plain Layout
613 which will create a file
614 \begin_inset Flex CharStyle:Code
617 \begin_layout Plain Layout
624 \begin_inset Flex CharStyle:Code
627 \begin_layout Plain Layout
634 LyX will then open that file.
638 \begin_layout Plain Layout
639 \begin_inset Flex CharStyle:Code
642 \begin_layout Plain Layout
648 can also be run from the command line, of course.
656 \begin_layout Standard
657 \begin_inset Flex CharStyle:Code
660 \begin_layout Plain Layout
666 will translate most legal LaTeX, but not everything.
667 It will put things it doesn't understand into ERT, so after translating
669 \begin_inset Flex CharStyle:Code
672 \begin_layout Plain Layout
678 , you can look for ERT and hand-edit it until it looks right.
681 \begin_layout Standard
682 If you don't know what ERT is, read the next section.
685 \begin_layout Section
686 \begin_inset CommandInset label
688 name "sec:Inserting-TeX-Code"
692 Inserting TeX Code into LyX Documents
695 \begin_layout Standard
696 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
697 You can always insert TeX code into any LyX document.
698 LyX cannot, and will never be able to, display every possible LaTeX construct.
699 If ever you need to insert LaTeX commands into your LyX document, you can
701 \begin_inset Flex CharStyle:Code
704 \begin_layout Plain Layout
710 box, which you can insert into your document with
711 \begin_inset Flex CharStyle:MenuItem
714 \begin_layout Plain Layout
715 Insert\SpecialChar \menuseparator
724 \begin_layout Standard
725 Here's an example of inserting LaTeX commands in a LyX document.
726 The code looks like this:
729 \begin_layout LyX-Code
733 \begin_inset Newline newline
739 \begin_inset Newline newline
742 This is an example for a minipage environment.
744 \begin_inset Newline newline
747 can put nearly everything in it, even (non-floating)
748 \begin_inset Newline newline
753 \begin_inset Newline newline
759 \begin_inset Newline newline
763 \begin_inset Newline newline
769 \begin_inset Newline newline
775 \begin_inset Newline newline
781 \begin_inset Newline newline
786 \begin_inset Newline newline
792 \begin_inset Newline newline
798 \begin_inset Newline newline
804 \begin_inset Newline newline
812 \begin_layout LyX-Code
816 \begin_layout Standard
818 \begin_inset Flex CharStyle:Code
821 \begin_layout Plain Layout
827 box containing this text is directly after this paragraph.
828 Those of you reading the manual in LyX will only see the ERT inset.
829 Those reading a printed version of the manuals will see the actual results:
832 \begin_layout Standard
836 \begin_layout Plain Layout
843 \begin_layout Plain Layout
850 \begin_layout Plain Layout
852 This is an example for a minipage environment.
853 You can put nearly everything in it, even (non-floating) figures and tables.
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
869 \begin_layout Plain Layout
876 \begin_layout Plain Layout
883 \begin_layout Plain Layout
890 \begin_layout Plain Layout
896 \begin_layout Plain Layout
903 \begin_layout Plain Layout
910 \begin_layout Plain Layout
917 \begin_layout Plain Layout
929 \begin_layout Standard
930 In addition to using ERT, you can also create a separate file containing
931 some complex LaTeX structure and then use
932 \begin_inset Flex CharStyle:MenuItem
935 \begin_layout Plain Layout
936 Insert\SpecialChar \menuseparator
946 to include your file (you should select the type
947 \begin_inset Flex CharStyle:Code
950 \begin_layout Plain Layout
957 We recommend that you only do this if you have a
958 \begin_inset Flex CharStyle:Code
961 \begin_layout Plain Layout
972 Otherwise, you'll have a big job tracking down LaTeX errors.
975 \begin_layout Standard
976 There are a few last points to emphasize:
979 \begin_layout Itemize
984 check if your LaTeX code is correct.
987 \begin_layout Itemize
988 Beware reinventing the wheel.
991 \begin_layout Standard
992 On that last point, LyX does have quite a few features tucked into it, and
994 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
995 feature before you decide you have to do it by hand.
996 Moreover, there are numerous LaTeX packages out there to do all sorts of
997 things, from labels to envelopes to fancy multipage tables.
999 \begin_inset CommandInset href
1002 target "http://www.ctan.org/"
1006 for details, and see chapter
1007 \begin_inset CommandInset ref
1009 reference "cha:secrets"
1016 \begin_layout Standard
1017 If you do need to do some wild and fancy things within your document, be
1018 sure to check out a good LaTeX book for assistance.
1019 There are a number of them listed in the bibliography of the
1026 \begin_layout Section
1027 LyX and the LaTeX Preamble
1030 \begin_layout Subsection
1031 About the LaTeX Preamble
1034 \begin_layout Standard
1035 If you already know LaTeX, there is no need to explain here what the preamble
1037 If you don't, the following will give you some ideas---we recommend again
1038 that you consult a LaTeX book for further information.
1039 In any case, you should read the points below, because they explain what
1040 you can do and what you don't need to do in the LaTeX preamble of a LyX
1044 \begin_layout Standard
1045 The LaTeX preamble comes at the very beginning of a document,
1053 \begin_layout Itemize
1054 Declare the document class.
1056 \begin_inset Newline newline
1059 LyX already does this for you.
1060 If you're a seasoned LaTeX-nician, and you have a custom document class
1061 you want to use, check out the
1063 Customization Manual
1065 for information on how to make LyX interface to it.
1068 \begin_layout Itemize
1069 Declare the usage of packages.
1071 \begin_inset Newline newline
1074 LaTeX packages provide special commands, which are only available within
1075 a document when the package has been declared in the preamble.
1076 For example, the package
1077 \begin_inset Flex CharStyle:Code
1080 \begin_layout Plain Layout
1086 forces all paragraphs to be indented.
1087 There are other packages for labels, envelopes, margins, etc.
1091 \begin_layout Itemize
1092 Set counters, variables, lengths and widths.
1094 \begin_inset Newline newline
1097 There are several LaTeX counters and variables which
1101 be set globally from within the preamble in order to have the desired effect.
1102 (There are variables which you can set and reset inside the document, too.)
1103 Margins are a good example of something which must be set in the preamble.
1104 Another example is the label format for lists.
1105 You can actually set these just about anywhere, but it's best to do it
1106 just once, inside the preamble.
1109 \begin_layout Itemize
1110 Declare user defined commands (with
1111 \begin_inset Flex CharStyle:Code
1114 \begin_layout Plain Layout
1123 \begin_inset Flex CharStyle:Code
1126 \begin_layout Plain Layout
1135 \begin_inset Newline newline
1138 These are abbreviations for LaTeX commands which appear very often inside
1140 Although the preamble is a good place to declare such commands, they
1144 be declared anywhere (before they are used for the first time, of course).
1145 This can be useful if there is a lot of raw LaTeX code in your document,
1146 which normally should not be the case.
1149 \begin_layout Standard
1150 LyX adds its own set of definitions to the preamble of the
1151 \begin_inset Flex CharStyle:Code
1154 \begin_layout Plain Layout
1161 This makes LaTeX files generated by LyX portable.
1164 \begin_layout Subsection
1165 Changing the Preamble
1168 \begin_layout Standard
1169 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1170 can't change them without patching LyX itself.
1171 You can, however, add your own stuff to the preamble by selecting
1172 \begin_inset Flex CharStyle:MenuItem
1175 \begin_layout Plain Layout
1181 \begin_inset space ~
1194 \begin_inset Flex CharStyle:MenuItem
1197 \begin_layout Plain Layout
1202 ocument\SpecialChar \menuseparator
1213 LyX adds anything in the
1214 \begin_inset Flex CharStyle:MenuItem
1217 \begin_layout Plain Layout
1223 dialog to its own built-in preamble.
1224 Before adding your own declarations in the preamble, you should make sure
1225 that LyX doesn't already support what you want to do.
1226 (Remember what we said about reinventing the wheel?) Also,
1228 make sure your preamble code is correct
1231 LyX doesn't check it for you.
1232 If there is an error, you're likely to get an error like
1233 \begin_inset Quotes eld
1237 \begin_inset Flex CharStyle:Code
1240 \begin_layout Plain Layout
1249 \begin_inset Quotes erd
1253 If you see this error, check your preamble.
1256 \begin_layout Subsection
1260 \begin_layout Standard
1261 Here are some examples of what you can add to a preamble, and what they
1265 \begin_layout Subsubsection
1269 \begin_layout Standard
1270 There are two variables under LaTeX that control page position:
1271 \begin_inset Flex CharStyle:Code
1274 \begin_layout Plain Layout
1283 \begin_inset Flex CharStyle:Code
1286 \begin_layout Plain Layout
1295 Their names should be self-explanatory.
1296 These variables are useful if you think for a moment about computer labels.
1297 Sometimes, the size of a print medium and the area of the medium that you
1298 can actually print on aren't the same.
1300 \begin_inset Flex CharStyle:Code
1303 \begin_layout Plain Layout
1312 \begin_inset Flex CharStyle:Code
1315 \begin_layout Plain Layout
1326 \begin_layout Standard
1327 The default values for
1328 \begin_inset Flex CharStyle:Code
1331 \begin_layout Plain Layout
1340 \begin_inset Flex CharStyle:Code
1343 \begin_layout Plain Layout
1351 are both 0 points, i.e., the page isn't shifted.
1352 Unfortunately, some DVI drivers always seem to shift the page.
1353 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1354 If you're using LyX on a system that you don't personally maintain, and
1355 your sysadmin is a doofus,
1356 \begin_inset Flex CharStyle:Code
1359 \begin_layout Plain Layout
1368 \begin_inset Flex CharStyle:Code
1371 \begin_layout Plain Layout
1380 Suppose you're left and top margins are always 0.5 inches too big.
1381 You can add this to the preamble:
1384 \begin_layout LyX-Code
1392 \begin_layout LyX-Code
1400 \begin_layout Standard
1401 and your margins should now be correct.
1404 \begin_layout Subsubsection
1408 \begin_layout Standard
1409 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1410 There's a rather nice package, available at your nearest CTAN archive,
1411 for printing sheets of labels:
1412 \begin_inset Flex CharStyle:Code
1415 \begin_layout Plain Layout
1422 Now, your system may not have this package installed by default.
1423 We leave that up to you to check.
1424 You'll also want to read the documentation for it; we're not going to do
1426 Since this is an example, however, we'll give you an example of how you
1430 \begin_layout Standard
1431 First, make sure you're using the
1432 \begin_inset Flex CharStyle:Code
1435 \begin_layout Plain Layout
1442 Next, you need to put the following in your preamble:
1445 \begin_layout LyX-Code
1451 \begin_layout LyX-Code
1457 \begin_layout LyX-Code
1463 \begin_layout LyX-Code
1469 \begin_layout LyX-Code
1475 \begin_layout LyX-Code
1481 \begin_layout LyX-Code
1487 \begin_layout Standard
1488 This sets things up for Avery® label sheets, stock #5360.
1489 You're now ready to print labels, but you'll need to insert LaTeX code,
1490 placing the commands
1491 \begin_inset Flex CharStyle:Code
1494 \begin_layout Plain Layout
1503 \begin_inset Flex CharStyle:Code
1506 \begin_layout Plain Layout
1514 around each label text.
1515 This and other special features of
1516 \begin_inset Flex CharStyle:Code
1519 \begin_layout Plain Layout
1525 are explained in its documentation.
1528 \begin_layout Standard
1529 Someday, someone may write a LyX layout file to support this package directly.
1530 Maybe that someone is you.
1533 \begin_layout Subsubsection
1534 Example #3: Paragraph Indentation
1537 \begin_layout Standard
1538 Americans are trained to indent the first line of
1543 As with all of their other weird quirks, most Americans will whine and
1544 moan until they can have their way and indent the first line of all paragraphs.
1553 \begin_layout Standard
1554 Of course, this behavior isn't standard typography.
1555 In books, you typically only indent the first line of a paragraph
1559 it follows another one.
1560 The idea behind indenting the first line of a paragraph is to distinguish
1561 neighboring paragraphs from one another.
1562 If there is no previous paragraph---for example, if it follows a figure
1563 or is the first paragraph in a section---then there is no need for indentation.
1567 \begin_layout Standard
1568 If you're a typical American (we're still joking!), though, you don't care
1569 about such esoteric things; you want your indentation! Add this to the
1573 \begin_layout LyX-Code
1576 usepackage{indentfirst}
1579 \begin_layout Standard
1580 If your TeX distribution isn't braindead, you'll have this package, and
1581 all of your paragraphs will get the indentation the Founding Fathers intended
1585 \begin_layout Subsubsection
1586 Example #4: This Document
1589 \begin_layout Standard
1590 You can also check out the preamble of this document to get an idea of some
1591 of the advanced things you can do.
1592 Also, there are more examples and an assortment of LaTeX
1593 \begin_inset Quotes eld
1597 \begin_inset Quotes erd
1601 \begin_inset space ~
1605 \begin_inset CommandInset ref
1607 reference "cha:secrets"
1615 \begin_layout Section
1616 LyX and LaTeX Errors
1619 \begin_layout Standard
1620 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1622 It then uses the logfile from the LaTeX run to do a post-mortem.
1623 After analyzing the logfile,LyX displays a dialog listing the errors.
1624 Clicking on any one of them will take you to the position in your LyX file
1625 where the error occurred.
1629 \begin_layout Plain Layout
1631 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1633 There are also cases where LaTeX reports the error on one line, but the
1634 actual error is earlier.
1635 This is not unlike forgetting a closing brace in a program: You'll get
1636 an error, but only later.
1644 \begin_layout Standard
1645 Some folks also like to look at the log file directly: It is available from
1647 \begin_inset Flex CharStyle:MenuItem
1650 \begin_layout Plain Layout
1653 \SpecialChar \menuseparator
1657 \begin_inset space ~
1666 There are some fairly common error messages and warnings.
1667 We'll cover those here.
1668 You should look at a good LaTeX book for a complete listing.
1671 \begin_layout Itemize
1672 \begin_inset Flex CharStyle:Code
1675 \begin_layout Plain Layout
1682 \begin_inset Newline newline
1685 Anything beginning with these words is a warning message for the purpose
1687 \begin_inset Quotes eld
1691 \begin_inset Quotes erd
1694 the LaTeX code itself.
1695 You'll get messages like this if you added or changed cross-references
1696 or bibliography entries, in which case, LaTeX is trying to tell you that
1697 you need to make another run.
1698 You can by-and-large ignore these.
1701 \begin_layout Itemize
1702 \begin_inset Flex CharStyle:Code
1705 \begin_layout Plain Layout
1712 \begin_inset Newline newline
1715 Another warning message, this time about fonts which LaTeX couldn't find.
1716 The rest of the message will often say something about a replacement font
1718 You can safely ignore these, too.
1721 \begin_layout Itemize
1722 \begin_inset Flex CharStyle:Code
1725 \begin_layout Plain Layout
1734 \begin_inset Newline newline
1742 They are warnings about lines that were too long and run past the right
1744 Almost always, this is unnoticeable in the final output.
1745 (It can be just a point or two.) Or, only one or two characters extend past
1747 LaTeX seems to generate at least one of these messages for just about any
1749 \begin_inset Newline newline
1752 You can ignore these messages.
1753 Your eyes will tell you if there's a problem with something that's too
1754 wide; just look at the output.
1758 \begin_layout Plain Layout
1759 You can also enable the `draft' option in
1760 \begin_inset Flex CharStyle:MenuItem
1763 \begin_layout Plain Layout
1766 \SpecialChar \menuseparator
1774 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1782 \begin_layout Itemize
1783 \begin_inset Flex CharStyle:Code
1786 \begin_layout Plain Layout
1795 \begin_inset Newline newline
1798 Not quite as common as its cousin.
1799 LaTeX seems to like to print lines that are a bit too wide as opposed to
1800 ones that are a bit too narrow.
1801 We have no idea why.
1804 \begin_layout Itemize
1805 \begin_inset Flex CharStyle:Code
1808 \begin_layout Plain Layout
1817 \begin_inset Flex CharStyle:Code
1820 \begin_layout Plain Layout
1829 \begin_inset Newline newline
1832 Warnings about troubles breaking the page.
1833 Once again, just look at the output.
1834 Your eyes will tell you where something has gone wrong.
1837 \begin_layout Itemize
1838 \begin_inset Flex CharStyle:Code
1841 \begin_layout Plain Layout
1843 \begin_inset Quotes els
1847 \begin_inset Quotes ers
1856 \begin_inset Newline newline
1860 \begin_inset Quotes eld
1864 \begin_inset Quotes erd
1867 isn't installed on this system.
1868 This usually appears because some package your document needs isn't installed.
1869 If you didn't touch the preamble or didn't use the
1870 \begin_inset Flex CharStyle:Code
1873 \begin_layout Plain Layout
1881 command, then one of the packages LyX tried to load is missing.
1883 \begin_inset Flex CharStyle:MenuItem
1886 \begin_layout Plain Layout
1887 Help\SpecialChar \menuseparator
1893 to get a list of packages that LyX knows about.
1894 This file is updated whenever you reconfigure LyX (using
1895 \begin_inset Flex CharStyle:MenuItem
1898 \begin_layout Plain Layout
1899 Tools\SpecialChar \menuseparator
1905 ) and tells you which packages have been detected and what they do.
1906 \begin_inset Newline newline
1910 \begin_inset Flex CharStyle:Code
1913 \begin_layout Plain Layout
1921 command and the package in question isn't installed, then you'll need to
1922 install it yourself.
1925 \begin_layout Itemize
1926 \begin_inset Flex CharStyle:Code
1929 \begin_layout Plain Layout
1930 LaTeX Error: Unknown option
1936 \begin_inset Newline newline
1939 Error messages beginning with this are trying to tell you that you specified
1940 a bad or undefined option to a package.
1941 Check the package's documentation.
1944 \begin_layout Itemize
1945 \begin_inset Flex CharStyle:Code
1948 \begin_layout Plain Layout
1949 Undefined control sequence
1955 \begin_inset Newline newline
1958 If you've inserted LaTeX code into your document, but made a typo, you'll
1960 You may have forgotten to load a package.
1961 In any case, this error message usually means that you used an undefined
1966 \begin_layout Standard
1967 There are other error and warning messages.
1968 Some are self-explanatory.
1969 These are usually LaTeX messages.
1970 Others are downright cryptic.
1971 These are usually TeX error messages, and we really have
1975 what they mean or how to decipher them.
1979 \begin_layout Standard
1980 There's a general sequence you should follow if you get error messages:
1983 \begin_layout Enumerate
1984 Look at the LaTeX code you inserted for typos.
1987 \begin_layout Enumerate
1988 If there are no typos, check that you used the command(s) correctly.
1991 \begin_layout Enumerate
1992 If you get a bunch of error boxes piled up at the very top of the document---and
1993 especially if you see a
1994 \begin_inset Quotes eld
1998 \begin_inset Flex CharStyle:Code
2001 \begin_layout Plain Layout
2010 \begin_inset Quotes erd
2013 error---it means that there are errors in the preamble.
2014 Start debugging your preamble.
2017 \begin_layout Enumerate
2018 If you didn't add anything to the preamble and didn't add any LaTeX code
2019 to the document, the first suspect is your LaTeX distribution itself.
2020 Check for missing packages and install them.
2023 \begin_layout Enumerate
2024 Okay, so there are no missing packages.
2025 Did you use any of the fine-tuning options in LyX? Specifically, did you
2030 any of them, like trying to manually insert lots of
2031 \begin_inset Flex CharStyle:Code
2034 \begin_layout Plain Layout
2036 \begin_inset space ~
2045 \begin_inset Flex CharStyle:Code
2048 \begin_layout Plain Layout
2055 \begin_inset Flex CharStyle:Code
2058 \begin_layout Plain Layout
2064 ? Did you try to kludge something together with these instead of using the
2065 appropriate paragraph environment?
2068 \begin_layout Enumerate
2069 All right, you didn't use any of the fine-tuning options, you played by
2071 Did you try to pull a fancy maneuver? Did you do something funky inside
2072 a table or an equation, like inserting a graphic into a table cell?
2075 \begin_layout Enumerate
2076 Do you have long sections of text where LaTeX cannot find a place to break
2077 a line? By default, LaTeX is rather strict about how much extra inter-word
2078 spacing it will add in order to break a line.
2079 Preferably, you should rework the paragraph to avoid the problem.
2080 If this isn't an option, you can wrap your text in
2081 \begin_inset Flex CharStyle:Code
2084 \begin_layout Plain Layout
2092 to make LaTeX's line breaking more, well, sloppy.
2095 \begin_layout Enumerate
2096 Did you go overboard with the nesting? LyX (currently) doesn't check to
2097 make sure you're in the limits for nesting environments.
2098 If you nested a bunch of environments to the
2099 \begin_inset Formula $17^{\mathrm{th}}$
2102 level, that's the problem.
2103 (The limit in LaTeX is five.)
2106 \begin_layout Enumerate
2107 Okay, you didn't get any error messages, but your output looks awful.
2108 If you have a table or figure that's too wide or long for the page, you
2113 \begin_layout Enumerate
2114 rescale the figure so it fits.
2117 \begin_layout Enumerate
2118 trim down the table so it fits.
2122 \begin_layout Enumerate
2123 If something else is wrong with the output, and you didn't try to pull anything
2124 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2127 \begin_layout Standard
2128 If all this doesn't help---well, then
2132 you might have found a bug in LyX\SpecialChar \ldots{}
2136 \begin_layout Chapter
2140 \begin_layout Section
2141 Customizing Bibliographies with BibTeX
2144 \begin_layout Standard
2145 The basics how to use BibTeX are explained in section
2147 Bibliography databases (BibTeX)
2154 The following subsections explain special bibliography features supported
2158 \begin_layout Subsection
2159 Alternative Citation Styles
2162 \begin_layout Standard
2163 Standard BibTeX uses numbers (e.g.,
2164 \begin_inset Quotes eld
2168 \begin_inset Quotes erd
2171 ) to refer to a cited work.
2172 However, in many scientific disciplines, other citation styles are in use.
2173 The most common one is the author-year style (e.g.,
2174 \begin_inset Quotes eld
2178 \begin_inset Quotes erd
2182 LyX supports two packages that provide this style,
2183 \begin_inset Flex CharStyle:Code
2186 \begin_layout Plain Layout
2193 \begin_inset Flex CharStyle:Code
2196 \begin_layout Plain Layout
2203 Both packages have their pros and cons, which cannot be listed in detail.
2204 If you only want to have simple author-year (or author-numerical) style,
2205 or if you want to use one of the countless style files for
2206 \begin_inset Flex CharStyle:Code
2209 \begin_layout Plain Layout
2215 , than the established
2216 \begin_inset Flex CharStyle:Code
2219 \begin_layout Plain Layout
2225 package is probably your choice.
2226 If you need special features like short title references, ibidem etc., you
2228 \begin_inset Flex CharStyle:Code
2231 \begin_layout Plain Layout
2240 \begin_layout Standard
2241 The handling of both packages in LyX is basically the same.
2243 \begin_inset Flex CharStyle:MenuItem
2246 \begin_layout Plain Layout
2247 Document\SpecialChar \menuseparator
2254 \begin_inset Flex CharStyle:MenuItem
2257 \begin_layout Plain Layout
2264 \begin_inset Flex CharStyle:MenuItem
2267 \begin_layout Plain Layout
2274 \begin_inset Flex CharStyle:MenuItem
2277 \begin_layout Plain Layout
2284 With both packages, you will get some extra features in the citation dialog
2285 and you can select the style of the reference (
2286 \begin_inset Quotes eld
2290 \begin_inset Quotes erd
2294 \begin_inset Quotes eld
2298 \begin_inset Quotes erd
2302 \begin_inset Quotes eld
2306 \begin_inset Quotes erd
2310 \begin_inset Quotes eld
2314 \begin_inset Quotes erd
2318 Note that both packages need specifically designed style files.
2319 They both ship their own, but there are lots of additional style files,
2320 and there is even an interactive style file builder
2324 \begin_layout Plain Layout
2326 \begin_inset Flex URL
2329 \begin_layout Plain Layout
2331 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2342 \begin_inset Flex CharStyle:Code
2345 \begin_layout Plain Layout
2354 \begin_layout Subsection
2355 Sectioned Bibliographies
2358 \begin_layout Standard
2359 Sometimes you might need to divide your bibliography into several sections.
2360 If you are for instance a historian, the possibility to separate sources
2361 and scientific works is most likely a
2362 \begin_inset Quotes eld
2366 \begin_inset Quotes erd
2370 Unfortunately, BibTeX itself does not allow you to do this.
2371 But with the help of some LaTeX packages, BibTeX can be extended to fit
2375 \begin_layout Standard
2376 LyX provides native support for one of these packages,
2384 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2401 The advantage of this package (compared to other packages like
2405 ) is that you don't need to define new citation commands.
2406 Instead, you need to prepare different bibliographic databases which include
2407 the entries for the different sections of the bibliography.
2408 For example: If you want to divide your bibliography into the sections
2410 \begin_inset Quotes eld
2414 \begin_inset Quotes erd
2418 \begin_inset Quotes eld
2422 \begin_inset Quotes erd
2425 , you first need to create two bibliographic databases, e.g.,
2426 \begin_inset Flex CharStyle:Code
2429 \begin_layout Plain Layout
2436 \begin_inset Flex CharStyle:Code
2439 \begin_layout Plain Layout
2449 \begin_layout Standard
2451 \begin_inset Flex CharStyle:MenuItem
2454 \begin_layout Plain Layout
2455 Document\SpecialChar \menuseparator
2462 \begin_inset Flex CharStyle:MenuItem
2465 \begin_layout Plain Layout
2472 \begin_inset Flex CharStyle:MenuItem
2475 \begin_layout Plain Layout
2476 Sectioned bibliography
2482 Now you can insert multiple BibTeX bibliographies, one for each section
2483 of your bibliography.
2484 Returning to our example: Insert the BibTeX bibliography
2485 \begin_inset Flex CharStyle:Code
2488 \begin_layout Plain Layout
2494 and a second one for the database
2495 \begin_inset Flex CharStyle:Code
2498 \begin_layout Plain Layout
2505 You are free to use the same or different styles for each section.
2506 Additionally, you can chose if the bibliography section should contain
2508 \begin_inset Quotes eld
2511 all cited references
2512 \begin_inset Quotes erd
2515 of the specified database(s) (which is the default),
2516 \begin_inset Quotes eld
2519 all uncited references
2520 \begin_inset Quotes erd
2524 \begin_inset Quotes eld
2528 \begin_inset Quotes erd
2532 This might be useful if you would like to separate your bibliography into
2534 \begin_inset Quotes eld
2538 \begin_inset Quotes erd
2542 \begin_inset Quotes eld
2546 \begin_inset Quotes erd
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 The titles for the sections can be added as ordinary sections or subsections.
2560 \begin_inset Flex CharStyle:Code
2563 \begin_layout Plain Layout
2569 removes the bibliography title, you have manually re-add that, too (as
2570 a chapter* or section*, for instance).
2573 \begin_layout Subsection
2574 Multiple Bibliographies
2577 \begin_layout Standard
2578 Multiple bibliographies, e.g., a bibliography for each section or chapter
2579 of the document, are not supported by BibTeX itself.
2581 \begin_inset Flex CharStyle:Code
2584 \begin_layout Plain Layout
2590 package, which is used for the creation of sectioned bibliographies in
2591 LyX (see the previous section), provides an easy way to solve this task,
2592 if you are willing to use some
2593 \begin_inset Flex CharStyle:MenuItem
2596 \begin_layout Plain Layout
2603 \begin_inset space ~
2607 \begin_inset CommandInset ref
2609 reference "sec:Inserting-TeX-Code"
2617 \begin_layout Plain Layout
2618 An alternative approach is to use the
2619 \begin_inset Flex CharStyle:Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex CharStyle:Code
2632 \begin_layout Plain Layout
2638 package, respectively.
2646 \begin_layout Standard
2648 \begin_inset Flex CharStyle:MenuItem
2651 \begin_layout Plain Layout
2652 Document\SpecialChar \menuseparator
2659 \begin_inset Flex CharStyle:MenuItem
2662 \begin_layout Plain Layout
2669 \begin_inset Flex CharStyle:MenuItem
2672 \begin_layout Plain Layout
2673 Sectioned bibliography
2679 In the document, you have to enclose the sections, which shall contain
2680 their own bibliography (including the BibTeX bibliography itself), between
2682 \begin_inset Flex CharStyle:Code
2685 \begin_layout Plain Layout
2694 \begin_inset Flex CharStyle:Code
2697 \begin_layout Plain Layout
2705 (those commands have to be inserted as ERT).
2706 The bibliography will contain all references which have been cited in the
2708 \begin_inset Flex CharStyle:Code
2711 \begin_layout Plain Layout
2722 If you are using this approach, then every citation reference has to be
2724 \begin_inset Flex CharStyle:Code
2727 \begin_layout Plain Layout
2735 \begin_inset Flex CharStyle:Code
2738 \begin_layout Plain Layout
2747 \begin_layout Section
2751 \begin_layout Subsection
2755 \begin_layout Standard
2756 When you are working on a large file with many sections, it is often convenient
2757 to break up the document into several files, or perhaps you have something
2758 where a table may change from time to time, but the preceding text does
2760 In these cases, you should seriously consider using multipart documents.
2761 For example, scientific papers often have five major sections: the introduction
2762 , observations, results, discussion, and conclusion.
2763 Each of these could be its own separate LyX file, with one
2764 \begin_inset Quotes eld
2768 \begin_inset Quotes erd
2771 file which contains the title, authors, abstract, references, etc., plus
2772 the five included files.
2773 It is important to note that each of these files is a full LyX file which
2774 can be formatted and printed on its own, as well as included in a master
2776 Each of these files must have the same document class, however---don't
2777 attempt to mix book classes with article classes.
2778 You may also include LaTeX files; however, these files must not have their
2784 everything up to and including the
2785 \begin_inset Flex CharStyle:Code
2788 \begin_layout Plain Layout
2797 \begin_inset Flex CharStyle:Code
2800 \begin_layout Plain Layout
2808 line must be deleted) or else errors will be generated when you try to
2812 \begin_layout Standard
2813 LyX allows you to include files quite easily with
2814 \begin_inset Flex CharStyle:MenuItem
2817 \begin_layout Plain Layout
2818 Insert\SpecialChar \menuseparator
2820 \begin_inset space ~
2829 When you click on this selection a small box is inserted into the file
2830 at the current cursor location.
2831 Clicking on the box raises a dialog which allows you to select the file
2832 to be included, and the method of its inclusion.
2836 \begin_layout Standard
2837 The file selection box should by now be obvious.
2838 The three inclusion methods are
2839 \begin_inset Quotes eld
2843 \begin_inset Quotes erd
2847 \begin_inset Quotes eld
2851 \begin_inset Quotes erd
2855 \begin_inset Quotes eld
2859 \begin_inset Quotes erd
2863 The difference between
2864 \begin_inset Quotes eld
2868 \begin_inset Quotes erd
2872 \begin_inset Quotes eld
2876 \begin_inset Quotes erd
2879 is really only meaningful to LaTeXperts, but the practical difference is
2880 that files which are
2881 \begin_inset Quotes eld
2885 \begin_inset Quotes erd
2888 are typeset beginning on a new page, while files which are
2889 \begin_inset Quotes eld
2893 \begin_inset Quotes erd
2896 are typeset starting on the current page.
2899 \begin_layout Standard
2900 Generally, the master file is converted into a full LaTeX file before typesettin
2901 g, while the included files are converted to LaTeX files which do not have
2902 all the preamble information.
2905 \begin_layout Standard
2907 \begin_inset Quotes eld
2911 \begin_inset Quotes erd
2914 included file allows you to include a file typeset exactly as it appears
2915 in the file, i.e., in
2916 \begin_inset Flex CharStyle:Code
2919 \begin_layout Plain Layout
2925 mode, with the characters set in a fixed-width typewriter font.
2926 Normally, spaces in this file are invisible, though two consecutive spaces
2927 are conserved, unlike LyX's normal treatment of spaces.
2928 However, setting the
2929 \begin_inset Flex CharStyle:MenuItem
2932 \begin_layout Plain Layout
2934 \begin_inset space ~
2938 \begin_inset space ~
2942 \begin_inset space ~
2950 checkbox typesets a mark to unambiguously define the presence of a space.
2954 \begin_layout Subsection
2955 Cross-References Between Files
2958 \begin_layout Standard
2959 \begin_inset Box Shadowbox
2968 height_special "totalheight"
2971 \begin_layout Plain Layout
2972 This section is somewhat out of date.
2973 Need to describe default master documents and how children are opened when
2983 \begin_layout Standard
2984 It is possible to set up cross-references between the different files.
2985 First, open all the files in question: let's call them A and B in a two
2986 file example, where B is included in A.
2987 Let's say you insert a label in A, then want to reference it in B.
2988 Open the cross-reference dialog in whilst in document B, and you can select
2990 \begin_inset Quotes eld
2994 \begin_inset Quotes erd
3000 \begin_layout Subsection
3001 Bibliography Lists in all Subdocuments
3004 \begin_layout Standard
3005 \begin_inset Box Frameless
3014 height_special "totalheight"
3017 \begin_layout Plain Layout
3018 This section also needs updating.
3019 There is now material about this on the wiki, and it could be copied here.
3027 \begin_layout Standard
3028 Copy the bibliography list with all entries to all subdocuments and transform
3030 This way LyX will find the
3031 \begin_inset Flex CharStyle:Code
3034 \begin_layout Plain Layout
3040 -files and you can easily insert references without making the bibliography
3044 \begin_layout Standard
3045 As the bibliography list is in a comment, LaTeX won't use use it and the
3046 references will look like this: [?], instead of like this: [1].
3047 One solution is to use the LaTeX-package
3048 \begin_inset Flex CharStyle:Code
3051 \begin_layout Plain Layout
3057 that will only include comments by processing the files separately.
3058 To do this, add in the LaTeX preamble of every subdocument the following:
3061 \begin_layout LyX-Code
3067 \begin_layout LyX-Code
3070 includecomment{comment}
3073 \begin_layout Standard
3075 \begin_inset Flex URL
3078 \begin_layout Plain Layout
3080 http://wiki.lyx.org/FAQ/Unsorted#toc31
3088 \begin_layout Section
3089 Fancy Headers and Footers
3092 \begin_layout Standard
3093 The default page layout is rather plain; for an
3094 \begin_inset Flex CharStyle:Code
3097 \begin_layout Plain Layout
3103 document class, all you get is a centered page number at the bottom of
3105 This document uses KOMA-script's book class, so it appears to be a bit
3107 But to really put on a show, you need to set the document page style to
3109 \begin_inset Quotes eld
3113 \begin_inset Quotes erd
3116 , as mentioned in the
3121 This section describes the LaTeX code you need to insert in your LaTeX
3122 preamble in order to get the desired effects.
3125 \begin_layout Standard
3126 The page header is divided into three fields, not surprisingly labeled
3127 \begin_inset Quotes eld
3131 \begin_inset Quotes erd
3135 \begin_inset Quotes eld
3139 \begin_inset Quotes erd
3143 \begin_inset Quotes eld
3147 \begin_inset Quotes erd
3151 The footer is also divided into these three fields.
3152 The LaTeX commands to set these fields in the simplest manner are
3153 \begin_inset Flex CharStyle:Code
3156 \begin_layout Plain Layout
3165 \begin_inset Flex CharStyle:Code
3168 \begin_layout Plain Layout
3177 \begin_inset Flex CharStyle:Code
3180 \begin_layout Plain Layout
3189 \begin_inset Flex CharStyle:Code
3192 \begin_layout Plain Layout
3201 Suppose you wish to put your name in the upper left hand corner of each
3203 Simply insert the following command in the preamble:
3206 \begin_layout Standard
3215 \begin_layout Standard
3216 You will now see your name in the upper left.
3217 If a field has a default entry that you would like to get rid of (often
3218 the page number appears in the central footer, simply include a command
3219 with a blank argument, e.g.:
3222 \begin_layout Standard
3230 \begin_layout Standard
3231 Let's get really fancy: lets put the section number with the word
3232 \begin_inset Quotes eld
3236 \begin_inset Quotes erd
3239 (e.g., Section 3) in the upper left, the page number (e.g., Page 4) in the
3240 upper right, your name in the lower left, and the date in the lower right.
3241 The following commands should now appear in the preamble:
3244 \begin_layout Standard
3254 \begin_layout Standard
3262 \begin_layout Standard
3272 \begin_layout Standard
3281 \begin_layout Standard
3289 \begin_layout Standard
3299 \begin_layout Standard
3301 \begin_inset Flex CharStyle:Code
3304 \begin_layout Plain Layout
3313 \begin_inset Flex CharStyle:Code
3316 \begin_layout Plain Layout
3324 access LaTeX's section and page counters, and so print out the current
3325 section and page numbers.
3327 \begin_inset Flex CharStyle:Code
3330 \begin_layout Plain Layout
3338 simply prints out today's date.
3341 \begin_layout Standard
3342 The thicknesses of the horizontal rules drawn beneath the header and above
3343 the footer can also be modified.
3344 If you don't want one of the rules, set its thickness to 0.
3345 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3351 \begin_inset Flex CharStyle:Code
3354 \begin_layout Plain Layout
3359 headrulewidth}{0.4pt}
3365 \begin_inset Flex CharStyle:Code
3368 \begin_layout Plain Layout
3373 footrulewidth}{0.4pt}
3378 to set the thicknesses.
3381 \begin_layout Standard
3382 You can switch the header/footer settings on and off for individual pages
3384 \begin_inset Flex CharStyle:Code
3387 \begin_layout Plain Layout
3390 thispagestyle{empty}
3396 \begin_inset Flex CharStyle:Code
3399 \begin_layout Plain Layout
3402 thispagestyle{plain}
3408 \begin_inset Flex CharStyle:Code
3411 \begin_layout Plain Layout
3414 thispagestyle{fancy}
3420 Simply insert them in the text on the page you want changed and mark them
3422 In fact, title pages are marked as plain by default, while following pages
3423 are marked fancy when using the global fancy setting.
3426 \begin_layout Standard
3427 There are more complex commands which will let you insert things in the
3428 upper left on odd numbered pages, etc., but we will refer you to the
3429 \begin_inset Flex CharStyle:Code
3432 \begin_layout Plain Layout
3438 package documentation for more information.
3440 \begin_inset Flex CharStyle:Code
3443 \begin_layout Plain Layout
3452 \begin_layout Standard
3453 As a final example, it is possible to include an image in the header or
3455 Suppose you want to put a company logo in the upper lefthand corner.
3456 You might try something like
3459 \begin_layout Standard
3468 includegraphics{logo.eps}}}
3471 \begin_layout Standard
3473 (you may need to preface this with
3474 \begin_inset Flex CharStyle:Code
3477 \begin_layout Plain Layout
3481 usepackage{graphics}
3486 if you don't include graphics elsewhere in your document).
3489 \begin_layout Section
3490 Itemize Bullet Selection
3491 \begin_inset CommandInset label
3500 \begin_layout Standard
3506 \begin_layout Subsection
3510 \begin_layout Standard
3511 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3512 Using this dialog you can easily specify what bullet shape to use at each
3513 level of an itemized list.
3514 These settings are document-wide so you won't be able to specify different
3515 sets of bullets for different paragraphs.
3519 \begin_layout Plain Layout
3520 Well, actually you can but you'll have to do it by hand.
3528 \begin_layout Subsection
3532 \begin_layout Standard
3533 Open the dialog by selecting the
3534 \begin_inset Flex CharStyle:MenuItem
3537 \begin_layout Plain Layout
3538 Document\SpecialChar \menuseparator
3544 menu item and then select the
3545 \begin_inset Flex CharStyle:MenuItem
3548 \begin_layout Plain Layout
3557 \begin_layout Standard
3558 The dialog provides you with a table of bullet shapes.
3559 A column of buttons on the left of the table provides access to the six
3560 different panels of bullet shapes.
3561 The row of buttons across the top is used to select which bullet depth
3563 A text entry under the table shows the currently selected bullet shape's
3564 LaTeX equivalent and this can be edited if desired.
3565 If you do modify the text you will also need to specify any needed packages
3566 in the LaTeX preamble.
3569 \begin_layout Standard
3570 The six panels are divided up by the packages they require.
3571 The following table shows the mappings from button name to LaTeX packages.
3574 \begin_layout Standard
3576 \begin_inset Tabular
3577 <lyxtabular version="3" rows="7" columns="2">
3579 <column alignment="center" valignment="top" width="0pt">
3580 <column alignment="center" valignment="top" width="0pt">
3582 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3585 \begin_layout Plain Layout
3600 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3603 \begin_layout Plain Layout
3620 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3623 \begin_layout Plain Layout
3638 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3641 \begin_layout Plain Layout
3657 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3660 \begin_layout Plain Layout
3675 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3678 \begin_layout Plain Layout
3695 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3698 \begin_layout Plain Layout
3713 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3716 \begin_layout Plain Layout
3733 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3736 \begin_layout Plain Layout
3751 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3754 \begin_layout Plain Layout
3771 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3774 \begin_layout Plain Layout
3789 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3792 \begin_layout Plain Layout
3809 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3812 \begin_layout Plain Layout
3827 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3830 \begin_layout Plain Layout
3853 \begin_layout Standard
3854 LyX doesn't stop you using bullets from packages you don't have.
3855 If you get errors from LaTeX when you try to view or print the file, then
3856 it is likely you are missing a package.
3860 \begin_layout Plain Layout
3861 LyX doesn't restrict your use since you may be editing locally and exporting
3870 \begin_layout Subsection
3874 \begin_layout Standard
3875 Select which bullet depth you want to change then select the bullet shape
3877 Any changes will not be visible in LyX, but are visible when viewing the
3881 \begin_layout Standard
3882 You can reset a bullet shape to the default simply by clicking your right
3883 mouse button on the appropriate bullet depth button.
3887 \begin_layout Plain Layout
3892 want to have multiple sets of paragraphs with different sets of bullets
3893 in each, then you're going to have to get your hands dirty with ERT.
3894 The bullet selection dialog can help though because it provides you with
3895 the LaTeX code for a wide range of bullet shapes.
3896 To make your own custom paragraphs you have the following options:
3899 \begin_layout Plain Layout
3903 \begin_layout Plain Layout
3919 \begin_layout Plain Layout
3923 \begin_layout Plain Layout
3945 \begin_layout Itemize
3946 Use the LaTeX command
3947 \begin_inset Flex CharStyle:Code
3950 \begin_layout Plain Layout
3958 to specify a new bullet shape for a given depth.
3959 You'll also need to save the current bullet shape so you can restore it
3961 In this itemized list the following LaTeX code was used to change the bullet
3962 used for the first depth.
3966 \begin_layout LyX-Code
3976 \begin_layout LyX-Code
3993 \begin_layout Itemize
3994 Note that the itemize depth is specified in Roman numerals as part of the
4004 \begin_layout Itemize
4008 \begin_layout Plain Layout
4021 Specify each individual entry by starting each item with the bullet shape
4022 enclosed in square brackets and set as
4023 \begin_inset Flex CharStyle:MenuItem
4026 \begin_layout Plain Layout
4033 For example, this item was started with
4034 \begin_inset Flex CharStyle:Code
4037 \begin_layout Plain Layout
4052 \begin_layout Plain Layout
4056 \begin_layout Plain Layout
4072 \begin_layout Plain Layout
4073 You'll also need to revert the labelitem back to its previous setting for
4074 the global bullet shape settings to remain in effect.
4075 The way used here was:
4078 \begin_layout LyX-Code
4093 \begin_layout Chapter
4097 \begin_layout Section
4101 \begin_layout Standard
4102 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4103 and retrieve information about the LyX internal state.
4104 This is only intended for advanced users, but they should find it useful.
4105 It is by writing to the LyX server, for example, that bibliography managers,
4106 such as JabRef, are able to
4107 \begin_inset Quotes eld
4111 \begin_inset Quotes erd
4117 \begin_layout Standard
4118 Please note that, at present,
4120 the server does not work on Windows
4126 \begin_layout Plain Layout
4127 There is no reason it cannot do so.
4128 But none of the developers on Windows® have yet implemented this functionality
4137 \begin_layout Section
4138 Starting the LyX Server
4141 \begin_layout Standard
4142 The LyX server works through the use of a pair of named pipes.
4143 These are usually located in
4144 \begin_inset Flex CharStyle:Code
4147 \begin_layout Plain Layout
4154 \begin_inset Quotes eld
4158 \begin_inset Flex CharStyle:Code
4161 \begin_layout Plain Layout
4168 \begin_inset Quotes erd
4172 \begin_inset Quotes eld
4176 \begin_inset Flex CharStyle:Code
4179 \begin_layout Plain Layout
4186 \begin_inset Quotes erd
4190 External programs write into
4191 \begin_inset Flex CharStyle:Code
4194 \begin_layout Plain Layout
4200 and read back data from
4201 \begin_inset Flex CharStyle:Code
4204 \begin_layout Plain Layout
4211 The stem of the pipe names can be defined in the
4212 \begin_inset Flex CharStyle:MenuItem
4215 \begin_layout Plain Layout
4220 ools\SpecialChar \menuseparator
4231 \begin_inset Flex CharStyle:Code
4234 \begin_layout Plain Layout
4235 "/home/myhome/lyxpipe"
4245 configure this manually in order for the server to start.
4248 \begin_layout Standard
4250 \begin_inset Flex CharStyle:Code
4253 \begin_layout Plain Layout
4260 \begin_inset Flex CharStyle:Code
4263 \begin_layout Plain Layout
4269 ' to create the pipes.
4270 If one of the pipes already exists, LyX will assume that another LyX process
4271 is already running and will not start the server.
4272 This means that if LyX crashes, or if for some other reason, a
4273 \begin_inset Quotes eld
4277 \begin_inset Quotes erd
4280 pipe is left in existence when LyX closes, then LyX will not start the
4282 (This is bug 641.) You will need to delete the pipes manually and then restart
4286 \begin_layout Standard
4287 To have several LyX processes with servers at the same time, you have to
4288 use different configurations, perhaps by using separate user directories,
4290 \begin_inset Flex CharStyle:Code
4293 \begin_layout Plain Layout
4299 file, for each process.
4302 \begin_layout Standard
4303 If you are developing a client program, you might find it useful to enable
4304 debugging information from the LyX server.
4305 Do this by starting LyX as
4306 \begin_inset Flex CharStyle:Code
4309 \begin_layout Plain Layout
4318 \begin_layout Standard
4319 Other than this, there are a few points to consider:
4322 \begin_layout Itemize
4323 Both server and clients must run on UNIX or OS/2 machines.
4324 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4325 not possible right now.
4328 \begin_layout Itemize
4329 On OS/2, only one client can connect to LyXServer at a time.
4332 \begin_layout Itemize
4333 On OS/2, clients must open the input pipe with
4334 \begin_inset Flex CharStyle:Code
4337 \begin_layout Plain Layout
4346 \begin_layout Standard
4347 You can find a complete example client written in C in the source distribution
4349 \begin_inset Flex CharStyle:Code
4352 \begin_layout Plain Layout
4353 development/lyxserver/server_monitor.c
4361 \begin_layout Section
4362 Normal communication
4365 \begin_layout Standard
4366 To issue a LyX call, the client writes a line of ASCII text into the input
4368 This line has the following format:
4385 \begin_layout Description
4386 clientname is a name that the client can choose arbitrarily.
4387 Its only use is that LyX will echo it if it sends an answer---so a client
4388 can dispatch results from different requesters.
4391 \begin_layout Description
4392 function is the function you want LyX to perform.
4393 It is the same as the commands you'd use in the minibuffer.
4396 \begin_layout Description
4397 argument is an optional argument which is meaningful only to some functions
4399 \begin_inset Quotes eld
4403 \begin_inset Quotes erd
4406 LFUN will insert the argument as text at the cursor position).
4409 \begin_layout Standard
4410 The answer from LyX will arrive in the output pipe and be of the form
4427 \begin_layout Standard
4436 are just echoed from the command request, while
4440 is more or less useful information filled according to how the command
4441 execution worked out.
4442 Some commands, such as
4443 \begin_inset Quotes eld
4447 \begin_inset Quotes erd
4450 , will return information about the internal state of LyX, while other will
4451 return an empty data-response.
4452 This means that the command execution went fine.
4455 \begin_layout Standard
4456 In case of errors, the response from LyX will have this form
4473 \begin_layout Standard
4478 should contain an explanation of why the command failed.
4481 \begin_layout Standard
4485 \begin_layout LyX-Code
4486 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4489 \begin_layout LyX-Code
4490 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4491 \begin_inset Newline newline
4494 read a <~/.lyxpipe.out
4495 \begin_inset Newline newline
4501 \begin_layout Section
4505 \begin_layout Standard
4506 LyX can notify clients of events going on asynchronously.
4507 Currently it will only do this if the user binds a key sequence with the
4509 \begin_inset Quotes eld
4513 \begin_inset Quotes erd
4517 The format of the string LyX sends is as follows:
4521 \begin_inset Flex CharStyle:Code
4524 \begin_layout Plain Layout
4535 \begin_layout Standard
4540 is the printed representation of the key sequence that was actually typed
4544 \begin_layout Standard
4545 This mechanism can be used to extend LyX's command set and implement macros.
4546 Bind some key sequence to
4547 \begin_inset Quotes eld
4551 \begin_inset Quotes erd
4555 Then start a client that listens on the output pipe, dispatches the command
4556 according to the sequence, and starts a function that may use LyX calls
4557 and LyX requests to issue a command or a series of commands to LyX.
4560 \begin_layout Section
4561 The simple LyX Server Protocol
4564 \begin_layout Standard
4565 LyX implements a simple protocol that can be used for session management.
4566 All messages are of the form
4579 \begin_layout Standard
4585 \begin_inset Quotes eld
4589 \begin_inset Quotes erd
4593 \begin_inset Quotes eld
4597 \begin_inset Quotes erd
4602 \begin_inset Quotes eld
4606 \begin_inset Quotes erd
4609 is received from a client, LyX will report back to inform the client that
4610 it's listening to it's messages, while
4611 \begin_inset Quotes eld
4615 \begin_inset Quotes erd
4618 sent from LyX will inform clients that LyX is closing.
4621 \begin_layout Chapter
4622 Special Document Classes
4625 \begin_layout Section
4629 \begin_layout Standard
4635 \begin_layout Subsection
4639 \begin_layout Standard
4640 This section describes how LyX can be used to write articles for submission
4641 to the scientific journal
4643 Astronomy and Astrophysics
4645 (www.edpsciences.fr/aa/
4646 \begin_inset Flex URL
4649 \begin_layout Plain Layout
4651 http://www.edpsciences.fr/aa/
4656 ) using Version 5.01 of the document class
4661 This package can be downloaded from the ftp site
4664 \begin_layout Standard
4665 \begin_inset VSpace medskip
4671 \begin_layout Standard
4673 \begin_inset Flex URL
4676 \begin_layout Plain Layout
4678 ftp://ftp.edpsciences.org/pub/aa/readme.html
4686 \begin_layout Standard
4687 \begin_inset VSpace medskip
4693 \begin_layout Standard
4694 A manual comes together with that package, and this text is not meant to
4695 replace the original manual but merely a short guide how to realize the
4696 correct form of your paper.
4700 \begin_layout Standard
4701 Please note that the publisher of the journal was changed from Springer
4702 to EDP Sciences starting January 1, 2001.
4703 That change implicated also some slight changes of the style files, namely
4704 the removal of the thesaurus command.
4705 The LyX class aa supports the newest version of these style files, V 5.01.
4706 If you have an older version installed, please upgrade.
4707 For compatibility, the old (version 4) layout has been kept as
4712 Please refer to the comments in
4714 LyXDir/layouts/aapaper.layout
4719 \begin_layout Subsection
4723 \begin_layout Standard
4724 It is recommended you start from the example template distributed with LyX.
4725 If you are not using a template, note the following settings:
4728 \begin_layout Itemize
4738 ocument\SpecialChar \menuseparator
4745 dialog (OK, that one was obvious).
4748 \begin_layout Itemize
4749 Don't change the option
4752 \begin_inset space ~
4762 The whole layout is done by the macros, you shouldn't change anything.
4765 \begin_layout Subsection
4769 \begin_layout Standard
4770 First thing to enter is the header information.
4771 It consists of seven entries, of which some are optional.
4775 \begin_layout Itemize
4783 \begin_layout Itemize
4791 \begin_layout Itemize
4799 \begin_layout Itemize
4807 \begin_layout Itemize
4812 : [optional] if more than one author: whom to contact for offprint requests.
4815 \begin_layout Itemize
4820 : [optional] mail address for contacts.
4823 \begin_layout Itemize
4831 Received: <date>; Accepted <date>
4834 \begin_layout Standard
4835 There is no need to issue the
4841 command, this is done automatically by LyX when the header is finished.
4842 Although the order of the single header entries doesn't matter it is advised
4843 to keep the above sequence, just to get the best optics and meets the layout
4844 of the real document.
4847 \begin_layout Standard
4848 If you want to place footnotes in the header block, e.
4849 \begin_inset space \thinspace{}
4853 \begin_inset space ~
4856 to state your present address, just use the standard footnote via
4861 nsert\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
5294 ocument\SpecialChar \menuseparator
5302 Just enter the string
5309 \begin_layout Subsection
5313 \begin_layout Standard
5318 directory contains an example paper written with LyX.
5319 It is the example paper from the original macro package, translated to
5321 Use it for inspiration, and compare the original LaTeX code with LyX way
5325 \begin_layout Section
5329 \begin_layout Standard
5335 \begin_layout Subsection
5339 \begin_layout Standard
5340 AASTeX is a set of macros produced by the American Astronomical Society
5341 to facilitate electronic manuscript submission to the three journals they
5342 publish: the Astrophysical Journal (including the Letters and Supplement),
5343 the Astronomical Journal, and the Publications of the Astronomical Society
5345 LyX has proven to be an excellent tool for generating these documents,
5346 especially given its equation, citation, and figure handling capabilities.
5347 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5348 is the version described here, or higher.
5349 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5350 incompatible with LyX.
5351 The AASTeX package may be downloaded from the AASTeX Web site
5354 \begin_layout Standard
5355 \begin_inset VSpace medskip
5361 \begin_layout Standard
5363 \begin_inset Flex URL
5366 \begin_layout Plain Layout
5368 http://www.journals.uchicago.edu/AAS/AASTeX
5376 \begin_layout Standard
5377 \begin_inset VSpace medskip
5383 \begin_layout Standard
5384 A complete user guide is contained in that package and you should familiarize
5385 yourself with it thoroughly before embarking on writing a paper in LyX.
5386 LyX will not reduce the need to figure out all the AASTeX commands, it
5387 will only reduce the drudgery of typing everything in.
5388 It is your responsibility to ensure that the final exported LaTeX document
5389 conforms completely to the requirements of the journal to which you are
5390 submitting your paper.
5393 \begin_layout Subsection
5394 Starting a New Paper
5397 \begin_layout Standard
5398 I strongly suggest that you start with the AASTeX template file.
5404 ile\SpecialChar \menuseparator
5414 , enter the new file name, then choose the
5419 This will show the most common fields found in a manuscript.
5420 Simply overwrite the existing text (including the brackets,
5424 ) with the correct information.
5425 Many of the AASTeX commands and environments can be implemented directly
5426 in LyX, but some cannot: most noticeably
5438 , which should stick out like a sore thumb if you actually just opened the
5440 For commands such as these, the LaTeX code must be entered directly and
5442 Such commands are referred to as ERT, or Evil Red Text.
5443 I tried to minimize the amount of ERT needed in an AASTeX document, but
5444 there is still a bit more required than any of us would like.
5447 \begin_layout Subsection
5448 Finishing Your Paper
5451 \begin_layout Standard
5452 When the paper is finished to your satisfaction and previews/prints correctly,
5454 \begin_inset Quotes eld
5458 \begin_inset Quotes erd
5461 actions which need to be done before you submit it to the journals.
5465 \begin_layout Enumerate
5466 Export your paper as a LaTeX file (
5471 ile\SpecialChar \menuseparator
5476 xport\SpecialChar \menuseparator
5487 \begin_layout Enumerate
5492 file with your favorite text editor
5496 \begin_layout Enumerate
5497 remove the comment lines before the
5506 \begin_layout Enumerate
5511 usepackage...{fontenc}
5513 line if it appears (usually just after
5528 \begin_layout Enumerate
5529 remove everything between (and including) the
5541 commands, except for any commands you specifically put into the LaTeX preamble
5542 (which should appear immediately after the
5543 \begin_inset Quotes eld
5546 User specified LaTeX commands
5547 \begin_inset Quotes erd
5558 \begin_layout Enumerate
5559 Run the resulting file through LaTeX to make sure it still processes correctly.
5562 \begin_layout Enumerate
5563 Reread the journal requirements to make sure your filenames and formats
5567 \begin_layout Enumerate
5571 \begin_layout Subsection
5572 Comments On Specific Commands
5575 \begin_layout Standard
5576 I will not describe the detailed usage of the individual AASTeX commands:
5577 the AASTeX User Guide (
5581 ) gives a good description of each.
5582 Thus it's probably easiest for me to go down the list as found in the guide
5583 and offer comments where necessary.
5584 So let's begin \SpecialChar \ldots{}
5588 \begin_layout Subsubsection
5589 Things that work as expected
5592 \begin_layout Standard
5596 \begin_layout Plain Layout
5608 \begin_layout Standard
5609 Because they work as you might expect, I simply list them and the section
5710 begin{thebibliography}
5718 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5719 graphicx figure commands (2.14.1),
5743 (2.15.4, amongst other places),
5770 \begin_layout Standard
5771 The following style options also work correctly:
5792 Simply put them in the
5798 Layout\SpecialChar \menuseparator
5804 \begin_layout Standard
5808 \begin_layout Plain Layout
5820 \begin_layout Subsubsection
5821 Things that work, but require more comment
5824 \begin_layout Standard
5825 The following items work, but require a little more discussion:
5828 \begin_layout Itemize
5829 These items are reserved for use by the journal editors, but you can put
5830 them into the LaTeX preamble if you feel compelled to do so:
5863 \begin_layout Itemize
5864 These items may be placed in the LaTeX preamble, and are included as blanks
5865 in the template file:
5886 \begin_layout Itemize
5893 (2.3) -- can only be used
5894 \begin_inset Quotes eld
5898 \begin_inset Quotes erd
5901 , not in the middle of a paragraph.
5902 Use ERT if you need to embed it.
5905 \begin_layout Itemize
5912 (2.3) -- will have extra {} after it.
5913 This should not cause an error.
5916 \begin_layout Itemize
5923 (2.6) -- can only be used
5924 \begin_inset Quotes eld
5928 \begin_inset Quotes erd
5931 , not in the middle of a paragraph.
5932 Use ERT if you need to embed it.
5935 \begin_layout Itemize
5942 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5946 \begin_layout Itemize
5953 (2.8) -- same as for
5960 \begin_layout Itemize
5967 (2.9) -- will have extra {} after it.
5968 This should not cause an error.
5971 \begin_layout Itemize
5978 (2.11) -- will have extra {} after it.
5979 This should not cause an error.
5982 \begin_layout Itemize
5989 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5990 at the beginning of the text and selecting
5992 Insert\SpecialChar \menuseparator
5997 \begin_inset Quotes eld
6001 \begin_inset Quotes erd
6004 inserts an optional argument of the type needed by
6011 Hopefully it will be renamed someday.
6014 \begin_layout Itemize
6027 for the catalog ID optional parameter
6030 \begin_layout Itemize
6043 for the catalog ID optional parameter
6046 \begin_layout Subsubsection
6047 Things not implemented, use ERT
6050 \begin_layout Standard
6054 \begin_layout Plain Layout
6066 \begin_layout Standard
6089 setcounter{equation}
6091 (2.12), Journal name abbreviations (2.13.4),
6127 (2.15.4, insert it as the first element in the lefthand cell after where
6129 Don't use any of LyX's rules in the table),
6141 (2.15.5), much of Misc (2.17, except
6192 \begin_layout Standard
6196 \begin_layout Plain Layout
6208 \begin_layout Subsubsection
6209 Things that cannot be implemented
6212 \begin_layout Standard
6213 \SpecialChar \ldots{}
6214 at least in any meaningful sort of way, so I suggest ignoring them.
6215 They are the references environment (2.13.3), and the deluxetable environment
6217 If you really, really need to use deluxetable, I suggest editing it in
6218 a separate file with a text editor, then using
6223 nsert\SpecialChar \menuseparator
6229 \begin_inset space ~
6234 to include it in your LyX document.
6239 file to see an example of this.
6242 \begin_layout Subsection
6243 FAQs, Tips, Tricks, and Other Ruminations
6246 \begin_layout Subsubsection
6247 Getting LyX and AASTeX to cooperate
6250 \begin_layout Standard
6251 It can be a bit tricky to get LyX to recognize a new layout and document
6253 When all else fails, do this:
6256 \begin_layout Enumerate
6257 Make certain that LaTeX can find AASTeX.
6258 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6259 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6266 \begin_layout Enumerate
6278 \begin_layout Enumerate
6284 ools\SpecialChar \menuseparator
6291 in LyX, then restart LyX.
6294 \begin_layout Enumerate
6295 Open a regular new file, not from a template.
6296 Does AASTeX appear in the class list in
6301 ocument\SpecialChar \menuseparator
6311 \begin_layout Standard
6312 If you get a warning from an existing AASTeX document about not being able
6313 to find the AASTeX layout or a message about
6314 \begin_inset Quotes eld
6317 You should not mix title layouts with normal ones
6318 \begin_inset Quotes erd
6321 , things haven't been installed correctly.
6324 \begin_layout Subsubsection
6325 LaTeX error processing a table
6328 \begin_layout Standard
6329 LyX, by default, attempts to center the table caption/title.
6330 This seems to produce a bad interaction in AASTeX so you should click somewhere
6331 in the caption/title, then select
6336 dit\SpecialChar \menuseparator
6342 \begin_inset space ~
6359 This took care of it for me.
6362 \begin_layout Subsubsection
6366 \begin_layout Standard
6367 A couple of things: 1) I have noticed some funny spacing in the reference
6368 entries in the text.
6369 When you enter the bibliography item data, make sure their is
6373 space between the last author and the parenthesis setting off the year;
6377 \begin_inset space \thinspace{}
6381 \begin_inset space ~
6395 2) Entering the references at all is not obvious.
6396 The easiest thing is to start typing your first reference at the end of
6397 the document, then mark it as type
6402 That will put a small gray box in front of what you just typed.
6403 Click on the box to fill in the rest of the information.
6404 For new references, go to the end of an existing reference and press return.
6405 That will create a new line with its own box, etc.
6408 \begin_layout Subsubsection
6412 \begin_layout Standard
6413 Even though AASTeX provides its own figure commands (
6419 , for example), I much prefer LaTeX's standard figure commands (with the
6428 \begin_inset space ~
6431 commands as ERT into a Figure Float box if you desire, but I never have
6432 much luck getting the layout right.
6433 With the standard graphics, LyX will insert a
6437 usepackage{graphicx}
6439 command into the LaTeX preamble and handle the figures in the standard
6440 LaTeX2e way, interspersing the figures in the text.
6441 I believe ApJ accepts figures exactly this way now; AJ might still use
6443 \begin_inset Quotes eld
6446 stack everything at the end
6447 \begin_inset Quotes erd
6453 \begin_layout Subsubsection
6454 Things I could have done, but didn't
6457 \begin_layout Standard
6459 \begin_inset Quotes eld
6463 \begin_inset Quotes erd
6466 things I could have implemented, but chose not to.
6467 For instance, I saw no point in double-spacing the text in the LyX window,
6468 even though it is double-spaced in the paper manuscript.
6469 Also, I chose not to make separate layouts for the preprint and preprint2
6471 Since I assume you will spend most of your time in the plain manuscript
6472 mode anyway, I decided not to chew up more disk space with this.
6476 \begin_layout Subsection
6480 \begin_layout Standard
6481 Your mileage may vary.
6482 I've now had papers published by both ApJ and AJ that have had 98% of the
6483 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6485 I have had no trouble with the submission process, and I'm sure the journals
6486 were never aware that there might be a difference.
6487 So, go forth and publish!
6490 \begin_layout Section
6494 \begin_layout Standard
6497 David Johnson; updated by Richard Heck
6500 \begin_layout Standard
6501 \begin_inset VSpace bigskip
6507 \begin_layout Standard
6509 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6510 papers to be submitted to American Mathematical Society publications.
6511 The layouts are not tailored to a specific journal, but easily can be.
6512 You should refer to the AMS documentation for specific instructions for
6513 each journal (usually it will entail only changing a single line in the
6515 That documentation is available on the Web at
6516 \begin_inset Flex URL
6519 \begin_layout Plain Layout
6527 \begin_inset Flex URL
6530 \begin_layout Plain Layout
6532 ftp://ftp.ams.org/pub/tex/amslatex/
6538 These layouts are appropriate, and useful, for any mathematical writing.
6542 \begin_layout Standard
6543 There are two basic AMS LaTeX layouts:
6546 \begin_layout Itemize
6547 amsart: The standard AMS article format.
6550 \begin_layout Itemize
6551 amsbook: the standard AMS book (really, monograph) format.
6555 \begin_layout Standard
6556 The layouts themselves contain only the minimum necessary to use the AMS
6558 They do not, in particular, contain any of the `theorem' environments used
6559 for setting theorems, lemmas, and the like.
6560 These are contained, instead, in the
6561 \begin_inset Flex CharStyle:Code
6564 \begin_layout Plain Layout
6570 module, which is loaded by default when when you select one of the AMS
6572 (It can also be used with other classes and can be removed, if you would
6573 rather use something else.) Less commonly used environments are in the
6574 \begin_inset Flex CharStyle:Code
6577 \begin_layout Plain Layout
6578 Theorems (AMS-Extended)
6583 module, which must be loaded manually.
6586 \begin_layout Standard
6587 By default, theorems and the like are numbered consecutively throughout
6588 the document, but this may be modified by loading the module
6589 \begin_inset Flex CharStyle:Code
6592 \begin_layout Plain Layout
6593 Theorems (Order by Section)
6598 or, if you are using
6599 \begin_inset Flex CharStyle:Code
6602 \begin_layout Plain Layout
6609 \begin_inset Flex CharStyle:Code
6612 \begin_layout Plain Layout
6613 Theorems (Order by Chapter)
6619 These will number the results as
6620 \begin_inset Formula $n.m$
6623 , where the first number refers to the section (or chapter) and the second
6624 refers to the total number of results so far in that section (or chapter).
6625 Many environments are also available unnumbered.
6626 These are indicated by an asterisk at the end.
6627 If you happen to want
6631 unnumbered results, the the module
6632 \begin_inset Flex CharStyle:Code
6635 \begin_layout Plain Layout
6641 provides that option.
6644 \begin_layout Standard
6645 Note that these modules do not
6649 to be used with the AMS classes.
6650 It is perfectly possible to use the
6651 \begin_inset Flex CharStyle:Code
6654 \begin_layout Plain Layout
6660 module, and the others mentioned, with other classes, such as
6661 \begin_inset Flex CharStyle:Code
6664 \begin_layout Plain Layout
6671 \begin_inset Flex CharStyle:Code
6674 \begin_layout Plain Layout
6681 \begin_inset Flex CharStyle:Code
6684 \begin_layout Plain Layout
6693 \begin_layout Subsection
6694 What these layouts provide
6697 \begin_layout Standard
6698 There is a long list of included environments provided by these layouts.
6699 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6700 variety of `theorem' environments.
6701 However, the AMS recommends the environments that are available in LyX.
6705 \begin_layout Standard
6706 The following environments---as well as the standard environments, such
6708 \begin_inset Flex CharStyle:Noun
6711 \begin_layout Plain Layout
6718 \begin_inset Flex CharStyle:Noun
6721 \begin_layout Plain Layout
6728 \begin_inset Flex CharStyle:Noun
6731 \begin_layout Plain Layout
6738 \begin_inset Flex CharStyle:Noun
6741 \begin_layout Plain Layout
6748 \begin_inset Flex CharStyle:Noun
6751 \begin_layout Plain Layout
6758 \begin_inset Flex CharStyle:Code
6761 \begin_layout Plain Layout
6768 \begin_inset Flex CharStyle:Code
6771 \begin_layout Plain Layout
6780 \begin_layout Description
6781 Address This should be the author's permanent address.
6784 \begin_layout Description
6786 \begin_inset space ~
6789 Address This should be the author's temporary address at the time of submission,
6790 if different from the Address.
6793 \begin_layout Description
6794 Email Author's e-mail address
6797 \begin_layout Description
6798 URL Author's Web address, if desired.
6801 \begin_layout Description
6802 Keywords Key words or phrases used to identify specific topics discussed
6806 \begin_layout Description
6807 Subjectclass These refer to the AMS Subject Classifications, published and
6810 Mathematical Reviews
6813 These are also available online at the AMS cites listed above.
6816 \begin_layout Description
6820 \begin_layout Description
6824 \begin_layout Description
6828 \begin_layout Standard
6829 The following environments are provided by both the
6830 \begin_inset Flex CharStyle:Code
6833 \begin_layout Plain Layout
6840 \begin_inset Flex CharStyle:Code
6843 \begin_layout Plain Layout
6849 modules, in the latter case in both starred (unnumbered) and unstarred
6850 (numbered) versions.
6851 These same environments are provided only in the starred versions by the
6853 \begin_inset Flex CharStyle:Code
6856 \begin_layout Plain Layout
6865 \begin_layout Theorem
6866 This is typically used for the statements of major results.
6870 \begin_layout Corollary*
6871 This is used for statements which follow fairly directly from previous statement
6873 Again, these can be major results.
6878 These are smaller results needed to prove other statements.
6881 \begin_layout Proposition
6882 These are less major results which (hopefully) add to the general theory
6886 \begin_layout Conjecture
6887 These are statements provided without justification, which the author does
6888 not know how to prove, but which seem to be true (to the author, at least).
6891 \begin_layout Definition*
6892 Guess what this is for.
6893 The font is different for this environment than for the previous ones.
6897 \begin_layout Example*
6898 Used for examples illustrating proven results.
6901 \begin_layout Problem
6902 It's not really known what this is for.
6903 You should figure it out.
6906 \begin_layout Exercise*
6907 Write a description for this one.
6910 \begin_layout Remark
6911 This environment is also a type of theorem, usually a lesser sort of observation.
6914 \begin_layout Claim*
6915 Often used in the course of giving a proof of a larger result.
6919 Generally, these are used to break up long arguments, using specific instances
6925 The numbering scheme for cases is on its own, not together with other numbered
6931 At the end of this environment, a QED symbol (usually a square, but it can
6932 vary with different styles) is placed.
6933 If you want to have other environments within this one---for example, Case
6934 environments---and have the QED symbol appear only after them, then the
6935 other environments need to be nested within the proof environment.
6938 Nesting Environments
6944 for information on nesting.
6947 \begin_layout Standard
6948 And these environments are provided by
6949 \begin_inset Flex CharStyle:Code
6952 \begin_layout Plain Layout
6953 Theorems (AMS-Extended)
6961 \begin_layout Criterion*
6962 A required condition.
6965 \begin_layout Algorithm*
6966 A general procedure to be used.
6969 \begin_layout Axiom*
6970 This is a property or statement taken as true within the system being discussed.
6973 \begin_layout Condition*
6974 Sometimes used to state a condition assumed within the present context of
6979 Similar to a Remark.
6982 \begin_layout Notation*
6983 Used for the explanation of, yes, notation.
6986 \begin_layout Summary
6987 Do we really need to tell you?
6990 \begin_layout Acknowledgement*
6994 \begin_layout Conclusion*
6995 Sometimes used at the end of a long train of argument.
6999 Used in a way similar to Proposition, though perhaps lower on the scale.
7002 \begin_layout Standard
7003 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
7005 They need to be available on your system in order to use these environments.
7008 \begin_layout Section
7016 \begin_layout Standard
7022 \begin_layout Subsection
7026 \begin_layout Standard
7027 These are the layout files for some of the journals of the American Geophysical
7029 It is assumed that you have both the AGU's own class files and AGUplus
7030 installed (everything to be found at
7031 \begin_inset Flex URL
7034 \begin_layout Plain Layout
7036 ftp://ftp.agu.org/journals/latex/journals
7044 \begin_layout Subsection
7048 \begin_layout Standard
7058 They are still called this in the LyX GUI, though their LaTeX equivalents
7059 in the AGU classes are
7070 \begin_layout Standard
7071 Newly defined styles are
7108 These are mostly manuscript attributes and defined in the AGU class documentati
7112 \begin_layout Standard
7113 I suspect this is still badly incomplete.
7116 \begin_layout Subsection
7120 \begin_layout Standard
7137 \begin_layout Subsection
7141 \begin_layout Itemize
7144 Journal of Geophysical Research
7153 \begin_layout Standard
7154 Add your own, it isn't so hard! Look at the
7165 \begin_layout Subsection
7166 Bugs and things to remember
7169 \begin_layout Standard
7170 In order to use the new layouts, you must remember to do the following for
7174 \begin_layout Enumerate
7180 This can be done in the
7182 layout\SpecialChar \menuseparator
7187 document\SpecialChar \menuseparator
7191 (AGU articles are always in English, right? So
7198 \begin_layout Enumerate
7208 (Yes, this is a bug.)
7211 \begin_layout Enumerate
7212 Make sure you use the
7216 bibliography style, by entering
7220 into the second field of the BibTeX inset.
7221 None of the standard styles will do.
7224 \begin_layout Section
7228 \begin_layout Standard
7234 \begin_layout Subsection
7238 \begin_layout Standard
7239 Broadway is for writing plays.
7240 The format is more decorative than Hollywood, and much less standardized.
7241 This format should be suitable for workshops.
7244 \begin_layout Subsection
7248 \begin_layout Standard
7249 The same as in Hollywood.
7252 \begin_layout Subsection
7256 \begin_layout Standard
7261 names as labels then cross-reference the label to insert the name.
7262 The cross-reference dialog will show the current cast of characters.
7265 \begin_layout Subsection
7266 Paper size and Margins
7269 \begin_layout Standard
7270 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7273 \begin_layout Subsection
7277 \begin_layout Standard
7278 The following environments are available.
7279 You can use broadway.bind to get the bind keys shown at the right.
7282 \begin_layout Itemize
7286 \begin_inset Newline newline
7291 You should not have to use this, but it is here for anything that does not
7295 \begin_layout Itemize
7299 \begin_inset space \hfill{}
7303 \begin_inset Newline newline
7308 Used to describe stage setting and the action.
7309 First use of speaker names in all CAPs.
7312 \begin_layout Itemize
7316 \begin_inset space \hfill{}
7320 \begin_inset Newline newline
7325 Automatically numbered.
7326 On screen it will be arabic, but will print as Roman.
7329 \begin_layout Itemize
7333 \begin_inset space \hfill{}
7337 \begin_inset Newline newline
7347 It is just centered text.
7350 \begin_layout Itemize
7354 \begin_inset space \hfill{}
7358 \begin_inset Newline newline
7363 Not automatically numbered.
7364 You supply the number.
7365 This is because I couldn't figure out how.
7368 \begin_layout Itemize
7372 \begin_inset space \hfill{}
7376 \begin_inset Newline newline
7381 A special case of Narrative to describe the setting and action as the curtain
7385 \begin_layout Itemize
7389 \begin_inset space \hfill{}
7393 \begin_inset Newline newline
7398 The speaker's (actor's) title, centered in all CAPS.
7401 \begin_layout Itemize
7405 \begin_inset space \hfill{}
7409 \begin_inset Newline newline
7414 Instructions to the speaker.
7415 The parentheses are automatically inserted.
7416 The ( will appear on screen, but both will be in the printed play.
7417 This environment is only used within
7424 \begin_layout Itemize
7428 \begin_inset space \hfill{}
7432 \begin_inset Newline newline
7437 What the Speaker says.
7440 \begin_layout Itemize
7444 \begin_inset space \hfill{}
7448 \begin_inset Newline newline
7453 The curtain comes down.
7456 \begin_layout Itemize
7460 \begin_inset space \hfill{}
7466 \begin_layout Itemize
7470 \begin_inset space \hfill{}
7476 \begin_layout Itemize
7480 \begin_inset space \hfill{}
7486 \begin_layout Standard
7490 \begin_layout Section
7494 \begin_layout Standard
7499 can be used to type letters according to German conventions.
7500 A template file is included in
7502 .../lyx/share/templates
7504 for you to use as a starting point.
7507 \begin_layout Section
7515 \begin_layout Standard
7521 \begin_layout Subsection
7525 \begin_layout Standard
7526 This is the layout file for the European Geophysical Society journals.
7531 can be downloaded from the web site of the EGS under
7532 \begin_inset Flex URL
7535 \begin_layout Plain Layout
7545 \begin_layout Subsection
7549 \begin_layout Standard
7552 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7560 The current layout file is unfortunately very unmodular and would benefit
7561 from using the various
7568 \begin_layout Section
7572 \begin_layout Standard
7578 \begin_layout Standard
7579 Elsevier Science Publishers B.V.
7580 provides a standard LaTeX document class (
7584 ) for submitting articles to their various journals.
7585 The style file can be downloaded directly from their web site:
7586 \begin_inset Flex URL
7589 \begin_layout Plain Layout
7591 http://authors.elsevier.com/
7597 Instructions are supplied along with the class file, which details the
7598 requirements of the publishers.
7599 LyX includes package that allows for the use of this class, by a layout
7600 and a template file.
7601 Installation of the class file is the same as for any other LaTeX package;
7602 instructions are provided in the Elsevier documentation.
7605 \begin_layout Standard
7615 As the Elsevier class file is based mainly on the standard article class,
7616 most of the normal functionality is provided.
7617 The Elsevier class defines a number of mathematical environments, which
7618 are similar to the AMS environments.
7619 These commands are all described in the Elsevier documentation, and are
7623 \begin_layout Standard
7624 The easiest way to use the Elsevier style is to base documents on the included
7626 It is best not to use options such as fancy headings or the geometry package,
7627 as elements such as these are defined by Elsevier in their style file.
7628 Ideally, no extra packages except those mentioned in the Elsevier documentation
7630 Essentially, Elsevier require as
7631 \begin_inset Quotes eld
7635 \begin_inset Quotes erd
7638 a LaTeX file as possible, as their intention is to take the supplied file
7639 and replace the class file with one for the particular journal to which
7640 the paper has been submitted.
7641 This also means that not too much time should be spent on the formating
7643 When it comes to be published, this will change anyway.
7644 The rest of the usage for this layout is substantially the same as for
7645 the normal article class.
7646 For details of what Elsevier do and don't allow, refer to their documentation.
7649 \begin_layout Section
7658 \begin_inset CommandInset label
7667 \begin_layout Standard
7673 \begin_layout Subsection
7677 \begin_layout Standard
7678 This section describes how to use LyX to make slides for overhead projectors.
7679 There are two document classes that can do this: the default slides class
7685 This section documents the latter.
7688 \begin_layout Standard
7689 I'm going to say this again, nice and clear, so that there's no misunderstanding
7693 \begin_layout Standard
7694 \begin_inset VSpace bigskip
7700 \begin_layout Standard
7704 This section documents the class
7705 \begin_inset Quotes eld
7713 \begin_inset Quotes erd
7721 \begin_layout Standard
7722 \begin_inset VSpace bigskip
7728 \begin_layout Standard
7729 If you're looking for the documentation for
7730 \begin_inset Quotes eld
7738 \begin_inset Quotes erd
7742 \begin_inset space ~
7746 \begin_inset CommandInset ref
7748 reference "sec:slitex"
7753 If your machine doesn't have the
7758 \begin_inset Quotes eld
7766 \begin_inset Quotes erd
7769 ] installed, you'll probably have to use the default
7773 class, which isn't quite as good as
7778 \begin_layout Standard
7783 class is designed for use with version 2.1 of the
7787 LaTeX class file which is now an integral part of LaTeX2e.
7790 \begin_layout Subsection
7794 \begin_layout Standard
7795 Obviously, to use this document class, you need to select
7796 \begin_inset Quotes eld
7804 \begin_inset Quotes erd
7817 \begin_inset space ~
7823 There are some settings in the
7826 \begin_inset space ~
7831 dialog that you should know about that are specific to this class:
7834 \begin_layout Itemize
7835 Don't change the options
7846 \begin_inset space ~
7852 They're ignored by the
7859 \begin_layout Itemize
7860 The default font size is 20pt with the other options being 17pt, 25pt and
7864 \begin_layout Itemize
7873 but all math equations are still typeset in the usual roman font.
7876 \begin_layout Itemize
7881 TeX supports A4 and Letter paper sizes as well as a special size for working
7883 It doesn't support A5, B5, legal or executive paper sizes.
7886 \begin_layout Itemize
7887 Don't bother changing the
7891 settings because they are ignored anyway.
7892 All floats appear where they are defined in the text.
7895 \begin_layout Itemize
7903 setting behaves a bit differently for this class.
7908 TeX provides extensive footer and header capabilities including a user-defined
7911 \begin_inset space ~
7915 \begin_inset CommandInset ref
7917 reference "sec:foilfoot"
7922 The title page is treated differently to all other pages in the document
7931 has the logo centered at the bottom of the page (if one is defined).
7932 The possible page style choices and what they do are as follows:
7936 \begin_layout Labeling
7937 \labelwidthstring MMMMMMM
7944 The final output contains no page numbers, or other headers or footers
7945 (except footnotes of course).
7949 \begin_layout Labeling
7950 \labelwidthstring MMMMMMM
7957 The final output contains page numbers centered at the bottom of the page.
7958 No other headings or footers (other than footnotes).
7961 \begin_layout Labeling
7962 \labelwidthstring MMMMMMM
7967 Page numbers in lower right corner.
7968 Additional headers and footers are also shown.
7969 This is also the default.
7972 \begin_layout Labeling
7973 \labelwidthstring MMMMMMM
7978 Gives you access to the
7982 package although its use with
7986 TeX is discouraged by the writer of the
7990 TeX package because of some potential page layout clashes.
7994 \begin_layout Subsubsection
7998 \begin_layout Standard
7999 The following options may be used in the extra class options in the
8004 ocument\SpecialChar \menuseparator
8014 \begin_layout Labeling
8015 \labelwidthstring MMMMMMx
8020 This sets up the page layout for 7.33in by 11in paper, which is about the
8021 same aspect ratio as a 35mm slide, making it a bit easier to work with
8025 \begin_layout Labeling
8026 \labelwidthstring MMMMMMx
8031 Places a rule across the page below the header on every page except the
8035 \begin_layout Labeling
8036 \labelwidthstring MMMMMMx
8041 Places a rule across the page above the footer on every page except the
8045 \begin_layout Labeling
8046 \labelwidthstring MMMMMMx
8051 This is automatically set each time you create a new
8060 TeX to use the dvips driver to rotate those pages that are set as landscape
8064 \begin_layout Labeling
8065 \labelwidthstring MMMMMMx
8070 Simply changes the page dimensions to those of a landscape page but doesn't
8072 Thus if you use this option you need to use an external program to rotate
8073 each page or feed your paper through your printer as landscape.
8074 Note that this option effectively reverses the roles of the
8082 environments (don't worry these are described in the next section).
8085 \begin_layout Labeling
8086 \labelwidthstring MMMMMMx
8091 Equation numbers on the left.
8094 \begin_layout Labeling
8095 \labelwidthstring MMMMMMx
8100 Flush-left equations.
8103 \begin_layout Subsection
8104 Supported Environments
8107 \begin_layout Standard
8108 Most of the environments commonly supported in other classes are also supported
8114 There are several additional environments provided by
8118 TeX as well as a couple added by LyX.
8119 The following environments are shared with other classes:
8122 \begin_layout Standard
8126 \begin_layout Plain Layout
8138 \begin_layout Itemize
8144 \begin_layout Itemize
8150 \begin_layout Itemize
8156 \begin_layout Itemize
8162 \begin_layout Itemize
8168 \begin_layout Itemize
8174 \begin_layout Itemize
8180 \begin_layout Itemize
8186 \begin_layout Itemize
8192 \begin_layout Itemize
8198 \begin_layout Itemize
8204 \begin_layout Itemize
8210 \begin_layout Itemize
8216 \begin_layout Itemize
8222 \begin_layout Itemize
8228 \begin_layout Itemize
8234 \begin_layout Itemize
8240 \begin_layout Itemize
8246 \begin_layout Standard
8250 \begin_layout Plain Layout
8262 \begin_layout Standard
8263 That is, all the major environments apart from the sectioning environments.
8264 Since foils are essentially self-contained sections, with a title and body,
8269 TeX provides specific commands for starting new foils and these are:
8272 \begin_layout Itemize
8278 \begin_layout Itemize
8284 \begin_layout Standard
8285 LyX also provides slightly modified versions of these two environments called:
8288 \begin_layout Itemize
8294 \begin_layout Itemize
8300 \begin_layout Standard
8301 and the differences will be explained in the next section.
8304 \begin_layout Standard
8305 Since foils are often used in presenting ideas or new theorems and such
8310 TeX also provides a comprehensive box of goodies for presenting them:
8313 \begin_layout Standard
8317 \begin_layout Plain Layout
8329 \begin_layout Itemize
8335 \begin_layout Itemize
8341 \begin_layout Itemize
8347 \begin_layout Itemize
8353 \begin_layout Itemize
8359 \begin_layout Itemize
8365 \begin_layout Itemize
8371 \begin_layout Itemize
8377 \begin_layout Itemize
8383 \begin_layout Itemize
8389 \begin_layout Itemize
8395 \begin_layout Standard
8399 \begin_layout Plain Layout
8411 \begin_layout Standard
8412 The starred versions are unnumbered while the unstarred versions are numbered.
8413 There are also two list environments added by LyX and these are:
8416 \begin_layout Itemize
8422 \begin_layout Itemize
8428 \begin_layout Standard
8433 TeX provides some powerful header and footer capabilities that are best
8434 set in the preamble although they may be set at any point in a document.
8435 If you want to change these settings in your document the best place to
8436 do so is at the very top of a foil,
8441 straight after the foilhead.
8444 \begin_layout Standard
8445 For this purpose, the following command styles are provided [
8452 \begin_layout Standard
8456 \begin_layout Plain Layout
8468 \begin_layout Itemize
8472 \begin_inset space ~
8478 \begin_layout Itemize
8484 \begin_layout Itemize
8488 \begin_inset space ~
8494 \begin_layout Itemize
8498 \begin_inset space ~
8504 \begin_layout Itemize
8508 \begin_inset space ~
8515 \begin_layout Standard
8516 \begin_inset space ~
8523 \begin_layout Standard
8527 \begin_layout Plain Layout
8539 \begin_layout Standard
8540 There are also a few commands provided by
8544 TeX that aren't directly supported by LyX but I'll tell you what they do
8545 and how to use them in section
8546 \begin_inset space ~
8550 \begin_inset CommandInset ref
8552 reference "sec:unsuppfoils"
8559 \begin_layout Subsection
8560 Building a Set of Foils
8563 \begin_layout Standard
8564 This section will give a simple introduction to using the different environments
8565 to build a set of foils.
8566 If you want to see an example set of foils, take a look at the
8570 file you find in LyX's
8577 \begin_layout Subsubsection
8578 Give It a Title Page
8581 \begin_layout Standard
8582 Unlike other classes that provide
8602 creates the title on a page of its own.
8603 If you leave out the
8607 environment LaTeX will substitute the current date (every time you regenerate
8611 \begin_layout Subsubsection
8615 \begin_layout Standard
8616 As I mentioned earlier, there are four ways of starting a new foil.
8617 For portrait foils you should use
8626 The difference between these two environments is the amount of space between
8627 the title of the foil (the foilhead) and the body of the foil.
8630 \begin_layout Standard
8631 Landscape foils are generated using the
8640 Again the only difference is the spacing between foilhead and body.
8641 Both of the short versions have 0.5 inches less separation between the foilhead
8646 \begin_layout Standard
8647 One problem with the support for landscape foils is the requirement that
8652 driver to generate the PostScript output otherwise the foils won't be rotated.
8653 It is possible to get landscape foils even if you haven't got the
8657 driver provided you can feed your foils sideways through your printer ;-)
8660 \begin_layout Subsubsection
8661 Theorems, Lemmas, Proofs and more
8664 \begin_layout Standard
8665 Due to a small bug in LyX you can't have two of the same type of these environme
8666 nts directly following each other.
8667 They must be separated by something.
8668 If you try, you will just be extending the previous environment as if you
8669 had merged the two environments together.
8670 So, how do you get around this problem? The simplest option is to insert
8671 some text between the two environments or add a
8675 environment between the two with just a
8676 \begin_inset Quotes eld
8684 \begin_inset Quotes erd
8688 This will force LyX to produce two separate environments and hence the
8689 correct LaTeX output.
8690 An example is provided in the example file included with the LyX distribution.
8691 Remember, this problem only occurs if you are trying to place two of the
8692 same type of theorem-like environments one directly after the other.
8695 \begin_layout Subsubsection
8699 \begin_layout Standard
8700 You get all the commonly supported list styles found in other classes as
8701 well as two new ones.
8702 I'll only describe the new ones here.
8703 If you want to find out more about the other list environments check out
8709 If you intend to use itemized lists you might also want to read about the
8713 \begin_inset space ~
8717 \begin_inset space ~
8722 dialog described above in section
8723 \begin_inset space ~
8727 \begin_inset CommandInset ref
8729 reference "sec:bullet"
8736 \begin_layout Standard
8737 The two new list styles,
8745 , are designed to make it easier for you to create lists of do's and don'ts
8746 or right and wrong by providing dedicated environments that use a tick
8747 or a cross as the label of the list.
8748 These lists are in fact dedicated variants of the
8753 They do however require that you have the
8760 \begin_layout Subsubsection
8764 \begin_layout Standard
8769 TeX redefines the floating tables and figures so that they appear exactly
8770 where they are in the text rather than pushing them to the top of the page
8771 or to some user specified location.
8772 In fact if you change the float placement settings they are simply ignored.
8775 \begin_layout Subsubsection
8776 Page Headers and Footers
8777 \begin_inset CommandInset label
8786 \begin_layout Standard
8790 \begin_inset space ~
8799 are two commands used to control the left-footer text string.
8800 The first is meant to allow you to include a graphic logo on your foils
8802 \begin_inset Quotes eld
8810 \begin_inset Quotes erd
8814 While the second is meant to provide a classification for the audience,
8818 \begin_inset space \thinspace{}
8824 \begin_inset space ~
8828 It is empty by default.
8831 \begin_layout Standard
8832 The remaining page corners can be filled by
8835 \begin_inset space ~
8840 (which defaults to page numbers),
8843 \begin_inset space ~
8851 \begin_inset space ~
8859 \begin_layout Subsection
8865 \begin_inset CommandInset label
8867 name "sec:unsuppfoils"
8874 \begin_layout Standard
8875 All the commands mentioned below need to be set in a
8883 within another environment.
8886 \begin_layout Subsubsection
8890 \begin_layout Standard
8891 All lengths are adjusted using the
8914 should be replaced by the name given to the length you want to change and
8919 is the length value.
8920 All lengths should be specified in units of length such as inches (
8932 ) or relative to some document or font-based length such as
8942 \begin_layout Standard
8943 It's possible to change the spacing between a foilhead and the body of the
8944 foil by adjusting the length specified by
8951 For example, to make
8955 foilheads 0.5 inches closer to their bodies put the following in the preamble:
8962 foilheadskip}{-0.5in}
8965 \begin_layout Standard
8966 The spacings around floats can be adjusted by setting these lengths:
8969 \begin_layout Labeling
8970 \labelwidthstring MMMMMMMMMMM
8977 Separation between the text and the top of the float
8980 \begin_layout Labeling
8981 \labelwidthstring MMMMMMMMMMM
8988 Separation between the float and the caption
8991 \begin_layout Labeling
8992 \labelwidthstring MMMMMMMMMMM
8999 Separation between the caption and the following text
9002 \begin_layout Labeling
9003 \labelwidthstring MMMMMMMMMMM
9010 You can make the captions narrower than the surrounding text by adjusting
9012 Best done relative to
9021 \begin_layout Standard
9022 There are also several title page related lengths that you may find useful
9023 if you have a long title or several authors:
9026 \begin_layout Labeling
9027 \labelwidthstring MMMMMMMMMMM
9034 Separation from headers to
9039 \begin_layout Labeling
9040 \labelwidthstring MMMMMMMMMMM
9058 \begin_layout Labeling
9059 \labelwidthstring MMMMMMMMMMM
9073 \begin_layout Labeling
9074 \labelwidthstring MMMMMMMMMMM
9090 \begin_layout Labeling
9091 \labelwidthstring MMMMMMMMMMM
9107 \begin_layout Standard
9108 The last length related command affects all the list environments.
9119 a list environment then all the vertical spacing between the list items
9121 Note that this is a command not a length so it doesn't require
9127 like the stuff mentioned above.
9130 \begin_layout Subsubsection
9134 \begin_layout Standard
9147 commands control whether the logo in the
9151 definition appear on a given page.
9158 in the preamble then none of the foils will have the logo on them.
9159 If you don't want the logo on a particular page place the
9165 directly after the foilhead of that page and the
9171 directly after the next foilhead.
9174 \begin_layout Standard
9175 If you decide to use the
9179 page style setting in the
9182 \begin_inset space ~
9187 dialog you should probably add
9197 to your preamble so headers and footers on landscape pages are correctly
9198 placed when rotated.
9199 This is due to some clashes between the page layouts provided by the
9210 \begin_layout Section
9211 Hollywood (Hollywood spec scripts)
9214 \begin_layout Standard
9220 \begin_layout Subsection
9224 \begin_layout Standard
9225 Getting the format of a Hollywood script right is a
9226 \begin_inset Quotes eld
9230 \begin_inset Quotes erd
9233 It is designed to make the readers focus on content and to be easy and
9234 familiar for the actors to read.
9235 Each page of a script should be one minute of film.
9236 Nothing goes in a script that you cannot see or hear on screen.
9237 The courier 12 pt font should be used throughout.
9241 \begin_layout Subsection
9245 \begin_layout Standard
9246 Speakers' lines should NEVER break in mid-sentence.
9247 If a speaker's lines continue over a page break, repeat the
9251 title followed by (Cont'd).
9254 \begin_layout Subsection
9258 \begin_layout Standard
9263 names as labels then cross-reference the label to insert the name.
9264 The cross-reference dialog will show the current cast of characters.
9265 You can use this to insert the speaker name in narratives also.
9268 \begin_layout Subsection
9269 Paper size and Margins
9272 \begin_layout Standard
9273 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9276 \begin_layout Subsection
9280 \begin_layout Standard
9281 The following environments are available.
9282 You can use hollywood.bind to get the bind keys shown at the right.
9285 \begin_layout Itemize
9289 \begin_inset Newline newline
9294 Used where nothing else works.
9298 \begin_layout Itemize
9304 \begin_inset space \hfill{}
9312 \begin_inset Newline newline
9315 Usually followed by something like
9316 \begin_inset Quotes eld
9320 \begin_inset Quotes erd
9326 \begin_layout Itemize
9330 \begin_inset space \hfill{}
9334 \begin_inset Newline newline
9339 Introduces a new INTERIOR camera set-up.
9340 Always followed by DAY or NIGHT, or something similar to define the lighting
9342 Everthing on this line in CAPS.
9345 \begin_layout Itemize
9349 \begin_inset space \hfill{}
9353 \begin_inset Newline newline
9358 Introduces a new EXTERIOR camera set-up.
9359 Everthing on this line in CAPS.
9362 \begin_layout Itemize
9366 \begin_inset space \hfill{}
9370 \begin_inset Newline newline
9375 The character speaking.
9378 \begin_layout Itemize
9382 \begin_inset space \hfill{}
9386 \begin_inset Newline newline
9391 Instructions to the speaker.
9392 The () are automatically inserted, but only the ( will show in LyX.
9393 Both will be printed.
9396 \begin_layout Itemize
9400 \begin_inset space \hfill{}
9404 \begin_inset Newline newline
9416 \begin_layout Itemize
9420 \begin_inset space \hfill{}
9424 \begin_inset Newline newline
9429 Camera movement instruction.
9431 \begin_inset space \thinspace{}
9435 \begin_inset space ~
9441 \begin_layout Itemize
9445 \begin_inset space \hfill{}
9451 \begin_layout Itemize
9455 \begin_inset space \hfill{}
9461 \begin_layout Itemize
9465 \begin_inset space \hfill{}
9471 \begin_layout Itemize
9475 \begin_inset space \hfill{}
9481 \begin_layout Subsection
9485 \begin_layout Itemize
9486 (O.S) --- off screen
9489 \begin_layout Itemize
9490 (V.0) --- voice over
9493 \begin_layout Itemize
9498 \begin_layout Itemize
9503 \begin_layout Itemize
9504 PAN --- camera movement
9507 \begin_layout Itemize
9508 INSERT --- cut to close-up of
9511 \begin_layout Section
9515 \begin_layout Standard
9518 Panayotis Papasotiriou
9521 \begin_layout Subsection
9525 \begin_layout Standard
9526 The ijmpc package is a set of macros that facilitates electronic manuscript
9529 International Journal of Modern Physics C
9532 Similarly, the ijmpd package is for creating manuscripts to be submitted
9535 International Journal of Modern Physics D
9538 Both journals are published by World Scientific.
9539 The corresponding document classes are named
9548 These files, together with instructions for the authors, can be downloaded
9550 \begin_inset Flex URL
9553 \begin_layout Plain Layout
9555 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9561 \begin_inset Flex URL
9564 \begin_layout Plain Layout
9566 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9572 Both packages are modified versions of the standard
9573 \begin_inset Quotes eld
9577 \begin_inset Quotes erd
9580 package, and they are almost (but not exactly) identical.
9581 Most of their features are supported by LyX.
9582 I have used LyX successfully to write articles submitted to both journals
9583 without any problem.
9586 \begin_layout Subsection
9590 \begin_layout Standard
9591 As usual, the easiest way to write a paper is to start with a template.
9597 ile\SpecialChar \menuseparator
9616 This will give an (almost) empty document that includes the most common
9617 fields found in a manuscript.
9618 Simply overwrite the existing text (including the brackets,
9623 You should keep in mind the following remarks.
9626 \begin_layout Enumerate
9627 LyX won't let you change the font size and the page style of the document,
9628 because such modifications are not allowed by both packages.
9631 \begin_layout Enumerate
9632 The language of the document should not be changed.
9633 Before previewing your paper, be sure that the babel package is not used.
9634 To do this, click on
9639 ools\SpecialChar \menuseparator
9657 checkbox in the language settings, and click on
9668 , if you wish to make this change permanent).
9671 \begin_layout Enumerate
9673 \begin_inset Quotes eld
9677 \begin_inset Quotes erd
9680 style must be used to define keywords.
9683 \begin_layout Enumerate
9684 The ijmpc package provides a style named
9685 \begin_inset Quotes eld
9688 Classification Codes
9689 \begin_inset Quotes erd
9692 , which can be used to define classification codes, such as PACS numbers.
9693 Note that this facility is not supported by the ijmpd package.
9696 \begin_layout Enumerate
9697 Several new environments are available:
9698 \begin_inset Quotes eld
9702 \begin_inset Quotes erd
9706 \begin_inset Quotes eld
9710 \begin_inset Quotes erd
9714 \begin_inset Quotes eld
9718 \begin_inset Quotes erd
9722 \begin_inset Quotes eld
9726 \begin_inset Quotes erd
9730 \begin_inset Quotes eld
9734 \begin_inset Quotes erd
9738 \begin_inset Quotes eld
9742 \begin_inset Quotes erd
9746 \begin_inset Quotes eld
9750 \begin_inset Quotes erd
9754 \begin_inset Quotes eld
9758 \begin_inset Quotes erd
9762 \begin_inset Quotes eld
9766 \begin_inset Quotes erd
9770 \begin_inset Quotes eld
9774 \begin_inset Quotes erd
9778 \begin_inset Quotes eld
9782 \begin_inset Quotes erd
9786 \begin_inset Quotes eld
9790 \begin_inset Quotes erd
9794 \begin_inset Quotes eld
9798 \begin_inset Quotes erd
9802 \begin_inset Quotes eld
9806 \begin_inset Quotes erd
9810 Their use is more or less obvious.
9811 LyX supports all these environments; it will use the proper label, text
9812 style, and numbering scheme for each of them.
9815 \begin_layout Enumerate
9816 Both packages use basic citations; the natbib package should not be used.
9817 In LyX, citation references are shown as usual; in the output, citations
9818 are shown as superscripts.
9819 If you want to use a citation as normal text, you should use the
9824 \begin_inset space \thinspace{}
9828 \begin_inset Quotes eld
9832 \begin_inset space ~
9842 \begin_inset Quotes erd
9848 \begin_layout Enumerate
9850 \begin_inset Quotes eld
9854 \begin_inset Quotes erd
9857 section in both packages.
9858 To put acknowledgments, just use the
9859 \begin_inset Quotes eld
9863 \begin_inset Quotes erd
9869 \begin_layout Enumerate
9870 Appendices may be added to the paper,
9874 the Acknowledgments and
9879 LyX provides a special environment, called
9880 \begin_inset Quotes eld
9884 \begin_inset Quotes erd
9887 which marks the beginning of the appendices.
9888 This environment should be left blank; it just sends a LaTeX command, but
9889 nothing is really printed.
9891 \begin_inset Quotes eld
9895 \begin_inset Quotes erd
9898 is printed with blue letters, as a signal that all sections after that
9899 point are appendices.
9900 To write an appendix, use the
9901 \begin_inset Quotes eld
9905 \begin_inset Quotes erd
9909 LyX will number each appendix with capital letters, as required by both
9912 \begin_inset Quotes eld
9916 \begin_inset Quotes erd
9923 be present before the first appendix; if not, all appendices will be numbered
9924 as normal sections in the output.
9927 \begin_layout Enumerate
9928 The ijmpc and the ijmpd packages use the
9932 command to implement table captions.
9933 As a result, a table created by LyX is printed correctly, but its caption
9935 However, you can use some ERT to overpass this problem, so that captions
9936 are printed as expected.
9937 To do so, create a float table as usual, remove the caption, and replace
9948 (sic); you must also the ERT
9952 immediately after the tabular material.
9953 Study the example table included in the template files to see how this
9954 trick is implemented.
9955 Alternatively, If you need table captions, you should implement the whole
9960 file, then include this file to the LyX document (
9965 nsert\SpecialChar \menuseparator
9970 \SpecialChar \menuseparator
9976 \begin_inset space ~
9982 Details on how to create a table float can be found in the files
9990 , included in the corresponding packages.
9993 \begin_layout Subsection
9994 Preparing a paper for submission
9997 \begin_layout Standard
9998 Before you submit your paper you must export the LyX document as a LaTeX
10004 ile\SpecialChar \menuseparator
10009 xport\SpecialChar \menuseparator
10024 \begin_layout Plain Layout
10025 Actually you have the choice between LaTeX (plain) and pdflatex.
10026 If you intend to use pdflatex to prepare the paper, you should use the
10027 pdflatex option so that included graphics are converted to PDF format,
10028 ready for use by pdflatex.
10033 , then make the following changes to the resulting
10040 \begin_layout Enumerate
10041 Remove the comment lines before the
10050 \begin_layout Enumerate
10051 Remove everything between (and including) the
10063 commands, except for any commands you specifically put into the LaTeX preamble.
10066 \begin_layout Standard
10071 file should be saved and processed through LaTeX as many times as necessary.
10072 You may also want to check the resulting
10079 \begin_layout Subsection
10083 \begin_layout Standard
10084 The use of ERT is reduced to two commands, which must be placed at the top
10086 If you started writing your paper by using the
10094 template, the ERT needed is already in its place; you usually don't need
10096 You may only modify the first ERT to specify the information printed to
10097 the top of odd and even pages (authors' names and short paper's title,
10099 This ERT must have the form
10103 markboth{Authors' Names}{Short Paper's Title}
10108 \begin_layout Section
10112 \begin_layout Standard
10118 \begin_layout Subsection
10122 \begin_layout Standard
10123 The iopart package provides a document class to create electronic manuscript
10124 submission to the journals published by the Institute of Physics.
10125 Instructions for the authors how to create a paper using the iopart class
10126 can be downloaded together with the iopart package from the site
10127 \begin_inset Flex URL
10130 \begin_layout Plain Layout
10132 ftp://ftp.iop.org/pub/journals/latex2e
10140 \begin_layout Subsection
10144 \begin_layout Standard
10145 The easiest way to write a paper is to start with the file
10149 that is available in LyX's examples files folder.
10150 Open this file, save it under a new name, and start writing.
10151 The example file explains how to use the special text environments.
10152 Here are the most important advices:
10155 \begin_layout Itemize
10156 To be able to compile your document to a PDF, PS, or DVI, assure that the
10159 Use AMS math package
10161 in the document settings under
10168 \begin_layout Itemize
10171 The title environment defines the kind of your paper.
10172 So use one of the following environments for the title:
10176 \begin_layout Itemize
10185 \begin_layout Itemize
10194 \begin_layout Itemize
10200 for a Topical review
10203 \begin_layout Itemize
10212 \begin_layout Itemize
10221 \begin_layout Itemize
10227 for a Paper (same as Title)
10230 \begin_layout Itemize
10236 for a Preliminary communication
10239 \begin_layout Itemize
10245 for a Rapid communication
10248 \begin_layout Itemize
10254 for a Letter to the editor
10258 \begin_layout Itemize
10261 All title environments except of
10265 can have an optional short title.
10268 \begin_layout Itemize
10269 There is a general title environment
10273 which is not directly supported by the LyX.
10274 This can be used as ERT when your document doesn't fit into one of the
10278 \begin_layout Standard
10279 For more informations like hints for special table and formula formatting,
10280 look at the IOP author guidelines.
10283 \begin_layout Section
10287 \begin_layout Standard
10290 Panayotis Papasotiriou
10293 \begin_layout Subsection
10297 \begin_layout Standard
10298 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10299 that facilitates electronic manuscript submission to the journals they
10301 Most known of them (at least in my domain of interest) are
10303 Astrophysics and Space Science
10309 , but there are many others (see a complete list at
10310 \begin_inset Flex URL
10313 \begin_layout Plain Layout
10315 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10321 The Kluwer package may be downloaded from the site
10322 \begin_inset Flex URL
10325 \begin_layout Plain Layout
10327 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10333 A complete user guide is contained in that package (but it can also be
10334 downloaded separately).
10337 \begin_layout Standard
10338 LyX supports many features of the package but not everything.
10339 However, the ERT needed is reduced to some
10340 \begin_inset Quotes eld
10344 \begin_inset Quotes erd
10347 commands of the package (see
10348 \begin_inset space ~
10352 \begin_inset CommandInset ref
10354 reference "subsec:kluwer_peculiarities"
10359 I have recently used LyX to write an article submitted to the
10361 Astrophysics and Space Science
10363 without any problem.
10366 \begin_layout Subsection
10370 \begin_layout Standard
10371 The easiest way to write a paper is to start with the Kluwer template file.
10374 File\SpecialChar \menuseparator
10389 This will give an (almost) empty document that includes the most common
10390 fields found in a manuscript and a short description of their use.
10391 As in most templates, simply overwrite the existing text (including the
10396 ) with the correct information.
10399 \begin_layout Subsection
10400 Preparing a paper for submission
10403 \begin_layout Standard
10404 As in the AASTeX package, before you submit your paper to a journal you
10406 \begin_inset Quotes eld
10410 \begin_inset Quotes erd
10416 \begin_layout Enumerate
10417 Export your paper as a LaTeX file.
10418 To do this, click on
10423 ile\SpecialChar \menuseparator
10428 xport\SpecialChar \menuseparator
10439 \begin_layout Enumerate
10444 file with a text editor and make the following changes
10448 \begin_layout Enumerate
10449 remove the comment lines before the
10458 \begin_layout Enumerate
10459 remove everything between (and including) the
10471 commands, except for any commands you specifically put into the LaTeX preamble.
10474 \begin_layout Standard
10483 \begin_layout Enumerate
10488 file through LaTeX as many times as necessary (usually up to three).
10491 \begin_layout Enumerate
10497 \begin_inset space \thinspace{}
10504 , and check if everything is OK (it should, if you didn't make any mistake).
10507 \begin_layout Subsection
10508 \begin_inset Quotes eld
10512 \begin_inset Quotes erd
10515 of the Kluwer package
10516 \begin_inset CommandInset label
10518 name "subsec:kluwer_peculiarities"
10525 \begin_layout Standard
10526 The Kluwer package has the following
10527 \begin_inset Quotes eld
10531 \begin_inset Quotes erd
10537 \begin_layout Enumerate
10538 It is possible to write multiple articles in the same LaTeX file
10542 \begin_layout Plain Layout
10543 I can't imagine any good reason to do this.
10549 Each article must be included in the environment
10550 \begin_inset Quotes eld
10554 \begin_inset Quotes erd
10558 Unfortunately, this environment cannot be omitted, even if you write just
10560 Therefore, each article starts with the command
10566 and, obviously, ends with the command
10573 Although this can be implemented in LyX, I didn't included it, since it
10574 looks ugly and can confuse the novice user.
10575 Therefore, you need to enter them directly and mark them as LaTeX code
10577 \begin_inset Quotes eld
10581 \begin_inset Quotes erd
10587 \begin_layout Enumerate
10588 Information given at the beginning of the article (i.e., title, subtitle,
10589 author, institution, running title, running author, abstract and keywords)
10590 must be included in an environment called
10591 \begin_inset Quotes eld
10595 \begin_inset Quotes erd
10599 This is not implemented in LyX, so you must enter title, subtitle etc.
10600 \begin_inset space ~
10603 between two ERT lines (
10618 \begin_layout Enumerate
10619 According to the user manual, the label of each bibliography item must be
10643 \begin_layout Standard
10648 template takes care of all these
10649 \begin_inset Quotes eld
10653 \begin_inset Quotes erd
10657 If you start a new paper using this template you don't need to do anything
10662 \begin_layout Enumerate
10663 don't delete the ERT included in the template, and
10666 \begin_layout Enumerate
10667 copy the example bibliography item included in the template and modify it
10668 as necessary to enter new bibliography items.
10671 \begin_layout Section
10675 \begin_layout Standard
10681 \begin_layout Subsection
10685 \begin_layout Standard
10686 The LyX document classes
10688 article (koma-script)
10692 report (koma-script)
10710 correspond to the LaTeX document classes
10727 \begin_inset space ~
10730 of the Koma-Script family.
10731 They are replacements for the standard document classes
10747 , resp., and fit better to European typography conventions in a number of
10751 \begin_layout Itemize
10752 Standard character size is 11pt in
10754 article (koma-script)
10758 report (koma-script)
10766 letter (koma-script)
10771 \begin_layout Itemize
10772 Headings, labels of the description environment, and a number of elements
10775 letter (koma-script)
10777 document class are set in a bold sans serif font.
10781 \begin_layout Plain Layout
10782 There is a big difference between the bold sans serif old cm fonts and new
10783 ec fonts, especially in the appearance of headings.
10784 In comparison, the ec bold sans serif fonts look a bit thin.
10785 Here the LaTeX package
10793 helps to produce the
10794 \begin_inset Quotes eld
10798 \begin_inset Quotes erd
10801 appearance when using the ec fonts.
10806 The numbering of chapter headings is made in the same way as the numbering
10807 of section headings, that is without the extra line
10808 \begin_inset Quotes eld
10811 Chapter\SpecialChar \ldots{}
10813 \begin_inset Quotes erd
10817 In addition, the appearance of the headings can be modified by using a
10818 number of options (in LyX to be entered in the field
10825 \begin_inset space ~
10835 ayout\SpecialChar \menuseparator
10843 A detailed German description of these options can be found in the Koma-Script
10851 \begin_layout Itemize
10852 The main means in the Koma-Script document classes to design the type area
10861 (in LyX to be entered in the extra class options field in the dialog
10866 ocument\SpecialChar \menuseparator
10874 They make a clearer modification of page margins possible as do the options
10880 ocument\SpecialChar \menuseparator
10888 A detailed German description of these and other type area options can
10889 be found in the Koma-Script documentation
10896 \begin_layout Itemize
10897 The LaTeX document classes of the Koma-Script family define a number of
10898 additional commands.
10899 Those part of it which makes sense in LyX is implemented in corresponding
10903 \begin_layout Standard
10904 A detailed German description of the LaTeX document classes of the Koma-Script
10905 family can be found in the Koma-Script documentation
10913 \begin_layout Plain Layout
10914 There is an English translation
10918 , but it is not a complete one.
10923 The following sections describe only those aspects, which are relevant
10927 \begin_layout Subsection
10928 article (koma-script), report (koma-script), and book (koma-script)
10931 \begin_layout Standard
10932 The document classes
10934 article (koma-script)
10938 report (koma-script)
10948 are implemented in the layout files
10961 They contain all the paragraph types of the corresponding standard document
10974 , resp., partly modified, with the exception of the LyX specific
10978 -type, which is replaced by the new
10982 -type having the same functionality.
10987 -Type there is a number of new paragraph types added.
10994 letter (koma-script)
10999 \begin_layout Itemize
11008 : are equivalents to
11016 , resp., additionally inserting an entry in the table of contents.
11025 are not contained in
11027 article (koma-script)
11032 \begin_layout Itemize
11041 : behave exactly as
11049 , resp., additionally clearing running heads.
11054 is not contained in
11056 article (koma-script)
11062 \begin_layout Plain Layout
11075 report (koma-script)
11077 , but since this is identical to
11081 , is has not been implemented in LyX.
11089 \begin_layout Itemize
11094 : generates a heading directly above the following paragraph in the standard
11095 character size without affecting the structure of the document.
11098 \begin_layout Itemize
11107 are special captions which respect the different space settings needed
11108 for captions placed above or below an element (if you follow strict typographic
11109 rules, you might want to place table captions always above the table).
11110 You can also use the class option
11114 , which will switch
11127 You need at least Koma-Script version 2.8q to use this.
11130 \begin_layout Itemize
11135 : can be used to set a bonmot, e.
11136 \begin_inset space \thinspace{}
11140 \begin_inset space ~
11143 at the beginning of a chapter.
11144 If you use the optional argument (
11149 nsert\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 ~
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 ~
12188 you can write several letters per document).
12189 New elements are sender's
12205 and the possibility to use a
12214 nsert\SpecialChar \menuseparator
12224 \begin_layout Standard
12225 The biggest improvement is, though, that the letter's layout is configurable
12226 at almost any needs.
12227 This can be done via the preamble or with a special style file (Letter
12228 Class Option, extension
12232 ), that will be read in as a class option.
12236 \begin_layout Plain Layout
12237 The KOMA package comes with some default
12242 There is, for instance, a
12246 file that follows german typesetting rules, or a
12250 that provides the default layout of the old
12255 The latter can be loaded with the class option
12264 ayout\SpecialChar \menuseparator
12269 ocument\SpecialChar \menuseparator
12281 template that is included in LyX for examples.
12282 A detailed description is to be found in the Koma-Script documentation
12290 \begin_layout Subsection
12294 \begin_layout Standard
12295 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12299 \begin_layout Itemize
12300 The chapter number of a
12304 type appears on a line of its own above the chapter heading instead of
12305 appearing in the same line ahead of it.
12306 The cause for that is the LyX internal behavior for the labeltype
12310 in the layout file.
12313 \begin_layout Itemize
12314 The headings of the types
12322 are only put in the
12323 \begin_inset Quotes eld
12327 \begin_inset Quotes erd
12330 LaTeX table of contents, but not in the LyX table of contents (
12335 ocument\SpecialChar \menuseparator
12341 \begin_inset space ~
12345 \begin_inset space ~
12353 \begin_layout Itemize
12354 The paragraphs in a
12358 document class appear in a skip separation mode, not indented.
12359 This is the standard behavior, no special LaTeX commands are needed for
12366 ocument\SpecialChar \menuseparator
12373 dialog the corresponding radio button indicates
12389 value always has the effect that extra LaTeX commands are inserted in the
12390 document to produce the gap, which is not what is wanted in this case.
12393 \begin_layout Section
12394 Latex8 (IEEE Conference Papers)
12397 \begin_layout Standard
12403 \begin_layout Subsection
12407 \begin_layout Standard
12408 Since this class is specifically for writing submissions to IEEE sponsored
12409 conferences I strongly recommend that you get a copy of their Authors Kit.
12414 package and associated bibliography style file is included in the kit.
12415 The Authors Kit is usually sent out by email once your initial submission
12417 There is a lot of useful information in the Authors Kit explaining formatting
12418 restrictions and so on and I will assume you have read this since that
12419 means I don't have to repeat it all here.
12422 \begin_layout Subsection
12426 \begin_layout Standard
12427 [AR\SpecialChar \@.
12431 \begin_layout Subsection
12432 Supported Environments
12435 \begin_layout Itemize
12441 \begin_layout Itemize
12447 \begin_layout Itemize
12453 \begin_layout Itemize
12459 \begin_layout Itemize
12465 \begin_layout Itemize
12471 \begin_layout Itemize
12477 \begin_layout Itemize
12483 \begin_layout Itemize
12489 \begin_layout Subsection
12490 Differences Between Screen and Paper
12493 \begin_layout Standard
12494 There are slight differences in appearance mainly with the presentation
12495 of section counters.
12496 On screen the trailing period of the section counter is missing but it
12497 will appear in the output so don't let this worry you.
12500 \begin_layout Section
12504 \begin_layout Standard
12507 Jürgen Spitzmüller
12510 \begin_layout Subsection
12514 \begin_layout Standard
12515 Memoir is a very powerful and constantly evolving class.
12516 It has been designed with regard to fictional and non-fictional literature.
12517 Its aim is to let the user have maximum control over the typesetting of
12519 Memoir is based on the standard book class, but it can also emulate the
12520 article class (see below).
12523 \begin_layout Standard
12524 Peter Wilson, the developer of Memoir, is known as the author of lots of
12525 useful packages in the LaTeX world.
12526 Most of them have been merged with Memoir.
12527 Therefore, it is much easier to layout the table of contents, appendices,
12528 chapter designs and such.
12529 LyX, though, does not support all of these goodies natively.
12530 Some of them might be added to forthcoming releases
12534 \begin_layout Plain Layout
12535 You are invited to send suggestions to
12536 \begin_inset Flex URL
12539 \begin_layout Plain Layout
12541 lyx-devel@lists.lyx.org
12551 , lots will probably never, due to the limitations of LyX's framework.
12552 Of course you can still use all features with the help of some native LaTeX
12557 \begin_layout Plain Layout
12562 \begin_layout Plain Layout
12572 \begin_inset space ~
12576 \begin_inset CommandInset ref
12578 reference "sec:Inserting-TeX-Code"
12588 In this section, we can only list those features which are natively supported
12590 For detailed descriptions (and for the rest of features) we are recommending
12591 to have a look at the detailed manual of the Memoir class
12595 \begin_layout Plain Layout
12600 \begin_layout Plain Layout
12610 \begin_inset Flex URL
12613 \begin_layout Plain Layout
12615 CTAN:/macros/latex/memoir/memman.pdf
12625 , which is not only a user guide for the class, but also both a comprehensive
12626 description on good typesetting and a superb example for good typesetting
12630 \begin_layout Subsection
12631 Basic features and restrictions
12634 \begin_layout Standard
12635 Memoir supports basically all features of the standard book classes.
12636 There are, however, some differences, as follows:
12639 \begin_layout Description
12641 \begin_inset space ~
12644 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12647 \begin_layout Description
12649 \begin_inset space ~
12652 style: The fancy page style is not supported, due to a command clash between
12653 Memoir and the fancyhdr package (they are both defining a command with
12654 the same name, which confuses LaTeX).
12655 Instead, Memoir comes with a bunch of own page styles (see
12657 Layout\SpecialChar \menuseparator
12658 Document\SpecialChar \menuseparator
12660 \begin_inset space ~
12666 If you want to use these for the chapter pages, you have to use the command
12673 in the main text or in preamble (e.
12674 \begin_inset space \thinspace{}
12678 \begin_inset space ~
12685 chapterstyle{companion}
12690 \begin_layout Description
12691 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12692 an optional argument in the standard classes.
12693 With this, you can specify an alternative version of the title for the
12694 table of contents and the headers (for instance, if the title is too long).
12695 In LyX, you can do this via
12697 Insert\SpecialChar \menuseparator
12699 \begin_inset space ~
12704 at the beginning of a chapter/section.
12705 Memoir features a second optional argument and thus separates the table
12706 of contents from the header.
12707 You can define three variants of a title with this: one for the main text,
12708 one for the table of contents, and one for the headers.
12709 Simply insert two optional arguments if you need this feature, the first
12710 one containing the short title for the Table of Contents, the second one
12711 containing an alternative short title for the headers.
12714 \begin_layout Description
12715 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12716 of contents, the list of figures and the list of table start a new page
12718 Memoir does not follow this route.
12719 You have to insert a page break yourself, if you want to have one.
12722 \begin_layout Description
12723 Titlepage: For some unknown reason, Memoir uses pagination on the title
12724 page (in the standard classes, title pages are
12725 \begin_inset Quotes eld
12729 \begin_inset Quotes erd
12733 \begin_inset space \thinspace{}
12737 \begin_inset space ~
12741 If you want an empty title page, type
12745 aliaspagestyle{title}{empty}
12750 \begin_layout Description
12751 Article: With the class option
12757 Layout\SpecialChar \menuseparator
12758 Document\SpecialChar \menuseparator
12760 \begin_inset space ~
12765 ), you can emulate article style.
12766 That is, counters (footnotes, figures, tables etc.) will not be reset on
12767 new chapters, chapters don't start a new page (but are---in contrary to
12769 \begin_inset Quotes eld
12773 \begin_inset Quotes erd
12776 article classes---still allowed), parts, though, use their own page, as
12780 \begin_layout Description
12781 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12782 font commands, which have been used in the old LaTeX version 2.09 (e.
12783 \begin_inset space \thinspace{}
12787 \begin_inset space ~
12803 It produces an error and stops LaTeX whenever such a command appears.
12808 reallows the commands and spits out warnings instead (which does at least
12810 Since a lot of packages and particularly BibTeX style files are still using
12811 those commands, we have decided to use this option by default.
12814 \begin_layout Subsection
12818 \begin_layout Standard
12819 We will only describe the features supported by LyX (which is not much currently
12821 Please consult the Memoir manual
12825 \begin_layout Plain Layout
12830 \begin_layout Plain Layout
12840 \begin_inset Flex URL
12843 \begin_layout Plain Layout
12845 CTAN:/macros/latex/memoir/memman.pdf
12858 \begin_layout Description
12859 Abstract: You may wonder why an abstract is an extra feature.
12860 Well, it is in book class.
12861 Usually books don't have abstracts.
12862 Memoir, however, has.
12863 You can use it wherever and how often you like.
12866 \begin_layout Description
12867 Chapterprecis: You may know this from belletristic: The contents of a chapter
12868 is shortly described below the title and also in the table of contents
12870 \begin_inset space \thinspace{}
12874 \begin_inset space ~
12879 Our hero arrives in Troia; he loses some friends; he finds others
12882 Chapterprecis does exactly this.
12883 It is therefore only sensible below a chapter.
12886 \begin_layout Description
12887 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12888 The epigraph environment provides an elegant way of typesetting such a
12890 The motto itself (text) and its author (source) are divided by a short
12892 Unfortunately, we have to fool LyX a bit here again, since the environment
12893 needs two arguments (text and source).
12894 In this case, we have to use curly brackets (in TeX mode) between the two
12905 <author of the slogan>.
12908 \begin_layout Description
12909 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12910 complex figurative poems).
12911 LyX can only support a few of them.
12912 One is poemtitle, which is a centered title for poems, which will also
12913 be added to the table of contents (verse is the standard environment for
12915 Memoir has some enhanced versions of verse, but you need to use ERT, because
12916 they have to be nested inside regular verse environments, which is not
12917 possible with LyX).
12920 \begin_layout Description
12921 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12924 \begin_layout Section
12925 Article (mwart), book (mwbk) and report (mwrep)
12926 \begin_inset OptArg
12929 \begin_layout Plain Layout
12942 \begin_layout Standard
12948 \begin_layout Standard
12949 The LyX document classes
12965 correspond to the LaTeX document classes
12978 They are replacements for the standard document classes
12990 , resp., and fit better to Polish typography conventions in a number of points.
12994 \begin_layout Standard
12998 \begin_layout Itemize
12999 Unnumbered titles (with star, eg.
13004 ) are added into table of contents,
13007 \begin_layout Itemize
13008 Additional page styles:
13012 \begin_layout Description
13013 uheadings header with separated lines,
13016 \begin_layout Description
13017 myheadings custom header, contents headers via commands:
13032 \begin_layout Description
13033 myuheadings custom header with separated lines,
13036 \begin_layout Description
13037 outer page number is placed on outer side of page
13041 \begin_layout Itemize
13046 \begin_layout Description
13047 rmheadings serif titles --- default,
13050 \begin_layout Description
13051 sfheadings sansserif titles,
13054 \begin_layout Description
13055 authortitle on title page first placed is author next title --- default,
13058 \begin_layout Description
13059 titleauthor on title page first placed is title next author,
13062 \begin_layout Description
13063 withmarginpar reserve place on page for margins.
13067 \begin_layout Section
13071 \begin_layout Standard
13076 provides an alternative to the standard
13081 It provides similar functionality, but you might prefer this layout with
13082 sans serif sections, headings, and more.
13085 \begin_layout Section
13089 \begin_layout Standard
13095 \begin_layout Standard
13096 \begin_inset VSpace bigskip
13102 \begin_layout Standard
13107 \begin_inset space ~
13112 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13113 \begin_inset Formula $\beta$
13116 release of May, 1999) class.
13119 \begin_layout Standard
13124 textclass, which works with RevTeX 3.1.
13125 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13126 That means that it doesn't interact very well with LyX, which requires
13127 LaTeX2e, although it has been kludged to work.
13128 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13132 \begin_inset space ~
13137 textclass should also be pretty easy to use.
13140 \begin_layout Standard
13141 These documents are supposed to be used in
13145 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13146 macros, and assume you'll know what to put in the preamble if necessary.
13149 \begin_layout Subsection
13153 \begin_layout Standard
13154 All you need to do is install RevTeX 4, as described in the package's README
13156 The package can be found at The RevTeX 4 Web Site
13157 \begin_inset Flex URL
13160 \begin_layout Plain Layout
13162 http://publish.aps.org/revtex4/
13168 Install it somewhere that LaTeX can see it.
13169 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13170 (i.e., not the directory where you installed the class file.) Then, if you
13171 reconfigure LyX, it will find the class file and let you use the RevTeX4
13175 \begin_layout Standard
13176 Probably the easiest way to get started is either to import a RevTeX 4 document
13184 \begin_inset space ~
13189 template, found in the templates directory.
13192 \begin_layout Subsection
13196 \begin_layout Standard
13197 Optional arguments to
13204 \begin_inset Quotes eld
13208 \begin_inset Quotes erd
13212 \begin_inset Quotes eld
13216 \begin_inset Quotes erd
13226 \begin_inset space ~
13234 \begin_inset space ~
13240 Remember that in RevTeX, at least one optional argument is required!
13243 \begin_layout Standard
13244 Other preamble matter, like
13251 \begin_inset space ~
13261 \begin_inset space ~
13266 dialog, also as usual.
13269 \begin_layout Subsection
13273 \begin_layout Standard
13274 The layouts basically correspond to the commands in RevTeX4.0.
13275 For example, the Email layout corresponds to
13282 Note that (at least as of RevTeX 4.0 Beta), the
13290 layouts are exactly equivalent, so you shouldn't need to use both.
13294 \begin_layout Plain Layout
13295 In case you're curious, both were included so that
13299 would be able to translate both
13319 \begin_layout Subsection
13323 \begin_layout Standard
13324 There are a couple of important unique aspects of RevTeX 4 which might cause
13325 bugs that will be even more confusing in LyX.
13328 \begin_layout Standard
13346 The LyX equivalent is that there is a separate Thanks layout.
13351 write footnotes in the
13355 layout, or weird things may happen.
13356 See the RevTeX 4 documentation for more details.
13359 \begin_layout Standard
13363 \begin_inset space ~
13371 \begin_inset space ~
13380 layouts must be placed
13388 layout and the corresponding
13405 , the LaTeX won't compile.
13408 \begin_layout Subsection
13412 \begin_layout Standard
13413 The main problem with this layout is that you can't use the optional arguments
13414 to layouts like Email and Title.
13415 (The problem is not unique to this layout; you can't use optional arguments
13416 to the Section layouts either.) This means that after you export that file
13417 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13418 need to edit the LaTeX file with a text editor to add the optional arguments
13420 \begin_inset space \thinspace{}
13423 g., the running title for the page headers.
13424 Lacking these layouts makes the
13430 (and the equivalent
13436 ) useless, so the corresponding layouts don't exist, and will have to be
13441 \begin_layout Plain Layout
13446 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13447 has not been updated yet to take advantage of it.
13455 \begin_layout Section
13456 Springer Journals (
13463 \begin_layout Standard
13469 \begin_layout Subsection
13473 \begin_layout Standard
13474 These are the layout files for some of the journal formats used by Springer
13475 Verlag and listed on
13476 \begin_inset Flex URL
13479 \begin_layout Plain Layout
13481 http://www.springer.de/author/tex/help-journals.html
13486 , where you should also go to fetch the class files (yes, these are LaTeX2e
13488 It is a modular system: the things common to all journals are implemented
13493 , which journal-specific layout files (such as, e.
13494 \begin_inset space \thinspace{}
13501 for Journal of Geodesy) can include.
13504 \begin_layout Standard
13505 This means that implementing support for any other Springer journal on this
13506 list is as simple as writing your own
13514 file following the outline given in
13522 \begin_layout Standard
13523 It is reasonably well tested only for the Journal of Geodesy.
13532 come with the standard LyX distribution.
13533 Install the relevant class file (downloaded from Springer) in a proper
13534 directory, reconfigure LaTeX (in the teTeX case by running
13538 , as root if necessary --- doesn't LyX take care of this?), reconfigure
13539 LyX and it should work.
13542 \begin_layout Subsection
13546 \begin_layout Standard
13547 A large number of theorem-like styles ---
13553 \SpecialChar \ldots{}
13559 \begin_layout Standard
13562 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13563 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13566 See the Springer class file documentation for details.
13569 \begin_layout Subsection
13573 \begin_layout Itemize
13585 \begin_layout Itemize
13588 Probability Theory and Related Fields
13594 --- Jean-Marc Lasgouttes
13597 \begin_layout Standard
13598 Add your own, it isn't so hard!
13601 \begin_layout Subsection
13605 \begin_layout Standard
13606 These files are partly based on the older
13610 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13611 file from Springer.
13616 layout, are now defunct.
13617 Jean-Marc Lasgouttes helped out big in making me find my way around the
13618 LyX layout file mechanism.
13621 \begin_layout Subsection
13625 \begin_layout Standard
13627 But probably less than in the old hacked-LaTeX
13634 \begin_layout Standard
13636 \begin_inset space \thinspace{}
13639 g.: does not display the number for theorem-like layouts, just #.
13642 \begin_layout Section
13648 \begin_inset CommandInset label
13657 \begin_layout Standard
13665 \begin_layout Subsection
13669 \begin_layout Standard
13670 This section describes how to use LyX to make slides for overhead projectors.
13671 There are two document classes that can do this: the default slides class
13677 This section documents the former.
13680 \begin_layout Standard
13681 I'm going to say this again, nice and clear, so that there's no misunderstanding
13685 \begin_layout Standard
13686 \begin_inset VSpace bigskip
13692 \begin_layout Standard
13696 This section documents the class
13697 \begin_inset Quotes eld
13705 \begin_inset Quotes erd
13713 \begin_layout Standard
13714 \begin_inset VSpace bigskip
13720 \begin_layout Standard
13721 If you're looking for the documentation for
13722 \begin_inset Quotes eld
13730 \begin_inset Quotes erd
13733 , check out section
13734 \begin_inset space ~
13738 \begin_inset CommandInset ref
13740 reference "sec:foiltex"
13750 \begin_inset Quotes eld
13758 \begin_inset Quotes erd
13761 ] is actually somewhat better than the default
13769 \begin_layout Plain Layout
13770 \SpecialChar \ldots{}
13771 or so I've been told repeatedly by its advocates.
13772 Having never used it, I have no idea if this claim is true or not.
13777 which this section documents.
13780 \begin_layout Standard
13781 This class is the LaTeX2e improvement of the old
13786 Every LaTeX2e distribution includes this class [which I'll just refer to
13788 \begin_inset Quotes eld
13796 \begin_inset Quotes erd
13799 from now on], so you're bound to have it.
13800 As I noted earlier, there are other classes, such as
13804 , which also produce slides for overhead projectors and do a better job
13806 However, there are some things which
13810 can do which the others can't, such as generate overlays.
13811 Read on to learn more!
13814 \begin_layout Subsection
13816 \begin_inset CommandInset label
13818 name "sec:slidesetup"
13825 \begin_layout Standard
13826 Obviously, to use this document class, you need to select
13827 \begin_inset Quotes eld
13835 \begin_inset Quotes erd
13838 from the class list in the
13843 ocument\SpecialChar \menuseparator
13851 There are some other special things you should know about this class:
13854 \begin_layout Itemize
13855 Don't bother changing the options
13860 They're not supported by the
13867 \begin_layout Itemize
13874 \begin_inset space ~
13879 behaves a bit differently for this class.
13880 The possible choices and what they do are as follows:
13884 \begin_layout Description
13889 The final output contains page numbers in the lower right corner.
13892 \begin_layout Description
13901 , but also prints out any time markers you've put in.
13902 This is the default.
13905 \begin_layout Description
13910 The final output contains no page numbers, time markers, or alignment markers.
13914 \begin_layout Itemize
13919 class has an extra option:
13925 \begin_inset Quotes eld
13933 \begin_inset Quotes erd
13936 in the extra class options.
13940 \begin_layout Standard
13941 Using this options allows you to add time markers to
13947 \begin_inset space ~
13951 \begin_inset CommandInset ref
13953 reference "sec:slideNote"
13961 \begin_layout Standard
13962 You can also use the template file
13963 \begin_inset Quotes eld
13971 \begin_inset Quotes erd
13974 to automatically set up a document to use the
13983 ile\SpecialChar \menuseparator
13985 \begin_inset space ~
13989 \begin_inset space ~
13998 to open your new document].
13999 The template file also contains some examples of the special paragraph
14000 environments used by this class.
14001 I'll describe those next.
14004 \begin_layout Subsection
14005 Paragraph Environments
14008 \begin_layout Subsubsection
14009 Supported Environments
14012 \begin_layout Standard
14013 The first thing you'll notice when you start up a new
14017 document is the font size and type: it's the equivalent of the size
14018 \begin_inset Quotes eld
14026 \begin_inset Quotes erd
14032 \begin_inset space ~
14038 This is also what's used in the output.
14040 \begin_inset Quotes eld
14044 \begin_inset Quotes erd
14047 to remind you that this is a slide.
14048 Your final slides will use a larger font; ergo, you'll have less space.
14049 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14052 \begin_layout Standard
14053 The next thing that becomes obvious is the changes to the paragraph environment
14054 pull-down box [at the far-left end of the toolbar].
14055 Most of the paragraph environments you're used to seeing are missing.
14056 There are also five new ones.
14061 class itself only supports certain paragraph environments:
14064 \begin_layout Itemize
14070 \begin_layout Itemize
14076 \begin_layout Itemize
14082 \begin_layout Itemize
14088 \begin_layout Itemize
14094 \begin_layout Itemize
14100 \begin_layout Itemize
14106 \begin_layout Itemize
14112 \begin_layout Itemize
14118 \begin_layout Itemize
14124 \begin_layout Itemize
14130 \begin_layout Standard
14131 All of the other standard environments, including the section-heading environmen
14132 ts, aren't used in the
14139 \begin_layout Standard
14140 On the other hand, you'll notice the following new environments:
14143 \begin_layout Itemize
14149 \begin_layout Itemize
14155 \begin_layout Itemize
14161 \begin_layout Itemize
14167 \begin_layout Itemize
14173 \begin_layout Standard
14174 These five are kind of quirky, due to a
14175 \begin_inset Quotes eld
14179 \begin_inset Quotes erd
14183 You see, LyX doesn't permit you to nest any other paragraph environment
14184 into an empty environment.
14185 Now, that's fine and dandy, but it means that you wouldn't be able to start
14186 a slide with anything except plain text.
14187 To deal with this, I've performed a little
14188 \begin_inset Quotes eld
14192 \begin_inset Quotes erd
14198 \begin_layout Subsubsection
14199 Quirks of the New Environments
14200 \begin_inset CommandInset label
14202 name "sec:slideQuirk"
14209 \begin_layout Standard
14210 All five of the new paragraph environments are somewhat quirky due to inherent
14211 limitiations in the current version of LyX.
14212 As I just mentioned, LyX forbids environments that begin with another environme
14214 To get around this, the
14218 environment isn't a paragraph environment as described in the
14226 \begin_layout Standard
14227 You should consider
14240 \begin_inset Quotes eld
14243 pseudo-environments.
14244 \begin_inset Quotes erd
14247 They look like a section heading or a
14248 \begin_inset Quotes eld
14256 \begin_inset Quotes erd
14259 but really begin a [and, if necessary, end the previous] paragraph environment.
14269 \begin_inset Quotes eld
14273 \begin_inset Quotes erd
14276 These two perform some action.
14279 \begin_layout Standard
14280 A common feature of all five environments,
14300 , is a rather long-ish label.
14301 The text following this label --- ordinarily the contents of the paragraph
14302 environment --- is utterly irrelevant for
14323 LyX completely ignores it.
14324 In fact, you can leave these five environments completely empty.
14328 \begin_layout Standard
14333 to put any text after the rather long-ish label, you might want to.
14334 This could be a short description of the contents of the
14339 In that case, enter in your descriptive comment and hit
14343 as you normally would.
14346 \begin_layout Standard
14347 If, on the other hand, you don't want to enter in any descriptive text,
14348 you'll hit another LyX quirk.
14349 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14350 environment until you put something in the old one.
14354 \begin_layout Itemize
14355 Start entering the text that will
14383 \begin_layout Itemize
14384 Now move to the beginning of that paragraph.
14388 \begin_layout Itemize
14397 \begin_layout Itemize
14398 Finally, change this new, empty paragraph to a
14422 \begin_layout Standard
14423 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14427 \begin_layout Subsection
14428 Making a Presentation with
14441 \begin_layout Subsubsection
14449 \begin_layout Standard
14450 If you're expecting this section to teach you how to actually make a presentatio
14451 n, you'll be sorely disappointed.
14452 Naturally, I'll describe all of the ways the
14456 class can assist you in preparing the materials for a presentation.
14457 Filling in the contents, however, is up to you.
14462 the LyX philosophy.]
14465 \begin_layout Standard
14470 environment [in the manner described in section
14471 \begin_inset space ~
14475 \begin_inset CommandInset ref
14477 reference "sec:slideQuirk"
14481 ] tells LyX to begin a new slide [duh].
14482 The label for this environment/
14483 \begin_inset Quotes erd
14487 \begin_inset Quotes erd
14491 \begin_inset Quotes eld
14495 \begin_inset Quotes erd
14498 in cool blue, followed by the label,
14499 \begin_inset Quotes eld
14503 \begin_inset Quotes erd
14507 Any text or paragraph environments that follow this one go on the new slide.
14511 \begin_layout Standard
14512 Slides are probably the only time you'll need to forcibly end pages in LyX
14513 (this can be specified in the
14518 In fact, you'll want to, once you finish entering the contents of one slide.
14519 If you've entered more text than can physically fit on a slide, the extra
14520 overflows onto a new slide.
14521 I don't recommend doing this, however, since the overflow slide won't have
14522 any page number on it.
14523 Furthermore, it may interfere with any
14527 you've made to accompany the oversized
14534 \begin_layout Standard
14543 environments work the same way as the
14548 They both create an
14549 \begin_inset Quotes eld
14553 \begin_inset Quotes erd
14556 followed by a label [
14557 \begin_inset Quotes eld
14561 \begin_inset Quotes erd
14565 \begin_inset Quotes eld
14569 \begin_inset Quotes erd
14573 The color is a stunning magenta instead of blue, and the
14574 \begin_inset Quotes eld
14578 \begin_inset Quotes erd
14581 will look different, in style and in length.
14582 The label fonts of all three also differ from one another.
14585 \begin_layout Standard
14590 , if the contents of a
14598 exceed the physical size of a slide or sheet of paper, the extra will overflow
14600 Again, you should avoid this.
14601 It defeats the whole purpose of
14612 \begin_layout Subsubsection
14622 \begin_layout Standard
14627 is a slide that sits atop another slide.
14628 Perhaps you wish to discuss a figure on the main
14632 before displaying the text associated with it.
14633 One way to accomplish this is tape a flap of dark paper over the part of
14638 you want to display later.
14639 This method fails, however, if you wish to overlap one graph with another,
14641 You would then have to fumble while speaking to align the two separate,
14646 s to align the two graphs.
14651 environment in both cases makes life much easier.
14654 \begin_layout Standard
14659 receives the page number of its
14660 \begin_inset Quotes eld
14664 \begin_inset Quotes erd
14672 \begin_inset Quotes eld
14680 \begin_inset Quotes erd
14687 \begin_layout Plain Layout
14688 Presumably, mutliple
14693 \begin_inset Quotes eld
14701 \begin_inset Quotes erd
14705 \begin_inset Quotes eld
14713 \begin_inset Quotes erd
14717 \begin_inset Quotes eld
14725 \begin_inset Quotes erd
14729 \begin_inset space ~
14732 appended to the page number of the parent
14742 Clearly, you want the contents of both the
14750 to each fit on a single physical slide! You should probably consider an
14756 \begin_inset Quotes eld
14760 \begin_inset Quotes erd
14772 class provides a visual cue for this: the label at the start of an
14776 is shorter than that at the start of a
14781 Lastly, when you generate printable output, you'll find alignment markers
14782 in all four corners of both the
14786 page and its parent
14791 These will assist you in lining up the two physical slides.
14794 \begin_layout Standard
14795 The major problem in overlaying two slides is aligning the contents of the
14796 two transparencies.
14797 How much space should you leave for that graph on the second slide? Worse
14798 still, what if you want a graph and a sentence on second slide, but there
14799 is text on the main transparency that goes in between them? You could try
14800 and insert vertical space of the right size.
14801 The better way is to use
14812 \begin_layout Standard
14813 As their names imply,
14821 are two command-like paragraph environments that make all subsequent text
14822 invisible and visible, respectively.
14824 \begin_inset space ~
14828 \begin_inset CommandInset ref
14830 reference "sec:slideQuirk"
14834 that you don't place anything
14838 these two environments, however.
14843 , it inserts a centered, sky-blue label into the page reading
14844 \begin_inset Quotes eld
14847 <Invisible Text Follows>
14848 \begin_inset Quotes erd
14852 For paragraphs following this label, the parts of the
14860 ; it doesn't matter which] where they would be contain instead blank space.
14864 \begin_layout Standard
14869 , the corresponding centered label is
14870 \begin_inset Quotes eld
14873 <Visible Text Follows>
14874 \begin_inset Quotes erd
14878 Paragraphs following this label behave normally.
14879 Note that the beginning of a new
14891 automatically shuts off an
14896 It's therefore not necessary to use
14907 \begin_layout Standard
14908 By now, it should be obvious how to create overlay transparencies using
14909 the proper combination of
14928 \begin_layout Enumerate
14933 , including everything that will appear on it, whether on the main slide
14941 \begin_layout Enumerate
14942 Before each figure or paragraph that will appear only on the
14951 If necessary, insert a
14955 environment after the
14962 \begin_layout Enumerate
14967 immediately following the
14974 \begin_layout Enumerate
14975 Copy the contents of this
14986 \begin_layout Enumerate
14991 , change all of the
15002 \begin_layout Standard
15004 You've just made an
15011 \begin_layout Standard
15012 There's one problem with the way I've designed the LyX
15016 class: you can't make text in the middle of a paragraph invisible, nor
15017 make text in the middle of an invisible paragraph visible again.
15018 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15022 \begin_layout Plain Layout
15023 The commands of interest are:
15026 \begin_layout Itemize
15031 invisible \SpecialChar \ldots{}
15035 \begin_layout Itemize
15040 visible \SpecialChar \ldots{}
15044 \begin_layout Plain Layout
15045 \SpecialChar \ldots{}
15046 and need to be marked as TeX.
15048 \begin_inset Quotes eld
15052 \begin_inset Quotes erd
15055 you wish to change goes in between the brackets [and after the
15068 If you don't know how to mark text as TeX, see the appropriate section
15081 \begin_layout Subsubsection
15091 \begin_inset CommandInset label
15093 name "sec:slideNote"
15100 \begin_layout Standard
15109 is associated with a
15110 \begin_inset Quotes eld
15114 \begin_inset Quotes erd
15126 class provides visual cues.
15131 is shorter than that of a
15135 [yet longer than that of an
15139 ] and, like the label of an
15143 is shockingly magenta.
15144 Additionally, the printed
15148 has the page number of its
15149 \begin_inset Quotes eld
15153 \begin_inset Quotes erd
15161 \begin_inset Quotes eld
15169 \begin_inset Quotes erd
15173 \begin_inset Quotes eld
15181 \begin_inset Quotes erd
15185 \begin_inset Quotes eld
15193 \begin_inset Quotes erd
15197 You can have multiple
15201 s associated with a single
15213 , you'll probably want to break up long
15217 s so that they fit on a single sheet of paper.
15220 \begin_layout Standard
15225 is obvious: it contains anything additional you might want to say about
15231 It could also be used as a sheet of reminders for a particular
15236 In the case of the latter, you might want to make use of time markers.
15242 \begin_inset Quotes eld
15246 \begin_inset Quotes erd
15249 support for time markers, a
15254 So, you'll have to resort to using the LaTeX codes.
15257 \begin_layout Standard
15258 To use time markers, you'll need to specify the extra class option
15259 \begin_inset Quotes eld
15267 \begin_inset Quotes erd
15271 \begin_inset space ~
15275 \begin_inset CommandInset ref
15277 reference "sec:slidesetup"
15282 This option turns on timing marks, which will appear in the lower-left-hand
15288 To set what appears in the time marker, you use the LaTeX commands
15289 \begin_inset Quotes eld
15299 \begin_inset Quotes erd
15303 \begin_inset Quotes eld
15313 \begin_inset Quotes erd
15317 The arguments of both commands are time measured in seconds.
15319 \begin_inset Quotes eld
15329 \begin_inset Quotes erd
15332 sets the time marker to a given time.
15334 \begin_inset Quotes eld
15344 \begin_inset Quotes erd
15347 increments the time marker by the specified amount.
15348 Using time markers and
15352 s in this fashion, you can remind yourself how much time to spend on a particula
15360 \begin_layout Standard
15361 There's one last feature to describe.
15362 Clearly, you'd like to print out all of your
15370 s on transparencies while printing all of your
15387 with which it is associated.
15388 What's a person to do?
15391 \begin_layout Standard
15392 Luckily, there are two LaTeX commands that allow you to select what to print
15394 Both must be placed into the preamble of your document.
15396 \begin_inset Quotes eld
15408 \begin_inset Quotes erd
15411 will cause the output to contain only the
15420 Correspondingly, the command
15421 \begin_inset Quotes eld
15433 \begin_inset Quotes erd
15436 prevents the output of anything but
15441 I'd advise placing both commands in the preamble and initially comment
15443 You can then preview your entire presentation as you write.
15444 When you're done writing, you can then uncomment one of the two to select
15445 what you want to print.
15446 I like to uncomment
15447 \begin_inset Quotes eld
15459 \begin_inset Quotes erd
15462 , print to a file with
15463 \begin_inset Quotes eld
15471 \begin_inset Quotes erd
15474 in its name, comment it back out, then uncomment
15475 \begin_inset Quotes eld
15487 \begin_inset Quotes erd
15491 \begin_inset Quotes eld
15499 \begin_inset Quotes erd
15503 I can then send either file to a printer, loading transparencies or plain
15504 paper as appropriate.
15507 \begin_layout Standard
15508 You can also provide other arguments to the
15509 \begin_inset Quotes eld
15519 \begin_inset Quotes erd
15523 \begin_inset Quotes eld
15533 \begin_inset Quotes erd
15537 See a good LaTeX book for details.
15540 \begin_layout Subsection
15545 Class Template File
15548 \begin_layout Standard
15549 I have also provided a template file,
15550 \begin_inset Quotes eld
15558 \begin_inset Quotes erd
15566 To use it, begin your new presentation with
15571 ile\SpecialChar \menuseparator
15573 \begin_inset space ~
15577 \begin_inset space ~
15587 Your new LyX presentation file will contain an example
15608 additionally contain an example of the use of
15617 Lastly, the preamble will contain:
15620 \begin_layout LyX-Code
15621 % Uncomment to print out only slides and overlays
15624 \begin_layout LyX-Code
15628 \begin_layout LyX-Code
15634 \begin_inset Newline newline
15640 \begin_layout LyX-Code
15641 % Uncomment to print out only notes
15644 \begin_layout LyX-Code
15648 \begin_layout LyX-Code
15656 \begin_layout Standard
15657 One final thing: I created this class to support the LaTeX2e
15658 \begin_inset Quotes eld
15666 \begin_inset Quotes erd
15669 class, one of the built-in LaTeX2e classes.
15670 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15671 built-in slide class.
15672 It's here if you want it or need it.
15673 There exist other LaTeX2e classes for creating presentations, such as the
15679 \begin_inset space ~
15683 \begin_inset CommandInset ref
15685 reference "sec:foiltex"
15690 \begin_inset Quotes eld
15698 \begin_inset Quotes erd
15701 package [present on some TeX distributions].
15702 The latter is not yet supported under LyX.
15706 \begin_layout Plain Layout
15707 Perhaps you can take on the task\SpecialChar \ldots{}
15713 I know nothing about these other classes.
15714 Try them out to see what sort of alternative they provide.
15717 \begin_layout Chapter
15718 LyX Features needing Extra Software
15721 \begin_layout Section
15725 \begin_layout Standard
15731 \begin_layout Subsection
15735 \begin_layout Standard
15740 program installed, you'll find in the
15747 \begin_inset space ~
15758 \begin_inset CommandInset href
15760 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15767 \begin_layout Standard
15772 package is a program that was written by
15773 \begin_inset Flex CharStyle:Noun
15776 \begin_layout Plain Layout
15778 \begin_inset space ~
15786 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15787 and easy to forget.
15788 The program runs over your LaTeX file, checks the integrity of the file,
15789 and flags some common errors.
15790 In other technical words, it is
15797 \begin_layout Standard
15798 Well, what is a syntax checker doing in LyX which is supposed to produce
15799 correct LaTeX anyways? The answer is simple: Just as
15803 not only checks the
15807 of C programs, but also does
15811 checks for type-errors,
15815 catches some common
15819 errors, in addition to the syntactical ones.
15824 is capable of detecting several common errors, such as
15827 \begin_layout Itemize
15828 Ellipsis detection:
15829 \begin_inset Newline newline
15832 Use \SpecialChar \ldots{}
15836 \begin_layout Itemize
15837 No space in front of/after parenthesis:
15838 \begin_inset Newline newline
15844 \begin_layout Itemize
15845 Enforcement of normal space after common abbreviations:
15846 \begin_inset Newline newline
15851 is too wide spacing.
15854 \begin_layout Itemize
15855 Enforcement of end-of-sentence space when the last sentence ends with a
15857 \begin_inset Newline newline
15861 And this is wrong spacing.
15864 \begin_layout Itemize
15865 Space in front of labels and similar commands:
15866 \begin_inset Newline newline
15869 The label should stick right up to the text to avoid falling to a wrong
15872 \begin_inset CommandInset label
15882 \begin_layout Plain Layout
15883 This footnote is in danger of falling off to a wrong page
15888 The label is separated too much.
15891 \begin_layout Itemize
15892 Space in front of references, instead of hard spaces:
15893 \begin_inset Newline newline
15896 In you are in bad luck, the text will break right between the referenced
15897 text and reference number, and that's a pity.
15899 \begin_inset CommandInset ref
15901 reference "sec:chktex"
15908 \begin_layout Itemize
15910 \begin_inset Quotes eld
15914 \begin_inset Quotes erd
15918 \begin_inset Formula $\times$
15922 \begin_inset Newline newline
15925 2x2 looks cheap compared to
15926 \begin_inset Formula $2\times2$
15932 \begin_layout Standard
15933 and more \SpecialChar \ldots{}
15934 It is an invaluable tool when you are
15935 \begin_inset Quotes eld
15939 \begin_inset Quotes erd
15942 your document before printing, and you should run it right after the obligatory
15943 spelling check, and before you go fine tuning the typesetting.
15946 \begin_layout Subsection
15950 \begin_layout Standard
15951 If you have the program installed, usage is as simple as choosing
15956 ools\SpecialChar \menuseparator
15962 \begin_inset space ~
15968 This will make LyX generate a LaTeX file of your document, start
15972 to check it, and then make LyX insert
15973 \begin_inset Quotes eld
15977 \begin_inset Quotes erd
15980 with the warnings from
15984 , if there were any.
15985 The warnings will be placed close to the point of the mistake, and you
15986 can quickly find them by using the
15991 avigate\SpecialChar \menuseparator
15998 menu item, or the shortcut key
16007 Open the error boxes by clicking on them with the mouse, or use the shortcut
16016 bindings, or the corresponding
16025 Read the warning and correct the mistake, if it is a mistake.
16026 If you have trouble understanding what the warning is about, you can safely
16028 Remember that there is a hidden layer between the document on screen and
16029 the technical details in invoking
16033 , and this gap can make some warnings seem arcane or just right down plain
16037 \begin_layout Standard
16038 This document is an excellent testing bed for the feature, and it should
16039 provide quite a few warnings for you to fiddle with.
16040 Since computers are only so smart, expect most of the warnings to be false
16044 \begin_layout Subsection
16045 How to fine tune it
16048 \begin_layout Standard
16049 Sometimes, you'll find that
16053 makes more noise than suits your mood.
16054 Then you can choose not to use it, wait until your mood changes, or try
16059 to get better along with you.
16060 Another choice in the most desperate situations is to use
16065 iew\SpecialChar \menuseparator
16071 \begin_inset space ~
16075 \begin_inset space ~
16079 \begin_inset space ~
16084 , which will get rid of all warnings instantly.
16087 \begin_layout Standard
16096 very configurable and extensible, you shouldn't expect to solve all problems
16102 Since LyX has to generate a somewhat special LaTeX file to be able to match
16103 the line numbers from the
16111 \begin_layout Plain Layout
16112 You can inspect the specific output from
16118 Edit\SpecialChar \menuseparator
16120 \begin_inset space ~
16124 \begin_inset space ~
16138 to the internal document structure, some of the warnings will not seen
16139 to appear correctly.
16140 There are two things you can do about this:
16143 \begin_layout Itemize
16148 invocation command line in
16164 installation configuration file (usually with the file
16169 See below to learn what warnings can be enabled and disabled on the command
16174 \begin_layout Itemize
16175 Export your document as a raw LaTeX file using
16180 ile\SpecialChar \menuseparator
16185 xport\SpecialChar \menuseparator
16197 Invoked in this way, it can be a hassle to find the corresponding place
16198 in the document inside LyX, but with a little patience, you should be able
16202 \begin_layout Standard
16203 Here follows the warning messages that can be enabled and disabled in
16212 to disable a warning, and
16216 to enable a warning.
16217 The emphasized entries are disabled by default, because the default is
16220 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16225 \begin_layout Standard
16226 Notice that you should only use the options that enable and disable warnings,
16227 because LyX relies on some of the other command line parameters to be set
16228 in a specific way to have a chance to communicate with
16235 \begin_layout Enumerate
16239 Command terminated with space.
16242 \begin_layout Enumerate
16245 Non-breaking space (
16246 \begin_inset Quotes eld
16254 \begin_inset Quotes erd
16257 ) should have been used.
16260 \begin_layout Enumerate
16264 You should enclose the previous parenthesis with
16265 \begin_inset Quotes eld
16273 \begin_inset Quotes erd
16279 \begin_layout Enumerate
16282 Italic correction (
16283 \begin_inset Quotes eld
16293 \begin_inset Quotes erd
16296 ) found in non-italic buffer.
16299 \begin_layout Enumerate
16302 Italic correction (
16303 \begin_inset Quotes eld
16313 \begin_inset Quotes erd
16316 ) found more than once.
16319 \begin_layout Enumerate
16323 No italic correction (
16324 \begin_inset Quotes eld
16334 \begin_inset Quotes erd
16340 \begin_layout Enumerate
16344 \begin_inset Quotes eld
16352 \begin_inset Quotes erd
16356 \begin_inset Quotes eld
16364 \begin_inset Quotes erd
16370 \begin_layout Enumerate
16373 Wrong length of dash may have been used.
16376 \begin_layout Enumerate
16380 \begin_inset Quotes eld
16388 \begin_inset Quotes erd
16392 \begin_inset Quotes eld
16400 \begin_inset Quotes erd
16406 \begin_layout Enumerate
16410 \begin_inset Quotes eld
16418 \begin_inset Quotes erd
16424 \begin_layout Enumerate
16428 \begin_inset Quotes eld
16436 \begin_inset Quotes erd
16439 to achieve an ellipsis.
16442 \begin_layout Enumerate
16445 Inter-word spacing (
16446 \begin_inset Quotes eld
16456 \begin_inset Quotes eld
16459 ) should perhaps be used.
16462 \begin_layout Enumerate
16465 Inter-sentence spacing (
16466 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16479 ) should perhaps be used.
16482 \begin_layout Enumerate
16485 Could not find argument for command.
16488 \begin_layout Enumerate
16492 \begin_inset Quotes eld
16500 \begin_inset Quotes erd
16506 \begin_layout Enumerate
16509 Math mode still on at end of LaTeX file.
16512 \begin_layout Enumerate
16516 \begin_inset Quotes eld
16524 \begin_inset Quotes erd
16527 doesn't match the number of
16528 \begin_inset Quotes eld
16536 \begin_inset Quotes erd
16542 \begin_layout Enumerate
16545 You should use either
16548 \begin_inset Quotes eld
16556 \begin_inset Quotes erd
16561 as an alternative to
16562 \begin_inset Quotes eld
16570 \begin_inset Quotes erd
16576 \begin_layout Enumerate
16583 " (ASCII 39) instead of "
16590 \begin_layout Enumerate
16593 User-specified pattern found.
16596 \begin_layout Enumerate
16599 This command might not be intended.
16602 \begin_layout Enumerate
16609 \begin_layout Enumerate
16627 \begin_layout Enumerate
16630 Delete this space to maintain correct page references.
16633 \begin_layout Enumerate
16637 You might wish to put this between a pair of
16638 \begin_inset Quotes eld
16646 \begin_inset Quotes erd
16652 \begin_layout Enumerate
16655 You ought to remove spaces in front of punctuation.
16658 \begin_layout Enumerate
16661 Could not execute LaTeX command.
16664 \begin_layout Enumerate
16673 in front of small punctuation.
16676 \begin_layout Enumerate
16684 may look prettier here.
16687 \begin_layout Enumerate
16691 Multiple spaces detected in output.
16694 \begin_layout Enumerate
16697 This text may be ignored.
16700 \begin_layout Enumerate
16706 \begin_inset Quotes eld
16711 to begin quotation, not
16718 \begin_layout Enumerate
16725 to end quotation, not
16728 \begin_inset Quotes eld
16736 \begin_layout Enumerate
16742 \begin_layout Enumerate
16745 You should perhaps use
16746 \begin_inset Quotes eld
16754 \begin_inset Quotes erd
16760 \begin_layout Enumerate
16763 You should put a space in front of/after parenthesis.
16766 \begin_layout Enumerate
16769 You should avoid spaces in front of/after parenthesis.
16772 \begin_layout Enumerate
16776 You should not use punctuation in front of/after quotes.
16779 \begin_layout Enumerate
16782 Double space found.
16785 \begin_layout Enumerate
16788 You should put punctuation outside inner/inside display math mode.
16791 \begin_layout Enumerate
16794 You ought to not use primitive TeX in LaTeX code.
16797 \begin_layout Enumerate
16800 You should remove spaces in front of
16801 \begin_inset Quotes eld
16809 \begin_inset Quotes erd
16815 \begin_layout Enumerate
16818 \begin_inset Quotes eld
16826 \begin_inset Quotes erd
16829 is normally not followed by
16830 \begin_inset Quotes eld
16838 \begin_inset Quotes erd
16844 \begin_layout Standard
16845 In later versions of LyX, we hope to provide a more complete interface to
16846 this tool (and it's smaller cousin
16850 ) to exploit the full power of it.
16851 But it's not exactly useless as it is now: go try it on one of your existing
16852 documents of a certain length and be surprised.
16855 \begin_layout Section
16856 Version Control in LyX
16859 \begin_layout Standard
16862 Lars Gullik Bjønnes,
16869 \begin_layout Subsection
16873 \begin_layout Standard
16874 A friend of mine wanted to try LyX for a group project.
16875 When he didn't find support for version control or file locking, he dropped
16877 This angered me a bit, so I thought that I should at least make support
16878 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16879 This has now been done.
16880 LyX now supports some of the most basic RCS commands.
16881 If you need to something a bit more sophisticated you will have to do that
16882 manually in an xterm.
16885 \begin_layout Standard
16886 Before you begin to use the version control features in LyX, you should
16888 \begin_inset Quotes eld
16892 \begin_inset Quotes erd
16895 (a man file, read it with
16900 This file describes all the basic features of RCS.
16901 You should especially notice the comment about a RCS directory, and the
16902 notion of a master RCS file (the file ending in
16909 \begin_layout Standard
16910 Later basic CVS/SVN support was added.
16911 You should be familiar with CVS/SVN usage before start using it under LyX.
16912 Most of the log messages are not currently displayed after operations -
16913 you can check them in terminal window if unsure.
16916 \begin_layout Standard
16917 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16918 package---no guarantees are made for older versions.
16921 \begin_layout Subsection
16922 RCS commands in LyX
16925 \begin_layout Standard
16926 The following sections describe the RCS commands supported by LyX.
16927 You can find them in the
16932 ile\SpecialChar \menuseparator
16938 \begin_inset space ~
16946 \begin_layout Subsubsection
16952 \begin_layout Standard
16953 If your document is not under revision control, this is the only item shown
16955 And if it is under revision control, the
16962 item is not visible.
16966 \begin_layout Standard
16967 This command registers your document with RCS (unless you are under the
16968 directory managed by CVS)\SpecialChar \@.
16969 You are asked interactively to supply an initial
16970 description of the document.
16971 The document is now set in Read-Only mode and you have to
16974 \begin_inset space ~
16978 \begin_inset space ~
16982 \begin_inset space ~
16987 , before making any changes to it.
16988 A document under revision control has a
16989 \begin_inset Quotes eld
16992 [RCS:<version> <locker>]
16993 \begin_inset Quotes erd
16996 item tagged to the filename in the minibuffer.
16999 \begin_layout Standard
17000 RCS command that is run:
17002 ci -q -u -i -t-"<initial description>" <file-name>
17005 \begin_layout Standard
17010 to understand the switches.
17014 \begin_layout Subsubsection
17020 \begin_layout Standard
17021 When you are finished editing a file, you check in your changes.
17022 When you do this, you are asked for a description of the changes.
17023 This is stored in the history log.
17024 The version number is bumped, your changes are applied to the master RCS
17025 file, the document is unlocked and set to Read-Only mode.
17029 \begin_layout Standard
17032 ci -q -u -m"<description>" <file-name>
17035 \begin_layout Subsubsection
17041 \begin_layout Standard
17042 By doing this you lock the document so that only you can edit it.
17043 This will also make the document Read-Write only for you.
17044 You will usually continue editing for a while and when you are finished
17045 you check in your changes.
17046 The status line is changed to reflect that you have locked the file.
17050 \begin_layout Standard
17053 co -q -l <file-name>
17056 \begin_layout Subsubsection
17059 Revert To Repository Version
17062 \begin_layout Standard
17063 This will discard all changes made to the document since the last check
17065 You get a warning before changes are discarded.
17068 \begin_layout Standard
17071 co -f -u<version> <file-name>
17074 \begin_layout Subsubsection
17080 \begin_layout Standard
17081 This makes as if the last check in never happened.
17082 No changes are made to the document loaded into LyX, but the last version
17083 is removed from the master RCS file.
17087 \begin_layout Standard
17090 rcs -o<version> <file-name>
17093 \begin_layout Subsubsection
17099 \begin_layout Standard
17100 This show the complete history of the RCS document.
17105 is shown in a browser.
17113 \begin_layout Subsection
17114 CVS commands in LyX
17117 \begin_layout Standard
17118 CVS is now partially supported by LyX.
17119 You can find the commands in the
17124 ile\SpecialChar \menuseparator
17130 \begin_inset space ~
17138 \begin_layout Subsubsection
17144 \begin_layout Standard
17145 If your document is not under revision control, this is the only item shown
17147 And if it is under revision control, the
17154 item is not visible.
17158 \begin_layout Standard
17159 This command registers in CVS your document ONLY in case you have already
17160 the documents directory under CVS control (in particular
17165 This means you have to checkout the archive by yourself.
17169 \begin_layout Standard
17170 Then you are asked interactively to supply an initial description of the
17172 Don't forget that registered file is not yet commited.
17175 \begin_layout Standard
17176 CVS command that is run:
17179 \begin_inset Quotes erd
17183 \begin_inset Quotes eld
17187 \begin_inset Quotes erd
17193 \begin_layout Standard
17198 to understand the switches.
17202 \begin_layout Subsubsection
17208 \begin_layout Standard
17209 When you are finished editing a file, you commit your changes.
17210 When you do this, you are asked for a description of the changes.
17211 After that changes are commited.
17214 \begin_layout Standard
17217 cvs -q commit -m"<description>" <file-name>
17220 \begin_layout Subsubsection
17223 Revert To Repository Version
17226 \begin_layout Standard
17227 This will discard all changes made to the document since the last check
17229 You get a warning before changes are discarded.
17230 Firstly the file is deleted, secondly CVS update command is run.
17233 \begin_layout Standard
17237 \begin_inset Quotes eld
17241 \begin_inset Quotes erd
17247 \begin_layout Subsubsection
17253 \begin_layout Standard
17254 This show the complete history of the CVS document.
17258 \begin_inset Quotes eld
17262 \begin_inset Quotes erd
17267 is shown in a browser.
17270 \begin_layout Subsection
17271 SVN commands in LyX
17274 \begin_layout Standard
17275 SVN is now partially supported by LyX.
17276 You can find the commands in the
17281 ile\SpecialChar \menuseparator
17287 \begin_inset space ~
17293 Please note that if you use password protected access to repository via
17294 ssh, you will be asked in terminal window.
17297 \begin_layout Subsubsection
17303 \begin_layout Standard
17304 If your document is not under revision control, this is the only item shown
17306 And if it is under revision control, the
17313 item is not visible.
17317 \begin_layout Standard
17318 This command registers in SVN your document ONLY in case you have already
17319 the documents directory under SVN control (in particular
17324 This means you have to checkout the archive by yourself.
17328 \begin_layout Standard
17329 Then you are asked interactively to supply an initial description of the
17331 Don't forget that registered file is not yet commited.
17334 \begin_layout Standard
17335 SVN command that is run:
17338 \begin_inset Quotes eld
17342 \begin_inset Quotes erd
17348 \begin_layout Standard
17353 to understand the switches.
17357 \begin_layout Subsubsection
17363 \begin_layout Standard
17364 When you are finished editing a file, you commit your changes.
17365 When you do this, you are asked for a description of the changes.
17366 After that changes are commited.
17369 \begin_layout Standard
17372 svn commit -q -m"<description>" <file-name>
17375 \begin_layout Subsubsection
17381 \begin_layout Standard
17382 Updates the changes of this file from the repository.
17383 Be sure you understand SVN merging and conflicts resolving before using
17384 this function, because all conflicts has to be done manually by you!
17387 \begin_layout Standard
17391 \begin_inset Quotes eld
17395 \begin_inset Quotes erd
17401 \begin_layout Subsubsection
17404 Revert To Repository Version
17407 \begin_layout Standard
17408 This will discard all changes made to the document since the last check
17410 You get a warning before changes are discarded.
17414 \begin_layout Standard
17418 \begin_inset Quotes eld
17422 \begin_inset Quotes erd
17428 \begin_layout Subsubsection
17434 \begin_layout Standard
17435 This show the complete history of the SVN document.
17439 \begin_inset Quotes eld
17443 \begin_inset Quotes erd
17448 is shown in a browser.
17451 \begin_layout Section
17452 Literate Programming
17455 \begin_layout Standard
17460 (kayvan@sylvan.com)
17464 original documentation written by
17466 Edmar Wienskoski Jr.
17469 (edmar-w-jr@technologist.com)
17472 \begin_layout Subsection
17476 \begin_layout Standard
17477 The main purpose of this documentation is to show you how to use LyX for
17478 literate programming.
17479 Where it is assumed that you are familiar with this programming technique,
17481 \begin_inset Quotes eld
17485 \begin_inset Quotes erd
17489 \begin_inset Quotes eld
17493 \begin_inset Quotes erd
17497 If that is not the case, please follow the web links provided in the following
17499 There is a lot of good documentation out there covering old development
17500 history to the latest tools tips.
17503 \begin_layout Standard
17504 It is also assumed that you are familiar with LyX itself to a point that
17505 you are comfortable changing your LyX preferences, and X resources file.
17506 If that is not the case please refer to other LyX documentation to cover
17507 your specific needs.
17510 \begin_layout Subsection
17511 Literate Programming
17514 \begin_layout Standard
17515 From the Literate Programming FAQ:
17518 \begin_layout Quotation
17519 Literate programming is the combination of documentation and source together
17520 in a fashion suited for reading by human beings.
17521 In fact, literate programs should be enjoyable reading, even inviting!
17522 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17523 and documentation in a single file.
17524 Literate programming tools then parse the file to produce either readable
17525 documentation or compilable source.
17526 The WEB style of literate programming was created by D.E.
17527 Knuth during the development of his TeX typesetting software.
17531 \begin_layout Standard
17532 Another excerpt says:
17535 \begin_layout Quotation
17538 How is literate programming different from verbose commenting?
17541 \begin_layout Quotation
17542 There are three distinguishing characteristics.
17543 In order of importance, they are:
17547 \begin_layout Itemize
17548 flexible order of elaboration
17551 \begin_layout Itemize
17552 automatic support for browsing
17555 \begin_layout Itemize
17556 typeset documentation, especially diagrams and mathematics
17560 \begin_layout Standard
17561 Now that I sparked your curiosity, take a look in the references.
17564 \begin_layout Subsubsection
17568 \begin_layout Standard
17569 The complete Literate Programming FAQ can be found at:
17572 \begin_layout Quote
17573 Literate Programming FAQ
17574 \begin_inset Flex URL
17577 \begin_layout Plain Layout
17579 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17587 \begin_layout Standard
17588 The FAQ lists 23 (twenty three!) different literate programming tools.
17589 Where some are specialized or
17590 \begin_inset Quotes eld
17594 \begin_inset Quotes erd
17597 for particular programming languages, while other have general scope.
17602 for my own use for several reasons:
17605 \begin_layout Itemize
17606 It can generate the documentation either in LaTeX or HTML.
17609 \begin_layout Itemize
17610 It has a open architecture, i.e., it is easy to plug in new filters and to
17611 perform special processing that you may need.
17615 \begin_layout Itemize
17616 There is a good selection of filters available already (the HTML is one
17620 \begin_layout Itemize
17624 \begin_layout Standard
17625 The Noweb web page can be found at:
17628 \begin_layout Quote
17630 \begin_inset Flex URL
17633 \begin_layout Plain Layout
17635 http://www.cs.virginia.edu/~nr/noweb/
17643 \begin_layout Standard
17644 Starting from there you can reach many other interesting links and even
17645 some literate program examples.
17648 \begin_layout Subsection
17649 LyX and Literate Programming
17652 \begin_layout Standard
17653 The LyX support for Literate Programming is provided by using the generic
17654 LyX converters mechanism.
17655 This support is provided in a
17656 \begin_inset Quotes eld
17660 \begin_inset Quotes erd
17663 way, i.e., you will be able to use this new LyX feature with some other literate
17664 programming tool of your choice by just changing your LyX preferences.
17667 \begin_layout Subsubsection
17668 Generating documents and code (weaving and tangling)
17671 \begin_layout Paragraph
17672 Selecting the document class
17675 \begin_layout Standard
17676 If you have installed Noweb and LyX successfully, whenever you open a new
17677 document or try to change the document class of an existing one, you will
17678 find that there are three new document classes available:
17681 \begin_layout Itemize
17685 \begin_layout Itemize
17689 \begin_layout Itemize
17693 \begin_layout Standard
17694 You must select one of them to create your literate documents from.
17698 \begin_layout Standard
17699 Note that literate documents are not limited to these three classes.
17700 New classes can be generated from other styles like letter or in combination
17701 with other class variations like Article (AMS).
17702 If you have special needs that cannot be covered by one of the existing
17703 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17704 will arrange to insert a new entry, or teach you how to do it.
17708 \begin_layout Plain Layout
17709 It is very simple, it involves the creation of a file with four lines, and
17710 re-running of the auto configuration.
17715 Moreover, if you use a literate tool other than Noweb you may need to create
17716 a new set of document classes for it.
17719 \begin_layout Paragraph
17723 \begin_layout Standard
17724 LyX enables you to write code with a layout named
17732 \begin_layout Plain Layout
17733 The equivalent Noweb term is
17734 \begin_inset Quotes eld
17738 \begin_inset Quotes erd
17742 For historical reasons, I got used to the term
17743 \begin_inset Quotes eld
17747 \begin_inset Quotes erd
17750 introduced by other literate tool named Nuweb, which I used for many years
17751 before rendering myself to Noweb.
17756 Noweb delimits scraps like this:
17759 \begin_layout LyX-Code
17763 \begin_layout LyX-Code
17767 \begin_layout LyX-Code
17771 \begin_layout LyX-Code
17775 \begin_layout LyX-Code
17779 \begin_layout Standard
17780 The problem is that whatever is written in between the << and the
17784 must be taken literally, i.e., LyX should be prevented from making any special
17785 interpretation of what has been written.
17786 This is handled by a special layout named Scrap, that works like a normal
17787 paragraph but has a free spacing capability.
17790 \begin_layout Standard
17791 The down side of the Scrap paragraph layout is that consecutive paragraphs
17792 of code will be spaced with one empty line in the source code and also
17793 in the printed documentation.
17794 The work around is to enter each line of code within a single Scrap, with
17795 a newline (ctrl-return).
17796 The example above will look like this:
17800 \begin_layout Plain Layout
17801 If you have a printed version of this document you will not see any difference
17802 between the previous example and this one.
17810 \begin_layout LyX-Code
17812 \begin_inset Newline newline
17816 \begin_inset Newline newline
17820 \begin_inset Newline newline
17824 \begin_inset Newline newline
17830 \begin_layout Standard
17831 This layout works fine.
17832 The only real inconvenience is that you have to type ctrl-return instead
17837 \begin_layout Plain Layout
17838 It is in my list of
17839 \begin_inset Quotes eld
17843 \begin_inset Quotes erd
17854 \begin_layout Standard
17855 As a special note, you can also use the
17856 \begin_inset Quotes eld
17860 \begin_inset Quotes erd
17863 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17867 \begin_layout LyX-Code
17869 \begin_inset Newline newline
17872 def some_function(args):
17873 \begin_inset Newline newline
17876 "This is the doc string for this function."
17877 \begin_inset Newline newline
17880 print "My args: ", args
17883 \begin_layout LyX-Code
17884 @ %def some_function
17887 \begin_layout Standard
17888 For an example of this usage and the resulting cross-reference output, look
17889 at the Literate python program in
17891 LIBDIR/examples/listerrors.lyx
17893 which should make this all clear.
17896 \begin_layout Paragraph
17897 Generating the documentation
17900 \begin_layout Standard
17901 At this point you already have a new document file with a proper document
17902 class, and with some code and text on it.
17903 How do I print it? The answer is simple, you select
17908 iew\SpecialChar \menuseparator
17916 Just like you would do for a plain document.
17917 No special procedure is required.
17920 \begin_layout Standard
17921 To help orientate you, I will now explain what happens inside LyX:
17924 \begin_layout Enumerate
17927 Update\SpecialChar \menuseparator
17930 menu option is chosen, a LaTeX file is generated.
17935 \begin_layout Standard
17936 If the document is of any literate class the generated file will be named
17937 with an extension name defined by the
17938 \begin_inset Quotes eld
17942 \begin_inset Quotes erd
17945 format (defined in the Preferences panel), otherwise the file will have
17954 \begin_layout Enumerate
17955 Note that the only difference so far is in the name of the file, no special
17956 processing is required by LyX.
17957 Given that you formatted the code using the Scrap layout that, by itself,
17958 takes care of the business.
17961 \begin_layout Enumerate
17962 If the document is of any literate class LyX will then use the internal
17963 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17967 \begin_layout Plain Layout
17968 The converters are defined in the
17970 Tools\SpecialChar \menuseparator
17974 \begin_inset Quotes eld
17978 \begin_inset Quotes erd
17990 manual for general information about converters.
17995 to generate the LaTeX file.
17999 \begin_layout Standard
18000 Otherwise it will just skip this step.
18004 \begin_layout Enumerate
18005 Finally, LaTeX is invoked and the regular post processing continues as in
18009 \begin_layout Standard
18010 Independence from a particular
18011 \begin_inset Quotes eld
18015 \begin_inset Quotes erd
18018 is easily achieved by changing the commands that are run by the various
18022 \begin_layout Paragraph
18023 Generating the code
18026 \begin_layout Standard
18027 When the build menu option is chosen or the corresponding button in the
18028 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18029 Next, LyX invokes the
18034 This converter needs to be defined by the user and is not installed by
18035 default, though the Program format is.
18036 This converter (like any other converter) will have two parts:
18039 \begin_layout Enumerate
18040 The converter program itself.
18041 This program performs the conversion from the one format to the other (in
18042 this case, from the Noweb format to the Program pseudo-format).
18045 \begin_layout Enumerate
18046 The error log parser.
18047 This is a program whose sole purpose is to rewrite error messages in a
18048 format that LyX understands.
18049 This makes it possible for LyX to place error boxes in the right places
18050 in the file buffer.
18053 \begin_layout Standard
18054 The first part, the
18055 \begin_inset Quotes eld
18059 \begin_inset Quotes erd
18062 setting, should be set to
18063 \begin_inset Quotes eld
18071 \begin_inset Quotes erd
18075 This basically means that LyX will call
18076 \begin_inset Quotes eld
18080 \begin_inset Quotes erd
18083 (a program or script) with the name of the Noweb file (normally a file
18084 in the LyX temp directory).
18088 \begin_layout Standard
18089 This is an implementation of
18090 \begin_inset Quotes eld
18094 \begin_inset Quotes erd
18097 that you can place in a directory on your path:
18100 \begin_layout LyX-Code
18104 \begin_layout LyX-Code
18108 \begin_layout LyX-Code
18109 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18112 \begin_layout Standard
18113 The next part of the converter setting is the
18114 \begin_inset Quotes eld
18118 \begin_inset Quotes erd
18121 which is to be set to
18122 \begin_inset Quotes eld
18127 parselog=listerrors
18130 \begin_inset Quotes erd
18134 This will run any errors that are generated by the
18135 \begin_inset Quotes eld
18139 \begin_inset Quotes erd
18142 process through the
18143 \begin_inset Quotes eld
18147 \begin_inset Quotes erd
18153 \begin_layout Standard
18154 The converter code looks in
18162 then on the path for the
18163 \begin_inset Quotes eld
18167 \begin_inset Quotes erd
18173 \begin_layout Standard
18174 The build will normally take place in LyX's temporary directory, so the
18175 files produced by the conversion will be in that directory.
18176 LyX will copy out what it regards as the `main' file, but the
18180 conversion may produce several files, and so most of these would then be
18181 deleted when LyX was closed.
18182 The present solution is to use a `copier',
18186 \begin_layout Plain Layout
18195 manual for information on these.
18204 script in its default mode, so that the entire contents of the temporary
18205 directory is copied.
18206 More will get copied than is needed, to be sure, but nothing will be lost.
18207 If, however, you know what extensions the generated files will have, this
18208 can be improved by using the
18217 This option takes a comma-separated list of extensions to copy.
18218 So, for example, if the conversion will generate only files with the extensions
18227 , then the correct definition would be:
18230 \begin_layout LyX-Code
18231 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18234 \begin_layout Standard
18235 The result will be that only files with these two extensions will be copied
18239 \begin_layout Paragraph
18240 Build instructions in the document
18243 \begin_layout Standard
18244 The last piece of the integration between LyX and noweb is the
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18253 Generally, the instructions for building your program should be embedded
18254 in a scrap of its own.
18256 \begin_inset Quotes eld
18260 \begin_inset Quotes erd
18263 above uses the notangle command to look for this scrap (called
18264 \begin_inset Quotes eld
18268 \begin_inset Quotes erd
18271 ) and runs its contents through
18272 \begin_inset Quotes eld
18276 \begin_inset Quotes erd
18282 \begin_layout Standard
18283 Typically, such a scrap would look something like this:
18286 \begin_layout LyX-Code
18288 \begin_inset Newline newline
18292 \begin_inset Newline newline
18296 \begin_inset Newline newline
18299 if [ -z "${NOWEB_SOURCE}" ]
18300 \begin_inset Newline newline
18304 \begin_inset Newline newline
18307 NOWEB_SOURCE=myfile.nw
18308 \begin_inset Newline newline
18312 \begin_inset Newline newline
18316 code to extract files ...]
18317 \begin_inset Newline newline
18321 code to compile files ...]
18322 \begin_inset Newline newline
18328 \begin_layout Standard
18331 LIBDIR/examples/listerrors.lyx
18335 LIBDIR/examples/Literate.lyx
18337 which implement two versions of the
18338 \begin_inset Quotes eld
18342 \begin_inset Quotes erd
18345 program for some illustrations of how all of these pieces go together or
18348 LIBDIR/examples/noweb2lyx.lyx.
18351 Interestingly, these three files show off the language-indepence of the
18352 LyX literate programming support since they are written in Python, C and
18356 \begin_layout Subsubsection
18360 \begin_layout Standard
18361 All the Literate Programming support is configured by the
18366 ools\SpecialChar \menuseparator
18374 \begin_inset Quotes eld
18378 \begin_inset Quotes erd
18382 The important parts are:
18385 \begin_layout Description
18387 \begin_inset space ~
18391 \begin_inset Quotes eld
18395 \begin_inset Quotes erd
18399 \begin_inset space ~
18402 format Set up via the Formats tab, this is where the Noweb-specific pieces
18412 , the file extension is set to
18417 This tells LyX to create a file with a
18421 extension in the first step of the conversion process.
18424 \begin_layout Description
18426 \begin_inset space ~
18434 \begin_inset space ~
18437 format This is an empty format whose sole purpose is to be the endpoint
18438 of a conversion (which then allows us to set up a converter for it).
18441 \begin_layout Description
18450 This converter performs the
18451 \begin_inset Quotes eld
18455 \begin_inset Quotes erd
18458 of the literate document.
18459 For Noweb, it is set to
18460 \begin_inset Quotes eld
18465 noweave -delay -index $$i > $$o
18468 \begin_inset Quotes erd
18474 \begin_layout Description
18484 \begin_inset Quotes eld
18488 \begin_inset Quotes erd
18492 As stated above, the Converter is set to
18493 \begin_inset Quotes eld
18501 \begin_inset Quotes erd
18504 , with Flags set to
18505 \begin_inset Quotes eld
18510 originaldir,parselog=listerrors
18513 \begin_inset Quotes erd
18519 \begin_layout Subsubsection
18523 \begin_layout Standard
18524 There is also a new function implemented in the LyX server, the
18525 \begin_inset Quotes eld
18528 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18532 \begin_layout Standard
18533 When debugging code with ddd/gdb, it is possible to invoke a text editor
18534 at the current execution position with a single key stroke.
18535 The default ddd configuration for that is shift-ctrl-V.
18536 It happens that you can define the editor command line invocation in ddd
18542 dit\SpecialChar \menuseparator
18547 references\SpecialChar \menuseparator
18554 dialog and changing the "Edit Sources" entry.
18557 \begin_layout Standard
18558 I take advantage of the new created LyX server function and this ddd feature,
18560 \begin_inset Quotes eld
18564 \begin_inset Quotes erd
18570 \begin_layout LyX-Code
18571 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18574 \begin_layout Standard
18575 With this, whenever you are using ddd and find a point in the program that
18576 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18577 ddd you forward this information to LyX through the LyX server and then
18578 the LyX window will show the same file with the cursor at the same position
18579 ddd was pointing to.
18580 No more guessing or long scrolling to locate a point in the program back
18584 \begin_layout Standard
18585 Note however that you must enable the LyX server to get this feature working
18586 (it is disabled by default).
18587 You can enable it in
18599 ) by entering in the
18604 \begin_inset Quotes eld
18609 /home/<your-home-directory>/.lyx/lyxpipe
18612 \begin_inset Quotes erd
18618 \begin_layout Standard
18619 Read the LyX server documentation in the
18621 Customization Manual
18623 for further information.
18626 \begin_layout Subsubsection
18630 \begin_layout Standard
18631 There are six new buttons that can be added to your LyX toolbar.
18632 Five of these buttons are short cuts to layout styles:
18653 The last one is a short cut to the
18654 \begin_inset Quotes eld
18658 \begin_inset Quotes erd
18665 \begin_layout Standard
18666 LyX has a range of buttons that are available for tool bar customization.
18667 In my toolbar I like to combine the six short cuts above with two more:
18675 \SpecialChar \menuseparator
18683 \SpecialChar \menuseparator
18696 iew\SpecialChar \menuseparator
18704 Here is how it looks like:
18707 \begin_layout LyX-Code
18711 \begin_layout LyX-Code
18715 \begin_layout LyX-Code
18716 Icon "layout Standard"
18719 \begin_layout LyX-Code
18720 Icon "layout Section"
18723 \begin_layout LyX-Code
18724 Icon "layout LaTeX"
18727 \begin_layout LyX-Code
18728 Icon "layout LyX-Code"
18731 \begin_layout LyX-Code
18732 Icon "layout Scrap"
18735 \begin_layout LyX-Code
18739 \begin_layout LyX-Code
18743 \begin_layout LyX-Code
18744 Icon "buffer-typeset"
18747 \begin_layout LyX-Code
18748 Icon "build-program"
18751 \begin_layout LyX-Code
18755 \begin_layout LyX-Code
18759 \begin_layout LyX-Code
18763 \begin_layout LyX-Code
18767 \begin_layout LyX-Code
18771 \begin_layout Subsubsection
18772 Colors customization
18775 \begin_layout Standard
18776 There are a number of colors in LyX that can be customized in
18781 One of the things that bothers people is the LaTeX font color.
18782 The default color is red, since the scraps uses LaTeX font, and there is
18783 a lot of scraps in literate documents, you may get tired of seeing everything
18785 You can change it by going to the tabs
18794 \begin_layout Standard
18795 The next thing is the visible presence of the newline character in the screen.
18796 You can choose the color of this particular character and make it blend
18798 I recommend you choosing a color that is close to the background but not
18799 equal, that way you still can see it is there, but it is not bothering
18804 \begin_layout Chapter
18805 Secrets of the LaTeX Masters
18806 \begin_inset CommandInset label
18815 \begin_layout Standard
18816 Though LyX is a powerful tool, it cannot hope to support everything that
18817 can be done with pure TeX/LaTeX.
18818 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18819 as long as you are not afraid to use that
18820 \begin_inset Quotes eld
18824 \begin_inset Quotes erd
18827 button on the toolbar or add things to the LaTeX preamble.
18828 This section lists some tips, tricks, and otherwise cool ideas to give
18829 your document that extra little flair.
18832 Do try this at home
18834 , just start with something a little smaller and less important than your
18838 \begin_layout Standard
18839 Most ideas in this section require less common files in your LaTeX installation.
18840 If you have a system like teTeX, most will already be available.
18841 A few, however, will need to be downloaded from one of the CTAN archives.
18842 Often, there are several ways to do something, or several LaTeX style files
18843 which do the same thing.
18844 We do not endorse one choice over another, we simply claim that we have
18845 done a particular task with a particular file.
18846 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18849 \begin_layout Section
18853 \begin_layout Standard
18856 Lars Gullik Bjønnes
18859 \begin_layout Subsection
18863 \begin_layout Standard
18864 The aim for this chapter
18868 \begin_layout Plain Layout
18869 Editor's note: Lars' original chapter was a masterful description of how
18875 However, it was too long to flow smoothly in this document.
18876 I have therefore chosen to excerpt the most important sections here (sorry,
18877 Lars); you can read the original chapter (and more of the story!) in the
18880 examples/multicol.lyx
18888 is to show how the LaTeX package
18892 can be used in a LyX document.
18893 As LyX doesn't support the
18897 package natively yet, we have to use some small hacks.
18898 By reading this section it should be obvious how to do this.
18901 \begin_layout Subsection
18905 \begin_layout Standard
18910 package allows switching between one and multicolumn format on the same
18912 Footnotes are handled correctly (for the most part), but will be placed
18913 at the bottom of the page and not under each column.
18914 LaTeX's float mechanism, however, is partly disabled in the current implementat
18916 At the moment only page-wide floats can be used within the scope of the
18920 \begin_layout Subsection
18924 \begin_layout Subsubsection
18928 \begin_layout Standard
18929 If you want to have two columns in your text, you have use LaTeX mode to
18934 begin{multicols}{2}
18936 at the point where you want the two column layout to start, and then
18942 where you want it to end.
18946 \begin_layout Standard
18950 \begin_layout Plain Layout
18954 begin{multicols}{2}
18962 \begin_layout Standard
18967 The Adventure of the Empty House
18970 \begin_inset Newline newline
18975 Sir Arthur Conan Doyle
18978 \begin_layout Standard
18981 It was in the spring of the year 1894 that all London was interested, and
18982 the fashionable world dismayed, by the murder of the Honourable Ronald
18983 Adair under most unusual and inexplicable circumstances.
18984 The public has already learned those particulars of the crime which came
18985 out in the police investigation, but a good deal was suppressed upon that
18986 occasion, since the case for the prosecution was so overwhelmingly strong
18987 that it was not necessary to bring forward all the facts.
18988 Only now, at the end of nearly ten years, am I allowed to supply those
18989 missing links which make up the whole of that remarkable chain.
18990 The crime was of interest in itself, but that interest was as nothing to
18991 me compared to the inconceivable sequel, which afforded me the greatest
18992 shock and surprise of any event in my adventurous life.
18993 Even now, after this long interval, I find myself thrilling as I think
18994 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18995 ty which utterly submerged my mind.
18996 Let me say to that public, which has shown some interest in those glimpses
18997 which I have occasionally given them of the thoughts and actions of a very
18998 remarkable man, that they are not to blame me if I have not shared my knowledge
18999 with them, for I should have considered it my first duty to do so, had
19000 I not been barred by a positive prohibition from his own lips, which was
19001 only withdrawn upon the third of last month.
19004 \begin_layout Standard
19008 \begin_layout Plain Layout
19020 \begin_layout Subsubsection
19024 \begin_layout Standard
19025 The same pattern is used when you want more than two columns:
19028 \begin_layout Standard
19032 \begin_layout Plain Layout
19036 begin{multicols}{3}
19044 \begin_layout Standard
19047 It can be imagined that my close intimacy with Sherlock Holmes had interested
19048 me deeply in crime, and that after his disappearance I never failed to
19049 read with care the various problems which came before the public.
19050 And I even attempted, more than once, for my own private satisfaction,
19051 to employ his methods in their solution, though with indifferent success.
19052 There was none, however, which appealed to me like this tragedy of Ronald
19054 As I read the evidence at the inquest, which led up to a verdict of willful
19055 murder against some person or persons unknown, I realized more clearly
19056 than I had ever done the loss which the community had sustained by the
19057 death of Sherlock Holmes.
19058 There were points about this strange business which would, I was sure,
19059 have specially appealed to him, and the efforts of the police would have
19060 been supplemented, or more probably anticipated, by the trained observation
19061 and the alert mind of the first criminal agent in Europe.
19062 All day, as I drove upon my round, I turned over the case in my mind and
19063 found no explanation which appeared to me to be adequate.
19064 At the risk of telling a twice-told tale, I will recapitulate the facts
19065 as they were known to the public at the conclusion of the inquest.
19068 \begin_layout Standard
19072 \begin_layout Plain Layout
19084 \begin_layout Standard
19085 You can have more than 3 columns if you want to, but that might not be very
19086 pleasant for the eye.
19089 \begin_layout Subsubsection
19090 Columns inside columns
19093 \begin_layout Standard
19094 You can even have columns inside columns:
19097 \begin_layout Standard
19101 \begin_layout Plain Layout
19105 begin{multicols}{2}
19113 \begin_layout Standard
19116 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19117 at that time governor of one of the Australian colonies.
19118 Adair's mother had returned from Australia to undergo the operation for
19119 cataract, and she, her son Ronald, and her daughter Hilda were living together
19123 \begin_layout Standard
19127 \begin_layout Plain Layout
19131 begin{multicols}{2}
19139 \begin_layout Standard
19142 The youth moved in the best society--had, so far as was known, no enemies
19143 and no particular vices.
19144 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19145 had been broken off by mutual consent some months before, and there was
19146 no sign that it had left any very profound feeling behind it.
19147 For the rest {sic} the man's life moved in a narrow and conventional circle,
19148 for his habits were quiet and his nature unemotional.
19149 Yet it was upon this easy-going young aristocrat that death came, in most
19150 strange and unexpected form, between the hours of ten and eleven-twenty
19151 on the night of March 30, 1894.
19154 \begin_layout Standard
19158 \begin_layout Plain Layout
19170 \begin_layout Standard
19173 Ronald Adair was fond of cards--playing continually, but never for such
19174 stakes as would hurt him.
19175 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19176 It was shown that, after dinner on the day of his death, he had played
19177 a rubber of whist at the latter club.
19178 He had also played there in the afternoon.
19183 The evidence of those who had played with him-- Mr.
19184 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19185 and that there was a fairly equal fall of the cards.
19186 Adair might have lost five pounds, but not more.
19187 His fortune was a considerable one, and such a loss could not in any way
19189 He had played nearly every day at one club or other, but he was a cautious
19190 player, and usually rose a winner.
19191 It came out in evidence that, in partnership with Colonel Moran, he had
19192 actually won as much as four hundred and twenty pounds in a sitting, some
19193 weeks before, from Godfrey Milner and Lord Balmoral.
19194 So much for his recent history as it came out at the inquest.
19197 \begin_layout Standard
19201 \begin_layout Plain Layout
19213 \begin_layout Standard
19214 Please do read the file
19216 examples/multicol.lyx
19218 for more advanced examples including column and header spacing, vertical
19219 separator lines, and more.
19222 \begin_layout Section
19227 Paragraph Environment
19228 \begin_inset OptArg
19231 \begin_layout Plain Layout
19232 Numbering in Enumerate
19240 \begin_layout Standard
19246 \begin_layout Standard
19247 \begin_inset VSpace bigskip
19253 \begin_layout Standard
19255 The default numbering for the
19259 paragraph environment begins with Arabic numbers and ends with uppercase
19261 Suppose, however, you wanted a different type of numbering scheme.
19262 Here's a quickie example of how to change the numbering scheme:
19265 \begin_layout LyX-Code
19275 \begin_layout LyX-Code
19285 \begin_layout LyX-Code
19295 \begin_layout LyX-Code
19305 \begin_layout Standard
19306 \SpecialChar \ldots{}
19307 which changes the numbering scheme to uppercase Roman numerals, uppercase
19308 letters, Arabic numbers, and lowercase letter.
19311 \begin_layout Standard
19312 Additionally, the previous example also adds a little bit extra to the numbering
19314 For example, the first level label actually looks like:
19315 \begin_inset Quotes eld
19319 \begin_inset Quotes erd
19323 For ease of reading, we'll describe what the numbering schemes look like
19324 using a notation something like this: <
19325 \begin_inset Quotes eld
19329 \begin_inset Quotes erd
19333 \begin_inset space ~
19337 \begin_inset Quotes erd
19341 \begin_inset Quotes erd
19345 \begin_inset space ~
19349 \begin_inset Quotes erd
19353 \begin_inset Quotes erd
19357 \begin_inset space ~
19361 \begin_inset Quotes eld
19365 \begin_inset Quotes erd
19372 \begin_layout Standard
19373 As you can see in the example, there is a label command for each nesting
19380 \SpecialChar \ldots{}
19387 , as well as a counter,
19391 \SpecialChar \ldots{}
19397 There are also five
19398 \begin_inset Quotes eld
19402 \begin_inset Quotes erd
19435 , each of which take one counter as an argument.
19436 You can add characters before or after these, but there's no need to add
19440 \begin_layout Standard
19441 You can get really fancy with these.
19445 \begin_layout LyX-Code
19459 \begin_layout LyX-Code
19471 \begin_layout LyX-Code
19481 \begin_layout LyX-Code
19491 \begin_layout Standard
19492 produces the somewhat out of hand numbering scheme: <
19493 \begin_inset Quotes eld
19497 \begin_inset Quotes erd
19501 \begin_inset space ~
19505 \begin_inset Quotes erd
19509 \begin_inset Quotes erd
19513 \begin_inset space ~
19517 \begin_inset Quotes erd
19521 \begin_inset Quotes erd
19525 \begin_inset space ~
19529 \begin_inset Quotes eld
19533 \begin_inset Quotes erd
19540 \begin_layout Standard
19544 \begin_layout Section
19548 \begin_layout Standard
19554 \begin_layout Standard
19555 \begin_inset VSpace bigskip
19561 \begin_layout Standard
19566 \begin_layout Plain Layout
19572 tmpfont}{cmr17 scaled 2500}{
19584 \begin_layout Standard
19589 \begin_layout Plain Layout
19600 hose of you who like the style of old books probably also like
19601 \begin_inset Quotes eld
19605 \begin_inset Quotes erd
19608 ---those large capital letters which begin each new chapter or section.
19609 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19610 know some plain TeX!) but does require a lot of work and many iterations,
19611 as you can see by all the ugly TeX-mode stuff at the beginning of this
19615 \begin_layout Standard
19619 \begin_layout Plain Layout
19625 bigdrop{-1em}{3}{ptmri}{T}+
19630 here is a much easier way of doing this, of course.
19639 ) package from CTAN allows a simple way to add such letters to your documents.
19640 Since this package is not a standard part of teTeX, I can't demonstrate
19641 it within this document, but if you copy this paragraph to a new document,
19643 \begin_inset Quotes eld
19653 \begin_inset Quotes erd
19656 and the pluses from the TeX code at the beginning of the paragraph, and
19661 usepackage{dropcaps}
19663 to your LaTeX preamble, you will get a nice Times Roman Italic
19664 \begin_inset Quotes eld
19668 \begin_inset Quotes erd
19671 , whose height is three lines of text and which protrudes 1 em into the
19673 (Make certain you have copied
19674 \begin_inset Quotes eld
19682 \begin_inset Quotes erd
19685 into a directory where TeX can see it.) The first argument is the amount
19686 of indentation; in this case the negative sign moves it into the margin.
19687 The second argument is the height of the letter in number of lines of text.
19688 The third argument is the font name: virtually anything which has a tfm
19689 file should work (wade through the
19691 .../texmf/fonts/tfm
19693 directory for possibilities).
19694 My personal favorite is
19695 \begin_inset Quotes eld
19703 \begin_inset Quotes erd
19706 , a fancy German font specifically designed for dropped capitals.
19707 The fourth argument is the letter (or letters) to be dropped.
19712 package also offers the
19718 command, as well as a slightly simplified
19727 \begin_layout Section
19728 Non-standard Paragraph Shapes
19731 \begin_layout Standard
19737 \begin_layout Standard
19738 \begin_inset VSpace bigskip
19744 \begin_layout Standard
19748 \begin_layout Plain Layout
19760 \begin_layout Standard
19764 \begin_layout Plain Layout
19773 \begin_layout Plain Layout
19787 \begin_layout Standard
19792 \begin_layout Plain Layout
19803 \begin_layout Plain Layout
19812 \begin_layout Plain Layout
19821 \begin_layout Plain Layout
19830 \begin_layout Plain Layout
19839 \begin_layout Plain Layout
19848 \begin_layout Plain Layout
19857 \begin_layout Plain Layout
19866 \begin_layout Plain Layout
19875 \begin_layout Plain Layout
19884 \begin_layout Plain Layout
19893 \begin_layout Plain Layout
19902 \begin_layout Plain Layout
19911 \begin_layout Plain Layout
19920 \begin_layout Plain Layout
19929 \begin_layout Plain Layout
19938 \begin_layout Plain Layout
19947 \begin_layout Plain Layout
19956 \begin_layout Plain Layout
19965 \begin_layout Plain Layout
19971 There are times when the tyranny of rectangular paragraphs must be overthrown.
19972 In such situations, a call to the delightful plain TeX command
19979 As you can see, completely arbitrary shapes can be laid out with a suitable
19980 set of linelength definitions.
19981 While this parshape may look a bit silly and useless, one could conceive
19982 of situations such as finely tuned dropped capitals, word wrapping around
19983 non-rectangular graphics, etc.
19984 which will benefit from such handcrafting.
19987 \begin_layout Standard
19988 \begin_inset VSpace bigskip
19994 \begin_layout Standard
19999 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20006 is the number of lines of text which define the paragraph.
20007 If there turn out to be fewer lines, the shape is truncated; if there are
20008 more, the excess lines have the same dimensions as the last line of the
20018 entries specify the indentation of the line from the left margin, and the
20019 length of the line as measured from that point.
20020 The shape applies only to the current paragraph; everything is reset to
20021 normal for the next paragraph.
20024 \begin_layout Standard
20028 \begin_layout Plain Layout
20040 \begin_layout Section
20044 \begin_layout Standard
20045 As you can see, the examples in this section range from the useful to the
20047 While I don't expect that anyone will ever need the paragraph shape demonstrate
20048 d in the last section, the important point is that you can do almost anything
20049 you want in LyX if you are willing to figure out how to do it in TeX and
20051 TeX is a fantastically powerful typesetting system and all that power is
20052 available to you since LyX uses it as its backend.
projects / lyx.git / blob