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 Extended 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
173 Extended LyX Features
175 manual, which you are now reading, is essentially Part II of the
177 User's Guide\SpecialChar \@.
180 The reason for separating this document out is simple: the
184 is already huge, and it contains all of the basic features one needs to
185 know in order to prepare most documents.
186 However, the LyX Team has a long-term goal of making LyX extensible through
187 various configuration files and external packages.
188 That means that if you want to support the Fizzwizzle LaTeX package, you
189 can create a layout file (or module) for it without having to alter LyX
191 We've already had contributions of several new features this way.
192 This is the place where all of that gets documented.
195 \begin_layout Standard
196 This manual also documents some special features, like fax support, version
197 control, and SGML support, which require additional software to work properly.
198 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
199 spruce up your documents by directly using the powerful features of LaTeX.
204 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
207 \begin_layout Standard
208 If you haven't read the
212 yet, you are definitely in the wrong manual.
217 is the first place to go, since it describes the notation and format of
219 You should also be thoroughly familiar with the
223 and all of the basic features of LyX before attempting to read this one.
226 \begin_layout Standard
227 Since all the topics in this manual depend heavily on LyX's interaction
228 with LaTeX, this first chapter covers the inner workings of LyX and how
229 to direct LyX to generate exactly the LaTeX code you want.
230 It is obviously for more seasoned LyX users.
233 \begin_layout Chapter
237 \begin_layout Section
241 \begin_layout Standard
242 This chapter is for both TeX-nicians and the LaTeX-curious.
243 In it, we'll explain how LyX and LaTeX work together to produce printable
245 This is the only place in any of the manuals where we assume you know something
249 \begin_layout Standard
250 At one time, LyX was called a
251 \begin_inset Quotes eld
254 WYSIWYM frontend to LaTeX,
255 \begin_inset Quotes erd
258 but that's no longer true.
259 There are frontends to LaTeX out there.
263 \begin_layout Plain Layout
264 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
265 There are also the LaTeX modes for vi and emacs, of course.
270 These are basically text editors with the ability to run LaTeX and mark
271 any errors in the file you're editing.
280 run LaTeX, and it also indicates errors in the file, it also does much,
282 For one thing, you don't need to know LaTeX to use LyX effectively.
283 And LyX has added its own extensions to LaTeX.
284 Try the following sometime: select
285 \begin_inset Flex CharStyle:MenuItem
288 \begin_layout Plain Layout
289 Export\SpecialChar \menuseparator
296 \begin_inset Flex CharStyle:MenuItem
299 \begin_layout Plain Layout
310 \begin_inset Flex CharStyle:MenuItem
313 \begin_layout Plain Layout
314 View\SpecialChar \menuseparator
320 ), then look at the preamble of the resulting
321 \begin_inset Flex CharStyle:Code
324 \begin_layout Plain Layout
331 You'll notice a variety of new macros defined specifically by LyX.
332 These macros are defined automatically, according to the features you use
336 \begin_layout Standard
337 There are several commands that automatically invoke LaTeX.
341 \begin_layout Itemize
344 \begin_inset Flex CharStyle:MenuItem
347 \begin_layout Plain Layout
352 iew\SpecialChar \menuseparator
363 \begin_layout Itemize
366 \begin_inset Flex CharStyle:MenuItem
369 \begin_layout Plain Layout
374 iew\SpecialChar \menuseparator
379 pdate\SpecialChar \menuseparator
390 \begin_layout Itemize
393 \begin_inset Flex CharStyle:MenuItem
396 \begin_layout Plain Layout
403 \SpecialChar \menuseparator
414 \begin_layout Itemize
417 \begin_inset Flex CharStyle:MenuItem
420 \begin_layout Plain Layout
427 \SpecialChar \menuseparator
438 \begin_layout Standard
439 They will only invoke LaTeX if the file has changed since the last time
444 \begin_layout Standard
445 When LyX runs LaTeX on the file you're editing, it performs these steps:
448 \begin_layout Enumerate
449 Convert the document to LaTeX and save to a file with the extension
450 \begin_inset Flex CharStyle:Code
453 \begin_layout Plain Layout
460 \begin_inset Flex CharStyle:Code
463 \begin_layout Plain Layout
472 \begin_layout Enumerate
474 \begin_inset Flex CharStyle:Code
477 \begin_layout Plain Layout
483 file (maybe several times), and run any other commands (such as
484 \begin_inset Flex CharStyle:Code
487 \begin_layout Plain Layout
494 \begin_inset Flex CharStyle:Code
497 \begin_layout Plain Layout
503 ) needed to compile the LaTeX file.
506 \begin_layout Enumerate
507 If there are any errors, show the error log.
510 \begin_layout Standard
511 If you've run LaTeX using
512 \begin_inset Flex CharStyle:MenuItem
515 \begin_layout Plain Layout
518 \SpecialChar \menuseparator
526 , LyX then runs a DVI viewer to display the DVI-file.
528 \begin_inset Flex CharStyle:MenuItem
531 \begin_layout Plain Layout
534 \SpecialChar \menuseparator
542 , LyX performs further steps:
545 \begin_layout Itemize
547 \begin_inset Flex CharStyle:Code
550 \begin_layout Plain Layout
556 to convert the DVI file to PostScript®.
559 \begin_layout Itemize
560 Run a PostScript® viewer, such as
561 \begin_inset Flex CharStyle:Code
564 \begin_layout Plain Layout
570 , to display the PostScript® file.
573 \begin_layout Standard
574 LyX does similar things when viewing, or exporting, other formats.
577 \begin_layout Section
578 Translating LaTeX files into LyX
581 \begin_layout Standard
582 You can import a LaTeX file into LyX by using the
583 \begin_inset Flex CharStyle:MenuItem
586 \begin_layout Plain Layout
591 ile\SpecialChar \menuseparator
596 mport\SpecialChar \menuseparator
607 This will call a program named
608 \begin_inset Flex CharStyle:Code
611 \begin_layout Plain Layout
617 which will create a file
618 \begin_inset Flex CharStyle:Code
621 \begin_layout Plain Layout
628 \begin_inset Flex CharStyle:Code
631 \begin_layout Plain Layout
638 LyX will then open that file.
642 \begin_layout Plain Layout
643 \begin_inset Flex CharStyle:Code
646 \begin_layout Plain Layout
652 can also be run from the command line, of course.
660 \begin_layout Standard
661 \begin_inset Flex CharStyle:Code
664 \begin_layout Plain Layout
670 will translate most legal LaTeX, but not everything.
671 It will put things it doesn't understand into ERT, so after translating
673 \begin_inset Flex CharStyle:Code
676 \begin_layout Plain Layout
682 , you can look for ERT and hand-edit it until it looks right.
685 \begin_layout Standard
686 If you don't know what ERT is, read the next section.
689 \begin_layout Section
690 \begin_inset CommandInset label
692 name "sec:Inserting-TeX-Code"
696 Inserting TeX Code into LyX Documents
699 \begin_layout Standard
700 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
701 You can always insert TeX code into any LyX document.
702 LyX cannot, and will never be able to, display every possible LaTeX construct.
703 If ever you need to insert LaTeX commands into your LyX document, you can
705 \begin_inset Flex CharStyle:Code
708 \begin_layout Plain Layout
714 box, which you can insert into your document with
715 \begin_inset Flex CharStyle:MenuItem
718 \begin_layout Plain Layout
719 Insert\SpecialChar \menuseparator
728 \begin_layout Standard
729 Here's an example of inserting LaTeX commands in a LyX document.
730 The code looks like this:
733 \begin_layout LyX-Code
737 \begin_inset Newline newline
743 \begin_inset Newline newline
746 This is an example for a minipage environment.
748 \begin_inset Newline newline
751 can put nearly everything in it, even (non-floating)
752 \begin_inset Newline newline
757 \begin_inset Newline newline
763 \begin_inset Newline newline
767 \begin_inset Newline newline
773 \begin_inset Newline newline
779 \begin_inset Newline newline
785 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
808 \begin_inset Newline newline
816 \begin_layout LyX-Code
820 \begin_layout Standard
822 \begin_inset Flex CharStyle:Code
825 \begin_layout Plain Layout
831 box containing this text is directly after this paragraph.
832 Those of you reading the manual in LyX will only see the ERT inset.
833 Those reading a printed version of the manuals will see the actual results:
836 \begin_layout Standard
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
854 \begin_layout Plain Layout
856 This is an example for a minipage environment.
857 You can put nearly everything in it, even (non-floating) figures and tables.
861 \begin_layout Plain Layout
868 \begin_layout Plain Layout
873 \begin_layout Plain Layout
880 \begin_layout Plain Layout
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
900 \begin_layout Plain Layout
907 \begin_layout Plain Layout
914 \begin_layout Plain Layout
921 \begin_layout Plain Layout
933 \begin_layout Standard
934 In addition to using ERT, you can also create a separate file containing
935 some complex LaTeX structure and then use
936 \begin_inset Flex CharStyle:MenuItem
939 \begin_layout Plain Layout
940 Insert\SpecialChar \menuseparator
950 to include your file (you should select the type
951 \begin_inset Flex CharStyle:Code
954 \begin_layout Plain Layout
961 We recommend that you only do this if you have a
962 \begin_inset Flex CharStyle:Code
965 \begin_layout Plain Layout
976 Otherwise, you'll have a big job tracking down LaTeX errors.
979 \begin_layout Standard
980 There are a few last points to emphasize:
983 \begin_layout Itemize
988 check if your LaTeX code is correct.
991 \begin_layout Itemize
992 Beware reinventing the wheel.
995 \begin_layout Standard
996 On that last point, LyX does have quite a few features tucked into it, and
998 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
999 feature before you decide you have to do it by hand.
1000 Moreover, there are numerous LaTeX packages out there to do all sorts of
1001 things, from labels to envelopes to fancy multipage tables.
1003 \begin_inset CommandInset href
1006 target "http://www.ctan.org/"
1010 for details, and see chapter
1011 \begin_inset CommandInset ref
1013 reference "cha:secrets"
1020 \begin_layout Standard
1021 If you do need to do some wild and fancy things within your document, be
1022 sure to check out a good LaTeX book for assistance.
1023 There are a number of them listed in the bibliography of the
1030 \begin_layout Section
1031 LyX and the LaTeX Preamble
1034 \begin_layout Subsection
1035 About the LaTeX Preamble
1038 \begin_layout Standard
1039 If you already know LaTeX, there is no need to explain here what the preamble
1041 If you don't, the following will give you some ideas---we recommend again
1042 that you consult a LaTeX book for further information.
1043 In any case, you should read the points below, because they explain what
1044 you can do and what you don't need to do in the LaTeX preamble of a LyX
1048 \begin_layout Standard
1049 The LaTeX preamble comes at the very beginning of a document,
1057 \begin_layout Itemize
1058 Declare the document class.
1060 \begin_inset Newline newline
1063 LyX already does this for you.
1064 If you're a seasoned LaTeX-nician, and you have a custom document class
1065 you want to use, check out the
1067 Customization Manual
1069 for information on how to make LyX interface to it.
1072 \begin_layout Itemize
1073 Declare the usage of packages.
1075 \begin_inset Newline newline
1078 LaTeX packages provide special commands, which are only available within
1079 a document when the package has been declared in the preamble.
1080 For example, the package
1081 \begin_inset Flex CharStyle:Code
1084 \begin_layout Plain Layout
1090 forces all paragraphs to be indented.
1091 There are other packages for labels, envelopes, margins, etc.
1095 \begin_layout Itemize
1096 Set counters, variables, lengths and widths.
1098 \begin_inset Newline newline
1101 There are several LaTeX counters and variables which
1105 be set globally from within the preamble in order to have the desired effect.
1106 (There are variables which you can set and reset inside the document, too.)
1107 Margins are a good example of something which must be set in the preamble.
1108 Another example is the label format for lists.
1109 You can actually set these just about anywhere, but it's best to do it
1110 just once, inside the preamble.
1113 \begin_layout Itemize
1114 Declare user defined commands (with
1115 \begin_inset Flex CharStyle:Code
1118 \begin_layout Plain Layout
1127 \begin_inset Flex CharStyle:Code
1130 \begin_layout Plain Layout
1139 \begin_inset Newline newline
1142 These are abbreviations for LaTeX commands which appear very often inside
1144 Although the preamble is a good place to declare such commands, they
1148 be declared anywhere (before they are used for the first time, of course).
1149 This can be useful if there is a lot of raw LaTeX code in your document,
1150 which normally should not be the case.
1153 \begin_layout Standard
1154 LyX adds its own set of definitions to the preamble of the
1155 \begin_inset Flex CharStyle:Code
1158 \begin_layout Plain Layout
1165 This makes LaTeX files generated by LyX portable.
1168 \begin_layout Subsection
1169 Changing the Preamble
1172 \begin_layout Standard
1173 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1174 can't change them without patching LyX itself.
1175 You can, however, add your own stuff to the preamble by selecting
1176 \begin_inset Flex CharStyle:MenuItem
1179 \begin_layout Plain Layout
1185 \begin_inset space ~
1198 \begin_inset Flex CharStyle:MenuItem
1201 \begin_layout Plain Layout
1206 ocument\SpecialChar \menuseparator
1217 LyX adds anything in the
1218 \begin_inset Flex CharStyle:MenuItem
1221 \begin_layout Plain Layout
1227 dialog to its own built-in preamble.
1228 Before adding your own declarations in the preamble, you should make sure
1229 that LyX doesn't already support what you want to do.
1230 (Remember what we said about reinventing the wheel?) Also,
1232 make sure your preamble code is correct
1235 LyX doesn't check it for you.
1236 If there is an error, you're likely to get an error like
1237 \begin_inset Quotes eld
1241 \begin_inset Flex CharStyle:Code
1244 \begin_layout Plain Layout
1253 \begin_inset Quotes erd
1257 If you see this error, check your preamble.
1260 \begin_layout Subsection
1264 \begin_layout Standard
1265 Here are some examples of what you can add to a preamble, and what they
1269 \begin_layout Subsubsection
1273 \begin_layout Standard
1274 There are two variables under LaTeX that control page position:
1275 \begin_inset Flex CharStyle:Code
1278 \begin_layout Plain Layout
1287 \begin_inset Flex CharStyle:Code
1290 \begin_layout Plain Layout
1299 Their names should be self-explanatory.
1300 These variables are useful if you think for a moment about computer labels.
1301 Sometimes, the size of a print medium and the area of the medium that you
1302 can actually print on aren't the same.
1304 \begin_inset Flex CharStyle:Code
1307 \begin_layout Plain Layout
1316 \begin_inset Flex CharStyle:Code
1319 \begin_layout Plain Layout
1330 \begin_layout Standard
1331 The default values for
1332 \begin_inset Flex CharStyle:Code
1335 \begin_layout Plain Layout
1344 \begin_inset Flex CharStyle:Code
1347 \begin_layout Plain Layout
1355 are both 0 points, i.e., the page isn't shifted.
1356 Unfortunately, some DVI drivers always seem to shift the page.
1357 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1358 If you're using LyX on a system that you don't personally maintain, and
1359 your sysadmin is a doofus,
1360 \begin_inset Flex CharStyle:Code
1363 \begin_layout Plain Layout
1372 \begin_inset Flex CharStyle:Code
1375 \begin_layout Plain Layout
1384 Suppose you're left and top margins are always 0.5 inches too big.
1385 You can add this to the preamble:
1388 \begin_layout LyX-Code
1396 \begin_layout LyX-Code
1404 \begin_layout Standard
1405 and your margins should now be correct.
1408 \begin_layout Subsubsection
1412 \begin_layout Standard
1413 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1414 There's a rather nice package, available at your nearest CTAN archive,
1415 for printing sheets of labels:
1416 \begin_inset Flex CharStyle:Code
1419 \begin_layout Plain Layout
1426 Now, your system may not have this package installed by default.
1427 We leave that up to you to check.
1428 You'll also want to read the documentation for it; we're not going to do
1430 Since this is an example, however, we'll give you an example of how you
1434 \begin_layout Standard
1435 First, make sure you're using the
1436 \begin_inset Flex CharStyle:Code
1439 \begin_layout Plain Layout
1446 Next, you need to put the following in your preamble:
1449 \begin_layout LyX-Code
1455 \begin_layout LyX-Code
1461 \begin_layout LyX-Code
1467 \begin_layout LyX-Code
1473 \begin_layout LyX-Code
1479 \begin_layout LyX-Code
1485 \begin_layout LyX-Code
1491 \begin_layout Standard
1492 This sets things up for Avery® label sheets, stock #5360.
1493 You're now ready to print labels, but you'll need to insert LaTeX code,
1494 placing the commands
1495 \begin_inset Flex CharStyle:Code
1498 \begin_layout Plain Layout
1507 \begin_inset Flex CharStyle:Code
1510 \begin_layout Plain Layout
1518 around each label text.
1519 This and other special features of
1520 \begin_inset Flex CharStyle:Code
1523 \begin_layout Plain Layout
1529 are explained in its documentation.
1532 \begin_layout Standard
1533 Someday, someone may write a LyX layout file to support this package directly.
1534 Maybe that someone is you.
1537 \begin_layout Subsubsection
1538 Example #3: Paragraph Indentation
1541 \begin_layout Standard
1542 Americans are trained to indent the first line of
1547 As with all of their other weird quirks, most Americans will whine and
1548 moan until they can have their way and indent the first line of all paragraphs.
1557 \begin_layout Standard
1558 Of course, this behavior isn't standard typography.
1559 In books, you typically only indent the first line of a paragraph
1563 it follows another one.
1564 The idea behind indenting the first line of a paragraph is to distinguish
1565 neighboring paragraphs from one another.
1566 If there is no previous paragraph---for example, if it follows a figure
1567 or is the first paragraph in a section---then there is no need for indentation.
1571 \begin_layout Standard
1572 If you're a typical American (we're still joking!), though, you don't care
1573 about such esoteric things; you want your indentation! Add this to the
1577 \begin_layout LyX-Code
1580 usepackage{indentfirst}
1583 \begin_layout Standard
1584 If your TeX distribution isn't braindead, you'll have this package, and
1585 all of your paragraphs will get the indentation the Founding Fathers intended
1589 \begin_layout Subsubsection
1590 Example #4: This Document
1593 \begin_layout Standard
1594 You can also check out the preamble of this document to get an idea of some
1595 of the advanced things you can do.
1596 Also, there are more examples and an assortment of LaTeX
1597 \begin_inset Quotes eld
1601 \begin_inset Quotes erd
1605 \begin_inset space ~
1609 \begin_inset CommandInset ref
1611 reference "cha:secrets"
1619 \begin_layout Section
1620 LyX and LaTeX Errors
1623 \begin_layout Standard
1624 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1626 It then uses the logfile from the LaTeX run to do a post-mortem.
1627 After analyzing the logfile,LyX displays a dialog listing the errors.
1628 Clicking on any one of them will take you to the position in your LyX file
1629 where the error occurred.
1633 \begin_layout Plain Layout
1635 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1637 There are also cases where LaTeX reports the error on one line, but the
1638 actual error is earlier.
1639 This is not unlike forgetting a closing brace in a program: You'll get
1640 an error, but only later.
1648 \begin_layout Standard
1649 Some folks also like to look at the log file directly: It is available from
1651 \begin_inset Flex CharStyle:MenuItem
1654 \begin_layout Plain Layout
1657 \SpecialChar \menuseparator
1661 \begin_inset space ~
1670 There are some fairly common error messages and warnings.
1671 We'll cover those here.
1672 You should look at a good LaTeX book for a complete listing.
1675 \begin_layout Itemize
1676 \begin_inset Flex CharStyle:Code
1679 \begin_layout Plain Layout
1686 \begin_inset Newline newline
1689 Anything beginning with these words is a warning message for the purpose
1691 \begin_inset Quotes eld
1695 \begin_inset Quotes erd
1698 the LaTeX code itself.
1699 You'll get messages like this if you added or changed cross-references
1700 or bibliography entries, in which case, LaTeX is trying to tell you that
1701 you need to make another run.
1702 You can by-and-large ignore these.
1705 \begin_layout Itemize
1706 \begin_inset Flex CharStyle:Code
1709 \begin_layout Plain Layout
1716 \begin_inset Newline newline
1719 Another warning message, this time about fonts which LaTeX couldn't find.
1720 The rest of the message will often say something about a replacement font
1722 You can safely ignore these, too.
1725 \begin_layout Itemize
1726 \begin_inset Flex CharStyle:Code
1729 \begin_layout Plain Layout
1738 \begin_inset Newline newline
1746 They are warnings about lines that were too long and run past the right
1748 Almost always, this is unnoticeable in the final output.
1749 (It can be just a point or two.) Or, only one or two characters extend past
1751 LaTeX seems to generate at least one of these messages for just about any
1753 \begin_inset Newline newline
1756 You can ignore these messages.
1757 Your eyes will tell you if there's a problem with something that's too
1758 wide; just look at the output.
1762 \begin_layout Plain Layout
1763 You can also enable the `draft' option in
1764 \begin_inset Flex CharStyle:MenuItem
1767 \begin_layout Plain Layout
1770 \SpecialChar \menuseparator
1778 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1786 \begin_layout Itemize
1787 \begin_inset Flex CharStyle:Code
1790 \begin_layout Plain Layout
1799 \begin_inset Newline newline
1802 Not quite as common as its cousin.
1803 LaTeX seems to like to print lines that are a bit too wide as opposed to
1804 ones that are a bit too narrow.
1805 We have no idea why.
1808 \begin_layout Itemize
1809 \begin_inset Flex CharStyle:Code
1812 \begin_layout Plain Layout
1821 \begin_inset Flex CharStyle:Code
1824 \begin_layout Plain Layout
1833 \begin_inset Newline newline
1836 Warnings about troubles breaking the page.
1837 Once again, just look at the output.
1838 Your eyes will tell you where something has gone wrong.
1841 \begin_layout Itemize
1842 \begin_inset Flex CharStyle:Code
1845 \begin_layout Plain Layout
1847 \begin_inset Quotes els
1851 \begin_inset Quotes ers
1860 \begin_inset Newline newline
1864 \begin_inset Quotes eld
1868 \begin_inset Quotes erd
1871 isn't installed on this system.
1872 This usually appears because some package your document needs isn't installed.
1873 If you didn't touch the preamble or didn't use the
1874 \begin_inset Flex CharStyle:Code
1877 \begin_layout Plain Layout
1885 command, then one of the packages LyX tried to load is missing.
1887 \begin_inset Flex CharStyle:MenuItem
1890 \begin_layout Plain Layout
1891 Help\SpecialChar \menuseparator
1897 to get a list of packages that LyX knows about.
1898 This file is updated whenever you reconfigure LyX (using
1899 \begin_inset Flex CharStyle:MenuItem
1902 \begin_layout Plain Layout
1903 Tools\SpecialChar \menuseparator
1909 ) and tells you which packages have been detected and what they do.
1910 \begin_inset Newline newline
1914 \begin_inset Flex CharStyle:Code
1917 \begin_layout Plain Layout
1925 command and the package in question isn't installed, then you'll need to
1926 install it yourself.
1929 \begin_layout Itemize
1930 \begin_inset Flex CharStyle:Code
1933 \begin_layout Plain Layout
1934 LaTeX Error: Unknown option
1940 \begin_inset Newline newline
1943 Error messages beginning with this are trying to tell you that you specified
1944 a bad or undefined option to a package.
1945 Check the package's documentation.
1948 \begin_layout Itemize
1949 \begin_inset Flex CharStyle:Code
1952 \begin_layout Plain Layout
1953 Undefined control sequence
1959 \begin_inset Newline newline
1962 If you've inserted LaTeX code into your document, but made a typo, you'll
1964 You may have forgotten to load a package.
1965 In any case, this error message usually means that you used an undefined
1970 \begin_layout Standard
1971 There are other error and warning messages.
1972 Some are self-explanatory.
1973 These are usually LaTeX messages.
1974 Others are downright cryptic.
1975 These are usually TeX error messages, and we really have
1979 what they mean or how to decipher them.
1983 \begin_layout Standard
1984 There's a general sequence you should follow if you get error messages:
1987 \begin_layout Enumerate
1988 Look at the LaTeX code you inserted for typos.
1991 \begin_layout Enumerate
1992 If there are no typos, check that you used the command(s) correctly.
1995 \begin_layout Enumerate
1996 If you get a bunch of error boxes piled up at the very top of the document---and
1997 especially if you see a
1998 \begin_inset Quotes eld
2002 \begin_inset Flex CharStyle:Code
2005 \begin_layout Plain Layout
2014 \begin_inset Quotes erd
2017 error---it means that there are errors in the preamble.
2018 Start debugging your preamble.
2021 \begin_layout Enumerate
2022 If you didn't add anything to the preamble and didn't add any LaTeX code
2023 to the document, the first suspect is your LaTeX distribution itself.
2024 Check for missing packages and install them.
2027 \begin_layout Enumerate
2028 Okay, so there are no missing packages.
2029 Did you use any of the fine-tuning options in LyX? Specifically, did you
2034 any of them, like trying to manually insert lots of
2035 \begin_inset Flex CharStyle:Code
2038 \begin_layout Plain Layout
2040 \begin_inset space ~
2049 \begin_inset Flex CharStyle:Code
2052 \begin_layout Plain Layout
2059 \begin_inset Flex CharStyle:Code
2062 \begin_layout Plain Layout
2068 ? Did you try to kludge something together with these instead of using the
2069 appropriate paragraph environment?
2072 \begin_layout Enumerate
2073 All right, you didn't use any of the fine-tuning options, you played by
2075 Did you try to pull a fancy maneuver? Did you do something funky inside
2076 a table or an equation, like inserting a graphic into a table cell?
2079 \begin_layout Enumerate
2080 Do you have long sections of text where LaTeX cannot find a place to break
2081 a line? By default, LaTeX is rather strict about how much extra inter-word
2082 spacing it will add in order to break a line.
2083 Preferably, you should rework the paragraph to avoid the problem.
2084 If this isn't an option, you can wrap your text in
2085 \begin_inset Flex CharStyle:Code
2088 \begin_layout Plain Layout
2096 to make LaTeX's line breaking more, well, sloppy.
2099 \begin_layout Enumerate
2100 Did you go overboard with the nesting? LyX (currently) doesn't check to
2101 make sure you're in the limits for nesting environments.
2102 If you nested a bunch of environments to the
2103 \begin_inset Formula $17^{\mathrm{th}}$
2106 level, that's the problem.
2107 (The limit in LaTeX is five.)
2110 \begin_layout Enumerate
2111 Okay, you didn't get any error messages, but your output looks awful.
2112 If you have a table or figure that's too wide or long for the page, you
2117 \begin_layout Enumerate
2118 rescale the figure so it fits.
2121 \begin_layout Enumerate
2122 trim down the table so it fits.
2126 \begin_layout Enumerate
2127 If something else is wrong with the output, and you didn't try to pull anything
2128 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2131 \begin_layout Standard
2132 If all this doesn't help---well, then
2136 you might have found a bug in LyX\SpecialChar \ldots{}
2140 \begin_layout Chapter
2141 Supplemental Toopullls
2144 \begin_layout Section
2145 Customizing Bibliographies with BibTeX
2148 \begin_layout Standard
2149 The basics how to use BibTeX are explained in section
2151 Bibliography databases (BibTeX)
2158 The following subsections explain special bibliography features supported
2162 \begin_layout Subsection
2163 Alternative Citation Styles
2166 \begin_layout Standard
2167 Standard BibTeX uses numbers (e.g.,
2168 \begin_inset Quotes eld
2172 \begin_inset Quotes erd
2175 ) to refer to a cited work.
2176 However, in many scientific disciplines, other citation styles are in use.
2177 The most common one is the author-year style (e.g.,
2178 \begin_inset Quotes eld
2182 \begin_inset Quotes erd
2186 LyX supports two packages that provide this style,
2187 \begin_inset Flex CharStyle:Code
2190 \begin_layout Plain Layout
2197 \begin_inset Flex CharStyle:Code
2200 \begin_layout Plain Layout
2207 Both packages have their pros and cons, which cannot be listed in detail.
2208 If you only want to have simple author-year (or author-numerical) style,
2209 or if you want to use one of the countless style files for
2210 \begin_inset Flex CharStyle:Code
2213 \begin_layout Plain Layout
2219 , than the established
2220 \begin_inset Flex CharStyle:Code
2223 \begin_layout Plain Layout
2229 package is probably your choice.
2230 If you need special features like short title references, ibidem etc., you
2232 \begin_inset Flex CharStyle:Code
2235 \begin_layout Plain Layout
2244 \begin_layout Standard
2245 The handling of both packages in LyX is basically the same.
2247 \begin_inset Flex CharStyle:MenuItem
2250 \begin_layout Plain Layout
2251 Document\SpecialChar \menuseparator
2258 \begin_inset Flex CharStyle:MenuItem
2261 \begin_layout Plain Layout
2268 \begin_inset Flex CharStyle:MenuItem
2271 \begin_layout Plain Layout
2278 \begin_inset Flex CharStyle:MenuItem
2281 \begin_layout Plain Layout
2288 With both packages, you will get some extra features in the citation dialog
2289 and you can select the style of the reference (
2290 \begin_inset Quotes eld
2294 \begin_inset Quotes erd
2298 \begin_inset Quotes eld
2302 \begin_inset Quotes erd
2306 \begin_inset Quotes eld
2310 \begin_inset Quotes erd
2314 \begin_inset Quotes eld
2318 \begin_inset Quotes erd
2322 Note that both packages need specifically designed style files.
2323 They both ship their own, but there are lots of additional style files,
2324 and there is even an interactive style file builder
2328 \begin_layout Plain Layout
2330 \begin_inset Flex URL
2333 \begin_layout Plain Layout
2335 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2346 \begin_inset Flex CharStyle:Code
2349 \begin_layout Plain Layout
2358 \begin_layout Subsection
2359 Sectioned Bibliographies
2362 \begin_layout Standard
2363 Sometimes you might need to divide your bibliography into several sections.
2364 If you are for instance a historian, the possibility to separate sources
2365 and scientific works is most likely a
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2374 Unfortunately, BibTeX itself does not allow you to do this.
2375 But with the help of some LaTeX packages, BibTeX can be extended to fit
2379 \begin_layout Standard
2380 LyX provides native support for one of these packages,
2388 \begin_layout Plain Layout
2390 \begin_inset Flex URL
2393 \begin_layout Plain Layout
2395 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2405 The advantage of this package (compared to other packages like
2409 ) is that you don't need to define new citation commands.
2410 Instead, you need to prepare different bibliographic databases which include
2411 the entries for the different sections of the bibliography.
2412 For example: If you want to divide your bibliography into the sections
2414 \begin_inset Quotes eld
2418 \begin_inset Quotes erd
2422 \begin_inset Quotes eld
2426 \begin_inset Quotes erd
2429 , you first need to create two bibliographic databases, e.g.,
2430 \begin_inset Flex CharStyle:Code
2433 \begin_layout Plain Layout
2440 \begin_inset Flex CharStyle:Code
2443 \begin_layout Plain Layout
2453 \begin_layout Standard
2455 \begin_inset Flex CharStyle:MenuItem
2458 \begin_layout Plain Layout
2459 Document\SpecialChar \menuseparator
2466 \begin_inset Flex CharStyle:MenuItem
2469 \begin_layout Plain Layout
2476 \begin_inset Flex CharStyle:MenuItem
2479 \begin_layout Plain Layout
2480 Sectioned bibliography
2486 Now you can insert multiple BibTeX bibliographies, one for each section
2487 of your bibliography.
2488 Returning to our example: Insert the BibTeX bibliography
2489 \begin_inset Flex CharStyle:Code
2492 \begin_layout Plain Layout
2498 and a second one for the database
2499 \begin_inset Flex CharStyle:Code
2502 \begin_layout Plain Layout
2509 You are free to use the same or different styles for each section.
2510 Additionally, you can chose if the bibliography section should contain
2512 \begin_inset Quotes eld
2515 all cited references
2516 \begin_inset Quotes erd
2519 of the specified database(s) (which is the default),
2520 \begin_inset Quotes eld
2523 all uncited references
2524 \begin_inset Quotes erd
2528 \begin_inset Quotes eld
2532 \begin_inset Quotes erd
2536 This might be useful if you would like to separate your bibliography into
2538 \begin_inset Quotes eld
2542 \begin_inset Quotes erd
2546 \begin_inset Quotes eld
2550 \begin_inset Quotes erd
2554 \begin_inset Quotes eld
2558 \begin_inset Quotes erd
2562 The titles for the sections can be added as ordinary sections or subsections.
2564 \begin_inset Flex CharStyle:Code
2567 \begin_layout Plain Layout
2573 removes the bibliography title, you have manually re-add that, too (as
2574 a chapter* or section*, for instance).
2577 \begin_layout Subsection
2578 Multiple Bibliographies
2581 \begin_layout Standard
2582 Multiple bibliographies, e.g., a bibliography for each section or chapter
2583 of the document, are not supported by BibTeX itself.
2585 \begin_inset Flex CharStyle:Code
2588 \begin_layout Plain Layout
2594 package, which is used for the creation of sectioned bibliographies in
2595 LyX (see the previous section), provides an easy way to solve this task,
2596 if you are willing to use some
2597 \begin_inset Flex CharStyle:MenuItem
2600 \begin_layout Plain Layout
2607 \begin_inset space ~
2611 \begin_inset CommandInset ref
2613 reference "sec:Inserting-TeX-Code"
2621 \begin_layout Plain Layout
2622 An alternative approach is to use the
2623 \begin_inset Flex CharStyle:Code
2626 \begin_layout Plain Layout
2633 \begin_inset Flex CharStyle:Code
2636 \begin_layout Plain Layout
2642 package, respectively.
2650 \begin_layout Standard
2652 \begin_inset Flex CharStyle:MenuItem
2655 \begin_layout Plain Layout
2656 Document\SpecialChar \menuseparator
2663 \begin_inset Flex CharStyle:MenuItem
2666 \begin_layout Plain Layout
2673 \begin_inset Flex CharStyle:MenuItem
2676 \begin_layout Plain Layout
2677 Sectioned bibliography
2683 In the document, you have to enclose the sections, which shall contain
2684 their own bibliography (including the BibTeX bibliography itself), between
2686 \begin_inset Flex CharStyle:Code
2689 \begin_layout Plain Layout
2698 \begin_inset Flex CharStyle:Code
2701 \begin_layout Plain Layout
2709 (those commands have to be inserted as ERT).
2710 The bibliography will contain all references which have been cited in the
2712 \begin_inset Flex CharStyle:Code
2715 \begin_layout Plain Layout
2726 If you are using this approach, then every citation reference has to be
2728 \begin_inset Flex CharStyle:Code
2731 \begin_layout Plain Layout
2739 \begin_inset Flex CharStyle:Code
2742 \begin_layout Plain Layout
2751 \begin_layout Section
2755 \begin_layout Subsection
2759 \begin_layout Standard
2760 When you are working on a large file with many sections, it is often convenient
2761 to break up the document into several files, or perhaps you have something
2762 where a table may change from time to time, but the preceding text does
2764 In these cases, you should seriously consider using multipart documents.
2765 For example, scientific papers often have five major sections: the introduction
2766 , observations, results, discussion, and conclusion.
2767 Each of these could be its own separate LyX file, with one
2768 \begin_inset Quotes eld
2772 \begin_inset Quotes erd
2775 file which contains the title, authors, abstract, references, etc., plus
2776 the five included files.
2777 It is important to note that each of these files is a full LyX file which
2778 can be formatted and printed on its own, as well as included in a master
2780 Each of these files must have the same document class, however---don't
2781 attempt to mix book classes with article classes.
2782 You may also include LaTeX files; however, these files must not have their
2788 everything up to and including the
2789 \begin_inset Flex CharStyle:Code
2792 \begin_layout Plain Layout
2801 \begin_inset Flex CharStyle:Code
2804 \begin_layout Plain Layout
2812 line must be deleted) or else errors will be generated when you try to
2816 \begin_layout Standard
2817 LyX allows you to include files quite easily with
2818 \begin_inset Flex CharStyle:MenuItem
2821 \begin_layout Plain Layout
2822 Insert\SpecialChar \menuseparator
2824 \begin_inset space ~
2833 When you click on this selection a small box is inserted into the file
2834 at the current cursor location.
2835 Clicking on the box raises a dialog which allows you to select the file
2836 to be included, and the method of its inclusion.
2840 \begin_layout Standard
2841 The file selection box should by now be obvious.
2842 The three inclusion methods are
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2851 \begin_inset Quotes eld
2855 \begin_inset Quotes erd
2859 \begin_inset Quotes eld
2863 \begin_inset Quotes erd
2867 The difference between
2868 \begin_inset Quotes eld
2872 \begin_inset Quotes erd
2876 \begin_inset Quotes eld
2880 \begin_inset Quotes erd
2883 is really only meaningful to LaTeXperts, but the practical difference is
2884 that files which are
2885 \begin_inset Quotes eld
2889 \begin_inset Quotes erd
2892 are typeset beginning on a new page, while files which are
2893 \begin_inset Quotes eld
2897 \begin_inset Quotes erd
2900 are typeset starting on the current page.
2903 \begin_layout Standard
2904 Generally, the master file is converted into a full LaTeX file before typesettin
2905 g, while the included files are converted to LaTeX files which do not have
2906 all the preamble information.
2909 \begin_layout Standard
2911 \begin_inset Quotes eld
2915 \begin_inset Quotes erd
2918 included file allows you to include a file typeset exactly as it appears
2919 in the file, i.e., in
2920 \begin_inset Flex CharStyle:Code
2923 \begin_layout Plain Layout
2929 mode, with the characters set in a fixed-width typewriter font.
2930 Normally, spaces in this file are invisible, though two consecutive spaces
2931 are conserved, unlike LyX's normal treatment of spaces.
2932 However, setting the
2933 \begin_inset Flex CharStyle:MenuItem
2936 \begin_layout Plain Layout
2938 \begin_inset space ~
2942 \begin_inset space ~
2946 \begin_inset space ~
2954 checkbox typesets a mark to unambiguously define the presence of a space.
2958 \begin_layout Subsection
2959 Cross-References Between Files
2962 \begin_layout Standard
2963 \begin_inset Box Shadowbox
2972 height_special "totalheight"
2975 \begin_layout Plain Layout
2976 This section is somewhat out of date.
2977 Need to describe default master documents and how children are opened when
2987 \begin_layout Standard
2988 It is possible to set up cross-references between the different files.
2989 First, open all the files in question: let's call them A and B in a two
2990 file example, where B is included in A.
2991 Let's say you insert a label in A, then want to reference it in B.
2992 Open the cross-reference dialog in whilst in document B, and you can select
2994 \begin_inset Quotes eld
2998 \begin_inset Quotes erd
3004 \begin_layout Subsection
3005 Bibliography Lists in all Subdocuments
3008 \begin_layout Standard
3009 \begin_inset Box Frameless
3018 height_special "totalheight"
3021 \begin_layout Plain Layout
3022 This section also needs updating.
3023 There is now material about this on the wiki, and it could be copied here.
3031 \begin_layout Standard
3032 Copy the bibliography list with all entries to all subdocuments and transform
3034 This way LyX will find the
3035 \begin_inset Flex CharStyle:Code
3038 \begin_layout Plain Layout
3044 -files and you can easily insert references without making the bibliography
3048 \begin_layout Standard
3049 As the bibliography list is in a comment, LaTeX won't use use it and the
3050 references will look like this: [?], instead of like this: [1].
3051 One solution is to use the LaTeX-package
3052 \begin_inset Flex CharStyle:Code
3055 \begin_layout Plain Layout
3061 that will only include comments by processing the files separately.
3062 To do this, add in the LaTeX preamble of every subdocument the following:
3065 \begin_layout LyX-Code
3071 \begin_layout LyX-Code
3074 includecomment{comment}
3077 \begin_layout Standard
3079 \begin_inset Flex URL
3082 \begin_layout Plain Layout
3084 http://wiki.lyx.org/FAQ/Unsorted#toc31
3092 \begin_layout Section
3093 Fancy Headers and Footers
3096 \begin_layout Standard
3097 The default page layout is rather plain; for an
3098 \begin_inset Flex CharStyle:Code
3101 \begin_layout Plain Layout
3107 document class, all you get is a centered page number at the bottom of
3109 This document uses KOMA-script's book class, so it appears to be a bit
3111 But to really put on a show, you need to set the document page style to
3113 \begin_inset Quotes eld
3117 \begin_inset Quotes erd
3120 , as mentioned in the
3125 This section describes the LaTeX code you need to insert in your LaTeX
3126 preamble in order to get the desired effects.
3129 \begin_layout Standard
3130 The page header is divided into three fields, not surprisingly labeled
3131 \begin_inset Quotes eld
3135 \begin_inset Quotes erd
3139 \begin_inset Quotes eld
3143 \begin_inset Quotes erd
3147 \begin_inset Quotes eld
3151 \begin_inset Quotes erd
3155 The footer is also divided into these three fields.
3156 The LaTeX commands to set these fields in the simplest manner are
3157 \begin_inset Flex CharStyle:Code
3160 \begin_layout Plain Layout
3169 \begin_inset Flex CharStyle:Code
3172 \begin_layout Plain Layout
3181 \begin_inset Flex CharStyle:Code
3184 \begin_layout Plain Layout
3193 \begin_inset Flex CharStyle:Code
3196 \begin_layout Plain Layout
3205 Suppose you wish to put your name in the upper left hand corner of each
3207 Simply insert the following command in the preamble:
3210 \begin_layout Standard
3219 \begin_layout Standard
3220 You will now see your name in the upper left.
3221 If a field has a default entry that you would like to get rid of (often
3222 the page number appears in the central footer, simply include a command
3223 with a blank argument, e.g.:
3226 \begin_layout Standard
3234 \begin_layout Standard
3235 Let's get really fancy: lets put the section number with the word
3236 \begin_inset Quotes eld
3240 \begin_inset Quotes erd
3243 (e.g., Section 3) in the upper left, the page number (e.g., Page 4) in the
3244 upper right, your name in the lower left, and the date in the lower right.
3245 The following commands should now appear in the preamble:
3248 \begin_layout Standard
3258 \begin_layout Standard
3266 \begin_layout Standard
3276 \begin_layout Standard
3285 \begin_layout Standard
3293 \begin_layout Standard
3303 \begin_layout Standard
3305 \begin_inset Flex CharStyle:Code
3308 \begin_layout Plain Layout
3317 \begin_inset Flex CharStyle:Code
3320 \begin_layout Plain Layout
3328 access LaTeX's section and page counters, and so print out the current
3329 section and page numbers.
3331 \begin_inset Flex CharStyle:Code
3334 \begin_layout Plain Layout
3342 simply prints out today's date.
3345 \begin_layout Standard
3346 The thicknesses of the horizontal rules drawn beneath the header and above
3347 the footer can also be modified.
3348 If you don't want one of the rules, set its thickness to 0.
3349 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3355 \begin_inset Flex CharStyle:Code
3358 \begin_layout Plain Layout
3363 headrulewidth}{0.4pt}
3369 \begin_inset Flex CharStyle:Code
3372 \begin_layout Plain Layout
3377 footrulewidth}{0.4pt}
3382 to set the thicknesses.
3385 \begin_layout Standard
3386 You can switch the header/footer settings on and off for individual pages
3388 \begin_inset Flex CharStyle:Code
3391 \begin_layout Plain Layout
3394 thispagestyle{empty}
3400 \begin_inset Flex CharStyle:Code
3403 \begin_layout Plain Layout
3406 thispagestyle{plain}
3412 \begin_inset Flex CharStyle:Code
3415 \begin_layout Plain Layout
3418 thispagestyle{fancy}
3424 Simply insert them in the text on the page you want changed and mark them
3426 In fact, title pages are marked as plain by default, while following pages
3427 are marked fancy when using the global fancy setting.
3430 \begin_layout Standard
3431 There are more complex commands which will let you insert things in the
3432 upper left on odd numbered pages, etc., but we will refer you to the
3433 \begin_inset Flex CharStyle:Code
3436 \begin_layout Plain Layout
3442 package documentation for more information.
3444 \begin_inset Flex CharStyle:Code
3447 \begin_layout Plain Layout
3456 \begin_layout Standard
3457 As a final example, it is possible to include an image in the header or
3459 Suppose you want to put a company logo in the upper lefthand corner.
3460 You might try something like
3463 \begin_layout Standard
3472 includegraphics{logo.eps}}}
3475 \begin_layout Standard
3477 (you may need to preface this with
3478 \begin_inset Flex CharStyle:Code
3481 \begin_layout Plain Layout
3485 usepackage{graphics}
3490 if you don't include graphics elsewhere in your document).
3493 \begin_layout Section
3494 Itemize Bullet Selection
3495 \begin_inset CommandInset label
3504 \begin_layout Standard
3510 \begin_layout Subsection
3514 \begin_layout Standard
3515 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3516 Using this dialog you can easily specify what bullet shape to use at each
3517 level of an itemized list.
3518 These settings are document-wide so you won't be able to specify different
3519 sets of bullets for different paragraphs.
3523 \begin_layout Plain Layout
3524 Well, actually you can but you'll have to do it by hand.
3532 \begin_layout Subsection
3536 \begin_layout Standard
3537 Open the dialog by selecting the
3538 \begin_inset Flex CharStyle:MenuItem
3541 \begin_layout Plain Layout
3542 Document\SpecialChar \menuseparator
3548 menu item and then select the
3549 \begin_inset Flex CharStyle:MenuItem
3552 \begin_layout Plain Layout
3561 \begin_layout Standard
3562 The dialog provides you with a table of bullet shapes.
3563 A column of buttons on the left of the table provides access to the six
3564 different panels of bullet shapes.
3565 The row of buttons across the top is used to select which bullet depth
3567 A text entry under the table shows the currently selected bullet shape's
3568 LaTeX equivalent and this can be edited if desired.
3569 If you do modify the text you will also need to specify any needed packages
3570 in the LaTeX preamble.
3573 \begin_layout Standard
3574 The six panels are divided up by the packages they require.
3575 The following table shows the mappings from button name to LaTeX packages.
3578 \begin_layout Standard
3580 \begin_inset Tabular
3581 <lyxtabular version="3" rows="7" columns="2">
3583 <column alignment="center" valignment="top" width="0pt">
3584 <column alignment="center" valignment="top" width="0pt">
3586 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3589 \begin_layout Plain Layout
3604 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3607 \begin_layout Plain Layout
3624 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3627 \begin_layout Plain Layout
3642 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3645 \begin_layout Plain Layout
3661 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3664 \begin_layout Plain Layout
3679 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3682 \begin_layout Plain Layout
3699 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3702 \begin_layout Plain Layout
3717 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3720 \begin_layout Plain Layout
3737 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3740 \begin_layout Plain Layout
3755 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3758 \begin_layout Plain Layout
3775 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3778 \begin_layout Plain Layout
3793 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3796 \begin_layout Plain Layout
3813 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3816 \begin_layout Plain Layout
3831 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3834 \begin_layout Plain Layout
3857 \begin_layout Standard
3858 LyX doesn't stop you using bullets from packages you don't have.
3859 If you get errors from LaTeX when you try to view or print the file, then
3860 it is likely you are missing a package.
3864 \begin_layout Plain Layout
3865 LyX doesn't restrict your use since you may be editing locally and exporting
3874 \begin_layout Subsection
3878 \begin_layout Standard
3879 Select which bullet depth you want to change then select the bullet shape
3881 Any changes will not be visible in LyX, but are visible when viewing the
3885 \begin_layout Standard
3886 You can reset a bullet shape to the default simply by clicking your right
3887 mouse button on the appropriate bullet depth button.
3891 \begin_layout Plain Layout
3896 want to have multiple sets of paragraphs with different sets of bullets
3897 in each, then you're going to have to get your hands dirty with ERT.
3898 The bullet selection dialog can help though because it provides you with
3899 the LaTeX code for a wide range of bullet shapes.
3900 To make your own custom paragraphs you have the following options:
3903 \begin_layout Plain Layout
3907 \begin_layout Plain Layout
3923 \begin_layout Plain Layout
3927 \begin_layout Plain Layout
3949 \begin_layout Itemize
3950 Use the LaTeX command
3951 \begin_inset Flex CharStyle:Code
3954 \begin_layout Plain Layout
3962 to specify a new bullet shape for a given depth.
3963 You'll also need to save the current bullet shape so you can restore it
3965 In this itemized list the following LaTeX code was used to change the bullet
3966 used for the first depth.
3970 \begin_layout LyX-Code
3980 \begin_layout LyX-Code
3997 \begin_layout Itemize
3998 Note that the itemize depth is specified in Roman numerals as part of the
4008 \begin_layout Itemize
4012 \begin_layout Plain Layout
4025 Specify each individual entry by starting each item with the bullet shape
4026 enclosed in square brackets and set as
4027 \begin_inset Flex CharStyle:MenuItem
4030 \begin_layout Plain Layout
4037 For example, this item was started with
4038 \begin_inset Flex CharStyle:Code
4041 \begin_layout Plain Layout
4056 \begin_layout Plain Layout
4060 \begin_layout Plain Layout
4076 \begin_layout Plain Layout
4077 You'll also need to revert the labelitem back to its previous setting for
4078 the global bullet shape settings to remain in effect.
4079 The way used here was:
4082 \begin_layout LyX-Code
4097 \begin_layout Chapter
4101 \begin_layout Section
4105 \begin_layout Standard
4106 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4107 and retrieve information about the LyX internal state.
4108 This is only intended for advanced users, but they should find it useful.
4109 It is by writing to the LyX server, for example, that bibliography managers,
4110 such as JabRef, are able to
4111 \begin_inset Quotes eld
4115 \begin_inset Quotes erd
4121 \begin_layout Standard
4122 Please note that, at present,
4124 the server does not work on Windows
4130 \begin_layout Plain Layout
4131 There is no reason it cannot do so.
4132 But none of the developers on Windows® have yet implemented this functionality
4141 \begin_layout Section
4142 Starting the LyX Server
4145 \begin_layout Standard
4146 The LyX server works through the use of a pair of named pipes.
4147 These are usually located in
4148 \begin_inset Flex CharStyle:Code
4151 \begin_layout Plain Layout
4158 \begin_inset Quotes eld
4162 \begin_inset Flex CharStyle:Code
4165 \begin_layout Plain Layout
4172 \begin_inset Quotes erd
4176 \begin_inset Quotes eld
4180 \begin_inset Flex CharStyle:Code
4183 \begin_layout Plain Layout
4190 \begin_inset Quotes erd
4194 External programs write into
4195 \begin_inset Flex CharStyle:Code
4198 \begin_layout Plain Layout
4204 and read back data from
4205 \begin_inset Flex CharStyle:Code
4208 \begin_layout Plain Layout
4215 The stem of the pipe names can be defined in the
4216 \begin_inset Flex CharStyle:MenuItem
4219 \begin_layout Plain Layout
4224 ools\SpecialChar \menuseparator
4235 \begin_inset Flex CharStyle:Code
4238 \begin_layout Plain Layout
4239 "/home/myhome/lyxpipe"
4249 configure this manually in order for the server to start.
4252 \begin_layout Standard
4254 \begin_inset Flex CharStyle:Code
4257 \begin_layout Plain Layout
4264 \begin_inset Flex CharStyle:Code
4267 \begin_layout Plain Layout
4273 ' to create the pipes.
4274 If one of the pipes already exists, LyX will assume that another LyX process
4275 is already running and will not start the server.
4276 This means that if LyX crashes, or if for some other reason, a
4277 \begin_inset Quotes eld
4281 \begin_inset Quotes erd
4284 pipe is left in existence when LyX closes, then LyX will not start the
4286 (This is bug 641.) You will need to delete the pipes manually and then restart
4290 \begin_layout Standard
4291 To have several LyX processes with servers at the same time, you have to
4292 use different configurations, perhaps by using separate user directories,
4294 \begin_inset Flex CharStyle:Code
4297 \begin_layout Plain Layout
4303 file, for each process.
4306 \begin_layout Standard
4307 If you are developing a client program, you might find it useful to enable
4308 debugging information from the LyX server.
4309 Do this by starting LyX as
4310 \begin_inset Flex CharStyle:Code
4313 \begin_layout Plain Layout
4322 \begin_layout Standard
4323 Other than this, there are a few points to consider:
4326 \begin_layout Itemize
4327 Both server and clients must run on UNIX or OS/2 machines.
4328 Communications between LyX on UNIX and clients on OS/2 or vice versa is
4329 not possible right now.
4332 \begin_layout Itemize
4333 On OS/2, only one client can connect to LyXServer at a time.
4336 \begin_layout Itemize
4337 On OS/2, clients must open the input pipe with
4338 \begin_inset Flex CharStyle:Code
4341 \begin_layout Plain Layout
4350 \begin_layout Standard
4351 You can find a complete example client written in C in the source distribution
4353 \begin_inset Flex CharStyle:Code
4356 \begin_layout Plain Layout
4357 development/lyxserver/server_monitor.c
4365 \begin_layout Section
4366 Normal communication
4369 \begin_layout Standard
4370 To issue a LyX call, the client writes a line of ASCII text into the input
4372 This line has the following format:
4389 \begin_layout Description
4390 clientname is a name that the client can choose arbitrarily.
4391 Its only use is that LyX will echo it if it sends an answer---so a client
4392 can dispatch results from different requesters.
4395 \begin_layout Description
4396 function is the function you want LyX to perform.
4397 It is the same as the commands you'd use in the minibuffer.
4400 \begin_layout Description
4401 argument is an optional argument which is meaningful only to some functions
4403 \begin_inset Quotes eld
4407 \begin_inset Quotes erd
4410 LFUN will insert the argument as text at the cursor position).
4413 \begin_layout Standard
4414 The answer from LyX will arrive in the output pipe and be of the form
4431 \begin_layout Standard
4440 are just echoed from the command request, while
4444 is more or less useful information filled according to how the command
4445 execution worked out.
4446 Some commands, such as
4447 \begin_inset Quotes eld
4451 \begin_inset Quotes erd
4454 , will return information about the internal state of LyX, while other will
4455 return an empty data-response.
4456 This means that the command execution went fine.
4459 \begin_layout Standard
4460 In case of errors, the response from LyX will have this form
4477 \begin_layout Standard
4482 should contain an explanation of why the command failed.
4485 \begin_layout Standard
4489 \begin_layout LyX-Code
4490 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4493 \begin_layout LyX-Code
4494 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4495 \begin_inset Newline newline
4498 read a <~/.lyxpipe.out
4499 \begin_inset Newline newline
4505 \begin_layout Section
4509 \begin_layout Standard
4510 LyX can notify clients of events going on asynchronously.
4511 Currently it will only do this if the user binds a key sequence with the
4513 \begin_inset Quotes eld
4517 \begin_inset Quotes erd
4521 The format of the string LyX sends is as follows:
4525 \begin_inset Flex CharStyle:Code
4528 \begin_layout Plain Layout
4539 \begin_layout Standard
4544 is the printed representation of the key sequence that was actually typed
4548 \begin_layout Standard
4549 This mechanism can be used to extend LyX's command set and implement macros.
4550 Bind some key sequence to
4551 \begin_inset Quotes eld
4555 \begin_inset Quotes erd
4559 Then start a client that listens on the output pipe, dispatches the command
4560 according to the sequence, and starts a function that may use LyX calls
4561 and LyX requests to issue a command or a series of commands to LyX.
4564 \begin_layout Section
4565 The simple LyX Server Protocol
4568 \begin_layout Standard
4569 LyX implements a simple protocol that can be used for session management.
4570 All messages are of the form
4583 \begin_layout Standard
4589 \begin_inset Quotes eld
4593 \begin_inset Quotes erd
4597 \begin_inset Quotes eld
4601 \begin_inset Quotes erd
4606 \begin_inset Quotes eld
4610 \begin_inset Quotes erd
4613 is received from a client, LyX will report back to inform the client that
4614 it's listening to it's messages, while
4615 \begin_inset Quotes eld
4619 \begin_inset Quotes erd
4622 sent from LyX will inform clients that LyX is closing.
4625 \begin_layout Chapter
4626 Special Document Classes
4629 \begin_layout Section
4633 \begin_layout Standard
4636 David Johnson; updated by Richard Heck
4639 \begin_layout Standard
4640 \begin_inset VSpace bigskip
4646 \begin_layout Standard
4648 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4649 papers to be submitted to American Mathematical Society publications.
4650 The layouts are not tailored to a specific journal, but easily can be.
4651 You should refer to the AMS documentation for specific instructions for
4652 each journal (usually it will entail only changing a single line in the
4654 That documentation is available on the Web at
4655 \begin_inset Flex URL
4658 \begin_layout Plain Layout
4666 \begin_inset Flex URL
4669 \begin_layout Plain Layout
4671 ftp://ftp.ams.org/pub/tex/amslatex/
4677 These layouts are appropriate, and useful, for any mathematical writing.
4681 \begin_layout Standard
4682 There are two basic AMS LaTeX layouts:
4685 \begin_layout Itemize
4686 amsart: The standard AMS article format.
4689 \begin_layout Itemize
4690 amsbook: the standard AMS book (really, monograph) format.
4694 \begin_layout Standard
4695 The layouts themselves contain only the minimum necessary to use the AMS
4697 They do not, in particular, contain any of the `theorem' environments used
4698 for setting theorems, lemmas, and the like.
4699 These are contained, instead, in the
4700 \begin_inset Flex CharStyle:Code
4703 \begin_layout Plain Layout
4709 module, which is loaded by default when when you select one of the AMS
4711 (It can also be used with other classes and can be removed, if you would
4712 rather use something else.) Less commonly used environments are in the
4713 \begin_inset Flex CharStyle:Code
4716 \begin_layout Plain Layout
4717 Theorems (AMS-Extended)
4722 module, which must be loaded manually.
4725 \begin_layout Standard
4726 By default, theorems and the like are numbered consecutively throughout
4727 the document, but this may be modified by loading the module
4728 \begin_inset Flex CharStyle:Code
4731 \begin_layout Plain Layout
4732 Theorems (Order by Section)
4737 or, if you are using
4738 \begin_inset Flex CharStyle:Code
4741 \begin_layout Plain Layout
4748 \begin_inset Flex CharStyle:Code
4751 \begin_layout Plain Layout
4752 Theorems (Order by Chapter)
4758 These will number the results as
4759 \begin_inset Formula $n.m$
4762 , where the first number refers to the section (or chapter) and the second
4763 refers to the total number of results so far in that section (or chapter).
4764 Many environments are also available unnumbered.
4765 These are indicated by an asterisk at the end.
4766 If you happen to want
4770 unnumbered results, the the module
4771 \begin_inset Flex CharStyle:Code
4774 \begin_layout Plain Layout
4780 provides that option.
4783 \begin_layout Standard
4784 Note that these modules do not
4788 to be used with the AMS classes.
4789 It is perfectly possible to use the
4790 \begin_inset Flex CharStyle:Code
4793 \begin_layout Plain Layout
4799 module, and the others mentioned, with other classes, such as
4800 \begin_inset Flex CharStyle:Code
4803 \begin_layout Plain Layout
4810 \begin_inset Flex CharStyle:Code
4813 \begin_layout Plain Layout
4820 \begin_inset Flex CharStyle:Code
4823 \begin_layout Plain Layout
4832 \begin_layout Subsection
4833 What these layouts provide
4836 \begin_layout Standard
4837 There is a long list of included environments provided by these layouts.
4838 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
4839 variety of `theorem' environments.
4840 However, the AMS recommends the environments that are available in LyX.
4844 \begin_layout Standard
4845 The following environments---as well as the standard environments, such
4847 \begin_inset Flex CharStyle:Noun
4850 \begin_layout Plain Layout
4857 \begin_inset Flex CharStyle:Noun
4860 \begin_layout Plain Layout
4867 \begin_inset Flex CharStyle:Noun
4870 \begin_layout Plain Layout
4877 \begin_inset Flex CharStyle:Noun
4880 \begin_layout Plain Layout
4887 \begin_inset Flex CharStyle:Noun
4890 \begin_layout Plain Layout
4897 \begin_inset Flex CharStyle:Code
4900 \begin_layout Plain Layout
4907 \begin_inset Flex CharStyle:Code
4910 \begin_layout Plain Layout
4919 \begin_layout Description
4920 Address This should be the author's permanent address.
4923 \begin_layout Description
4925 \begin_inset space ~
4928 Address This should be the author's temporary address at the time of submission,
4929 if different from the Address.
4932 \begin_layout Description
4933 Email Author's e-mail address
4936 \begin_layout Description
4937 URL Author's Web address, if desired.
4940 \begin_layout Description
4941 Keywords Key words or phrases used to identify specific topics discussed
4945 \begin_layout Description
4946 Subjectclass These refer to the AMS Subject Classifications, published and
4949 Mathematical Reviews
4952 These are also available online at the AMS cites listed above.
4955 \begin_layout Description
4959 \begin_layout Description
4963 \begin_layout Description
4967 \begin_layout Standard
4968 The following environments are provided by both the
4969 \begin_inset Flex CharStyle:Code
4972 \begin_layout Plain Layout
4979 \begin_inset Flex CharStyle:Code
4982 \begin_layout Plain Layout
4988 modules, in the latter case in both starred (unnumbered) and unstarred
4989 (numbered) versions.
4990 These same environments are provided only in the starred versions by the
4992 \begin_inset Flex CharStyle:Code
4995 \begin_layout Plain Layout
5004 \begin_layout Theorem
5005 This is typically used for the statements of major results.
5009 \begin_layout Corollary*
5010 This is used for statements which follow fairly directly from previous statement
5012 Again, these can be major results.
5017 These are smaller results needed to prove other statements.
5020 \begin_layout Proposition
5021 These are less major results which (hopefully) add to the general theory
5025 \begin_layout Conjecture
5026 These are statements provided without justification, which the author does
5027 not know how to prove, but which seem to be true (to the author, at least).
5030 \begin_layout Definition*
5031 Guess what this is for.
5032 The font is different for this environment than for the previous ones.
5036 \begin_layout Example*
5037 Used for examples illustrating proven results.
5040 \begin_layout Problem
5041 It's not really known what this is for.
5042 You should figure it out.
5045 \begin_layout Exercise*
5046 Write a description for this one.
5049 \begin_layout Remark
5050 This environment is also a type of theorem, usually a lesser sort of observation.
5053 \begin_layout Claim*
5054 Often used in the course of giving a proof of a larger result.
5058 Generally, these are used to break up long arguments, using specific instances
5064 The numbering scheme for cases is on its own, not together with other numbered
5070 At the end of this environment, a QED symbol (usually a square, but it can
5071 vary with different styles) is placed.
5072 If you want to have other environments within this one---for example, Case
5073 environments---and have the QED symbol appear only after them, then the
5074 other environments need to be nested within the proof environment.
5077 Nesting Environments
5083 for information on nesting.
5086 \begin_layout Standard
5087 And these environments are provided by
5088 \begin_inset Flex CharStyle:Code
5091 \begin_layout Plain Layout
5092 Theorems (AMS-Extended)
5100 \begin_layout Criterion*
5101 A required condition.
5104 \begin_layout Algorithm*
5105 A general procedure to be used.
5108 \begin_layout Axiom*
5109 This is a property or statement taken as true within the system being discussed.
5112 \begin_layout Condition*
5113 Sometimes used to state a condition assumed within the present context of
5118 Similar to a Remark.
5121 \begin_layout Notation*
5122 Used for the explanation of, yes, notation.
5125 \begin_layout Summary
5126 Do we really need to tell you?
5129 \begin_layout Acknowledgement*
5133 \begin_layout Conclusion*
5134 Sometimes used at the end of a long train of argument.
5138 Used in a way similar to Proposition, though perhaps lower on the scale.
5141 \begin_layout Standard
5142 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
5144 They need to be available on your system in order to use these environments.
5147 \begin_layout Section
5151 \begin_layout Standard
5156 can be used to type letters according to German conventions.
5157 A template file is included in
5159 .../lyx/share/templates
5161 for you to use as a starting point.
5164 \begin_layout Section
5168 \begin_layout Standard
5173 provides an alternative to the standard
5178 It provides similar functionality, but you might prefer this layout with
5179 sans serif sections, headings, and more.
5182 \begin_layout Section
5186 \begin_layout Standard
5192 \begin_layout Subsection
5196 \begin_layout Standard
5197 This section describes how LyX can be used to write articles for submission
5198 to the scientific journal
5200 Astronomy and Astrophysics
5202 (www.edpsciences.fr/aa/
5203 \begin_inset Flex URL
5206 \begin_layout Plain Layout
5208 http://www.edpsciences.fr/aa/
5213 ) using Version 5.01 of the document class
5218 This package can be downloaded from the ftp site
5221 \begin_layout Standard
5222 \begin_inset VSpace medskip
5228 \begin_layout Standard
5230 \begin_inset Flex URL
5233 \begin_layout Plain Layout
5235 ftp://ftp.edpsciences.org/pub/aa/readme.html
5243 \begin_layout Standard
5244 \begin_inset VSpace medskip
5250 \begin_layout Standard
5251 A manual comes together with that package, and this text is not meant to
5252 replace the original manual but merely a short guide how to realize the
5253 correct form of your paper.
5257 \begin_layout Standard
5258 Please note that the publisher of the journal was changed from Springer
5259 to EDP Sciences starting January 1, 2001.
5260 That change implicated also some slight changes of the style files, namely
5261 the removal of the thesaurus command.
5262 The LyX class aa supports the newest version of these style files, V 5.01.
5263 If you have an older version installed, please upgrade.
5264 For compatibility, the old (version 4) layout has been kept as
5269 Please refer to the comments in
5271 LyXDir/layouts/aapaper.layout
5276 \begin_layout Subsection
5280 \begin_layout Standard
5281 It is recommended you start from the example template distributed with LyX.
5282 If you are not using a template, note the following settings:
5285 \begin_layout Itemize
5295 ocument\SpecialChar \menuseparator
5302 dialog (OK, that one was obvious).
5305 \begin_layout Itemize
5306 Don't change the option
5309 \begin_inset space ~
5319 The whole layout is done by the macros, you shouldn't change anything.
5322 \begin_layout Subsection
5326 \begin_layout Standard
5327 First thing to enter is the header information.
5328 It consists of seven entries, of which some are optional.
5332 \begin_layout Itemize
5340 \begin_layout Itemize
5348 \begin_layout Itemize
5356 \begin_layout Itemize
5364 \begin_layout Itemize
5369 : [optional] if more than one author: whom to contact for offprint requests.
5372 \begin_layout Itemize
5377 : [optional] mail address for contacts.
5380 \begin_layout Itemize
5388 Received: <date>; Accepted <date>
5391 \begin_layout Standard
5392 There is no need to issue the
5398 command, this is done automatically by LyX when the header is finished.
5399 Although the order of the single header entries doesn't matter it is advised
5400 to keep the above sequence, just to get the best optics and meets the layout
5401 of the real document.
5404 \begin_layout Standard
5405 If you want to place footnotes in the header block, e.
5406 \begin_inset space \thinspace{}
5410 \begin_inset space ~
5413 to state your present address, just use the standard footnote via
5418 nsert\SpecialChar \menuseparator
5426 LyX will automagically use the term
5435 \begin_layout Standard
5436 In addition to these topics, the macros use three additional LaTeX commands
5437 that have no counterpart in LyX:
5440 \begin_layout Itemize
5447 to separate different names for more than one author and institute, respectivel
5451 \begin_layout Itemize
5458 to mark corresponding author/institute pairs.
5459 The institutes are numbered sequentially as they appear in the
5463 field, so you have to put a marker to each author.
5466 \begin_layout Itemize
5473 to supply an email address for fast contact.
5476 \begin_layout Standard
5477 In all cases, the appropriate command has to be entered in LyX and marked
5483 \begin_layout Subsection
5487 \begin_layout Standard
5488 The abstract should immediately follow the header block.
5489 With version 5 the abstract environment was changed to a command, and there
5490 is now a resctriction to only one paragraph.
5491 In addition, it should contain an entry with the keywords.
5492 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5499 by hand and mark it as LaTeX code.
5500 Refer to the example paper.
5503 \begin_layout Subsection
5504 Supported environments
5507 \begin_layout Standard
5508 The A&A paper layout supports the following environments for structuring
5512 \begin_layout Itemize
5518 \begin_layout Itemize
5524 \begin_layout Itemize
5530 \begin_layout Itemize
5536 \begin_layout Itemize
5542 \begin_layout Itemize
5548 \begin_layout Itemize
5554 \begin_layout Itemize
5560 \begin_layout Itemize
5566 \begin_layout Itemize
5572 \begin_layout Itemize
5578 \begin_layout Itemize
5584 \begin_layout Subsection
5585 Commands not supported by LyX
5588 \begin_layout Standard
5589 Some commands are not yet supported by the
5594 Some have already been mentioned.
5595 For the sake of completeness, they are listed all together here:
5598 \begin_layout Itemize
5606 \begin_layout Itemize
5614 \begin_layout Itemize
5622 \begin_layout Itemize
5630 \begin_layout Itemize
5638 \begin_layout Itemize
5646 \begin_layout Itemize
5654 \begin_layout Itemize
5662 \begin_layout Standard
5663 If you want to use any of these commands, you have to enter them yourself.
5666 Do not forget to mark them as LaTeX code!
5669 \begin_layout Subsection
5670 Figure and Table Floats
5673 \begin_layout Standard
5674 LyX provides support for the necessary float environments
5676 figure, figure*, table
5682 , therefore we won't tell much about it here.
5686 \begin_inset space ~
5692 Just remember that tables should be left-aligned.
5693 For that, select the table and change the alignment in
5698 dit\SpecialChar \menuseparator
5704 \begin_inset space ~
5710 \begin_layout Standard
5711 There is only one special thing: the figures with caption besides the figure.
5712 To create such a figure, you have to do the following:
5715 \begin_layout Enumerate
5716 Create a wide figure float:
5721 nsert\SpecialChar \menuseparator
5726 t\SpecialChar \menuseparator
5729 , then right click in the figure and select
5735 \begin_inset space ~
5743 \begin_layout Enumerate
5744 Enter your caption text.
5747 \begin_layout Enumerate
5752 to move the cursor above the caption.
5755 \begin_layout Enumerate
5759 \begin_layout Enumerate
5760 Position the cursor behind the figure and insert a horizontal fill:
5765 nsert\SpecialChar \menuseparator
5771 \begin_inset space ~
5776 \SpecialChar \menuseparator
5780 \begin_inset space ~
5788 \begin_layout Enumerate
5789 Switch to LaTeX mode:
5792 \begin_inset space ~
5800 \begin_layout Enumerate
5810 Do not close the brace!
5813 \begin_layout Enumerate
5814 Position the cursor behind the caption text, switch to LaTeX mode and insert
5818 \begin_inset space ~
5830 \begin_layout Standard
5831 Also, refer to the figures in the example paper.
5834 \begin_layout Subsection
5838 \begin_layout Standard
5839 For submission, the paper has to be formated in a special double-spacing
5841 For this purpose, you have to give the option
5845 to the documentclass.
5846 This must be done using the extra class options field in the
5851 ocument\SpecialChar \menuseparator
5859 Just enter the string
5866 \begin_layout Subsection
5870 \begin_layout Standard
5875 directory contains an example paper written with LyX.
5876 It is the example paper from the original macro package, translated to
5878 Use it for inspiration, and compare the original LaTeX code with LyX way
5882 \begin_layout Section
5886 \begin_layout Standard
5892 \begin_layout Subsection
5896 \begin_layout Standard
5897 AASTeX is a set of macros produced by the American Astronomical Society
5898 to facilitate electronic manuscript submission to the three journals they
5899 publish: the Astrophysical Journal (including the Letters and Supplement),
5900 the Astronomical Journal, and the Publications of the Astronomical Society
5902 LyX has proven to be an excellent tool for generating these documents,
5903 especially given its equation, citation, and figure handling capabilities.
5904 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5905 is the version described here, or higher.
5906 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5907 incompatible with LyX.
5908 The AASTeX package may be downloaded from the AASTeX Web site
5911 \begin_layout Standard
5912 \begin_inset VSpace medskip
5918 \begin_layout Standard
5920 \begin_inset Flex URL
5923 \begin_layout Plain Layout
5925 http://www.journals.uchicago.edu/AAS/AASTeX
5933 \begin_layout Standard
5934 \begin_inset VSpace medskip
5940 \begin_layout Standard
5941 A complete user guide is contained in that package and you should familiarize
5942 yourself with it thoroughly before embarking on writing a paper in LyX.
5943 LyX will not reduce the need to figure out all the AASTeX commands, it
5944 will only reduce the drudgery of typing everything in.
5945 It is your responsibility to ensure that the final exported LaTeX document
5946 conforms completely to the requirements of the journal to which you are
5947 submitting your paper.
5950 \begin_layout Subsection
5951 Starting a New Paper
5954 \begin_layout Standard
5955 I strongly suggest that you start with the AASTeX template file.
5961 ile\SpecialChar \menuseparator
5971 , enter the new file name, then choose the
5976 This will show the most common fields found in a manuscript.
5977 Simply overwrite the existing text (including the brackets,
5981 ) with the correct information.
5982 Many of the AASTeX commands and environments can be implemented directly
5983 in LyX, but some cannot: most noticeably
5995 , which should stick out like a sore thumb if you actually just opened the
5997 For commands such as these, the LaTeX code must be entered directly and
5999 Such commands are referred to as ERT, or Evil Red Text.
6000 I tried to minimize the amount of ERT needed in an AASTeX document, but
6001 there is still a bit more required than any of us would like.
6004 \begin_layout Subsection
6005 Finishing Your Paper
6008 \begin_layout Standard
6009 When the paper is finished to your satisfaction and previews/prints correctly,
6011 \begin_inset Quotes eld
6015 \begin_inset Quotes erd
6018 actions which need to be done before you submit it to the journals.
6022 \begin_layout Enumerate
6023 Export your paper as a LaTeX file (
6028 ile\SpecialChar \menuseparator
6033 xport\SpecialChar \menuseparator
6044 \begin_layout Enumerate
6049 file with your favorite text editor
6053 \begin_layout Enumerate
6054 remove the comment lines before the
6063 \begin_layout Enumerate
6068 usepackage...{fontenc}
6070 line if it appears (usually just after
6085 \begin_layout Enumerate
6086 remove everything between (and including) the
6098 commands, except for any commands you specifically put into the LaTeX preamble
6099 (which should appear immediately after the
6100 \begin_inset Quotes eld
6103 User specified LaTeX commands
6104 \begin_inset Quotes erd
6115 \begin_layout Enumerate
6116 Run the resulting file through LaTeX to make sure it still processes correctly.
6119 \begin_layout Enumerate
6120 Reread the journal requirements to make sure your filenames and formats
6124 \begin_layout Enumerate
6128 \begin_layout Subsection
6129 Comments On Specific Commands
6132 \begin_layout Standard
6133 I will not describe the detailed usage of the individual AASTeX commands:
6134 the AASTeX User Guide (
6138 ) gives a good description of each.
6139 Thus it's probably easiest for me to go down the list as found in the guide
6140 and offer comments where necessary.
6141 So let's begin \SpecialChar \ldots{}
6145 \begin_layout Subsubsection
6146 Things that work as expected
6149 \begin_layout Standard
6153 \begin_layout Plain Layout
6165 \begin_layout Standard
6166 Because they work as you might expect, I simply list them and the section
6267 begin{thebibliography}
6275 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6276 graphicx figure commands (2.14.1),
6300 (2.15.4, amongst other places),
6327 \begin_layout Standard
6328 The following style options also work correctly:
6349 Simply put them in the
6355 Layout\SpecialChar \menuseparator
6361 \begin_layout Standard
6365 \begin_layout Plain Layout
6377 \begin_layout Subsubsection
6378 Things that work, but require more comment
6381 \begin_layout Standard
6382 The following items work, but require a little more discussion:
6385 \begin_layout Itemize
6386 These items are reserved for use by the journal editors, but you can put
6387 them into the LaTeX preamble if you feel compelled to do so:
6420 \begin_layout Itemize
6421 These items may be placed in the LaTeX preamble, and are included as blanks
6422 in the template file:
6443 \begin_layout Itemize
6450 (2.3) -- can only be used
6451 \begin_inset Quotes eld
6455 \begin_inset Quotes erd
6458 , not in the middle of a paragraph.
6459 Use ERT if you need to embed it.
6462 \begin_layout Itemize
6469 (2.3) -- will have extra {} after it.
6470 This should not cause an error.
6473 \begin_layout Itemize
6480 (2.6) -- can only be used
6481 \begin_inset Quotes eld
6485 \begin_inset Quotes erd
6488 , not in the middle of a paragraph.
6489 Use ERT if you need to embed it.
6492 \begin_layout Itemize
6499 (2.8) -- can't insert a cross-reference tag, you must type the tag name
6503 \begin_layout Itemize
6510 (2.8) -- same as for
6517 \begin_layout Itemize
6524 (2.9) -- will have extra {} after it.
6525 This should not cause an error.
6528 \begin_layout Itemize
6535 (2.11) -- will have extra {} after it.
6536 This should not cause an error.
6539 \begin_layout Itemize
6546 (2.14.2) -- you can insert an optional filename argument by placing the cursor
6547 at the beginning of the text and selecting
6549 Insert\SpecialChar \menuseparator
6554 \begin_inset Quotes eld
6558 \begin_inset Quotes erd
6561 inserts an optional argument of the type needed by
6568 Hopefully it will be renamed someday.
6571 \begin_layout Itemize
6584 for the catalog ID optional parameter
6587 \begin_layout Itemize
6600 for the catalog ID optional parameter
6603 \begin_layout Subsubsection
6604 Things not implemented, use ERT
6607 \begin_layout Standard
6611 \begin_layout Plain Layout
6623 \begin_layout Standard
6646 setcounter{equation}
6648 (2.12), Journal name abbreviations (2.13.4),
6684 (2.15.4, insert it as the first element in the lefthand cell after where
6686 Don't use any of LyX's rules in the table),
6698 (2.15.5), much of Misc (2.17, except
6749 \begin_layout Standard
6753 \begin_layout Plain Layout
6765 \begin_layout Subsubsection
6766 Things that cannot be implemented
6769 \begin_layout Standard
6770 \SpecialChar \ldots{}
6771 at least in any meaningful sort of way, so I suggest ignoring them.
6772 They are the references environment (2.13.3), and the deluxetable environment
6774 If you really, really need to use deluxetable, I suggest editing it in
6775 a separate file with a text editor, then using
6780 nsert\SpecialChar \menuseparator
6786 \begin_inset space ~
6791 to include it in your LyX document.
6796 file to see an example of this.
6799 \begin_layout Subsection
6800 FAQs, Tips, Tricks, and Other Ruminations
6803 \begin_layout Subsubsection
6804 Getting LyX and AASTeX to cooperate
6807 \begin_layout Standard
6808 It can be a bit tricky to get LyX to recognize a new layout and document
6810 When all else fails, do this:
6813 \begin_layout Enumerate
6814 Make certain that LaTeX can find AASTeX.
6815 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6816 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6823 \begin_layout Enumerate
6835 \begin_layout Enumerate
6841 ools\SpecialChar \menuseparator
6848 in LyX, then restart LyX.
6851 \begin_layout Enumerate
6852 Open a regular new file, not from a template.
6853 Does AASTeX appear in the class list in
6858 ocument\SpecialChar \menuseparator
6868 \begin_layout Standard
6869 If you get a warning from an existing AASTeX document about not being able
6870 to find the AASTeX layout or a message about
6871 \begin_inset Quotes eld
6874 You should not mix title layouts with normal ones
6875 \begin_inset Quotes erd
6878 , things haven't been installed correctly.
6881 \begin_layout Subsubsection
6882 LaTeX error processing a table
6885 \begin_layout Standard
6886 LyX, by default, attempts to center the table caption/title.
6887 This seems to produce a bad interaction in AASTeX so you should click somewhere
6888 in the caption/title, then select
6893 dit\SpecialChar \menuseparator
6899 \begin_inset space ~
6916 This took care of it for me.
6919 \begin_layout Subsubsection
6923 \begin_layout Standard
6924 A couple of things: 1) I have noticed some funny spacing in the reference
6925 entries in the text.
6926 When you enter the bibliography item data, make sure their is
6930 space between the last author and the parenthesis setting off the year;
6934 \begin_inset space \thinspace{}
6938 \begin_inset space ~
6952 2) Entering the references at all is not obvious.
6953 The easiest thing is to start typing your first reference at the end of
6954 the document, then mark it as type
6959 That will put a small gray box in front of what you just typed.
6960 Click on the box to fill in the rest of the information.
6961 For new references, go to the end of an existing reference and press return.
6962 That will create a new line with its own box, etc.
6965 \begin_layout Subsubsection
6969 \begin_layout Standard
6970 Even though AASTeX provides its own figure commands (
6976 , for example), I much prefer LaTeX's standard figure commands (with the
6985 \begin_inset space ~
6988 commands as ERT into a Figure Float box if you desire, but I never have
6989 much luck getting the layout right.
6990 With the standard graphics, LyX will insert a
6994 usepackage{graphicx}
6996 command into the LaTeX preamble and handle the figures in the standard
6997 LaTeX2e way, interspersing the figures in the text.
6998 I believe ApJ accepts figures exactly this way now; AJ might still use
7000 \begin_inset Quotes eld
7003 stack everything at the end
7004 \begin_inset Quotes erd
7010 \begin_layout Subsubsection
7011 Things I could have done, but didn't
7014 \begin_layout Standard
7016 \begin_inset Quotes eld
7020 \begin_inset Quotes erd
7023 things I could have implemented, but chose not to.
7024 For instance, I saw no point in double-spacing the text in the LyX window,
7025 even though it is double-spaced in the paper manuscript.
7026 Also, I chose not to make separate layouts for the preprint and preprint2
7028 Since I assume you will spend most of your time in the plain manuscript
7029 mode anyway, I decided not to chew up more disk space with this.
7033 \begin_layout Subsection
7037 \begin_layout Standard
7038 Your mileage may vary.
7039 I've now had papers published by both ApJ and AJ that have had 98% of the
7040 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7042 I have had no trouble with the submission process, and I'm sure the journals
7043 were never aware that there might be a difference.
7044 So, go forth and publish!
7047 \begin_layout Section
7051 \begin_layout Standard
7054 Panayotis Papasotiriou
7057 \begin_layout Subsection
7061 \begin_layout Standard
7062 The ijmpc package is a set of macros that facilitates electronic manuscript
7065 International Journal of Modern Physics C
7068 Similarly, the ijmpd package is for creating manuscripts to be submitted
7071 International Journal of Modern Physics D
7074 Both journals are published by World Scientific.
7075 The corresponding document classes are named
7084 These files, together with instructions for the authors, can be downloaded
7086 \begin_inset Flex URL
7089 \begin_layout Plain Layout
7091 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
7097 \begin_inset Flex URL
7100 \begin_layout Plain Layout
7102 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
7108 Both packages are modified versions of the standard
7109 \begin_inset Quotes eld
7113 \begin_inset Quotes erd
7116 package, and they are almost (but not exactly) identical.
7117 Most of their features are supported by LyX.
7118 I have used LyX successfully to write articles submitted to both journals
7119 without any problem.
7122 \begin_layout Subsection
7126 \begin_layout Standard
7127 As usual, the easiest way to write a paper is to start with a template.
7133 ile\SpecialChar \menuseparator
7152 This will give an (almost) empty document that includes the most common
7153 fields found in a manuscript.
7154 Simply overwrite the existing text (including the brackets,
7159 You should keep in mind the following remarks.
7162 \begin_layout Enumerate
7163 LyX won't let you change the font size and the page style of the document,
7164 because such modifications are not allowed by both packages.
7167 \begin_layout Enumerate
7168 The language of the document should not be changed.
7169 Before previewing your paper, be sure that the babel package is not used.
7170 To do this, click on
7175 ools\SpecialChar \menuseparator
7193 checkbox in the language settings, and click on
7204 , if you wish to make this change permanent).
7207 \begin_layout Enumerate
7209 \begin_inset Quotes eld
7213 \begin_inset Quotes erd
7216 style must be used to define keywords.
7219 \begin_layout Enumerate
7220 The ijmpc package provides a style named
7221 \begin_inset Quotes eld
7224 Classification Codes
7225 \begin_inset Quotes erd
7228 , which can be used to define classification codes, such as PACS numbers.
7229 Note that this facility is not supported by the ijmpd package.
7232 \begin_layout Enumerate
7233 Several new environments are available:
7234 \begin_inset Quotes eld
7238 \begin_inset Quotes erd
7242 \begin_inset Quotes eld
7246 \begin_inset Quotes erd
7250 \begin_inset Quotes eld
7254 \begin_inset Quotes erd
7258 \begin_inset Quotes eld
7262 \begin_inset Quotes erd
7266 \begin_inset Quotes eld
7270 \begin_inset Quotes erd
7274 \begin_inset Quotes eld
7278 \begin_inset Quotes erd
7282 \begin_inset Quotes eld
7286 \begin_inset Quotes erd
7290 \begin_inset Quotes eld
7294 \begin_inset Quotes erd
7298 \begin_inset Quotes eld
7302 \begin_inset Quotes erd
7306 \begin_inset Quotes eld
7310 \begin_inset Quotes erd
7314 \begin_inset Quotes eld
7318 \begin_inset Quotes erd
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 \begin_inset Quotes eld
7334 \begin_inset Quotes erd
7338 \begin_inset Quotes eld
7342 \begin_inset Quotes erd
7346 Their use is more or less obvious.
7347 LyX supports all these environments; it will use the proper label, text
7348 style, and numbering scheme for each of them.
7351 \begin_layout Enumerate
7352 Both packages use basic citations; the natbib package should not be used.
7353 In LyX, citation references are shown as usual; in the output, citations
7354 are shown as superscripts.
7355 If you want to use a citation as normal text, you should use the
7360 \begin_inset space \thinspace{}
7364 \begin_inset Quotes eld
7368 \begin_inset space ~
7378 \begin_inset Quotes erd
7384 \begin_layout Enumerate
7386 \begin_inset Quotes eld
7390 \begin_inset Quotes erd
7393 section in both packages.
7394 To put acknowledgments, just use the
7395 \begin_inset Quotes eld
7399 \begin_inset Quotes erd
7405 \begin_layout Enumerate
7406 Appendices may be added to the paper,
7410 the Acknowledgments and
7415 LyX provides a special environment, called
7416 \begin_inset Quotes eld
7420 \begin_inset Quotes erd
7423 which marks the beginning of the appendices.
7424 This environment should be left blank; it just sends a LaTeX command, but
7425 nothing is really printed.
7427 \begin_inset Quotes eld
7431 \begin_inset Quotes erd
7434 is printed with blue letters, as a signal that all sections after that
7435 point are appendices.
7436 To write an appendix, use the
7437 \begin_inset Quotes eld
7441 \begin_inset Quotes erd
7445 LyX will number each appendix with capital letters, as required by both
7448 \begin_inset Quotes eld
7452 \begin_inset Quotes erd
7459 be present before the first appendix; if not, all appendices will be numbered
7460 as normal sections in the output.
7463 \begin_layout Enumerate
7464 The ijmpc and the ijmpd packages use the
7468 command to implement table captions.
7469 As a result, a table created by LyX is printed correctly, but its caption
7471 However, you can use some ERT to overpass this problem, so that captions
7472 are printed as expected.
7473 To do so, create a float table as usual, remove the caption, and replace
7484 (sic); you must also the ERT
7488 immediately after the tabular material.
7489 Study the example table included in the template files to see how this
7490 trick is implemented.
7491 Alternatively, If you need table captions, you should implement the whole
7496 file, then include this file to the LyX document (
7501 nsert\SpecialChar \menuseparator
7506 \SpecialChar \menuseparator
7512 \begin_inset space ~
7518 Details on how to create a table float can be found in the files
7526 , included in the corresponding packages.
7529 \begin_layout Subsection
7530 Preparing a paper for submission
7533 \begin_layout Standard
7534 Before you submit your paper you must export the LyX document as a LaTeX
7540 ile\SpecialChar \menuseparator
7545 xport\SpecialChar \menuseparator
7560 \begin_layout Plain Layout
7561 Actually you have the choice between LaTeX (plain) and pdflatex.
7562 If you intend to use pdflatex to prepare the paper, you should use the
7563 pdflatex option so that included graphics are converted to PDF format,
7564 ready for use by pdflatex.
7569 , then make the following changes to the resulting
7576 \begin_layout Enumerate
7577 Remove the comment lines before the
7586 \begin_layout Enumerate
7587 Remove everything between (and including) the
7599 commands, except for any commands you specifically put into the LaTeX preamble.
7602 \begin_layout Standard
7607 file should be saved and processed through LaTeX as many times as necessary.
7608 You may also want to check the resulting
7615 \begin_layout Subsection
7619 \begin_layout Standard
7620 The use of ERT is reduced to two commands, which must be placed at the top
7622 If you started writing your paper by using the
7630 template, the ERT needed is already in its place; you usually don't need
7632 You may only modify the first ERT to specify the information printed to
7633 the top of odd and even pages (authors' names and short paper's title,
7635 This ERT must have the form
7639 markboth{Authors' Names}{Short Paper's Title}
7644 \begin_layout Section
7648 \begin_layout Standard
7654 \begin_layout Subsection
7658 \begin_layout Standard
7659 The iopart package provides a document class to create electronic manuscript
7660 submission to the journals published by the Institute of Physics.
7661 Instructions for the authors how to create a paper using the iopart class
7662 can be downloaded together with the iopart package from the site
7663 \begin_inset Flex URL
7666 \begin_layout Plain Layout
7668 ftp://ftp.iop.org/pub/journals/latex2e
7676 \begin_layout Subsection
7680 \begin_layout Standard
7681 The easiest way to write a paper is to start with the file
7685 that is available in LyX's examples files folder.
7686 Open this file, save it under a new name, and start writing.
7687 The example file explains how to use the special text environments.
7688 Here are the most important advices:
7691 \begin_layout Itemize
7692 To be able to compile your document to a PDF, PS, or DVI, assure that the
7695 Use AMS math package
7697 in the document settings under
7704 \begin_layout Itemize
7707 The title environment defines the kind of your paper.
7708 So use one of the following environments for the title:
7712 \begin_layout Itemize
7721 \begin_layout Itemize
7730 \begin_layout Itemize
7736 for a Topical review
7739 \begin_layout Itemize
7748 \begin_layout Itemize
7757 \begin_layout Itemize
7763 for a Paper (same as Title)
7766 \begin_layout Itemize
7772 for a Preliminary communication
7775 \begin_layout Itemize
7781 for a Rapid communication
7784 \begin_layout Itemize
7790 for a Letter to the editor
7794 \begin_layout Itemize
7797 All title environments except of
7801 can have an optional short title.
7804 \begin_layout Itemize
7805 There is a general title environment
7809 which is not directly supported by the LyX.
7810 This can be used as ERT when your document doesn't fit into one of the
7814 \begin_layout Standard
7815 For more informations like hints for special table and formula formatting,
7816 look at the IOP author guidelines.
7819 \begin_layout Section
7823 \begin_layout Standard
7826 Panayotis Papasotiriou
7829 \begin_layout Subsection
7833 \begin_layout Standard
7834 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7835 that facilitates electronic manuscript submission to the journals they
7837 Most known of them (at least in my domain of interest) are
7839 Astrophysics and Space Science
7845 , but there are many others (see a complete list at
7846 \begin_inset Flex URL
7849 \begin_layout Plain Layout
7851 http://www.wkap.nl/jrnllist.htm/JRNLHOME
7857 The Kluwer package may be downloaded from the site
7858 \begin_inset Flex URL
7861 \begin_layout Plain Layout
7863 http://www.wkap.nl/kaphtml.htm/STYLEFILES
7869 A complete user guide is contained in that package (but it can also be
7870 downloaded separately).
7873 \begin_layout Standard
7874 LyX supports many features of the package but not everything.
7875 However, the ERT needed is reduced to some
7876 \begin_inset Quotes eld
7880 \begin_inset Quotes erd
7883 commands of the package (see
7884 \begin_inset space ~
7888 \begin_inset CommandInset ref
7890 reference "subsec:kluwer_peculiarities"
7895 I have recently used LyX to write an article submitted to the
7897 Astrophysics and Space Science
7899 without any problem.
7902 \begin_layout Subsection
7906 \begin_layout Standard
7907 The easiest way to write a paper is to start with the Kluwer template file.
7910 File\SpecialChar \menuseparator
7925 This will give an (almost) empty document that includes the most common
7926 fields found in a manuscript and a short description of their use.
7927 As in most templates, simply overwrite the existing text (including the
7932 ) with the correct information.
7935 \begin_layout Subsection
7936 Preparing a paper for submission
7939 \begin_layout Standard
7940 As in the AASTeX package, before you submit your paper to a journal you
7942 \begin_inset Quotes eld
7946 \begin_inset Quotes erd
7952 \begin_layout Enumerate
7953 Export your paper as a LaTeX file.
7954 To do this, click on
7959 ile\SpecialChar \menuseparator
7964 xport\SpecialChar \menuseparator
7975 \begin_layout Enumerate
7980 file with a text editor and make the following changes
7984 \begin_layout Enumerate
7985 remove the comment lines before the
7994 \begin_layout Enumerate
7995 remove everything between (and including) the
8007 commands, except for any commands you specifically put into the LaTeX preamble.
8010 \begin_layout Standard
8019 \begin_layout Enumerate
8024 file through LaTeX as many times as necessary (usually up to three).
8027 \begin_layout Enumerate
8033 \begin_inset space \thinspace{}
8040 , and check if everything is OK (it should, if you didn't make any mistake).
8043 \begin_layout Subsection
8044 \begin_inset Quotes eld
8048 \begin_inset Quotes erd
8051 of the Kluwer package
8052 \begin_inset CommandInset label
8054 name "subsec:kluwer_peculiarities"
8061 \begin_layout Standard
8062 The Kluwer package has the following
8063 \begin_inset Quotes eld
8067 \begin_inset Quotes erd
8073 \begin_layout Enumerate
8074 It is possible to write multiple articles in the same LaTeX file
8078 \begin_layout Plain Layout
8079 I can't imagine any good reason to do this.
8085 Each article must be included in the environment
8086 \begin_inset Quotes eld
8090 \begin_inset Quotes erd
8094 Unfortunately, this environment cannot be omitted, even if you write just
8096 Therefore, each article starts with the command
8102 and, obviously, ends with the command
8109 Although this can be implemented in LyX, I didn't included it, since it
8110 looks ugly and can confuse the novice user.
8111 Therefore, you need to enter them directly and mark them as LaTeX code
8113 \begin_inset Quotes eld
8117 \begin_inset Quotes erd
8123 \begin_layout Enumerate
8124 Information given at the beginning of the article (i.e., title, subtitle,
8125 author, institution, running title, running author, abstract and keywords)
8126 must be included in an environment called
8127 \begin_inset Quotes eld
8131 \begin_inset Quotes erd
8135 This is not implemented in LyX, so you must enter title, subtitle etc.
8136 \begin_inset space ~
8139 between two ERT lines (
8154 \begin_layout Enumerate
8155 According to the user manual, the label of each bibliography item must be
8179 \begin_layout Standard
8184 template takes care of all these
8185 \begin_inset Quotes eld
8189 \begin_inset Quotes erd
8193 If you start a new paper using this template you don't need to do anything
8198 \begin_layout Enumerate
8199 don't delete the ERT included in the template, and
8202 \begin_layout Enumerate
8203 copy the example bibliography item included in the template and modify it
8204 as necessary to enter new bibliography items.
8207 \begin_layout Section
8211 \begin_layout Standard
8217 \begin_layout Subsection
8221 \begin_layout Standard
8222 The LyX document classes
8224 article (koma-script)
8228 report (koma-script)
8246 correspond to the LaTeX document classes
8263 \begin_inset space ~
8266 of the Koma-Script family.
8267 They are replacements for the standard document classes
8283 , resp., and fit better to European typography conventions in a number of
8287 \begin_layout Itemize
8288 Standard character size is 11pt in
8290 article (koma-script)
8294 report (koma-script)
8302 letter (koma-script)
8307 \begin_layout Itemize
8308 Headings, labels of the description environment, and a number of elements
8311 letter (koma-script)
8313 document class are set in a bold sans serif font.
8317 \begin_layout Plain Layout
8318 There is a big difference between the bold sans serif old cm fonts and new
8319 ec fonts, especially in the appearance of headings.
8320 In comparison, the ec bold sans serif fonts look a bit thin.
8321 Here the LaTeX package
8329 helps to produce the
8330 \begin_inset Quotes eld
8334 \begin_inset Quotes erd
8337 appearance when using the ec fonts.
8342 The numbering of chapter headings is made in the same way as the numbering
8343 of section headings, that is without the extra line
8344 \begin_inset Quotes eld
8347 Chapter\SpecialChar \ldots{}
8349 \begin_inset Quotes erd
8353 In addition, the appearance of the headings can be modified by using a
8354 number of options (in LyX to be entered in the field
8361 \begin_inset space ~
8371 ayout\SpecialChar \menuseparator
8379 A detailed German description of these options can be found in the Koma-Script
8387 \begin_layout Itemize
8388 The main means in the Koma-Script document classes to design the type area
8397 (in LyX to be entered in the extra class options field in the dialog
8402 ocument\SpecialChar \menuseparator
8410 They make a clearer modification of page margins possible as do the options
8416 ocument\SpecialChar \menuseparator
8424 A detailed German description of these and other type area options can
8425 be found in the Koma-Script documentation
8432 \begin_layout Itemize
8433 The LaTeX document classes of the Koma-Script family define a number of
8434 additional commands.
8435 Those part of it which makes sense in LyX is implemented in corresponding
8439 \begin_layout Standard
8440 A detailed German description of the LaTeX document classes of the Koma-Script
8441 family can be found in the Koma-Script documentation
8449 \begin_layout Plain Layout
8450 There is an English translation
8454 , but it is not a complete one.
8459 The following sections describe only those aspects, which are relevant
8463 \begin_layout Subsection
8464 article (koma-script), report (koma-script), and book (koma-script)
8467 \begin_layout Standard
8468 The document classes
8470 article (koma-script)
8474 report (koma-script)
8484 are implemented in the layout files
8497 They contain all the paragraph types of the corresponding standard document
8510 , resp., partly modified, with the exception of the LyX specific
8514 -type, which is replaced by the new
8518 -type having the same functionality.
8523 -Type there is a number of new paragraph types added.
8530 letter (koma-script)
8535 \begin_layout Itemize
8544 : are equivalents to
8552 , resp., additionally inserting an entry in the table of contents.
8561 are not contained in
8563 article (koma-script)
8568 \begin_layout Itemize
8585 , resp., additionally clearing running heads.
8592 article (koma-script)
8598 \begin_layout Plain Layout
8611 report (koma-script)
8613 , but since this is identical to
8617 , is has not been implemented in LyX.
8625 \begin_layout Itemize
8630 : generates a heading directly above the following paragraph in the standard
8631 character size without affecting the structure of the document.
8634 \begin_layout Itemize
8643 are special captions which respect the different space settings needed
8644 for captions placed above or below an element (if you follow strict typographic
8645 rules, you might want to place table captions always above the table).
8646 You can also use the class option
8663 You need at least Koma-Script version 2.8q to use this.
8666 \begin_layout Itemize
8671 : can be used to set a bonmot, e.
8672 \begin_inset space \thinspace{}
8676 \begin_inset space ~
8679 at the beginning of a chapter.
8680 If you use the optional argument (
8685 nsert\SpecialChar \menuseparator
8687 \begin_inset space ~
8692 ), you can insert the dictum's author there.
8693 Dictum and author are separated by a line.
8694 You need at least Koma-Script version 2.8q to use this.
8701 article (koma-script)
8706 \begin_layout Standard
8707 The following types, together with the standard types
8719 , form the title area of the document.
8720 They must be entered ahead of the first
8721 \begin_inset Quotes eld
8725 \begin_inset Quotes erd
8732 \begin_layout Plain Layout
8733 The corresponding LaTeX commands must appear before the
8744 When such a type is used more than once, the latter usage overwrites the
8745 former one, that means, for every type only the latest usage is valid.
8746 The order of the different types however has, like
8758 , no effect on the appearance of the produced document.
8761 \begin_layout Itemize
8766 : produces a centered paragraph above the ordinary title (
8778 ) for the subject of the document.
8781 \begin_layout Itemize
8786 : produces a centered paragraph below the ordinary title (
8798 ) for the publishers' name.
8801 \begin_layout Itemize
8808 report (koma-script)
8814 produces a centered paragraph on its own page behind the title page, or
8817 article (koma-script)
8819 produces a centered paragraph below the ordinary title (
8838 \begin_layout Itemize
8843 : produces a left aligned paragraph above the ordinary title (
8859 ) for a document`s head.
8862 \begin_layout Itemize
8867 : produces in a double-sided print in
8869 report (koma-script)
8875 a left-aligned paragraph at the top of the title page`s back or has no
8876 effect in a single-sided print or in
8878 article (koma-script)
8883 \begin_layout Itemize
8888 : produces in a double-sided print in
8890 report (koma-script)
8896 a left-aligned paragraph at the bottom of the title page`s back or has
8897 no effect in a single-sided print or in
8899 article (koma-script)
8904 \begin_layout Itemize
8909 : produces a special
8910 \begin_inset Quotes eld
8914 \begin_inset Quotes erd
8917 page ahead of the actual document containing a paragraph without special
8921 \begin_layout Standard
8922 The layout files for the document classes
8924 article (koma-script)
8928 report (koma-script)
8939 This is thought of as a place to define your own types.
8944 in your personal layout directory and edit the file!
8947 \begin_layout Subsection
8948 letter (koma-script)
8951 \begin_layout Standard
8955 \begin_layout Plain Layout
8967 \begin_layout Standard
8971 letter (koma-script)
8973 is implemented in the layout file
8978 It contains all the paragraph types of the corresponding standard document
8983 , partly modified, with the exception of the LyX specific types
8995 type, which is replaced by the new
9000 In addition, it contains, in contrast to the standard document class, the
9018 Furthermore, there are a number of new letter specific types.
9021 \begin_layout Standard
9025 \begin_layout Plain Layout
9037 \begin_layout Standard
9038 The appearance of the letter produced by this document class can be controlled
9039 by a number of LaTeX commands, which you can put in the LaTeX preamble.
9043 \begin_layout Plain Layout
9044 For example, the standard appearance of the letter`s heading, consisting
9045 of name and address, is quite self-willed.
9047 \begin_inset Quotes eld
9051 \begin_inset Quotes erd
9054 heading is produced by the following LaTeX commands in the preamble:
9057 \begin_layout LyX-Code
9067 \begin_layout LyX-Code
9083 \begin_layout LyX-Code
9093 \begin_layout LyX-Code
9113 A detailed German description of such LaTeX commands can be found in the
9114 Koma-Script documentation
9119 With it, the letter's author can produce his personal letter layout.
9122 \begin_layout Standard
9131 define the beginning of the letter and must be used in every letter.
9132 To emphasize them in the LyX document class, they are marked with the letter
9142 \begin_inset space ~
9146 It is possible to write any number of letters in one file.
9151 type produces a new letter using the same addressee and a
9155 type produces a new addressee.
9172 are ordinary paragraph types and can also be used several times in one
9173 and the same letter.
9176 \begin_layout Itemize
9181 : produces a paragraph for the addressee and implicitly defines the beginning
9185 \begin_layout Itemize
9190 : produces a paragraph for the form of address and implicitly produces a
9194 \begin_layout Itemize
9199 : produces a paragraph for a close.
9202 \begin_layout Itemize
9207 : produces a paragraph for a postscript.
9210 \begin_layout Itemize
9215 : produces a paragraph for a distribution list.
9218 \begin_layout Itemize
9223 : produces a paragraph for enclosures.
9226 \begin_layout Standard
9267 are input types provided with a label to enter information, which will
9268 be processed by the document class.
9272 \begin_layout Plain Layout
9273 It could be seen as a matter of inconsequence, that the types
9281 described above are not such input types as well.
9282 Because of the special meaning of those types, however, I have implemented
9283 them as ordinary paragraph types with a one letter mark in the left margin.
9284 Moreover, it would affect my feeling of symmetry, if the
9292 type had such a serious different appearance.
9297 The types must be used ahead of the corresponding
9304 \begin_layout Standard
9305 An implementation of these types in a WYSIWYG fashion does not seem to make
9306 sense, because the real appearance of the produced letter does not only
9307 depend on the usage of the particular type, but also on other factors.
9308 For example, a signature entered in the
9312 type will in the standard behavior appear in the produced letter only,
9313 when in the same letter also a
9318 The entered value of the
9322 type will in the standard behavior not appear in the produced letter at
9324 The possibility to design the letter`s heading freely is already indicated
9325 in a footnote above.
9328 \begin_layout Standard
9329 The input types can also be used as empty paragraphs.
9331 \begin_inset space \thinspace{}
9335 \begin_inset space ~
9347 type is not used at all, in the standard behavior the value of the
9351 type is used as signature, whereas if an empty
9355 type is used, no signature value is defined.
9358 \begin_layout Standard
9359 By using the input types it is possible to write a letter template, containing
9360 filled input types with your personal dates (name, address, etc.) and empty
9361 input types for other dates you want to enter.
9364 \begin_layout Itemize
9369 : sender's name, in the standard behavior appears as a centered paragraph
9370 in small caps in the letter`s heading.
9373 \begin_layout Itemize
9378 : sender's signature, in the standard behavior appears below the
9387 type is used, the value of the
9391 type appears instead.
9394 \begin_layout Itemize
9399 : sender's address, in the standard behavior appears in a centered paragraph
9400 in the letter`s heading below the sender's name.
9403 \begin_layout Itemize
9408 : sender's telephone number, in the standard behavior only sets the LaTeX
9418 \begin_layout Itemize
9423 : place of the letter`s making.
9426 \begin_layout Itemize
9431 : date of the letter`s making.
9440 , in the standard behavior, produce the place and the date in a right-aligned
9441 line below the addressee's field.
9446 type is used, neither place nor date appear, independent of the value of
9456 type is used, the date of the letter `s production is used.
9459 \begin_layout Itemize
9464 : sender`s back address, in the standard behavior appears above the addressee's
9465 field in a small sans serif font.
9468 \begin_layout Itemize
9473 : special mail information, in the standard behavior appears underlined
9474 above the addressee's field below the back address.
9477 \begin_layout Itemize
9482 : additional information, in the standard behavior appears on right side
9483 below the addressee`s field.
9486 \begin_layout Itemize
9491 : the letter's title, in the standard behavior appears in a big, bold, sans
9492 serif font above the subject.
9495 \begin_layout Itemize
9500 : the letter's subject, in the standard behavior appears in a bold font
9508 \begin_layout Standard
9529 produce a business letter like line above the
9533 line containing the fields
9534 \begin_inset Quotes eld
9538 \begin_inset Quotes erd
9542 \begin_inset Quotes eld
9546 \begin_inset Quotes erd
9550 \begin_inset Quotes eld
9554 \begin_inset Quotes erd
9558 \begin_inset Quotes eld
9562 \begin_inset Quotes erd
9566 \begin_inset Quotes eld
9570 \begin_inset Quotes erd
9574 \begin_inset Quotes eld
9578 \begin_inset Quotes erd
9582 For the date field, the value of the
9588 \begin_inset Quotes eld
9591 business letter types
9592 \begin_inset Quotes erd
9595 is used, the value of the
9599 type however does not appear, but only the LaTeX variable
9606 The ordinary output of place and date in a right-aligned line below the
9607 addressee`s field is suppressed.
9608 The types are implemented as input types provided with a label and must
9609 be used ahead of the corresponding
9616 \begin_layout Itemize
9624 \begin_layout Itemize
9632 \begin_layout Itemize
9640 \begin_layout Itemize
9648 \begin_layout Itemize
9656 \begin_layout Subsection
9657 The new letter class: letter (koma-script v.2)
9660 \begin_layout Standard
9663 Jürgen Spitzmüller
9666 \begin_layout Standard
9667 \begin_inset VSpace medskip
9673 \begin_layout Standard
9675 Koma-Script version 2.8 has introduced a new letter class
9679 which supersedes the now unsupported
9684 It has --- on the LaTeX side --- a completely new interface and is not
9685 compatible with the old class.
9686 Therefore, LyX supports both, though it is recommended to use the new class.
9689 \begin_layout Standard
9690 This class covers the same functionality as
9692 letter (koma-script),
9699 (receiver's address, same as
9716 will start a new letter (i.
9717 \begin_inset space \thinspace{}
9721 \begin_inset space ~
9724 you can write several letters per document).
9725 New elements are sender's
9741 and the possibility to use a
9750 nsert\SpecialChar \menuseparator
9760 \begin_layout Standard
9761 The biggest improvement is, though, that the letter's layout is configurable
9762 at almost any needs.
9763 This can be done via the preamble or with a special style file (Letter
9764 Class Option, extension
9768 ), that will be read in as a class option.
9772 \begin_layout Plain Layout
9773 The KOMA package comes with some default
9778 There is, for instance, a
9782 file that follows german typesetting rules, or a
9786 that provides the default layout of the old
9791 The latter can be loaded with the class option
9800 ayout\SpecialChar \menuseparator
9805 ocument\SpecialChar \menuseparator
9817 template that is included in LyX for examples.
9818 A detailed description is to be found in the Koma-Script documentation
9826 \begin_layout Subsection
9830 \begin_layout Standard
9831 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9835 \begin_layout Itemize
9836 The chapter number of a
9840 type appears on a line of its own above the chapter heading instead of
9841 appearing in the same line ahead of it.
9842 The cause for that is the LyX internal behavior for the labeltype
9849 \begin_layout Itemize
9850 The headings of the types
9859 \begin_inset Quotes eld
9863 \begin_inset Quotes erd
9866 LaTeX table of contents, but not in the LyX table of contents (
9871 ocument\SpecialChar \menuseparator
9877 \begin_inset space ~
9881 \begin_inset space ~
9889 \begin_layout Itemize
9894 document class appear in a skip separation mode, not indented.
9895 This is the standard behavior, no special LaTeX commands are needed for
9902 ocument\SpecialChar \menuseparator
9909 dialog the corresponding radio button indicates
9925 value always has the effect that extra LaTeX commands are inserted in the
9926 document to produce the gap, which is not what is wanted in this case.
9929 \begin_layout Section
9937 \begin_layout Standard
9943 \begin_layout Subsection
9947 \begin_layout Standard
9948 These are the layout files for some of the journal formats used by Springer
9949 Verlag and listed on
9950 \begin_inset Flex URL
9953 \begin_layout Plain Layout
9955 http://www.springer.de/author/tex/help-journals.html
9960 , where you should also go to fetch the class files (yes, these are LaTeX2e
9962 It is a modular system: the things common to all journals are implemented
9967 , which journal-specific layout files (such as, e.
9968 \begin_inset space \thinspace{}
9975 for Journal of Geodesy) can include.
9978 \begin_layout Standard
9979 This means that implementing support for any other Springer journal on this
9980 list is as simple as writing your own
9988 file following the outline given in
9996 \begin_layout Standard
9997 It is reasonably well tested only for the Journal of Geodesy.
10006 come with the standard LyX distribution.
10007 Install the relevant class file (downloaded from Springer) in a proper
10008 directory, reconfigure LaTeX (in the teTeX case by running
10012 , as root if necessary --- doesn't LyX take care of this?), reconfigure
10013 LyX and it should work.
10016 \begin_layout Subsection
10020 \begin_layout Standard
10021 A large number of theorem-like styles ---
10027 \SpecialChar \ldots{}
10033 \begin_layout Standard
10036 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
10037 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
10040 See the Springer class file documentation for details.
10043 \begin_layout Subsection
10047 \begin_layout Itemize
10059 \begin_layout Itemize
10062 Probability Theory and Related Fields
10068 --- Jean-Marc Lasgouttes
10071 \begin_layout Standard
10072 Add your own, it isn't so hard!
10075 \begin_layout Subsection
10079 \begin_layout Standard
10080 These files are partly based on the older
10084 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
10085 file from Springer.
10090 layout, are now defunct.
10091 Jean-Marc Lasgouttes helped out big in making me find my way around the
10092 LyX layout file mechanism.
10095 \begin_layout Subsection
10099 \begin_layout Standard
10101 But probably less than in the old hacked-LaTeX
10108 \begin_layout Standard
10110 \begin_inset space \thinspace{}
10113 g.: does not display the number for theorem-like layouts, just #.
10116 \begin_layout Section
10124 \begin_layout Standard
10130 \begin_layout Subsection
10134 \begin_layout Standard
10135 These are the layout files for some of the journals of the American Geophysical
10137 It is assumed that you have both the AGU's own class files and AGUplus
10138 installed (everything to be found at
10139 \begin_inset Flex URL
10142 \begin_layout Plain Layout
10144 ftp://ftp.agu.org/journals/latex/journals
10152 \begin_layout Subsection
10156 \begin_layout Standard
10166 They are still called this in the LyX GUI, though their LaTeX equivalents
10167 in the AGU classes are
10178 \begin_layout Standard
10179 Newly defined styles are
10216 These are mostly manuscript attributes and defined in the AGU class documentati
10220 \begin_layout Standard
10221 I suspect this is still badly incomplete.
10224 \begin_layout Subsection
10228 \begin_layout Standard
10245 \begin_layout Subsection
10249 \begin_layout Itemize
10252 Journal of Geophysical Research
10261 \begin_layout Standard
10262 Add your own, it isn't so hard! Look at the
10273 \begin_layout Subsection
10274 Bugs and things to remember
10277 \begin_layout Standard
10278 In order to use the new layouts, you must remember to do the following for
10282 \begin_layout Enumerate
10288 This can be done in the
10290 layout\SpecialChar \menuseparator
10295 document\SpecialChar \menuseparator
10299 (AGU articles are always in English, right? So
10303 choose a language.)
10306 \begin_layout Enumerate
10311 into the document's
10316 (Yes, this is a bug.)
10319 \begin_layout Enumerate
10320 Make sure you use the
10324 bibliography style, by entering
10328 into the second field of the BibTeX inset.
10329 None of the standard styles will do.
10332 \begin_layout Section
10340 \begin_layout Standard
10346 \begin_layout Subsection
10350 \begin_layout Standard
10351 This is the layout file for the European Geophysical Society journals.
10356 can be downloaded from the web site of the EGS under
10357 \begin_inset Flex URL
10360 \begin_layout Plain Layout
10370 \begin_layout Subsection
10374 \begin_layout Standard
10377 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10385 The current layout file is unfortunately very unmodular and would benefit
10386 from using the various
10393 \begin_layout Section
10399 \begin_inset CommandInset label
10408 \begin_layout Standard
10416 \begin_layout Subsection
10420 \begin_layout Standard
10421 This section describes how to use LyX to make slides for overhead projectors.
10422 There are two document classes that can do this: the default slides class
10428 This section documents the former.
10431 \begin_layout Standard
10432 I'm going to say this again, nice and clear, so that there's no misunderstanding
10436 \begin_layout Standard
10437 \begin_inset VSpace bigskip
10443 \begin_layout Standard
10447 This section documents the class
10448 \begin_inset Quotes eld
10456 \begin_inset Quotes erd
10464 \begin_layout Standard
10465 \begin_inset VSpace bigskip
10471 \begin_layout Standard
10472 If you're looking for the documentation for
10473 \begin_inset Quotes eld
10481 \begin_inset Quotes erd
10484 , check out section
10485 \begin_inset space ~
10489 \begin_inset CommandInset ref
10491 reference "sec:foiltex"
10501 \begin_inset Quotes eld
10509 \begin_inset Quotes erd
10512 ] is actually somewhat better than the default
10520 \begin_layout Plain Layout
10521 \SpecialChar \ldots{}
10522 or so I've been told repeatedly by its advocates.
10523 Having never used it, I have no idea if this claim is true or not.
10528 which this section documents.
10531 \begin_layout Standard
10532 This class is the LaTeX2e improvement of the old
10537 Every LaTeX2e distribution includes this class [which I'll just refer to
10539 \begin_inset Quotes eld
10547 \begin_inset Quotes erd
10550 from now on], so you're bound to have it.
10551 As I noted earlier, there are other classes, such as
10555 , which also produce slides for overhead projectors and do a better job
10557 However, there are some things which
10561 can do which the others can't, such as generate overlays.
10562 Read on to learn more!
10565 \begin_layout Subsection
10567 \begin_inset CommandInset label
10569 name "sec:slidesetup"
10576 \begin_layout Standard
10577 Obviously, to use this document class, you need to select
10578 \begin_inset Quotes eld
10586 \begin_inset Quotes erd
10589 from the class list in the
10594 ocument\SpecialChar \menuseparator
10602 There are some other special things you should know about this class:
10605 \begin_layout Itemize
10606 Don't bother changing the options
10611 They're not supported by the
10618 \begin_layout Itemize
10625 \begin_inset space ~
10630 behaves a bit differently for this class.
10631 The possible choices and what they do are as follows:
10635 \begin_layout Description
10640 The final output contains page numbers in the lower right corner.
10643 \begin_layout Description
10652 , but also prints out any time markers you've put in.
10653 This is the default.
10656 \begin_layout Description
10661 The final output contains no page numbers, time markers, or alignment markers.
10665 \begin_layout Itemize
10670 class has an extra option:
10676 \begin_inset Quotes eld
10684 \begin_inset Quotes erd
10687 in the extra class options.
10691 \begin_layout Standard
10692 Using this options allows you to add time markers to
10698 \begin_inset space ~
10702 \begin_inset CommandInset ref
10704 reference "sec:slideNote"
10712 \begin_layout Standard
10713 You can also use the template file
10714 \begin_inset Quotes eld
10722 \begin_inset Quotes erd
10725 to automatically set up a document to use the
10734 ile\SpecialChar \menuseparator
10736 \begin_inset space ~
10740 \begin_inset space ~
10749 to open your new document].
10750 The template file also contains some examples of the special paragraph
10751 environments used by this class.
10752 I'll describe those next.
10755 \begin_layout Subsection
10756 Paragraph Environments
10759 \begin_layout Subsubsection
10760 Supported Environments
10763 \begin_layout Standard
10764 The first thing you'll notice when you start up a new
10768 document is the font size and type: it's the equivalent of the size
10769 \begin_inset Quotes eld
10777 \begin_inset Quotes erd
10783 \begin_inset space ~
10789 This is also what's used in the output.
10791 \begin_inset Quotes eld
10795 \begin_inset Quotes erd
10798 to remind you that this is a slide.
10799 Your final slides will use a larger font; ergo, you'll have less space.
10800 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10803 \begin_layout Standard
10804 The next thing that becomes obvious is the changes to the paragraph environment
10805 pull-down box [at the far-left end of the toolbar].
10806 Most of the paragraph environments you're used to seeing are missing.
10807 There are also five new ones.
10812 class itself only supports certain paragraph environments:
10815 \begin_layout Itemize
10821 \begin_layout Itemize
10827 \begin_layout Itemize
10833 \begin_layout Itemize
10839 \begin_layout Itemize
10845 \begin_layout Itemize
10851 \begin_layout Itemize
10857 \begin_layout Itemize
10863 \begin_layout Itemize
10869 \begin_layout Itemize
10875 \begin_layout Itemize
10881 \begin_layout Standard
10882 All of the other standard environments, including the section-heading environmen
10883 ts, aren't used in the
10890 \begin_layout Standard
10891 On the other hand, you'll notice the following new environments:
10894 \begin_layout Itemize
10900 \begin_layout Itemize
10906 \begin_layout Itemize
10912 \begin_layout Itemize
10918 \begin_layout Itemize
10924 \begin_layout Standard
10925 These five are kind of quirky, due to a
10926 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10934 You see, LyX doesn't permit you to nest any other paragraph environment
10935 into an empty environment.
10936 Now, that's fine and dandy, but it means that you wouldn't be able to start
10937 a slide with anything except plain text.
10938 To deal with this, I've performed a little
10939 \begin_inset Quotes eld
10943 \begin_inset Quotes erd
10949 \begin_layout Subsubsection
10950 Quirks of the New Environments
10951 \begin_inset CommandInset label
10953 name "sec:slideQuirk"
10960 \begin_layout Standard
10961 All five of the new paragraph environments are somewhat quirky due to inherent
10962 limitiations in the current version of LyX.
10963 As I just mentioned, LyX forbids environments that begin with another environme
10965 To get around this, the
10969 environment isn't a paragraph environment as described in the
10977 \begin_layout Standard
10978 You should consider
10991 \begin_inset Quotes eld
10994 pseudo-environments.
10995 \begin_inset Quotes erd
10998 They look like a section heading or a
10999 \begin_inset Quotes eld
11007 \begin_inset Quotes erd
11010 but really begin a [and, if necessary, end the previous] paragraph environment.
11020 \begin_inset Quotes eld
11024 \begin_inset Quotes erd
11027 These two perform some action.
11030 \begin_layout Standard
11031 A common feature of all five environments,
11051 , is a rather long-ish label.
11052 The text following this label --- ordinarily the contents of the paragraph
11053 environment --- is utterly irrelevant for
11074 LyX completely ignores it.
11075 In fact, you can leave these five environments completely empty.
11079 \begin_layout Standard
11084 to put any text after the rather long-ish label, you might want to.
11085 This could be a short description of the contents of the
11090 In that case, enter in your descriptive comment and hit
11094 as you normally would.
11097 \begin_layout Standard
11098 If, on the other hand, you don't want to enter in any descriptive text,
11099 you'll hit another LyX quirk.
11100 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
11101 environment until you put something in the old one.
11105 \begin_layout Itemize
11106 Start entering the text that will
11134 \begin_layout Itemize
11135 Now move to the beginning of that paragraph.
11139 \begin_layout Itemize
11148 \begin_layout Itemize
11149 Finally, change this new, empty paragraph to a
11173 \begin_layout Standard
11174 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
11178 \begin_layout Subsection
11179 Making a Presentation with
11192 \begin_layout Subsubsection
11200 \begin_layout Standard
11201 If you're expecting this section to teach you how to actually make a presentatio
11202 n, you'll be sorely disappointed.
11203 Naturally, I'll describe all of the ways the
11207 class can assist you in preparing the materials for a presentation.
11208 Filling in the contents, however, is up to you.
11213 the LyX philosophy.]
11216 \begin_layout Standard
11221 environment [in the manner described in section
11222 \begin_inset space ~
11226 \begin_inset CommandInset ref
11228 reference "sec:slideQuirk"
11232 ] tells LyX to begin a new slide [duh].
11233 The label for this environment/
11234 \begin_inset Quotes erd
11238 \begin_inset Quotes erd
11242 \begin_inset Quotes eld
11246 \begin_inset Quotes erd
11249 in cool blue, followed by the label,
11250 \begin_inset Quotes eld
11254 \begin_inset Quotes erd
11258 Any text or paragraph environments that follow this one go on the new slide.
11262 \begin_layout Standard
11263 Slides are probably the only time you'll need to forcibly end pages in LyX
11264 (this can be specified in the
11269 In fact, you'll want to, once you finish entering the contents of one slide.
11270 If you've entered more text than can physically fit on a slide, the extra
11271 overflows onto a new slide.
11272 I don't recommend doing this, however, since the overflow slide won't have
11273 any page number on it.
11274 Furthermore, it may interfere with any
11278 you've made to accompany the oversized
11285 \begin_layout Standard
11294 environments work the same way as the
11299 They both create an
11300 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11307 followed by a label [
11308 \begin_inset Quotes eld
11312 \begin_inset Quotes erd
11316 \begin_inset Quotes eld
11320 \begin_inset Quotes erd
11324 The color is a stunning magenta instead of blue, and the
11325 \begin_inset Quotes eld
11329 \begin_inset Quotes erd
11332 will look different, in style and in length.
11333 The label fonts of all three also differ from one another.
11336 \begin_layout Standard
11341 , if the contents of a
11349 exceed the physical size of a slide or sheet of paper, the extra will overflow
11351 Again, you should avoid this.
11352 It defeats the whole purpose of
11363 \begin_layout Subsubsection
11373 \begin_layout Standard
11378 is a slide that sits atop another slide.
11379 Perhaps you wish to discuss a figure on the main
11383 before displaying the text associated with it.
11384 One way to accomplish this is tape a flap of dark paper over the part of
11389 you want to display later.
11390 This method fails, however, if you wish to overlap one graph with another,
11392 You would then have to fumble while speaking to align the two separate,
11397 s to align the two graphs.
11402 environment in both cases makes life much easier.
11405 \begin_layout Standard
11410 receives the page number of its
11411 \begin_inset Quotes eld
11415 \begin_inset Quotes erd
11423 \begin_inset Quotes eld
11431 \begin_inset Quotes erd
11438 \begin_layout Plain Layout
11439 Presumably, mutliple
11444 \begin_inset Quotes eld
11452 \begin_inset Quotes erd
11456 \begin_inset Quotes eld
11464 \begin_inset Quotes erd
11468 \begin_inset Quotes eld
11476 \begin_inset Quotes erd
11480 \begin_inset space ~
11483 appended to the page number of the parent
11493 Clearly, you want the contents of both the
11501 to each fit on a single physical slide! You should probably consider an
11507 \begin_inset Quotes eld
11511 \begin_inset Quotes erd
11523 class provides a visual cue for this: the label at the start of an
11527 is shorter than that at the start of a
11532 Lastly, when you generate printable output, you'll find alignment markers
11533 in all four corners of both the
11537 page and its parent
11542 These will assist you in lining up the two physical slides.
11545 \begin_layout Standard
11546 The major problem in overlaying two slides is aligning the contents of the
11547 two transparencies.
11548 How much space should you leave for that graph on the second slide? Worse
11549 still, what if you want a graph and a sentence on second slide, but there
11550 is text on the main transparency that goes in between them? You could try
11551 and insert vertical space of the right size.
11552 The better way is to use
11563 \begin_layout Standard
11564 As their names imply,
11572 are two command-like paragraph environments that make all subsequent text
11573 invisible and visible, respectively.
11575 \begin_inset space ~
11579 \begin_inset CommandInset ref
11581 reference "sec:slideQuirk"
11585 that you don't place anything
11589 these two environments, however.
11594 , it inserts a centered, sky-blue label into the page reading
11595 \begin_inset Quotes eld
11598 <Invisible Text Follows>
11599 \begin_inset Quotes erd
11603 For paragraphs following this label, the parts of the
11611 ; it doesn't matter which] where they would be contain instead blank space.
11615 \begin_layout Standard
11620 , the corresponding centered label is
11621 \begin_inset Quotes eld
11624 <Visible Text Follows>
11625 \begin_inset Quotes erd
11629 Paragraphs following this label behave normally.
11630 Note that the beginning of a new
11642 automatically shuts off an
11647 It's therefore not necessary to use
11658 \begin_layout Standard
11659 By now, it should be obvious how to create overlay transparencies using
11660 the proper combination of
11679 \begin_layout Enumerate
11684 , including everything that will appear on it, whether on the main slide
11692 \begin_layout Enumerate
11693 Before each figure or paragraph that will appear only on the
11702 If necessary, insert a
11706 environment after the
11713 \begin_layout Enumerate
11718 immediately following the
11725 \begin_layout Enumerate
11726 Copy the contents of this
11737 \begin_layout Enumerate
11742 , change all of the
11753 \begin_layout Standard
11755 You've just made an
11762 \begin_layout Standard
11763 There's one problem with the way I've designed the LyX
11767 class: you can't make text in the middle of a paragraph invisible, nor
11768 make text in the middle of an invisible paragraph visible again.
11769 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11773 \begin_layout Plain Layout
11774 The commands of interest are:
11777 \begin_layout Itemize
11782 invisible \SpecialChar \ldots{}
11786 \begin_layout Itemize
11791 visible \SpecialChar \ldots{}
11795 \begin_layout Plain Layout
11796 \SpecialChar \ldots{}
11797 and need to be marked as TeX.
11799 \begin_inset Quotes eld
11803 \begin_inset Quotes erd
11806 you wish to change goes in between the brackets [and after the
11819 If you don't know how to mark text as TeX, see the appropriate section
11832 \begin_layout Subsubsection
11842 \begin_inset CommandInset label
11844 name "sec:slideNote"
11851 \begin_layout Standard
11860 is associated with a
11861 \begin_inset Quotes eld
11865 \begin_inset Quotes erd
11877 class provides visual cues.
11882 is shorter than that of a
11886 [yet longer than that of an
11890 ] and, like the label of an
11894 is shockingly magenta.
11895 Additionally, the printed
11899 has the page number of its
11900 \begin_inset Quotes eld
11904 \begin_inset Quotes erd
11912 \begin_inset Quotes eld
11920 \begin_inset Quotes erd
11924 \begin_inset Quotes eld
11932 \begin_inset Quotes erd
11936 \begin_inset Quotes eld
11944 \begin_inset Quotes erd
11948 You can have multiple
11952 s associated with a single
11964 , you'll probably want to break up long
11968 s so that they fit on a single sheet of paper.
11971 \begin_layout Standard
11976 is obvious: it contains anything additional you might want to say about
11982 It could also be used as a sheet of reminders for a particular
11987 In the case of the latter, you might want to make use of time markers.
11993 \begin_inset Quotes eld
11997 \begin_inset Quotes erd
12000 support for time markers, a
12005 So, you'll have to resort to using the LaTeX codes.
12008 \begin_layout Standard
12009 To use time markers, you'll need to specify the extra class option
12010 \begin_inset Quotes eld
12018 \begin_inset Quotes erd
12022 \begin_inset space ~
12026 \begin_inset CommandInset ref
12028 reference "sec:slidesetup"
12033 This option turns on timing marks, which will appear in the lower-left-hand
12039 To set what appears in the time marker, you use the LaTeX commands
12040 \begin_inset Quotes eld
12050 \begin_inset Quotes erd
12054 \begin_inset Quotes eld
12064 \begin_inset Quotes erd
12068 The arguments of both commands are time measured in seconds.
12070 \begin_inset Quotes eld
12080 \begin_inset Quotes erd
12083 sets the time marker to a given time.
12085 \begin_inset Quotes eld
12095 \begin_inset Quotes erd
12098 increments the time marker by the specified amount.
12099 Using time markers and
12103 s in this fashion, you can remind yourself how much time to spend on a particula
12111 \begin_layout Standard
12112 There's one last feature to describe.
12113 Clearly, you'd like to print out all of your
12121 s on transparencies while printing all of your
12138 with which it is associated.
12139 What's a person to do?
12142 \begin_layout Standard
12143 Luckily, there are two LaTeX commands that allow you to select what to print
12145 Both must be placed into the preamble of your document.
12147 \begin_inset Quotes eld
12159 \begin_inset Quotes erd
12162 will cause the output to contain only the
12171 Correspondingly, the command
12172 \begin_inset Quotes eld
12184 \begin_inset Quotes erd
12187 prevents the output of anything but
12192 I'd advise placing both commands in the preamble and initially comment
12194 You can then preview your entire presentation as you write.
12195 When you're done writing, you can then uncomment one of the two to select
12196 what you want to print.
12197 I like to uncomment
12198 \begin_inset Quotes eld
12210 \begin_inset Quotes erd
12213 , print to a file with
12214 \begin_inset Quotes eld
12222 \begin_inset Quotes erd
12225 in its name, comment it back out, then uncomment
12226 \begin_inset Quotes eld
12238 \begin_inset Quotes erd
12242 \begin_inset Quotes eld
12250 \begin_inset Quotes erd
12254 I can then send either file to a printer, loading transparencies or plain
12255 paper as appropriate.
12258 \begin_layout Standard
12259 You can also provide other arguments to the
12260 \begin_inset Quotes eld
12270 \begin_inset Quotes erd
12274 \begin_inset Quotes eld
12284 \begin_inset Quotes erd
12288 See a good LaTeX book for details.
12291 \begin_layout Subsection
12296 Class Template File
12299 \begin_layout Standard
12300 I have also provided a template file,
12301 \begin_inset Quotes eld
12309 \begin_inset Quotes erd
12317 To use it, begin your new presentation with
12322 ile\SpecialChar \menuseparator
12324 \begin_inset space ~
12328 \begin_inset space ~
12338 Your new LyX presentation file will contain an example
12359 additionally contain an example of the use of
12368 Lastly, the preamble will contain:
12371 \begin_layout LyX-Code
12372 % Uncomment to print out only slides and overlays
12375 \begin_layout LyX-Code
12379 \begin_layout LyX-Code
12385 \begin_inset Newline newline
12391 \begin_layout LyX-Code
12392 % Uncomment to print out only notes
12395 \begin_layout LyX-Code
12399 \begin_layout LyX-Code
12407 \begin_layout Standard
12408 One final thing: I created this class to support the LaTeX2e
12409 \begin_inset Quotes eld
12417 \begin_inset Quotes erd
12420 class, one of the built-in LaTeX2e classes.
12421 Neither I nor the rest of the LyX Team endorse or oppose the use of this
12422 built-in slide class.
12423 It's here if you want it or need it.
12424 There exist other LaTeX2e classes for creating presentations, such as the
12430 \begin_inset space ~
12434 \begin_inset CommandInset ref
12436 reference "sec:foiltex"
12441 \begin_inset Quotes eld
12449 \begin_inset Quotes erd
12452 package [present on some TeX distributions].
12453 The latter is not yet supported under LyX.
12457 \begin_layout Plain Layout
12458 Perhaps you can take on the task\SpecialChar \ldots{}
12464 I know nothing about these other classes.
12465 Try them out to see what sort of alternative they provide.
12468 \begin_layout Section
12477 \begin_inset CommandInset label
12486 \begin_layout Standard
12492 \begin_layout Subsection
12496 \begin_layout Standard
12497 This section describes how to use LyX to make slides for overhead projectors.
12498 There are two document classes that can do this: the default slides class
12504 This section documents the latter.
12507 \begin_layout Standard
12508 I'm going to say this again, nice and clear, so that there's no misunderstanding
12512 \begin_layout Standard
12513 \begin_inset VSpace bigskip
12519 \begin_layout Standard
12523 This section documents the class
12524 \begin_inset Quotes eld
12532 \begin_inset Quotes erd
12540 \begin_layout Standard
12541 \begin_inset VSpace bigskip
12547 \begin_layout Standard
12548 If you're looking for the documentation for
12549 \begin_inset Quotes eld
12557 \begin_inset Quotes erd
12560 , check out section
12561 \begin_inset space ~
12565 \begin_inset CommandInset ref
12567 reference "sec:slitex"
12572 If your machine doesn't have the
12577 \begin_inset Quotes eld
12585 \begin_inset Quotes erd
12588 ] installed, you'll probably have to use the default
12592 class, which isn't quite as good as
12597 \begin_layout Standard
12602 class is designed for use with version 2.1 of the
12606 LaTeX class file which is now an integral part of LaTeX2e.
12609 \begin_layout Subsection
12613 \begin_layout Standard
12614 Obviously, to use this document class, you need to select
12615 \begin_inset Quotes eld
12623 \begin_inset Quotes erd
12636 \begin_inset space ~
12642 There are some settings in the
12645 \begin_inset space ~
12650 dialog that you should know about that are specific to this class:
12653 \begin_layout Itemize
12654 Don't change the options
12665 \begin_inset space ~
12671 They're ignored by the
12678 \begin_layout Itemize
12679 The default font size is 20pt with the other options being 17pt, 25pt and
12683 \begin_layout Itemize
12684 The default font is
12692 but all math equations are still typeset in the usual roman font.
12695 \begin_layout Itemize
12700 TeX supports A4 and Letter paper sizes as well as a special size for working
12702 It doesn't support A5, B5, legal or executive paper sizes.
12705 \begin_layout Itemize
12706 Don't bother changing the
12710 settings because they are ignored anyway.
12711 All floats appear where they are defined in the text.
12714 \begin_layout Itemize
12722 setting behaves a bit differently for this class.
12727 TeX provides extensive footer and header capabilities including a user-defined
12730 \begin_inset space ~
12734 \begin_inset CommandInset ref
12736 reference "sec:foilfoot"
12741 The title page is treated differently to all other pages in the document
12750 has the logo centered at the bottom of the page (if one is defined).
12751 The possible page style choices and what they do are as follows:
12755 \begin_layout Labeling
12756 \labelwidthstring MMMMMMM
12763 The final output contains no page numbers, or other headers or footers
12764 (except footnotes of course).
12768 \begin_layout Labeling
12769 \labelwidthstring MMMMMMM
12776 The final output contains page numbers centered at the bottom of the page.
12777 No other headings or footers (other than footnotes).
12780 \begin_layout Labeling
12781 \labelwidthstring MMMMMMM
12786 Page numbers in lower right corner.
12787 Additional headers and footers are also shown.
12788 This is also the default.
12791 \begin_layout Labeling
12792 \labelwidthstring MMMMMMM
12797 Gives you access to the
12801 package although its use with
12805 TeX is discouraged by the writer of the
12809 TeX package because of some potential page layout clashes.
12813 \begin_layout Subsubsection
12817 \begin_layout Standard
12818 The following options may be used in the extra class options in the
12823 ocument\SpecialChar \menuseparator
12833 \begin_layout Labeling
12834 \labelwidthstring MMMMMMx
12839 This sets up the page layout for 7.33in by 11in paper, which is about the
12840 same aspect ratio as a 35mm slide, making it a bit easier to work with
12844 \begin_layout Labeling
12845 \labelwidthstring MMMMMMx
12850 Places a rule across the page below the header on every page except the
12854 \begin_layout Labeling
12855 \labelwidthstring MMMMMMx
12860 Places a rule across the page above the footer on every page except the
12864 \begin_layout Labeling
12865 \labelwidthstring MMMMMMx
12870 This is automatically set each time you create a new
12879 TeX to use the dvips driver to rotate those pages that are set as landscape
12883 \begin_layout Labeling
12884 \labelwidthstring MMMMMMx
12889 Simply changes the page dimensions to those of a landscape page but doesn't
12891 Thus if you use this option you need to use an external program to rotate
12892 each page or feed your paper through your printer as landscape.
12893 Note that this option effectively reverses the roles of the
12901 environments (don't worry these are described in the next section).
12904 \begin_layout Labeling
12905 \labelwidthstring MMMMMMx
12910 Equation numbers on the left.
12913 \begin_layout Labeling
12914 \labelwidthstring MMMMMMx
12919 Flush-left equations.
12922 \begin_layout Subsection
12923 Supported Environments
12926 \begin_layout Standard
12927 Most of the environments commonly supported in other classes are also supported
12933 There are several additional environments provided by
12937 TeX as well as a couple added by LyX.
12938 The following environments are shared with other classes:
12941 \begin_layout Standard
12945 \begin_layout Plain Layout
12949 begin{multicols}{2}
12957 \begin_layout Itemize
12963 \begin_layout Itemize
12969 \begin_layout Itemize
12975 \begin_layout Itemize
12981 \begin_layout Itemize
12987 \begin_layout Itemize
12993 \begin_layout Itemize
12999 \begin_layout Itemize
13005 \begin_layout Itemize
13011 \begin_layout Itemize
13017 \begin_layout Itemize
13023 \begin_layout Itemize
13029 \begin_layout Itemize
13035 \begin_layout Itemize
13041 \begin_layout Itemize
13047 \begin_layout Itemize
13053 \begin_layout Itemize
13059 \begin_layout Itemize
13065 \begin_layout Standard
13069 \begin_layout Plain Layout
13081 \begin_layout Standard
13082 That is, all the major environments apart from the sectioning environments.
13083 Since foils are essentially self-contained sections, with a title and body,
13088 TeX provides specific commands for starting new foils and these are:
13091 \begin_layout Itemize
13097 \begin_layout Itemize
13103 \begin_layout Standard
13104 LyX also provides slightly modified versions of these two environments called:
13107 \begin_layout Itemize
13113 \begin_layout Itemize
13116 ShortRotatefoilhead
13119 \begin_layout Standard
13120 and the differences will be explained in the next section.
13123 \begin_layout Standard
13124 Since foils are often used in presenting ideas or new theorems and such
13129 TeX also provides a comprehensive box of goodies for presenting them:
13132 \begin_layout Standard
13136 \begin_layout Plain Layout
13140 begin{multicols}{2}
13148 \begin_layout Itemize
13154 \begin_layout Itemize
13160 \begin_layout Itemize
13166 \begin_layout Itemize
13172 \begin_layout Itemize
13178 \begin_layout Itemize
13184 \begin_layout Itemize
13190 \begin_layout Itemize
13196 \begin_layout Itemize
13202 \begin_layout Itemize
13208 \begin_layout Itemize
13214 \begin_layout Standard
13218 \begin_layout Plain Layout
13230 \begin_layout Standard
13231 The starred versions are unnumbered while the unstarred versions are numbered.
13232 There are also two list environments added by LyX and these are:
13235 \begin_layout Itemize
13241 \begin_layout Itemize
13247 \begin_layout Standard
13252 TeX provides some powerful header and footer capabilities that are best
13253 set in the preamble although they may be set at any point in a document.
13254 If you want to change these settings in your document the best place to
13255 do so is at the very top of a foil,
13260 straight after the foilhead.
13263 \begin_layout Standard
13264 For this purpose, the following command styles are provided [
13271 \begin_layout Standard
13275 \begin_layout Plain Layout
13279 begin{multicols}{2}
13287 \begin_layout Itemize
13291 \begin_inset space ~
13297 \begin_layout Itemize
13303 \begin_layout Itemize
13307 \begin_inset space ~
13313 \begin_layout Itemize
13317 \begin_inset space ~
13323 \begin_layout Itemize
13327 \begin_inset space ~
13334 \begin_layout Standard
13335 \begin_inset space ~
13342 \begin_layout Standard
13346 \begin_layout Plain Layout
13358 \begin_layout Standard
13359 There are also a few commands provided by
13363 TeX that aren't directly supported by LyX but I'll tell you what they do
13364 and how to use them in section
13365 \begin_inset space ~
13369 \begin_inset CommandInset ref
13371 reference "sec:unsuppfoils"
13378 \begin_layout Subsection
13379 Building a Set of Foils
13382 \begin_layout Standard
13383 This section will give a simple introduction to using the different environments
13384 to build a set of foils.
13385 If you want to see an example set of foils, take a look at the
13389 file you find in LyX's
13396 \begin_layout Subsubsection
13397 Give It a Title Page
13400 \begin_layout Standard
13401 Unlike other classes that provide
13421 creates the title on a page of its own.
13422 If you leave out the
13426 environment LaTeX will substitute the current date (every time you regenerate
13430 \begin_layout Subsubsection
13434 \begin_layout Standard
13435 As I mentioned earlier, there are four ways of starting a new foil.
13436 For portrait foils you should use
13445 The difference between these two environments is the amount of space between
13446 the title of the foil (the foilhead) and the body of the foil.
13449 \begin_layout Standard
13450 Landscape foils are generated using the
13456 ShortRotatefoilhead
13459 Again the only difference is the spacing between foilhead and body.
13460 Both of the short versions have 0.5 inches less separation between the foilhead
13465 \begin_layout Standard
13466 One problem with the support for landscape foils is the requirement that
13467 you have to use the
13471 driver to generate the PostScript output otherwise the foils won't be rotated.
13472 It is possible to get landscape foils even if you haven't got the
13476 driver provided you can feed your foils sideways through your printer ;-)
13479 \begin_layout Subsubsection
13480 Theorems, Lemmas, Proofs and more
13483 \begin_layout Standard
13484 Due to a small bug in LyX you can't have two of the same type of these environme
13485 nts directly following each other.
13486 They must be separated by something.
13487 If you try, you will just be extending the previous environment as if you
13488 had merged the two environments together.
13489 So, how do you get around this problem? The simplest option is to insert
13490 some text between the two environments or add a
13494 environment between the two with just a
13495 \begin_inset Quotes eld
13503 \begin_inset Quotes erd
13507 This will force LyX to produce two separate environments and hence the
13508 correct LaTeX output.
13509 An example is provided in the example file included with the LyX distribution.
13510 Remember, this problem only occurs if you are trying to place two of the
13511 same type of theorem-like environments one directly after the other.
13514 \begin_layout Subsubsection
13518 \begin_layout Standard
13519 You get all the commonly supported list styles found in other classes as
13520 well as two new ones.
13521 I'll only describe the new ones here.
13522 If you want to find out more about the other list environments check out
13528 If you intend to use itemized lists you might also want to read about the
13532 \begin_inset space ~
13536 \begin_inset space ~
13541 dialog described above in section
13542 \begin_inset space ~
13546 \begin_inset CommandInset ref
13548 reference "sec:bullet"
13555 \begin_layout Standard
13556 The two new list styles,
13564 , are designed to make it easier for you to create lists of do's and don'ts
13565 or right and wrong by providing dedicated environments that use a tick
13566 or a cross as the label of the list.
13567 These lists are in fact dedicated variants of the
13572 They do however require that you have the
13576 packages installed.
13579 \begin_layout Subsubsection
13583 \begin_layout Standard
13588 TeX redefines the floating tables and figures so that they appear exactly
13589 where they are in the text rather than pushing them to the top of the page
13590 or to some user specified location.
13591 In fact if you change the float placement settings they are simply ignored.
13594 \begin_layout Subsubsection
13595 Page Headers and Footers
13596 \begin_inset CommandInset label
13598 name "sec:foilfoot"
13605 \begin_layout Standard
13609 \begin_inset space ~
13618 are two commands used to control the left-footer text string.
13619 The first is meant to allow you to include a graphic logo on your foils
13621 \begin_inset Quotes eld
13629 \begin_inset Quotes erd
13633 While the second is meant to provide a classification for the audience,
13637 \begin_inset space \thinspace{}
13643 \begin_inset space ~
13647 It is empty by default.
13650 \begin_layout Standard
13651 The remaining page corners can be filled by
13654 \begin_inset space ~
13659 (which defaults to page numbers),
13662 \begin_inset space ~
13670 \begin_inset space ~
13678 \begin_layout Subsection
13684 \begin_inset CommandInset label
13686 name "sec:unsuppfoils"
13693 \begin_layout Standard
13694 All the commands mentioned below need to be set in a
13702 within another environment.
13705 \begin_layout Subsubsection
13709 \begin_layout Standard
13710 All lengths are adjusted using the
13733 should be replaced by the name given to the length you want to change and
13738 is the length value.
13739 All lengths should be specified in units of length such as inches (
13751 ) or relative to some document or font-based length such as
13761 \begin_layout Standard
13762 It's possible to change the spacing between a foilhead and the body of the
13763 foil by adjusting the length specified by
13770 For example, to make
13774 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13781 foilheadskip}{-0.5in}
13784 \begin_layout Standard
13785 The spacings around floats can be adjusted by setting these lengths:
13788 \begin_layout Labeling
13789 \labelwidthstring MMMMMMMMMMM
13796 Separation between the text and the top of the float
13799 \begin_layout Labeling
13800 \labelwidthstring MMMMMMMMMMM
13807 Separation between the float and the caption
13810 \begin_layout Labeling
13811 \labelwidthstring MMMMMMMMMMM
13818 Separation between the caption and the following text
13821 \begin_layout Labeling
13822 \labelwidthstring MMMMMMMMMMM
13829 You can make the captions narrower than the surrounding text by adjusting
13831 Best done relative to
13840 \begin_layout Standard
13841 There are also several title page related lengths that you may find useful
13842 if you have a long title or several authors:
13845 \begin_layout Labeling
13846 \labelwidthstring MMMMMMMMMMM
13853 Separation from headers to
13858 \begin_layout Labeling
13859 \labelwidthstring MMMMMMMMMMM
13877 \begin_layout Labeling
13878 \labelwidthstring MMMMMMMMMMM
13892 \begin_layout Labeling
13893 \labelwidthstring MMMMMMMMMMM
13909 \begin_layout Labeling
13910 \labelwidthstring MMMMMMMMMMM
13926 \begin_layout Standard
13927 The last length related command affects all the list environments.
13938 a list environment then all the vertical spacing between the list items
13940 Note that this is a command not a length so it doesn't require
13946 like the stuff mentioned above.
13949 \begin_layout Subsubsection
13950 Headers and Footers
13953 \begin_layout Standard
13966 commands control whether the logo in the
13970 definition appear on a given page.
13977 in the preamble then none of the foils will have the logo on them.
13978 If you don't want the logo on a particular page place the
13984 directly after the foilhead of that page and the
13990 directly after the next foilhead.
13993 \begin_layout Standard
13994 If you decide to use the
13998 page style setting in the
14001 \begin_inset space ~
14006 dialog you should probably add
14016 to your preamble so headers and footers on landscape pages are correctly
14017 placed when rotated.
14018 This is due to some clashes between the page layouts provided by the
14029 \begin_layout Section
14030 Latex8 (IEEE Conference Papers)
14033 \begin_layout Standard
14039 \begin_layout Subsection
14043 \begin_layout Standard
14044 Since this class is specifically for writing submissions to IEEE sponsored
14045 conferences I strongly recommend that you get a copy of their Authors Kit.
14050 package and associated bibliography style file is included in the kit.
14051 The Authors Kit is usually sent out by email once your initial submission
14053 There is a lot of useful information in the Authors Kit explaining formatting
14054 restrictions and so on and I will assume you have read this since that
14055 means I don't have to repeat it all here.
14058 \begin_layout Subsection
14062 \begin_layout Standard
14063 [AR\SpecialChar \@.
14067 \begin_layout Subsection
14068 Supported Environments
14071 \begin_layout Itemize
14077 \begin_layout Itemize
14083 \begin_layout Itemize
14089 \begin_layout Itemize
14095 \begin_layout Itemize
14101 \begin_layout Itemize
14107 \begin_layout Itemize
14113 \begin_layout Itemize
14119 \begin_layout Itemize
14125 \begin_layout Subsection
14126 Differences Between Screen and Paper
14129 \begin_layout Standard
14130 There are slight differences in appearance mainly with the presentation
14131 of section counters.
14132 On screen the trailing period of the section counter is missing but it
14133 will appear in the output so don't let this worry you.
14136 \begin_layout Section
14137 Hollywood (Hollywood spec scripts)
14140 \begin_layout Standard
14146 \begin_layout Subsection
14150 \begin_layout Standard
14151 Getting the format of a Hollywood script right is a
14152 \begin_inset Quotes eld
14156 \begin_inset Quotes erd
14159 It is designed to make the readers focus on content and to be easy and
14160 familiar for the actors to read.
14161 Each page of a script should be one minute of film.
14162 Nothing goes in a script that you cannot see or hear on screen.
14163 The courier 12 pt font should be used throughout.
14167 \begin_layout Subsection
14171 \begin_layout Standard
14172 Speakers' lines should NEVER break in mid-sentence.
14173 If a speaker's lines continue over a page break, repeat the
14177 title followed by (Cont'd).
14180 \begin_layout Subsection
14184 \begin_layout Standard
14189 names as labels then cross-reference the label to insert the name.
14190 The cross-reference dialog will show the current cast of characters.
14191 You can use this to insert the speaker name in narratives also.
14194 \begin_layout Subsection
14195 Paper size and Margins
14198 \begin_layout Standard
14199 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14202 \begin_layout Subsection
14206 \begin_layout Standard
14207 The following environments are available.
14208 You can use hollywood.bind to get the bind keys shown at the right.
14211 \begin_layout Itemize
14215 \begin_inset Newline newline
14220 Used where nothing else works.
14224 \begin_layout Itemize
14230 \begin_inset space \hfill{}
14238 \begin_inset Newline newline
14241 Usually followed by something like
14242 \begin_inset Quotes eld
14245 on Sally waking up.
14246 \begin_inset Quotes erd
14252 \begin_layout Itemize
14256 \begin_inset space \hfill{}
14260 \begin_inset Newline newline
14265 Introduces a new INTERIOR camera set-up.
14266 Always followed by DAY or NIGHT, or something similar to define the lighting
14268 Everthing on this line in CAPS.
14271 \begin_layout Itemize
14275 \begin_inset space \hfill{}
14279 \begin_inset Newline newline
14284 Introduces a new EXTERIOR camera set-up.
14285 Everthing on this line in CAPS.
14288 \begin_layout Itemize
14292 \begin_inset space \hfill{}
14296 \begin_inset Newline newline
14301 The character speaking.
14304 \begin_layout Itemize
14308 \begin_inset space \hfill{}
14312 \begin_inset Newline newline
14317 Instructions to the speaker.
14318 The () are automatically inserted, but only the ( will show in LyX.
14319 Both will be printed.
14322 \begin_layout Itemize
14326 \begin_inset space \hfill{}
14330 \begin_inset Newline newline
14342 \begin_layout Itemize
14346 \begin_inset space \hfill{}
14350 \begin_inset Newline newline
14355 Camera movement instruction.
14357 \begin_inset space \thinspace{}
14361 \begin_inset space ~
14367 \begin_layout Itemize
14371 \begin_inset space \hfill{}
14377 \begin_layout Itemize
14381 \begin_inset space \hfill{}
14387 \begin_layout Itemize
14391 \begin_inset space \hfill{}
14397 \begin_layout Itemize
14401 \begin_inset space \hfill{}
14407 \begin_layout Subsection
14411 \begin_layout Itemize
14412 (O.S) --- off screen
14415 \begin_layout Itemize
14416 (V.0) --- voice over
14419 \begin_layout Itemize
14424 \begin_layout Itemize
14429 \begin_layout Itemize
14430 PAN --- camera movement
14433 \begin_layout Itemize
14434 INSERT --- cut to close-up of
14437 \begin_layout Section
14441 \begin_layout Standard
14447 \begin_layout Subsection
14451 \begin_layout Standard
14452 Broadway is for writing plays.
14453 The format is more decorative than Hollywood, and much less standardized.
14454 This format should be suitable for workshops.
14457 \begin_layout Subsection
14461 \begin_layout Standard
14462 The same as in Hollywood.
14465 \begin_layout Subsection
14469 \begin_layout Standard
14474 names as labels then cross-reference the label to insert the name.
14475 The cross-reference dialog will show the current cast of characters.
14478 \begin_layout Subsection
14479 Paper size and Margins
14482 \begin_layout Standard
14483 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14486 \begin_layout Subsection
14490 \begin_layout Standard
14491 The following environments are available.
14492 You can use broadway.bind to get the bind keys shown at the right.
14495 \begin_layout Itemize
14499 \begin_inset Newline newline
14504 You should not have to use this, but it is here for anything that does not
14508 \begin_layout Itemize
14512 \begin_inset space \hfill{}
14516 \begin_inset Newline newline
14521 Used to describe stage setting and the action.
14522 First use of speaker names in all CAPs.
14525 \begin_layout Itemize
14529 \begin_inset space \hfill{}
14533 \begin_inset Newline newline
14538 Automatically numbered.
14539 On screen it will be arabic, but will print as Roman.
14542 \begin_layout Itemize
14546 \begin_inset space \hfill{}
14550 \begin_inset Newline newline
14560 It is just centered text.
14563 \begin_layout Itemize
14567 \begin_inset space \hfill{}
14571 \begin_inset Newline newline
14576 Not automatically numbered.
14577 You supply the number.
14578 This is because I couldn't figure out how.
14581 \begin_layout Itemize
14585 \begin_inset space \hfill{}
14589 \begin_inset Newline newline
14594 A special case of Narrative to describe the setting and action as the curtain
14598 \begin_layout Itemize
14602 \begin_inset space \hfill{}
14606 \begin_inset Newline newline
14611 The speaker's (actor's) title, centered in all CAPS.
14614 \begin_layout Itemize
14618 \begin_inset space \hfill{}
14622 \begin_inset Newline newline
14627 Instructions to the speaker.
14628 The parentheses are automatically inserted.
14629 The ( will appear on screen, but both will be in the printed play.
14630 This environment is only used within
14637 \begin_layout Itemize
14641 \begin_inset space \hfill{}
14645 \begin_inset Newline newline
14650 What the Speaker says.
14653 \begin_layout Itemize
14657 \begin_inset space \hfill{}
14661 \begin_inset Newline newline
14666 The curtain comes down.
14669 \begin_layout Itemize
14673 \begin_inset space \hfill{}
14679 \begin_layout Itemize
14683 \begin_inset space \hfill{}
14689 \begin_layout Itemize
14693 \begin_inset space \hfill{}
14699 \begin_layout Standard
14703 \begin_layout Section
14707 \begin_layout Standard
14713 \begin_layout Standard
14714 \begin_inset VSpace bigskip
14720 \begin_layout Standard
14725 \begin_inset space ~
14730 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14731 \begin_inset Formula $\beta$
14734 release of May, 1999) class.
14737 \begin_layout Standard
14742 textclass, which works with RevTeX 3.1.
14743 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14744 That means that it doesn't interact very well with LyX, which requires
14745 LaTeX2e, although it has been kludged to work.
14746 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14750 \begin_inset space ~
14755 textclass should also be pretty easy to use.
14758 \begin_layout Standard
14759 These documents are supposed to be used in
14763 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14764 macros, and assume you'll know what to put in the preamble if necessary.
14767 \begin_layout Subsection
14771 \begin_layout Standard
14772 All you need to do is install RevTeX 4, as described in the package's README
14774 The package can be found at The RevTeX 4 Web Site
14775 \begin_inset Flex URL
14778 \begin_layout Plain Layout
14780 http://publish.aps.org/revtex4/
14786 Install it somewhere that LaTeX can see it.
14787 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14788 (i.e., not the directory where you installed the class file.) Then, if you
14789 reconfigure LyX, it will find the class file and let you use the RevTeX4
14793 \begin_layout Standard
14794 Probably the easiest way to get started is either to import a RevTeX 4 document
14802 \begin_inset space ~
14807 template, found in the templates directory.
14810 \begin_layout Subsection
14814 \begin_layout Standard
14815 Optional arguments to
14822 \begin_inset Quotes eld
14826 \begin_inset Quotes erd
14830 \begin_inset Quotes eld
14834 \begin_inset Quotes erd
14844 \begin_inset space ~
14852 \begin_inset space ~
14858 Remember that in RevTeX, at least one optional argument is required!
14861 \begin_layout Standard
14862 Other preamble matter, like
14869 \begin_inset space ~
14879 \begin_inset space ~
14884 dialog, also as usual.
14887 \begin_layout Subsection
14891 \begin_layout Standard
14892 The layouts basically correspond to the commands in RevTeX4.0.
14893 For example, the Email layout corresponds to
14900 Note that (at least as of RevTeX 4.0 Beta), the
14908 layouts are exactly equivalent, so you shouldn't need to use both.
14912 \begin_layout Plain Layout
14913 In case you're curious, both were included so that
14917 would be able to translate both
14937 \begin_layout Subsection
14941 \begin_layout Standard
14942 There are a couple of important unique aspects of RevTeX 4 which might cause
14943 bugs that will be even more confusing in LyX.
14946 \begin_layout Standard
14964 The LyX equivalent is that there is a separate Thanks layout.
14969 write footnotes in the
14973 layout, or weird things may happen.
14974 See the RevTeX 4 documentation for more details.
14977 \begin_layout Standard
14981 \begin_inset space ~
14989 \begin_inset space ~
14998 layouts must be placed
15006 layout and the corresponding
15023 , the LaTeX won't compile.
15026 \begin_layout Subsection
15030 \begin_layout Standard
15031 The main problem with this layout is that you can't use the optional arguments
15032 to layouts like Email and Title.
15033 (The problem is not unique to this layout; you can't use optional arguments
15034 to the Section layouts either.) This means that after you export that file
15035 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15036 need to edit the LaTeX file with a text editor to add the optional arguments
15038 \begin_inset space \thinspace{}
15041 g., the running title for the page headers.
15042 Lacking these layouts makes the
15048 (and the equivalent
15054 ) useless, so the corresponding layouts don't exist, and will have to be
15059 \begin_layout Plain Layout
15064 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15065 has not been updated yet to take advantage of it.
15073 \begin_layout Section
15074 Article (mwart), book (mwbk) and report (mwrep)
15075 \begin_inset OptArg
15078 \begin_layout Plain Layout
15091 \begin_layout Standard
15097 \begin_layout Standard
15098 The LyX document classes
15114 correspond to the LaTeX document classes
15127 They are replacements for the standard document classes
15139 , resp., and fit better to Polish typography conventions in a number of points.
15143 \begin_layout Standard
15147 \begin_layout Itemize
15148 Unnumbered titles (with star, eg.
15153 ) are added into table of contents,
15156 \begin_layout Itemize
15157 Additional page styles:
15161 \begin_layout Description
15162 uheadings header with separated lines,
15165 \begin_layout Description
15166 myheadings custom header, contents headers via commands:
15181 \begin_layout Description
15182 myuheadings custom header with separated lines,
15185 \begin_layout Description
15186 outer page number is placed on outer side of page
15190 \begin_layout Itemize
15195 \begin_layout Description
15196 rmheadings serif titles --- default,
15199 \begin_layout Description
15200 sfheadings sansserif titles,
15203 \begin_layout Description
15204 authortitle on title page first placed is author next title --- default,
15207 \begin_layout Description
15208 titleauthor on title page first placed is title next author,
15211 \begin_layout Description
15212 withmarginpar reserve place on page for margins.
15216 \begin_layout Section
15220 \begin_layout Standard
15226 \begin_layout Standard
15227 Elsevier Science Publishers B.V.
15228 provides a standard LaTeX document class (
15232 ) for submitting articles to their various journals.
15233 The style file can be downloaded directly from their web site:
15234 \begin_inset Flex URL
15237 \begin_layout Plain Layout
15239 http://authors.elsevier.com/
15245 Instructions are supplied along with the class file, which details the
15246 requirements of the publishers.
15247 LyX includes package that allows for the use of this class, by a layout
15248 and a template file.
15249 Installation of the class file is the same as for any other LaTeX package;
15250 instructions are provided in the Elsevier documentation.
15253 \begin_layout Standard
15263 As the Elsevier class file is based mainly on the standard article class,
15264 most of the normal functionality is provided.
15265 The Elsevier class defines a number of mathematical environments, which
15266 are similar to the AMS environments.
15267 These commands are all described in the Elsevier documentation, and are
15271 \begin_layout Standard
15272 The easiest way to use the Elsevier style is to base documents on the included
15274 It is best not to use options such as fancy headings or the geometry package,
15275 as elements such as these are defined by Elsevier in their style file.
15276 Ideally, no extra packages except those mentioned in the Elsevier documentation
15278 Essentially, Elsevier require as
15279 \begin_inset Quotes eld
15283 \begin_inset Quotes erd
15286 a LaTeX file as possible, as their intention is to take the supplied file
15287 and replace the class file with one for the particular journal to which
15288 the paper has been submitted.
15289 This also means that not too much time should be spent on the formating
15291 When it comes to be published, this will change anyway.
15292 The rest of the usage for this layout is substantially the same as for
15293 the normal article class.
15294 For details of what Elsevier do and don't allow, refer to their documentation.
15297 \begin_layout Section
15301 \begin_layout Standard
15304 Jürgen Spitzmüller
15307 \begin_layout Subsection
15311 \begin_layout Standard
15312 Memoir is a very powerful and constantly evolving class.
15313 It has been designed with regard to fictional and non-fictional literature.
15314 Its aim is to let the user have maximum control over the typesetting of
15316 Memoir is based on the standard book class, but it can also emulate the
15317 article class (see below).
15320 \begin_layout Standard
15321 Peter Wilson, the developer of Memoir, is known as the author of lots of
15322 useful packages in the LaTeX world.
15323 Most of them have been merged with Memoir.
15324 Therefore, it is much easier to layout the table of contents, appendices,
15325 chapter designs and such.
15326 LyX, though, does not support all of these goodies natively.
15327 Some of them might be added to forthcoming releases
15331 \begin_layout Plain Layout
15332 You are invited to send suggestions to
15333 \begin_inset Flex URL
15336 \begin_layout Plain Layout
15338 lyx-devel@lists.lyx.org
15348 , lots will probably never, due to the limitations of LyX's framework.
15349 Of course you can still use all features with the help of some native LaTeX
15354 \begin_layout Plain Layout
15359 \begin_layout Plain Layout
15369 \begin_inset space ~
15373 \begin_inset CommandInset ref
15375 reference "sec:Inserting-TeX-Code"
15385 In this section, we can only list those features which are natively supported
15387 For detailed descriptions (and for the rest of features) we are recommending
15388 to have a look at the detailed manual of the Memoir class
15392 \begin_layout Plain Layout
15397 \begin_layout Plain Layout
15407 \begin_inset Flex URL
15410 \begin_layout Plain Layout
15412 CTAN:/macros/latex/memoir/memman.pdf
15422 , which is not only a user guide for the class, but also both a comprehensive
15423 description on good typesetting and a superb example for good typesetting
15427 \begin_layout Subsection
15428 Basic features and restrictions
15431 \begin_layout Standard
15432 Memoir supports basically all features of the standard book classes.
15433 There are, however, some differences, as follows:
15436 \begin_layout Description
15438 \begin_inset space ~
15441 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15444 \begin_layout Description
15446 \begin_inset space ~
15449 style: The fancy page style is not supported, due to a command clash between
15450 Memoir and the fancyhdr package (they are both defining a command with
15451 the same name, which confuses LaTeX).
15452 Instead, Memoir comes with a bunch of own page styles (see
15454 Layout\SpecialChar \menuseparator
15455 Document\SpecialChar \menuseparator
15457 \begin_inset space ~
15463 If you want to use these for the chapter pages, you have to use the command
15470 in the main text or in preamble (e.
15471 \begin_inset space \thinspace{}
15475 \begin_inset space ~
15482 chapterstyle{companion}
15487 \begin_layout Description
15488 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
15489 an optional argument in the standard classes.
15490 With this, you can specify an alternative version of the title for the
15491 table of contents and the headers (for instance, if the title is too long).
15492 In LyX, you can do this via
15494 Insert\SpecialChar \menuseparator
15496 \begin_inset space ~
15501 at the beginning of a chapter/section.
15502 Memoir features a second optional argument and thus separates the table
15503 of contents from the header.
15504 You can define three variants of a title with this: one for the main text,
15505 one for the table of contents, and one for the headers.
15506 Simply insert two optional arguments if you need this feature, the first
15507 one containing the short title for the Table of Contents, the second one
15508 containing an alternative short title for the headers.
15511 \begin_layout Description
15512 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15513 of contents, the list of figures and the list of table start a new page
15515 Memoir does not follow this route.
15516 You have to insert a page break yourself, if you want to have one.
15519 \begin_layout Description
15520 Titlepage: For some unknown reason, Memoir uses pagination on the title
15521 page (in the standard classes, title pages are
15522 \begin_inset Quotes eld
15526 \begin_inset Quotes erd
15530 \begin_inset space \thinspace{}
15534 \begin_inset space ~
15538 If you want an empty title page, type
15542 aliaspagestyle{title}{empty}
15547 \begin_layout Description
15548 Article: With the class option
15554 Layout\SpecialChar \menuseparator
15555 Document\SpecialChar \menuseparator
15557 \begin_inset space ~
15562 ), you can emulate article style.
15563 That is, counters (footnotes, figures, tables etc.) will not be reset on
15564 new chapters, chapters don't start a new page (but are---in contrary to
15566 \begin_inset Quotes eld
15570 \begin_inset Quotes erd
15573 article classes---still allowed), parts, though, use their own page, as
15577 \begin_layout Description
15578 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15579 font commands, which have been used in the old LaTeX version 2.09 (e.
15580 \begin_inset space \thinspace{}
15584 \begin_inset space ~
15600 It produces an error and stops LaTeX whenever such a command appears.
15605 reallows the commands and spits out warnings instead (which does at least
15607 Since a lot of packages and particularly BibTeX style files are still using
15608 those commands, we have decided to use this option by default.
15611 \begin_layout Subsection
15615 \begin_layout Standard
15616 We will only describe the features supported by LyX (which is not much currently
15618 Please consult the Memoir manual
15622 \begin_layout Plain Layout
15627 \begin_layout Plain Layout
15637 \begin_inset Flex URL
15640 \begin_layout Plain Layout
15642 CTAN:/macros/latex/memoir/memman.pdf
15655 \begin_layout Description
15656 Abstract: You may wonder why an abstract is an extra feature.
15657 Well, it is in book class.
15658 Usually books don't have abstracts.
15659 Memoir, however, has.
15660 You can use it wherever and how often you like.
15663 \begin_layout Description
15664 Chapterprecis: You may know this from belletristic: The contents of a chapter
15665 is shortly described below the title and also in the table of contents
15667 \begin_inset space \thinspace{}
15671 \begin_inset space ~
15676 Our hero arrives in Troia; he loses some friends; he finds others
15679 Chapterprecis does exactly this.
15680 It is therefore only sensible below a chapter.
15683 \begin_layout Description
15684 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15685 The epigraph environment provides an elegant way of typesetting such a
15687 The motto itself (text) and its author (source) are divided by a short
15689 Unfortunately, we have to fool LyX a bit here again, since the environment
15690 needs two arguments (text and source).
15691 In this case, we have to use curly brackets (in TeX mode) between the two
15702 <author of the slogan>.
15705 \begin_layout Description
15706 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15707 complex figurative poems).
15708 LyX can only support a few of them.
15709 One is poemtitle, which is a centered title for poems, which will also
15710 be added to the table of contents (verse is the standard environment for
15712 Memoir has some enhanced versions of verse, but you need to use ERT, because
15713 they have to be nested inside regular verse environments, which is not
15714 possible with LyX).
15717 \begin_layout Description
15718 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15721 \begin_layout Chapter
15722 LyX Features needing Extra Software
15725 \begin_layout Section
15729 \begin_layout Standard
15735 \begin_layout Subsection
15739 \begin_layout Standard
15744 program installed, you'll find in the
15751 \begin_inset space ~
15762 \begin_inset CommandInset href
15764 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15771 \begin_layout Standard
15776 package is a program that was written by
15777 \begin_inset Flex CharStyle:Noun
15780 \begin_layout Plain Layout
15782 \begin_inset space ~
15790 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15791 and easy to forget.
15792 The program runs over your LaTeX file, checks the integrity of the file,
15793 and flags some common errors.
15794 In other technical words, it is
15801 \begin_layout Standard
15802 Well, what is a syntax checker doing in LyX which is supposed to produce
15803 correct LaTeX anyways? The answer is simple: Just as
15807 not only checks the
15811 of C programs, but also does
15815 checks for type-errors,
15819 catches some common
15823 errors, in addition to the syntactical ones.
15828 is capable of detecting several common errors, such as
15831 \begin_layout Itemize
15832 Ellipsis detection:
15833 \begin_inset Newline newline
15836 Use \SpecialChar \ldots{}
15840 \begin_layout Itemize
15841 No space in front of/after parenthesis:
15842 \begin_inset Newline newline
15848 \begin_layout Itemize
15849 Enforcement of normal space after common abbreviations:
15850 \begin_inset Newline newline
15855 is too wide spacing.
15858 \begin_layout Itemize
15859 Enforcement of end-of-sentence space when the last sentence ends with a
15861 \begin_inset Newline newline
15865 And this is wrong spacing.
15868 \begin_layout Itemize
15869 Space in front of labels and similar commands:
15870 \begin_inset Newline newline
15873 The label should stick right up to the text to avoid falling to a wrong
15876 \begin_inset CommandInset label
15886 \begin_layout Plain Layout
15887 This footnote is in danger of falling off to a wrong page
15892 The label is separated too much.
15895 \begin_layout Itemize
15896 Space in front of references, instead of hard spaces:
15897 \begin_inset Newline newline
15900 In you are in bad luck, the text will break right between the referenced
15901 text and reference number, and that's a pity.
15903 \begin_inset CommandInset ref
15905 reference "sec:chktex"
15912 \begin_layout Itemize
15914 \begin_inset Quotes eld
15918 \begin_inset Quotes erd
15922 \begin_inset Formula $\times$
15926 \begin_inset Newline newline
15929 2x2 looks cheap compared to
15930 \begin_inset Formula $2\times2$
15936 \begin_layout Standard
15937 and more \SpecialChar \ldots{}
15938 It is an invaluable tool when you are
15939 \begin_inset Quotes eld
15943 \begin_inset Quotes erd
15946 your document before printing, and you should run it right after the obligatory
15947 spelling check, and before you go fine tuning the typesetting.
15950 \begin_layout Subsection
15954 \begin_layout Standard
15955 If you have the program installed, usage is as simple as choosing
15960 ools\SpecialChar \menuseparator
15966 \begin_inset space ~
15972 This will make LyX generate a LaTeX file of your document, start
15976 to check it, and then make LyX insert
15977 \begin_inset Quotes eld
15981 \begin_inset Quotes erd
15984 with the warnings from
15988 , if there were any.
15989 The warnings will be placed close to the point of the mistake, and you
15990 can quickly find them by using the
15995 avigate\SpecialChar \menuseparator
16002 menu item, or the shortcut key
16011 Open the error boxes by clicking on them with the mouse, or use the shortcut
16020 bindings, or the corresponding
16029 Read the warning and correct the mistake, if it is a mistake.
16030 If you have trouble understanding what the warning is about, you can safely
16032 Remember that there is a hidden layer between the document on screen and
16033 the technical details in invoking
16037 , and this gap can make some warnings seem arcane or just right down plain
16041 \begin_layout Standard
16042 This document is an excellent testing bed for the feature, and it should
16043 provide quite a few warnings for you to fiddle with.
16044 Since computers are only so smart, expect most of the warnings to be false
16048 \begin_layout Subsection
16049 How to fine tune it
16052 \begin_layout Standard
16053 Sometimes, you'll find that
16057 makes more noise than suits your mood.
16058 Then you can choose not to use it, wait until your mood changes, or try
16063 to get better along with you.
16064 Another choice in the most desperate situations is to use
16069 iew\SpecialChar \menuseparator
16075 \begin_inset space ~
16079 \begin_inset space ~
16083 \begin_inset space ~
16088 , which will get rid of all warnings instantly.
16091 \begin_layout Standard
16100 very configurable and extensible, you shouldn't expect to solve all problems
16106 Since LyX has to generate a somewhat special LaTeX file to be able to match
16107 the line numbers from the
16115 \begin_layout Plain Layout
16116 You can inspect the specific output from
16122 Edit\SpecialChar \menuseparator
16124 \begin_inset space ~
16128 \begin_inset space ~
16142 to the internal document structure, some of the warnings will not seen
16143 to appear correctly.
16144 There are two things you can do about this:
16147 \begin_layout Itemize
16152 invocation command line in
16168 installation configuration file (usually with the file
16173 See below to learn what warnings can be enabled and disabled on the command
16178 \begin_layout Itemize
16179 Export your document as a raw LaTeX file using
16184 ile\SpecialChar \menuseparator
16189 xport\SpecialChar \menuseparator
16201 Invoked in this way, it can be a hassle to find the corresponding place
16202 in the document inside LyX, but with a little patience, you should be able
16206 \begin_layout Standard
16207 Here follows the warning messages that can be enabled and disabled in
16216 to disable a warning, and
16220 to enable a warning.
16221 The emphasized entries are disabled by default, because the default is
16224 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16229 \begin_layout Standard
16230 Notice that you should only use the options that enable and disable warnings,
16231 because LyX relies on some of the other command line parameters to be set
16232 in a specific way to have a chance to communicate with
16239 \begin_layout Enumerate
16243 Command terminated with space.
16246 \begin_layout Enumerate
16249 Non-breaking space (
16250 \begin_inset Quotes eld
16258 \begin_inset Quotes erd
16261 ) should have been used.
16264 \begin_layout Enumerate
16268 You should enclose the previous parenthesis with
16269 \begin_inset Quotes eld
16277 \begin_inset Quotes erd
16283 \begin_layout Enumerate
16286 Italic correction (
16287 \begin_inset Quotes eld
16297 \begin_inset Quotes erd
16300 ) found in non-italic buffer.
16303 \begin_layout Enumerate
16306 Italic correction (
16307 \begin_inset Quotes eld
16317 \begin_inset Quotes erd
16320 ) found more than once.
16323 \begin_layout Enumerate
16327 No italic correction (
16328 \begin_inset Quotes eld
16338 \begin_inset Quotes erd
16344 \begin_layout Enumerate
16348 \begin_inset Quotes eld
16356 \begin_inset Quotes erd
16360 \begin_inset Quotes eld
16368 \begin_inset Quotes erd
16374 \begin_layout Enumerate
16377 Wrong length of dash may have been used.
16380 \begin_layout Enumerate
16384 \begin_inset Quotes eld
16392 \begin_inset Quotes erd
16396 \begin_inset Quotes eld
16404 \begin_inset Quotes erd
16410 \begin_layout Enumerate
16414 \begin_inset Quotes eld
16422 \begin_inset Quotes erd
16428 \begin_layout Enumerate
16432 \begin_inset Quotes eld
16440 \begin_inset Quotes erd
16443 to achieve an ellipsis.
16446 \begin_layout Enumerate
16449 Inter-word spacing (
16450 \begin_inset Quotes eld
16460 \begin_inset Quotes eld
16463 ) should perhaps be used.
16466 \begin_layout Enumerate
16469 Inter-sentence spacing (
16470 \begin_inset Quotes eld
16480 \begin_inset Quotes erd
16483 ) should perhaps be used.
16486 \begin_layout Enumerate
16489 Could not find argument for command.
16492 \begin_layout Enumerate
16496 \begin_inset Quotes eld
16504 \begin_inset Quotes erd
16510 \begin_layout Enumerate
16513 Math mode still on at end of LaTeX file.
16516 \begin_layout Enumerate
16520 \begin_inset Quotes eld
16528 \begin_inset Quotes erd
16531 doesn't match the number of
16532 \begin_inset Quotes eld
16540 \begin_inset Quotes erd
16546 \begin_layout Enumerate
16549 You should use either
16552 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16565 as an alternative to
16566 \begin_inset Quotes eld
16574 \begin_inset Quotes erd
16580 \begin_layout Enumerate
16587 " (ASCII 39) instead of "
16594 \begin_layout Enumerate
16597 User-specified pattern found.
16600 \begin_layout Enumerate
16603 This command might not be intended.
16606 \begin_layout Enumerate
16613 \begin_layout Enumerate
16631 \begin_layout Enumerate
16634 Delete this space to maintain correct page references.
16637 \begin_layout Enumerate
16641 You might wish to put this between a pair of
16642 \begin_inset Quotes eld
16650 \begin_inset Quotes erd
16656 \begin_layout Enumerate
16659 You ought to remove spaces in front of punctuation.
16662 \begin_layout Enumerate
16665 Could not execute LaTeX command.
16668 \begin_layout Enumerate
16677 in front of small punctuation.
16680 \begin_layout Enumerate
16688 may look prettier here.
16691 \begin_layout Enumerate
16695 Multiple spaces detected in output.
16698 \begin_layout Enumerate
16701 This text may be ignored.
16704 \begin_layout Enumerate
16710 \begin_inset Quotes eld
16715 to begin quotation, not
16722 \begin_layout Enumerate
16729 to end quotation, not
16732 \begin_inset Quotes eld
16740 \begin_layout Enumerate
16746 \begin_layout Enumerate
16749 You should perhaps use
16750 \begin_inset Quotes eld
16758 \begin_inset Quotes erd
16764 \begin_layout Enumerate
16767 You should put a space in front of/after parenthesis.
16770 \begin_layout Enumerate
16773 You should avoid spaces in front of/after parenthesis.
16776 \begin_layout Enumerate
16780 You should not use punctuation in front of/after quotes.
16783 \begin_layout Enumerate
16786 Double space found.
16789 \begin_layout Enumerate
16792 You should put punctuation outside inner/inside display math mode.
16795 \begin_layout Enumerate
16798 You ought to not use primitive TeX in LaTeX code.
16801 \begin_layout Enumerate
16804 You should remove spaces in front of
16805 \begin_inset Quotes eld
16813 \begin_inset Quotes erd
16819 \begin_layout Enumerate
16822 \begin_inset Quotes eld
16830 \begin_inset Quotes erd
16833 is normally not followed by
16834 \begin_inset Quotes eld
16842 \begin_inset Quotes erd
16848 \begin_layout Standard
16849 In later versions of LyX, we hope to provide a more complete interface to
16850 this tool (and it's smaller cousin
16854 ) to exploit the full power of it.
16855 But it's not exactly useless as it is now: go try it on one of your existing
16856 documents of a certain length and be surprised.
16859 \begin_layout Section
16860 Version Control in LyX
16863 \begin_layout Standard
16866 Lars Gullik Bjønnes,
16873 \begin_layout Subsection
16877 \begin_layout Standard
16878 A friend of mine wanted to try LyX for a group project.
16879 When he didn't find support for version control or file locking, he dropped
16881 This angered me a bit, so I thought that I should at least make support
16882 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16883 This has now been done.
16884 LyX now supports some of the most basic RCS commands.
16885 If you need to something a bit more sophisticated you will have to do that
16886 manually in an xterm.
16889 \begin_layout Standard
16890 Before you begin to use the version control features in LyX, you should
16892 \begin_inset Quotes eld
16896 \begin_inset Quotes erd
16899 (a man file, read it with
16904 This file describes all the basic features of RCS.
16905 You should especially notice the comment about a RCS directory, and the
16906 notion of a master RCS file (the file ending in
16913 \begin_layout Standard
16914 Later basic CVS/SVN support was added.
16915 You should be familiar with CVS/SVN usage before start using it under LyX.
16916 Most of the log messages are not currently displayed after operations -
16917 you can check them in terminal window if unsure.
16920 \begin_layout Standard
16921 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16922 package---no guarantees are made for older versions.
16925 \begin_layout Subsection
16926 RCS commands in LyX
16929 \begin_layout Standard
16930 The following sections describe the RCS commands supported by LyX.
16931 You can find them in the
16936 ile\SpecialChar \menuseparator
16942 \begin_inset space ~
16950 \begin_layout Subsubsection
16956 \begin_layout Standard
16957 If your document is not under revision control, this is the only item shown
16959 And if it is under revision control, the
16966 item is not visible.
16970 \begin_layout Standard
16971 This command registers your document with RCS (unless you are under the
16972 directory managed by CVS)\SpecialChar \@.
16973 You are asked interactively to supply an initial
16974 description of the document.
16975 The document is now set in Read-Only mode and you have to
16978 \begin_inset space ~
16982 \begin_inset space ~
16986 \begin_inset space ~
16991 , before making any changes to it.
16992 A document under revision control has a
16993 \begin_inset Quotes eld
16996 [RCS:<version> <locker>]
16997 \begin_inset Quotes erd
17000 item tagged to the filename in the minibuffer.
17003 \begin_layout Standard
17004 RCS command that is run:
17006 ci -q -u -i -t-"<initial description>" <file-name>
17009 \begin_layout Standard
17014 to understand the switches.
17018 \begin_layout Subsubsection
17024 \begin_layout Standard
17025 When you are finished editing a file, you check in your changes.
17026 When you do this, you are asked for a description of the changes.
17027 This is stored in the history log.
17028 The version number is bumped, your changes are applied to the master RCS
17029 file, the document is unlocked and set to Read-Only mode.
17033 \begin_layout Standard
17036 ci -q -u -m"<description>" <file-name>
17039 \begin_layout Subsubsection
17045 \begin_layout Standard
17046 By doing this you lock the document so that only you can edit it.
17047 This will also make the document Read-Write only for you.
17048 You will usually continue editing for a while and when you are finished
17049 you check in your changes.
17050 The status line is changed to reflect that you have locked the file.
17054 \begin_layout Standard
17057 co -q -l <file-name>
17060 \begin_layout Subsubsection
17063 Revert To Repository Version
17066 \begin_layout Standard
17067 This will discard all changes made to the document since the last check
17069 You get a warning before changes are discarded.
17072 \begin_layout Standard
17075 co -f -u<version> <file-name>
17078 \begin_layout Subsubsection
17084 \begin_layout Standard
17085 This makes as if the last check in never happened.
17086 No changes are made to the document loaded into LyX, but the last version
17087 is removed from the master RCS file.
17091 \begin_layout Standard
17094 rcs -o<version> <file-name>
17097 \begin_layout Subsubsection
17103 \begin_layout Standard
17104 This show the complete history of the RCS document.
17109 is shown in a browser.
17117 \begin_layout Subsection
17118 CVS commands in LyX
17121 \begin_layout Standard
17122 CVS is now partially supported by LyX.
17123 You can find the commands in the
17128 ile\SpecialChar \menuseparator
17134 \begin_inset space ~
17142 \begin_layout Subsubsection
17148 \begin_layout Standard
17149 If your document is not under revision control, this is the only item shown
17151 And if it is under revision control, the
17158 item is not visible.
17162 \begin_layout Standard
17163 This command registers in CVS your document ONLY in case you have already
17164 the documents directory under CVS control (in particular
17169 This means you have to checkout the archive by yourself.
17173 \begin_layout Standard
17174 Then you are asked interactively to supply an initial description of the
17176 Don't forget that registered file is not yet commited.
17179 \begin_layout Standard
17180 CVS command that is run:
17183 \begin_inset Quotes erd
17187 \begin_inset Quotes eld
17191 \begin_inset Quotes erd
17197 \begin_layout Standard
17202 to understand the switches.
17206 \begin_layout Subsubsection
17212 \begin_layout Standard
17213 When you are finished editing a file, you commit your changes.
17214 When you do this, you are asked for a description of the changes.
17215 After that changes are commited.
17218 \begin_layout Standard
17221 cvs -q commit -m"<description>" <file-name>
17224 \begin_layout Subsubsection
17227 Revert To Repository Version
17230 \begin_layout Standard
17231 This will discard all changes made to the document since the last check
17233 You get a warning before changes are discarded.
17234 Firstly the file is deleted, secondly CVS update command is run.
17237 \begin_layout Standard
17241 \begin_inset Quotes eld
17245 \begin_inset Quotes erd
17251 \begin_layout Subsubsection
17257 \begin_layout Standard
17258 This show the complete history of the CVS document.
17262 \begin_inset Quotes eld
17266 \begin_inset Quotes erd
17271 is shown in a browser.
17274 \begin_layout Subsection
17275 SVN commands in LyX
17278 \begin_layout Standard
17279 SVN is now partially supported by LyX.
17280 You can find the commands in the
17285 ile\SpecialChar \menuseparator
17291 \begin_inset space ~
17297 Please note that if you use password protected access to repository via
17298 ssh, you will be asked in terminal window.
17301 \begin_layout Subsubsection
17307 \begin_layout Standard
17308 If your document is not under revision control, this is the only item shown
17310 And if it is under revision control, the
17317 item is not visible.
17321 \begin_layout Standard
17322 This command registers in SVN your document ONLY in case you have already
17323 the documents directory under SVN control (in particular
17328 This means you have to checkout the archive by yourself.
17332 \begin_layout Standard
17333 Then you are asked interactively to supply an initial description of the
17335 Don't forget that registered file is not yet commited.
17338 \begin_layout Standard
17339 SVN command that is run:
17342 \begin_inset Quotes eld
17346 \begin_inset Quotes erd
17352 \begin_layout Standard
17357 to understand the switches.
17361 \begin_layout Subsubsection
17367 \begin_layout Standard
17368 When you are finished editing a file, you commit your changes.
17369 When you do this, you are asked for a description of the changes.
17370 After that changes are commited.
17373 \begin_layout Standard
17376 svn commit -q -m"<description>" <file-name>
17379 \begin_layout Subsubsection
17385 \begin_layout Standard
17386 Updates the changes of this file from the repository.
17387 Be sure you understand SVN merging and conflicts resolving before using
17388 this function, because all conflicts has to be done manually by you!
17391 \begin_layout Standard
17395 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17405 \begin_layout Subsubsection
17408 Revert To Repository Version
17411 \begin_layout Standard
17412 This will discard all changes made to the document since the last check
17414 You get a warning before changes are discarded.
17418 \begin_layout Standard
17422 \begin_inset Quotes eld
17426 \begin_inset Quotes erd
17432 \begin_layout Subsubsection
17438 \begin_layout Standard
17439 This show the complete history of the SVN document.
17443 \begin_inset Quotes eld
17447 \begin_inset Quotes erd
17452 is shown in a browser.
17455 \begin_layout Section
17456 Literate Programming
17459 \begin_layout Standard
17464 (kayvan@sylvan.com)
17468 original documentation written by
17470 Edmar Wienskoski Jr.
17473 (edmar-w-jr@technologist.com)
17476 \begin_layout Subsection
17480 \begin_layout Standard
17481 The main purpose of this documentation is to show you how to use LyX for
17482 literate programming.
17483 Where it is assumed that you are familiar with this programming technique,
17485 \begin_inset Quotes eld
17489 \begin_inset Quotes erd
17493 \begin_inset Quotes eld
17497 \begin_inset Quotes erd
17501 If that is not the case, please follow the web links provided in the following
17503 There is a lot of good documentation out there covering old development
17504 history to the latest tools tips.
17507 \begin_layout Standard
17508 It is also assumed that you are familiar with LyX itself to a point that
17509 you are comfortable changing your LyX preferences, and X resources file.
17510 If that is not the case please refer to other LyX documentation to cover
17511 your specific needs.
17514 \begin_layout Subsection
17515 Literate Programming
17518 \begin_layout Standard
17519 From the Literate Programming FAQ:
17522 \begin_layout Quotation
17523 Literate programming is the combination of documentation and source together
17524 in a fashion suited for reading by human beings.
17525 In fact, literate programs should be enjoyable reading, even inviting!
17526 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17527 and documentation in a single file.
17528 Literate programming tools then parse the file to produce either readable
17529 documentation or compilable source.
17530 The WEB style of literate programming was created by D.E.
17531 Knuth during the development of his TeX typesetting software.
17535 \begin_layout Standard
17536 Another excerpt says:
17539 \begin_layout Quotation
17542 How is literate programming different from verbose commenting?
17545 \begin_layout Quotation
17546 There are three distinguishing characteristics.
17547 In order of importance, they are:
17551 \begin_layout Itemize
17552 flexible order of elaboration
17555 \begin_layout Itemize
17556 automatic support for browsing
17559 \begin_layout Itemize
17560 typeset documentation, especially diagrams and mathematics
17564 \begin_layout Standard
17565 Now that I sparked your curiosity, take a look in the references.
17568 \begin_layout Subsubsection
17572 \begin_layout Standard
17573 The complete Literate Programming FAQ can be found at:
17576 \begin_layout Quote
17577 Literate Programming FAQ
17578 \begin_inset Flex URL
17581 \begin_layout Plain Layout
17583 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17591 \begin_layout Standard
17592 The FAQ lists 23 (twenty three!) different literate programming tools.
17593 Where some are specialized or
17594 \begin_inset Quotes eld
17598 \begin_inset Quotes erd
17601 for particular programming languages, while other have general scope.
17606 for my own use for several reasons:
17609 \begin_layout Itemize
17610 It can generate the documentation either in LaTeX or HTML.
17613 \begin_layout Itemize
17614 It has a open architecture, i.e., it is easy to plug in new filters and to
17615 perform special processing that you may need.
17619 \begin_layout Itemize
17620 There is a good selection of filters available already (the HTML is one
17624 \begin_layout Itemize
17628 \begin_layout Standard
17629 The Noweb web page can be found at:
17632 \begin_layout Quote
17634 \begin_inset Flex URL
17637 \begin_layout Plain Layout
17639 http://www.cs.virginia.edu/~nr/noweb/
17647 \begin_layout Standard
17648 Starting from there you can reach many other interesting links and even
17649 some literate program examples.
17652 \begin_layout Subsection
17653 LyX and Literate Programming
17656 \begin_layout Standard
17657 The LyX support for Literate Programming is provided by using the generic
17658 LyX converters mechanism.
17659 This support is provided in a
17660 \begin_inset Quotes eld
17664 \begin_inset Quotes erd
17667 way, i.e., you will be able to use this new LyX feature with some other literate
17668 programming tool of your choice by just changing your LyX preferences.
17671 \begin_layout Subsubsection
17672 Generating documents and code (weaving and tangling)
17675 \begin_layout Paragraph
17676 Selecting the document class
17679 \begin_layout Standard
17680 If you have installed Noweb and LyX successfully, whenever you open a new
17681 document or try to change the document class of an existing one, you will
17682 find that there are three new document classes available:
17685 \begin_layout Itemize
17689 \begin_layout Itemize
17693 \begin_layout Itemize
17697 \begin_layout Standard
17698 You must select one of them to create your literate documents from.
17702 \begin_layout Standard
17703 Note that literate documents are not limited to these three classes.
17704 New classes can be generated from other styles like letter or in combination
17705 with other class variations like Article (AMS).
17706 If you have special needs that cannot be covered by one of the existing
17707 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17708 will arrange to insert a new entry, or teach you how to do it.
17712 \begin_layout Plain Layout
17713 It is very simple, it involves the creation of a file with four lines, and
17714 re-running of the auto configuration.
17719 Moreover, if you use a literate tool other than Noweb you may need to create
17720 a new set of document classes for it.
17723 \begin_layout Paragraph
17727 \begin_layout Standard
17728 LyX enables you to write code with a layout named
17736 \begin_layout Plain Layout
17737 The equivalent Noweb term is
17738 \begin_inset Quotes eld
17742 \begin_inset Quotes erd
17746 For historical reasons, I got used to the term
17747 \begin_inset Quotes eld
17751 \begin_inset Quotes erd
17754 introduced by other literate tool named Nuweb, which I used for many years
17755 before rendering myself to Noweb.
17760 Noweb delimits scraps like this:
17763 \begin_layout LyX-Code
17767 \begin_layout LyX-Code
17771 \begin_layout LyX-Code
17775 \begin_layout LyX-Code
17779 \begin_layout LyX-Code
17783 \begin_layout Standard
17784 The problem is that whatever is written in between the << and the
17788 must be taken literally, i.e., LyX should be prevented from making any special
17789 interpretation of what has been written.
17790 This is handled by a special layout named Scrap, that works like a normal
17791 paragraph but has a free spacing capability.
17794 \begin_layout Standard
17795 The down side of the Scrap paragraph layout is that consecutive paragraphs
17796 of code will be spaced with one empty line in the source code and also
17797 in the printed documentation.
17798 The work around is to enter each line of code within a single Scrap, with
17799 a newline (ctrl-return).
17800 The example above will look like this:
17804 \begin_layout Plain Layout
17805 If you have a printed version of this document you will not see any difference
17806 between the previous example and this one.
17814 \begin_layout LyX-Code
17816 \begin_inset Newline newline
17820 \begin_inset Newline newline
17824 \begin_inset Newline newline
17828 \begin_inset Newline newline
17834 \begin_layout Standard
17835 This layout works fine.
17836 The only real inconvenience is that you have to type ctrl-return instead
17841 \begin_layout Plain Layout
17842 It is in my list of
17843 \begin_inset Quotes eld
17847 \begin_inset Quotes erd
17858 \begin_layout Standard
17859 As a special note, you can also use the
17860 \begin_inset Quotes eld
17864 \begin_inset Quotes erd
17867 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17871 \begin_layout LyX-Code
17873 \begin_inset Newline newline
17876 def some_function(args):
17877 \begin_inset Newline newline
17880 "This is the doc string for this function."
17881 \begin_inset Newline newline
17884 print "My args: ", args
17887 \begin_layout LyX-Code
17888 @ %def some_function
17891 \begin_layout Standard
17892 For an example of this usage and the resulting cross-reference output, look
17893 at the Literate python program in
17895 LIBDIR/examples/listerrors.lyx
17897 which should make this all clear.
17900 \begin_layout Paragraph
17901 Generating the documentation
17904 \begin_layout Standard
17905 At this point you already have a new document file with a proper document
17906 class, and with some code and text on it.
17907 How do I print it? The answer is simple, you select
17912 iew\SpecialChar \menuseparator
17920 Just like you would do for a plain document.
17921 No special procedure is required.
17924 \begin_layout Standard
17925 To help orientate you, I will now explain what happens inside LyX:
17928 \begin_layout Enumerate
17931 Update\SpecialChar \menuseparator
17934 menu option is chosen, a LaTeX file is generated.
17939 \begin_layout Standard
17940 If the document is of any literate class the generated file will be named
17941 with an extension name defined by the
17942 \begin_inset Quotes eld
17946 \begin_inset Quotes erd
17949 format (defined in the Preferences panel), otherwise the file will have
17958 \begin_layout Enumerate
17959 Note that the only difference so far is in the name of the file, no special
17960 processing is required by LyX.
17961 Given that you formatted the code using the Scrap layout that, by itself,
17962 takes care of the business.
17965 \begin_layout Enumerate
17966 If the document is of any literate class LyX will then use the internal
17967 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17971 \begin_layout Plain Layout
17972 The converters are defined in the
17974 Tools\SpecialChar \menuseparator
17978 \begin_inset Quotes eld
17982 \begin_inset Quotes erd
17994 manual for general information about converters.
17999 to generate the LaTeX file.
18003 \begin_layout Standard
18004 Otherwise it will just skip this step.
18008 \begin_layout Enumerate
18009 Finally, LaTeX is invoked and the regular post processing continues as in
18013 \begin_layout Standard
18014 Independence from a particular
18015 \begin_inset Quotes eld
18019 \begin_inset Quotes erd
18022 is easily achieved by changing the commands that are run by the various
18026 \begin_layout Paragraph
18027 Generating the code
18030 \begin_layout Standard
18031 When the build menu option is chosen or the corresponding button in the
18032 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18033 Next, LyX invokes the
18038 This converter needs to be defined by the user and is not installed by
18039 default, though the Program format is.
18040 This converter (like any other converter) will have two parts:
18043 \begin_layout Enumerate
18044 The converter program itself.
18045 This program performs the conversion from the one format to the other (in
18046 this case, from the Noweb format to the Program pseudo-format).
18049 \begin_layout Enumerate
18050 The error log parser.
18051 This is a program whose sole purpose is to rewrite error messages in a
18052 format that LyX understands.
18053 This makes it possible for LyX to place error boxes in the right places
18054 in the file buffer.
18057 \begin_layout Standard
18058 The first part, the
18059 \begin_inset Quotes eld
18063 \begin_inset Quotes erd
18066 setting, should be set to
18067 \begin_inset Quotes eld
18075 \begin_inset Quotes erd
18079 This basically means that LyX will call
18080 \begin_inset Quotes eld
18084 \begin_inset Quotes erd
18087 (a program or script) with the name of the Noweb file (normally a file
18088 in the LyX temp directory).
18092 \begin_layout Standard
18093 This is an implementation of
18094 \begin_inset Quotes eld
18098 \begin_inset Quotes erd
18101 that you can place in a directory on your path:
18104 \begin_layout LyX-Code
18108 \begin_layout LyX-Code
18112 \begin_layout LyX-Code
18113 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18116 \begin_layout Standard
18117 The next part of the converter setting is the
18118 \begin_inset Quotes eld
18122 \begin_inset Quotes erd
18125 which is to be set to
18126 \begin_inset Quotes eld
18131 parselog=listerrors
18134 \begin_inset Quotes erd
18138 This will run any errors that are generated by the
18139 \begin_inset Quotes eld
18143 \begin_inset Quotes erd
18146 process through the
18147 \begin_inset Quotes eld
18151 \begin_inset Quotes erd
18157 \begin_layout Standard
18158 The converter code looks in
18166 then on the path for the
18167 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18177 \begin_layout Standard
18178 The build will normally take place in LyX's temporary directory, so the
18179 files produced by the conversion will be in that directory.
18180 LyX will copy out what it regards as the `main' file, but the
18184 conversion may produce several files, and so most of these would then be
18185 deleted when LyX was closed.
18186 The present solution is to use a `copier',
18190 \begin_layout Plain Layout
18199 manual for information on these.
18208 script in its default mode, so that the entire contents of the temporary
18209 directory is copied.
18210 More will get copied than is needed, to be sure, but nothing will be lost.
18211 If, however, you know what extensions the generated files will have, this
18212 can be improved by using the
18221 This option takes a comma-separated list of extensions to copy.
18222 So, for example, if the conversion will generate only files with the extensions
18231 , then the correct definition would be:
18234 \begin_layout LyX-Code
18235 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18238 \begin_layout Standard
18239 The result will be that only files with these two extensions will be copied
18243 \begin_layout Paragraph
18244 Build instructions in the document
18247 \begin_layout Standard
18248 The last piece of the integration between LyX and noweb is the
18249 \begin_inset Quotes eld
18253 \begin_inset Quotes erd
18257 Generally, the instructions for building your program should be embedded
18258 in a scrap of its own.
18260 \begin_inset Quotes eld
18264 \begin_inset Quotes erd
18267 above uses the notangle command to look for this scrap (called
18268 \begin_inset Quotes eld
18272 \begin_inset Quotes erd
18275 ) and runs its contents through
18276 \begin_inset Quotes eld
18280 \begin_inset Quotes erd
18286 \begin_layout Standard
18287 Typically, such a scrap would look something like this:
18290 \begin_layout LyX-Code
18292 \begin_inset Newline newline
18296 \begin_inset Newline newline
18300 \begin_inset Newline newline
18303 if [ -z "${NOWEB_SOURCE}" ]
18304 \begin_inset Newline newline
18308 \begin_inset Newline newline
18311 NOWEB_SOURCE=myfile.nw
18312 \begin_inset Newline newline
18316 \begin_inset Newline newline
18320 code to extract files ...]
18321 \begin_inset Newline newline
18325 code to compile files ...]
18326 \begin_inset Newline newline
18332 \begin_layout Standard
18335 LIBDIR/examples/listerrors.lyx
18339 LIBDIR/examples/Literate.lyx
18341 which implement two versions of the
18342 \begin_inset Quotes eld
18346 \begin_inset Quotes erd
18349 program for some illustrations of how all of these pieces go together or
18352 LIBDIR/examples/noweb2lyx.lyx.
18355 Interestingly, these three files show off the language-indepence of the
18356 LyX literate programming support since they are written in Python, C and
18360 \begin_layout Subsubsection
18364 \begin_layout Standard
18365 All the Literate Programming support is configured by the
18370 ools\SpecialChar \menuseparator
18378 \begin_inset Quotes eld
18382 \begin_inset Quotes erd
18386 The important parts are:
18389 \begin_layout Description
18391 \begin_inset space ~
18395 \begin_inset Quotes eld
18399 \begin_inset Quotes erd
18403 \begin_inset space ~
18406 format Set up via the Formats tab, this is where the Noweb-specific pieces
18416 , the file extension is set to
18421 This tells LyX to create a file with a
18425 extension in the first step of the conversion process.
18428 \begin_layout Description
18430 \begin_inset space ~
18438 \begin_inset space ~
18441 format This is an empty format whose sole purpose is to be the endpoint
18442 of a conversion (which then allows us to set up a converter for it).
18445 \begin_layout Description
18454 This converter performs the
18455 \begin_inset Quotes eld
18459 \begin_inset Quotes erd
18462 of the literate document.
18463 For Noweb, it is set to
18464 \begin_inset Quotes eld
18469 noweave -delay -index $$i > $$o
18472 \begin_inset Quotes erd
18478 \begin_layout Description
18488 \begin_inset Quotes eld
18492 \begin_inset Quotes erd
18496 As stated above, the Converter is set to
18497 \begin_inset Quotes eld
18505 \begin_inset Quotes erd
18508 , with Flags set to
18509 \begin_inset Quotes eld
18514 originaldir,parselog=listerrors
18517 \begin_inset Quotes erd
18523 \begin_layout Subsubsection
18527 \begin_layout Standard
18528 There is also a new function implemented in the LyX server, the
18529 \begin_inset Quotes eld
18532 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18536 \begin_layout Standard
18537 When debugging code with ddd/gdb, it is possible to invoke a text editor
18538 at the current execution position with a single key stroke.
18539 The default ddd configuration for that is shift-ctrl-V.
18540 It happens that you can define the editor command line invocation in ddd
18546 dit\SpecialChar \menuseparator
18551 references\SpecialChar \menuseparator
18558 dialog and changing the "Edit Sources" entry.
18561 \begin_layout Standard
18562 I take advantage of the new created LyX server function and this ddd feature,
18564 \begin_inset Quotes eld
18568 \begin_inset Quotes erd
18574 \begin_layout LyX-Code
18575 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18578 \begin_layout Standard
18579 With this, whenever you are using ddd and find a point in the program that
18580 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18581 ddd you forward this information to LyX through the LyX server and then
18582 the LyX window will show the same file with the cursor at the same position
18583 ddd was pointing to.
18584 No more guessing or long scrolling to locate a point in the program back
18588 \begin_layout Standard
18589 Note however that you must enable the LyX server to get this feature working
18590 (it is disabled by default).
18591 You can enable it in
18603 ) by entering in the
18608 \begin_inset Quotes eld
18613 /home/<your-home-directory>/.lyx/lyxpipe
18616 \begin_inset Quotes erd
18622 \begin_layout Standard
18623 Read the LyX server documentation in the
18625 Customization Manual
18627 for further information.
18630 \begin_layout Subsubsection
18634 \begin_layout Standard
18635 There are six new buttons that can be added to your LyX toolbar.
18636 Five of these buttons are short cuts to layout styles:
18657 The last one is a short cut to the
18658 \begin_inset Quotes eld
18662 \begin_inset Quotes erd
18669 \begin_layout Standard
18670 LyX has a range of buttons that are available for tool bar customization.
18671 In my toolbar I like to combine the six short cuts above with two more:
18679 \SpecialChar \menuseparator
18687 \SpecialChar \menuseparator
18700 iew\SpecialChar \menuseparator
18708 Here is how it looks like:
18711 \begin_layout LyX-Code
18715 \begin_layout LyX-Code
18719 \begin_layout LyX-Code
18720 Icon "layout Standard"
18723 \begin_layout LyX-Code
18724 Icon "layout Section"
18727 \begin_layout LyX-Code
18728 Icon "layout LaTeX"
18731 \begin_layout LyX-Code
18732 Icon "layout LyX-Code"
18735 \begin_layout LyX-Code
18736 Icon "layout Scrap"
18739 \begin_layout LyX-Code
18743 \begin_layout LyX-Code
18747 \begin_layout LyX-Code
18748 Icon "buffer-typeset"
18751 \begin_layout LyX-Code
18752 Icon "build-program"
18755 \begin_layout LyX-Code
18759 \begin_layout LyX-Code
18763 \begin_layout LyX-Code
18767 \begin_layout LyX-Code
18771 \begin_layout LyX-Code
18775 \begin_layout Subsubsection
18776 Colors customization
18779 \begin_layout Standard
18780 There are a number of colors in LyX that can be customized in
18785 One of the things that bothers people is the LaTeX font color.
18786 The default color is red, since the scraps uses LaTeX font, and there is
18787 a lot of scraps in literate documents, you may get tired of seeing everything
18789 You can change it by going to the tabs
18798 \begin_layout Standard
18799 The next thing is the visible presence of the newline character in the screen.
18800 You can choose the color of this particular character and make it blend
18802 I recommend you choosing a color that is close to the background but not
18803 equal, that way you still can see it is there, but it is not bothering
18808 \begin_layout Chapter
18809 Secrets of the LaTeX Masters
18810 \begin_inset CommandInset label
18819 \begin_layout Standard
18820 Though LyX is a powerful tool, it cannot hope to support everything that
18821 can be done with pure TeX/LaTeX.
18822 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18823 as long as you are not afraid to use that
18824 \begin_inset Quotes eld
18828 \begin_inset Quotes erd
18831 button on the toolbar or add things to the LaTeX preamble.
18832 This section lists some tips, tricks, and otherwise cool ideas to give
18833 your document that extra little flair.
18836 Do try this at home
18838 , just start with something a little smaller and less important than your
18842 \begin_layout Standard
18843 Most ideas in this section require less common files in your LaTeX installation.
18844 If you have a system like teTeX, most will already be available.
18845 A few, however, will need to be downloaded from one of the CTAN archives.
18846 Often, there are several ways to do something, or several LaTeX style files
18847 which do the same thing.
18848 We do not endorse one choice over another, we simply claim that we have
18849 done a particular task with a particular file.
18850 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18853 \begin_layout Section
18857 \begin_layout Standard
18860 Lars Gullik Bjønnes
18863 \begin_layout Subsection
18867 \begin_layout Standard
18868 The aim for this chapter
18872 \begin_layout Plain Layout
18873 Editor's note: Lars' original chapter was a masterful description of how
18879 However, it was too long to flow smoothly in this document.
18880 I have therefore chosen to excerpt the most important sections here (sorry,
18881 Lars); you can read the original chapter (and more of the story!) in the
18884 examples/multicol.lyx
18892 is to show how the LaTeX package
18896 can be used in a LyX document.
18897 As LyX doesn't support the
18901 package natively yet, we have to use some small hacks.
18902 By reading this section it should be obvious how to do this.
18905 \begin_layout Subsection
18909 \begin_layout Standard
18914 package allows switching between one and multicolumn format on the same
18916 Footnotes are handled correctly (for the most part), but will be placed
18917 at the bottom of the page and not under each column.
18918 LaTeX's float mechanism, however, is partly disabled in the current implementat
18920 At the moment only page-wide floats can be used within the scope of the
18924 \begin_layout Subsection
18928 \begin_layout Subsubsection
18932 \begin_layout Standard
18933 If you want to have two columns in your text, you have use LaTeX mode to
18938 begin{multicols}{2}
18940 at the point where you want the two column layout to start, and then
18946 where you want it to end.
18950 \begin_layout Standard
18954 \begin_layout Plain Layout
18958 begin{multicols}{2}
18966 \begin_layout Standard
18971 The Adventure of the Empty House
18974 \begin_inset Newline newline
18979 Sir Arthur Conan Doyle
18982 \begin_layout Standard
18985 It was in the spring of the year 1894 that all London was interested, and
18986 the fashionable world dismayed, by the murder of the Honourable Ronald
18987 Adair under most unusual and inexplicable circumstances.
18988 The public has already learned those particulars of the crime which came
18989 out in the police investigation, but a good deal was suppressed upon that
18990 occasion, since the case for the prosecution was so overwhelmingly strong
18991 that it was not necessary to bring forward all the facts.
18992 Only now, at the end of nearly ten years, am I allowed to supply those
18993 missing links which make up the whole of that remarkable chain.
18994 The crime was of interest in itself, but that interest was as nothing to
18995 me compared to the inconceivable sequel, which afforded me the greatest
18996 shock and surprise of any event in my adventurous life.
18997 Even now, after this long interval, I find myself thrilling as I think
18998 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18999 ty which utterly submerged my mind.
19000 Let me say to that public, which has shown some interest in those glimpses
19001 which I have occasionally given them of the thoughts and actions of a very
19002 remarkable man, that they are not to blame me if I have not shared my knowledge
19003 with them, for I should have considered it my first duty to do so, had
19004 I not been barred by a positive prohibition from his own lips, which was
19005 only withdrawn upon the third of last month.
19008 \begin_layout Standard
19012 \begin_layout Plain Layout
19024 \begin_layout Subsubsection
19028 \begin_layout Standard
19029 The same pattern is used when you want more than two columns:
19032 \begin_layout Standard
19036 \begin_layout Plain Layout
19040 begin{multicols}{3}
19048 \begin_layout Standard
19051 It can be imagined that my close intimacy with Sherlock Holmes had interested
19052 me deeply in crime, and that after his disappearance I never failed to
19053 read with care the various problems which came before the public.
19054 And I even attempted, more than once, for my own private satisfaction,
19055 to employ his methods in their solution, though with indifferent success.
19056 There was none, however, which appealed to me like this tragedy of Ronald
19058 As I read the evidence at the inquest, which led up to a verdict of willful
19059 murder against some person or persons unknown, I realized more clearly
19060 than I had ever done the loss which the community had sustained by the
19061 death of Sherlock Holmes.
19062 There were points about this strange business which would, I was sure,
19063 have specially appealed to him, and the efforts of the police would have
19064 been supplemented, or more probably anticipated, by the trained observation
19065 and the alert mind of the first criminal agent in Europe.
19066 All day, as I drove upon my round, I turned over the case in my mind and
19067 found no explanation which appeared to me to be adequate.
19068 At the risk of telling a twice-told tale, I will recapitulate the facts
19069 as they were known to the public at the conclusion of the inquest.
19072 \begin_layout Standard
19076 \begin_layout Plain Layout
19088 \begin_layout Standard
19089 You can have more than 3 columns if you want to, but that might not be very
19090 pleasant for the eye.
19093 \begin_layout Subsubsection
19094 Columns inside columns
19097 \begin_layout Standard
19098 You can even have columns inside columns:
19101 \begin_layout Standard
19105 \begin_layout Plain Layout
19109 begin{multicols}{2}
19117 \begin_layout Standard
19120 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19121 at that time governor of one of the Australian colonies.
19122 Adair's mother had returned from Australia to undergo the operation for
19123 cataract, and she, her son Ronald, and her daughter Hilda were living together
19127 \begin_layout Standard
19131 \begin_layout Plain Layout
19135 begin{multicols}{2}
19143 \begin_layout Standard
19146 The youth moved in the best society--had, so far as was known, no enemies
19147 and no particular vices.
19148 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19149 had been broken off by mutual consent some months before, and there was
19150 no sign that it had left any very profound feeling behind it.
19151 For the rest {sic} the man's life moved in a narrow and conventional circle,
19152 for his habits were quiet and his nature unemotional.
19153 Yet it was upon this easy-going young aristocrat that death came, in most
19154 strange and unexpected form, between the hours of ten and eleven-twenty
19155 on the night of March 30, 1894.
19158 \begin_layout Standard
19162 \begin_layout Plain Layout
19174 \begin_layout Standard
19177 Ronald Adair was fond of cards--playing continually, but never for such
19178 stakes as would hurt him.
19179 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19180 It was shown that, after dinner on the day of his death, he had played
19181 a rubber of whist at the latter club.
19182 He had also played there in the afternoon.
19187 The evidence of those who had played with him-- Mr.
19188 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19189 and that there was a fairly equal fall of the cards.
19190 Adair might have lost five pounds, but not more.
19191 His fortune was a considerable one, and such a loss could not in any way
19193 He had played nearly every day at one club or other, but he was a cautious
19194 player, and usually rose a winner.
19195 It came out in evidence that, in partnership with Colonel Moran, he had
19196 actually won as much as four hundred and twenty pounds in a sitting, some
19197 weeks before, from Godfrey Milner and Lord Balmoral.
19198 So much for his recent history as it came out at the inquest.
19201 \begin_layout Standard
19205 \begin_layout Plain Layout
19217 \begin_layout Standard
19218 Please do read the file
19220 examples/multicol.lyx
19222 for more advanced examples including column and header spacing, vertical
19223 separator lines, and more.
19226 \begin_layout Section
19231 Paragraph Environment
19232 \begin_inset OptArg
19235 \begin_layout Plain Layout
19236 Numbering in Enumerate
19244 \begin_layout Standard
19250 \begin_layout Standard
19251 \begin_inset VSpace bigskip
19257 \begin_layout Standard
19259 The default numbering for the
19263 paragraph environment begins with Arabic numbers and ends with uppercase
19265 Suppose, however, you wanted a different type of numbering scheme.
19266 Here's a quickie example of how to change the numbering scheme:
19269 \begin_layout LyX-Code
19279 \begin_layout LyX-Code
19289 \begin_layout LyX-Code
19299 \begin_layout LyX-Code
19309 \begin_layout Standard
19310 \SpecialChar \ldots{}
19311 which changes the numbering scheme to uppercase Roman numerals, uppercase
19312 letters, Arabic numbers, and lowercase letter.
19315 \begin_layout Standard
19316 Additionally, the previous example also adds a little bit extra to the numbering
19318 For example, the first level label actually looks like:
19319 \begin_inset Quotes eld
19323 \begin_inset Quotes erd
19327 For ease of reading, we'll describe what the numbering schemes look like
19328 using a notation something like this: <
19329 \begin_inset Quotes eld
19333 \begin_inset Quotes erd
19337 \begin_inset space ~
19341 \begin_inset Quotes erd
19345 \begin_inset Quotes erd
19349 \begin_inset space ~
19353 \begin_inset Quotes erd
19357 \begin_inset Quotes erd
19361 \begin_inset space ~
19365 \begin_inset Quotes eld
19369 \begin_inset Quotes erd
19376 \begin_layout Standard
19377 As you can see in the example, there is a label command for each nesting
19384 \SpecialChar \ldots{}
19391 , as well as a counter,
19395 \SpecialChar \ldots{}
19401 There are also five
19402 \begin_inset Quotes eld
19406 \begin_inset Quotes erd
19439 , each of which take one counter as an argument.
19440 You can add characters before or after these, but there's no need to add
19444 \begin_layout Standard
19445 You can get really fancy with these.
19449 \begin_layout LyX-Code
19463 \begin_layout LyX-Code
19475 \begin_layout LyX-Code
19485 \begin_layout LyX-Code
19495 \begin_layout Standard
19496 produces the somewhat out of hand numbering scheme: <
19497 \begin_inset Quotes eld
19501 \begin_inset Quotes erd
19505 \begin_inset space ~
19509 \begin_inset Quotes erd
19513 \begin_inset Quotes erd
19517 \begin_inset space ~
19521 \begin_inset Quotes erd
19525 \begin_inset Quotes erd
19529 \begin_inset space ~
19533 \begin_inset Quotes eld
19537 \begin_inset Quotes erd
19544 \begin_layout Standard
19548 \begin_layout Section
19552 \begin_layout Standard
19558 \begin_layout Standard
19559 \begin_inset VSpace bigskip
19565 \begin_layout Standard
19570 \begin_layout Plain Layout
19576 tmpfont}{cmr17 scaled 2500}{
19588 \begin_layout Standard
19593 \begin_layout Plain Layout
19604 hose of you who like the style of old books probably also like
19605 \begin_inset Quotes eld
19609 \begin_inset Quotes erd
19612 ---those large capital letters which begin each new chapter or section.
19613 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19614 know some plain TeX!) but does require a lot of work and many iterations,
19615 as you can see by all the ugly TeX-mode stuff at the beginning of this
19619 \begin_layout Standard
19623 \begin_layout Plain Layout
19629 bigdrop{-1em}{3}{ptmri}{T}+
19634 here is a much easier way of doing this, of course.
19643 ) package from CTAN allows a simple way to add such letters to your documents.
19644 Since this package is not a standard part of teTeX, I can't demonstrate
19645 it within this document, but if you copy this paragraph to a new document,
19647 \begin_inset Quotes eld
19657 \begin_inset Quotes erd
19660 and the pluses from the TeX code at the beginning of the paragraph, and
19665 usepackage{dropcaps}
19667 to your LaTeX preamble, you will get a nice Times Roman Italic
19668 \begin_inset Quotes eld
19672 \begin_inset Quotes erd
19675 , whose height is three lines of text and which protrudes 1 em into the
19677 (Make certain you have copied
19678 \begin_inset Quotes eld
19686 \begin_inset Quotes erd
19689 into a directory where TeX can see it.) The first argument is the amount
19690 of indentation; in this case the negative sign moves it into the margin.
19691 The second argument is the height of the letter in number of lines of text.
19692 The third argument is the font name: virtually anything which has a tfm
19693 file should work (wade through the
19695 .../texmf/fonts/tfm
19697 directory for possibilities).
19698 My personal favorite is
19699 \begin_inset Quotes eld
19707 \begin_inset Quotes erd
19710 , a fancy German font specifically designed for dropped capitals.
19711 The fourth argument is the letter (or letters) to be dropped.
19716 package also offers the
19722 command, as well as a slightly simplified
19731 \begin_layout Section
19732 Non-standard Paragraph Shapes
19735 \begin_layout Standard
19741 \begin_layout Standard
19742 \begin_inset VSpace bigskip
19748 \begin_layout Standard
19752 \begin_layout Plain Layout
19764 \begin_layout Standard
19768 \begin_layout Plain Layout
19777 \begin_layout Plain Layout
19791 \begin_layout Standard
19796 \begin_layout Plain Layout
19807 \begin_layout Plain Layout
19816 \begin_layout Plain Layout
19825 \begin_layout Plain Layout
19834 \begin_layout Plain Layout
19843 \begin_layout Plain Layout
19852 \begin_layout Plain Layout
19861 \begin_layout Plain Layout
19870 \begin_layout Plain Layout
19879 \begin_layout Plain Layout
19888 \begin_layout Plain Layout
19897 \begin_layout Plain Layout
19906 \begin_layout Plain Layout
19915 \begin_layout Plain Layout
19924 \begin_layout Plain Layout
19933 \begin_layout Plain Layout
19942 \begin_layout Plain Layout
19951 \begin_layout Plain Layout
19960 \begin_layout Plain Layout
19969 \begin_layout Plain Layout
19975 There are times when the tyranny of rectangular paragraphs must be overthrown.
19976 In such situations, a call to the delightful plain TeX command
19983 As you can see, completely arbitrary shapes can be laid out with a suitable
19984 set of linelength definitions.
19985 While this parshape may look a bit silly and useless, one could conceive
19986 of situations such as finely tuned dropped capitals, word wrapping around
19987 non-rectangular graphics, etc.
19988 which will benefit from such handcrafting.
19991 \begin_layout Standard
19992 \begin_inset VSpace bigskip
19998 \begin_layout Standard
20003 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20010 is the number of lines of text which define the paragraph.
20011 If there turn out to be fewer lines, the shape is truncated; if there are
20012 more, the excess lines have the same dimensions as the last line of the
20022 entries specify the indentation of the line from the left margin, and the
20023 length of the line as measured from that point.
20024 The shape applies only to the current paragraph; everything is reset to
20025 normal for the next paragraph.
20028 \begin_layout Standard
20032 \begin_layout Plain Layout
20044 \begin_layout Section
20048 \begin_layout Standard
20049 As you can see, the examples in this section range from the useful to the
20051 While I don't expect that anyone will ever need the paragraph shape demonstrate
20052 d in the last section, the important point is that you can do almost anything
20053 you want in LyX if you are willing to figure out how to do it in TeX and
20055 TeX is a fantastically powerful typesetting system and all that power is
20056 available to you since LyX uses it as its backend.
projects / lyx.git / blob