1 #LyX 2.0.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
82 \default_output_format default
83 \bibtex_command default
84 \index_command default
88 \pdf_title "LyX's Extended manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's extended documentation"
91 \pdf_keywords "LyX, Documentation, Extended"
93 \pdf_bookmarksnumbered true
94 \pdf_bookmarksopen false
95 \pdf_bookmarksopenlevel 1
100 \pdf_pdfusetitle false
101 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
109 \paperorientation portrait
112 \paragraph_separation indent
113 \paragraph_indentation default
114 \quotes_language english
117 \paperpagestyle headings
118 \tracking_changes false
119 \output_changes false
125 Additional LyX Features
133 \begin_layout Plain Layout
135 Principal maintainer of this file is
140 If you have comments or error corrections, please send them to the LyX
141 Documentation mailing list,
142 \begin_inset Flex CharStyle:Code
145 \begin_layout Plain Layout
147 <lyx-docs@lists.lyx.org>
160 \begin_layout Standard
161 \begin_inset CommandInset toc
162 LatexCommand tableofcontents
169 \begin_layout Chapter
173 \begin_layout Standard
174 This manual is essentially Part II of the
176 User's Guide\SpecialChar \@.
179 The reason for separating this document out is simple: the
183 is already quite lengthy, and it contains information on all of the basic
184 features one needs to know in order to prepare most documents.
185 However, the LyX Team has worked to LyX extensible through various configuratio
186 n files and external packages.
187 That means that if you want to support the Fizzwizzle LaTeX package, you
188 can create a layout file (or module) for it without having to alter LyX
190 We've already had contributions of several new features this way.
191 This is the place where all of those get documented.
194 \begin_layout Standard
195 This manual also documents some special features, like fax support, version
196 control, and SGML support, which require additional software to work properly.
197 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
198 spruce up your documents by directly using the powerful features of LaTeX.
203 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
206 \begin_layout Standard
207 If you haven't read the
211 yet, you are definitely in the wrong manual.
216 is the first place to go, since it describes the notation and format of
218 You should also be thoroughly familiar with the
222 and all of the basic features of LyX before attempting to read this one.
225 \begin_layout Standard
226 Since all the topics in this manual depend heavily on LyX's interaction
227 with LaTeX, this first chapter covers the inner workings of LyX and how
228 to direct LyX to generate exactly the LaTeX code you want.
229 It is obviously for more seasoned LyX users.
232 \begin_layout Chapter
236 \begin_layout Section
240 \begin_layout Standard
241 This chapter is for both TeX-nicians and the LaTeX-curious.
242 In it, we'll explain how LyX and LaTeX work together to produce printable
244 This is the only place in any of the manuals where we assume you know something
248 \begin_layout Standard
249 At one time, LyX was called a
250 \begin_inset Quotes eld
253 WYSIWYM frontend to LaTeX,
254 \begin_inset Quotes erd
257 but that's no longer true.
258 There are frontends to LaTeX out there.
262 \begin_layout Plain Layout
263 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
264 There are also the LaTeX modes for vi and emacs, of course.
269 These are basically text editors with the ability to run LaTeX and mark
270 any errors in the file you're editing.
279 run LaTeX, and it also indicates errors in the file, it also does much,
281 For one thing, you don't need to know LaTeX to use LyX effectively.
282 And LyX has added its own extensions to LaTeX.
283 Try the following sometime: select
284 \begin_inset Flex CharStyle:MenuItem
287 \begin_layout Plain Layout
288 Export\SpecialChar \menuseparator
295 \begin_inset Flex CharStyle:MenuItem
298 \begin_layout Plain Layout
305 \begin_inset Flex CharStyle:MenuItem
308 \begin_layout Plain Layout
309 View\SpecialChar \menuseparator
315 ), then look at the preamble of the resulting
316 \begin_inset Flex CharStyle:Code
319 \begin_layout Plain Layout
326 You'll notice a variety of new macros defined specifically by LyX.
327 These macros are defined automatically, according to the features you use
331 \begin_layout Standard
332 There are several commands that automatically invoke LaTeX.
336 \begin_layout Itemize
337 \begin_inset Flex CharStyle:MenuItem
340 \begin_layout Plain Layout
341 View\SpecialChar \menuseparator
350 \begin_layout Itemize
351 \begin_inset Flex CharStyle:MenuItem
354 \begin_layout Plain Layout
355 View\SpecialChar \menuseparator
356 Update\SpecialChar \menuseparator
365 \begin_layout Itemize
366 \begin_inset Flex CharStyle:MenuItem
369 \begin_layout Plain Layout
370 File\SpecialChar \menuseparator
379 \begin_layout Itemize
380 \begin_inset Flex CharStyle:MenuItem
383 \begin_layout Plain Layout
384 File\SpecialChar \menuseparator
393 \begin_layout Standard
394 They will only invoke LaTeX if the file has changed since the last time
399 \begin_layout Standard
400 When LyX runs LaTeX on the file you're editing, it performs these steps:
403 \begin_layout Enumerate
404 Convert the document to LaTeX and save to a file with the extension
405 \begin_inset Flex CharStyle:Code
408 \begin_layout Plain Layout
415 \begin_inset Flex CharStyle:Code
418 \begin_layout Plain Layout
427 \begin_layout Enumerate
429 \begin_inset Flex CharStyle:Code
432 \begin_layout Plain Layout
438 file (maybe several times), and run any other commands (such as
439 \begin_inset Flex CharStyle:Code
442 \begin_layout Plain Layout
449 \begin_inset Flex CharStyle:Code
452 \begin_layout Plain Layout
458 ) needed to compile the LaTeX file.
461 \begin_layout Enumerate
462 If there are any errors, show the error log.
465 \begin_layout Standard
466 If you've run LaTeX using
467 \begin_inset Flex CharStyle:MenuItem
470 \begin_layout Plain Layout
473 \SpecialChar \menuseparator
481 , LyX then runs a DVI viewer to display the DVI-file.
483 \begin_inset Flex CharStyle:MenuItem
486 \begin_layout Plain Layout
489 \SpecialChar \menuseparator
497 , LyX performs further steps:
500 \begin_layout Itemize
502 \begin_inset Flex CharStyle:Code
505 \begin_layout Plain Layout
511 to convert the DVI file to PostScript.
514 \begin_layout Itemize
515 Run a PostScript viewer, such as
516 \begin_inset Flex CharStyle:Code
519 \begin_layout Plain Layout
525 , to display the PostScript file.
528 \begin_layout Standard
529 LyX does similar things when viewing, or exporting, other formats.
532 \begin_layout Section
533 Translating LaTeX files into LyX
536 \begin_layout Standard
537 You can import a LaTeX file into LyX by using the
538 \begin_inset Flex CharStyle:MenuItem
541 \begin_layout Plain Layout
542 File\SpecialChar \menuseparator
543 Import\SpecialChar \menuseparator
550 This will call a program named
551 \begin_inset Flex CharStyle:Code
554 \begin_layout Plain Layout
560 which will create a file
561 \begin_inset Flex CharStyle:Code
564 \begin_layout Plain Layout
571 \begin_inset Flex CharStyle:Code
574 \begin_layout Plain Layout
581 LyX will then open that file.
585 \begin_layout Plain Layout
586 \begin_inset Flex CharStyle:Code
589 \begin_layout Plain Layout
595 can also be run from the command line, of course.
603 \begin_layout Standard
604 \begin_inset Flex CharStyle:Code
607 \begin_layout Plain Layout
613 will translate most legal LaTeX, but not everything.
614 It will put things it doesn't understand into TeX code, so after translating
616 \begin_inset Flex CharStyle:Code
619 \begin_layout Plain Layout
625 , you can look for TeX code and hand-edit it until it looks right.
628 \begin_layout Standard
629 If you don't know what TeX code is, read the next section.
632 \begin_layout Section
633 \begin_inset CommandInset label
635 name "sec:Inserting-TeX-Code"
639 Inserting TeX Code into LyX Documents
642 \begin_layout Standard
643 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
644 You can always insert TeX code into any LyX document.
645 LyX cannot, and will never be able to, display every possible LaTeX construct.
646 If ever you need to insert LaTeX commands into your LyX document, you can
648 \begin_inset Flex CharStyle:Code
651 \begin_layout Plain Layout
657 box, which you can insert into your document with
658 \begin_inset Flex CharStyle:MenuItem
661 \begin_layout Plain Layout
662 Insert\SpecialChar \menuseparator
671 \begin_layout Standard
672 Here's an example of inserting LaTeX commands in a LyX document.
673 The code looks like this:
676 \begin_layout LyX-Code
680 \begin_inset Newline newline
686 \begin_inset Newline newline
689 This is an example for a minipage environment.
691 \begin_inset Newline newline
694 can put nearly everything in it, even (non-floating)
695 \begin_inset Newline newline
700 \begin_inset Newline newline
706 \begin_inset Newline newline
710 \begin_inset Newline newline
716 \begin_inset Newline newline
722 \begin_inset Newline newline
728 \begin_inset Newline newline
733 \begin_inset Newline newline
739 \begin_inset Newline newline
745 \begin_inset Newline newline
751 \begin_inset Newline newline
759 \begin_layout LyX-Code
763 \begin_layout Standard
765 \begin_inset Flex CharStyle:Code
768 \begin_layout Plain Layout
774 box containing this text is directly after this paragraph.
775 Those of you reading the manual in LyX will only see the TeX code inset.
776 Those reading a printed version of the manuals will see the actual results:
779 \begin_layout Standard
783 \begin_layout Plain Layout
790 \begin_layout Plain Layout
797 \begin_layout Plain Layout
799 This is an example for a minipage environment.
800 You can put nearly everything in it, even (non-floating) figures and tables.
804 \begin_layout Plain Layout
811 \begin_layout Plain Layout
816 \begin_layout Plain Layout
823 \begin_layout Plain Layout
830 \begin_layout Plain Layout
837 \begin_layout Plain Layout
843 \begin_layout Plain Layout
850 \begin_layout Plain Layout
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
876 \begin_layout Standard
877 In addition to using TeX code, you can also create a separate file containing
878 some complex LaTeX structure and then use
879 \begin_inset Flex CharStyle:MenuItem
882 \begin_layout Plain Layout
883 Insert\SpecialChar \menuseparator
893 to include your file (you should select the type
894 \begin_inset Flex CharStyle:Code
897 \begin_layout Plain Layout
904 We recommend that you only do this if you have a
905 \begin_inset Flex CharStyle:Code
908 \begin_layout Plain Layout
919 Otherwise, you'll have a big job tracking down LaTeX errors.
922 \begin_layout Standard
923 There are a few last points to emphasize:
926 \begin_layout Itemize
931 check if your LaTeX code is correct.
934 \begin_layout Itemize
935 Beware reinventing the wheel.
938 \begin_layout Standard
939 On that last point, LyX does have quite a few features tucked into it, and
941 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
942 feature before you decide you have to do it by hand.
943 Moreover, there are numerous LaTeX packages out there to do all sorts of
944 things, from labels to envelopes to fancy multipage tables.
946 \begin_inset CommandInset href
949 target "http://www.ctan.org/"
953 for details, and see chapter
954 \begin_inset CommandInset ref
956 reference "cha:secrets"
963 \begin_layout Standard
964 If you do need to do some wild and fancy things within your document, be
965 sure to check out a good LaTeX book for assistance.
966 There are a number of them listed in the bibliography of the
973 \begin_layout Section
974 LyX and the LaTeX Preamble
977 \begin_layout Subsection
978 About the LaTeX Preamble
981 \begin_layout Standard
982 If you already know LaTeX, there is no need to explain here what the preamble
984 If you don't, the following will give you some ideas—we recommend again
985 that you consult a LaTeX book for further information.
986 In any case, you should read the points below, because they explain what
987 you can do and what you don't need to do in the LaTeX preamble of a LyX
991 \begin_layout Standard
992 The LaTeX preamble comes at the very beginning of a document,
1000 \begin_layout Itemize
1001 Declare the document class.
1003 \begin_inset Newline newline
1006 LyX already does this for you.
1007 If you're a seasoned LaTeX-nician, and you have a custom document class
1008 you want to use, check out the
1010 Customization Manual
1012 for information on how to make LyX interface to it.
1015 \begin_layout Itemize
1016 Declare the usage of packages.
1018 \begin_inset Newline newline
1021 LaTeX packages provide special commands, which are only available within
1022 a document when the package has been declared in the preamble.
1023 For example, the package
1024 \begin_inset Flex CharStyle:Code
1027 \begin_layout Plain Layout
1033 forces all paragraphs to be indented.
1034 There are other packages for labels, envelopes, margins, etc.
1038 \begin_layout Itemize
1039 Set counters, variables, lengths and widths.
1041 \begin_inset Newline newline
1044 There are several LaTeX counters and variables which
1048 be set globally from within the preamble in order to have the desired effect.
1049 (There are variables which you can set and reset inside the document, too.)
1050 Margins are a good example of something which must be set in the preamble.
1051 Another example is the label format for lists.
1052 You can actually set these just about anywhere, but it's best to do it
1053 just once, inside the preamble.
1056 \begin_layout Itemize
1057 Declare user defined commands (with
1058 \begin_inset Flex CharStyle:Code
1061 \begin_layout Plain Layout
1070 \begin_inset Flex CharStyle:Code
1073 \begin_layout Plain Layout
1082 \begin_inset Newline newline
1085 These are abbreviations for LaTeX commands which appear very often inside
1087 Although the preamble is a good place to declare such commands, they
1091 be declared anywhere (before they are used for the first time, of course).
1092 This can be useful if there is a lot of raw LaTeX code in your document,
1093 which normally should not be the case.
1096 \begin_layout Standard
1097 LyX adds its own set of definitions to the preamble of the
1098 \begin_inset Flex CharStyle:Code
1101 \begin_layout Plain Layout
1108 This makes LaTeX files generated by LyX portable.
1111 \begin_layout Subsection
1112 Changing the Preamble
1115 \begin_layout Standard
1116 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1117 can't change them without patching LyX itself.
1118 You can, however, add your own stuff to the preamble by selecting
1119 \begin_inset Flex CharStyle:MenuItem
1122 \begin_layout Plain Layout
1124 \begin_inset space ~
1133 \begin_inset Flex CharStyle:MenuItem
1136 \begin_layout Plain Layout
1137 Document\SpecialChar \menuseparator
1144 LyX adds anything in the
1145 \begin_inset Flex CharStyle:MenuItem
1148 \begin_layout Plain Layout
1154 dialog to its own built-in preamble.
1155 Before adding your own declarations in the preamble, you should make sure
1156 that LyX doesn't already support what you want to do.
1157 (Remember what we said about reinventing the wheel?) Also,
1159 make sure your preamble code is correct
1162 LyX doesn't check it for you.
1163 If there is an error, you're likely to get an error like
1164 \begin_inset Quotes eld
1168 \begin_inset Flex CharStyle:Code
1171 \begin_layout Plain Layout
1180 \begin_inset Quotes erd
1184 If you see this error, check your preamble.
1187 \begin_layout Subsection
1191 \begin_layout Standard
1192 Here are some examples of what you can add to a preamble, and what they
1196 \begin_layout Subsubsection
1200 \begin_layout Standard
1201 There are two variables under LaTeX that control page position:
1202 \begin_inset Flex CharStyle:Code
1205 \begin_layout Plain Layout
1214 \begin_inset Flex CharStyle:Code
1217 \begin_layout Plain Layout
1226 Their names should be self-explanatory.
1227 These variables are useful if you think for a moment about computer labels.
1228 Sometimes, the size of a print medium and the area of the medium that you
1229 can actually print on aren't the same.
1231 \begin_inset Flex CharStyle:Code
1234 \begin_layout Plain Layout
1243 \begin_inset Flex CharStyle:Code
1246 \begin_layout Plain Layout
1257 \begin_layout Standard
1258 The default values for
1259 \begin_inset Flex CharStyle:Code
1262 \begin_layout Plain Layout
1271 \begin_inset Flex CharStyle:Code
1274 \begin_layout Plain Layout
1283 \begin_inset space \thinspace{}
1287 \begin_inset space \thinspace{}
1291 \begin_inset space \space{}
1294 the page isn't shifted.
1295 Unfortunately, some DVI drivers always seem to shift the page.
1296 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1297 If you're using LyX on a system that you don't personally maintain, and
1298 your sysadmin is a doofus,
1299 \begin_inset Flex CharStyle:Code
1302 \begin_layout Plain Layout
1311 \begin_inset Flex CharStyle:Code
1314 \begin_layout Plain Layout
1323 Suppose you're left and top margins are always 0.5
1324 \begin_inset space \thinspace{}
1328 You can add this to the preamble:
1331 \begin_layout LyX-Code
1339 \begin_layout LyX-Code
1347 \begin_layout Standard
1348 and your margins should now be correct.
1351 \begin_layout Subsubsection
1355 \begin_layout Standard
1356 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1357 There's a rather nice package, available at your nearest CTAN archive,
1358 for printing sheets of labels:
1359 \begin_inset Flex CharStyle:Code
1362 \begin_layout Plain Layout
1369 Now, your system may not have this package installed by default.
1370 We leave that up to you to check.
1371 You'll also want to read the documentation for it; we're not going to do
1373 Since this is an example, however, we'll give you an example of how you
1377 \begin_layout Standard
1378 First, make sure you're using the
1379 \begin_inset Flex CharStyle:Code
1382 \begin_layout Plain Layout
1389 Next, you need to put the following in your preamble:
1392 \begin_layout LyX-Code
1398 \begin_layout LyX-Code
1404 \begin_layout LyX-Code
1410 \begin_layout LyX-Code
1416 \begin_layout LyX-Code
1422 \begin_layout LyX-Code
1428 \begin_layout LyX-Code
1434 \begin_layout Standard
1435 This sets things up for Avery label sheets, stock #5360.
1436 You're now ready to print labels, but you'll need to insert LaTeX code,
1437 placing the commands
1438 \begin_inset Flex CharStyle:Code
1441 \begin_layout Plain Layout
1450 \begin_inset Flex CharStyle:Code
1453 \begin_layout Plain Layout
1461 around each label text.
1462 This and other special features of
1463 \begin_inset Flex CharStyle:Code
1466 \begin_layout Plain Layout
1472 are explained in its documentation.
1475 \begin_layout Standard
1476 Someday, someone may write a LyX layout file to support this package directly.
1477 Maybe that someone is you.
1480 \begin_layout Subsubsection
1481 Example #3: Paragraph Indentation
1484 \begin_layout Standard
1485 Americans are trained to indent the first line of
1490 As with all of their other weird quirks, most Americans will whine and
1491 moan until they can have their way and indent the first line of all paragraphs.
1500 \begin_layout Standard
1501 Of course, this behavior isn't standard typography.
1502 In books, you typically only indent the first line of a paragraph
1506 it follows another one.
1507 The idea behind indenting the first line of a paragraph is to distinguish
1508 neighboring paragraphs from one another.
1509 If there is no previous paragraph—for example, if it follows a figure or
1510 is the first paragraph in a section—then there is no need for indentation.
1514 \begin_layout Standard
1515 If you're a typical American (we're still joking!), though, you don't care
1516 about such esoteric things; you want your indentation! Add this to the
1520 \begin_layout LyX-Code
1523 usepackage{indentfirst}
1526 \begin_layout Standard
1527 If your TeX distribution isn't braindead, you'll have this package, and
1528 all of your paragraphs will get the indentation the Founding Fathers intended
1532 \begin_layout Subsubsection
1533 Example #4: This Document
1536 \begin_layout Standard
1537 You can also check out the preamble of this document to get an idea of some
1538 of the advanced things you can do.
1539 Also, there are more examples and an assortment of LaTeX
1540 \begin_inset Quotes eld
1544 \begin_inset Quotes erd
1548 \begin_inset space ~
1552 \begin_inset CommandInset ref
1554 reference "cha:secrets"
1562 \begin_layout Section
1563 LyX and LaTeX Errors
1566 \begin_layout Standard
1567 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1569 It then uses the logfile from the LaTeX run to do a post-mortem.
1570 After analyzing the logfile,LyX displays a dialog listing the errors.
1571 Clicking on any one of them will take you to the position in your LyX file
1572 where the error occurred.
1576 \begin_layout Plain Layout
1578 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1580 There are also cases where LaTeX reports the error on one line, but the
1581 actual error is earlier.
1582 This is not unlike forgetting a closing brace in a program: You'll get
1583 an error, but only later.
1591 \begin_layout Standard
1592 Some folks also like to look at the log file directly: It is available from
1594 \begin_inset Flex CharStyle:MenuItem
1597 \begin_layout Plain Layout
1600 \SpecialChar \menuseparator
1604 \begin_inset space ~
1613 There are some fairly common error messages and warnings.
1614 We'll cover those here.
1615 You should look at a good LaTeX book for a complete listing.
1618 \begin_layout Itemize
1619 \begin_inset Flex CharStyle:Code
1622 \begin_layout Plain Layout
1629 \begin_inset Newline newline
1632 Anything beginning with these words is a warning message for the purpose
1634 \begin_inset Quotes eld
1638 \begin_inset Quotes erd
1641 the LaTeX code itself.
1642 You'll get messages like this if you added or changed cross-references
1643 or bibliography entries, in which case, LaTeX is trying to tell you that
1644 you need to make another run.
1645 You can by-and-large ignore these.
1648 \begin_layout Itemize
1649 \begin_inset Flex CharStyle:Code
1652 \begin_layout Plain Layout
1659 \begin_inset Newline newline
1662 Another warning message, this time about fonts which LaTeX couldn't find.
1663 The rest of the message will often say something about a replacement font
1665 You can safely ignore these, too.
1668 \begin_layout Itemize
1669 \begin_inset Flex CharStyle:Code
1672 \begin_layout Plain Layout
1681 \begin_inset Newline newline
1689 They are warnings about lines that were too long and run past the right
1691 Almost always, this is unnoticeable in the final output.
1692 (It can be just a point or two.) Or, only one or two characters extend past
1694 LaTeX seems to generate at least one of these messages for just about any
1696 \begin_inset Newline newline
1699 You can ignore these messages.
1700 Your eyes will tell you if there's a problem with something that's too
1701 wide; just look at the output.
1705 \begin_layout Plain Layout
1706 You can also enable the `draft' option in
1707 \begin_inset Flex CharStyle:MenuItem
1710 \begin_layout Plain Layout
1713 \SpecialChar \menuseparator
1721 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1729 \begin_layout Itemize
1730 \begin_inset Flex CharStyle:Code
1733 \begin_layout Plain Layout
1742 \begin_inset Newline newline
1745 Not quite as common as its cousin.
1746 LaTeX seems to like to print lines that are a bit too wide as opposed to
1747 ones that are a bit too narrow.
1748 We have no idea why.
1751 \begin_layout Itemize
1752 \begin_inset Flex CharStyle:Code
1755 \begin_layout Plain Layout
1764 \begin_inset Flex CharStyle:Code
1767 \begin_layout Plain Layout
1776 \begin_inset Newline newline
1779 Warnings about troubles breaking the page.
1780 Once again, just look at the output.
1781 Your eyes will tell you where something has gone wrong.
1784 \begin_layout Itemize
1785 \begin_inset Flex CharStyle:Code
1788 \begin_layout Plain Layout
1790 \begin_inset Quotes els
1794 \begin_inset Quotes ers
1803 \begin_inset Newline newline
1807 \begin_inset Quotes eld
1811 \begin_inset Quotes erd
1814 isn't installed on this system.
1815 This usually appears because some package your document needs isn't installed.
1816 If you didn't touch the preamble or didn't use the
1817 \begin_inset Flex CharStyle:Code
1820 \begin_layout Plain Layout
1828 command, then one of the packages LyX tried to load is missing.
1830 \begin_inset Flex CharStyle:MenuItem
1833 \begin_layout Plain Layout
1834 Help\SpecialChar \menuseparator
1840 to get a list of packages that LyX knows about.
1841 This file is updated whenever you reconfigure LyX (using
1842 \begin_inset Flex CharStyle:MenuItem
1845 \begin_layout Plain Layout
1846 Tools\SpecialChar \menuseparator
1852 ) and tells you which packages have been detected and what they do.
1853 \begin_inset Newline newline
1857 \begin_inset Flex CharStyle:Code
1860 \begin_layout Plain Layout
1868 command and the package in question isn't installed, then you'll need to
1869 install it yourself.
1872 \begin_layout Itemize
1873 \begin_inset Flex CharStyle:Code
1876 \begin_layout Plain Layout
1877 LaTeX Error: Unknown option
1883 \begin_inset Newline newline
1886 Error messages beginning with this are trying to tell you that you specified
1887 a bad or undefined option to a package.
1888 Check the package's documentation.
1891 \begin_layout Itemize
1892 \begin_inset Flex CharStyle:Code
1895 \begin_layout Plain Layout
1896 Undefined control sequence
1902 \begin_inset Newline newline
1905 If you've inserted LaTeX code into your document, but made a typo, you'll
1907 You may have forgotten to load a package.
1908 In any case, this error message usually means that you used an undefined
1913 \begin_layout Standard
1914 There are other error and warning messages.
1915 Some are self-explanatory.
1916 These are usually LaTeX messages.
1917 Others are downright cryptic.
1918 These are usually TeX error messages, and we really have
1922 what they mean or how to decipher them.
1926 \begin_layout Standard
1927 There's a general sequence you should follow if you get error messages:
1930 \begin_layout Enumerate
1931 Look at the LaTeX code you inserted for typos.
1934 \begin_layout Enumerate
1935 If there are no typos, check that you used the command(s) correctly.
1938 \begin_layout Enumerate
1939 If you get a bunch of error boxes piled up at the very top of the document—and
1940 especially if you see a
1941 \begin_inset Quotes eld
1945 \begin_inset Flex CharStyle:Code
1948 \begin_layout Plain Layout
1957 \begin_inset Quotes erd
1960 error—it means that there are errors in the preamble.
1961 Start debugging your preamble.
1964 \begin_layout Enumerate
1965 If you didn't add anything to the preamble and didn't add any LaTeX code
1966 to the document, the first suspect is your LaTeX distribution itself.
1967 Check for missing packages and install them.
1970 \begin_layout Enumerate
1971 Okay, so there are no missing packages.
1972 Did you use any of the fine-tuning options in LyX? Specifically, did you
1977 any of them, like trying to manually insert lots of
1978 \begin_inset Flex CharStyle:Code
1981 \begin_layout Plain Layout
1983 \begin_inset space ~
1992 \begin_inset Flex CharStyle:Code
1995 \begin_layout Plain Layout
2002 \begin_inset Flex CharStyle:Code
2005 \begin_layout Plain Layout
2011 ? Did you try to kludge something together with these instead of using the
2012 appropriate paragraph environment?
2015 \begin_layout Enumerate
2016 All right, you didn't use any of the fine-tuning options, you played by
2018 Did you try to pull a fancy maneuver? Did you do something funky inside
2019 a table or an equation, like inserting a graphic into a table cell?
2022 \begin_layout Enumerate
2023 Do you have long sections of text where LaTeX cannot find a place to break
2024 a line? By default, LaTeX is rather strict about how much extra inter-word
2025 spacing it will add in order to break a line.
2026 Preferably, you should rework the paragraph to avoid the problem.
2027 If this isn't an option, you can wrap your text in
2028 \begin_inset Flex CharStyle:Code
2031 \begin_layout Plain Layout
2039 to make LaTeX's line breaking more, well, sloppy.
2042 \begin_layout Enumerate
2043 Did you go overboard with the nesting? LyX (currently) doesn't check to
2044 make sure you're in the limits for nesting environments.
2045 If you nested a bunch of environments to the
2046 \begin_inset Formula $17^{\mathrm{th}}
2050 level, that's the problem.
2051 (The limit in LaTeX is five.)
2054 \begin_layout Enumerate
2055 Okay, you didn't get any error messages, but your output looks awful.
2056 If you have a table or figure that's too wide or long for the page, you
2061 \begin_layout Enumerate
2062 rescale the figure so it fits.
2065 \begin_layout Enumerate
2066 trim down the table so it fits.
2070 \begin_layout Enumerate
2071 If something else is wrong with the output, and you didn't try to pull anything
2072 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2075 \begin_layout Standard
2076 If all this doesn't help—well, then
2080 you might have found a bug in LyX\SpecialChar \ldots{}
2084 \begin_layout Chapter
2088 \begin_layout Section
2089 Customizing Bibliographies with BibTeX
2092 \begin_layout Standard
2093 The basics how to use BibTeX are explained in section
2095 Bibliography databases (BibTeX)
2102 The following subsections explain special bibliography features supported
2106 \begin_layout Subsection
2107 Alternative Citation Styles
2110 \begin_layout Standard
2111 Standard BibTeX uses numbers (e.
2112 \begin_inset space \thinspace{}
2116 \begin_inset space \space{}
2120 \begin_inset Quotes eld
2124 \begin_inset Quotes erd
2127 ) to refer to a cited work.
2128 However, in many scientific disciplines, other citation styles are in use.
2129 The most common one is the author-year style (e.
2130 \begin_inset space \thinspace{}
2134 \begin_inset space \space{}
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2146 LyX supports two packages that provide this style,
2147 \begin_inset Flex CharStyle:Code
2150 \begin_layout Plain Layout
2157 \begin_inset Flex CharStyle:Code
2160 \begin_layout Plain Layout
2167 Both packages have their pros and cons, which cannot be listed in detail.
2168 If you only want to have simple author-year (or author-numerical) style,
2169 or if you want to use one of the countless style files for
2170 \begin_inset Flex CharStyle:Code
2173 \begin_layout Plain Layout
2179 , than the established
2180 \begin_inset Flex CharStyle:Code
2183 \begin_layout Plain Layout
2189 package is probably your choice.
2190 If you need special features like short title references, ibidem etc., you
2192 \begin_inset Flex CharStyle:Code
2195 \begin_layout Plain Layout
2204 \begin_layout Standard
2205 The handling of both packages in LyX is basically the same.
2207 \begin_inset Flex CharStyle:MenuItem
2210 \begin_layout Plain Layout
2211 Document\SpecialChar \menuseparator
2218 \begin_inset Flex CharStyle:MenuItem
2221 \begin_layout Plain Layout
2228 \begin_inset Flex CharStyle:MenuItem
2231 \begin_layout Plain Layout
2238 \begin_inset Flex CharStyle:MenuItem
2241 \begin_layout Plain Layout
2248 With both packages, you will get some extra features in the citation dialog
2249 and you can select the style of the reference (
2250 \begin_inset Quotes eld
2254 \begin_inset Quotes erd
2258 \begin_inset Quotes eld
2262 \begin_inset Quotes erd
2266 \begin_inset Quotes eld
2270 \begin_inset Quotes erd
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2282 Note that both packages need specifically designed style files.
2283 They both ship their own, but there are lots of additional style files,
2284 and there is even an interactive style file builder
2288 \begin_layout Plain Layout
2290 \begin_inset Flex URL
2293 \begin_layout Plain Layout
2295 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2306 \begin_inset Flex CharStyle:Code
2309 \begin_layout Plain Layout
2318 \begin_layout Subsection
2319 Sectioned Bibliographies
2322 \begin_layout Standard
2323 Sometimes you might need to divide your bibliography into several sections.
2324 If you are for instance a historian, the possibility to separate sources
2325 and scientific works is most likely a
2326 \begin_inset Quotes eld
2330 \begin_inset Quotes erd
2334 Unfortunately, BibTeX itself does not allow you to do this.
2335 But with the help of some LaTeX packages, BibTeX can be extended to fit
2339 \begin_layout Standard
2340 LyX provides native support for one of these packages,
2348 \begin_layout Plain Layout
2350 \begin_inset Flex URL
2353 \begin_layout Plain Layout
2355 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2365 The advantage of this package (compared to other packages like
2369 ) is that you don't need to define new citation commands.
2370 Instead, you need to prepare different bibliographic databases which include
2371 the entries for the different sections of the bibliography.
2372 For example: If you want to divide your bibliography into the sections
2374 \begin_inset Quotes eld
2378 \begin_inset Quotes erd
2382 \begin_inset Quotes eld
2386 \begin_inset Quotes erd
2389 , you first need to create two bibliographic databases, e.
2390 \begin_inset space \thinspace{}
2394 \begin_inset space \space{}
2398 \begin_inset Flex CharStyle:Code
2401 \begin_layout Plain Layout
2408 \begin_inset Flex CharStyle:Code
2411 \begin_layout Plain Layout
2421 \begin_layout Standard
2423 \begin_inset Flex CharStyle:MenuItem
2426 \begin_layout Plain Layout
2427 Document\SpecialChar \menuseparator
2434 \begin_inset Flex CharStyle:MenuItem
2437 \begin_layout Plain Layout
2444 \begin_inset Flex CharStyle:MenuItem
2447 \begin_layout Plain Layout
2448 Sectioned bibliography
2454 Now you can insert multiple BibTeX bibliographies, one for each section
2455 of your bibliography.
2456 Returning to our example: Insert the BibTeX bibliography
2457 \begin_inset Flex CharStyle:Code
2460 \begin_layout Plain Layout
2466 and a second one for the database
2467 \begin_inset Flex CharStyle:Code
2470 \begin_layout Plain Layout
2477 You are free to use the same or different styles for each section.
2478 Additionally, you can chose if the bibliography section should contain
2480 \begin_inset Quotes eld
2483 all cited references
2484 \begin_inset Quotes erd
2487 of the specified database(s) (which is the default),
2488 \begin_inset Quotes eld
2491 all uncited references
2492 \begin_inset Quotes erd
2496 \begin_inset Quotes eld
2500 \begin_inset Quotes erd
2504 This might be useful if you would like to separate your bibliography into
2506 \begin_inset Quotes eld
2510 \begin_inset Quotes erd
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 The titles for the sections can be added as ordinary sections or subsections.
2532 \begin_inset Flex CharStyle:Code
2535 \begin_layout Plain Layout
2541 removes the bibliography title, you have manually re-add that, too (as
2542 a chapter* or section*, for instance).
2545 \begin_layout Subsection
2546 Multiple Bibliographies
2549 \begin_layout Standard
2550 Multiple bibliographies, e.
2551 \begin_inset space \thinspace{}
2555 \begin_inset space \space{}
2558 a bibliography for each section or chapter of the document, are not supported
2561 \begin_inset Flex CharStyle:Code
2564 \begin_layout Plain Layout
2570 package, which is used for the creation of sectioned bibliographies in
2571 LyX (see the previous section), provides an easy way to solve this task,
2572 if you are willing to use some
2573 \begin_inset Flex CharStyle:MenuItem
2576 \begin_layout Plain Layout
2583 \begin_inset space ~
2587 \begin_inset CommandInset ref
2589 reference "sec:Inserting-TeX-Code"
2597 \begin_layout Plain Layout
2598 An alternative approach is to use the
2599 \begin_inset Flex CharStyle:Code
2602 \begin_layout Plain Layout
2609 \begin_inset Flex CharStyle:Code
2612 \begin_layout Plain Layout
2618 package, respectively.
2626 \begin_layout Standard
2628 \begin_inset Flex CharStyle:MenuItem
2631 \begin_layout Plain Layout
2632 Document\SpecialChar \menuseparator
2639 \begin_inset Flex CharStyle:MenuItem
2642 \begin_layout Plain Layout
2649 \begin_inset Flex CharStyle:MenuItem
2652 \begin_layout Plain Layout
2653 Sectioned bibliography
2659 In the document, you have to enclose the sections, which shall contain
2660 their own bibliography (including the BibTeX bibliography itself), between
2662 \begin_inset Flex CharStyle:Code
2665 \begin_layout Plain Layout
2674 \begin_inset Flex CharStyle:Code
2677 \begin_layout Plain Layout
2685 (those commands have to be inserted as TeX code).
2686 The bibliography will contain all references which have been cited in the
2688 \begin_inset Flex CharStyle:Code
2691 \begin_layout Plain Layout
2702 If you are using this approach, then every citation reference has to be
2704 \begin_inset Flex CharStyle:Code
2707 \begin_layout Plain Layout
2715 \begin_inset Flex CharStyle:Code
2718 \begin_layout Plain Layout
2727 \begin_layout Section
2731 \begin_layout Subsection
2735 \begin_layout Standard
2736 When you are working on a large file with many sections, it is often convenient
2737 to break up the document into several files, or perhaps you have something
2738 where a table may change from time to time, but the preceding text does
2740 In these cases, you should seriously consider using multipart documents.
2741 For example, scientific papers often have five major sections: the introduction
2742 , observations, results, discussion, and conclusion.
2743 Each of these could be its own separate LyX file, with one
2744 \begin_inset Quotes eld
2748 \begin_inset Quotes erd
2751 file which contains the title, authors, abstract, references, etc., plus
2752 the five included files.
2753 It is important to note that each of these files is a full LyX file which
2754 can be formatted and printed on its own, as well as included in a master
2756 Each of these files must have the same document class, however—don't attempt
2757 to mix book classes with article classes.
2758 You may also include LaTeX files; however, these files must not have their
2760 \begin_inset space \thinspace{}
2764 \begin_inset space \space{}
2767 everything up to and including the
2768 \begin_inset Flex CharStyle:Code
2771 \begin_layout Plain Layout
2780 \begin_inset Flex CharStyle:Code
2783 \begin_layout Plain Layout
2791 line must be deleted) or else errors will be generated when you try to
2795 \begin_layout Standard
2796 LyX allows you to include files quite easily with
2797 \begin_inset Flex CharStyle:MenuItem
2800 \begin_layout Plain Layout
2801 Insert\SpecialChar \menuseparator
2803 \begin_inset space ~
2812 When you click on this selection a small box is inserted into the file
2813 at the current cursor location.
2814 Clicking on the box raises a dialog which allows you to select the file
2815 to be included, and the method of its inclusion.
2819 \begin_layout Standard
2820 The file selection box should by now be obvious.
2821 The three inclusion methods are
2822 \begin_inset Quotes eld
2826 \begin_inset Quotes erd
2830 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2846 The difference between
2847 \begin_inset Quotes eld
2851 \begin_inset Quotes erd
2855 \begin_inset Quotes eld
2859 \begin_inset Quotes erd
2862 is really only meaningful to LaTeXperts, but the practical difference is
2863 that files which are
2864 \begin_inset Quotes eld
2868 \begin_inset Quotes erd
2871 are typeset beginning on a new page, while files which are
2872 \begin_inset Quotes eld
2876 \begin_inset Quotes erd
2879 are typeset starting on the current page.
2882 \begin_layout Standard
2883 Generally, the master file is converted into a full LaTeX file before typesettin
2884 g, while the included files are converted to LaTeX files which do not have
2885 all the preamble information.
2888 \begin_layout Standard
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2897 included file allows you to include a file typeset exactly as it appears
2899 \begin_inset space \thinspace{}
2903 \begin_inset space \space{}
2907 \begin_inset Flex CharStyle:Code
2910 \begin_layout Plain Layout
2916 mode, with the characters set in a fixed-width typewriter font.
2917 Normally, spaces in this file are invisible, though two consecutive spaces
2918 are conserved, unlike LyX's normal treatment of spaces.
2919 However, setting the
2920 \begin_inset Flex CharStyle:MenuItem
2923 \begin_layout Plain Layout
2925 \begin_inset space ~
2929 \begin_inset space ~
2933 \begin_inset space ~
2941 checkbox typesets a mark to unambiguously define the presence of a space.
2945 \begin_layout Subsection
2946 Cross-References Between Files
2949 \begin_layout Standard
2950 \begin_inset Box Shadowbox
2959 height_special "totalheight"
2962 \begin_layout Plain Layout
2963 This section is somewhat out of date.
2964 Need to describe default master documents and how children are opened when
2974 \begin_layout Standard
2975 It is possible to set up cross-references between the different files.
2976 First, open all the files in question: let's call them A and B in a two
2977 file example, where B is included in A.
2978 Let's say you insert a label in A, then want to reference it in B.
2979 Open the cross-reference dialog in whilst in document B, and you can select
2981 \begin_inset Quotes eld
2985 \begin_inset Quotes erd
2991 \begin_layout Subsection
2992 Bibliography Lists in all Subdocuments
2995 \begin_layout Standard
2996 \begin_inset Box Frameless
3005 height_special "totalheight"
3008 \begin_layout Plain Layout
3009 This section also needs updating.
3010 There is now material about this on the wiki, and it could be copied here.
3018 \begin_layout Standard
3019 Copy the bibliography list with all entries to all subdocuments and transform
3021 This way LyX will find the
3022 \begin_inset Flex CharStyle:Code
3025 \begin_layout Plain Layout
3031 -files and you can easily insert references without making the bibliography
3035 \begin_layout Standard
3036 As the bibliography list is in a comment, LaTeX won't use use it and the
3037 references will look like this: [?], instead of like this: [1].
3038 One solution is to use the LaTeX-package
3039 \begin_inset Flex CharStyle:Code
3042 \begin_layout Plain Layout
3048 that will only include comments by processing the files separately.
3049 To do this, add in the LaTeX preamble of every subdocument the following:
3052 \begin_layout LyX-Code
3058 \begin_layout LyX-Code
3061 includecomment{comment}
3064 \begin_layout Standard
3066 \begin_inset Flex URL
3069 \begin_layout Plain Layout
3071 http://wiki.lyx.org/FAQ/Unsorted#toc31
3079 \begin_layout Section
3080 Fancy Headers and Footers
3083 \begin_layout Standard
3084 The default page layout is rather plain; for an
3085 \begin_inset Flex CharStyle:Code
3088 \begin_layout Plain Layout
3094 document class, all you get is a centered page number at the bottom of
3096 This document uses KOMA-script's book class, so it appears to be a bit
3098 But to really put on a show, you need to set the document page style to
3100 \begin_inset Quotes eld
3104 \begin_inset Quotes erd
3107 , as mentioned in the
3112 This section describes the LaTeX code you need to insert in your LaTeX
3113 preamble in order to get the desired effects.
3116 \begin_layout Standard
3117 For more information on fancy headers, see the
3118 \begin_inset Flex CharStyle:Code
3121 \begin_layout Plain Layout
3127 package documentation.
3128 This can be found in the file
3129 \begin_inset Flex CharStyle:Code
3132 \begin_layout Plain Layout
3138 , which should have been installed with your LaTeX distribution, or
3139 \begin_inset CommandInset href
3142 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3149 \begin_layout Standard
3150 The page header is divided into three fields, not surprisingly labeled
3151 \begin_inset Quotes eld
3155 \begin_inset Quotes erd
3159 \begin_inset Quotes eld
3163 \begin_inset Quotes erd
3167 \begin_inset Quotes eld
3171 \begin_inset Quotes erd
3175 The footer is also divided into these three fields.
3176 The LaTeX commands to set these fields in the simplest manner are
3177 \begin_inset Flex CharStyle:Code
3180 \begin_layout Plain Layout
3189 \begin_inset Flex CharStyle:Code
3192 \begin_layout Plain Layout
3201 \begin_inset Flex CharStyle:Code
3204 \begin_layout Plain Layout
3213 \begin_inset Flex CharStyle:Code
3216 \begin_layout Plain Layout
3225 Suppose you wish to put your name in the upper left hand corner of each
3227 Simply insert the following command in the preamble:
3230 \begin_layout Standard
3239 \begin_layout Standard
3240 You will now see your name in the upper left.
3241 If a field has a default entry that you would like to get rid of (often
3242 the page number appears in the central footer, simply include a command
3243 with a blank argument, e.
3244 \begin_inset space \thinspace{}
3250 \begin_layout Standard
3258 \begin_layout Standard
3259 Let's get really fancy: lets put the section number with the word
3260 \begin_inset Quotes eld
3264 \begin_inset Quotes erd
3268 \begin_inset space \thinspace{}
3272 \begin_inset space \space{}
3275 Section 3) in the upper left, the page number (e.
3276 \begin_inset space \thinspace{}
3280 \begin_inset space \space{}
3283 Page 4) in the upper right, your name in the lower left, and the date in
3285 The following commands should now appear in the preamble:
3288 \begin_layout Standard
3298 \begin_layout Standard
3306 \begin_layout Standard
3316 \begin_layout Standard
3325 \begin_layout Standard
3333 \begin_layout Standard
3343 \begin_layout Standard
3345 \begin_inset Flex CharStyle:Code
3348 \begin_layout Plain Layout
3357 \begin_inset Flex CharStyle:Code
3360 \begin_layout Plain Layout
3368 access LaTeX's section and page counters, and so print out the current
3369 section and page numbers.
3371 \begin_inset Flex CharStyle:Code
3374 \begin_layout Plain Layout
3382 simply prints out today's date.
3385 \begin_layout Standard
3386 The thicknesses of the horizontal rules drawn beneath the header and above
3387 the footer can also be modified.
3388 If you don't want one of the rules, set its thickness to 0.
3389 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3395 \begin_inset Flex CharStyle:Code
3398 \begin_layout Plain Layout
3403 headrulewidth}{0.4pt}
3409 \begin_inset Flex CharStyle:Code
3412 \begin_layout Plain Layout
3417 footrulewidth}{0.4pt}
3422 to set the thicknesses.
3425 \begin_layout Standard
3426 You can switch the header/footer settings on and off for individual pages
3428 \begin_inset Flex CharStyle:Code
3431 \begin_layout Plain Layout
3434 thispagestyle{empty}
3440 \begin_inset Flex CharStyle:Code
3443 \begin_layout Plain Layout
3446 thispagestyle{plain}
3452 \begin_inset Flex CharStyle:Code
3455 \begin_layout Plain Layout
3458 thispagestyle{fancy}
3464 Simply insert them in the text on the page you want changed and mark them
3466 In fact, title pages are marked as plain by default, while following pages
3467 are marked fancy when using the global fancy setting.
3470 \begin_layout Standard
3471 As a final example, it is possible to include an image in the header or
3473 Suppose you want to put a company logo in the upper lefthand corner.
3474 You might try something like
3477 \begin_layout Standard
3486 includegraphics{logo.eps}}}
3489 \begin_layout Standard
3491 (you may need to preface this with
3492 \begin_inset Flex CharStyle:Code
3495 \begin_layout Plain Layout
3499 usepackage{graphics}
3504 if you don't include graphics elsewhere in your document).
3507 \begin_layout Section
3508 Itemize Bullet Selection
3509 \begin_inset CommandInset label
3518 \begin_layout Standard
3524 \begin_layout Subsection
3528 \begin_layout Standard
3529 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3530 Using this dialog you can easily specify what bullet shape to use at each
3531 level of an itemized list.
3532 These settings are document-wide so you won't be able to specify different
3533 sets of bullets for different paragraphs.
3537 \begin_layout Plain Layout
3538 Well, actually you can but you'll have to do it by hand.
3546 \begin_layout Subsection
3550 \begin_layout Standard
3551 Open the dialog by selecting the
3552 \begin_inset Flex CharStyle:MenuItem
3555 \begin_layout Plain Layout
3556 Document\SpecialChar \menuseparator
3562 menu item and then select the
3563 \begin_inset Flex CharStyle:MenuItem
3566 \begin_layout Plain Layout
3575 \begin_layout Standard
3576 The dialog provides you with a table of bullet shapes.
3577 A column of buttons on the left of the table provides access to the six
3578 different panels of bullet shapes.
3579 The row of buttons across the top is used to select which bullet depth
3581 A text entry under the table shows the currently selected bullet shape's
3582 LaTeX equivalent and this can be edited if desired.
3583 If you do modify the text you will also need to specify any needed packages
3584 in the LaTeX preamble.
3587 \begin_layout Standard
3588 The six panels are divided up by the packages they require.
3589 The following table shows the mappings from button name to LaTeX packages.
3592 \begin_layout Standard
3594 \begin_inset Tabular
3595 <lyxtabular version="3" rows="7" columns="2">
3596 <features tabularvalignment="middle">
3597 <column alignment="center" valignment="top" width="0pt">
3598 <column alignment="center" valignment="top" width="0pt">
3600 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3603 \begin_layout Plain Layout
3618 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3621 \begin_layout Plain Layout
3638 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3641 \begin_layout Plain Layout
3656 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3659 \begin_layout Plain Layout
3675 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3678 \begin_layout Plain Layout
3693 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3696 \begin_layout Plain Layout
3713 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3716 \begin_layout Plain Layout
3731 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3734 \begin_layout Plain Layout
3751 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3754 \begin_layout Plain Layout
3769 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3772 \begin_layout Plain Layout
3789 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3792 \begin_layout Plain Layout
3807 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3810 \begin_layout Plain Layout
3827 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3830 \begin_layout Plain Layout
3845 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3848 \begin_layout Plain Layout
3871 \begin_layout Standard
3872 LyX doesn't stop you using bullets from packages you don't have.
3873 If you get errors from LaTeX when you try to view or print the file, then
3874 it is likely you are missing a package.
3878 \begin_layout Plain Layout
3879 LyX doesn't restrict your use since you may be editing locally and exporting
3888 \begin_layout Subsection
3892 \begin_layout Standard
3893 Select which bullet depth you want to change then select the bullet shape
3895 Any changes will not be visible in LyX, but are visible when viewing the
3899 \begin_layout Standard
3900 You can reset a bullet shape to the default simply by clicking your right
3901 mouse button on the appropriate bullet depth button.
3905 \begin_layout Plain Layout
3910 want to have multiple sets of paragraphs with different sets of bullets
3911 in each, then you're going to have to get your hands dirty with TeX code.
3912 The bullet selection dialog can help though because it provides you with
3913 the LaTeX code for a wide range of bullet shapes.
3914 To make your own custom paragraphs you have the following options:
3917 \begin_layout Plain Layout
3921 \begin_layout Plain Layout
3937 \begin_layout Plain Layout
3941 \begin_layout Plain Layout
3963 \begin_layout Itemize
3964 Use the LaTeX command
3965 \begin_inset Flex CharStyle:Code
3968 \begin_layout Plain Layout
3976 to specify a new bullet shape for a given depth.
3977 You'll also need to save the current bullet shape so you can restore it
3979 In this itemized list the following LaTeX code was used to change the bullet
3980 used for the first depth.
3984 \begin_layout LyX-Code
3994 \begin_layout LyX-Code
4011 \begin_layout Itemize
4012 Note that the itemize depth is specified in Roman numerals as part of the
4022 \begin_layout Itemize
4026 \begin_layout Plain Layout
4039 Specify each individual entry by starting each item with the bullet shape
4040 enclosed in square brackets and set as
4041 \begin_inset Flex CharStyle:MenuItem
4044 \begin_layout Plain Layout
4051 For example, this item was started with
4052 \begin_inset Flex CharStyle:Code
4055 \begin_layout Plain Layout
4070 \begin_layout Plain Layout
4074 \begin_layout Plain Layout
4090 \begin_layout Plain Layout
4091 You'll also need to revert the labelitem back to its previous setting for
4092 the global bullet shape settings to remain in effect.
4093 The way used here was:
4096 \begin_layout LyX-Code
4111 \begin_layout Chapter
4115 \begin_layout Section
4119 \begin_layout Standard
4120 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4121 and retrieve information about the LyX internal state.
4122 This is only intended for advanced users, but they should find it useful.
4123 It is by writing to the LyX server, for example, that bibliography managers,
4124 such as JabRef, are able to
4125 \begin_inset Quotes eld
4129 \begin_inset Quotes erd
4135 \begin_layout Standard
4136 Please note that, at present,
4138 the server does not work natively on Windows
4144 \begin_layout Plain Layout
4145 There is no reason it cannot do so.
4146 But none of the developers on Windows have yet implemented this functionality
4152 but it does work with Cygwin versions of LyX.
4155 \begin_layout Section
4156 Starting the LyX Server
4159 \begin_layout Standard
4160 The LyX server works through the use of a pair of named pipes.
4161 These are usually located in
4162 \begin_inset Flex CharStyle:Code
4165 \begin_layout Plain Layout
4172 \begin_inset Quotes eld
4176 \begin_inset Flex CharStyle:Code
4179 \begin_layout Plain Layout
4186 \begin_inset Quotes erd
4190 \begin_inset Quotes eld
4194 \begin_inset Flex CharStyle:Code
4197 \begin_layout Plain Layout
4204 \begin_inset Quotes erd
4208 External programs write into
4209 \begin_inset Flex CharStyle:Code
4212 \begin_layout Plain Layout
4218 and read back data from
4219 \begin_inset Flex CharStyle:Code
4222 \begin_layout Plain Layout
4229 The stem of the pipe names can be defined in the
4230 \begin_inset Flex CharStyle:MenuItem
4233 \begin_layout Plain Layout
4234 Tools\SpecialChar \menuseparator
4241 \begin_inset Flex CharStyle:Code
4244 \begin_layout Plain Layout
4245 "/home/myhome/lyxpipe"
4255 configure this manually in order for the server to start.
4258 \begin_layout Standard
4260 \begin_inset Flex CharStyle:Code
4263 \begin_layout Plain Layout
4270 \begin_inset Flex CharStyle:Code
4273 \begin_layout Plain Layout
4279 ' to create the pipes.
4280 If one of the pipes already exists, LyX will assume that another LyX process
4281 is already running and will not start the server.
4282 If for some other reason, an unused
4283 \begin_inset Quotes eld
4287 \begin_inset Quotes erd
4290 pipe is left in existence when LyX closes, then LyX will try to delete
4292 If this fails for some reason, you will need to delete the pipes manually
4293 and then restart LyX.
4296 \begin_layout Standard
4297 To have several LyX processes with servers at the same time, you have to
4298 use different configurations, perhaps by using separate user directories,
4300 \begin_inset Flex CharStyle:Code
4303 \begin_layout Plain Layout
4309 file, for each process.
4312 \begin_layout Standard
4313 If you are developing a client program, you might find it useful to enable
4314 debugging information from the LyX server.
4315 Do this by starting LyX as
4316 \begin_inset Flex CharStyle:Code
4319 \begin_layout Plain Layout
4328 \begin_layout Standard
4329 You can find a complete example client written in C in the source distribution
4331 \begin_inset Flex CharStyle:Code
4334 \begin_layout Plain Layout
4335 development/lyxserver/server_monitor.c
4343 \begin_layout Standard
4344 Another useful tool is command-line based client you will find in
4345 \begin_inset Flex CharStyle:Code
4348 \begin_layout Plain Layout
4349 src/client/lyxclient
4357 \begin_layout Section
4358 Normal communication
4361 \begin_layout Standard
4362 To issue a LyX call, the client writes a line of ASCII text into the input
4364 This line has the following format:
4381 \begin_layout Description
4382 clientname is a name that the client can choose arbitrarily.
4383 Its only use is that LyX will echo it if it sends an answer—so a client
4384 can dispatch results from different requesters.
4387 \begin_layout Description
4388 function is the function you want LyX to perform.
4389 It is the same as the commands you'd use in the minibuffer.
4392 \begin_layout Description
4393 argument is an optional argument which is meaningful only to some functions
4395 \begin_inset Quotes eld
4399 \begin_inset Quotes erd
4402 LFUN will insert the argument as text at the cursor position).
4405 \begin_layout Standard
4406 The answer from LyX will arrive in the output pipe and be of the form
4423 \begin_layout Standard
4432 are just echoed from the command request, while
4436 is more or less useful information filled according to how the command
4437 execution worked out.
4438 Some commands, such as
4439 \begin_inset Quotes eld
4443 \begin_inset Quotes erd
4446 , will return information about the internal state of LyX, while other will
4447 return an empty data-response.
4448 This means that the command execution went fine.
4451 \begin_layout Standard
4452 In case of errors, the response from LyX will have this form
4469 \begin_layout Standard
4474 should contain an explanation of why the command failed.
4477 \begin_layout Standard
4481 \begin_layout LyX-Code
4482 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4483 \begin_inset Newline newline
4486 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4487 \begin_inset Newline newline
4490 read a <~/.lyxpipe.out
4491 \begin_inset Newline newline
4497 \begin_layout Section
4501 \begin_layout Standard
4502 LyX can notify clients of events going on asynchronously.
4503 Currently it will only do this if the user binds a key sequence with the
4505 \begin_inset Quotes eld
4509 \begin_inset Quotes erd
4513 The format of the string LyX sends is as follows:
4517 \begin_inset Flex CharStyle:Code
4520 \begin_layout Plain Layout
4531 \begin_layout Standard
4536 is the printed representation of the key sequence that was actually typed
4540 \begin_layout Standard
4541 This mechanism can be used to extend LyX's command set and implement macros.
4542 Bind some key sequence to
4543 \begin_inset Quotes eld
4547 \begin_inset Quotes erd
4551 Then start a client that listens on the output pipe, dispatches the command
4552 according to the sequence, and starts a function that may use LyX calls
4553 and LyX requests to issue a command or a series of commands to LyX.
4556 \begin_layout Section
4557 The simple LyX Server Protocol
4560 \begin_layout Standard
4561 LyX implements a simple protocol that can be used for session management.
4562 All messages are of the form
4575 \begin_layout Standard
4581 \begin_inset Quotes eld
4585 \begin_inset Quotes erd
4589 \begin_inset Quotes eld
4593 \begin_inset Quotes erd
4598 \begin_inset Quotes eld
4602 \begin_inset Quotes erd
4605 is received from a client, LyX will report back to inform the client that
4606 it's listening to it's messages, while
4607 \begin_inset Quotes eld
4611 \begin_inset Quotes erd
4614 sent from LyX will inform clients that LyX is closing.
4617 \begin_layout Section
4618 Reverse DVI/PDF search
4621 \begin_layout Standard
4622 Some DVI/PDF viewers
4626 \begin_layout Plain Layout
4627 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
4628 Skim on Mac OSX and SumatraPDF on Windows.
4637 facility (also called
4642 This means that you can tell LyX to put the cursor to a specific line in
4643 the document by clicking at the respective position in the DVI/PDF output.
4644 To achieve this, the viewer must be able to communicate with LyX.
4645 This is done via the LyX server either by using the named pipe (
4649 ), or the UNIX domain socket (
4653 ) that LyX creates in its temporary directory (this is the way the
4654 \begin_inset Flex CharStyle:Code
4657 \begin_layout Plain Layout
4663 program communicates with LyX).
4664 In some cases, you need a helper script that mediates between the viewer
4665 and LyX, in others, the viewer can communicate with LyX directly.
4666 This depends on the selected viewer and on your operating system.
4667 The same applies to the way viewers need to be configured and the way the
4668 reverse search is actually performed.
4669 In what follows, we will thus describe how to setup reverse search for
4671 Before we turn to this, though, we will explain what needs to be done generally
4672 to enable reverse search in the DVI/PDF output.
4675 \begin_layout Subsection
4676 Enabling reverse search
4679 \begin_layout Standard
4680 LaTeX provides several different methods for reverse search.
4681 Some are built-in in the
4682 \begin_inset Flex CharStyle:Code
4685 \begin_layout Plain Layout
4691 program, some are provided by external packages.
4692 Your choice depends on whether your LaTeX distribution already provides
4693 a given method (the built-in methods are rather new) and whether your viewer
4695 The available methods are described in the following.
4698 \begin_layout Subsubsection*
4699 Built-in DVI-search via src-specials (DVI only)
4702 \begin_layout Standard
4703 This method provides the DVI file with the necessary information for reverse
4705 It is available in LaTeX since quite some time (any somewhat recent LaTeX
4706 distribution should include it), and it works reliably.
4707 To enable it, change the
4708 \begin_inset Flex CharStyle:MenuItem
4711 \begin_layout Plain Layout
4716 \begin_layout Plain Layout
4729 \begin_inset Flex CharStyle:MenuItem
4732 \begin_layout Plain Layout
4737 \begin_layout Plain Layout
4744 eX (plain)->DraftDVI
4750 \begin_inset Flex CharStyle:MenuItem
4753 \begin_layout Plain Layout
4754 Preferences\SpecialChar \menuseparator
4755 File Handling\SpecialChar \menuseparator
4762 \begin_inset Flex CharStyle:Code
4765 \begin_layout Plain Layout
4766 latex -src-specials $$i
4772 If this doesn't work, check if your TeX engine needs different options
4773 (the syntax might differ in some distributions).
4776 \begin_layout Subsubsection*
4777 External Packages (PDFSync and scrltx)
4780 \begin_layout Standard
4789 provide reverse search facility for PDF output (via pdflatex) and DVI output,
4791 In order to enable it, load the packages in the LyX preamble:
4794 \begin_layout Itemize
4795 \begin_inset Flex CharStyle:Code
4798 \begin_layout Plain Layout
4806 for reverse PDF search,
4809 \begin_layout Itemize
4811 \begin_inset Flex CharStyle:Code
4814 \begin_layout Plain Layout
4817 usepackage[active]{srcltx}
4822 for reverse DVI search.
4825 \begin_layout Standard
4826 If you want to be able to perform both DVI and PDF reverse searches, you
4827 can also insert in the preamble the following lines
4830 \begin_layout LyX-Code
4834 \begin_inset Newline newline
4840 \begin_inset Newline newline
4846 \begin_inset Newline newline
4852 \begin_inset Newline newline
4857 usepackage[active]{srcltx}
4858 \begin_inset Newline newline
4866 \begin_layout Standard
4867 This way, you can preview the file as either DVI or PDF (pdflatex) and the
4868 right package will be used.
4871 \begin_layout Standard
4872 Note that PDFSync might affect the output layout of your document.
4873 It is therefore advised to disable PDFsync for final documents.
4876 \begin_layout Subsubsection*
4877 Built-in reverse search via SyncTeX (DVI and PDF)
4880 \begin_layout Standard
4882 \begin_inset Flex CharStyle:Code
4885 \begin_layout Plain Layout
4891 have built-in support for both PDF and DVI reverse search.
4896 facility is basically the result of the integration of the PDFSync package
4897 to the pdftex program and its merge with the
4902 You need at least TeXLive 2008 or a recent MikTeX distribution in order
4904 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
4905 already provide SyncTeX support.
4908 \begin_layout Standard
4909 To enable SyncTeX for DVI output, change the
4910 \begin_inset Flex CharStyle:MenuItem
4913 \begin_layout Plain Layout
4918 \begin_layout Plain Layout
4931 \begin_inset Flex CharStyle:MenuItem
4934 \begin_layout Plain Layout
4939 \begin_layout Plain Layout
4946 eX (plain) -> DraftDVI
4952 \begin_inset Flex CharStyle:MenuItem
4955 \begin_layout Plain Layout
4956 Preferences\SpecialChar \menuseparator
4957 File Handling\SpecialChar \menuseparator
4964 \begin_inset Flex CharStyle:Code
4967 \begin_layout Plain Layout
4968 latex -synctex=1 $$i
4973 , and for PDF output, change the
4974 \begin_inset Flex CharStyle:MenuItem
4977 \begin_layout Plain Layout
4982 \begin_layout Plain Layout
4989 eX (pdflatex) -> PDF (pdflatex)
4995 \begin_inset Flex CharStyle:Code
4998 \begin_layout Plain Layout
4999 pdflatex -synctex=1 $$i
5005 Check the documentation of your viewer whether the viewer needs to be configure
5006 d for the use with SyncTeX.
5010 \begin_layout Plain Layout
5012 \begin_inset Flex CharStyle:Code
5015 \begin_layout Plain Layout
5021 option enables gzip compression.
5022 If your viewer does not support it, you should instead use
5023 \begin_inset Flex CharStyle:Code
5026 \begin_layout Plain Layout
5040 \begin_layout Subsection
5041 Configuring and using specific viewers
5044 \begin_layout Subsubsection*
5045 Xdvi (all platforms)
5048 \begin_layout Standard
5050 \begin_inset Flex CharStyle:Code
5053 \begin_layout Plain Layout
5059 , you don't need to do anything else for performing a reverse DVI search,
5060 as LyX already provides the necessary hooks for automatically using the
5062 \begin_inset Flex CharStyle:Code
5065 \begin_layout Plain Layout
5072 Just setup your document as described above (reverse search is triggered
5073 by Ctrl-click or Alt-click on Mac OSX, respectively).
5076 \begin_layout Standard
5077 However, if for whatever reason you want to use the named pipe instead of
5078 the socket for communicating with LyX, simply change the DVI viewer in
5080 \begin_inset Flex CharStyle:MenuItem
5083 \begin_layout Plain Layout
5084 Preferences\SpecialChar \menuseparator
5085 File Handling\SpecialChar \menuseparator
5095 \begin_layout Plain Layout
5096 On Mac OSX you have to use
5097 \begin_inset Flex CharStyle:Code
5100 \begin_layout Plain Layout
5101 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5112 \begin_inset Flex CharStyle:Code
5115 \begin_layout Plain Layout
5116 xdvi -editor 'lyxeditor.sh %f %l'
5122 \begin_inset Flex CharStyle:Code
5125 \begin_layout Plain Layout
5131 is a suitable script.
5132 For example, a minimal shell script is the following one:
5135 \begin_layout LyX-Code
5137 \begin_inset Newline newline
5140 LYXPIPE="/path/to/lyxpipe"
5141 \begin_inset Newline newline
5144 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5145 \begin_inset Newline newline
5148 echo "$COMMAND" > "${LYXPIPE}".in || exit
5149 \begin_inset Newline newline
5152 read < "${LYXPIPE}".out || exit
5155 \begin_layout Standard
5157 \begin_inset Flex CharStyle:Code
5160 \begin_layout Plain Layout
5170 \begin_layout Plain Layout
5177 XServer pipe path specified in
5178 \begin_inset Flex CharStyle:MenuItem
5181 \begin_layout Plain Layout
5182 Preferences\SpecialChar \menuseparator
5192 \begin_layout Plain Layout
5194 \begin_inset Flex CharStyle:Code
5197 \begin_layout Plain Layout
5203 folder of a source distribution you can find a
5204 \begin_inset Flex CharStyle:Code
5207 \begin_layout Plain Layout
5213 script which is able to locate the
5217 based on your preferences.
5225 \begin_layout Subsubsection*
5229 \begin_layout Standard
5231 \begin_inset Flex CharStyle:Code
5234 \begin_layout Plain Layout
5235 /Applications/MacDviX_Folder/calleditor.script
5240 , add the following lines:
5243 \begin_layout LyX-Code
5248 \begin_layout Plain Layout
5255 X.app/Contents/MacOS/lyxeditor "$2" $1
5256 \begin_inset Newline newline
5262 \begin_layout Standard
5263 Modify the lines accordingly if you install LyX somewhere else than in the
5264 Applications folder.
5267 \begin_layout Standard
5268 Reverse search is triggered by Alt-click (OPTION-click).
5271 \begin_layout Subsubsection*
5275 \begin_layout Standard
5277 \begin_inset Flex CharStyle:Code
5280 \begin_layout Plain Layout
5281 open -a Skim.app $$i
5286 to the viewer setting in
5287 \begin_inset Flex CharStyle:MenuItem
5290 \begin_layout Plain Layout
5291 Preferences\SpecialChar \menuseparator
5292 File Handling\SpecialChar \menuseparator
5293 File formats\SpecialChar \menuseparator
5300 \begin_inset Flex CharStyle:MenuItem
5303 \begin_layout Plain Layout
5304 Skim\SpecialChar \menuseparator
5305 Preferences\SpecialChar \menuseparator
5315 \begin_layout Plain Layout
5325 \begin_layout Standard
5326 Reverse search is triggered by COMMAND-SHIFT-click
5329 \begin_layout Subsubsection*
5333 \begin_layout Standard
5335 \begin_inset Flex CharStyle:MenuItem
5338 \begin_layout Plain Layout
5339 Settings\SpecialChar \menuseparator
5340 Configure Okular\SpecialChar \ldots{}
5341 \SpecialChar \menuseparator
5348 \begin_inset Quotes eld
5352 \begin_inset Quotes erd
5356 \begin_inset Flex CharStyle:Code
5359 \begin_layout Plain Layout
5368 \begin_layout Standard
5369 Reverse search is triggered by SHIFT-click.
5372 \begin_layout Subsubsection*
5376 \begin_layout Standard
5377 Launch yap, choose its
5378 \begin_inset Flex CharStyle:MenuItem
5381 \begin_layout Plain Layout
5382 View\SpecialChar \menuseparator
5389 \begin_inset Quotes eld
5393 \begin_inset Quotes erd
5398 \begin_inset Quotes eld
5401 New\SpecialChar \ldots{}
5403 \begin_inset Quotes erd
5406 button and, in the window that opens, enter
5407 \begin_inset Quotes eld
5411 \begin_inset Quotes erd
5414 (or any other name you like) in the
5415 \begin_inset Quotes eld
5419 \begin_inset Quotes erd
5423 Now click on the button labeled
5424 \begin_inset Quotes eld
5427 \SpecialChar \ldots{}
5429 \begin_inset Quotes erd
5432 to open a file dialog and navigate to the directory containing the batch
5434 \begin_inset Flex CharStyle:Code
5437 \begin_layout Plain Layout
5445 \begin_inset Flex CharStyle:Code
5448 \begin_layout Plain Layout
5454 and then specify the program arguments as
5455 \begin_inset Flex CharStyle:Code
5458 \begin_layout Plain Layout
5464 if you want to use the shell script above, or as
5465 \begin_inset Flex CharStyle:Code
5468 \begin_layout Plain Layout
5474 if you want to use the
5475 \begin_inset Flex CharStyle:Code
5478 \begin_layout Plain Layout
5485 Since yap is a native Windows application, the filename it provides should
5486 be converted to POSIX style before being passed to
5487 \begin_inset Flex CharStyle:Code
5490 \begin_layout Plain Layout
5497 \begin_inset Flex CharStyle:Code
5500 \begin_layout Plain Layout
5506 , and this is the purpose of the
5507 \begin_inset Flex CharStyle:Code
5510 \begin_layout Plain Layout
5516 wrapper, which is as follows:
5519 \begin_layout LyX-Code
5521 \begin_inset Newline newline
5524 if "%1" == "-g" goto lyxclient
5525 \begin_inset Newline newline
5528 bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
5529 \begin_inset Newline newline
5533 \begin_inset Newline newline
5537 \begin_inset Newline newline
5540 bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
5543 \begin_layout Standard
5544 You have to make sure that both
5545 \begin_inset Flex CharStyle:Code
5548 \begin_layout Plain Layout
5555 \begin_inset Flex CharStyle:Code
5558 \begin_layout Plain Layout
5564 are in the command PATH, otherwise you have to use their full posix path
5565 in the above batch file.
5568 \begin_layout Standard
5569 In yap, reverse search is triggered by double-click.
5572 \begin_layout Subsubsection*
5576 \begin_layout Standard
5577 In SumatraPDF, you can set the name of the program that communicates with
5578 LyX by simply launching SumatraPDF as
5579 \begin_inset Flex CharStyle:Code
5582 \begin_layout Plain Layout
5583 SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
5589 The program will remember the setting and using the
5590 \begin_inset Flex CharStyle:Code
5593 \begin_layout Plain Layout
5599 option will not be needed from now on
5603 \begin_layout Plain Layout
5604 It has been reported that SumatraPDF is not able to remember the settings
5605 if it is installed in the Program Files system folder.
5606 This problem can be avoided by installing it somewhere else, for example
5608 \begin_inset Flex CharStyle:Code
5611 \begin_layout Plain Layout
5622 (in this way you will be using the lyxsocket; omit the
5623 \begin_inset Flex CharStyle:Code
5626 \begin_layout Plain Layout
5632 option if you want to use the lyxpipe and be sure that the
5633 \begin_inset Flex CharStyle:Code
5636 \begin_layout Plain Layout
5642 script is in your command PATH).
5643 If SumatraPDF is not your default PDF viewer, you should enter
5644 \begin_inset Flex CharStyle:Code
5647 \begin_layout Plain Layout
5653 in the viewer setting in
5654 \begin_inset Flex CharStyle:MenuItem
5657 \begin_layout Plain Layout
5658 Preferences\SpecialChar \menuseparator
5659 File Handling\SpecialChar \menuseparator
5660 File formats\SpecialChar \menuseparator
5667 \begin_inset Flex CharStyle:Code
5670 \begin_layout Plain Layout
5676 is the following script (to be placed in your command PATH,
5677 \begin_inset Flex CharStyle:Code
5680 \begin_layout Plain Layout
5686 being the best choice):
5689 \begin_layout LyX-Code
5691 \begin_inset Newline newline
5695 \begin_inset Newline newline
5698 SumatraPDF.exe $(basename $1)
5701 \begin_layout Standard
5702 This is needed because SumatraPDF is a native Windows application and does
5703 not understand the posix paths used by the Cygwin version of LyX.
5706 \begin_layout Standard
5707 Reverse search is triggered by double-click.
5710 \begin_layout Chapter
5711 Special Document Classes
5714 \begin_layout Section
5718 \begin_layout Standard
5724 \begin_layout Subsection
5728 \begin_layout Standard
5729 This section describes how LyX can be used to write articles for submission
5730 to the scientific journal
5732 Astronomy and Astrophysics
5734 (www.edpsciences.fr/aa/
5735 \begin_inset Flex URL
5738 \begin_layout Plain Layout
5740 http://www.edpsciences.fr/aa/
5745 ) using Version 5.01 of the document class
5750 This package can be downloaded from the ftp site
5753 \begin_layout Standard
5754 \begin_inset VSpace medskip
5760 \begin_layout Standard
5762 \begin_inset Flex URL
5765 \begin_layout Plain Layout
5767 ftp://ftp.edpsciences.org/pub/aa/readme.html
5775 \begin_layout Standard
5776 \begin_inset VSpace medskip
5782 \begin_layout Standard
5783 A manual comes together with that package, and this text is not meant to
5784 replace the original manual but merely a short guide how to realize the
5785 correct form of your paper.
5789 \begin_layout Standard
5790 Please note that the publisher of the journal was changed from Springer
5791 to EDP Sciences starting January 1, 2001.
5792 That change implicated also some slight changes of the style files, namely
5793 the removal of the thesaurus command.
5794 The LyX class aa supports the newest version of these style files, V 5.01.
5795 If you have an older version installed, please upgrade.
5796 For compatibility, the old (version 4) layout has been kept as
5801 Please refer to the comments in
5803 LyXDir/layouts/aapaper.layout
5808 \begin_layout Subsection
5812 \begin_layout Standard
5813 It is recommended you start from the example template distributed with LyX.
5814 If you are not using a template, note the following settings:
5817 \begin_layout Itemize
5824 Document\SpecialChar \menuseparator
5827 dialog (OK, that one was obvious).
5830 \begin_layout Itemize
5831 Don't change the option
5834 \begin_inset space ~
5844 The whole layout is done by the macros, you shouldn't change anything.
5847 \begin_layout Subsection
5851 \begin_layout Standard
5852 First thing to enter is the header information.
5853 It consists of seven entries, of which some are optional.
5857 \begin_layout Itemize
5865 \begin_layout Itemize
5873 \begin_layout Itemize
5881 \begin_layout Itemize
5889 \begin_layout Itemize
5894 : [optional] if more than one author: whom to contact for offprint requests.
5897 \begin_layout Itemize
5902 : [optional] mail address for contacts.
5905 \begin_layout Itemize
5913 Received: <date>; Accepted <date>
5916 \begin_layout Standard
5917 There is no need to issue the
5923 command, this is done automatically by LyX when the header is finished.
5924 Although the order of the single header entries doesn't matter it is advised
5925 to keep the above sequence, just to get the best optics and meets the layout
5926 of the real document.
5929 \begin_layout Standard
5930 If you want to place footnotes in the header block, e.
5931 \begin_inset space \thinspace{}
5935 \begin_inset space \space{}
5938 to state your present address, just use the standard footnote via the menu
5941 Insert\SpecialChar \menuseparator
5945 LyX will automagically use the term
5954 \begin_layout Standard
5955 In addition to these topics, the macros use three additional LaTeX commands
5956 that have no counterpart in LyX:
5959 \begin_layout Itemize
5966 to separate different names for more than one author and institute, respectivel
5970 \begin_layout Itemize
5977 to mark corresponding author/institute pairs.
5978 The institutes are numbered sequentially as they appear in the
5982 field, so you have to put a marker to each author.
5985 \begin_layout Itemize
5992 to supply an email address for fast contact.
5995 \begin_layout Standard
5996 In all cases, the appropriate command has to be entered in LyX and marked
6002 \begin_layout Subsection
6006 \begin_layout Standard
6007 The abstract should immediately follow the header block.
6008 With version 5 the abstract environment was changed to a command, and there
6009 is now a resctriction to only one paragraph.
6010 In addition, it should contain an entry with the keywords.
6011 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6018 by hand and mark it as LaTeX code.
6019 Refer to the example paper.
6022 \begin_layout Subsection
6023 Supported environments
6026 \begin_layout Standard
6027 The A&A paper layout supports the following environments for structuring
6031 \begin_layout Itemize
6037 \begin_layout Itemize
6043 \begin_layout Itemize
6049 \begin_layout Itemize
6055 \begin_layout Itemize
6061 \begin_layout Itemize
6067 \begin_layout Itemize
6073 \begin_layout Itemize
6079 \begin_layout Itemize
6085 \begin_layout Itemize
6091 \begin_layout Itemize
6097 \begin_layout Itemize
6103 \begin_layout Subsection
6104 Commands not supported by LyX
6107 \begin_layout Standard
6108 Some commands are not yet supported by the
6113 Some have already been mentioned.
6114 For the sake of completeness, they are listed all together here:
6117 \begin_layout Itemize
6125 \begin_layout Itemize
6133 \begin_layout Itemize
6141 \begin_layout Itemize
6149 \begin_layout Itemize
6157 \begin_layout Itemize
6165 \begin_layout Itemize
6173 \begin_layout Itemize
6181 \begin_layout Standard
6182 If you want to use any of these commands, you have to enter them yourself.
6185 Do not forget to mark them as LaTeX code!
6188 \begin_layout Subsection
6189 Figure and Table Floats
6192 \begin_layout Standard
6193 LyX provides support for the necessary float environments
6195 figure, figure*, table
6201 , therefore we won't tell much about it here.
6205 \begin_inset space ~
6211 Just remember that tables should be left-aligned.
6212 For that, select the table and change the alignment in
6214 Edit\SpecialChar \menuseparator
6216 \begin_inset space ~
6222 \begin_layout Standard
6223 There is only one special thing: the figures with caption besides the figure.
6224 To create such a figure, you have to do the following:
6227 \begin_layout Enumerate
6228 Create a wide figure float:
6230 Insert\SpecialChar \menuseparator
6231 Float\SpecialChar \menuseparator
6234 , then right click in the figure and select
6240 \begin_inset space ~
6248 \begin_layout Enumerate
6249 Enter your caption text.
6252 \begin_layout Enumerate
6257 to move the cursor above the caption.
6260 \begin_layout Enumerate
6264 \begin_layout Enumerate
6265 Position the cursor behind the figure and insert a horizontal fill:
6267 Insert\SpecialChar \menuseparator
6269 \begin_inset space ~
6272 Character\SpecialChar \menuseparator
6274 \begin_inset space ~
6282 \begin_layout Enumerate
6283 Switch to LaTeX mode:
6286 \begin_inset space ~
6294 \begin_layout Enumerate
6304 Do not close the brace!
6307 \begin_layout Enumerate
6308 Position the cursor behind the caption text, switch to LaTeX mode and insert
6312 \begin_inset space ~
6324 \begin_layout Standard
6325 Also, refer to the figures in the example paper.
6328 \begin_layout Subsection
6332 \begin_layout Standard
6333 For submission, the paper has to be formated in a special double-spacing
6335 For this purpose, you have to give the option
6339 to the documentclass.
6340 This must be done using the extra class options field in the
6342 Document\SpecialChar \menuseparator
6346 Just enter the string
6353 \begin_layout Subsection
6357 \begin_layout Standard
6362 directory contains an example paper written with LyX.
6363 It is the example paper from the original macro package, translated to
6365 Use it for inspiration, and compare the original LaTeX code with LyX way
6369 \begin_layout Section
6373 \begin_layout Standard
6379 \begin_layout Subsection
6383 \begin_layout Standard
6384 AASTeX is a set of macros produced by the American Astronomical Society
6385 to facilitate electronic manuscript submission to the three journals they
6386 publish: the Astrophysical Journal (including the Letters and Supplement),
6387 the Astronomical Journal, and the Publications of the Astronomical Society
6389 LyX has proven to be an excellent tool for generating these documents,
6390 especially given its equation, citation, and figure handling capabilities.
6391 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6392 is the version described here, or higher.
6393 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6394 incompatible with LyX.
6395 The AASTeX package may be downloaded from the AASTeX Web site
6398 \begin_layout Standard
6399 \begin_inset VSpace medskip
6405 \begin_layout Standard
6407 \begin_inset Flex URL
6410 \begin_layout Plain Layout
6412 http://www.journals.uchicago.edu/AAS/AASTeX
6420 \begin_layout Standard
6421 \begin_inset VSpace medskip
6427 \begin_layout Standard
6428 A complete user guide is contained in that package and you should familiarize
6429 yourself with it thoroughly before embarking on writing a paper in LyX.
6430 LyX will not reduce the need to figure out all the AASTeX commands, it
6431 will only reduce the drudgery of typing everything in.
6432 It is your responsibility to ensure that the final exported LaTeX document
6433 conforms completely to the requirements of the journal to which you are
6434 submitting your paper.
6437 \begin_layout Subsection
6438 Starting a New Paper
6441 \begin_layout Standard
6442 I strongly suggest that you start with the AASTeX template file.
6445 File\SpecialChar \menuseparator
6452 , enter the new file name, then choose the
6457 This will show the most common fields found in a manuscript.
6458 Simply overwrite the existing text (including the brackets,
6462 ) with the correct information.
6463 Many of the AASTeX commands and environments can be implemented directly
6464 in LyX, but some cannot: most noticeably
6476 , which should stick out like a sore thumb if you actually just opened the
6478 For commands such as these, the LaTeX code must be entered directly and
6480 Such commands are referred to as TeX code, or Evil Red Text.
6481 I tried to minimize the amount of TeX code needed in an AASTeX document,
6482 but there is still a bit more required than any of us would like.
6485 \begin_layout Subsection
6486 Finishing Your Paper
6489 \begin_layout Standard
6490 When the paper is finished to your satisfaction and previews/prints correctly,
6492 \begin_inset Quotes eld
6496 \begin_inset Quotes erd
6499 actions which need to be done before you submit it to the journals.
6503 \begin_layout Enumerate
6504 Export your paper as a LaTeX file (
6506 File\SpecialChar \menuseparator
6507 Export\SpecialChar \menuseparator
6514 \begin_layout Enumerate
6519 file with your favorite text editor
6523 \begin_layout Enumerate
6524 remove the comment lines before the
6533 \begin_layout Enumerate
6538 usepackage...{fontenc}
6540 line if it appears (usually just after
6555 \begin_layout Enumerate
6556 remove everything between (and including) the
6568 commands, except for any commands you specifically put into the LaTeX preamble
6569 (which should appear immediately after the
6570 \begin_inset Quotes eld
6573 User specified LaTeX commands
6574 \begin_inset Quotes erd
6585 \begin_layout Enumerate
6586 Run the resulting file through LaTeX to make sure it still processes correctly.
6589 \begin_layout Enumerate
6590 Reread the journal requirements to make sure your filenames and formats
6594 \begin_layout Enumerate
6598 \begin_layout Subsection
6599 Comments On Specific Commands
6602 \begin_layout Standard
6603 I will not describe the detailed usage of the individual AASTeX commands:
6604 the AASTeX User Guide (
6608 ) gives a good description of each.
6609 Thus it's probably easiest for me to go down the list as found in the guide
6610 and offer comments where necessary.
6611 So let's begin \SpecialChar \ldots{}
6615 \begin_layout Subsubsection
6616 Things that work as expected
6619 \begin_layout Standard
6623 \begin_layout Plain Layout
6635 \begin_layout Standard
6636 Because they work as you might expect, I simply list them and the section
6737 begin{thebibliography}
6745 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6746 graphicx figure commands (2.14.1),
6770 (2.15.4, amongst other places),
6797 \begin_layout Standard
6798 The following style options also work correctly:
6819 Simply put them in the
6825 Layout\SpecialChar \menuseparator
6831 \begin_layout Standard
6835 \begin_layout Plain Layout
6847 \begin_layout Subsubsection
6848 Things that work, but require more comment
6851 \begin_layout Standard
6852 The following items work, but require a little more discussion:
6855 \begin_layout Itemize
6856 These items are reserved for use by the journal editors, but you can put
6857 them into the LaTeX preamble if you feel compelled to do so:
6890 \begin_layout Itemize
6891 These items may be placed in the LaTeX preamble, and are included as blanks
6892 in the template file:
6913 \begin_layout Itemize
6920 (2.3) – can only be used
6921 \begin_inset Quotes eld
6925 \begin_inset Quotes erd
6928 , not in the middle of a paragraph.
6929 Use TeX code if you need to embed it.
6932 \begin_layout Itemize
6939 (2.3) – will have extra {} after it.
6940 This should not cause an error.
6943 \begin_layout Itemize
6950 (2.6) – can only be used
6951 \begin_inset Quotes eld
6955 \begin_inset Quotes erd
6958 , not in the middle of a paragraph.
6959 Use TeX code if you need to embed it.
6962 \begin_layout Itemize
6969 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6973 \begin_layout Itemize
6980 (2.8) – same as for
6987 \begin_layout Itemize
6994 (2.9) – will have extra {} after it.
6995 This should not cause an error.
6998 \begin_layout Itemize
7005 (2.11) – will have extra {} after it.
7006 This should not cause an error.
7009 \begin_layout Itemize
7016 (2.14.2) – you can insert an optional filename argument by placing the cursor
7017 at the beginning of the text and selecting
7019 Insert\SpecialChar \menuseparator
7024 \begin_inset Quotes eld
7028 \begin_inset Quotes erd
7031 inserts an optional argument of the type needed by
7038 Hopefully it will be renamed someday.
7041 \begin_layout Itemize
7048 (2.17.1) – same as
7054 for the catalog ID optional parameter
7057 \begin_layout Itemize
7064 (2.17.1) – same as
7070 for the catalog ID optional parameter
7073 \begin_layout Subsubsection
7074 Things not implemented, use TeX code
7077 \begin_layout Standard
7081 \begin_layout Plain Layout
7093 \begin_layout Standard
7116 setcounter{equation}
7118 (2.12), Journal name abbreviations (2.13.4),
7154 (2.15.4, insert it as the first element in the lefthand cell after where
7156 Don't use any of LyX's rules in the table),
7168 (2.15.5), much of Misc (2.17, except
7219 \begin_layout Standard
7223 \begin_layout Plain Layout
7235 \begin_layout Subsubsection
7236 Things that cannot be implemented
7239 \begin_layout Standard
7240 \SpecialChar \ldots{}
7241 at least in any meaningful sort of way, so I suggest ignoring them.
7242 They are the references environment (2.13.3), and the deluxetable environment
7244 If you really, really need to use deluxetable, I suggest editing it in
7245 a separate file with a text editor, then using
7247 Insert\SpecialChar \menuseparator
7249 \begin_inset space ~
7254 to include it in your LyX document.
7259 file to see an example of this.
7262 \begin_layout Subsection
7263 FAQs, Tips, Tricks, and Other Ruminations
7266 \begin_layout Subsubsection
7267 Getting LyX and AASTeX to cooperate
7270 \begin_layout Standard
7271 It can be a bit tricky to get LyX to recognize a new layout and document
7273 When all else fails, do this:
7276 \begin_layout Enumerate
7277 Make certain that LaTeX can find AASTeX.
7278 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7279 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7286 \begin_layout Enumerate
7298 \begin_layout Enumerate
7301 Tools\SpecialChar \menuseparator
7304 in LyX, then restart LyX.
7307 \begin_layout Enumerate
7308 Open a regular new file, not from a template.
7309 Does AASTeX appear in the class list in
7311 Document\SpecialChar \menuseparator
7317 \begin_layout Standard
7318 If you get a warning from an existing AASTeX document about not being able
7319 to find the AASTeX layout or a message about
7320 \begin_inset Quotes eld
7323 You should not mix title layouts with normal ones
7324 \begin_inset Quotes erd
7327 , things haven't been installed correctly.
7330 \begin_layout Subsubsection
7331 LaTeX error processing a table
7334 \begin_layout Standard
7335 LyX, by default, attempts to center the table caption/title.
7336 This seems to produce a bad interaction in AASTeX so you should click somewhere
7337 in the caption/title, then select
7339 Edit\SpecialChar \menuseparator
7341 \begin_inset space ~
7355 This took care of it for me.
7358 \begin_layout Subsubsection
7362 \begin_layout Standard
7363 A couple of things: 1) I have noticed some funny spacing in the reference
7364 entries in the text.
7365 When you enter the bibliography item data, make sure their is
7369 space between the last author and the parenthesis setting off the year;
7373 \begin_inset space \thinspace{}
7377 \begin_inset space \space{}
7391 2) Entering the references at all is not obvious.
7392 The easiest thing is to start typing your first reference at the end of
7393 the document, then mark it as type
7398 That will put a small gray box in front of what you just typed.
7399 Click on the box to fill in the rest of the information.
7400 For new references, go to the end of an existing reference and press return.
7401 That will create a new line with its own box, etc.
7404 \begin_layout Subsubsection
7408 \begin_layout Standard
7409 Even though AASTeX provides its own figure commands (
7415 , for example), I much prefer LaTeX's standard figure commands (with the
7424 \begin_inset space ~
7427 commands as TeX code into a Figure Float box if you desire, but I never
7428 have much luck getting the layout right.
7429 With the standard graphics, LyX will insert a
7433 usepackage{graphicx}
7435 command into the LaTeX preamble and handle the figures in the standard
7436 LaTeX2e way, interspersing the figures in the text.
7437 I believe ApJ accepts figures exactly this way now; AJ might still use
7439 \begin_inset Quotes eld
7442 stack everything at the end
7443 \begin_inset Quotes erd
7449 \begin_layout Subsubsection
7450 Things I could have done, but didn't
7453 \begin_layout Standard
7455 \begin_inset Quotes eld
7459 \begin_inset Quotes erd
7462 things I could have implemented, but chose not to.
7463 For instance, I saw no point in double-spacing the text in the LyX window,
7464 even though it is double-spaced in the paper manuscript.
7465 Also, I chose not to make separate layouts for the preprint and preprint2
7467 Since I assume you will spend most of your time in the plain manuscript
7468 mode anyway, I decided not to chew up more disk space with this.
7472 \begin_layout Subsection
7476 \begin_layout Standard
7477 Your mileage may vary.
7478 I've now had papers published by both ApJ and AJ that have had 98% of the
7479 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7481 I have had no trouble with the submission process, and I'm sure the journals
7482 were never aware that there might be a difference.
7483 So, go forth and publish!
7486 \begin_layout Section
7490 \begin_layout Standard
7493 David Johnson; updated by Richard Heck
7496 \begin_layout Standard
7497 \begin_inset VSpace bigskip
7503 \begin_layout Standard
7505 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7506 papers to be submitted to American Mathematical Society publications.
7507 The layouts are not tailored to a specific journal, but easily can be.
7508 You should refer to the AMS documentation for specific instructions for
7509 each journal (usually it will entail only changing a single line in the
7511 That documentation is available on the Web at
7512 \begin_inset Flex URL
7515 \begin_layout Plain Layout
7523 \begin_inset Flex URL
7526 \begin_layout Plain Layout
7528 ftp://ftp.ams.org/pub/tex/amslatex/
7534 These layouts are appropriate, and useful, for any mathematical writing.
7538 \begin_layout Standard
7539 There are two basic AMS LaTeX layouts:
7542 \begin_layout Itemize
7543 amsart: The standard AMS article format.
7546 \begin_layout Itemize
7547 amsbook: the standard AMS book (really, monograph) format.
7551 \begin_layout Standard
7552 The layouts themselves contain only the minimum necessary to use the AMS
7554 They do not, in particular, contain any of the `theorem' environments used
7555 for setting theorems, lemmas, and the like.
7556 These are contained, instead, in the
7557 \begin_inset Flex CharStyle:Code
7560 \begin_layout Plain Layout
7566 module, which is loaded by default when when you select one of the AMS
7568 (It can also be used with other classes and can be removed, if you would
7569 rather use something else.) Less commonly used environments are in the
7570 \begin_inset Flex CharStyle:Code
7573 \begin_layout Plain Layout
7574 Theorems (AMS-Extended)
7579 module, which must be loaded manually.
7582 \begin_layout Standard
7583 By default, theorems and the like are numbered consecutively throughout
7584 the document, but this may be modified by loading the module
7585 \begin_inset Flex CharStyle:Code
7588 \begin_layout Plain Layout
7589 Theorems (Order by Section)
7594 or, if you are using
7595 \begin_inset Flex CharStyle:Code
7598 \begin_layout Plain Layout
7605 \begin_inset Flex CharStyle:Code
7608 \begin_layout Plain Layout
7609 Theorems (Order by Chapter)
7615 These will number the results as
7616 \begin_inset Formula $n.m
7620 , where the first number refers to the section (or chapter) and the second
7621 refers to the total number of results so far in that section (or chapter).
7622 Many environments are also available unnumbered.
7623 These are indicated by an asterisk at the end.
7624 If you happen to want
7628 unnumbered results, the the module
7629 \begin_inset Flex CharStyle:Code
7632 \begin_layout Plain Layout
7638 provides that option.
7641 \begin_layout Standard
7642 Note that these modules do not
7646 to be used with the AMS classes.
7647 It is perfectly possible to use the
7648 \begin_inset Flex CharStyle:Code
7651 \begin_layout Plain Layout
7657 module, and the others mentioned, with other classes, such as
7658 \begin_inset Flex CharStyle:Code
7661 \begin_layout Plain Layout
7668 \begin_inset Flex CharStyle:Code
7671 \begin_layout Plain Layout
7678 \begin_inset Flex CharStyle:Code
7681 \begin_layout Plain Layout
7690 \begin_layout Subsection
7691 What these layouts provide
7694 \begin_layout Standard
7695 There is a long list of included environments provided by these layouts.
7696 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7697 variety of `theorem' environments.
7698 However, the AMS recommends the environments that are available in LyX.
7702 \begin_layout Standard
7703 The following environments—as well as the standard environments, such as
7705 \begin_inset Flex CharStyle:Noun
7708 \begin_layout Plain Layout
7715 \begin_inset Flex CharStyle:Noun
7718 \begin_layout Plain Layout
7725 \begin_inset Flex CharStyle:Noun
7728 \begin_layout Plain Layout
7735 \begin_inset Flex CharStyle:Noun
7738 \begin_layout Plain Layout
7745 \begin_inset Flex CharStyle:Noun
7748 \begin_layout Plain Layout
7755 \begin_inset Flex CharStyle:Code
7758 \begin_layout Plain Layout
7765 \begin_inset Flex CharStyle:Code
7768 \begin_layout Plain Layout
7777 \begin_layout Description
7778 Address This should be the author's permanent address.
7781 \begin_layout Description
7783 \begin_inset space ~
7786 Address This should be the author's temporary address at the time of submission,
7787 if different from the Address.
7790 \begin_layout Description
7791 Email Author's e-mail address
7794 \begin_layout Description
7795 URL Author's Web address, if desired.
7798 \begin_layout Description
7799 Keywords Key words or phrases used to identify specific topics discussed
7803 \begin_layout Description
7804 Subjectclass These refer to the AMS Subject Classifications, published and
7807 Mathematical Reviews
7810 These are also available online at the AMS cites listed above.
7813 \begin_layout Description
7817 \begin_layout Description
7821 \begin_layout Description
7825 \begin_layout Standard
7826 The following environments are provided by both the
7827 \begin_inset Flex CharStyle:Code
7830 \begin_layout Plain Layout
7837 \begin_inset Flex CharStyle:Code
7840 \begin_layout Plain Layout
7846 modules, in the latter case in both starred (unnumbered) and unstarred
7847 (numbered) versions.
7848 These same environments are provided only in the starred versions by the
7850 \begin_inset Flex CharStyle:Code
7853 \begin_layout Plain Layout
7862 \begin_layout Theorem
7863 This is typically used for the statements of major results.
7867 \begin_layout Corollary*
7868 This is used for statements which follow fairly directly from previous statement
7870 Again, these can be major results.
7875 These are smaller results needed to prove other statements.
7878 \begin_layout Proposition
7879 These are less major results which (hopefully) add to the general theory
7883 \begin_layout Conjecture
7884 These are statements provided without justification, which the author does
7885 not know how to prove, but which seem to be true (to the author, at least).
7888 \begin_layout Definition*
7889 Guess what this is for.
7890 The font is different for this environment than for the previous ones.
7894 \begin_layout Example*
7895 Used for examples illustrating proven results.
7898 \begin_layout Problem
7899 It's not really known what this is for.
7900 You should figure it out.
7903 \begin_layout Exercise*
7904 Write a description for this one.
7907 \begin_layout Remark
7908 This environment is also a type of theorem, usually a lesser sort of observation.
7911 \begin_layout Claim*
7912 Often used in the course of giving a proof of a larger result.
7916 Generally, these are used to break up long arguments, using specific instances
7922 The numbering scheme for cases is on its own, not together with other numbered
7928 At the end of this environment, a QED symbol (usually a square, but it can
7929 vary with different styles) is placed.
7930 If you want to have other environments within this one—for example, Case
7931 environments—and have the QED symbol appear only after them, then the other
7932 environments need to be nested within the proof environment.
7935 Nesting Environments
7941 for information on nesting.
7944 \begin_layout Standard
7945 And these environments are provided by
7946 \begin_inset Flex CharStyle:Code
7949 \begin_layout Plain Layout
7950 Theorems (AMS-Extended)
7958 \begin_layout Criterion*
7959 A required condition.
7962 \begin_layout Algorithm*
7963 A general procedure to be used.
7966 \begin_layout Axiom*
7967 This is a property or statement taken as true within the system being discussed.
7970 \begin_layout Condition*
7971 Sometimes used to state a condition assumed within the present context of
7976 Similar to a Remark.
7979 \begin_layout Notation*
7980 Used for the explanation of, yes, notation.
7983 \begin_layout Summary
7984 Do we really need to tell you?
7987 \begin_layout Acknowledgement*
7991 \begin_layout Conclusion*
7992 Sometimes used at the end of a long train of argument.
7996 Used in a way similar to Proposition, though perhaps lower on the scale.
7999 \begin_layout Standard
8000 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8002 They need to be available on your system in order to use these environments.
8005 \begin_layout Section
8013 \begin_layout Standard
8019 \begin_layout Subsection
8023 \begin_layout Standard
8024 These are the layout files for some of the journals of the American Geophysical
8026 It is assumed that you have both the AGU's own class files and AGUplus
8027 installed (everything to be found at
8028 \begin_inset Flex URL
8031 \begin_layout Plain Layout
8033 ftp://ftp.agu.org/journals/latex/journals
8041 \begin_layout Subsection
8045 \begin_layout Standard
8055 They are still called this in the LyX GUI, though their LaTeX equivalents
8056 in the AGU classes are
8067 \begin_layout Standard
8068 Newly defined styles are
8105 These are mostly manuscript attributes and defined in the AGU class documentati
8109 \begin_layout Standard
8110 I suspect this is still badly incomplete.
8113 \begin_layout Subsection
8117 \begin_layout Standard
8134 \begin_layout Subsection
8138 \begin_layout Itemize
8141 Journal of Geophysical Research
8150 \begin_layout Standard
8151 Add your own, it isn't so hard! Look at the
8162 \begin_layout Subsection
8163 Bugs and things to remember
8166 \begin_layout Standard
8167 In order to use the new layouts, you must remember to do the following for
8171 \begin_layout Enumerate
8177 This can be done in the
8179 Layout\SpecialChar \menuseparator
8184 Document\SpecialChar \menuseparator
8188 (AGU articles are always in English, right? So
8195 \begin_layout Enumerate
8205 (Yes, this is a bug.)
8208 \begin_layout Enumerate
8209 Make sure you use the
8213 bibliography style, by entering
8217 into the second field of the BibTeX inset.
8218 None of the standard styles will do.
8221 \begin_layout Section
8225 \begin_layout Standard
8231 \begin_layout Subsection
8235 \begin_layout Standard
8236 Broadway is for writing plays.
8237 The format is more decorative than Hollywood, and much less standardized.
8238 This format should be suitable for workshops.
8241 \begin_layout Subsection
8245 \begin_layout Standard
8246 The same as in Hollywood.
8249 \begin_layout Subsection
8253 \begin_layout Standard
8258 names as labels then cross-reference the label to insert the name.
8259 The cross-reference dialog will show the current cast of characters.
8262 \begin_layout Subsection
8263 Paper size and Margins
8266 \begin_layout Standard
8267 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8270 \begin_layout Subsection
8274 \begin_layout Standard
8275 The following environments are available.
8276 You can use broadway.bind to get the bind keys shown at the right.
8279 \begin_layout Itemize
8283 \begin_inset Newline newline
8288 You should not have to use this, but it is here for anything that does not
8292 \begin_layout Itemize
8296 \begin_inset space \hfill{}
8300 \begin_inset Newline newline
8305 Used to describe stage setting and the action.
8306 First use of speaker names in all CAPs.
8309 \begin_layout Itemize
8313 \begin_inset space \hfill{}
8317 \begin_inset Newline newline
8322 Automatically numbered.
8323 On screen it will be arabic, but will print as Roman.
8326 \begin_layout Itemize
8330 \begin_inset space \hfill{}
8334 \begin_inset Newline newline
8344 It is just centered text.
8347 \begin_layout Itemize
8351 \begin_inset space \hfill{}
8355 \begin_inset Newline newline
8360 Not automatically numbered.
8361 You supply the number.
8362 This is because I couldn't figure out how.
8365 \begin_layout Itemize
8369 \begin_inset space \hfill{}
8373 \begin_inset Newline newline
8378 A special case of Narrative to describe the setting and action as the curtain
8382 \begin_layout Itemize
8386 \begin_inset space \hfill{}
8390 \begin_inset Newline newline
8395 The speaker's (actor's) title, centered in all CAPS.
8398 \begin_layout Itemize
8402 \begin_inset space \hfill{}
8406 \begin_inset Newline newline
8411 Instructions to the speaker.
8412 The parentheses are automatically inserted.
8413 The ( will appear on screen, but both will be in the printed play.
8414 This environment is only used within
8421 \begin_layout Itemize
8425 \begin_inset space \hfill{}
8429 \begin_inset Newline newline
8434 What the Speaker says.
8437 \begin_layout Itemize
8441 \begin_inset space \hfill{}
8445 \begin_inset Newline newline
8450 The curtain comes down.
8453 \begin_layout Itemize
8457 \begin_inset space \hfill{}
8463 \begin_layout Itemize
8467 \begin_inset space \hfill{}
8473 \begin_layout Itemize
8477 \begin_inset space \hfill{}
8483 \begin_layout Standard
8487 \begin_layout Section
8491 \begin_layout Standard
8496 can be used to type letters according to German conventions.
8497 A template file is included in
8499 .../lyx/share/templates
8501 for you to use as a starting point.
8504 \begin_layout Section
8512 \begin_layout Standard
8518 \begin_layout Subsection
8522 \begin_layout Standard
8523 This is the layout file for the European Geophysical Society journals.
8528 can be downloaded from the web site of the EGS under
8529 \begin_inset Flex URL
8532 \begin_layout Plain Layout
8542 \begin_layout Subsection
8546 \begin_layout Standard
8549 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8557 The current layout file is unfortunately very unmodular and would benefit
8558 from using the various
8565 \begin_layout Section
8569 \begin_layout Standard
8575 \begin_layout Standard
8576 Elsevier Science Publishers B.V.
8577 provides a standard LaTeX document class (
8581 ) for submitting articles to their various journals.
8582 The style file can be downloaded directly from their web site:
8583 \begin_inset Flex URL
8586 \begin_layout Plain Layout
8588 http://authors.elsevier.com/
8594 Instructions are supplied along with the class file, which details the
8595 requirements of the publishers.
8596 LyX includes package that allows for the use of this class, by a layout
8597 and a template file.
8598 Installation of the class file is the same as for any other LaTeX package;
8599 instructions are provided in the Elsevier documentation.
8602 \begin_layout Standard
8612 As the Elsevier class file is based mainly on the standard article class,
8613 most of the normal functionality is provided.
8614 The Elsevier class defines a number of mathematical environments, which
8615 are similar to the AMS environments.
8616 These commands are all described in the Elsevier documentation, and are
8620 \begin_layout Standard
8621 The easiest way to use the Elsevier style is to base documents on the included
8623 It is best not to use options such as fancy headings or the geometry package,
8624 as elements such as these are defined by Elsevier in their style file.
8625 Ideally, no extra packages except those mentioned in the Elsevier documentation
8627 Essentially, Elsevier require as
8628 \begin_inset Quotes eld
8632 \begin_inset Quotes erd
8635 a LaTeX file as possible, as their intention is to take the supplied file
8636 and replace the class file with one for the particular journal to which
8637 the paper has been submitted.
8638 This also means that not too much time should be spent on the formating
8640 When it comes to be published, this will change anyway.
8641 The rest of the usage for this layout is substantially the same as for
8642 the normal article class.
8643 For details of what Elsevier do and don't allow, refer to their documentation.
8646 \begin_layout Section
8652 \begin_inset CommandInset label
8661 \begin_layout Standard
8667 \begin_layout Subsection
8671 \begin_layout Standard
8672 This section describes how to use LyX to make slides for overhead projectors.
8673 There are two document classes that can do this: the default slides class
8679 This section documents the latter.
8682 \begin_layout Standard
8683 I'm going to say this again, nice and clear, so that there's no misunderstanding
8687 \begin_layout Standard
8688 \begin_inset VSpace bigskip
8694 \begin_layout Standard
8698 This section documents the class
8699 \begin_inset Quotes eld
8707 \begin_inset Quotes erd
8715 \begin_layout Standard
8716 \begin_inset VSpace bigskip
8722 \begin_layout Standard
8723 If you're looking for the documentation for
8724 \begin_inset Quotes eld
8732 \begin_inset Quotes erd
8736 \begin_inset space ~
8740 \begin_inset CommandInset ref
8742 reference "sec:slitex"
8747 If your machine doesn't have the
8752 \begin_inset Quotes eld
8760 \begin_inset Quotes erd
8763 ] installed, you'll probably have to use the default
8767 class, which isn't quite as good as
8772 \begin_layout Standard
8777 class is designed for use with version 2.1 of the
8781 LaTeX class file which is now an integral part of LaTeX2e.
8784 \begin_layout Subsection
8788 \begin_layout Standard
8789 Obviously, to use this document class, you need to select
8790 \begin_inset Quotes eld
8798 \begin_inset Quotes erd
8808 \begin_inset space ~
8814 There are some settings in the
8817 \begin_inset space ~
8822 dialog that you should know about that are specific to this class:
8825 \begin_layout Itemize
8826 Don't change the options
8837 \begin_inset space ~
8843 They're ignored by the
8850 \begin_layout Itemize
8851 The default font size is 20
8852 \begin_inset space \thinspace{}
8855 pt with the other options being 17
8856 \begin_inset space \thinspace{}
8860 \begin_inset space \thinspace{}
8864 \begin_inset space \thinspace{}
8870 \begin_layout Itemize
8879 but all math equations are still typeset in the usual roman font.
8882 \begin_layout Itemize
8887 supports A4 and Letter paper sizes as well as a special size for working
8889 \begin_inset space \thinspace{}
8893 It doesn't support A5, B5, legal or executive paper sizes.
8896 \begin_layout Itemize
8897 Don't bother changing the
8901 settings because they are ignored anyway.
8902 All floats appear where they are defined in the text.
8905 \begin_layout Itemize
8910 setting behaves a bit differently for this class.
8915 provides extensive footer and header capabilities including a user-defined
8918 \begin_inset space ~
8922 \begin_inset CommandInset ref
8924 reference "sec:foilfoot"
8929 The title page is treated differently to all other pages in the document
8938 has the logo centered at the bottom of the page (if one is defined).
8939 The possible page style choices and what they do are as follows:
8943 \begin_layout Labeling
8944 \labelwidthstring MMMMMMM
8951 The final output contains no page numbers, or other headers or footers
8952 (except footnotes of course).
8956 \begin_layout Labeling
8957 \labelwidthstring MMMMMMM
8964 The final output contains page numbers centered at the bottom of the page.
8965 No other headings or footers (other than footnotes).
8968 \begin_layout Labeling
8969 \labelwidthstring MMMMMMM
8974 Page numbers in lower right corner.
8975 Additional headers and footers are also shown.
8976 This is also the default.
8979 \begin_layout Labeling
8980 \labelwidthstring MMMMMMM
8985 Gives you access to the
8989 package although its use with
8993 is discouraged by the writer of the
8997 package because of some potential page layout clashes.
9001 \begin_layout Subsubsection
9005 \begin_layout Standard
9006 The following options may be used in the extra class options in the
9008 Document\SpecialChar \menuseparator
9014 \begin_layout Labeling
9015 \labelwidthstring MMMMMMx
9020 This sets up the page layout for 7.33
9021 \begin_inset space \thinspace{}
9025 \begin_inset space \thinspace{}
9028 in paper, which is about the same aspect ratio as a 35
9029 \begin_inset space \thinspace{}
9032 mm slide, making it a bit easier to work with this medium.
9035 \begin_layout Labeling
9036 \labelwidthstring MMMMMMx
9041 Places a rule across the page below the header on every page except the
9045 \begin_layout Labeling
9046 \labelwidthstring MMMMMMx
9051 Places a rule across the page above the footer on every page except the
9055 \begin_layout Labeling
9056 \labelwidthstring MMMMMMx
9061 This is automatically set each time you create a new
9070 to use the dvips driver to rotate those pages that are set as landscape
9074 \begin_layout Labeling
9075 \labelwidthstring MMMMMMx
9080 Simply changes the page dimensions to those of a landscape page but doesn't
9082 Thus if you use this option you need to use an external program to rotate
9083 each page or feed your paper through your printer as landscape.
9084 Note that this option effectively reverses the roles of the
9092 environments (don't worry these are described in the next section).
9095 \begin_layout Labeling
9096 \labelwidthstring MMMMMMx
9101 Equation numbers on the left.
9104 \begin_layout Labeling
9105 \labelwidthstring MMMMMMx
9110 Flush-left equations.
9113 \begin_layout Subsection
9114 Supported Environments
9117 \begin_layout Standard
9118 Most of the environments commonly supported in other classes are also supported
9124 There are several additional environments provided by
9128 as well as a couple added by LyX.
9129 The following environments are shared with other classes:
9132 \begin_layout Standard
9136 \begin_layout Plain Layout
9148 \begin_layout Itemize
9154 \begin_layout Itemize
9160 \begin_layout Itemize
9166 \begin_layout Itemize
9172 \begin_layout Itemize
9178 \begin_layout Itemize
9184 \begin_layout Itemize
9190 \begin_layout Itemize
9196 \begin_layout Itemize
9202 \begin_layout Itemize
9208 \begin_layout Itemize
9214 \begin_layout Itemize
9220 \begin_layout Itemize
9226 \begin_layout Itemize
9232 \begin_layout Itemize
9238 \begin_layout Itemize
9244 \begin_layout Itemize
9250 \begin_layout Itemize
9256 \begin_layout Standard
9260 \begin_layout Plain Layout
9272 \begin_layout Standard
9273 That is, all the major environments apart from the sectioning environments.
9274 Since foils are essentially self-contained sections, with a title and body,
9279 provides specific commands for starting new foils and these are:
9282 \begin_layout Itemize
9288 \begin_layout Itemize
9294 \begin_layout Standard
9295 LyX also provides slightly modified versions of these two environments called:
9298 \begin_layout Itemize
9304 \begin_layout Itemize
9310 \begin_layout Standard
9311 and the differences will be explained in the next section.
9314 \begin_layout Standard
9315 Since foils are often used in presenting ideas or new theorems and such
9320 also provides a comprehensive box of goodies for presenting them:
9323 \begin_layout Standard
9327 \begin_layout Plain Layout
9339 \begin_layout Itemize
9345 \begin_layout Itemize
9351 \begin_layout Itemize
9357 \begin_layout Itemize
9363 \begin_layout Itemize
9369 \begin_layout Itemize
9375 \begin_layout Itemize
9381 \begin_layout Itemize
9387 \begin_layout Itemize
9393 \begin_layout Itemize
9399 \begin_layout Itemize
9405 \begin_layout Standard
9409 \begin_layout Plain Layout
9421 \begin_layout Standard
9422 The starred versions are unnumbered while the unstarred versions are numbered.
9423 There are also two list environments added by LyX and these are:
9426 \begin_layout Itemize
9432 \begin_layout Itemize
9438 \begin_layout Standard
9443 provides some powerful header and footer capabilities that are best set
9444 in the preamble although they may be set at any point in a document.
9445 If you want to change these settings in your document the best place to
9446 do so is at the very top of a foil, i.
9447 \begin_inset space \thinspace{}
9453 \begin_inset space \space{}
9458 straight after the foilhead.
9461 \begin_layout Standard
9462 For this purpose, the following command styles are provided [
9469 \begin_layout Standard
9473 \begin_layout Plain Layout
9485 \begin_layout Itemize
9489 \begin_inset space ~
9495 \begin_layout Itemize
9501 \begin_layout Itemize
9505 \begin_inset space ~
9511 \begin_layout Itemize
9515 \begin_inset space ~
9521 \begin_layout Itemize
9525 \begin_inset space ~
9532 \begin_layout Standard
9533 \begin_inset space ~
9540 \begin_layout Standard
9544 \begin_layout Plain Layout
9556 \begin_layout Standard
9557 There are also a few commands provided by
9561 that aren't directly supported by LyX but I'll tell you what they do and
9562 how to use them in section
9563 \begin_inset space ~
9567 \begin_inset CommandInset ref
9569 reference "sec:unsuppfoils"
9576 \begin_layout Subsection
9577 Building a Set of Foils
9580 \begin_layout Standard
9581 This section will give a simple introduction to using the different environments
9582 to build a set of foils.
9583 If you want to see an example set of foils, take a look at the
9587 file you find in LyX's
9594 \begin_layout Subsubsection
9595 Give It a Title Page
9598 \begin_layout Standard
9599 Unlike other classes that provide
9619 creates the title on a page of its own.
9620 If you leave out the
9624 environment LaTeX will substitute the current date (every time you regenerate
9628 \begin_layout Subsubsection
9632 \begin_layout Standard
9633 As I mentioned earlier, there are four ways of starting a new foil.
9634 For portrait foils you should use
9643 The difference between these two environments is the amount of space between
9644 the title of the foil (the foilhead) and the body of the foil.
9647 \begin_layout Standard
9648 Landscape foils are generated using the
9657 Again the only difference is the spacing between foilhead and body.
9658 Both of the short versions have 0.5 inches less separation between the foilhead
9663 \begin_layout Standard
9664 One problem with the support for landscape foils is the requirement that
9669 driver to generate the PostScript output otherwise the foils won't be rotated.
9670 It is possible to get landscape foils even if you haven't got the
9674 driver provided you can feed your foils sideways through your printer ;-)
9677 \begin_layout Subsubsection
9678 Theorems, Lemmas, Proofs and more
9681 \begin_layout Standard
9682 Due to a small bug in LyX you can't have two of the same type of these environme
9683 nts directly following each other.
9684 They must be separated by something.
9685 If you try, you will just be extending the previous environment as if you
9686 had merged the two environments together.
9687 So, how do you get around this problem? The simplest option is to insert
9688 some text between the two environments or add a
9692 environment between the two with just a
9693 \begin_inset Quotes eld
9701 \begin_inset Quotes erd
9705 This will force LyX to produce two separate environments and hence the
9706 correct LaTeX output.
9707 An example is provided in the example file included with the LyX distribution.
9708 Remember, this problem only occurs if you are trying to place two of the
9709 same type of theorem-like environments one directly after the other.
9712 \begin_layout Subsubsection
9716 \begin_layout Standard
9717 You get all the commonly supported list styles found in other classes as
9718 well as two new ones.
9719 I'll only describe the new ones here.
9720 If you want to find out more about the other list environments check out
9726 If you intend to use itemized lists you might also want to read about the
9730 \begin_inset space ~
9734 \begin_inset space ~
9739 dialog described above in section
9740 \begin_inset space ~
9744 \begin_inset CommandInset ref
9746 reference "sec:bullet"
9753 \begin_layout Standard
9754 The two new list styles,
9762 , are designed to make it easier for you to create lists of do's and don'ts
9763 or right and wrong by providing dedicated environments that use a tick
9764 or a cross as the label of the list.
9765 These lists are in fact dedicated variants of the
9770 They do however require that you have the
9777 \begin_layout Subsubsection
9781 \begin_layout Standard
9786 redefines the floating tables and figures so that they appear exactly where
9787 they are in the text rather than pushing them to the top of the page or
9788 to some user specified location.
9789 In fact if you change the float placement settings they are simply ignored.
9792 \begin_layout Subsubsection
9793 Page Headers and Footers
9794 \begin_inset CommandInset label
9803 \begin_layout Standard
9807 \begin_inset space ~
9816 are two commands used to control the left-footer text string.
9817 The first is meant to allow you to include a graphic logo on your foils
9819 \begin_inset Quotes eld
9827 \begin_inset Quotes erd
9831 While the second is meant to provide a classification for the audience,
9835 \begin_inset space \thinspace{}
9841 \begin_inset space \space{}
9845 It is empty by default.
9848 \begin_layout Standard
9849 The remaining page corners can be filled by
9852 \begin_inset space ~
9857 (which defaults to page numbers),
9860 \begin_inset space ~
9868 \begin_inset space ~
9876 \begin_layout Subsection
9882 \begin_inset CommandInset label
9884 name "sec:unsuppfoils"
9891 \begin_layout Standard
9892 All the commands mentioned below need to be set in a
9900 within another environment.
9903 \begin_layout Subsubsection
9907 \begin_layout Standard
9908 All lengths are adjusted using the
9931 should be replaced by the name given to the length you want to change and
9936 is the length value.
9937 All lengths should be specified in units of length such as inches (
9949 ) or relative to some document or font-based length such as
9959 \begin_layout Standard
9960 It's possible to change the spacing between a foilhead and the body of the
9961 foil by adjusting the length specified by
9968 For example, to make
9973 \begin_inset space \space{}
9976 in closer to their bodies put the following in the preamble:
9982 foilheadskip}{-0.5in}
9985 \begin_layout Standard
9986 The spacings around floats can be adjusted by setting these lengths:
9989 \begin_layout Labeling
9990 \labelwidthstring MMMMMMMMMMM
9997 Separation between the text and the top of the float
10000 \begin_layout Labeling
10001 \labelwidthstring MMMMMMMMMMM
10008 Separation between the float and the caption
10011 \begin_layout Labeling
10012 \labelwidthstring MMMMMMMMMMM
10019 Separation between the caption and the following text
10022 \begin_layout Labeling
10023 \labelwidthstring MMMMMMMMMMM
10030 You can make the captions narrower than the surrounding text by adjusting
10032 Best done relative to
10041 \begin_layout Standard
10042 There are also several title page related lengths that you may find useful
10043 if you have a long title or several authors:
10046 \begin_layout Labeling
10047 \labelwidthstring MMMMMMMMMMM
10054 Separation from headers to
10059 \begin_layout Labeling
10060 \labelwidthstring MMMMMMMMMMM
10078 \begin_layout Labeling
10079 \labelwidthstring MMMMMMMMMMM
10093 \begin_layout Labeling
10094 \labelwidthstring MMMMMMMMMMM
10110 \begin_layout Labeling
10111 \labelwidthstring MMMMMMMMMMM
10127 \begin_layout Standard
10128 The last length related command affects all the list environments.
10139 a list environment then all the vertical spacing between the list items
10141 Note that this is a command not a length so it doesn't require
10147 like the stuff mentioned above.
10150 \begin_layout Subsubsection
10151 Headers and Footers
10154 \begin_layout Standard
10167 commands control whether the logo in the
10171 definition appear on a given page.
10178 in the preamble then none of the foils will have the logo on them.
10179 If you don't want the logo on a particular page place the
10185 directly after the foilhead of that page and the
10191 directly after the next foilhead.
10194 \begin_layout Standard
10195 If you decide to use the
10199 page style setting in the
10202 \begin_inset space ~
10207 dialog you should probably add
10217 to your preamble so headers and footers on landscape pages are correctly
10218 placed when rotated.
10219 This is due to some clashes between the page layouts provided by the
10230 \begin_layout Section
10231 Hollywood (Hollywood spec scripts)
10234 \begin_layout Standard
10240 \begin_layout Subsection
10244 \begin_layout Standard
10245 Getting the format of a Hollywood script right is a
10246 \begin_inset Quotes eld
10250 \begin_inset Quotes erd
10253 It is designed to make the readers focus on content and to be easy and
10254 familiar for the actors to read.
10255 Each page of a script should be one minute of film.
10256 Nothing goes in a script that you cannot see or hear on screen.
10257 The courier 12 pt font should be used throughout.
10261 \begin_layout Subsection
10265 \begin_layout Standard
10266 Speakers' lines should NEVER break in mid-sentence.
10267 If a speaker's lines continue over a page break, repeat the
10271 title followed by (Cont'd).
10274 \begin_layout Subsection
10278 \begin_layout Standard
10283 names as labels then cross-reference the label to insert the name.
10284 The cross-reference dialog will show the current cast of characters.
10285 You can use this to insert the speaker name in narratives also.
10288 \begin_layout Subsection
10289 Paper size and Margins
10292 \begin_layout Standard
10293 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10296 \begin_layout Subsection
10300 \begin_layout Standard
10301 The following environments are available.
10302 You can use hollywood.bind to get the bind keys shown at the right.
10305 \begin_layout Itemize
10309 \begin_inset Newline newline
10314 Used where nothing else works.
10318 \begin_layout Itemize
10324 \begin_inset space \hfill{}
10332 \begin_inset Newline newline
10335 Usually followed by something like
10336 \begin_inset Quotes eld
10339 on Sally waking up.
10340 \begin_inset Quotes erd
10346 \begin_layout Itemize
10350 \begin_inset space \hfill{}
10354 \begin_inset Newline newline
10359 Introduces a new INTERIOR camera set-up.
10360 Always followed by DAY or NIGHT, or something similar to define the lighting
10362 Everthing on this line in CAPS.
10365 \begin_layout Itemize
10369 \begin_inset space \hfill{}
10373 \begin_inset Newline newline
10378 Introduces a new EXTERIOR camera set-up.
10379 Everthing on this line in CAPS.
10382 \begin_layout Itemize
10386 \begin_inset space \hfill{}
10390 \begin_inset Newline newline
10395 The character speaking.
10398 \begin_layout Itemize
10402 \begin_inset space \hfill{}
10406 \begin_inset Newline newline
10411 Instructions to the speaker.
10412 The () are automatically inserted, but only the ( will show in LyX.
10413 Both will be printed.
10416 \begin_layout Itemize
10420 \begin_inset space \hfill{}
10424 \begin_inset Newline newline
10436 \begin_layout Itemize
10440 \begin_inset space \hfill{}
10444 \begin_inset Newline newline
10449 Camera movement instruction.
10451 \begin_inset space \thinspace{}
10455 \begin_inset space \space{}
10461 \begin_layout Itemize
10465 \begin_inset space \hfill{}
10471 \begin_layout Itemize
10475 \begin_inset space \hfill{}
10481 \begin_layout Itemize
10485 \begin_inset space \hfill{}
10491 \begin_layout Itemize
10495 \begin_inset space \hfill{}
10501 \begin_layout Subsection
10505 \begin_layout Itemize
10506 (O.S) — off screen
10509 \begin_layout Itemize
10510 (V.0) — voice over
10513 \begin_layout Itemize
10515 \begin_inset space \thinspace{}
10522 \begin_layout Itemize
10527 \begin_layout Itemize
10528 PAN — camera movement
10531 \begin_layout Itemize
10532 INSERT — cut to close-up of
10535 \begin_layout Section
10539 \begin_layout Standard
10542 Panayotis Papasotiriou
10545 \begin_layout Subsection
10549 \begin_layout Standard
10550 The ijmpc package is a set of macros that facilitates electronic manuscript
10553 International Journal of Modern Physics C
10556 Similarly, the ijmpd package is for creating manuscripts to be submitted
10559 International Journal of Modern Physics D
10562 Both journals are published by World Scientific.
10563 The corresponding document classes are named
10572 These files, together with instructions for the authors, can be downloaded
10574 \begin_inset Flex URL
10577 \begin_layout Plain Layout
10579 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10585 \begin_inset Flex URL
10588 \begin_layout Plain Layout
10590 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10596 Both packages are modified versions of the standard
10597 \begin_inset Quotes eld
10601 \begin_inset Quotes erd
10604 package, and they are almost (but not exactly) identical.
10605 Most of their features are supported by LyX.
10606 I have used LyX successfully to write articles submitted to both journals
10607 without any problem.
10610 \begin_layout Subsection
10614 \begin_layout Standard
10615 As usual, the easiest way to write a paper is to start with a template.
10618 File\SpecialChar \menuseparator
10637 This will give an (almost) empty document that includes the most common
10638 fields found in a manuscript.
10639 Simply overwrite the existing text (including the brackets,
10644 You should keep in mind the following remarks.
10647 \begin_layout Enumerate
10648 LyX won't let you change the font size and the page style of the document,
10649 because such modifications are not allowed by both packages.
10652 \begin_layout Enumerate
10653 The language of the document should not be changed.
10654 Before previewing your paper, be sure that the babel package is not used.
10655 To do this, click on
10657 Tools\SpecialChar \menuseparator
10668 checkbox in the language settings, and click on
10676 , if you wish to make this change permanent).
10679 \begin_layout Enumerate
10681 \begin_inset Quotes eld
10685 \begin_inset Quotes erd
10688 style must be used to define keywords.
10691 \begin_layout Enumerate
10692 The ijmpc package provides a style named
10693 \begin_inset Quotes eld
10696 Classification Codes
10697 \begin_inset Quotes erd
10700 , which can be used to define classification codes, such as PACS numbers.
10701 Note that this facility is not supported by the ijmpd package.
10704 \begin_layout Enumerate
10705 Several new environments are available:
10706 \begin_inset Quotes eld
10710 \begin_inset Quotes erd
10714 \begin_inset Quotes eld
10718 \begin_inset Quotes erd
10722 \begin_inset Quotes eld
10726 \begin_inset Quotes erd
10730 \begin_inset Quotes eld
10734 \begin_inset Quotes erd
10738 \begin_inset Quotes eld
10742 \begin_inset Quotes erd
10746 \begin_inset Quotes eld
10750 \begin_inset Quotes erd
10754 \begin_inset Quotes eld
10758 \begin_inset Quotes erd
10762 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10770 \begin_inset Quotes eld
10774 \begin_inset Quotes erd
10778 \begin_inset Quotes eld
10782 \begin_inset Quotes erd
10786 \begin_inset Quotes eld
10790 \begin_inset Quotes erd
10794 \begin_inset Quotes eld
10798 \begin_inset Quotes erd
10802 \begin_inset Quotes eld
10806 \begin_inset Quotes erd
10810 \begin_inset Quotes eld
10814 \begin_inset Quotes erd
10818 Their use is more or less obvious.
10819 LyX supports all these environments; it will use the proper label, text
10820 style, and numbering scheme for each of them.
10823 \begin_layout Enumerate
10824 Both packages use basic citations; the natbib package should not be used.
10825 In LyX, citation references are shown as usual; in the output, citations
10826 are shown as superscripts.
10827 If you want to use a citation as normal text, you should use the
10832 \begin_inset space \thinspace{}
10836 \begin_inset space \space{}
10840 \begin_inset Quotes eld
10844 \begin_inset space \space{}
10854 \begin_inset Quotes erd
10860 \begin_layout Enumerate
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10869 section in both packages.
10870 To put acknowledgments, just use the
10871 \begin_inset Quotes eld
10875 \begin_inset Quotes erd
10881 \begin_layout Enumerate
10882 Appendices may be added to the paper,
10886 the Acknowledgments and
10891 LyX provides a special environment, called
10892 \begin_inset Quotes eld
10896 \begin_inset Quotes erd
10899 which marks the beginning of the appendices.
10900 This environment should be left blank; it just sends a LaTeX command, but
10901 nothing is really printed.
10903 \begin_inset Quotes eld
10907 \begin_inset Quotes erd
10910 is printed with blue letters, as a signal that all sections after that
10911 point are appendices.
10912 To write an appendix, use the
10913 \begin_inset Quotes eld
10917 \begin_inset Quotes erd
10921 LyX will number each appendix with capital letters, as required by both
10924 \begin_inset Quotes eld
10928 \begin_inset Quotes erd
10935 be present before the first appendix; if not, all appendices will be numbered
10936 as normal sections in the output.
10939 \begin_layout Enumerate
10940 The ijmpc and the ijmpd packages use the
10944 command to implement table captions.
10945 As a result, a table created by LyX is printed correctly, but its caption
10947 However, you can use some TeX code to overpass this problem, so that captions
10948 are printed as expected.
10949 To do so, create a float table as usual, remove the caption, and replace
10950 it with the TeX code
10960 (sic); you must also the TeX code
10964 immediately after the tabular material.
10965 Study the example table included in the template files to see how this
10966 trick is implemented.
10967 Alternatively, If you need table captions, you should implement the whole
10972 file, then include this file to the LyX document (
10974 Insert\SpecialChar \menuseparator
10975 File\SpecialChar \menuseparator
10977 \begin_inset space ~
10983 Details on how to create a table float can be found in the files
10991 , included in the corresponding packages.
10994 \begin_layout Subsection
10995 Preparing a paper for submission
10998 \begin_layout Standard
10999 Before you submit your paper you must export the LyX document as a LaTeX
11002 File\SpecialChar \menuseparator
11003 Export\SpecialChar \menuseparator
11010 \begin_layout Plain Layout
11011 Actually you have the choice between LaTeX (plain) and pdflatex.
11012 If you intend to use pdflatex to prepare the paper, you should use the
11013 pdflatex option so that included graphics are converted to PDF format,
11014 ready for use by pdflatex.
11019 , then make the following changes to the resulting
11026 \begin_layout Enumerate
11027 Remove the comment lines before the
11036 \begin_layout Enumerate
11037 Remove everything between (and including) the
11049 commands, except for any commands you specifically put into the LaTeX preamble.
11052 \begin_layout Standard
11057 file should be saved and processed through LaTeX as many times as necessary.
11058 You may also want to check the resulting
11065 \begin_layout Subsection
11069 \begin_layout Standard
11070 The use of TeX code is reduced to two commands, which must be placed at
11071 the top of the document.
11072 If you started writing your paper by using the
11080 template, the TeX code needed is already in its place; you usually don't
11082 You may only modify the first TeX code to specify the information printed
11083 to the top of odd and even pages (authors' names and short paper's title,
11085 This TeX code must have the form
11089 markboth{Authors' Names}{Short Paper's Title}
11094 \begin_layout Section
11098 \begin_layout Standard
11104 \begin_layout Subsection
11108 \begin_layout Standard
11109 The iopart package provides a document class to create electronic manuscript
11110 submission to the journals published by the Institute of Physics.
11111 Instructions for the authors how to create a paper using the iopart class
11112 can be downloaded together with the iopart package from the site
11113 \begin_inset Flex URL
11116 \begin_layout Plain Layout
11118 ftp://ftp.iop.org/pub/journals/latex2e
11126 \begin_layout Subsection
11130 \begin_layout Standard
11131 The easiest way to write a paper is to start with the file
11135 that is available in LyX's examples files folder.
11136 Open this file, save it under a new name, and start writing.
11137 The example file explains how to use the special text environments.
11138 Here are the most important advices:
11141 \begin_layout Itemize
11142 To be able to compile your document to a PDF, PS, or DVI, assure that the
11145 Use AMS math package
11147 in the document settings under
11154 \begin_layout Itemize
11157 The title environment defines the kind of your paper.
11158 So use one of the following environments for the title:
11162 \begin_layout Itemize
11171 \begin_layout Itemize
11180 \begin_layout Itemize
11186 for a Topical review
11189 \begin_layout Itemize
11198 \begin_layout Itemize
11207 \begin_layout Itemize
11213 for a Paper (same as Title)
11216 \begin_layout Itemize
11222 for a Preliminary communication
11225 \begin_layout Itemize
11231 for a Rapid communication
11234 \begin_layout Itemize
11240 for a Letter to the editor
11244 \begin_layout Itemize
11247 All title environments except of
11251 can have an optional short title.
11254 \begin_layout Itemize
11255 There is a general title environment
11259 which is not directly supported by the LyX.
11260 This can be used as TeX code when your document doesn't fit into one of
11261 the other title types.
11264 \begin_layout Standard
11265 For more informations like hints for special table and formula formatting,
11266 look at the IOP author guidelines.
11269 \begin_layout Section
11273 \begin_layout Standard
11276 Panayotis Papasotiriou
11279 \begin_layout Subsection
11283 \begin_layout Standard
11284 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11285 that facilitates electronic manuscript submission to the journals they
11287 Most known of them (at least in my domain of interest) are
11289 Astrophysics and Space Science
11295 , but there are many others (see a complete list at
11296 \begin_inset Flex URL
11299 \begin_layout Plain Layout
11301 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11307 The Kluwer package may be downloaded from the site
11308 \begin_inset Flex URL
11311 \begin_layout Plain Layout
11313 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11319 A complete user guide is contained in that package (but it can also be
11320 downloaded separately).
11323 \begin_layout Standard
11324 LyX supports many features of the package but not everything.
11325 However, the TeX code needed is reduced to some
11326 \begin_inset Quotes eld
11330 \begin_inset Quotes erd
11333 commands of the package (see
11334 \begin_inset space ~
11338 \begin_inset CommandInset ref
11340 reference "subsec:kluwer_peculiarities"
11345 I have recently used LyX to write an article submitted to the
11347 Astrophysics and Space Science
11349 without any problem.
11352 \begin_layout Subsection
11356 \begin_layout Standard
11357 The easiest way to write a paper is to start with the Kluwer template file.
11360 File\SpecialChar \menuseparator
11372 This will give an (almost) empty document that includes the most common
11373 fields found in a manuscript and a short description of their use.
11374 As in most templates, simply overwrite the existing text (including the
11379 ) with the correct information.
11382 \begin_layout Subsection
11383 Preparing a paper for submission
11386 \begin_layout Standard
11387 As in the AASTeX package, before you submit your paper to a journal you
11389 \begin_inset Quotes eld
11393 \begin_inset Quotes erd
11399 \begin_layout Enumerate
11400 Export your paper as a LaTeX file.
11401 To do this, click on
11403 File\SpecialChar \menuseparator
11404 Export\SpecialChar \menuseparator
11411 \begin_layout Enumerate
11416 file with a text editor and make the following changes
11420 \begin_layout Enumerate
11421 remove the comment lines before the
11430 \begin_layout Enumerate
11431 remove everything between (and including) the
11443 commands, except for any commands you specifically put into the LaTeX preamble.
11446 \begin_layout Standard
11455 \begin_layout Enumerate
11460 file through LaTeX as many times as necessary (usually up to three).
11463 \begin_layout Enumerate
11469 \begin_inset space \thinspace{}
11473 \begin_inset space \space{}
11480 , and check if everything is OK (it should, if you didn't make any mistake).
11483 \begin_layout Subsection
11484 \begin_inset Quotes eld
11488 \begin_inset Quotes erd
11491 of the Kluwer package
11492 \begin_inset CommandInset label
11494 name "subsec:kluwer_peculiarities"
11501 \begin_layout Standard
11502 The Kluwer package has the following
11503 \begin_inset Quotes eld
11507 \begin_inset Quotes erd
11513 \begin_layout Enumerate
11514 It is possible to write multiple articles in the same LaTeX file
11518 \begin_layout Plain Layout
11519 I can't imagine any good reason to do this.
11525 Each article must be included in the environment
11526 \begin_inset Quotes eld
11530 \begin_inset Quotes erd
11534 Unfortunately, this environment cannot be omitted, even if you write just
11536 Therefore, each article starts with the command
11542 and, obviously, ends with the command
11549 Although this can be implemented in LyX, I didn't included it, since it
11550 looks ugly and can confuse the novice user.
11551 Therefore, you need to enter them directly and mark them as LaTeX code
11553 \begin_inset Quotes eld
11557 \begin_inset Quotes erd
11563 \begin_layout Enumerate
11564 Information given at the beginning of the article (i.
11565 \begin_inset space \thinspace{}
11569 \begin_inset space \space{}
11572 title, subtitle, author, institution, running title, running author, abstract
11573 and keywords) must be included in an environment called
11574 \begin_inset Quotes eld
11578 \begin_inset Quotes erd
11582 This is not implemented in LyX, so you must enter title, subtitle etc.
11583 \begin_inset space ~
11586 between two TeX code lines (
11601 \begin_layout Enumerate
11602 According to the user manual, the label of each bibliography item must be
11626 \begin_layout Standard
11631 template takes care of all these
11632 \begin_inset Quotes eld
11636 \begin_inset Quotes erd
11640 If you start a new paper using this template you don't need to do anything
11645 \begin_layout Enumerate
11646 don't delete the TeX code included in the template, and
11649 \begin_layout Enumerate
11650 copy the example bibliography item included in the template and modify it
11651 as necessary to enter new bibliography items.
11654 \begin_layout Section
11658 \begin_layout Standard
11664 \begin_layout Subsection
11668 \begin_layout Standard
11669 The LyX document classes
11671 article (koma-script)
11675 report (koma-script)
11693 correspond to the LaTeX document classes
11710 \begin_inset space ~
11713 of the Koma-Script family.
11714 They are replacements for the standard document classes
11730 , resp., and fit better to European typography conventions in a number of
11734 \begin_layout Itemize
11735 Standard character size is 11pt in
11737 article (koma-script)
11741 report (koma-script)
11749 letter (koma-script)
11754 \begin_layout Itemize
11755 Headings, labels of the description environment, and a number of elements
11758 letter (koma-script)
11760 document class are set in a bold sans serif font.
11764 \begin_layout Plain Layout
11765 There is a big difference between the bold sans serif old cm fonts and new
11766 ec fonts, especially in the appearance of headings.
11767 In comparison, the ec bold sans serif fonts look a bit thin.
11768 Here the LaTeX package
11776 helps to produce the
11777 \begin_inset Quotes eld
11781 \begin_inset Quotes erd
11784 appearance when using the ec fonts.
11789 The numbering of chapter headings is made in the same way as the numbering
11790 of section headings, that is without the extra line
11791 \begin_inset Quotes eld
11794 Chapter\SpecialChar \ldots{}
11796 \begin_inset Quotes erd
11800 In addition, the appearance of the headings can be modified by using a
11801 number of options (in LyX to be entered in the field
11804 \begin_inset space ~
11811 Layout\SpecialChar \menuseparator
11815 A detailed German description of these options can be found in the Koma-Script
11823 \begin_layout Itemize
11824 The main means in the Koma-Script document classes to design the type area
11833 (in LyX to be entered in the extra class options field in the dialog
11835 Document\SpecialChar \menuseparator
11839 They make a clearer modification of page margins possible as do the options
11842 Document\SpecialChar \menuseparator
11846 A detailed German description of these and other type area options can
11847 be found in the Koma-Script documentation
11854 \begin_layout Itemize
11855 The LaTeX document classes of the Koma-Script family define a number of
11856 additional commands.
11857 Those part of it which makes sense in LyX is implemented in corresponding
11861 \begin_layout Standard
11862 A detailed German description of the LaTeX document classes of the Koma-Script
11863 family can be found in the Koma-Script documentation
11871 \begin_layout Plain Layout
11872 There is an English translation
11876 , but it is not a complete one.
11881 The following sections describe only those aspects, which are relevant
11885 \begin_layout Subsection
11886 article (koma-script), report (koma-script), and book (koma-script)
11889 \begin_layout Standard
11890 The document classes
11892 article (koma-script)
11896 report (koma-script)
11906 are implemented in the layout files
11919 They contain all the paragraph types of the corresponding standard document
11932 , resp., partly modified, with the exception of the LyX specific
11936 -type, which is replaced by the new
11940 -type having the same functionality.
11945 -Type there is a number of new paragraph types added.
11952 letter (koma-script)
11957 \begin_layout Itemize
11966 : are equivalents to
11974 , resp., additionally inserting an entry in the table of contents.
11983 are not contained in
11985 article (koma-script)
11990 \begin_layout Itemize
11999 : behave exactly as
12007 , resp., additionally clearing running heads.
12012 is not contained in
12014 article (koma-script)
12020 \begin_layout Plain Layout
12033 report (koma-script)
12035 , but since this is identical to
12039 , is has not been implemented in LyX.
12047 \begin_layout Itemize
12052 : generates a heading directly above the following paragraph in the standard
12053 character size without affecting the structure of the document.
12056 \begin_layout Itemize
12065 are special captions which respect the different space settings needed
12066 for captions placed above or below an element (if you follow strict typographic
12067 rules, you might want to place table captions always above the table).
12068 You can also use the class option
12072 , which will switch
12085 You need at least Koma-Script version 2.8q to use this.
12088 \begin_layout Itemize
12093 : can be used to set a bonmot, e.
12094 \begin_inset space \thinspace{}
12098 \begin_inset space \space{}
12101 at the beginning of a chapter.
12102 If you use the optional argument (
12104 Insert\SpecialChar \menuseparator
12106 \begin_inset space ~
12111 ), you can insert the dictum's author there.
12112 Dictum and author are separated by a line.
12113 You need at least Koma-Script version 2.8q to use this.
12118 is not contained in
12120 article (koma-script)
12125 \begin_layout Standard
12126 The following types, together with the standard types
12138 , form the title area of the document.
12139 They must be entered ahead of the first
12140 \begin_inset Quotes eld
12144 \begin_inset Quotes erd
12151 \begin_layout Plain Layout
12152 The corresponding LaTeX commands must appear before the
12163 When such a type is used more than once, the latter usage overwrites the
12164 former one, that means, for every type only the latest usage is valid.
12165 The order of the different types however has, like
12177 , no effect on the appearance of the produced document.
12180 \begin_layout Itemize
12185 : produces a centered paragraph above the ordinary title (
12197 ) for the subject of the document.
12200 \begin_layout Itemize
12205 : produces a centered paragraph below the ordinary title (
12217 ) for the publishers' name.
12220 \begin_layout Itemize
12227 report (koma-script)
12233 produces a centered paragraph on its own page behind the title page, or
12236 article (koma-script)
12238 produces a centered paragraph below the ordinary title (
12254 ) for a dedication.
12257 \begin_layout Itemize
12262 : produces a left aligned paragraph above the ordinary title (
12278 ) for a document`s head.
12281 \begin_layout Itemize
12286 : produces in a double-sided print in
12288 report (koma-script)
12294 a left-aligned paragraph at the top of the title page`s back or has no
12295 effect in a single-sided print or in
12297 article (koma-script)
12302 \begin_layout Itemize
12307 : produces in a double-sided print in
12309 report (koma-script)
12315 a left-aligned paragraph at the bottom of the title page`s back or has
12316 no effect in a single-sided print or in
12318 article (koma-script)
12323 \begin_layout Itemize
12328 : produces a special
12329 \begin_inset Quotes eld
12333 \begin_inset Quotes erd
12336 page ahead of the actual document containing a paragraph without special
12340 \begin_layout Standard
12341 The layout files for the document classes
12343 article (koma-script)
12347 report (koma-script)
12353 do include the file
12358 This is thought of as a place to define your own types.
12363 in your personal layout directory and edit the file!
12366 \begin_layout Subsection
12367 letter (koma-script)
12370 \begin_layout Standard
12374 \begin_layout Plain Layout
12386 \begin_layout Standard
12390 letter (koma-script)
12392 is implemented in the layout file
12397 It contains all the paragraph types of the corresponding standard document
12402 , partly modified, with the exception of the LyX specific types
12414 type, which is replaced by the new
12419 In addition, it contains, in contrast to the standard document class, the
12437 Furthermore, there are a number of new letter specific types.
12440 \begin_layout Standard
12444 \begin_layout Plain Layout
12456 \begin_layout Standard
12457 The appearance of the letter produced by this document class can be controlled
12458 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12462 \begin_layout Plain Layout
12463 For example, the standard appearance of the letter`s heading, consisting
12464 of name and address, is quite self-willed.
12466 \begin_inset Quotes eld
12470 \begin_inset Quotes erd
12473 heading is produced by the following LaTeX commands in the preamble:
12476 \begin_layout LyX-Code
12486 \begin_layout LyX-Code
12502 \begin_layout LyX-Code
12512 \begin_layout LyX-Code
12532 A detailed German description of such LaTeX commands can be found in the
12533 Koma-Script documentation
12538 With it, the letter's author can produce his personal letter layout.
12541 \begin_layout Standard
12550 define the beginning of the letter and must be used in every letter.
12551 To emphasize them in the LyX document class, they are marked with the letter
12561 \begin_inset space ~
12564 in the left margin.
12565 It is possible to write any number of letters in one file.
12570 type produces a new letter using the same addressee and a
12574 type produces a new addressee.
12591 are ordinary paragraph types and can also be used several times in one
12592 and the same letter.
12595 \begin_layout Itemize
12600 : produces a paragraph for the addressee and implicitly defines the beginning
12604 \begin_layout Itemize
12609 : produces a paragraph for the form of address and implicitly produces a
12613 \begin_layout Itemize
12618 : produces a paragraph for a close.
12621 \begin_layout Itemize
12626 : produces a paragraph for a postscript.
12629 \begin_layout Itemize
12634 : produces a paragraph for a distribution list.
12637 \begin_layout Itemize
12642 : produces a paragraph for enclosures.
12645 \begin_layout Standard
12686 are input types provided with a label to enter information, which will
12687 be processed by the document class.
12691 \begin_layout Plain Layout
12692 It could be seen as a matter of inconsequence, that the types
12700 described above are not such input types as well.
12701 Because of the special meaning of those types, however, I have implemented
12702 them as ordinary paragraph types with a one letter mark in the left margin.
12703 Moreover, it would affect my feeling of symmetry, if the
12711 type had such a serious different appearance.
12716 The types must be used ahead of the corresponding
12723 \begin_layout Standard
12724 An implementation of these types in a WYSIWYG fashion does not seem to make
12725 sense, because the real appearance of the produced letter does not only
12726 depend on the usage of the particular type, but also on other factors.
12727 For example, a signature entered in the
12731 type will in the standard behavior appear in the produced letter only,
12732 when in the same letter also a
12737 The entered value of the
12741 type will in the standard behavior not appear in the produced letter at
12743 The possibility to design the letter`s heading freely is already indicated
12744 in a footnote above.
12747 \begin_layout Standard
12748 The input types can also be used as empty paragraphs.
12749 This makes sense e.
12750 \begin_inset space \thinspace{}
12754 \begin_inset space \space{}
12766 type is not used at all, in the standard behavior the value of the
12770 type is used as signature, whereas if an empty
12774 type is used, no signature value is defined.
12777 \begin_layout Standard
12778 By using the input types it is possible to write a letter template, containing
12779 filled input types with your personal dates (name, address, etc.) and empty
12780 input types for other dates you want to enter.
12783 \begin_layout Itemize
12788 : sender's name, in the standard behavior appears as a centered paragraph
12789 in small caps in the letter`s heading.
12792 \begin_layout Itemize
12797 : sender's signature, in the standard behavior appears below the
12806 type is used, the value of the
12810 type appears instead.
12813 \begin_layout Itemize
12818 : sender's address, in the standard behavior appears in a centered paragraph
12819 in the letter`s heading below the sender's name.
12822 \begin_layout Itemize
12827 : sender's telephone number, in the standard behavior only sets the LaTeX
12837 \begin_layout Itemize
12842 : place of the letter`s making.
12845 \begin_layout Itemize
12850 : date of the letter`s making.
12859 , in the standard behavior, produce the place and the date in a right-aligned
12860 line below the addressee's field.
12865 type is used, neither place nor date appear, independent of the value of
12875 type is used, the date of the letter `s production is used.
12878 \begin_layout Itemize
12883 : sender`s back address, in the standard behavior appears above the addressee's
12884 field in a small sans serif font.
12887 \begin_layout Itemize
12892 : special mail information, in the standard behavior appears underlined
12893 above the addressee's field below the back address.
12896 \begin_layout Itemize
12901 : additional information, in the standard behavior appears on right side
12902 below the addressee`s field.
12905 \begin_layout Itemize
12910 : the letter's title, in the standard behavior appears in a big, bold, sans
12911 serif font above the subject.
12914 \begin_layout Itemize
12919 : the letter's subject, in the standard behavior appears in a bold font
12927 \begin_layout Standard
12948 produce a business letter like line above the
12952 line containing the fields
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Quotes eld
12965 \begin_inset Quotes erd
12969 \begin_inset Quotes eld
12973 \begin_inset Quotes erd
12977 \begin_inset Quotes eld
12981 \begin_inset Quotes erd
12985 \begin_inset Quotes eld
12989 \begin_inset Quotes erd
12993 \begin_inset Quotes eld
12997 \begin_inset Quotes erd
13001 For the date field, the value of the
13007 \begin_inset Quotes eld
13010 business letter types
13011 \begin_inset Quotes erd
13014 is used, the value of the
13018 type however does not appear, but only the LaTeX variable
13025 The ordinary output of place and date in a right-aligned line below the
13026 addressee`s field is suppressed.
13027 The types are implemented as input types provided with a label and must
13028 be used ahead of the corresponding
13035 \begin_layout Itemize
13043 \begin_layout Itemize
13051 \begin_layout Itemize
13059 \begin_layout Itemize
13067 \begin_layout Itemize
13075 \begin_layout Subsection
13076 The new letter class: letter (koma-script v.2)
13079 \begin_layout Standard
13082 Jürgen Spitzmüller
13085 \begin_layout Standard
13086 \begin_inset VSpace medskip
13092 \begin_layout Standard
13094 Koma-Script version 2.8 has introduced a new letter class
13098 which supersedes the now unsupported
13103 It has — on the LaTeX side — a completely new interface and is not compatible
13104 with the old class.
13105 Therefore, LyX supports both, though it is recommended to use the new class.
13108 \begin_layout Standard
13109 This class covers the same functionality as
13111 letter (koma-script),
13114 The basic items are
13118 (receiver's address, same as
13122 in the old layout),
13135 will start a new letter (i.
13136 \begin_inset space \thinspace{}
13140 \begin_inset space \space{}
13143 you can write several letters per document).
13144 New elements are sender's
13160 and the possibility to use a
13166 Insert\SpecialChar \menuseparator
13172 \begin_layout Standard
13173 The biggest improvement is, though, that the letter's layout is configurable
13174 at almost any needs.
13175 This can be done via the preamble or with a special style file (Letter
13176 Class Option, extension
13180 ), that will be read in as a class option.
13184 \begin_layout Plain Layout
13185 The KOMA package comes with some default
13190 There is, for instance, a
13194 file that follows german typesetting rules, or a
13198 that provides the default layout of the old
13203 The latter can be loaded with the class option
13212 ayout\SpecialChar \menuseparator
13217 ocument\SpecialChar \menuseparator
13229 template that is included in LyX for examples.
13230 A detailed description is to be found in the Koma-Script documentation
13238 \begin_layout Subsection
13242 \begin_layout Standard
13243 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13247 \begin_layout Itemize
13248 The chapter number of a
13252 type appears on a line of its own above the chapter heading instead of
13253 appearing in the same line ahead of it.
13254 The cause for that is the LyX internal behavior for the labeltype
13258 in the layout file.
13261 \begin_layout Itemize
13262 The headings of the types
13270 are only put in the
13271 \begin_inset Quotes eld
13275 \begin_inset Quotes erd
13278 LaTeX table of contents, but not in the LyX table of contents (
13280 Document\SpecialChar \menuseparator
13282 \begin_inset space ~
13286 \begin_inset space ~
13294 \begin_layout Itemize
13295 The paragraphs in a
13299 document class appear in a skip separation mode, not indented.
13300 This is the standard behavior, no special LaTeX commands are needed for
13304 Document\SpecialChar \menuseparator
13307 dialog the corresponding radio button indicates
13316 value always has the effect that extra LaTeX commands are inserted in the
13317 document to produce the gap, which is not what is wanted in this case.
13320 \begin_layout Section
13321 Latex8 (IEEE Conference Papers)
13324 \begin_layout Standard
13330 \begin_layout Subsection
13334 \begin_layout Standard
13335 Since this class is specifically for writing submissions to IEEE sponsored
13336 conferences I strongly recommend that you get a copy of their Authors Kit.
13341 package and associated bibliography style file is included in the kit.
13342 The Authors Kit is usually sent out by email once your initial submission
13344 There is a lot of useful information in the Authors Kit explaining formatting
13345 restrictions and so on and I will assume you have read this since that
13346 means I don't have to repeat it all here.
13349 \begin_layout Subsection
13353 \begin_layout Standard
13354 [AR\SpecialChar \@.
13358 \begin_layout Subsection
13359 Supported Environments
13362 \begin_layout Itemize
13368 \begin_layout Itemize
13374 \begin_layout Itemize
13380 \begin_layout Itemize
13386 \begin_layout Itemize
13392 \begin_layout Itemize
13398 \begin_layout Itemize
13404 \begin_layout Itemize
13410 \begin_layout Itemize
13416 \begin_layout Subsection
13417 Differences Between Screen and Paper
13420 \begin_layout Standard
13421 There are slight differences in appearance mainly with the presentation
13422 of section counters.
13423 On screen the trailing period of the section counter is missing but it
13424 will appear in the output so don't let this worry you.
13427 \begin_layout Section
13431 \begin_layout Standard
13434 Jürgen Spitzmüller
13437 \begin_layout Subsection
13441 \begin_layout Standard
13442 Memoir is a very powerful and constantly evolving class.
13443 It has been designed with regard to fictional and non-fictional literature.
13444 Its aim is to let the user have maximum control over the typesetting of
13446 Memoir is based on the standard book class, but it can also emulate the
13447 article class (see below).
13450 \begin_layout Standard
13451 Peter Wilson, the developer of Memoir, is known as the author of lots of
13452 useful packages in the LaTeX world.
13453 Most of them have been merged with Memoir.
13454 Therefore, it is much easier to layout the table of contents, appendices,
13455 chapter designs and such.
13456 LyX, though, does not support all of these goodies natively.
13457 Some of them might be added to forthcoming releases
13461 \begin_layout Plain Layout
13462 You are invited to send suggestions to
13463 \begin_inset Flex URL
13466 \begin_layout Plain Layout
13468 lyx-devel@lists.lyx.org
13478 , lots will probably never, due to the limitations of LyX's framework.
13479 Of course you can still use all features with the help of some native LaTeX
13484 \begin_layout Plain Layout
13489 \begin_layout Plain Layout
13499 \begin_inset space ~
13503 \begin_inset CommandInset ref
13505 reference "sec:Inserting-TeX-Code"
13515 In this section, we can only list those features which are natively supported
13517 For detailed descriptions (and for the rest of features) we are recommending
13518 to have a look at the detailed manual of the Memoir class
13522 \begin_layout Plain Layout
13527 \begin_layout Plain Layout
13537 \begin_inset Flex URL
13540 \begin_layout Plain Layout
13542 CTAN:/macros/latex/memoir/memman.pdf
13552 , which is not only a user guide for the class, but also both a comprehensive
13553 description on good typesetting and a superb example for good typesetting
13557 \begin_layout Subsection
13558 Basic features and restrictions
13561 \begin_layout Standard
13562 Memoir supports basically all features of the standard book classes.
13563 There are, however, some differences, as follows:
13566 \begin_layout Description
13568 \begin_inset space ~
13571 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13574 \begin_layout Description
13576 \begin_inset space ~
13579 style: The fancy page style is not supported, due to a command clash between
13580 Memoir and the fancyhdr package (they are both defining a command with
13581 the same name, which confuses LaTeX).
13582 Instead, Memoir comes with a bunch of own page styles (see
13584 Layout\SpecialChar \menuseparator
13585 Document\SpecialChar \menuseparator
13587 \begin_inset space ~
13593 If you want to use these for the chapter pages, you have to use the command
13600 in the main text or in preamble (e.
13601 \begin_inset space \thinspace{}
13605 \begin_inset space \space{}
13612 chapterstyle{companion}
13617 \begin_layout Description
13618 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13619 an optional argument in the standard classes.
13620 With this, you can specify an alternative version of the title for the
13621 table of contents and the headers (for instance, if the title is too long).
13622 In LyX, you can do this via
13624 Insert\SpecialChar \menuseparator
13626 \begin_inset space ~
13631 at the beginning of a chapter/section.
13632 Memoir features a second optional argument and thus separates the table
13633 of contents from the header.
13634 You can define three variants of a title with this: one for the main text,
13635 one for the table of contents, and one for the headers.
13636 Simply insert two optional arguments if you need this feature, the first
13637 one containing the short title for the Table of Contents, the second one
13638 containing an alternative short title for the headers.
13641 \begin_layout Description
13642 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13643 of contents, the list of figures and the list of table start a new page
13645 Memoir does not follow this route.
13646 You have to insert a page break yourself, if you want to have one.
13649 \begin_layout Description
13650 Titlepage: For some unknown reason, Memoir uses pagination on the title
13651 page (in the standard classes, title pages are
13652 \begin_inset Quotes eld
13656 \begin_inset Quotes erd
13660 \begin_inset space \thinspace{}
13664 \begin_inset space \space{}
13668 If you want an empty title page, type
13672 aliaspagestyle{title}{empty}
13677 \begin_layout Description
13678 Article: With the class option
13684 Layout\SpecialChar \menuseparator
13685 Document\SpecialChar \menuseparator
13687 \begin_inset space ~
13692 ), you can emulate article style.
13693 That is, counters (footnotes, figures, tables etc.) will not be reset on
13694 new chapters, chapters don't start a new page (but are—in contrary to
13695 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13702 article classes—still allowed), parts, though, use their own page, as in
13706 \begin_layout Description
13707 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13708 font commands, which have been used in the old LaTeX version 2.09 (e.
13709 \begin_inset space \thinspace{}
13713 \begin_inset space \space{}
13729 It produces an error and stops LaTeX whenever such a command appears.
13734 reallows the commands and spits out warnings instead (which does at least
13736 Since a lot of packages and particularly BibTeX style files are still using
13737 those commands, we have decided to use this option by default.
13740 \begin_layout Subsection
13744 \begin_layout Standard
13745 We will only describe the features supported by LyX (which is not much currently
13747 Please consult the Memoir manual
13751 \begin_layout Plain Layout
13756 \begin_layout Plain Layout
13766 \begin_inset Flex URL
13769 \begin_layout Plain Layout
13771 CTAN:/macros/latex/memoir/memman.pdf
13784 \begin_layout Description
13785 Abstract: You may wonder why an abstract is an extra feature.
13786 Well, it is in book class.
13787 Usually books don't have abstracts.
13788 Memoir, however, has.
13789 You can use it wherever and how often you like.
13792 \begin_layout Description
13793 Chapterprecis: You may know this from belletristic: The contents of a chapter
13794 is shortly described below the title and also in the table of contents
13796 \begin_inset space \thinspace{}
13800 \begin_inset space \space{}
13805 Our hero arrives in Troia; he loses some friends; he finds others
13808 Chapterprecis does exactly this.
13809 It is therefore only sensible below a chapter.
13812 \begin_layout Description
13813 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13814 The epigraph environment provides an elegant way of typesetting such a
13816 The motto itself (text) and its author (source) are divided by a short
13818 Unfortunately, we have to fool LyX a bit here again, since the environment
13819 needs two arguments (text and source).
13820 In this case, we have to use curly brackets (in TeX mode) between the two
13831 <author of the slogan>.
13834 \begin_layout Description
13835 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13836 complex figurative poems).
13837 LyX can only support a few of them.
13838 One is poemtitle, which is a centered title for poems, which will also
13839 be added to the table of contents (verse is the standard environment for
13841 Memoir has some enhanced versions of verse, but you need to use TeX code,
13842 because they have to be nested inside regular verse environments, which
13843 is not possible with LyX).
13846 \begin_layout Description
13847 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13850 \begin_layout Section
13851 Article (mwart), book (mwbk) and report (mwrep)
13852 \begin_inset OptArg
13855 \begin_layout Plain Layout
13868 \begin_layout Standard
13874 \begin_layout Standard
13875 The LyX document classes
13891 correspond to the LaTeX document classes
13904 They are replacements for the standard document classes
13916 , resp., and fit better to Polish typography conventions in a number of points.
13920 \begin_layout Standard
13924 \begin_layout Itemize
13925 Unnumbered titles (with star, e.
13926 \begin_inset space \thinspace{}
13930 \begin_inset space \space{}
13937 ) are added into table of contents,
13940 \begin_layout Itemize
13941 Additional page styles:
13945 \begin_layout Description
13946 uheadings header with separated lines,
13949 \begin_layout Description
13950 myheadings custom header, contents headers via commands:
13965 \begin_layout Description
13966 myuheadings custom header with separated lines,
13969 \begin_layout Description
13970 outer page number is placed on outer side of page
13974 \begin_layout Itemize
13979 \begin_layout Description
13980 rmheadings serif titles — default,
13983 \begin_layout Description
13984 sfheadings sansserif titles,
13987 \begin_layout Description
13988 authortitle on title page first placed is author next title — default,
13991 \begin_layout Description
13992 titleauthor on title page first placed is title next author,
13995 \begin_layout Description
13996 withmarginpar reserve place on page for margins.
14000 \begin_layout Section
14004 \begin_layout Standard
14009 provides an alternative to the standard
14014 It provides similar functionality, but you might prefer this layout with
14015 sans serif sections, headings, and more.
14018 \begin_layout Section
14022 \begin_layout Standard
14028 \begin_layout Standard
14029 \begin_inset VSpace bigskip
14035 \begin_layout Standard
14040 \begin_inset space ~
14045 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14046 \begin_inset Formula $\beta
14050 release of May, 1999) class.
14053 \begin_layout Standard
14058 textclass, which works with RevTeX 3.1.
14059 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14060 That means that it doesn't interact very well with LyX, which requires
14061 LaTeX2e, although it has been kludged to work.
14062 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14066 \begin_inset space ~
14071 textclass should also be pretty easy to use.
14074 \begin_layout Standard
14075 These documents are supposed to be used in
14079 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14080 macros, and assume you'll know what to put in the preamble if necessary.
14083 \begin_layout Subsection
14087 \begin_layout Standard
14088 All you need to do is install RevTeX 4, as described in the package's README
14090 The package can be found at The RevTeX 4 Web Site
14091 \begin_inset Flex URL
14094 \begin_layout Plain Layout
14096 http://publish.aps.org/revtex4/
14102 Install it somewhere that LaTeX can see it.
14103 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14105 \begin_inset space \thinspace{}
14109 \begin_inset space \space{}
14112 not the directory where you installed the class file.) Then, if you reconfigure
14113 LyX, it will find the class file and let you use the RevTeX4 textclass.
14116 \begin_layout Standard
14117 Probably the easiest way to get started is either to import a RevTeX 4 document
14125 \begin_inset space ~
14130 template, found in the templates directory.
14133 \begin_layout Subsection
14137 \begin_layout Standard
14138 Optional arguments to
14145 \begin_inset Quotes eld
14149 \begin_inset Quotes erd
14153 \begin_inset Quotes eld
14157 \begin_inset Quotes erd
14167 \begin_inset space ~
14175 \begin_inset space ~
14181 Remember that in RevTeX, at least one optional argument is required!
14184 \begin_layout Standard
14185 Other preamble matter, like
14192 \begin_inset space ~
14198 \begin_inset space ~
14203 dialog, also as usual.
14206 \begin_layout Subsection
14210 \begin_layout Standard
14211 The layouts basically correspond to the commands in RevTeX4.0.
14212 For example, the Email layout corresponds to
14219 Note that (at least as of RevTeX 4.0 Beta), the
14227 layouts are exactly equivalent, so you shouldn't need to use both.
14231 \begin_layout Plain Layout
14232 In case you're curious, both were included so that
14236 would be able to translate both
14256 \begin_layout Subsection
14260 \begin_layout Standard
14261 There are a couple of important unique aspects of RevTeX 4 which might cause
14262 bugs that will be even more confusing in LyX.
14265 \begin_layout Standard
14283 The LyX equivalent is that there is a separate Thanks layout.
14288 write footnotes in the
14292 layout, or weird things may happen.
14293 See the RevTeX 4 documentation for more details.
14296 \begin_layout Standard
14300 \begin_inset space ~
14308 \begin_inset space ~
14317 layouts must be placed
14325 layout and the corresponding
14342 , the LaTeX won't compile.
14345 \begin_layout Subsection
14349 \begin_layout Standard
14350 The main problem with this layout is that you can't use the optional arguments
14351 to layouts like Email and Title.
14352 (The problem is not unique to this layout; you can't use optional arguments
14353 to the Section layouts either.) This means that after you export that file
14354 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14355 need to edit the LaTeX file with a text editor to add the optional arguments
14357 \begin_inset space \thinspace{}
14361 \begin_inset space \space{}
14364 the running title for the page headers.
14365 Lacking these layouts makes the
14371 (and the equivalent
14377 ) useless, so the corresponding layouts don't exist, and will have to be
14382 \begin_layout Plain Layout
14387 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14388 has not been updated yet to take advantage of it.
14396 \begin_layout Section
14397 Springer Journals (
14404 \begin_layout Standard
14410 \begin_layout Subsection
14414 \begin_layout Standard
14415 These are the layout files for some of the journal formats used by Springer
14416 Verlag and listed on
14417 \begin_inset Flex URL
14420 \begin_layout Plain Layout
14422 http://www.springer.de/author/tex/help-journals.html
14427 , where you should also go to fetch the class files (yes, these are LaTeX2e
14429 It is a modular system: the things common to all journals are implemented
14434 , which journal-specific layout files (such as, e.
14435 \begin_inset space \thinspace{}
14439 \begin_inset space \space{}
14446 for Journal of Geodesy) can include.
14449 \begin_layout Standard
14450 This means that implementing support for any other Springer journal on this
14451 list is as simple as writing your own
14459 file following the outline given in
14467 \begin_layout Standard
14468 It is reasonably well tested only for the Journal of Geodesy.
14477 come with the standard LyX distribution.
14478 Install the relevant class file (downloaded from Springer) in a proper
14479 directory, reconfigure LaTeX (in the teTeX case by running
14483 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14484 and it should work.
14487 \begin_layout Subsection
14491 \begin_layout Standard
14492 A large number of theorem-like styles —
14498 \SpecialChar \ldots{}
14504 \begin_layout Standard
14507 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14508 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14511 See the Springer class file documentation for details.
14514 \begin_layout Subsection
14518 \begin_layout Itemize
14530 \begin_layout Itemize
14533 Probability Theory and Related Fields
14539 — Jean-Marc Lasgouttes
14542 \begin_layout Standard
14543 Add your own, it isn't so hard!
14546 \begin_layout Subsection
14550 \begin_layout Standard
14551 These files are partly based on the older
14555 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14556 file from Springer.
14561 layout, are now defunct.
14562 Jean-Marc Lasgouttes helped out big in making me find my way around the
14563 LyX layout file mechanism.
14566 \begin_layout Subsection
14570 \begin_layout Standard
14572 But probably less than in the old hacked-LaTeX
14579 \begin_layout Standard
14581 \begin_inset space \thinspace{}
14584 g.: does not display the number for theorem-like layouts, just #.
14587 \begin_layout Section
14593 \begin_inset CommandInset label
14602 \begin_layout Standard
14610 \begin_layout Subsection
14614 \begin_layout Standard
14615 This section describes how to use LyX to make slides for overhead projectors.
14616 There are two document classes that can do this: the default slides class
14622 This section documents the former.
14625 \begin_layout Standard
14626 I'm going to say this again, nice and clear, so that there's no misunderstanding
14630 \begin_layout Standard
14631 \begin_inset VSpace bigskip
14637 \begin_layout Standard
14641 This section documents the class
14642 \begin_inset Quotes eld
14650 \begin_inset Quotes erd
14658 \begin_layout Standard
14659 \begin_inset VSpace bigskip
14665 \begin_layout Standard
14666 If you're looking for the documentation for
14667 \begin_inset Quotes eld
14675 \begin_inset Quotes erd
14678 , check out section
14679 \begin_inset space ~
14683 \begin_inset CommandInset ref
14685 reference "sec:foiltex"
14695 \begin_inset Quotes eld
14703 \begin_inset Quotes erd
14706 ] is actually somewhat better than the default
14714 \begin_layout Plain Layout
14715 \SpecialChar \ldots{}
14716 or so I've been told repeatedly by its advocates.
14717 Having never used it, I have no idea if this claim is true or not.
14722 which this section documents.
14725 \begin_layout Standard
14726 This class is the LaTeX2e improvement of the old
14731 Every LaTeX2e distribution includes this class [which I'll just refer to
14733 \begin_inset Quotes eld
14741 \begin_inset Quotes erd
14744 from now on], so you're bound to have it.
14745 As I noted earlier, there are other classes, such as
14749 , which also produce slides for overhead projectors and do a better job
14751 However, there are some things which
14755 can do which the others can't, such as generate overlays.
14756 Read on to learn more!
14759 \begin_layout Subsection
14761 \begin_inset CommandInset label
14763 name "sec:slidesetup"
14770 \begin_layout Standard
14771 Obviously, to use this document class, you need to select
14772 \begin_inset Quotes eld
14780 \begin_inset Quotes erd
14783 from the class list in the
14785 Document\SpecialChar \menuseparator
14789 There are some other special things you should know about this class:
14792 \begin_layout Itemize
14793 Don't bother changing the options
14798 They're not supported by the
14805 \begin_layout Itemize
14809 \begin_inset space ~
14814 behaves a bit differently for this class.
14815 The possible choices and what they do are as follows:
14819 \begin_layout Description
14824 The final output contains page numbers in the lower right corner.
14827 \begin_layout Description
14836 , but also prints out any time markers you've put in.
14837 This is the default.
14840 \begin_layout Description
14845 The final output contains no page numbers, time markers, or alignment markers.
14849 \begin_layout Itemize
14854 class has an extra option:
14860 \begin_inset Quotes eld
14868 \begin_inset Quotes erd
14871 in the extra class options.
14875 \begin_layout Standard
14876 Using this options allows you to add time markers to
14882 \begin_inset space ~
14886 \begin_inset CommandInset ref
14888 reference "sec:slideNote"
14896 \begin_layout Standard
14897 You can also use the template file
14898 \begin_inset Quotes eld
14906 \begin_inset Quotes erd
14909 to automatically set up a document to use the
14915 File\SpecialChar \menuseparator
14917 \begin_inset space ~
14921 \begin_inset space ~
14926 to open your new document].
14927 The template file also contains some examples of the special paragraph
14928 environments used by this class.
14929 I'll describe those next.
14932 \begin_layout Subsection
14933 Paragraph Environments
14936 \begin_layout Subsubsection
14937 Supported Environments
14940 \begin_layout Standard
14941 The first thing you'll notice when you start up a new
14945 document is the font size and type: it's the equivalent of the size
14946 \begin_inset Quotes eld
14954 \begin_inset Quotes erd
14960 \begin_inset space ~
14966 This is also what's used in the output.
14968 \begin_inset Quotes eld
14972 \begin_inset Quotes erd
14975 to remind you that this is a slide.
14976 Your final slides will use a larger font; ergo, you'll have less space.
14977 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14980 \begin_layout Standard
14981 The next thing that becomes obvious is the changes to the paragraph environment
14982 pull-down box [at the far-left end of the toolbar].
14983 Most of the paragraph environments you're used to seeing are missing.
14984 There are also five new ones.
14989 class itself only supports certain paragraph environments:
14992 \begin_layout Itemize
14998 \begin_layout Itemize
15004 \begin_layout Itemize
15010 \begin_layout Itemize
15016 \begin_layout Itemize
15022 \begin_layout Itemize
15028 \begin_layout Itemize
15034 \begin_layout Itemize
15040 \begin_layout Itemize
15046 \begin_layout Itemize
15052 \begin_layout Itemize
15058 \begin_layout Standard
15059 All of the other standard environments, including the section-heading environmen
15060 ts, aren't used in the
15067 \begin_layout Standard
15068 On the other hand, you'll notice the following new environments:
15071 \begin_layout Itemize
15077 \begin_layout Itemize
15083 \begin_layout Itemize
15089 \begin_layout Itemize
15095 \begin_layout Itemize
15101 \begin_layout Standard
15102 These five are kind of quirky, due to a
15103 \begin_inset Quotes eld
15107 \begin_inset Quotes erd
15111 You see, LyX doesn't permit you to nest any other paragraph environment
15112 into an empty environment.
15113 Now, that's fine and dandy, but it means that you wouldn't be able to start
15114 a slide with anything except plain text.
15115 To deal with this, I've performed a little
15116 \begin_inset Quotes eld
15120 \begin_inset Quotes erd
15126 \begin_layout Subsubsection
15127 Quirks of the New Environments
15128 \begin_inset CommandInset label
15130 name "sec:slideQuirk"
15137 \begin_layout Standard
15138 All five of the new paragraph environments are somewhat quirky due to inherent
15139 limitiations in the current version of LyX.
15140 As I just mentioned, LyX forbids environments that begin with another environme
15142 To get around this, the
15146 environment isn't a paragraph environment as described in the
15154 \begin_layout Standard
15155 You should consider
15168 \begin_inset Quotes eld
15171 pseudo-environments.
15172 \begin_inset Quotes erd
15175 They look like a section heading or a
15176 \begin_inset Quotes eld
15184 \begin_inset Quotes erd
15187 but really begin a [and, if necessary, end the previous] paragraph environment.
15197 \begin_inset Quotes eld
15201 \begin_inset Quotes erd
15204 These two perform some action.
15207 \begin_layout Standard
15208 A common feature of all five environments,
15228 , is a rather long-ish label.
15229 The text following this label — ordinarily the contents of the paragraph
15230 environment — is utterly irrelevant for
15251 LyX completely ignores it.
15252 In fact, you can leave these five environments completely empty.
15256 \begin_layout Standard
15261 to put any text after the rather long-ish label, you might want to.
15262 This could be a short description of the contents of the
15267 In that case, enter in your descriptive comment and hit
15271 as you normally would.
15274 \begin_layout Standard
15275 If, on the other hand, you don't want to enter in any descriptive text,
15276 you'll hit another LyX quirk.
15277 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15278 environment until you put something in the old one.
15282 \begin_layout Itemize
15283 Start entering the text that will
15311 \begin_layout Itemize
15312 Now move to the beginning of that paragraph.
15316 \begin_layout Itemize
15325 \begin_layout Itemize
15326 Finally, change this new, empty paragraph to a
15350 \begin_layout Standard
15351 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15355 \begin_layout Subsection
15356 Making a Presentation with
15369 \begin_layout Subsubsection
15377 \begin_layout Standard
15378 If you're expecting this section to teach you how to actually make a presentatio
15379 n, you'll be sorely disappointed.
15380 Naturally, I'll describe all of the ways the
15384 class can assist you in preparing the materials for a presentation.
15385 Filling in the contents, however, is up to you.
15390 the LyX philosophy.]
15393 \begin_layout Standard
15398 environment [in the manner described in section
15399 \begin_inset space ~
15403 \begin_inset CommandInset ref
15405 reference "sec:slideQuirk"
15409 ] tells LyX to begin a new slide [duh].
15410 The label for this environment/
15411 \begin_inset Quotes erd
15415 \begin_inset Quotes erd
15419 \begin_inset Quotes eld
15423 \begin_inset Quotes erd
15426 in cool blue, followed by the label,
15427 \begin_inset Quotes eld
15431 \begin_inset Quotes erd
15435 Any text or paragraph environments that follow this one go on the new slide.
15439 \begin_layout Standard
15440 Slides are probably the only time you'll need to forcibly end pages in LyX
15441 (this can be specified in the
15446 In fact, you'll want to, once you finish entering the contents of one slide.
15447 If you've entered more text than can physically fit on a slide, the extra
15448 overflows onto a new slide.
15449 I don't recommend doing this, however, since the overflow slide won't have
15450 any page number on it.
15451 Furthermore, it may interfere with any
15455 you've made to accompany the oversized
15462 \begin_layout Standard
15471 environments work the same way as the
15476 They both create an
15477 \begin_inset Quotes eld
15481 \begin_inset Quotes erd
15484 followed by a label [
15485 \begin_inset Quotes eld
15489 \begin_inset Quotes erd
15493 \begin_inset Quotes eld
15497 \begin_inset Quotes erd
15501 The color is a stunning magenta instead of blue, and the
15502 \begin_inset Quotes eld
15506 \begin_inset Quotes erd
15509 will look different, in style and in length.
15510 The label fonts of all three also differ from one another.
15513 \begin_layout Standard
15518 , if the contents of a
15526 exceed the physical size of a slide or sheet of paper, the extra will overflow
15528 Again, you should avoid this.
15529 It defeats the whole purpose of
15540 \begin_layout Subsubsection
15550 \begin_layout Standard
15555 is a slide that sits atop another slide.
15556 Perhaps you wish to discuss a figure on the main
15560 before displaying the text associated with it.
15561 One way to accomplish this is tape a flap of dark paper over the part of
15566 you want to display later.
15567 This method fails, however, if you wish to overlap one graph with another,
15569 You would then have to fumble while speaking to align the two separate,
15574 s to align the two graphs.
15579 environment in both cases makes life much easier.
15582 \begin_layout Standard
15587 receives the page number of its
15588 \begin_inset Quotes eld
15592 \begin_inset Quotes erd
15600 \begin_inset Quotes eld
15608 \begin_inset Quotes erd
15615 \begin_layout Plain Layout
15616 Presumably, mutliple
15621 \begin_inset Quotes eld
15629 \begin_inset Quotes erd
15633 \begin_inset Quotes eld
15641 \begin_inset Quotes erd
15645 \begin_inset Quotes eld
15653 \begin_inset Quotes erd
15657 \begin_inset space ~
15660 appended to the page number of the parent
15670 Clearly, you want the contents of both the
15678 to each fit on a single physical slide! You should probably consider an
15684 \begin_inset Quotes eld
15688 \begin_inset Quotes erd
15700 class provides a visual cue for this: the label at the start of an
15704 is shorter than that at the start of a
15709 Lastly, when you generate printable output, you'll find alignment markers
15710 in all four corners of both the
15714 page and its parent
15719 These will assist you in lining up the two physical slides.
15722 \begin_layout Standard
15723 The major problem in overlaying two slides is aligning the contents of the
15724 two transparencies.
15725 How much space should you leave for that graph on the second slide? Worse
15726 still, what if you want a graph and a sentence on second slide, but there
15727 is text on the main transparency that goes in between them? You could try
15728 and insert vertical space of the right size.
15729 The better way is to use
15740 \begin_layout Standard
15741 As their names imply,
15749 are two command-like paragraph environments that make all subsequent text
15750 invisible and visible, respectively.
15752 \begin_inset space ~
15756 \begin_inset CommandInset ref
15758 reference "sec:slideQuirk"
15762 that you don't place anything
15766 these two environments, however.
15771 , it inserts a centered, sky-blue label into the page reading
15772 \begin_inset Quotes eld
15775 <Invisible Text Follows>
15776 \begin_inset Quotes erd
15780 For paragraphs following this label, the parts of the
15788 ; it doesn't matter which] where they would be contain instead blank space.
15792 \begin_layout Standard
15797 , the corresponding centered label is
15798 \begin_inset Quotes eld
15801 <Visible Text Follows>
15802 \begin_inset Quotes erd
15806 Paragraphs following this label behave normally.
15807 Note that the beginning of a new
15819 automatically shuts off an
15824 It's therefore not necessary to use
15835 \begin_layout Standard
15836 By now, it should be obvious how to create overlay transparencies using
15837 the proper combination of
15856 \begin_layout Enumerate
15861 , including everything that will appear on it, whether on the main slide
15869 \begin_layout Enumerate
15870 Before each figure or paragraph that will appear only on the
15879 If necessary, insert a
15883 environment after the
15890 \begin_layout Enumerate
15895 immediately following the
15902 \begin_layout Enumerate
15903 Copy the contents of this
15914 \begin_layout Enumerate
15919 , change all of the
15930 \begin_layout Standard
15932 You've just made an
15939 \begin_layout Standard
15940 There's one problem with the way I've designed the LyX
15944 class: you can't make text in the middle of a paragraph invisible, nor
15945 make text in the middle of an invisible paragraph visible again.
15946 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15950 \begin_layout Plain Layout
15951 The commands of interest are:
15954 \begin_layout Itemize
15959 invisible \SpecialChar \ldots{}
15963 \begin_layout Itemize
15968 visible \SpecialChar \ldots{}
15972 \begin_layout Plain Layout
15973 \SpecialChar \ldots{}
15974 and need to be marked as TeX.
15976 \begin_inset Quotes eld
15980 \begin_inset Quotes erd
15983 you wish to change goes in between the brackets [and after the
15996 If you don't know how to mark text as TeX, see the appropriate section
16009 \begin_layout Subsubsection
16019 \begin_inset CommandInset label
16021 name "sec:slideNote"
16028 \begin_layout Standard
16037 is associated with a
16038 \begin_inset Quotes eld
16042 \begin_inset Quotes erd
16054 class provides visual cues.
16059 is shorter than that of a
16063 [yet longer than that of an
16067 ] and, like the label of an
16071 is shockingly magenta.
16072 Additionally, the printed
16076 has the page number of its
16077 \begin_inset Quotes eld
16081 \begin_inset Quotes erd
16089 \begin_inset Quotes eld
16097 \begin_inset Quotes erd
16101 \begin_inset Quotes eld
16109 \begin_inset Quotes erd
16113 \begin_inset Quotes eld
16121 \begin_inset Quotes erd
16125 You can have multiple
16129 s associated with a single
16141 , you'll probably want to break up long
16145 s so that they fit on a single sheet of paper.
16148 \begin_layout Standard
16153 is obvious: it contains anything additional you might want to say about
16159 It could also be used as a sheet of reminders for a particular
16164 In the case of the latter, you might want to make use of time markers.
16170 \begin_inset Quotes eld
16174 \begin_inset Quotes erd
16177 support for time markers, a
16182 So, you'll have to resort to using the LaTeX codes.
16185 \begin_layout Standard
16186 To use time markers, you'll need to specify the extra class option
16187 \begin_inset Quotes eld
16195 \begin_inset Quotes erd
16199 \begin_inset space ~
16203 \begin_inset CommandInset ref
16205 reference "sec:slidesetup"
16210 This option turns on timing marks, which will appear in the lower-left-hand
16216 To set what appears in the time marker, you use the LaTeX commands
16217 \begin_inset Quotes eld
16227 \begin_inset Quotes erd
16231 \begin_inset Quotes eld
16241 \begin_inset Quotes erd
16245 The arguments of both commands are time measured in seconds.
16247 \begin_inset Quotes eld
16257 \begin_inset Quotes erd
16260 sets the time marker to a given time.
16262 \begin_inset Quotes eld
16272 \begin_inset Quotes erd
16275 increments the time marker by the specified amount.
16276 Using time markers and
16280 s in this fashion, you can remind yourself how much time to spend on a particula
16288 \begin_layout Standard
16289 There's one last feature to describe.
16290 Clearly, you'd like to print out all of your
16298 s on transparencies while printing all of your
16315 with which it is associated.
16316 What's a person to do?
16319 \begin_layout Standard
16320 Luckily, there are two LaTeX commands that allow you to select what to print
16322 Both must be placed into the preamble of your document.
16324 \begin_inset Quotes eld
16336 \begin_inset Quotes erd
16339 will cause the output to contain only the
16348 Correspondingly, the command
16349 \begin_inset Quotes eld
16361 \begin_inset Quotes erd
16364 prevents the output of anything but
16369 I'd advise placing both commands in the preamble and initially comment
16371 You can then preview your entire presentation as you write.
16372 When you're done writing, you can then uncomment one of the two to select
16373 what you want to print.
16374 I like to uncomment
16375 \begin_inset Quotes eld
16387 \begin_inset Quotes erd
16390 , print to a file with
16391 \begin_inset Quotes eld
16399 \begin_inset Quotes erd
16402 in its name, comment it back out, then uncomment
16403 \begin_inset Quotes eld
16415 \begin_inset Quotes erd
16419 \begin_inset Quotes eld
16427 \begin_inset Quotes erd
16431 I can then send either file to a printer, loading transparencies or plain
16432 paper as appropriate.
16435 \begin_layout Standard
16436 You can also provide other arguments to the
16437 \begin_inset Quotes eld
16447 \begin_inset Quotes erd
16451 \begin_inset Quotes eld
16461 \begin_inset Quotes erd
16465 See a good LaTeX book for details.
16468 \begin_layout Subsection
16473 Class Template File
16476 \begin_layout Standard
16477 I have also provided a template file,
16478 \begin_inset Quotes eld
16486 \begin_inset Quotes erd
16494 To use it, begin your new presentation with
16499 ile\SpecialChar \menuseparator
16501 \begin_inset space ~
16505 \begin_inset space ~
16515 Your new LyX presentation file will contain an example
16536 additionally contain an example of the use of
16545 Lastly, the preamble will contain:
16548 \begin_layout LyX-Code
16549 % Uncomment to print out only slides and overlays
16552 \begin_layout LyX-Code
16556 \begin_layout LyX-Code
16562 \begin_inset Newline newline
16568 \begin_layout LyX-Code
16569 % Uncomment to print out only notes
16572 \begin_layout LyX-Code
16576 \begin_layout LyX-Code
16584 \begin_layout Standard
16585 One final thing: I created this class to support the LaTeX2e
16586 \begin_inset Quotes eld
16594 \begin_inset Quotes erd
16597 class, one of the built-in LaTeX2e classes.
16598 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16599 built-in slide class.
16600 It's here if you want it or need it.
16601 There exist other LaTeX2e classes for creating presentations, such as the
16607 \begin_inset space ~
16611 \begin_inset CommandInset ref
16613 reference "sec:foiltex"
16618 \begin_inset Quotes eld
16626 \begin_inset Quotes erd
16629 package [present on some TeX distributions].
16630 The latter is not yet supported under LyX.
16634 \begin_layout Plain Layout
16635 Perhaps you can take on the task\SpecialChar \ldots{}
16641 I know nothing about these other classes.
16642 Try them out to see what sort of alternative they provide.
16645 \begin_layout Chapter
16646 LyX Features needing Extra Software
16649 \begin_layout Section
16653 \begin_layout Standard
16659 \begin_layout Subsection
16663 \begin_layout Standard
16672 \begin_layout Plain Layout
16677 is not yet available when you are using the LaTeX distribution MiKTeX.
16682 , you'll find in the
16689 \begin_inset space ~
16700 \begin_inset CommandInset href
16702 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16709 \begin_layout Standard
16714 package is a program that was written by
16715 \begin_inset Flex CharStyle:Noun
16718 \begin_layout Plain Layout
16720 \begin_inset space ~
16728 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16729 and easy to forget.
16730 The program runs over your LaTeX file, checks the integrity of the file,
16731 and flags some common errors.
16732 In other technical words, it is
16739 \begin_layout Standard
16740 Well, what is a syntax checker doing in LyX which is supposed to produce
16741 correct LaTeX anyways? The answer is simple: Just as
16745 not only checks the
16749 of C programs, but also does
16753 checks for type-errors,
16757 catches some common
16761 errors, in addition to the syntactical ones.
16766 is capable of detecting several common errors, such as
16769 \begin_layout Itemize
16770 Ellipsis detection:
16771 \begin_inset Newline newline
16774 Use \SpecialChar \ldots{}
16778 \begin_layout Itemize
16779 No space in front of/after parenthesis:
16780 \begin_inset Newline newline
16786 \begin_layout Itemize
16787 Enforcement of normal space after common abbreviations:
16788 \begin_inset Newline newline
16792 \begin_inset space \thinspace{}
16796 \begin_inset space \space{}
16799 is too wide spacing.
16802 \begin_layout Itemize
16803 Enforcement of end-of-sentence space when the last sentence ends with a
16805 \begin_inset Newline newline
16809 And this is wrong spacing.
16812 \begin_layout Itemize
16813 Space in front of labels and similar commands:
16814 \begin_inset Newline newline
16817 The label should stick right up to the text to avoid falling to a wrong
16820 \begin_inset CommandInset label
16830 \begin_layout Plain Layout
16831 This footnote is in danger of falling off to a wrong page
16836 The label is separated too much.
16839 \begin_layout Itemize
16840 Space in front of references, instead of hard spaces:
16841 \begin_inset Newline newline
16844 In you are in bad luck, the text will break right between the referenced
16845 text and reference number, and that's a pity.
16847 \begin_inset CommandInset ref
16849 reference "sec:chktex"
16856 \begin_layout Itemize
16858 \begin_inset Quotes eld
16862 \begin_inset Quotes erd
16866 \begin_inset Formula $\times
16871 \begin_inset Newline newline
16874 2x2 looks cheap compared to
16875 \begin_inset Formula $2\times2
16882 \begin_layout Standard
16883 and more \SpecialChar \ldots{}
16884 It is an invaluable tool when you are
16885 \begin_inset Quotes eld
16889 \begin_inset Quotes erd
16892 your document before printing, and you should run it right after the obligatory
16893 spelling check, and before you go fine tuning the typesetting.
16896 \begin_layout Subsection
16900 \begin_layout Standard
16901 If you have the program installed, usage is as simple as choosing
16903 Tools\SpecialChar \menuseparator
16905 \begin_inset space ~
16911 This will make LyX generate a LaTeX file of your document, start
16915 to check it, and then make LyX insert
16916 \begin_inset Quotes eld
16920 \begin_inset Quotes erd
16923 with the warnings from
16927 , if there were any.
16928 The warnings will be placed close to the point of the mistake, and you
16929 can quickly find them by using the
16931 Navigate\SpecialChar \menuseparator
16934 menu item, or the shortcut key
16943 Open the error boxes by clicking on them with the mouse, or use the shortcut
16952 bindings, or the corresponding
16961 Read the warning and correct the mistake, if it is a mistake.
16962 If you have trouble understanding what the warning is about, you can safely
16964 Remember that there is a hidden layer between the document on screen and
16965 the technical details in invoking
16969 , and this gap can make some warnings seem arcane or just right down plain
16973 \begin_layout Standard
16974 This document is an excellent testing bed for the feature, and it should
16975 provide quite a few warnings for you to fiddle with.
16976 Since computers are only so smart, expect most of the warnings to be false
16980 \begin_layout Subsection
16981 How to fine tune it
16984 \begin_layout Standard
16985 Sometimes, you'll find that
16989 makes more noise than suits your mood.
16990 Then you can choose not to use it, wait until your mood changes, or try
16995 to get better along with you.
16996 Another choice in the most desperate situations is to use
16998 View\SpecialChar \menuseparator
17000 \begin_inset space ~
17004 \begin_inset space ~
17008 \begin_inset space ~
17013 , which will get rid of all warnings instantly.
17016 \begin_layout Standard
17025 very configurable and extensible, you shouldn't expect to solve all problems
17031 Since LyX has to generate a somewhat special LaTeX file to be able to match
17032 the line numbers from the
17040 \begin_layout Plain Layout
17041 You can inspect the specific output from
17047 Edit\SpecialChar \menuseparator
17049 \begin_inset space ~
17053 \begin_inset space ~
17067 to the internal document structure, some of the warnings will not seen
17068 to appear correctly.
17069 There are two things you can do about this:
17072 \begin_layout Itemize
17077 invocation command line in
17093 installation configuration file (usually with the file
17098 See below to learn what warnings can be enabled and disabled on the command
17103 \begin_layout Itemize
17104 Export your document as a raw LaTeX file using
17106 File\SpecialChar \menuseparator
17107 Export\SpecialChar \menuseparator
17115 Invoked in this way, it can be a hassle to find the corresponding place
17116 in the document inside LyX, but with a little patience, you should be able
17120 \begin_layout Standard
17121 Here follows the warning messages that can be enabled and disabled in
17130 to disable a warning, and
17134 to enable a warning.
17135 The emphasized entries are disabled by default, because the default is
17138 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17143 \begin_layout Standard
17144 Notice that you should only use the options that enable and disable warnings,
17145 because LyX relies on some of the other command line parameters to be set
17146 in a specific way to have a chance to communicate with
17153 \begin_layout Enumerate
17157 Command terminated with space.
17160 \begin_layout Enumerate
17163 Non-breaking space (
17164 \begin_inset Quotes eld
17172 \begin_inset Quotes erd
17175 ) should have been used.
17178 \begin_layout Enumerate
17182 You should enclose the previous parenthesis with
17183 \begin_inset Quotes eld
17191 \begin_inset Quotes erd
17197 \begin_layout Enumerate
17200 Italic correction (
17201 \begin_inset Quotes eld
17211 \begin_inset Quotes erd
17214 ) found in non-italic buffer.
17217 \begin_layout Enumerate
17220 Italic correction (
17221 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17234 ) found more than once.
17237 \begin_layout Enumerate
17241 No italic correction (
17242 \begin_inset Quotes eld
17252 \begin_inset Quotes erd
17258 \begin_layout Enumerate
17262 \begin_inset Quotes eld
17270 \begin_inset Quotes erd
17274 \begin_inset Quotes eld
17282 \begin_inset Quotes erd
17288 \begin_layout Enumerate
17291 Wrong length of dash may have been used.
17294 \begin_layout Enumerate
17298 \begin_inset Quotes eld
17306 \begin_inset Quotes erd
17310 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17324 \begin_layout Enumerate
17328 \begin_inset Quotes eld
17336 \begin_inset Quotes erd
17342 \begin_layout Enumerate
17346 \begin_inset Quotes eld
17354 \begin_inset Quotes erd
17357 to achieve an ellipsis.
17360 \begin_layout Enumerate
17363 Inter-word spacing (
17364 \begin_inset Quotes eld
17374 \begin_inset Quotes eld
17377 ) should perhaps be used.
17380 \begin_layout Enumerate
17383 Inter-sentence spacing (
17384 \begin_inset Quotes eld
17394 \begin_inset Quotes erd
17397 ) should perhaps be used.
17400 \begin_layout Enumerate
17403 Could not find argument for command.
17406 \begin_layout Enumerate
17410 \begin_inset Quotes eld
17418 \begin_inset Quotes erd
17424 \begin_layout Enumerate
17427 Math mode still on at end of LaTeX file.
17430 \begin_layout Enumerate
17434 \begin_inset Quotes eld
17442 \begin_inset Quotes erd
17445 doesn't match the number of
17446 \begin_inset Quotes eld
17454 \begin_inset Quotes erd
17460 \begin_layout Enumerate
17463 You should use either
17466 \begin_inset Quotes eld
17474 \begin_inset Quotes erd
17479 as an alternative to
17480 \begin_inset Quotes eld
17488 \begin_inset Quotes erd
17494 \begin_layout Enumerate
17501 " (ASCII 39) instead of "
17508 \begin_layout Enumerate
17511 User-specified pattern found.
17514 \begin_layout Enumerate
17517 This command might not be intended.
17520 \begin_layout Enumerate
17527 \begin_layout Enumerate
17545 \begin_layout Enumerate
17548 Delete this space to maintain correct page references.
17551 \begin_layout Enumerate
17555 You might wish to put this between a pair of
17556 \begin_inset Quotes eld
17564 \begin_inset Quotes erd
17570 \begin_layout Enumerate
17573 You ought to remove spaces in front of punctuation.
17576 \begin_layout Enumerate
17579 Could not execute LaTeX command.
17582 \begin_layout Enumerate
17591 in front of small punctuation.
17594 \begin_layout Enumerate
17602 may look prettier here.
17605 \begin_layout Enumerate
17609 Multiple spaces detected in output.
17612 \begin_layout Enumerate
17615 This text may be ignored.
17618 \begin_layout Enumerate
17624 \begin_inset Quotes eld
17629 to begin quotation, not
17636 \begin_layout Enumerate
17643 to end quotation, not
17646 \begin_inset Quotes eld
17654 \begin_layout Enumerate
17660 \begin_layout Enumerate
17663 You should perhaps use
17664 \begin_inset Quotes eld
17672 \begin_inset Quotes erd
17678 \begin_layout Enumerate
17681 You should put a space in front of/after parenthesis.
17684 \begin_layout Enumerate
17687 You should avoid spaces in front of/after parenthesis.
17690 \begin_layout Enumerate
17694 You should not use punctuation in front of/after quotes.
17697 \begin_layout Enumerate
17700 Double space found.
17703 \begin_layout Enumerate
17706 You should put punctuation outside inner/inside display math mode.
17709 \begin_layout Enumerate
17712 You ought to not use primitive TeX in LaTeX code.
17715 \begin_layout Enumerate
17718 You should remove spaces in front of
17719 \begin_inset Quotes eld
17727 \begin_inset Quotes erd
17733 \begin_layout Enumerate
17736 \begin_inset Quotes eld
17744 \begin_inset Quotes erd
17747 is normally not followed by
17748 \begin_inset Quotes eld
17756 \begin_inset Quotes erd
17762 \begin_layout Standard
17763 In later versions of LyX, we hope to provide a more complete interface to
17764 this tool (and it's smaller cousin
17768 ) to exploit the full power of it.
17769 But it's not exactly useless as it is now: go try it on one of your existing
17770 documents of a certain length and be surprised.
17773 \begin_layout Section
17774 Version Control in LyX
17777 \begin_layout Standard
17780 Lars Gullik Bjønnes,
17787 \begin_layout Subsection
17791 \begin_layout Standard
17792 A friend of mine wanted to try LyX for a group project.
17793 When he didn't find support for version control or file locking, he dropped
17795 This angered me a bit, so I thought that I should at least make support
17796 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17797 This has now been done.
17798 LyX now supports some of the most basic RCS commands.
17799 If you need to something a bit more sophisticated you will have to do that
17800 manually in an xterm.
17803 \begin_layout Standard
17804 Before you begin to use the version control features in LyX, you should
17806 \begin_inset Quotes eld
17810 \begin_inset Quotes erd
17813 (a man file, read it with
17818 This file describes all the basic features of RCS.
17819 You should especially notice the comment about a RCS directory, and the
17820 notion of a master RCS file (the file ending in
17827 \begin_layout Standard
17828 Later basic CVS/SVN support was added.
17829 You should be familiar with CVS/SVN usage before start using it under LyX.
17830 Most of the log messages are not currently displayed after operations -
17831 you can check them in terminal window if unsure.
17834 \begin_layout Standard
17835 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17836 package—no guarantees are made for older versions.
17839 \begin_layout Standard
17840 For introducing your own external commands consult vc-command in the manual
17844 \begin_layout Subsection
17845 RCS commands in LyX
17848 \begin_layout Standard
17849 The following sections describe the RCS commands supported by LyX.
17850 You can find them in the
17852 File\SpecialChar \menuseparator
17854 \begin_inset space ~
17860 LyX was tested against RCS 5.7.
17863 \begin_layout Subsubsection
17869 \begin_layout Standard
17870 If your document is not under revision control, this is the only item shown
17872 And if it is under revision control, the
17876 item is not visible.
17880 \begin_layout Standard
17881 This command registers your document with RCS (unless you are under the
17882 directory managed by CVS)\SpecialChar \@.
17883 You are asked interactively to supply an initial
17884 description of the document.
17885 The document is now set in Read-Only mode and you have to
17888 \begin_inset space ~
17892 \begin_inset space ~
17896 \begin_inset space ~
17901 , before making any changes to it.
17902 A document under revision control has a
17903 \begin_inset Quotes eld
17906 [RCS:<version> <locker>]
17907 \begin_inset Quotes erd
17910 item tagged to the filename in the minibuffer.
17913 \begin_layout Standard
17914 RCS command that is run:
17916 ci -q -u -i -t-"<initial description>" <file-name>
17919 \begin_layout Standard
17924 to understand the switches.
17928 \begin_layout Subsubsection
17934 \begin_layout Standard
17935 When you are finished editing a file, you check in your changes.
17936 When you do this, you are asked for a description of the changes.
17937 This is stored in the history log.
17938 The version number is bumped, your changes are applied to the master RCS
17939 file, the document is unlocked and set to Read-Only mode.
17943 \begin_layout Standard
17946 ci -q -u -m"<description>" <file-name>
17949 \begin_layout Subsubsection
17955 \begin_layout Standard
17956 By doing this you lock the document so that only you can edit it.
17957 This will also make the document Read-Write only for you.
17958 You will usually continue editing for a while and when you are finished
17959 you check in your changes.
17960 The status line is changed to reflect that you have locked the file.
17964 \begin_layout Standard
17967 co -q -l <file-name>
17970 \begin_layout Subsubsection
17973 Revert To Repository Version
17976 \begin_layout Standard
17977 This will discard all changes made to the document since the last check
17979 You get a warning before changes are discarded.
17982 \begin_layout Standard
17985 co -f -u<version> <file-name>
17988 \begin_layout Subsubsection
17994 \begin_layout Standard
17995 This makes as if the last check in never happened.
17996 No changes are made to the document loaded into LyX, but the last version
17997 is removed from the master RCS file.
18001 \begin_layout Standard
18004 rcs -o<version> <file-name>
18007 \begin_layout Subsubsection
18013 \begin_layout Standard
18014 This show the complete history of the RCS document.
18019 is shown in a browser.
18027 \begin_layout Subsection
18028 CVS commands in LyX
18031 \begin_layout Standard
18032 CVS is now partially supported by LyX.
18033 You can find the commands in the
18035 File\SpecialChar \menuseparator
18037 \begin_inset space ~
18045 \begin_layout Subsubsection
18051 \begin_layout Standard
18052 If your document is not under revision control, this is the only item shown
18054 And if it is under revision control, the
18061 item is not visible.
18065 \begin_layout Standard
18066 This command registers in CVS your document ONLY in case you have already
18067 the documents directory under CVS control (in particular
18072 This means you have to checkout the archive by yourself.
18076 \begin_layout Standard
18077 Then you are asked interactively to supply an initial description of the
18079 Don't forget that registered file is not yet commited.
18082 \begin_layout Standard
18083 CVS command that is run:
18086 \begin_inset Quotes erd
18090 \begin_inset Quotes eld
18094 \begin_inset Quotes erd
18100 \begin_layout Standard
18105 to understand the switches.
18109 \begin_layout Subsubsection
18115 \begin_layout Standard
18116 When you are finished editing a file, you commit your changes.
18117 When you do this, you are asked for a description of the changes.
18118 After that changes are commited.
18121 \begin_layout Standard
18124 cvs -q commit -m"<description>" "<file-name>"
18127 \begin_layout Subsubsection
18130 Revert To Repository Version
18133 \begin_layout Standard
18134 This will discard all changes made to the document since the last check
18136 You get a warning before changes are discarded.
18137 Firstly the file is deleted, secondly CVS update command is run.
18140 \begin_layout Standard
18144 \begin_inset Quotes eld
18148 \begin_inset Quotes erd
18154 \begin_layout Subsubsection
18160 \begin_layout Standard
18161 This show the complete history of the CVS document.
18165 \begin_inset Quotes eld
18169 \begin_inset Quotes erd
18174 is shown in a browser.
18177 \begin_layout Subsection
18178 SVN commands in LyX
18181 \begin_layout Standard
18182 SVN is now partially supported by LyX.
18183 You can find the commands in the
18185 File\SpecialChar \menuseparator
18187 \begin_inset space ~
18193 Please note that if you use password protected access to repository via
18194 ssh, you will be asked in terminal window.
18195 LyX was tested against SVN 1.4 and 1.5.
18198 \begin_layout Subsubsection
18204 \begin_layout Standard
18205 If your document is not under revision control, this is the only item shown
18207 And if it is under revision control, the
18214 item is not visible.
18218 \begin_layout Standard
18219 This command registers in SVN your document ONLY in case you have already
18220 the documents directory under SVN control (in particular
18225 This means you have to checkout the archive by yourself.
18229 \begin_layout Standard
18230 Then you are asked interactively to supply an initial description of the
18232 Don't forget that registered file is not yet commited.
18235 \begin_layout Standard
18236 SVN command that is run:
18239 \begin_inset Quotes eld
18243 \begin_inset Quotes erd
18249 \begin_layout Standard
18254 to understand the switches.
18258 \begin_layout Subsubsection
18264 \begin_layout Standard
18265 When you are finished editing a file, you commit your changes.
18266 When you do this, you are asked for a description of the changes.
18267 After that changes are commited.
18270 \begin_layout Standard
18275 \begin_layout Plain Layout
18276 In case locking is not enabled.
18278 \begin_inset CommandInset ref
18280 reference "subsec:SVN-File-Locking"
18291 svn commit -q -m"<description>" <file-name>
18294 \begin_layout Subsubsection
18300 \begin_layout Standard
18301 Updates the changes of this file from the repository.
18302 Be sure you understand SVN merging and conflicts resolving before using
18303 this function, because all conflicts has to be done manually by you!
18306 \begin_layout Standard
18311 \begin_layout Plain Layout
18320 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18330 \begin_layout Subsubsection
18333 Revert To Repository Version
18336 \begin_layout Standard
18337 This will discard all changes made to the document since the last check
18339 You get a warning before changes are discarded.
18343 \begin_layout Standard
18347 \begin_inset Quotes eld
18351 \begin_inset Quotes erd
18357 \begin_layout Subsubsection
18363 \begin_layout Standard
18364 This show the complete history of the SVN document.
18368 \begin_inset Quotes eld
18372 \begin_inset Quotes erd
18377 is shown in a browser.
18380 \begin_layout Subsubsection
18382 \begin_inset CommandInset label
18384 name "subsec:SVN-File-Locking"
18391 \begin_layout Standard
18392 The file exchange through various revision control systems brings the problem
18393 of merge conflicts in case two different users try to edit the same (parts
18395 When such conflict happens it needs manual resolving and one reasonable
18396 alternative is to provide some kind of locking mechanism, which guarantees
18397 that only one user is allowed to edit file at the given time.
18400 \begin_layout Standard
18401 SVN has two mechanisms to provide such kind of mutual exclusivity for file
18402 access - locks and automatical setting of write permissions (see sec.
18404 \begin_inset CommandInset ref
18406 reference "subsec:Automatical-Locking-Property"
18411 \begin_inset Flex CharStyle:Code
18414 \begin_layout Plain Layout
18424 \begin_layout Plain Layout
18425 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
18431 In a case this property is detected for a given document LyX starts to
18432 use SVN locks for document editing automatically and the whole check-in/out
18433 mechanism switches to the same regimen as for RCS.
18434 This in particular means there are two different modes how file is used
18438 \begin_layout Itemize
18440 The loaded file is in the read-only mode.
18441 For editation on needs to check-out.
18446 consists of update from repository and gaining write lock.
18447 If the lock is not possible to obtain, we remain in unlocked state.
18450 \begin_layout Itemize
18452 The loaded file is in the 'normal' edit mode.
18453 No other user is allowed to edit the file.
18458 consists of commiting changes and releasing write-lock.
18459 If no changes have been made to the document, no commit will be produced
18463 \begin_layout Plain Layout
18464 Don't be puzzled by the fact that you will be asked for commit message anyway.
18469 and only the write-lock will be released.
18472 \begin_layout Standard
18476 \begin_layout Labeling
18477 \labelwidthstring 00.00.0000
18480 svn commit -q -m"<description>" "<file-name>"
18481 \begin_inset Newline newline
18484 svn unlock "<file-name>"
18487 \begin_layout Labeling
18488 \labelwidthstring 00.00.0000
18491 svn update "<file-name>"
18492 \begin_inset Newline newline
18495 svn lock "<file-name>"
18498 \begin_layout Subsubsection
18501 \begin_inset CommandInset label
18503 name "subsec:Automatical-Locking-Property"
18509 Automatical Locking Property
18512 \begin_layout Standard
18513 The above mentioned automatical setting of write permissions of the .lyx
18514 file can be set through
18519 ile\SpecialChar \menuseparator
18525 \begin_inset space ~
18528 Control\SpecialChar \menuseparator
18533 oggle locking property
18536 This command is active only when the file is not locked on the svn server
18538 you need to check-out before proceeding).
18541 \begin_layout Labeling
18542 \labelwidthstring 00.00.0000
18544 \begin_inset space ~
18550 \begin_layout Labeling
18551 \labelwidthstring 00.00.0000
18554 svn propset svn:needs-lock ON "<file-name>"
18557 \begin_layout Labeling
18558 \labelwidthstring 00.00.0000
18561 svn propdel svn:needs-lock "<file-name>"
18564 \begin_layout Subsubsection
18565 Revision Information in Documents
18568 \begin_layout Standard
18569 Currently there is no way how to provide such kind of information directly
18571 There are possibilities how to activate it with the help of svn features,
18572 but each has its own drawbacks.
18575 \begin_layout Standard
18576 One possibility is to use svn keywords
18580 \begin_layout Plain Layout
18581 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
18587 In short -- you set file keywords property (e.g.
18590 svn propset svn:keywords 'Rev' file.lyx
18592 ) and then paste keyword ERT
18596 \begin_layout Plain Layout
18597 This is an easy way how to ensure that LyX won't break the line in the middle
18603 tag in your document (e.g.
18608 \begin_layout Plain Layout
18616 This way svn client will automatically substitute revision number (e.g.
18621 \begin_layout Plain Layout
18628 ) after each update and commit.
18629 There are more problems with this approach.
18630 Firstly, the '$' character is used in TeX world for math equations, so
18631 any occurence of math formula
18632 \begin_inset Formula $Rev
18637 \begin_inset Formula $Rev:59
18641 in your LyX document.
18642 Similarly for other keywords like Id, Date, Author, etc.
18643 Secondly svn output is dependent on your locales, so its very easy that
18644 svn would produce some problematic strings once Date is used.
18645 Thirdly you get the whole 'Rev: 59' string in your document instead of
18647 Until subversion implements user's custom keywords it will be hard to use
18648 this approach reliably or let LyX to support it directly .
18651 \begin_layout Standard
18652 The second possibility would be to write your own external-material template
18654 \begin_inset Flex CharStyle:Code
18657 \begin_layout Plain Layout
18663 utility or parses the output of
18664 \begin_inset Flex CharStyle:Code
18667 \begin_layout Plain Layout
18673 command and returns the result back, when typeseting the document.
18676 \begin_layout Subsection
18677 SVN and Windows Environment
18680 \begin_layout Quote
18681 My inclination is to say that if the user cannot figure out the command
18682 line operations on their own fairly quickly, they would be well advised
18683 to use TortoiseSVN.
18689 \begin_layout Subsubsection
18693 \begin_layout Standard
18694 In addition to installing LyX, and having access to a Subversion repository,
18695 the user will need to install the Subversion client program.
18696 A Windows installer for the client program is available from
18697 \begin_inset CommandInset href
18700 target "http://www.collab.net/nonav/downloads/subversion/"
18705 The user may also want to install
18706 \begin_inset CommandInset href
18709 target "http://tortoisesvn.tigris.org/"
18713 , which integrates Subversion operations into the context (rightclick) menu
18714 of Windows Explorer.
18715 Operations done outside LyX will typically be more convenient using the
18716 Explorer context menu.
18717 Note that TortoiseSVN is not a replacement for the client program, which
18718 is what LyX itself will use.
18721 \begin_layout Subsubsection
18722 Bringing a document under Subversion control
18725 \begin_layout Standard
18726 Before a LyX document can be brought under version control in Subversion,
18727 its parent directory needs to be under version control.
18728 If the document is being added to a project already in the repository,
18729 this is accomplished by checking the project out to the directory where
18730 the new document will be placed.
18731 If the project itself is not yet under version control (for instance, if
18732 this document starts a new project), the directory must be imported into
18734 This is done outside LyX.
18735 Both import and checkout are easily accomplished from the Explorer context
18736 menu using TortoiseSVN, or alternatively can be done using the command
18737 line client at a DOS prompt.
18738 The procedure for importing the project using TortoiseSVN is described
18739 below, assuming an existing repository and a new project being started
18747 For information on using the Subversion client program, run
18754 \begin_layout Enumerate
18761 in Windows Explorer, right click it, and select
18763 TortoiseSVN > Repo-browser
18766 If necessary, adjust the URL for the repository, then click OK.
18769 \begin_layout Enumerate
18770 Right click the level of the repository under which you want to place the
18771 new project folder (typically the top level) and click
18773 Create folder\SpecialChar \ldots{}
18776 Supply a name for the project folder and click OK.
18777 Add a message for the log file if desired, then click OK again.
18778 The new project folder should appear in the repository.
18779 Finally, click OK again to exit the repository browser.
18782 \begin_layout Enumerate
18783 Once again right click
18789 , this time selecting SVN Checkout\SpecialChar \ldots{}
18790 Select the URL of the project folder
18791 you just created in the repository, and set the checkout directory to
18799 You will be warned about a non-empty folder; click OK to proceed.
18800 You should now have a
18811 \begin_layout Enumerate
18812 Create or open your document in LyX and click
18817 ile\SpecialChar \menuseparator
18823 \begin_inset space ~
18826 Control\SpecialChar \menuseparator
18834 Add a log message and click OK to commit the document to version control.
18837 \begin_layout Standard
18838 From this point onward, you should have full functionality in the
18843 ile\SpecialChar \menuseparator
18849 \begin_inset space ~
18855 You also have the option of checking the document in and out, viewing its
18857 using the TortoiseSVN context menu in Windows Explorer or the Subversion
18858 client program from a command prompt.
18861 \begin_layout Subsection
18865 \begin_layout Standard
18866 With the recent addition of the vc-command function LyX power users are
18867 allowed to create their own commands for revision control.
18870 \begin_layout Standard
18871 As an example you can see how two TortoiseSVN commands could be integrated
18875 \begin_layout Description
18877 \begin_inset Flex CharStyle:Code
18880 \begin_layout Plain Layout
18881 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
18889 \begin_layout Description
18891 \begin_inset Flex CharStyle:Code
18894 \begin_layout Plain Layout
18895 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
18903 \begin_layout Section
18904 Literate Programming
18907 \begin_layout Standard
18912 (kayvan@sylvan.com)
18916 original documentation written by
18918 Edmar Wienskoski Jr.
18921 (edmar-w-jr@technologist.com)
18924 \begin_layout Subsection
18928 \begin_layout Standard
18929 The main purpose of this documentation is to show you how to use LyX for
18930 literate programming.
18931 Where it is assumed that you are familiar with this programming technique,
18933 \begin_inset Quotes eld
18937 \begin_inset Quotes erd
18941 \begin_inset Quotes eld
18945 \begin_inset Quotes erd
18949 If that is not the case, please follow the web links provided in the following
18951 There is a lot of good documentation out there covering old development
18952 history to the latest tools tips.
18955 \begin_layout Standard
18956 It is also assumed that you are familiar with LyX itself to a point that
18957 you are comfortable changing your LyX preferences, and X resources file.
18958 If that is not the case please refer to other LyX documentation to cover
18959 your specific needs.
18962 \begin_layout Subsection
18963 Literate Programming
18966 \begin_layout Standard
18967 From the Literate Programming FAQ:
18970 \begin_layout Quotation
18971 Literate programming is the combination of documentation and source together
18972 in a fashion suited for reading by human beings.
18973 In fact, literate programs should be enjoyable reading, even inviting!
18974 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18975 and documentation in a single file.
18976 Literate programming tools then parse the file to produce either readable
18977 documentation or compilable source.
18978 The WEB style of literate programming was created by D.
18979 \begin_inset space \thinspace{}
18983 Knuth during the development of his TeX typesetting software.
18987 \begin_layout Standard
18988 Another excerpt says:
18991 \begin_layout Quotation
18994 How is literate programming different from verbose commenting?
18997 \begin_layout Quotation
18998 There are three distinguishing characteristics.
18999 In order of importance, they are:
19003 \begin_layout Itemize
19004 flexible order of elaboration
19007 \begin_layout Itemize
19008 automatic support for browsing
19011 \begin_layout Itemize
19012 typeset documentation, especially diagrams and mathematics
19016 \begin_layout Standard
19017 Now that I sparked your curiosity, take a look in the references.
19020 \begin_layout Subsubsection
19024 \begin_layout Standard
19025 The complete Literate Programming FAQ can be found at:
19028 \begin_layout Quote
19029 Literate Programming FAQ
19030 \begin_inset Flex URL
19033 \begin_layout Plain Layout
19035 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
19043 \begin_layout Standard
19044 The FAQ lists 23 (twenty three!) different literate programming tools.
19045 Where some are specialized or
19046 \begin_inset Quotes eld
19050 \begin_inset Quotes erd
19053 for particular programming languages, while other have general scope.
19058 for my own use for several reasons:
19061 \begin_layout Itemize
19062 It can generate the documentation either in LaTeX or HTML.
19065 \begin_layout Itemize
19066 It has a open architecture, i.
19067 \begin_inset space \thinspace{}
19071 \begin_inset space \space{}
19074 it is easy to plug in new filters and to perform special processing that
19079 \begin_layout Itemize
19080 There is a good selection of filters available already (the HTML is one
19084 \begin_layout Itemize
19088 \begin_layout Standard
19089 The Noweb web page can be found at:
19092 \begin_layout Quote
19094 \begin_inset Flex URL
19097 \begin_layout Plain Layout
19099 http://www.cs.virginia.edu/~nr/noweb/
19107 \begin_layout Standard
19108 Starting from there you can reach many other interesting links and even
19109 some literate program examples.
19112 \begin_layout Subsection
19113 LyX and Literate Programming
19116 \begin_layout Standard
19117 The LyX support for Literate Programming is provided by using the generic
19118 LyX converters mechanism.
19119 This support is provided in a
19120 \begin_inset Quotes eld
19124 \begin_inset Quotes erd
19128 \begin_inset space \thinspace{}
19132 \begin_inset space \space{}
19135 you will be able to use this new LyX feature with some other literate programmin
19136 g tool of your choice by just changing your LyX preferences.
19139 \begin_layout Subsubsection
19140 Generating documents and code (weaving and tangling)
19143 \begin_layout Paragraph
19144 Selecting the document class
19147 \begin_layout Standard
19148 If you have installed Noweb and LyX successfully, whenever you open a new
19149 document or try to change the document class of an existing one, you will
19150 find that there are three new document classes available:
19153 \begin_layout Itemize
19157 \begin_layout Itemize
19161 \begin_layout Itemize
19165 \begin_layout Standard
19166 You must select one of them to create your literate documents from.
19170 \begin_layout Standard
19171 Note that literate documents are not limited to these three classes.
19172 New classes can be generated from other styles like letter or in combination
19173 with other class variations like Article (AMS).
19174 If you have special needs that cannot be covered by one of the existing
19175 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
19176 will arrange to insert a new entry, or teach you how to do it.
19180 \begin_layout Plain Layout
19181 It is very simple, it involves the creation of a file with four lines, and
19182 re-running of the auto configuration.
19187 Moreover, if you use a literate tool other than Noweb you may need to create
19188 a new set of document classes for it.
19191 \begin_layout Paragraph
19195 \begin_layout Standard
19196 LyX enables you to write code with a layout named
19204 \begin_layout Plain Layout
19205 The equivalent Noweb term is
19206 \begin_inset Quotes eld
19210 \begin_inset Quotes erd
19214 For historical reasons, I got used to the term
19215 \begin_inset Quotes eld
19219 \begin_inset Quotes erd
19222 introduced by other literate tool named Nuweb, which I used for many years
19223 before rendering myself to Noweb.
19228 Noweb delimits scraps like this:
19231 \begin_layout LyX-Code
19235 \begin_layout LyX-Code
19239 \begin_layout LyX-Code
19243 \begin_layout LyX-Code
19247 \begin_layout LyX-Code
19251 \begin_layout Standard
19252 The problem is that whatever is written in between the << and the
19256 must be taken literally, i.
19257 \begin_inset space \thinspace{}
19261 \begin_inset space \space{}
19264 LyX should be prevented from making any special interpretation of what has
19266 This is handled by a special layout named Scrap, that works like a normal
19267 paragraph but has a free spacing capability.
19270 \begin_layout Standard
19271 The down side of the Scrap paragraph layout is that consecutive paragraphs
19272 of code will be spaced with one empty line in the source code and also
19273 in the printed documentation.
19274 The work around is to enter each line of code within a single Scrap, with
19275 a newline (ctrl-return).
19276 The example above will look like this:
19280 \begin_layout Plain Layout
19281 If you have a printed version of this document you will not see any difference
19282 between the previous example and this one.
19290 \begin_layout LyX-Code
19292 \begin_inset Newline newline
19296 \begin_inset Newline newline
19300 \begin_inset Newline newline
19304 \begin_inset Newline newline
19310 \begin_layout Standard
19311 This layout works fine.
19312 The only real inconvenience is that you have to type ctrl-return instead
19317 \begin_layout Plain Layout
19318 It is in my list of
19319 \begin_inset Quotes eld
19323 \begin_inset Quotes erd
19334 \begin_layout Standard
19335 As a special note, you can also use the
19336 \begin_inset Quotes eld
19340 \begin_inset Quotes erd
19343 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
19347 \begin_layout LyX-Code
19349 \begin_inset Newline newline
19352 def some_function(args):
19353 \begin_inset Newline newline
19356 "This is the doc string for this function."
19357 \begin_inset Newline newline
19360 print "My args: ", args
19363 \begin_layout LyX-Code
19364 @ %def some_function
19367 \begin_layout Standard
19368 For an example of this usage and the resulting cross-reference output, look
19369 at the Literate python program in
19371 LIBDIR/examples/listerrors.lyx
19373 which should make this all clear.
19376 \begin_layout Paragraph
19377 Generating the documentation
19380 \begin_layout Standard
19381 At this point you already have a new document file with a proper document
19382 class, and with some code and text on it.
19383 How do I print it? The answer is simple, you select
19385 View\SpecialChar \menuseparator
19389 Just like you would do for a plain document.
19390 No special procedure is required.
19393 \begin_layout Standard
19394 To help orientate you, I will now explain what happens inside LyX:
19397 \begin_layout Enumerate
19400 Update\SpecialChar \menuseparator
19403 menu option is chosen, a LaTeX file is generated.
19408 \begin_layout Standard
19409 If the document is of any literate class the generated file will be named
19410 with an extension name defined by the
19411 \begin_inset Quotes eld
19415 \begin_inset Quotes erd
19418 format (defined in the Preferences panel), otherwise the file will have
19427 \begin_layout Enumerate
19428 Note that the only difference so far is in the name of the file, no special
19429 processing is required by LyX.
19430 Given that you formatted the code using the Scrap layout that, by itself,
19431 takes care of the business.
19434 \begin_layout Enumerate
19435 If the document is of any literate class LyX will then use the internal
19436 LyX to Noweb converter, followed by the Noweb to LaTeX converter
19440 \begin_layout Plain Layout
19441 The converters are defined in the
19443 Tools\SpecialChar \menuseparator
19447 \begin_inset Quotes eld
19451 \begin_inset Quotes erd
19463 manual for general information about converters.
19468 to generate the LaTeX file.
19472 \begin_layout Standard
19473 Otherwise it will just skip this step.
19477 \begin_layout Enumerate
19478 Finally, LaTeX is invoked and the regular post processing continues as in
19482 \begin_layout Standard
19483 Independence from a particular
19484 \begin_inset Quotes eld
19488 \begin_inset Quotes erd
19491 is easily achieved by changing the commands that are run by the various
19495 \begin_layout Paragraph
19496 Generating the code
19499 \begin_layout Standard
19500 When the build menu option is chosen or the corresponding button in the
19501 toolbar is pressed, a LaTeX file is generated just like step 1 above.
19502 Next, LyX invokes the
19507 This converter needs to be defined by the user and is not installed by
19508 default, though the Program format is.
19509 This converter (like any other converter) will have two parts:
19512 \begin_layout Enumerate
19513 The converter program itself.
19514 This program performs the conversion from the one format to the other (in
19515 this case, from the Noweb format to the Program pseudo-format).
19518 \begin_layout Enumerate
19519 The error log parser.
19520 This is a program whose sole purpose is to rewrite error messages in a
19521 format that LyX understands.
19522 This makes it possible for LyX to place error boxes in the right places
19523 in the file buffer.
19526 \begin_layout Standard
19527 The first part, the
19528 \begin_inset Quotes eld
19532 \begin_inset Quotes erd
19535 setting, should be set to
19536 \begin_inset Quotes eld
19544 \begin_inset Quotes erd
19548 This basically means that LyX will call
19549 \begin_inset Quotes eld
19553 \begin_inset Quotes erd
19556 (a program or script) with the name of the Noweb file (normally a file
19557 in the LyX temp directory).
19561 \begin_layout Standard
19562 This is an implementation of
19563 \begin_inset Quotes eld
19567 \begin_inset Quotes erd
19570 that you can place in a directory on your path:
19573 \begin_layout LyX-Code
19577 \begin_layout LyX-Code
19581 \begin_layout LyX-Code
19582 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19585 \begin_layout Standard
19586 The next part of the converter setting is the
19587 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19594 which is to be set to
19595 \begin_inset Quotes eld
19600 parselog=listerrors
19603 \begin_inset Quotes erd
19607 This will run any errors that are generated by the
19608 \begin_inset Quotes eld
19612 \begin_inset Quotes erd
19615 process through the
19616 \begin_inset Quotes eld
19620 \begin_inset Quotes erd
19626 \begin_layout Standard
19627 The converter code looks in
19635 then on the path for the
19636 \begin_inset Quotes eld
19640 \begin_inset Quotes erd
19646 \begin_layout Standard
19647 The build will normally take place in LyX's temporary directory, so the
19648 files produced by the conversion will be in that directory.
19649 LyX will copy out what it regards as the `main' file, but the
19653 conversion may produce several files, and so most of these would then be
19654 deleted when LyX was closed.
19655 The present solution is to use a `copier',
19659 \begin_layout Plain Layout
19668 manual for information on these.
19677 script in its default mode, so that the entire contents of the temporary
19678 directory is copied.
19679 More will get copied than is needed, to be sure, but nothing will be lost.
19680 If, however, you know what extensions the generated files will have, this
19681 can be improved by using the
19690 This option takes a comma-separated list of extensions to copy.
19691 So, for example, if the conversion will generate only files with the extensions
19700 , then the correct definition would be:
19703 \begin_layout LyX-Code
19704 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19707 \begin_layout Standard
19708 The result will be that only files with these two extensions will be copied
19712 \begin_layout Paragraph
19713 Build instructions in the document
19716 \begin_layout Standard
19717 The last piece of the integration between LyX and noweb is the
19718 \begin_inset Quotes eld
19722 \begin_inset Quotes erd
19726 Generally, the instructions for building your program should be embedded
19727 in a scrap of its own.
19729 \begin_inset Quotes eld
19733 \begin_inset Quotes erd
19736 above uses the notangle command to look for this scrap (called
19737 \begin_inset Quotes eld
19741 \begin_inset Quotes erd
19744 ) and runs its contents through
19745 \begin_inset Quotes eld
19749 \begin_inset Quotes erd
19755 \begin_layout Standard
19756 Typically, such a scrap would look something like this:
19759 \begin_layout LyX-Code
19761 \begin_inset Newline newline
19765 \begin_inset Newline newline
19769 \begin_inset Newline newline
19772 if [ -z "${NOWEB_SOURCE}" ]
19773 \begin_inset Newline newline
19777 \begin_inset Newline newline
19780 NOWEB_SOURCE=myfile.nw
19781 \begin_inset Newline newline
19785 \begin_inset Newline newline
19789 code to extract files ...]
19790 \begin_inset Newline newline
19794 code to compile files ...]
19795 \begin_inset Newline newline
19801 \begin_layout Standard
19804 LIBDIR/examples/listerrors.lyx
19808 LIBDIR/examples/Literate.lyx
19810 which implement two versions of the
19811 \begin_inset Quotes eld
19815 \begin_inset Quotes erd
19818 program for some illustrations of how all of these pieces go together or
19821 LIBDIR/examples/noweb2lyx.lyx.
19824 Interestingly, these three files show off the language-indepence of the
19825 LyX literate programming support since they are written in Python, C and
19829 \begin_layout Subsubsection
19833 \begin_layout Standard
19834 All the Literate Programming support is configured by the
19836 Tools\SpecialChar \menuseparator
19840 \begin_inset Quotes eld
19844 \begin_inset Quotes erd
19848 The important parts are:
19851 \begin_layout Description
19853 \begin_inset space ~
19857 \begin_inset Quotes eld
19861 \begin_inset Quotes erd
19865 \begin_inset space ~
19868 format Set up via the Formats tab, this is where the Noweb-specific pieces
19878 , the file extension is set to
19883 This tells LyX to create a file with a
19887 extension in the first step of the conversion process.
19890 \begin_layout Description
19892 \begin_inset space ~
19900 \begin_inset space ~
19903 format This is an empty format whose sole purpose is to be the endpoint
19904 of a conversion (which then allows us to set up a converter for it).
19907 \begin_layout Description
19916 This converter performs the
19917 \begin_inset Quotes eld
19921 \begin_inset Quotes erd
19924 of the literate document.
19925 For Noweb, it is set to
19926 \begin_inset Quotes eld
19931 noweave -delay -index $$i > $$o
19934 \begin_inset Quotes erd
19940 \begin_layout Description
19950 \begin_inset Quotes eld
19954 \begin_inset Quotes erd
19958 As stated above, the Converter is set to
19959 \begin_inset Quotes eld
19967 \begin_inset Quotes erd
19970 , with Flags set to
19971 \begin_inset Quotes eld
19976 originaldir,parselog=listerrors
19979 \begin_inset Quotes erd
19985 \begin_layout Subsubsection
19989 \begin_layout Standard
19990 There is also a new function implemented in the LyX server, the
19991 \begin_inset Quotes eld
19994 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19998 \begin_layout Standard
19999 When debugging code with ddd/gdb, it is possible to invoke a text editor
20000 at the current execution position with a single key stroke.
20001 The default ddd configuration for that is shift-ctrl-V.
20002 It happens that you can define the editor command line invocation in ddd
20005 Edit\SpecialChar \menuseparator
20006 Preferences\SpecialChar \menuseparator
20009 dialog and changing the "Edit Sources" entry.
20012 \begin_layout Standard
20013 I take advantage of the new created LyX server function and this ddd feature,
20015 \begin_inset Quotes eld
20019 \begin_inset Quotes erd
20025 \begin_layout LyX-Code
20026 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20029 \begin_layout Standard
20030 With this, whenever you are using ddd and find a point in the program that
20031 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20032 ddd you forward this information to LyX through the LyX server and then
20033 the LyX window will show the same file with the cursor at the same position
20034 ddd was pointing to.
20035 No more guessing or long scrolling to locate a point in the program back
20039 \begin_layout Standard
20040 Note however that you must enable the LyX server to get this feature working
20041 (it is disabled by default).
20042 You can enable it in
20054 ) by entering in the
20059 \begin_inset Quotes eld
20064 /home/<your-home-directory>/.lyx/lyxpipe
20067 \begin_inset Quotes erd
20073 \begin_layout Standard
20074 Read the LyX server documentation in the
20076 Customization Manual
20078 for further information.
20081 \begin_layout Subsubsection
20085 \begin_layout Standard
20086 There are six new buttons that can be added to your LyX toolbar.
20087 Five of these buttons are short cuts to layout styles:
20108 The last one is a short cut to the
20109 \begin_inset Quotes eld
20113 \begin_inset Quotes erd
20120 \begin_layout Standard
20121 LyX has a range of buttons that are available for tool bar customization.
20122 In my toolbar I like to combine the six short cuts above with two more:
20127 \SpecialChar \menuseparator
20132 \SpecialChar \menuseparator
20139 View\SpecialChar \menuseparator
20143 Here is how it looks like:
20146 \begin_layout LyX-Code
20150 \begin_layout LyX-Code
20154 \begin_layout LyX-Code
20155 Icon "layout Standard"
20158 \begin_layout LyX-Code
20159 Icon "layout Section"
20162 \begin_layout LyX-Code
20163 Icon "layout LaTeX"
20166 \begin_layout LyX-Code
20167 Icon "layout LyX-Code"
20170 \begin_layout LyX-Code
20171 Icon "layout Scrap"
20174 \begin_layout LyX-Code
20178 \begin_layout LyX-Code
20182 \begin_layout LyX-Code
20183 Icon "buffer-typeset"
20186 \begin_layout LyX-Code
20187 Icon "build-program"
20190 \begin_layout LyX-Code
20194 \begin_layout LyX-Code
20198 \begin_layout LyX-Code
20202 \begin_layout LyX-Code
20206 \begin_layout LyX-Code
20210 \begin_layout Subsubsection
20211 Colors customization
20214 \begin_layout Standard
20215 There are a number of colors in LyX that can be customized in
20220 One of the things that bothers people is the LaTeX font color.
20221 The default color is red, since the scraps uses LaTeX font, and there is
20222 a lot of scraps in literate documents, you may get tired of seeing everything
20224 You can change it by going to the tabs
20233 \begin_layout Standard
20234 The next thing is the visible presence of the newline character in the screen.
20235 You can choose the color of this particular character and make it blend
20237 I recommend you choosing a color that is close to the background but not
20238 equal, that way you still can see it is there, but it is not bothering
20243 \begin_layout Chapter
20244 Secrets of the LaTeX Masters
20245 \begin_inset CommandInset label
20254 \begin_layout Standard
20255 Though LyX is a powerful tool, it cannot hope to support everything that
20256 can be done with pure TeX/LaTeX.
20257 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
20258 as long as you are not afraid to use that
20259 \begin_inset Quotes eld
20263 \begin_inset Quotes erd
20266 button on the toolbar or add things to the LaTeX preamble.
20267 This section lists some tips, tricks, and otherwise cool ideas to give
20268 your document that extra little flair.
20271 Do try this at home
20273 , just start with something a little smaller and less important than your
20277 \begin_layout Standard
20278 Most ideas in this section require less common files in your LaTeX installation.
20279 If you have a system like teTeX, most will already be available.
20280 A few, however, will need to be downloaded from one of the CTAN archives.
20281 Often, there are several ways to do something, or several LaTeX style files
20282 which do the same thing.
20283 We do not endorse one choice over another, we simply claim that we have
20284 done a particular task with a particular file.
20285 Put on your wizard hat, keep an eye out for dragons, and let us begin.
20288 \begin_layout Section
20292 \begin_layout Standard
20295 Lars Gullik Bjønnes
20298 \begin_layout Subsection
20302 \begin_layout Standard
20303 The aim for this chapter
20307 \begin_layout Plain Layout
20308 Editor's note: Lars' original chapter was a masterful description of how
20314 However, it was too long to flow smoothly in this document.
20315 I have therefore chosen to excerpt the most important sections here (sorry,
20316 Lars); you can read the original chapter (and more of the story!) in the
20319 examples/multicol.lyx
20327 is to show how the LaTeX package
20331 can be used in a LyX document.
20332 As LyX doesn't support the
20336 package natively yet, we have to use some small hacks.
20337 By reading this section it should be obvious how to do this.
20340 \begin_layout Subsection
20344 \begin_layout Standard
20349 package allows switching between one and multicolumn format on the same
20351 Footnotes are handled correctly (for the most part), but will be placed
20352 at the bottom of the page and not under each column.
20353 LaTeX's float mechanism, however, is partly disabled in the current implementat
20355 At the moment only page-wide floats can be used within the scope of the
20359 \begin_layout Subsection
20363 \begin_layout Subsubsection
20367 \begin_layout Standard
20368 If you want to have two columns in your text, you have use LaTeX mode to
20373 begin{multicols}{2}
20375 at the point where you want the two column layout to start, and then
20381 where you want it to end.
20385 \begin_layout Standard
20389 \begin_layout Plain Layout
20393 begin{multicols}{2}
20401 \begin_layout Standard
20406 The Adventure of the Empty House
20409 \begin_inset Newline newline
20414 Sir Arthur Conan Doyle
20417 \begin_layout Standard
20420 It was in the spring of the year 1894 that all London was interested, and
20421 the fashionable world dismayed, by the murder of the Honourable Ronald
20422 Adair under most unusual and inexplicable circumstances.
20423 The public has already learned those particulars of the crime which came
20424 out in the police investigation, but a good deal was suppressed upon that
20425 occasion, since the case for the prosecution was so overwhelmingly strong
20426 that it was not necessary to bring forward all the facts.
20427 Only now, at the end of nearly ten years, am I allowed to supply those
20428 missing links which make up the whole of that remarkable chain.
20429 The crime was of interest in itself, but that interest was as nothing to
20430 me compared to the inconceivable sequel, which afforded me the greatest
20431 shock and surprise of any event in my adventurous life.
20432 Even now, after this long interval, I find myself thrilling as I think
20433 of it, and feeling once more that sudden flood of joy, amazement, and increduli
20434 ty which utterly submerged my mind.
20435 Let me say to that public, which has shown some interest in those glimpses
20436 which I have occasionally given them of the thoughts and actions of a very
20437 remarkable man, that they are not to blame me if I have not shared my knowledge
20438 with them, for I should have considered it my first duty to do so, had
20439 I not been barred by a positive prohibition from his own lips, which was
20440 only withdrawn upon the third of last month.
20443 \begin_layout Standard
20447 \begin_layout Plain Layout
20459 \begin_layout Subsubsection
20463 \begin_layout Standard
20464 The same pattern is used when you want more than two columns:
20467 \begin_layout Standard
20471 \begin_layout Plain Layout
20475 begin{multicols}{3}
20483 \begin_layout Standard
20486 It can be imagined that my close intimacy with Sherlock Holmes had interested
20487 me deeply in crime, and that after his disappearance I never failed to
20488 read with care the various problems which came before the public.
20489 And I even attempted, more than once, for my own private satisfaction,
20490 to employ his methods in their solution, though with indifferent success.
20491 There was none, however, which appealed to me like this tragedy of Ronald
20493 As I read the evidence at the inquest, which led up to a verdict of willful
20494 murder against some person or persons unknown, I realized more clearly
20495 than I had ever done the loss which the community had sustained by the
20496 death of Sherlock Holmes.
20497 There were points about this strange business which would, I was sure,
20498 have specially appealed to him, and the efforts of the police would have
20499 been supplemented, or more probably anticipated, by the trained observation
20500 and the alert mind of the first criminal agent in Europe.
20501 All day, as I drove upon my round, I turned over the case in my mind and
20502 found no explanation which appeared to me to be adequate.
20503 At the risk of telling a twice-told tale, I will recapitulate the facts
20504 as they were known to the public at the conclusion of the inquest.
20507 \begin_layout Standard
20511 \begin_layout Plain Layout
20523 \begin_layout Standard
20524 You can have more than 3 columns if you want to, but that might not be very
20525 pleasant for the eye.
20528 \begin_layout Subsubsection
20529 Columns inside columns
20532 \begin_layout Standard
20533 You can even have columns inside columns:
20536 \begin_layout Standard
20540 \begin_layout Plain Layout
20544 begin{multicols}{2}
20552 \begin_layout Standard
20555 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20556 at that time governor of one of the Australian colonies.
20557 Adair's mother had returned from Australia to undergo the operation for
20558 cataract, and she, her son Ronald, and her daughter Hilda were living together
20562 \begin_layout Standard
20566 \begin_layout Plain Layout
20570 begin{multicols}{2}
20578 \begin_layout Standard
20581 The youth moved in the best society–had, so far as was known, no enemies
20582 and no particular vices.
20583 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20584 had been broken off by mutual consent some months before, and there was
20585 no sign that it had left any very profound feeling behind it.
20586 For the rest {sic} the man's life moved in a narrow and conventional circle,
20587 for his habits were quiet and his nature unemotional.
20588 Yet it was upon this easy-going young aristocrat that death came, in most
20589 strange and unexpected form, between the hours of ten and eleven-twenty
20590 on the night of March 30, 1894.
20593 \begin_layout Standard
20597 \begin_layout Plain Layout
20609 \begin_layout Standard
20612 Ronald Adair was fond of cards–playing continually, but never for such stakes
20614 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20615 It was shown that, after dinner on the day of his death, he had played
20616 a rubber of whist at the latter club.
20617 He had also played there in the afternoon.
20622 The evidence of those who had played with him– Mr.
20623 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20624 and that there was a fairly equal fall of the cards.
20625 Adair might have lost five pounds, but not more.
20626 His fortune was a considerable one, and such a loss could not in any way
20628 He had played nearly every day at one club or other, but he was a cautious
20629 player, and usually rose a winner.
20630 It came out in evidence that, in partnership with Colonel Moran, he had
20631 actually won as much as four hundred and twenty pounds in a sitting, some
20632 weeks before, from Godfrey Milner and Lord Balmoral.
20633 So much for his recent history as it came out at the inquest.
20636 \begin_layout Standard
20640 \begin_layout Plain Layout
20652 \begin_layout Standard
20653 Please do read the file
20655 examples/multicol.lyx
20657 for more advanced examples including column and header spacing, vertical
20658 separator lines, and more.
20661 \begin_layout Section
20666 Paragraph Environment
20667 \begin_inset OptArg
20670 \begin_layout Plain Layout
20671 Numbering in Enumerate
20679 \begin_layout Standard
20685 \begin_layout Standard
20686 \begin_inset VSpace bigskip
20692 \begin_layout Standard
20694 The default numbering for the
20698 paragraph environment begins with Arabic numbers and ends with uppercase
20700 Suppose, however, you wanted a different type of numbering scheme.
20701 Here's a quickie example of how to change the numbering scheme:
20704 \begin_layout LyX-Code
20714 \begin_layout LyX-Code
20724 \begin_layout LyX-Code
20734 \begin_layout LyX-Code
20744 \begin_layout Standard
20745 \SpecialChar \ldots{}
20746 which changes the numbering scheme to uppercase Roman numerals, uppercase
20747 letters, Arabic numbers, and lowercase letter.
20750 \begin_layout Standard
20751 Additionally, the previous example also adds a little bit extra to the numbering
20753 For example, the first level label actually looks like:
20754 \begin_inset Quotes eld
20758 \begin_inset Quotes erd
20762 For ease of reading, we'll describe what the numbering schemes look like
20763 using a notation something like this: <
20764 \begin_inset Quotes eld
20768 \begin_inset Quotes erd
20772 \begin_inset space ~
20776 \begin_inset Quotes erd
20780 \begin_inset Quotes erd
20784 \begin_inset space ~
20788 \begin_inset Quotes erd
20792 \begin_inset Quotes erd
20796 \begin_inset space ~
20800 \begin_inset Quotes eld
20804 \begin_inset Quotes erd
20811 \begin_layout Standard
20812 As you can see in the example, there is a label command for each nesting
20819 \SpecialChar \ldots{}
20826 , as well as a counter,
20830 \SpecialChar \ldots{}
20836 There are also five
20837 \begin_inset Quotes eld
20841 \begin_inset Quotes erd
20874 , each of which take one counter as an argument.
20875 You can add characters before or after these, but there's no need to add
20879 \begin_layout Standard
20880 You can get really fancy with these.
20884 \begin_layout LyX-Code
20898 \begin_layout LyX-Code
20910 \begin_layout LyX-Code
20920 \begin_layout LyX-Code
20930 \begin_layout Standard
20931 produces the somewhat out of hand numbering scheme: <
20932 \begin_inset Quotes eld
20936 \begin_inset Quotes erd
20940 \begin_inset space ~
20944 \begin_inset Quotes erd
20948 \begin_inset Quotes erd
20952 \begin_inset space ~
20956 \begin_inset Quotes erd
20960 \begin_inset Quotes erd
20964 \begin_inset space ~
20968 \begin_inset Quotes eld
20972 \begin_inset Quotes erd
20979 \begin_layout Standard
20983 \begin_layout Section
20987 \begin_layout Standard
20993 \begin_layout Standard
20994 \begin_inset VSpace bigskip
21000 \begin_layout Standard
21005 \begin_layout Plain Layout
21011 tmpfont}{cmr17 scaled 2500}{
21023 \begin_layout Standard
21028 \begin_layout Plain Layout
21039 hose of you who like the style of old books probably also like
21040 \begin_inset Quotes eld
21044 \begin_inset Quotes erd
21047 —those large capital letters which begin each new chapter or section.
21048 Implementing them with plain LyX/LaTeX is straightforward (assuming you
21049 know some plain TeX!) but does require a lot of work and many iterations,
21050 as you can see by all the ugly TeX-mode stuff at the beginning of this
21054 \begin_layout Standard
21058 \begin_layout Plain Layout
21064 bigdrop{-1em}{3}{ptmri}{T}+
21069 here is a much easier way of doing this, of course.
21078 ) package from CTAN allows a simple way to add such letters to your documents.
21079 Since this package is not a standard part of teTeX, I can't demonstrate
21080 it within this document, but if you copy this paragraph to a new document,
21082 \begin_inset Quotes eld
21092 \begin_inset Quotes erd
21095 and the pluses from the TeX code at the beginning of the paragraph, and
21100 usepackage{dropcaps}
21102 to your LaTeX preamble, you will get a nice Times Roman Italic
21103 \begin_inset Quotes eld
21107 \begin_inset Quotes erd
21110 , whose height is three lines of text and which protrudes 1 em into the
21112 (Make certain you have copied
21113 \begin_inset Quotes eld
21121 \begin_inset Quotes erd
21124 into a directory where TeX can see it.) The first argument is the amount
21125 of indentation; in this case the negative sign moves it into the margin.
21126 The second argument is the height of the letter in number of lines of text.
21127 The third argument is the font name: virtually anything which has a tfm
21128 file should work (wade through the
21130 .../texmf/fonts/tfm
21132 directory for possibilities).
21133 My personal favorite is
21134 \begin_inset Quotes eld
21142 \begin_inset Quotes erd
21145 , a fancy German font specifically designed for dropped capitals.
21146 The fourth argument is the letter (or letters) to be dropped.
21151 package also offers the
21157 command, as well as a slightly simplified
21166 \begin_layout Section
21167 Non-standard Paragraph Shapes
21170 \begin_layout Standard
21176 \begin_layout Standard
21177 \begin_inset VSpace bigskip
21183 \begin_layout Standard
21187 \begin_layout Plain Layout
21199 \begin_layout Standard
21203 \begin_layout Plain Layout
21212 \begin_layout Plain Layout
21226 \begin_layout Standard
21231 \begin_layout Plain Layout
21242 \begin_layout Plain Layout
21251 \begin_layout Plain Layout
21260 \begin_layout Plain Layout
21269 \begin_layout Plain Layout
21278 \begin_layout Plain Layout
21287 \begin_layout Plain Layout
21296 \begin_layout Plain Layout
21305 \begin_layout Plain Layout
21314 \begin_layout Plain Layout
21323 \begin_layout Plain Layout
21332 \begin_layout Plain Layout
21341 \begin_layout Plain Layout
21350 \begin_layout Plain Layout
21359 \begin_layout Plain Layout
21368 \begin_layout Plain Layout
21377 \begin_layout Plain Layout
21386 \begin_layout Plain Layout
21395 \begin_layout Plain Layout
21404 \begin_layout Plain Layout
21410 There are times when the tyranny of rectangular paragraphs must be overthrown.
21411 In such situations, a call to the delightful plain TeX command
21418 As you can see, completely arbitrary shapes can be laid out with a suitable
21419 set of linelength definitions.
21420 While this parshape may look a bit silly and useless, one could conceive
21421 of situations such as finely tuned dropped capitals, word wrapping around
21422 non-rectangular graphics, etc.
21423 which will benefit from such handcrafting.
21426 \begin_layout Standard
21427 \begin_inset VSpace bigskip
21433 \begin_layout Standard
21438 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21445 is the number of lines of text which define the paragraph.
21446 If there turn out to be fewer lines, the shape is truncated; if there are
21447 more, the excess lines have the same dimensions as the last line of the
21457 entries specify the indentation of the line from the left margin, and the
21458 length of the line as measured from that point.
21459 The shape applies only to the current paragraph; everything is reset to
21460 normal for the next paragraph.
21463 \begin_layout Standard
21467 \begin_layout Plain Layout
21479 \begin_layout Section
21483 \begin_layout Standard
21484 As you can see, the examples in this section range from the useful to the
21486 While I don't expect that anyone will ever need the paragraph shape demonstrate
21487 d in the last section, the important point is that you can do almost anything
21488 you want in LyX if you are willing to figure out how to do it in TeX and
21490 TeX is a fantastically powerful typesetting system and all that power is
21491 available to you since LyX uses it as its backend.