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 Additional Features manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's additional features documentation"
91 \pdf_keywords "LyX, Documentation, Additional"
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
117 \paragraph_separation indent
118 \paragraph_indentation default
119 \quotes_language english
122 \paperpagestyle headings
123 \tracking_changes false
124 \output_changes false
130 Additional LyX Features
138 \begin_layout Plain Layout
140 Principal maintainer of this file is
145 If you have comments or error corrections, please send them to the LyX
146 Documentation mailing list,
147 \begin_inset Flex CharStyle:Code
150 \begin_layout Plain Layout
152 <lyx-docs@lists.lyx.org>
165 \begin_layout Standard
166 \begin_inset CommandInset toc
167 LatexCommand tableofcontents
174 \begin_layout Chapter
178 \begin_layout Standard
179 This manual is essentially Part II of the
181 User's Guide\SpecialChar \@.
184 The reason for separating this document out is simple: the
188 is already quite lengthy, and it contains information on all of the basic
189 features one needs to know in order to prepare most documents.
190 However, the LyX Team has worked to LyX extensible through various configuratio
191 n files and external packages.
192 That means that if you want to support the Fizzwizzle LaTeX package, you
193 can create a layout file (or module) for it without having to alter LyX
195 We've already had contributions of several new features this way.
196 This is the place where all of those get documented.
199 \begin_layout Standard
200 This manual also documents some special features, like fax support, version
201 control, and SGML support, which require additional software to work properly.
202 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
203 spruce up your documents by directly using the powerful features of LaTeX.
208 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
211 \begin_layout Standard
212 If you haven't read the
216 yet, you are definitely in the wrong manual.
221 is the first place to go, since it describes the notation and format of
223 You should also be thoroughly familiar with the
227 and all of the basic features of LyX before attempting to read this one.
230 \begin_layout Standard
231 Since all the topics in this manual depend heavily on LyX's interaction
232 with LaTeX, this first chapter covers the inner workings of LyX and how
233 to direct LyX to generate exactly the LaTeX code you want.
234 It is obviously for more seasoned LyX users.
237 \begin_layout Chapter
241 \begin_layout Section
245 \begin_layout Standard
246 This chapter is for both TeX-nicians and the LaTeX-curious.
247 In it, we'll explain how LyX and LaTeX work together to produce printable
249 This is the only place in any of the manuals where we assume you know something
253 \begin_layout Standard
254 At one time, LyX was called a
255 \begin_inset Quotes eld
258 WYSIWYM frontend to LaTeX,
259 \begin_inset Quotes erd
262 but that's no longer true.
263 There are frontends to LaTeX out there.
267 \begin_layout Plain Layout
268 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
269 There are also the LaTeX modes for vi and emacs, of course.
274 These are basically text editors with the ability to run LaTeX and mark
275 any errors in the file you're editing.
284 run LaTeX, and it also indicates errors in the file, it also does much,
286 For one thing, you don't need to know LaTeX to use LyX effectively.
287 And LyX has added its own extensions to LaTeX.
288 Try the following sometime: select
289 \begin_inset Flex CharStyle:MenuItem
292 \begin_layout Plain Layout
293 Export\SpecialChar \menuseparator
300 \begin_inset Flex CharStyle:MenuItem
303 \begin_layout Plain Layout
310 \begin_inset Flex CharStyle:MenuItem
313 \begin_layout Plain Layout
314 View\SpecialChar \menuseparator
320 ), then look at the preamble of the resulting
321 \begin_inset Flex CharStyle:Code
324 \begin_layout Plain Layout
331 You'll notice a variety of new macros defined specifically by LyX.
332 These macros are defined automatically, according to the features you use
336 \begin_layout Standard
337 There are several commands that automatically invoke LaTeX.
341 \begin_layout Itemize
342 \begin_inset Flex CharStyle:MenuItem
345 \begin_layout Plain Layout
346 View\SpecialChar \menuseparator
355 \begin_layout Itemize
356 \begin_inset Flex CharStyle:MenuItem
359 \begin_layout Plain Layout
360 View\SpecialChar \menuseparator
361 Update\SpecialChar \menuseparator
370 \begin_layout Itemize
371 \begin_inset Flex CharStyle:MenuItem
374 \begin_layout Plain Layout
375 File\SpecialChar \menuseparator
384 \begin_layout Itemize
385 \begin_inset Flex CharStyle:MenuItem
388 \begin_layout Plain Layout
389 File\SpecialChar \menuseparator
398 \begin_layout Standard
399 They will only invoke LaTeX if the file has changed since the last time
404 \begin_layout Standard
405 When LyX runs LaTeX on the file you're editing, it performs these steps:
408 \begin_layout Enumerate
409 Convert the document to LaTeX and save to a file with the extension
410 \begin_inset Flex CharStyle:Code
413 \begin_layout Plain Layout
420 \begin_inset Flex CharStyle:Code
423 \begin_layout Plain Layout
432 \begin_layout Enumerate
434 \begin_inset Flex CharStyle:Code
437 \begin_layout Plain Layout
443 file (maybe several times), and run any other commands (such as
444 \begin_inset Flex CharStyle:Code
447 \begin_layout Plain Layout
454 \begin_inset Flex CharStyle:Code
457 \begin_layout Plain Layout
463 ) needed to compile the LaTeX file.
466 \begin_layout Enumerate
467 If there are any errors, show the error log.
470 \begin_layout Standard
471 If you've run LaTeX using
472 \begin_inset Flex CharStyle:MenuItem
475 \begin_layout Plain Layout
478 \SpecialChar \menuseparator
486 , LyX then runs a DVI viewer to display the DVI-file.
488 \begin_inset Flex CharStyle:MenuItem
491 \begin_layout Plain Layout
494 \SpecialChar \menuseparator
502 , LyX performs further steps:
505 \begin_layout Itemize
507 \begin_inset Flex CharStyle:Code
510 \begin_layout Plain Layout
516 to convert the DVI file to PostScript.
519 \begin_layout Itemize
520 Run a PostScript viewer, such as
521 \begin_inset Flex CharStyle:Code
524 \begin_layout Plain Layout
530 , to display the PostScript file.
533 \begin_layout Standard
534 LyX does similar things when viewing, or exporting, other formats.
537 \begin_layout Section
538 Translating LaTeX files into LyX
541 \begin_layout Standard
542 You can import a LaTeX file into LyX by using the
543 \begin_inset Flex CharStyle:MenuItem
546 \begin_layout Plain Layout
547 File\SpecialChar \menuseparator
548 Import\SpecialChar \menuseparator
555 This will call a program named
556 \begin_inset Flex CharStyle:Code
559 \begin_layout Plain Layout
565 which will create a file
566 \begin_inset Flex CharStyle:Code
569 \begin_layout Plain Layout
576 \begin_inset Flex CharStyle:Code
579 \begin_layout Plain Layout
586 LyX will then open that file.
590 \begin_layout Plain Layout
591 \begin_inset Flex CharStyle:Code
594 \begin_layout Plain Layout
600 can also be run from the command line, of course.
608 \begin_layout Standard
609 \begin_inset Flex CharStyle:Code
612 \begin_layout Plain Layout
618 will translate most legal LaTeX, but not everything.
619 It will put things it doesn't understand into TeX code, so after translating
621 \begin_inset Flex CharStyle:Code
624 \begin_layout Plain Layout
630 , you can look for TeX code and hand-edit it until it looks right.
633 \begin_layout Standard
634 If you don't know what TeX code is, read the next section.
637 \begin_layout Section
638 \begin_inset CommandInset label
640 name "sec:Inserting-TeX-Code"
644 Inserting TeX Code into LyX Documents
647 \begin_layout Standard
648 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
649 You can always insert TeX code into any LyX document.
650 LyX cannot, and will never be able to, display every possible LaTeX construct.
651 If ever you need to insert LaTeX commands into your LyX document, you can
653 \begin_inset Flex CharStyle:Code
656 \begin_layout Plain Layout
662 box, which you can insert into your document with
663 \begin_inset Flex CharStyle:MenuItem
666 \begin_layout Plain Layout
667 Insert\SpecialChar \menuseparator
676 \begin_layout Standard
677 Here's an example of inserting LaTeX commands in a LyX document.
678 The code looks like this:
681 \begin_layout LyX-Code
685 \begin_inset Newline newline
691 \begin_inset Newline newline
694 This is an example for a minipage environment.
696 \begin_inset Newline newline
699 can put nearly everything in it, even (non-floating)
700 \begin_inset Newline newline
705 \begin_inset Newline newline
711 \begin_inset Newline newline
715 \begin_inset Newline newline
721 \begin_inset Newline newline
727 \begin_inset Newline newline
733 \begin_inset Newline newline
738 \begin_inset Newline newline
744 \begin_inset Newline newline
750 \begin_inset Newline newline
756 \begin_inset Newline newline
764 \begin_layout LyX-Code
768 \begin_layout Standard
770 \begin_inset Flex CharStyle:Code
773 \begin_layout Plain Layout
779 box containing this text is directly after this paragraph.
780 Those of you reading the manual in LyX will only see the TeX code inset.
781 Those reading a printed version of the manuals will see the actual results:
784 \begin_layout Standard
788 \begin_layout Plain Layout
795 \begin_layout Plain Layout
802 \begin_layout Plain Layout
804 This is an example for a minipage environment.
805 You can put nearly everything in it, even (non-floating) figures and tables.
809 \begin_layout Plain Layout
816 \begin_layout Plain Layout
821 \begin_layout Plain Layout
828 \begin_layout Plain Layout
835 \begin_layout Plain Layout
842 \begin_layout Plain Layout
848 \begin_layout Plain Layout
855 \begin_layout Plain Layout
862 \begin_layout Plain Layout
869 \begin_layout Plain Layout
881 \begin_layout Standard
882 In addition to using TeX code, you can also create a separate file containing
883 some complex LaTeX structure and then use
884 \begin_inset Flex CharStyle:MenuItem
887 \begin_layout Plain Layout
888 Insert\SpecialChar \menuseparator
898 to include your file (you should select the type
899 \begin_inset Flex CharStyle:Code
902 \begin_layout Plain Layout
909 We recommend that you only do this if you have a
910 \begin_inset Flex CharStyle:Code
913 \begin_layout Plain Layout
924 Otherwise, you'll have a big job tracking down LaTeX errors.
927 \begin_layout Standard
928 There are a few last points to emphasize:
931 \begin_layout Itemize
936 check if your LaTeX code is correct.
939 \begin_layout Itemize
940 Beware reinventing the wheel.
943 \begin_layout Standard
944 On that last point, LyX does have quite a few features tucked into it, and
946 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
947 feature before you decide you have to do it by hand.
948 Moreover, there are numerous LaTeX packages out there to do all sorts of
949 things, from labels to envelopes to fancy multipage tables.
951 \begin_inset CommandInset href
954 target "http://www.ctan.org/"
958 for details, and see chapter
959 \begin_inset CommandInset ref
961 reference "cha:secrets"
968 \begin_layout Standard
969 If you do need to do some wild and fancy things within your document, be
970 sure to check out a good LaTeX book for assistance.
971 There are a number of them listed in the bibliography of the
978 \begin_layout Section
979 LyX and the LaTeX Preamble
982 \begin_layout Subsection
983 About the LaTeX Preamble
986 \begin_layout Standard
987 If you already know LaTeX, there is no need to explain here what the preamble
989 If you don't, the following will give you some ideas—we recommend again
990 that you consult a LaTeX book for further information.
991 In any case, you should read the points below, because they explain what
992 you can do and what you don't need to do in the LaTeX preamble of a LyX
996 \begin_layout Standard
997 The LaTeX preamble comes at the very beginning of a document,
1005 \begin_layout Itemize
1006 Declare the document class.
1008 \begin_inset Newline newline
1011 LyX already does this for you.
1012 If you're a seasoned LaTeX-nician, and you have a custom document class
1013 you want to use, check out the
1015 Customization Manual
1017 for information on how to make LyX interface to it.
1020 \begin_layout Itemize
1021 Declare the usage of packages.
1023 \begin_inset Newline newline
1026 LaTeX packages provide special commands, which are only available within
1027 a document when the package has been declared in the preamble.
1028 For example, the package
1029 \begin_inset Flex CharStyle:Code
1032 \begin_layout Plain Layout
1038 forces all paragraphs to be indented.
1039 There are other packages for labels, envelopes, margins, etc.
1043 \begin_layout Itemize
1044 Set counters, variables, lengths and widths.
1046 \begin_inset Newline newline
1049 There are several LaTeX counters and variables which
1053 be set globally from within the preamble in order to have the desired effect.
1054 (There are variables which you can set and reset inside the document, too.)
1055 Margins are a good example of something which must be set in the preamble.
1056 Another example is the label format for lists.
1057 You can actually set these just about anywhere, but it's best to do it
1058 just once, inside the preamble.
1061 \begin_layout Itemize
1062 Declare user defined commands (with
1063 \begin_inset Flex CharStyle:Code
1066 \begin_layout Plain Layout
1075 \begin_inset Flex CharStyle:Code
1078 \begin_layout Plain Layout
1087 \begin_inset Newline newline
1090 These are abbreviations for LaTeX commands which appear very often inside
1092 Although the preamble is a good place to declare such commands, they
1096 be declared anywhere (before they are used for the first time, of course).
1097 This can be useful if there is a lot of raw LaTeX code in your document,
1098 which normally should not be the case.
1101 \begin_layout Standard
1102 LyX adds its own set of definitions to the preamble of the
1103 \begin_inset Flex CharStyle:Code
1106 \begin_layout Plain Layout
1113 This makes LaTeX files generated by LyX portable.
1116 \begin_layout Subsection
1117 Changing the Preamble
1120 \begin_layout Standard
1121 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1122 can't change them without patching LyX itself.
1123 You can, however, add your own stuff to the preamble by selecting
1124 \begin_inset Flex CharStyle:MenuItem
1127 \begin_layout Plain Layout
1129 \begin_inset space ~
1138 \begin_inset Flex CharStyle:MenuItem
1141 \begin_layout Plain Layout
1142 Document\SpecialChar \menuseparator
1149 LyX adds anything in the
1150 \begin_inset Flex CharStyle:MenuItem
1153 \begin_layout Plain Layout
1159 dialog to its own built-in preamble.
1160 Before adding your own declarations in the preamble, you should make sure
1161 that LyX doesn't already support what you want to do.
1162 (Remember what we said about reinventing the wheel?) Also,
1164 make sure your preamble code is correct
1167 LyX doesn't check it for you.
1168 If there is an error, you're likely to get an error like
1169 \begin_inset Quotes eld
1173 \begin_inset Flex CharStyle:Code
1176 \begin_layout Plain Layout
1185 \begin_inset Quotes erd
1189 If you see this error, check your preamble.
1192 \begin_layout Subsection
1196 \begin_layout Standard
1197 Here are some examples of what you can add to a preamble, and what they
1201 \begin_layout Subsubsection
1205 \begin_layout Standard
1206 There are two variables under LaTeX that control page position:
1207 \begin_inset Flex CharStyle:Code
1210 \begin_layout Plain Layout
1219 \begin_inset Flex CharStyle:Code
1222 \begin_layout Plain Layout
1231 Their names should be self-explanatory.
1232 These variables are useful if you think for a moment about computer labels.
1233 Sometimes, the size of a print medium and the area of the medium that you
1234 can actually print on aren't the same.
1236 \begin_inset Flex CharStyle:Code
1239 \begin_layout Plain Layout
1248 \begin_inset Flex CharStyle:Code
1251 \begin_layout Plain Layout
1262 \begin_layout Standard
1263 The default values for
1264 \begin_inset Flex CharStyle:Code
1267 \begin_layout Plain Layout
1276 \begin_inset Flex CharStyle:Code
1279 \begin_layout Plain Layout
1288 \begin_inset space \thinspace{}
1292 \begin_inset space \thinspace{}
1296 \begin_inset space \space{}
1299 the page isn't shifted.
1300 Unfortunately, some DVI drivers always seem to shift the page.
1301 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1302 If you're using LyX on a system that you don't personally maintain, and
1303 your sysadmin is a doofus,
1304 \begin_inset Flex CharStyle:Code
1307 \begin_layout Plain Layout
1316 \begin_inset Flex CharStyle:Code
1319 \begin_layout Plain Layout
1328 Suppose you're left and top margins are always 0.5
1329 \begin_inset space \thinspace{}
1333 You can add this to the preamble:
1336 \begin_layout LyX-Code
1344 \begin_layout LyX-Code
1352 \begin_layout Standard
1353 and your margins should now be correct.
1356 \begin_layout Subsubsection
1360 \begin_layout Standard
1361 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1362 There's a rather nice package, available at your nearest CTAN archive,
1363 for printing sheets of labels:
1364 \begin_inset Flex CharStyle:Code
1367 \begin_layout Plain Layout
1374 Now, your system may not have this package installed by default.
1375 We leave that up to you to check.
1376 You'll also want to read the documentation for it; we're not going to do
1378 Since this is an example, however, we'll give you an example of how you
1382 \begin_layout Standard
1383 First, make sure you're using the
1384 \begin_inset Flex CharStyle:Code
1387 \begin_layout Plain Layout
1394 Next, you need to put the following in your preamble:
1397 \begin_layout LyX-Code
1403 \begin_layout LyX-Code
1409 \begin_layout LyX-Code
1415 \begin_layout LyX-Code
1421 \begin_layout LyX-Code
1427 \begin_layout LyX-Code
1433 \begin_layout LyX-Code
1439 \begin_layout Standard
1440 This sets things up for Avery label sheets, stock #5360.
1441 You're now ready to print labels, but you'll need to insert LaTeX code,
1442 placing the commands
1443 \begin_inset Flex CharStyle:Code
1446 \begin_layout Plain Layout
1455 \begin_inset Flex CharStyle:Code
1458 \begin_layout Plain Layout
1466 around each label text.
1467 This and other special features of
1468 \begin_inset Flex CharStyle:Code
1471 \begin_layout Plain Layout
1477 are explained in its documentation.
1480 \begin_layout Standard
1481 Someday, someone may write a LyX layout file to support this package directly.
1482 Maybe that someone is you.
1485 \begin_layout Subsubsection
1486 Example #3: Paragraph Indentation
1489 \begin_layout Standard
1490 Americans are trained to indent the first line of
1495 As with all of their other weird quirks, most Americans will whine and
1496 moan until they can have their way and indent the first line of all paragraphs.
1505 \begin_layout Standard
1506 Of course, this behavior isn't standard typography.
1507 In books, you typically only indent the first line of a paragraph
1511 it follows another one.
1512 The idea behind indenting the first line of a paragraph is to distinguish
1513 neighboring paragraphs from one another.
1514 If there is no previous paragraph—for example, if it follows a figure or
1515 is the first paragraph in a section—then there is no need for indentation.
1519 \begin_layout Standard
1520 If you're a typical American (we're still joking!), though, you don't care
1521 about such esoteric things; you want your indentation! Add this to the
1525 \begin_layout LyX-Code
1528 usepackage{indentfirst}
1531 \begin_layout Standard
1532 If your TeX distribution isn't braindead, you'll have this package, and
1533 all of your paragraphs will get the indentation the Founding Fathers intended
1537 \begin_layout Subsubsection
1538 Example #4: This Document
1541 \begin_layout Standard
1542 You can also check out the preamble of this document to get an idea of some
1543 of the advanced things you can do.
1544 Also, there are more examples and an assortment of LaTeX
1545 \begin_inset Quotes eld
1549 \begin_inset Quotes erd
1553 \begin_inset space ~
1557 \begin_inset CommandInset ref
1559 reference "cha:secrets"
1567 \begin_layout Section
1568 LyX and LaTeX Errors
1571 \begin_layout Standard
1572 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1574 It then uses the logfile from the LaTeX run to do a post-mortem.
1575 After analyzing the logfile,LyX displays a dialog listing the errors.
1576 Clicking on any one of them will take you to the position in your LyX file
1577 where the error occurred.
1581 \begin_layout Plain Layout
1583 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1585 There are also cases where LaTeX reports the error on one line, but the
1586 actual error is earlier.
1587 This is not unlike forgetting a closing brace in a program: You'll get
1588 an error, but only later.
1596 \begin_layout Standard
1597 Some folks also like to look at the log file directly: It is available from
1599 \begin_inset Flex CharStyle:MenuItem
1602 \begin_layout Plain Layout
1605 \SpecialChar \menuseparator
1609 \begin_inset space ~
1618 There are some fairly common error messages and warnings.
1619 We'll cover those here.
1620 You should look at a good LaTeX book for a complete listing.
1623 \begin_layout Itemize
1624 \begin_inset Flex CharStyle:Code
1627 \begin_layout Plain Layout
1634 \begin_inset Newline newline
1637 Anything beginning with these words is a warning message for the purpose
1639 \begin_inset Quotes eld
1643 \begin_inset Quotes erd
1646 the LaTeX code itself.
1647 You'll get messages like this if you added or changed cross-references
1648 or bibliography entries, in which case, LaTeX is trying to tell you that
1649 you need to make another run.
1650 You can by-and-large ignore these.
1653 \begin_layout Itemize
1654 \begin_inset Flex CharStyle:Code
1657 \begin_layout Plain Layout
1664 \begin_inset Newline newline
1667 Another warning message, this time about fonts which LaTeX couldn't find.
1668 The rest of the message will often say something about a replacement font
1670 You can safely ignore these, too.
1673 \begin_layout Itemize
1674 \begin_inset Flex CharStyle:Code
1677 \begin_layout Plain Layout
1686 \begin_inset Newline newline
1694 They are warnings about lines that were too long and run past the right
1696 Almost always, this is unnoticeable in the final output.
1697 (It can be just a point or two.) Or, only one or two characters extend past
1699 LaTeX seems to generate at least one of these messages for just about any
1701 \begin_inset Newline newline
1704 You can ignore these messages.
1705 Your eyes will tell you if there's a problem with something that's too
1706 wide; just look at the output.
1710 \begin_layout Plain Layout
1711 You can also enable the `draft' option in
1712 \begin_inset Flex CharStyle:MenuItem
1715 \begin_layout Plain Layout
1718 \SpecialChar \menuseparator
1726 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1734 \begin_layout Itemize
1735 \begin_inset Flex CharStyle:Code
1738 \begin_layout Plain Layout
1747 \begin_inset Newline newline
1750 Not quite as common as its cousin.
1751 LaTeX seems to like to print lines that are a bit too wide as opposed to
1752 ones that are a bit too narrow.
1753 We have no idea why.
1756 \begin_layout Itemize
1757 \begin_inset Flex CharStyle:Code
1760 \begin_layout Plain Layout
1769 \begin_inset Flex CharStyle:Code
1772 \begin_layout Plain Layout
1781 \begin_inset Newline newline
1784 Warnings about troubles breaking the page.
1785 Once again, just look at the output.
1786 Your eyes will tell you where something has gone wrong.
1789 \begin_layout Itemize
1790 \begin_inset Flex CharStyle:Code
1793 \begin_layout Plain Layout
1795 \begin_inset Quotes els
1799 \begin_inset Quotes ers
1808 \begin_inset Newline newline
1812 \begin_inset Quotes eld
1816 \begin_inset Quotes erd
1819 isn't installed on this system.
1820 This usually appears because some package your document needs isn't installed.
1821 If you didn't touch the preamble or didn't use the
1822 \begin_inset Flex CharStyle:Code
1825 \begin_layout Plain Layout
1833 command, then one of the packages LyX tried to load is missing.
1835 \begin_inset Flex CharStyle:MenuItem
1838 \begin_layout Plain Layout
1839 Help\SpecialChar \menuseparator
1845 to get a list of packages that LyX knows about.
1846 This file is updated whenever you reconfigure LyX (using
1847 \begin_inset Flex CharStyle:MenuItem
1850 \begin_layout Plain Layout
1851 Tools\SpecialChar \menuseparator
1857 ) and tells you which packages have been detected and what they do.
1858 \begin_inset Newline newline
1862 \begin_inset Flex CharStyle:Code
1865 \begin_layout Plain Layout
1873 command and the package in question isn't installed, then you'll need to
1874 install it yourself.
1877 \begin_layout Itemize
1878 \begin_inset Flex CharStyle:Code
1881 \begin_layout Plain Layout
1882 LaTeX Error: Unknown option
1888 \begin_inset Newline newline
1891 Error messages beginning with this are trying to tell you that you specified
1892 a bad or undefined option to a package.
1893 Check the package's documentation.
1896 \begin_layout Itemize
1897 \begin_inset Flex CharStyle:Code
1900 \begin_layout Plain Layout
1901 Undefined control sequence
1907 \begin_inset Newline newline
1910 If you've inserted LaTeX code into your document, but made a typo, you'll
1912 You may have forgotten to load a package.
1913 In any case, this error message usually means that you used an undefined
1918 \begin_layout Standard
1919 There are other error and warning messages.
1920 Some are self-explanatory.
1921 These are usually LaTeX messages.
1922 Others are downright cryptic.
1923 These are usually TeX error messages, and we really have
1927 what they mean or how to decipher them.
1931 \begin_layout Standard
1932 There's a general sequence you should follow if you get error messages:
1935 \begin_layout Enumerate
1936 Look at the LaTeX code you inserted for typos.
1939 \begin_layout Enumerate
1940 If there are no typos, check that you used the command(s) correctly.
1943 \begin_layout Enumerate
1944 If you get a bunch of error boxes piled up at the very top of the document—and
1945 especially if you see a
1946 \begin_inset Quotes eld
1950 \begin_inset Flex CharStyle:Code
1953 \begin_layout Plain Layout
1962 \begin_inset Quotes erd
1965 error—it means that there are errors in the preamble.
1966 Start debugging your preamble.
1969 \begin_layout Enumerate
1970 If you didn't add anything to the preamble and didn't add any LaTeX code
1971 to the document, the first suspect is your LaTeX distribution itself.
1972 Check for missing packages and install them.
1975 \begin_layout Enumerate
1976 Okay, so there are no missing packages.
1977 Did you use any of the fine-tuning options in LyX? Specifically, did you
1982 any of them, like trying to manually insert lots of
1983 \begin_inset Flex CharStyle:Code
1986 \begin_layout Plain Layout
1988 \begin_inset space ~
1997 \begin_inset Flex CharStyle:Code
2000 \begin_layout Plain Layout
2007 \begin_inset Flex CharStyle:Code
2010 \begin_layout Plain Layout
2016 ? Did you try to kludge something together with these instead of using the
2017 appropriate paragraph environment?
2020 \begin_layout Enumerate
2021 All right, you didn't use any of the fine-tuning options, you played by
2023 Did you try to pull a fancy maneuver? Did you do something funky inside
2024 a table or an equation, like inserting a graphic into a table cell?
2027 \begin_layout Enumerate
2028 Do you have long sections of text where LaTeX cannot find a place to break
2029 a line? By default, LaTeX is rather strict about how much extra inter-word
2030 spacing it will add in order to break a line.
2031 Preferably, you should rework the paragraph to avoid the problem.
2032 If this isn't an option, you can wrap your text in
2033 \begin_inset Flex CharStyle:Code
2036 \begin_layout Plain Layout
2044 to make LaTeX's line breaking more, well, sloppy.
2047 \begin_layout Enumerate
2048 Did you go overboard with the nesting? LyX (currently) doesn't check to
2049 make sure you're in the limits for nesting environments.
2050 If you nested a bunch of environments to the
2051 \begin_inset Formula $17^{\mathrm{th}}$
2054 level, that's the problem.
2055 (The limit in LaTeX is five.)
2058 \begin_layout Enumerate
2059 Okay, you didn't get any error messages, but your output looks awful.
2060 If you have a table or figure that's too wide or long for the page, you
2065 \begin_layout Enumerate
2066 rescale the figure so it fits.
2069 \begin_layout Enumerate
2070 trim down the table so it fits.
2074 \begin_layout Enumerate
2075 If something else is wrong with the output, and you didn't try to pull anything
2076 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2079 \begin_layout Standard
2080 If all this doesn't help—well, then
2084 you might have found a bug in LyX\SpecialChar \ldots{}
2088 \begin_layout Chapter
2092 \begin_layout Section
2093 Customizing Bibliographies with BibTeX
2096 \begin_layout Standard
2097 The basics how to use BibTeX are explained in section
2099 Bibliography databases (BibTeX)
2106 The following subsections explain special bibliography features supported
2110 \begin_layout Subsection
2111 Alternative Citation Styles
2114 \begin_layout Standard
2115 Standard BibTeX uses numbers (e.
2116 \begin_inset space \thinspace{}
2120 \begin_inset space \space{}
2124 \begin_inset Quotes eld
2128 \begin_inset Quotes erd
2131 ) to refer to a cited work.
2132 However, in many scientific disciplines, other citation styles are in use.
2133 The most common one is the author-year style (e.
2134 \begin_inset space \thinspace{}
2138 \begin_inset space \space{}
2142 \begin_inset Quotes eld
2146 \begin_inset Quotes erd
2150 LyX supports two packages that provide this style,
2151 \begin_inset Flex CharStyle:Code
2154 \begin_layout Plain Layout
2161 \begin_inset Flex CharStyle:Code
2164 \begin_layout Plain Layout
2171 Both packages have their pros and cons, which cannot be listed in detail.
2172 If you only want to have simple author-year (or author-numerical) style,
2173 or if you want to use one of the countless style files for
2174 \begin_inset Flex CharStyle:Code
2177 \begin_layout Plain Layout
2183 , than the established
2184 \begin_inset Flex CharStyle:Code
2187 \begin_layout Plain Layout
2193 package is probably your choice.
2194 If you need special features like short title references, ibidem etc., you
2196 \begin_inset Flex CharStyle:Code
2199 \begin_layout Plain Layout
2208 \begin_layout Standard
2209 The handling of both packages in LyX is basically the same.
2211 \begin_inset Flex CharStyle:MenuItem
2214 \begin_layout Plain Layout
2215 Document\SpecialChar \menuseparator
2222 \begin_inset Flex CharStyle:MenuItem
2225 \begin_layout Plain Layout
2232 \begin_inset Flex CharStyle:MenuItem
2235 \begin_layout Plain Layout
2242 \begin_inset Flex CharStyle:MenuItem
2245 \begin_layout Plain Layout
2252 With both packages, you will get some extra features in the citation dialog
2253 and you can select the style of the reference (
2254 \begin_inset Quotes eld
2258 \begin_inset Quotes erd
2262 \begin_inset Quotes eld
2266 \begin_inset Quotes erd
2270 \begin_inset Quotes eld
2274 \begin_inset Quotes erd
2278 \begin_inset Quotes eld
2282 \begin_inset Quotes erd
2286 Note that both packages need specifically designed style files.
2287 They both ship their own, but there are lots of additional style files,
2288 and there is even an interactive style file builder
2292 \begin_layout Plain Layout
2294 \begin_inset Flex URL
2297 \begin_layout Plain Layout
2299 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2310 \begin_inset Flex CharStyle:Code
2313 \begin_layout Plain Layout
2322 \begin_layout Subsection
2323 Sectioned Bibliographies
2326 \begin_layout Standard
2327 Sometimes you might need to divide your bibliography into several sections.
2328 If you are for instance a historian, the possibility to separate sources
2329 and scientific works is most likely a
2330 \begin_inset Quotes eld
2334 \begin_inset Quotes erd
2338 Unfortunately, BibTeX itself does not allow you to do this.
2339 But with the help of some LaTeX packages, BibTeX can be extended to fit
2343 \begin_layout Standard
2344 LyX provides native support for one of these packages,
2352 \begin_layout Plain Layout
2354 \begin_inset Flex URL
2357 \begin_layout Plain Layout
2359 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2369 The advantage of this package (compared to other packages like
2373 ) is that you don't need to define new citation commands.
2374 Instead, you need to prepare different bibliographic databases which include
2375 the entries for the different sections of the bibliography.
2376 For example: If you want to divide your bibliography into the sections
2378 \begin_inset Quotes eld
2382 \begin_inset Quotes erd
2386 \begin_inset Quotes eld
2390 \begin_inset Quotes erd
2393 , you first need to create two bibliographic databases, e.
2394 \begin_inset space \thinspace{}
2398 \begin_inset space \space{}
2402 \begin_inset Flex CharStyle:Code
2405 \begin_layout Plain Layout
2412 \begin_inset Flex CharStyle:Code
2415 \begin_layout Plain Layout
2425 \begin_layout Standard
2427 \begin_inset Flex CharStyle:MenuItem
2430 \begin_layout Plain Layout
2431 Document\SpecialChar \menuseparator
2438 \begin_inset Flex CharStyle:MenuItem
2441 \begin_layout Plain Layout
2448 \begin_inset Flex CharStyle:MenuItem
2451 \begin_layout Plain Layout
2452 Sectioned bibliography
2458 Now you can insert multiple BibTeX bibliographies, one for each section
2459 of your bibliography.
2460 Returning to our example: Insert the BibTeX bibliography
2461 \begin_inset Flex CharStyle:Code
2464 \begin_layout Plain Layout
2470 and a second one for the database
2471 \begin_inset Flex CharStyle:Code
2474 \begin_layout Plain Layout
2481 You are free to use the same or different styles for each section.
2482 Additionally, you can chose if the bibliography section should contain
2484 \begin_inset Quotes eld
2487 all cited references
2488 \begin_inset Quotes erd
2491 of the specified database(s) (which is the default),
2492 \begin_inset Quotes eld
2495 all uncited references
2496 \begin_inset Quotes erd
2500 \begin_inset Quotes eld
2504 \begin_inset Quotes erd
2508 This might be useful if you would like to separate your bibliography into
2510 \begin_inset Quotes eld
2514 \begin_inset Quotes erd
2518 \begin_inset Quotes eld
2522 \begin_inset Quotes erd
2526 \begin_inset Quotes eld
2530 \begin_inset Quotes erd
2534 The titles for the sections can be added as ordinary sections or subsections.
2536 \begin_inset Flex CharStyle:Code
2539 \begin_layout Plain Layout
2545 removes the bibliography title, you have manually re-add that, too (as
2546 a chapter* or section*, for instance).
2549 \begin_layout Subsection
2550 Multiple Bibliographies
2553 \begin_layout Standard
2554 Multiple bibliographies, e.
2555 \begin_inset space \thinspace{}
2559 \begin_inset space \space{}
2562 a bibliography for each section or chapter of the document, are not supported
2565 \begin_inset Flex CharStyle:Code
2568 \begin_layout Plain Layout
2574 package, which is used for the creation of sectioned bibliographies in
2575 LyX (see the previous section), provides an easy way to solve this task,
2576 if you are willing to use some
2577 \begin_inset Flex CharStyle:MenuItem
2580 \begin_layout Plain Layout
2587 \begin_inset space ~
2591 \begin_inset CommandInset ref
2593 reference "sec:Inserting-TeX-Code"
2601 \begin_layout Plain Layout
2602 An alternative approach is to use the
2603 \begin_inset Flex CharStyle:Code
2606 \begin_layout Plain Layout
2613 \begin_inset Flex CharStyle:Code
2616 \begin_layout Plain Layout
2622 package, respectively.
2630 \begin_layout Standard
2632 \begin_inset Flex CharStyle:MenuItem
2635 \begin_layout Plain Layout
2636 Document\SpecialChar \menuseparator
2643 \begin_inset Flex CharStyle:MenuItem
2646 \begin_layout Plain Layout
2653 \begin_inset Flex CharStyle:MenuItem
2656 \begin_layout Plain Layout
2657 Sectioned bibliography
2663 In the document, you have to enclose the sections, which shall contain
2664 their own bibliography (including the BibTeX bibliography itself), between
2666 \begin_inset Flex CharStyle:Code
2669 \begin_layout Plain Layout
2678 \begin_inset Flex CharStyle:Code
2681 \begin_layout Plain Layout
2689 (those commands have to be inserted as TeX code).
2690 The bibliography will contain all references which have been cited in the
2692 \begin_inset Flex CharStyle:Code
2695 \begin_layout Plain Layout
2706 If you are using this approach, then every citation reference has to be
2708 \begin_inset Flex CharStyle:Code
2711 \begin_layout Plain Layout
2719 \begin_inset Flex CharStyle:Code
2722 \begin_layout Plain Layout
2731 \begin_layout Section
2735 \begin_layout Subsection
2739 \begin_layout Standard
2740 When you are working on a large file with many sections, it is often convenient
2741 to break up the document into several files, or perhaps you have something
2742 where a table may change from time to time, but the preceding text does
2744 In these cases, you should seriously consider using multipart documents.
2745 For example, scientific papers often have five major sections: the introduction
2746 , observations, results, discussion, and conclusion.
2747 Each of these could be its own separate LyX file, with one
2748 \begin_inset Quotes eld
2752 \begin_inset Quotes erd
2755 file which contains the title, authors, abstract, references, etc., plus
2756 the five included files.
2757 It is important to note that each of these files is a full LyX file which
2758 can be formatted and printed on its own, as well as included in a master
2760 Each of these files must have the same document class, however—don't attempt
2761 to mix book classes with article classes.
2762 You may also include LaTeX files; however, these files must not have their
2764 \begin_inset space \thinspace{}
2768 \begin_inset space \space{}
2771 everything up to and including the
2772 \begin_inset Flex CharStyle:Code
2775 \begin_layout Plain Layout
2784 \begin_inset Flex CharStyle:Code
2787 \begin_layout Plain Layout
2795 line must be deleted) or else errors will be generated when you try to
2799 \begin_layout Standard
2800 LyX allows you to include files quite easily with
2801 \begin_inset Flex CharStyle:MenuItem
2804 \begin_layout Plain Layout
2805 Insert\SpecialChar \menuseparator
2807 \begin_inset space ~
2816 When you click on this selection a small box is inserted into the file
2817 at the current cursor location.
2818 Clicking on the box raises a dialog which allows you to select the file
2819 to be included, and the method of its inclusion.
2823 \begin_layout Standard
2824 The file selection box should by now be obvious.
2825 The three inclusion methods are
2826 \begin_inset Quotes eld
2830 \begin_inset Quotes erd
2834 \begin_inset Quotes eld
2838 \begin_inset Quotes erd
2842 \begin_inset Quotes eld
2846 \begin_inset Quotes erd
2850 The difference between
2851 \begin_inset Quotes eld
2855 \begin_inset Quotes erd
2859 \begin_inset Quotes eld
2863 \begin_inset Quotes erd
2866 is really only meaningful to LaTeXperts, but the practical difference is
2867 that files which are
2868 \begin_inset Quotes eld
2872 \begin_inset Quotes erd
2875 are typeset beginning on a new page, while files which are
2876 \begin_inset Quotes eld
2880 \begin_inset Quotes erd
2883 are typeset starting on the current page.
2886 \begin_layout Standard
2887 Generally, the master file is converted into a full LaTeX file before typesettin
2888 g, while the included files are converted to LaTeX files which do not have
2889 all the preamble information.
2892 \begin_layout Standard
2894 \begin_inset Quotes eld
2898 \begin_inset Quotes erd
2901 included file allows you to include a file typeset exactly as it appears
2903 \begin_inset space \thinspace{}
2907 \begin_inset space \space{}
2911 \begin_inset Flex CharStyle:Code
2914 \begin_layout Plain Layout
2920 mode, with the characters set in a fixed-width typewriter font.
2921 Normally, spaces in this file are invisible, though two consecutive spaces
2922 are conserved, unlike LyX's normal treatment of spaces.
2923 However, setting the
2924 \begin_inset Flex CharStyle:MenuItem
2927 \begin_layout Plain Layout
2929 \begin_inset space ~
2933 \begin_inset space ~
2937 \begin_inset space ~
2945 checkbox typesets a mark to unambiguously define the presence of a space.
2949 \begin_layout Subsection
2950 Cross-References Between Files
2953 \begin_layout Standard
2954 \begin_inset Box Shadowbox
2963 height_special "totalheight"
2966 \begin_layout Plain Layout
2967 This section is somewhat out of date.
2968 Need to describe default master documents and how children are opened when
2978 \begin_layout Standard
2979 It is possible to set up cross-references between the different files.
2980 First, open all the files in question: let's call them A and B in a two
2981 file example, where B is included in A.
2982 Let's say you insert a label in A, then want to reference it in B.
2983 Open the cross-reference dialog in whilst in document B, and you can select
2985 \begin_inset Quotes eld
2989 \begin_inset Quotes erd
2995 \begin_layout Subsection
2996 Bibliography Lists in all Subdocuments
2999 \begin_layout Standard
3000 \begin_inset Box Frameless
3009 height_special "totalheight"
3012 \begin_layout Plain Layout
3013 This section also needs updating.
3014 There is now material about this on the wiki, and it could be copied here.
3022 \begin_layout Standard
3023 Copy the bibliography list with all entries to all subdocuments and transform
3025 This way LyX will find the
3026 \begin_inset Flex CharStyle:Code
3029 \begin_layout Plain Layout
3035 -files and you can easily insert references without making the bibliography
3039 \begin_layout Standard
3040 As the bibliography list is in a comment, LaTeX won't use use it and the
3041 references will look like this: [?], instead of like this: [1].
3042 One solution is to use the LaTeX-package
3043 \begin_inset Flex CharStyle:Code
3046 \begin_layout Plain Layout
3052 that will only include comments by processing the files separately.
3053 To do this, add in the LaTeX preamble of every subdocument the following:
3056 \begin_layout LyX-Code
3062 \begin_layout LyX-Code
3065 includecomment{comment}
3068 \begin_layout Standard
3070 \begin_inset Flex URL
3073 \begin_layout Plain Layout
3075 http://wiki.lyx.org/FAQ/Unsorted#toc31
3083 \begin_layout Section
3084 Fancy Headers and Footers
3087 \begin_layout Standard
3088 The default page layout is rather plain; for an
3089 \begin_inset Flex CharStyle:Code
3092 \begin_layout Plain Layout
3098 document class, all you get is a centered page number at the bottom of
3100 This document uses KOMA-script's book class, so it appears to be a bit
3102 But to really put on a show, you need to set the document page style to
3104 \begin_inset Quotes eld
3108 \begin_inset Quotes erd
3111 , as mentioned in the
3116 This section describes the LaTeX code you need to insert in your LaTeX
3117 preamble in order to get the desired effects.
3120 \begin_layout Standard
3121 For more information on fancy headers, see the
3122 \begin_inset Flex CharStyle:Code
3125 \begin_layout Plain Layout
3131 package documentation.
3132 This can be found in the file
3133 \begin_inset Flex CharStyle:Code
3136 \begin_layout Plain Layout
3142 , which should have been installed with your LaTeX distribution, or
3143 \begin_inset CommandInset href
3146 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3153 \begin_layout Standard
3154 The page header is divided into three fields, not surprisingly labeled
3155 \begin_inset Quotes eld
3159 \begin_inset Quotes erd
3163 \begin_inset Quotes eld
3167 \begin_inset Quotes erd
3171 \begin_inset Quotes eld
3175 \begin_inset Quotes erd
3179 The footer is also divided into these three fields.
3180 The LaTeX commands to set these fields in the simplest manner are
3181 \begin_inset Flex CharStyle:Code
3184 \begin_layout Plain Layout
3193 \begin_inset Flex CharStyle:Code
3196 \begin_layout Plain Layout
3205 \begin_inset Flex CharStyle:Code
3208 \begin_layout Plain Layout
3217 \begin_inset Flex CharStyle:Code
3220 \begin_layout Plain Layout
3229 Suppose you wish to put your name in the upper left hand corner of each
3231 Simply insert the following command in the preamble:
3234 \begin_layout Standard
3243 \begin_layout Standard
3244 You will now see your name in the upper left.
3245 If a field has a default entry that you would like to get rid of (often
3246 the page number appears in the central footer, simply include a command
3247 with a blank argument, e.
3248 \begin_inset space \thinspace{}
3254 \begin_layout Standard
3262 \begin_layout Standard
3263 Let's get really fancy: lets put the section number with the word
3264 \begin_inset Quotes eld
3268 \begin_inset Quotes erd
3272 \begin_inset space \thinspace{}
3276 \begin_inset space \space{}
3279 Section 3) in the upper left, the page number (e.
3280 \begin_inset space \thinspace{}
3284 \begin_inset space \space{}
3287 Page 4) in the upper right, your name in the lower left, and the date in
3289 The following commands should now appear in the preamble:
3292 \begin_layout Standard
3302 \begin_layout Standard
3310 \begin_layout Standard
3320 \begin_layout Standard
3329 \begin_layout Standard
3337 \begin_layout Standard
3347 \begin_layout Standard
3349 \begin_inset Flex CharStyle:Code
3352 \begin_layout Plain Layout
3361 \begin_inset Flex CharStyle:Code
3364 \begin_layout Plain Layout
3372 access LaTeX's section and page counters, and so print out the current
3373 section and page numbers.
3375 \begin_inset Flex CharStyle:Code
3378 \begin_layout Plain Layout
3386 simply prints out today's date.
3389 \begin_layout Standard
3390 The thicknesses of the horizontal rules drawn beneath the header and above
3391 the footer can also be modified.
3392 If you don't want one of the rules, set its thickness to 0.
3393 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3399 \begin_inset Flex CharStyle:Code
3402 \begin_layout Plain Layout
3407 headrulewidth}{0.4pt}
3413 \begin_inset Flex CharStyle:Code
3416 \begin_layout Plain Layout
3421 footrulewidth}{0.4pt}
3426 to set the thicknesses.
3429 \begin_layout Standard
3430 You can switch the header/footer settings on and off for individual pages
3432 \begin_inset Flex CharStyle:Code
3435 \begin_layout Plain Layout
3438 thispagestyle{empty}
3444 \begin_inset Flex CharStyle:Code
3447 \begin_layout Plain Layout
3450 thispagestyle{plain}
3456 \begin_inset Flex CharStyle:Code
3459 \begin_layout Plain Layout
3462 thispagestyle{fancy}
3468 Simply insert them in the text on the page you want changed and mark them
3470 In fact, title pages are marked as plain by default, while following pages
3471 are marked fancy when using the global fancy setting.
3474 \begin_layout Standard
3475 As a final example, it is possible to include an image in the header or
3477 Suppose you want to put a company logo in the upper lefthand corner.
3478 You might try something like
3481 \begin_layout Standard
3490 includegraphics{logo.eps}}}
3493 \begin_layout Standard
3495 (you may need to preface this with
3496 \begin_inset Flex CharStyle:Code
3499 \begin_layout Plain Layout
3503 usepackage{graphics}
3508 if you don't include graphics elsewhere in your document).
3511 \begin_layout Section
3512 Itemize Bullet Selection
3513 \begin_inset CommandInset label
3522 \begin_layout Standard
3528 \begin_layout Subsection
3532 \begin_layout Standard
3533 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3534 Using this dialog you can easily specify what bullet shape to use at each
3535 level of an itemized list.
3536 These settings are document-wide so you won't be able to specify different
3537 sets of bullets for different paragraphs.
3541 \begin_layout Plain Layout
3542 Well, actually you can but you'll have to do it by hand.
3550 \begin_layout Subsection
3554 \begin_layout Standard
3555 Open the dialog by selecting the
3556 \begin_inset Flex CharStyle:MenuItem
3559 \begin_layout Plain Layout
3560 Document\SpecialChar \menuseparator
3566 menu item and then select the
3567 \begin_inset Flex CharStyle:MenuItem
3570 \begin_layout Plain Layout
3579 \begin_layout Standard
3580 The dialog provides you with a table of bullet shapes.
3581 A column of buttons on the left of the table provides access to the six
3582 different panels of bullet shapes.
3583 The row of buttons across the top is used to select which bullet depth
3585 A text entry under the table shows the currently selected bullet shape's
3586 LaTeX equivalent and this can be edited if desired.
3587 If you do modify the text you will also need to specify any needed packages
3588 in the LaTeX preamble.
3591 \begin_layout Standard
3592 The six panels are divided up by the packages they require.
3593 The following table shows the mappings from button name to LaTeX packages.
3596 \begin_layout Standard
3598 \begin_inset Tabular
3599 <lyxtabular version="3" rows="7" columns="2">
3600 <features tabularvalignment="middle">
3601 <column alignment="center" valignment="top" width="0pt">
3602 <column alignment="center" valignment="top" width="0pt">
3604 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3607 \begin_layout Plain Layout
3622 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3625 \begin_layout Plain Layout
3642 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3645 \begin_layout Plain Layout
3660 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3663 \begin_layout Plain Layout
3679 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3682 \begin_layout Plain Layout
3697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3700 \begin_layout Plain Layout
3717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3720 \begin_layout Plain Layout
3735 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3738 \begin_layout Plain Layout
3755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3758 \begin_layout Plain Layout
3773 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3776 \begin_layout Plain Layout
3793 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3796 \begin_layout Plain Layout
3811 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3814 \begin_layout Plain Layout
3831 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3834 \begin_layout Plain Layout
3849 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3852 \begin_layout Plain Layout
3875 \begin_layout Standard
3876 LyX doesn't stop you using bullets from packages you don't have.
3877 If you get errors from LaTeX when you try to view or print the file, then
3878 it is likely you are missing a package.
3882 \begin_layout Plain Layout
3883 LyX doesn't restrict your use since you may be editing locally and exporting
3892 \begin_layout Subsection
3896 \begin_layout Standard
3897 Select which bullet depth you want to change then select the bullet shape
3899 Any changes will not be visible in LyX, but are visible when viewing the
3903 \begin_layout Standard
3904 You can reset a bullet shape to the default simply by clicking your right
3905 mouse button on the appropriate bullet depth button.
3909 \begin_layout Plain Layout
3914 want to have multiple sets of paragraphs with different sets of bullets
3915 in each, then you're going to have to get your hands dirty with TeX code.
3916 The bullet selection dialog can help though because it provides you with
3917 the LaTeX code for a wide range of bullet shapes.
3918 To make your own custom paragraphs you have the following options:
3921 \begin_layout Plain Layout
3925 \begin_layout Plain Layout
3941 \begin_layout Plain Layout
3945 \begin_layout Plain Layout
3967 \begin_layout Itemize
3968 Use the LaTeX command
3969 \begin_inset Flex CharStyle:Code
3972 \begin_layout Plain Layout
3980 to specify a new bullet shape for a given depth.
3981 You'll also need to save the current bullet shape so you can restore it
3983 In this itemized list the following LaTeX code was used to change the bullet
3984 used for the first depth.
3988 \begin_layout LyX-Code
3998 \begin_layout LyX-Code
4015 \begin_layout Itemize
4016 Note that the itemize depth is specified in Roman numerals as part of the
4026 \begin_layout Itemize
4030 \begin_layout Plain Layout
4043 Specify each individual entry by starting each item with the bullet shape
4044 enclosed in square brackets and set as
4045 \begin_inset Flex CharStyle:MenuItem
4048 \begin_layout Plain Layout
4055 For example, this item was started with
4056 \begin_inset Flex CharStyle:Code
4059 \begin_layout Plain Layout
4074 \begin_layout Plain Layout
4078 \begin_layout Plain Layout
4094 \begin_layout Plain Layout
4095 You'll also need to revert the labelitem back to its previous setting for
4096 the global bullet shape settings to remain in effect.
4097 The way used here was:
4100 \begin_layout LyX-Code
4115 \begin_layout Chapter
4119 \begin_layout Section
4123 \begin_layout Standard
4124 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4125 and retrieve information about the LyX internal state.
4126 This is only intended for advanced users, but they should find it useful.
4127 It is by writing to the LyX server, for example, that bibliography managers,
4128 such as JabRef, are able to
4129 \begin_inset Quotes eld
4133 \begin_inset Quotes erd
4139 \begin_layout Standard
4140 Please note that, at present,
4142 the server does not work natively on Windows
4148 \begin_layout Plain Layout
4149 There is no reason it cannot do so.
4150 But none of the developers on Windows have yet implemented this functionality
4156 but it does work with Cygwin versions of LyX.
4159 \begin_layout Section
4160 Starting the LyX Server
4163 \begin_layout Standard
4164 The LyX server works through the use of a pair of named pipes.
4165 These are usually located in
4166 \begin_inset Flex CharStyle:Code
4169 \begin_layout Plain Layout
4176 \begin_inset Quotes eld
4180 \begin_inset Flex CharStyle:Code
4183 \begin_layout Plain Layout
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Flex CharStyle:Code
4201 \begin_layout Plain Layout
4208 \begin_inset Quotes erd
4212 External programs write into
4213 \begin_inset Flex CharStyle:Code
4216 \begin_layout Plain Layout
4222 and read back data from
4223 \begin_inset Flex CharStyle:Code
4226 \begin_layout Plain Layout
4233 The stem of the pipe names can be defined in the
4234 \begin_inset Flex CharStyle:MenuItem
4237 \begin_layout Plain Layout
4238 Tools\SpecialChar \menuseparator
4245 \begin_inset Flex CharStyle:Code
4248 \begin_layout Plain Layout
4249 "/home/myhome/lyxpipe"
4259 configure this manually in order for the server to start.
4262 \begin_layout Standard
4264 \begin_inset Flex CharStyle:Code
4267 \begin_layout Plain Layout
4274 \begin_inset Flex CharStyle:Code
4277 \begin_layout Plain Layout
4283 ' to create the pipes.
4284 If one of the pipes already exists, LyX will assume that another LyX process
4285 is already running and will not start the server.
4286 If for some other reason, an unused
4287 \begin_inset Quotes eld
4291 \begin_inset Quotes erd
4294 pipe is left in existence when LyX closes, then LyX will try to delete
4296 If this fails for some reason, you will need to delete the pipes manually
4297 and then restart LyX.
4300 \begin_layout Standard
4301 To have several LyX processes with servers at the same time, you have to
4302 use different configurations, perhaps by using separate user directories,
4304 \begin_inset Flex CharStyle:Code
4307 \begin_layout Plain Layout
4313 file, for each process.
4316 \begin_layout Standard
4317 If you are developing a client program, you might find it useful to enable
4318 debugging information from the LyX server.
4319 Do this by starting LyX as
4320 \begin_inset Flex CharStyle:Code
4323 \begin_layout Plain Layout
4332 \begin_layout Standard
4333 You can find a complete example client written in C in the source distribution
4335 \begin_inset Flex CharStyle:Code
4338 \begin_layout Plain Layout
4339 development/lyxserver/server_monitor.c
4347 \begin_layout Standard
4348 Another useful tool is command-line based client you will find in
4349 \begin_inset Flex CharStyle:Code
4352 \begin_layout Plain Layout
4353 src/client/lyxclient
4361 \begin_layout Section
4362 Normal communication
4365 \begin_layout Standard
4366 To issue a LyX call, the client writes a line of ASCII text into the input
4368 This line has the following format:
4385 \begin_layout Description
4386 clientname is a name that the client can choose arbitrarily.
4387 Its only use is that LyX will echo it if it sends an answer—so a client
4388 can dispatch results from different requesters.
4391 \begin_layout Description
4392 function is the function you want LyX to perform.
4393 It is the same as the commands you'd use in the minibuffer.
4396 \begin_layout Description
4397 argument is an optional argument which is meaningful only to some functions
4399 \begin_inset Quotes eld
4403 \begin_inset Quotes erd
4406 LFUN will insert the argument as text at the cursor position).
4409 \begin_layout Standard
4410 The answer from LyX will arrive in the output pipe and be of the form
4427 \begin_layout Standard
4436 are just echoed from the command request, while
4440 is more or less useful information filled according to how the command
4441 execution worked out.
4442 Some commands, such as
4443 \begin_inset Quotes eld
4447 \begin_inset Quotes erd
4450 , will return information about the internal state of LyX, while other will
4451 return an empty data-response.
4452 This means that the command execution went fine.
4455 \begin_layout Standard
4456 In case of errors, the response from LyX will have this form
4473 \begin_layout Standard
4478 should contain an explanation of why the command failed.
4481 \begin_layout Standard
4485 \begin_layout LyX-Code
4486 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4487 \begin_inset Newline newline
4490 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4491 \begin_inset Newline newline
4494 read a <~/.lyxpipe.out
4495 \begin_inset Newline newline
4501 \begin_layout Section
4505 \begin_layout Standard
4506 LyX can notify clients of events going on asynchronously.
4507 Currently it will only do this if the user binds a key sequence with the
4509 \begin_inset Quotes eld
4513 \begin_inset Quotes erd
4517 The format of the string LyX sends is as follows:
4521 \begin_inset Flex CharStyle:Code
4524 \begin_layout Plain Layout
4535 \begin_layout Standard
4540 is the printed representation of the key sequence that was actually typed
4544 \begin_layout Standard
4545 This mechanism can be used to extend LyX's command set and implement macros.
4546 Bind some key sequence to
4547 \begin_inset Quotes eld
4551 \begin_inset Quotes erd
4555 Then start a client that listens on the output pipe, dispatches the command
4556 according to the sequence, and starts a function that may use LyX calls
4557 and LyX requests to issue a command or a series of commands to LyX.
4560 \begin_layout Section
4561 The simple LyX Server Protocol
4564 \begin_layout Standard
4565 LyX implements a simple protocol that can be used for session management.
4566 All messages are of the form
4579 \begin_layout Standard
4585 \begin_inset Quotes eld
4589 \begin_inset Quotes erd
4593 \begin_inset Quotes eld
4597 \begin_inset Quotes erd
4602 \begin_inset Quotes eld
4606 \begin_inset Quotes erd
4609 is received from a client, LyX will report back to inform the client that
4610 it's listening to it's messages, while
4611 \begin_inset Quotes eld
4615 \begin_inset Quotes erd
4618 sent from LyX will inform clients that LyX is closing.
4621 \begin_layout Section
4622 Reverse DVI/PDF search
4625 \begin_layout Standard
4626 Some DVI/PDF viewers
4630 \begin_layout Plain Layout
4631 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
4632 Skim on Mac OSX and SumatraPDF on Windows.
4641 facility (also called
4646 This means that you can tell LyX to put the cursor to a specific line in
4647 the document by clicking at the respective position in the DVI/PDF output.
4648 To achieve this, the viewer must be able to communicate with LyX.
4649 This is done via the LyX server either by using the named pipe (
4653 ), or the UNIX domain socket (
4657 ) that LyX creates in its temporary directory (this is the way the
4658 \begin_inset Flex CharStyle:Code
4661 \begin_layout Plain Layout
4667 program communicates with LyX).
4668 In some cases, you need a helper script that mediates between the viewer
4669 and LyX, in others, the viewer can communicate with LyX directly.
4670 This depends on the selected viewer and on your operating system.
4671 The same applies to the way viewers need to be configured and the way the
4672 reverse search is actually performed.
4673 In what follows, we will thus describe how to setup reverse search for
4675 Before we turn to this, though, we will explain what needs to be done generally
4676 to enable reverse search in the DVI/PDF output.
4679 \begin_layout Subsection
4680 Enabling reverse search
4683 \begin_layout Standard
4684 LaTeX provides several different methods for reverse search.
4685 Some are built-in in the
4686 \begin_inset Flex CharStyle:Code
4689 \begin_layout Plain Layout
4695 program, some are provided by external packages.
4696 Your choice depends on whether your LaTeX distribution already provides
4697 a given method (the built-in methods are rather new) and whether your viewer
4699 The available methods are described in the following.
4702 \begin_layout Subsubsection*
4703 Built-in DVI-search via src-specials (DVI only)
4706 \begin_layout Standard
4707 This method provides the DVI file with the necessary information for reverse
4709 It is available in LaTeX since quite some time (any somewhat recent LaTeX
4710 distribution should include it), and it works reliably.
4711 To enable it, change the
4712 \begin_inset Flex CharStyle:MenuItem
4715 \begin_layout Plain Layout
4720 \begin_layout Plain Layout
4733 \begin_inset Flex CharStyle:MenuItem
4736 \begin_layout Plain Layout
4741 \begin_layout Plain Layout
4748 eX (plain)->DraftDVI
4754 \begin_inset Flex CharStyle:MenuItem
4757 \begin_layout Plain Layout
4758 Preferences\SpecialChar \menuseparator
4759 File Handling\SpecialChar \menuseparator
4766 \begin_inset Flex CharStyle:Code
4769 \begin_layout Plain Layout
4770 latex -src-specials $$i
4776 If this doesn't work, check if your TeX engine needs different options
4777 (the syntax might differ in some distributions).
4780 \begin_layout Subsubsection*
4781 External Packages (PDFSync and scrltx)
4784 \begin_layout Standard
4793 provide reverse search facility for PDF output (via pdflatex) and DVI output,
4795 In order to enable it, load the packages in the LyX preamble:
4798 \begin_layout Itemize
4799 \begin_inset Flex CharStyle:Code
4802 \begin_layout Plain Layout
4810 for reverse PDF search,
4813 \begin_layout Itemize
4815 \begin_inset Flex CharStyle:Code
4818 \begin_layout Plain Layout
4821 usepackage[active]{srcltx}
4826 for reverse DVI search.
4829 \begin_layout Standard
4830 If you want to be able to perform both DVI and PDF reverse searches, you
4831 can also insert in the preamble the following lines
4834 \begin_layout LyX-Code
4838 \begin_inset Newline newline
4844 \begin_inset Newline newline
4850 \begin_inset Newline newline
4856 \begin_inset Newline newline
4861 usepackage[active]{srcltx}
4862 \begin_inset Newline newline
4870 \begin_layout Standard
4871 This way, you can preview the file as either DVI or PDF (pdflatex) and the
4872 right package will be used.
4875 \begin_layout Standard
4876 Note that PDFSync might affect the output layout of your document.
4877 It is therefore advised to disable PDFsync for final documents.
4880 \begin_layout Subsubsection*
4881 Built-in reverse search via SyncTeX (DVI and PDF)
4884 \begin_layout Standard
4886 \begin_inset Flex CharStyle:Code
4889 \begin_layout Plain Layout
4895 have built-in support for both PDF and DVI reverse search.
4900 facility is basically the result of the integration of the PDFSync package
4901 to the pdftex program and its merge with the
4906 You need at least TeXLive 2008 or a recent MikTeX distribution in order
4908 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
4909 already provide SyncTeX support.
4912 \begin_layout Standard
4913 To enable SyncTeX for DVI output, change the
4914 \begin_inset Flex CharStyle:MenuItem
4917 \begin_layout Plain Layout
4922 \begin_layout Plain Layout
4935 \begin_inset Flex CharStyle:MenuItem
4938 \begin_layout Plain Layout
4943 \begin_layout Plain Layout
4950 eX (plain) -> DraftDVI
4956 \begin_inset Flex CharStyle:MenuItem
4959 \begin_layout Plain Layout
4960 Preferences\SpecialChar \menuseparator
4961 File Handling\SpecialChar \menuseparator
4968 \begin_inset Flex CharStyle:Code
4971 \begin_layout Plain Layout
4972 latex -synctex=1 $$i
4977 , and for PDF output, change the
4978 \begin_inset Flex CharStyle:MenuItem
4981 \begin_layout Plain Layout
4986 \begin_layout Plain Layout
4993 eX (pdflatex) -> PDF (pdflatex)
4999 \begin_inset Flex CharStyle:Code
5002 \begin_layout Plain Layout
5003 pdflatex -synctex=1 $$i
5009 Check the documentation of your viewer whether the viewer needs to be configure
5010 d for the use with SyncTeX.
5014 \begin_layout Plain Layout
5016 \begin_inset Flex CharStyle:Code
5019 \begin_layout Plain Layout
5025 option enables gzip compression.
5026 If your viewer does not support it, you should instead use
5027 \begin_inset Flex CharStyle:Code
5030 \begin_layout Plain Layout
5044 \begin_layout Subsection
5045 Configuring and using specific viewers
5048 \begin_layout Subsubsection*
5049 Xdvi (all platforms)
5052 \begin_layout Standard
5054 \begin_inset Flex CharStyle:Code
5057 \begin_layout Plain Layout
5063 , you don't need to do anything else for performing a reverse DVI search,
5064 as LyX already provides the necessary hooks for automatically using the
5066 \begin_inset Flex CharStyle:Code
5069 \begin_layout Plain Layout
5076 Just setup your document as described above (reverse search is triggered
5077 by Ctrl-click or Alt-click on Mac OSX, respectively).
5080 \begin_layout Standard
5081 However, if for whatever reason you want to use the named pipe instead of
5082 the socket for communicating with LyX, simply change the DVI viewer in
5084 \begin_inset Flex CharStyle:MenuItem
5087 \begin_layout Plain Layout
5088 Preferences\SpecialChar \menuseparator
5089 File Handling\SpecialChar \menuseparator
5099 \begin_layout Plain Layout
5100 On Mac OSX you have to use
5101 \begin_inset Flex CharStyle:Code
5104 \begin_layout Plain Layout
5105 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5116 \begin_inset Flex CharStyle:Code
5119 \begin_layout Plain Layout
5120 xdvi -editor 'lyxeditor.sh %f %l'
5126 \begin_inset Flex CharStyle:Code
5129 \begin_layout Plain Layout
5135 is a suitable script.
5136 For example, a minimal shell script is the following one:
5139 \begin_layout LyX-Code
5141 \begin_inset Newline newline
5144 LYXPIPE="/path/to/lyxpipe"
5145 \begin_inset Newline newline
5148 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5149 \begin_inset Newline newline
5152 echo "$COMMAND" > "${LYXPIPE}".in || exit
5153 \begin_inset Newline newline
5156 read < "${LYXPIPE}".out || exit
5159 \begin_layout Standard
5161 \begin_inset Flex CharStyle:Code
5164 \begin_layout Plain Layout
5174 \begin_layout Plain Layout
5181 XServer pipe path specified in
5182 \begin_inset Flex CharStyle:MenuItem
5185 \begin_layout Plain Layout
5186 Preferences\SpecialChar \menuseparator
5196 \begin_layout Plain Layout
5198 \begin_inset Flex CharStyle:Code
5201 \begin_layout Plain Layout
5207 folder of a source distribution you can find a
5208 \begin_inset Flex CharStyle:Code
5211 \begin_layout Plain Layout
5217 script which is able to locate the
5221 based on your preferences.
5229 \begin_layout Subsubsection*
5233 \begin_layout Standard
5235 \begin_inset Flex CharStyle:Code
5238 \begin_layout Plain Layout
5239 /Applications/MacDviX_Folder/calleditor.script
5244 , add the following lines:
5247 \begin_layout LyX-Code
5252 \begin_layout Plain Layout
5259 X.app/Contents/MacOS/lyxeditor "$2" $1
5260 \begin_inset Newline newline
5266 \begin_layout Standard
5267 Modify the lines accordingly if you install LyX somewhere else than in the
5268 Applications folder.
5271 \begin_layout Standard
5272 Reverse search is triggered by Alt-click (OPTION-click).
5275 \begin_layout Subsubsection*
5279 \begin_layout Standard
5281 \begin_inset Flex CharStyle:Code
5284 \begin_layout Plain Layout
5285 open -a Skim.app $$i
5290 to the viewer setting in
5291 \begin_inset Flex CharStyle:MenuItem
5294 \begin_layout Plain Layout
5295 Preferences\SpecialChar \menuseparator
5296 File Handling\SpecialChar \menuseparator
5297 File formats\SpecialChar \menuseparator
5304 \begin_inset Flex CharStyle:MenuItem
5307 \begin_layout Plain Layout
5308 Skim\SpecialChar \menuseparator
5309 Preferences\SpecialChar \menuseparator
5319 \begin_layout Plain Layout
5329 \begin_layout Standard
5330 Reverse search is triggered by COMMAND-SHIFT-click
5333 \begin_layout Subsubsection*
5337 \begin_layout Standard
5339 \begin_inset Flex CharStyle:MenuItem
5342 \begin_layout Plain Layout
5343 Settings\SpecialChar \menuseparator
5344 Configure Okular\SpecialChar \ldots{}
5345 \SpecialChar \menuseparator
5352 \begin_inset Quotes eld
5356 \begin_inset Quotes erd
5360 \begin_inset Flex CharStyle:Code
5363 \begin_layout Plain Layout
5372 \begin_layout Standard
5373 Reverse search is triggered by SHIFT-click.
5376 \begin_layout Subsubsection*
5380 \begin_layout Standard
5381 Launch yap, choose its
5382 \begin_inset Flex CharStyle:MenuItem
5385 \begin_layout Plain Layout
5386 View\SpecialChar \menuseparator
5393 \begin_inset Quotes eld
5397 \begin_inset Quotes erd
5402 \begin_inset Quotes eld
5405 New\SpecialChar \ldots{}
5407 \begin_inset Quotes erd
5410 button and, in the window that opens, enter
5411 \begin_inset Quotes eld
5415 \begin_inset Quotes erd
5418 (or any other name you like) in the
5419 \begin_inset Quotes eld
5423 \begin_inset Quotes erd
5427 Now click on the button labeled
5428 \begin_inset Quotes eld
5431 \SpecialChar \ldots{}
5433 \begin_inset Quotes erd
5436 to open a file dialog and navigate to the directory containing the batch
5438 \begin_inset Flex CharStyle:Code
5441 \begin_layout Plain Layout
5449 \begin_inset Flex CharStyle:Code
5452 \begin_layout Plain Layout
5458 and then specify the program arguments as
5459 \begin_inset Flex CharStyle:Code
5462 \begin_layout Plain Layout
5468 if you want to use the shell script above, or as
5469 \begin_inset Flex CharStyle:Code
5472 \begin_layout Plain Layout
5478 if you want to use the
5479 \begin_inset Flex CharStyle:Code
5482 \begin_layout Plain Layout
5489 Since yap is a native Windows application, the filename it provides should
5490 be converted to POSIX style before being passed to
5491 \begin_inset Flex CharStyle:Code
5494 \begin_layout Plain Layout
5501 \begin_inset Flex CharStyle:Code
5504 \begin_layout Plain Layout
5510 , and this is the purpose of the
5511 \begin_inset Flex CharStyle:Code
5514 \begin_layout Plain Layout
5520 wrapper, which is as follows:
5523 \begin_layout LyX-Code
5525 \begin_inset Newline newline
5528 if "%1" == "-g" goto lyxclient
5529 \begin_inset Newline newline
5532 bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
5533 \begin_inset Newline newline
5537 \begin_inset Newline newline
5541 \begin_inset Newline newline
5544 bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
5547 \begin_layout Standard
5548 You have to make sure that both
5549 \begin_inset Flex CharStyle:Code
5552 \begin_layout Plain Layout
5559 \begin_inset Flex CharStyle:Code
5562 \begin_layout Plain Layout
5568 are in the command PATH, otherwise you have to use their full posix path
5569 in the above batch file.
5572 \begin_layout Standard
5573 In yap, reverse search is triggered by double-click.
5576 \begin_layout Subsubsection*
5580 \begin_layout Standard
5581 In SumatraPDF, you can set the name of the program that communicates with
5582 LyX by simply launching SumatraPDF as
5583 \begin_inset Flex CharStyle:Code
5586 \begin_layout Plain Layout
5587 SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
5593 The program will remember the setting and using the
5594 \begin_inset Flex CharStyle:Code
5597 \begin_layout Plain Layout
5603 option will not be needed from now on
5607 \begin_layout Plain Layout
5608 It has been reported that SumatraPDF is not able to remember the settings
5609 if it is installed in the Program Files system folder.
5610 This problem can be avoided by installing it somewhere else, for example
5612 \begin_inset Flex CharStyle:Code
5615 \begin_layout Plain Layout
5626 (in this way you will be using the lyxsocket; omit the
5627 \begin_inset Flex CharStyle:Code
5630 \begin_layout Plain Layout
5636 option if you want to use the lyxpipe and be sure that the
5637 \begin_inset Flex CharStyle:Code
5640 \begin_layout Plain Layout
5646 script is in your command PATH).
5647 If SumatraPDF is not your default PDF viewer, you should enter
5648 \begin_inset Flex CharStyle:Code
5651 \begin_layout Plain Layout
5657 in the viewer setting in
5658 \begin_inset Flex CharStyle:MenuItem
5661 \begin_layout Plain Layout
5662 Preferences\SpecialChar \menuseparator
5663 File Handling\SpecialChar \menuseparator
5664 File formats\SpecialChar \menuseparator
5671 \begin_inset Flex CharStyle:Code
5674 \begin_layout Plain Layout
5680 is the following script (to be placed in your command PATH,
5681 \begin_inset Flex CharStyle:Code
5684 \begin_layout Plain Layout
5690 being the best choice):
5693 \begin_layout LyX-Code
5695 \begin_inset Newline newline
5699 \begin_inset Newline newline
5702 SumatraPDF.exe $(basename $1)
5705 \begin_layout Standard
5706 This is needed because SumatraPDF is a native Windows application and does
5707 not understand the posix paths used by the Cygwin version of LyX.
5710 \begin_layout Standard
5711 Reverse search is triggered by double-click.
5714 \begin_layout Chapter
5715 Special Document Classes
5718 \begin_layout Section
5722 \begin_layout Standard
5728 \begin_layout Subsection
5732 \begin_layout Standard
5733 This section describes how LyX can be used to write articles for submission
5734 to the scientific journal
5736 Astronomy and Astrophysics
5738 (www.edpsciences.fr/aa/
5739 \begin_inset Flex URL
5742 \begin_layout Plain Layout
5744 http://www.edpsciences.fr/aa/
5749 ) using Version 5.01 of the document class
5754 This package can be downloaded from the ftp site
5757 \begin_layout Standard
5758 \begin_inset VSpace medskip
5764 \begin_layout Standard
5766 \begin_inset Flex URL
5769 \begin_layout Plain Layout
5771 ftp://ftp.edpsciences.org/pub/aa/readme.html
5779 \begin_layout Standard
5780 \begin_inset VSpace medskip
5786 \begin_layout Standard
5787 A manual comes together with that package, and this text is not meant to
5788 replace the original manual but merely a short guide how to realize the
5789 correct form of your paper.
5793 \begin_layout Standard
5794 Please note that the publisher of the journal was changed from Springer
5795 to EDP Sciences starting January 1, 2001.
5796 That change implicated also some slight changes of the style files, namely
5797 the removal of the thesaurus command.
5798 The LyX class aa supports the newest version of these style files, V 5.01.
5799 If you have an older version installed, please upgrade.
5800 For compatibility, the old (version 4) layout has been kept as
5805 Please refer to the comments in
5807 LyXDir/layouts/aapaper.layout
5812 \begin_layout Subsection
5816 \begin_layout Standard
5817 It is recommended you start from the example template distributed with LyX.
5818 If you are not using a template, note the following settings:
5821 \begin_layout Itemize
5828 Document\SpecialChar \menuseparator
5831 dialog (OK, that one was obvious).
5834 \begin_layout Itemize
5835 Don't change the option
5838 \begin_inset space ~
5848 The whole layout is done by the macros, you shouldn't change anything.
5851 \begin_layout Subsection
5855 \begin_layout Standard
5856 First thing to enter is the header information.
5857 It consists of seven entries, of which some are optional.
5861 \begin_layout Itemize
5869 \begin_layout Itemize
5877 \begin_layout Itemize
5885 \begin_layout Itemize
5893 \begin_layout Itemize
5898 : [optional] if more than one author: whom to contact for offprint requests.
5901 \begin_layout Itemize
5906 : [optional] mail address for contacts.
5909 \begin_layout Itemize
5917 Received: <date>; Accepted <date>
5920 \begin_layout Standard
5921 There is no need to issue the
5927 command, this is done automatically by LyX when the header is finished.
5928 Although the order of the single header entries doesn't matter it is advised
5929 to keep the above sequence, just to get the best optics and meets the layout
5930 of the real document.
5933 \begin_layout Standard
5934 If you want to place footnotes in the header block, e.
5935 \begin_inset space \thinspace{}
5939 \begin_inset space \space{}
5942 to state your present address, just use the standard footnote via the menu
5945 Insert\SpecialChar \menuseparator
5949 LyX will automagically use the term
5958 \begin_layout Standard
5959 In addition to these topics, the macros use three additional LaTeX commands
5960 that have no counterpart in LyX:
5963 \begin_layout Itemize
5970 to separate different names for more than one author and institute, respectivel
5974 \begin_layout Itemize
5981 to mark corresponding author/institute pairs.
5982 The institutes are numbered sequentially as they appear in the
5986 field, so you have to put a marker to each author.
5989 \begin_layout Itemize
5996 to supply an email address for fast contact.
5999 \begin_layout Standard
6000 In all cases, the appropriate command has to be entered in LyX and marked
6006 \begin_layout Subsection
6010 \begin_layout Standard
6011 The abstract should immediately follow the header block.
6012 With version 5 the abstract environment was changed to a command, and there
6013 is now a resctriction to only one paragraph.
6014 In addition, it should contain an entry with the keywords.
6015 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6022 by hand and mark it as LaTeX code.
6023 Refer to the example paper.
6026 \begin_layout Subsection
6027 Supported environments
6030 \begin_layout Standard
6031 The A&A paper layout supports the following environments for structuring
6035 \begin_layout Itemize
6041 \begin_layout Itemize
6047 \begin_layout Itemize
6053 \begin_layout Itemize
6059 \begin_layout Itemize
6065 \begin_layout Itemize
6071 \begin_layout Itemize
6077 \begin_layout Itemize
6083 \begin_layout Itemize
6089 \begin_layout Itemize
6095 \begin_layout Itemize
6101 \begin_layout Itemize
6107 \begin_layout Subsection
6108 Commands not supported by LyX
6111 \begin_layout Standard
6112 Some commands are not yet supported by the
6117 Some have already been mentioned.
6118 For the sake of completeness, they are listed all together here:
6121 \begin_layout Itemize
6129 \begin_layout Itemize
6137 \begin_layout Itemize
6145 \begin_layout Itemize
6153 \begin_layout Itemize
6161 \begin_layout Itemize
6169 \begin_layout Itemize
6177 \begin_layout Itemize
6185 \begin_layout Standard
6186 If you want to use any of these commands, you have to enter them yourself.
6189 Do not forget to mark them as LaTeX code!
6192 \begin_layout Subsection
6193 Figure and Table Floats
6196 \begin_layout Standard
6197 LyX provides support for the necessary float environments
6199 figure, figure*, table
6205 , therefore we won't tell much about it here.
6209 \begin_inset space ~
6215 Just remember that tables should be left-aligned.
6216 For that, select the table and change the alignment in
6218 Edit\SpecialChar \menuseparator
6220 \begin_inset space ~
6226 \begin_layout Standard
6227 There is only one special thing: the figures with caption besides the figure.
6228 To create such a figure, you have to do the following:
6231 \begin_layout Enumerate
6232 Create a wide figure float:
6234 Insert\SpecialChar \menuseparator
6235 Float\SpecialChar \menuseparator
6238 , then right click in the figure and select
6244 \begin_inset space ~
6252 \begin_layout Enumerate
6253 Enter your caption text.
6256 \begin_layout Enumerate
6261 to move the cursor above the caption.
6264 \begin_layout Enumerate
6268 \begin_layout Enumerate
6269 Position the cursor behind the figure and insert a horizontal fill:
6271 Insert\SpecialChar \menuseparator
6273 \begin_inset space ~
6276 Character\SpecialChar \menuseparator
6278 \begin_inset space ~
6286 \begin_layout Enumerate
6287 Switch to LaTeX mode:
6290 \begin_inset space ~
6298 \begin_layout Enumerate
6308 Do not close the brace!
6311 \begin_layout Enumerate
6312 Position the cursor behind the caption text, switch to LaTeX mode and insert
6316 \begin_inset space ~
6328 \begin_layout Standard
6329 Also, refer to the figures in the example paper.
6332 \begin_layout Subsection
6336 \begin_layout Standard
6337 For submission, the paper has to be formated in a special double-spacing
6339 For this purpose, you have to give the option
6343 to the documentclass.
6344 This must be done using the extra class options field in the
6346 Document\SpecialChar \menuseparator
6350 Just enter the string
6357 \begin_layout Subsection
6361 \begin_layout Standard
6366 directory contains an example paper written with LyX.
6367 It is the example paper from the original macro package, translated to
6369 Use it for inspiration, and compare the original LaTeX code with LyX way
6373 \begin_layout Section
6377 \begin_layout Standard
6383 \begin_layout Subsection
6387 \begin_layout Standard
6388 AASTeX is a set of macros produced by the American Astronomical Society
6389 to facilitate electronic manuscript submission to the three journals they
6390 publish: the Astrophysical Journal (including the Letters and Supplement),
6391 the Astronomical Journal, and the Publications of the Astronomical Society
6393 LyX has proven to be an excellent tool for generating these documents,
6394 especially given its equation, citation, and figure handling capabilities.
6395 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6396 is the version described here, or higher.
6397 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6398 incompatible with LyX.
6399 The AASTeX package may be downloaded from the AASTeX Web site
6402 \begin_layout Standard
6403 \begin_inset VSpace medskip
6409 \begin_layout Standard
6411 \begin_inset Flex URL
6414 \begin_layout Plain Layout
6416 http://www.journals.uchicago.edu/AAS/AASTeX
6424 \begin_layout Standard
6425 \begin_inset VSpace medskip
6431 \begin_layout Standard
6432 A complete user guide is contained in that package and you should familiarize
6433 yourself with it thoroughly before embarking on writing a paper in LyX.
6434 LyX will not reduce the need to figure out all the AASTeX commands, it
6435 will only reduce the drudgery of typing everything in.
6436 It is your responsibility to ensure that the final exported LaTeX document
6437 conforms completely to the requirements of the journal to which you are
6438 submitting your paper.
6441 \begin_layout Subsection
6442 Starting a New Paper
6445 \begin_layout Standard
6446 I strongly suggest that you start with the AASTeX template file.
6449 File\SpecialChar \menuseparator
6456 , enter the new file name, then choose the
6461 This will show the most common fields found in a manuscript.
6462 Simply overwrite the existing text (including the brackets,
6466 ) with the correct information.
6467 Many of the AASTeX commands and environments can be implemented directly
6468 in LyX, but some cannot: most noticeably
6480 , which should stick out like a sore thumb if you actually just opened the
6482 For commands such as these, the LaTeX code must be entered directly and
6484 Such commands are referred to as TeX code, or Evil Red Text.
6485 I tried to minimize the amount of TeX code needed in an AASTeX document,
6486 but there is still a bit more required than any of us would like.
6489 \begin_layout Subsection
6490 Finishing Your Paper
6493 \begin_layout Standard
6494 When the paper is finished to your satisfaction and previews/prints correctly,
6496 \begin_inset Quotes eld
6500 \begin_inset Quotes erd
6503 actions which need to be done before you submit it to the journals.
6507 \begin_layout Enumerate
6508 Export your paper as a LaTeX file (
6510 File\SpecialChar \menuseparator
6511 Export\SpecialChar \menuseparator
6518 \begin_layout Enumerate
6523 file with your favorite text editor
6527 \begin_layout Enumerate
6528 remove the comment lines before the
6537 \begin_layout Enumerate
6542 usepackage...{fontenc}
6544 line if it appears (usually just after
6559 \begin_layout Enumerate
6560 remove everything between (and including) the
6572 commands, except for any commands you specifically put into the LaTeX preamble
6573 (which should appear immediately after the
6574 \begin_inset Quotes eld
6577 User specified LaTeX commands
6578 \begin_inset Quotes erd
6589 \begin_layout Enumerate
6590 Run the resulting file through LaTeX to make sure it still processes correctly.
6593 \begin_layout Enumerate
6594 Reread the journal requirements to make sure your filenames and formats
6598 \begin_layout Enumerate
6602 \begin_layout Subsection
6603 Comments On Specific Commands
6606 \begin_layout Standard
6607 I will not describe the detailed usage of the individual AASTeX commands:
6608 the AASTeX User Guide (
6612 ) gives a good description of each.
6613 Thus it's probably easiest for me to go down the list as found in the guide
6614 and offer comments where necessary.
6615 So let's begin \SpecialChar \ldots{}
6619 \begin_layout Subsubsection
6620 Things that work as expected
6623 \begin_layout Standard
6627 \begin_layout Plain Layout
6639 \begin_layout Standard
6640 Because they work as you might expect, I simply list them and the section
6741 begin{thebibliography}
6749 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6750 graphicx figure commands (2.14.1),
6774 (2.15.4, amongst other places),
6801 \begin_layout Standard
6802 The following style options also work correctly:
6823 Simply put them in the
6829 Layout\SpecialChar \menuseparator
6835 \begin_layout Standard
6839 \begin_layout Plain Layout
6851 \begin_layout Subsubsection
6852 Things that work, but require more comment
6855 \begin_layout Standard
6856 The following items work, but require a little more discussion:
6859 \begin_layout Itemize
6860 These items are reserved for use by the journal editors, but you can put
6861 them into the LaTeX preamble if you feel compelled to do so:
6894 \begin_layout Itemize
6895 These items may be placed in the LaTeX preamble, and are included as blanks
6896 in the template file:
6917 \begin_layout Itemize
6924 (2.3) – can only be used
6925 \begin_inset Quotes eld
6929 \begin_inset Quotes erd
6932 , not in the middle of a paragraph.
6933 Use TeX code if you need to embed it.
6936 \begin_layout Itemize
6943 (2.3) – will have extra {} after it.
6944 This should not cause an error.
6947 \begin_layout Itemize
6954 (2.6) – can only be used
6955 \begin_inset Quotes eld
6959 \begin_inset Quotes erd
6962 , not in the middle of a paragraph.
6963 Use TeX code if you need to embed it.
6966 \begin_layout Itemize
6973 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6977 \begin_layout Itemize
6984 (2.8) – same as for
6991 \begin_layout Itemize
6998 (2.9) – will have extra {} after it.
6999 This should not cause an error.
7002 \begin_layout Itemize
7009 (2.11) – will have extra {} after it.
7010 This should not cause an error.
7013 \begin_layout Itemize
7020 (2.14.2) – you can insert an optional filename argument by placing the cursor
7021 at the beginning of the text and selecting
7023 Insert\SpecialChar \menuseparator
7028 \begin_inset Quotes eld
7032 \begin_inset Quotes erd
7035 inserts an optional argument of the type needed by
7042 Hopefully it will be renamed someday.
7045 \begin_layout Itemize
7052 (2.17.1) – same as
7058 for the catalog ID optional parameter
7061 \begin_layout Itemize
7068 (2.17.1) – same as
7074 for the catalog ID optional parameter
7077 \begin_layout Subsubsection
7078 Things not implemented, use TeX code
7081 \begin_layout Standard
7085 \begin_layout Plain Layout
7097 \begin_layout Standard
7120 setcounter{equation}
7122 (2.12), Journal name abbreviations (2.13.4),
7158 (2.15.4, insert it as the first element in the lefthand cell after where
7160 Don't use any of LyX's rules in the table),
7172 (2.15.5), much of Misc (2.17, except
7223 \begin_layout Standard
7227 \begin_layout Plain Layout
7239 \begin_layout Subsubsection
7240 Things that cannot be implemented
7243 \begin_layout Standard
7244 \SpecialChar \ldots{}
7245 at least in any meaningful sort of way, so I suggest ignoring them.
7246 They are the references environment (2.13.3), and the deluxetable environment
7248 If you really, really need to use deluxetable, I suggest editing it in
7249 a separate file with a text editor, then using
7251 Insert\SpecialChar \menuseparator
7253 \begin_inset space ~
7258 to include it in your LyX document.
7263 file to see an example of this.
7266 \begin_layout Subsection
7267 FAQs, Tips, Tricks, and Other Ruminations
7270 \begin_layout Subsubsection
7271 Getting LyX and AASTeX to cooperate
7274 \begin_layout Standard
7275 It can be a bit tricky to get LyX to recognize a new layout and document
7277 When all else fails, do this:
7280 \begin_layout Enumerate
7281 Make certain that LaTeX can find AASTeX.
7282 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7283 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7290 \begin_layout Enumerate
7302 \begin_layout Enumerate
7305 Tools\SpecialChar \menuseparator
7308 in LyX, then restart LyX.
7311 \begin_layout Enumerate
7312 Open a regular new file, not from a template.
7313 Does AASTeX appear in the class list in
7315 Document\SpecialChar \menuseparator
7321 \begin_layout Standard
7322 If you get a warning from an existing AASTeX document about not being able
7323 to find the AASTeX layout or a message about
7324 \begin_inset Quotes eld
7327 You should not mix title layouts with normal ones
7328 \begin_inset Quotes erd
7331 , things haven't been installed correctly.
7334 \begin_layout Subsubsection
7335 LaTeX error processing a table
7338 \begin_layout Standard
7339 LyX, by default, attempts to center the table caption/title.
7340 This seems to produce a bad interaction in AASTeX so you should click somewhere
7341 in the caption/title, then select
7343 Edit\SpecialChar \menuseparator
7345 \begin_inset space ~
7359 This took care of it for me.
7362 \begin_layout Subsubsection
7366 \begin_layout Standard
7367 A couple of things: 1) I have noticed some funny spacing in the reference
7368 entries in the text.
7369 When you enter the bibliography item data, make sure their is
7373 space between the last author and the parenthesis setting off the year;
7377 \begin_inset space \thinspace{}
7381 \begin_inset space \space{}
7395 2) Entering the references at all is not obvious.
7396 The easiest thing is to start typing your first reference at the end of
7397 the document, then mark it as type
7402 That will put a small gray box in front of what you just typed.
7403 Click on the box to fill in the rest of the information.
7404 For new references, go to the end of an existing reference and press return.
7405 That will create a new line with its own box, etc.
7408 \begin_layout Subsubsection
7412 \begin_layout Standard
7413 Even though AASTeX provides its own figure commands (
7419 , for example), I much prefer LaTeX's standard figure commands (with the
7428 \begin_inset space ~
7431 commands as TeX code into a Figure Float box if you desire, but I never
7432 have much luck getting the layout right.
7433 With the standard graphics, LyX will insert a
7437 usepackage{graphicx}
7439 command into the LaTeX preamble and handle the figures in the standard
7440 LaTeX2e way, interspersing the figures in the text.
7441 I believe ApJ accepts figures exactly this way now; AJ might still use
7443 \begin_inset Quotes eld
7446 stack everything at the end
7447 \begin_inset Quotes erd
7453 \begin_layout Subsubsection
7454 Things I could have done, but didn't
7457 \begin_layout Standard
7459 \begin_inset Quotes eld
7463 \begin_inset Quotes erd
7466 things I could have implemented, but chose not to.
7467 For instance, I saw no point in double-spacing the text in the LyX window,
7468 even though it is double-spaced in the paper manuscript.
7469 Also, I chose not to make separate layouts for the preprint and preprint2
7471 Since I assume you will spend most of your time in the plain manuscript
7472 mode anyway, I decided not to chew up more disk space with this.
7476 \begin_layout Subsection
7480 \begin_layout Standard
7481 Your mileage may vary.
7482 I've now had papers published by both ApJ and AJ that have had 98% of the
7483 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7485 I have had no trouble with the submission process, and I'm sure the journals
7486 were never aware that there might be a difference.
7487 So, go forth and publish!
7490 \begin_layout Section
7494 \begin_layout Standard
7497 David Johnson; updated by Richard Heck
7500 \begin_layout Standard
7501 \begin_inset VSpace bigskip
7507 \begin_layout Standard
7509 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7510 papers to be submitted to American Mathematical Society publications.
7511 The layouts are not tailored to a specific journal, but easily can be.
7512 You should refer to the AMS documentation for specific instructions for
7513 each journal (usually it will entail only changing a single line in the
7515 That documentation is available on the Web at
7516 \begin_inset Flex URL
7519 \begin_layout Plain Layout
7527 \begin_inset Flex URL
7530 \begin_layout Plain Layout
7532 ftp://ftp.ams.org/pub/tex/amslatex/
7538 These layouts are appropriate, and useful, for any mathematical writing.
7542 \begin_layout Standard
7543 There are two basic AMS LaTeX layouts:
7546 \begin_layout Itemize
7547 amsart: The standard AMS article format.
7550 \begin_layout Itemize
7551 amsbook: the standard AMS book (really, monograph) format.
7555 \begin_layout Standard
7556 The layouts themselves contain only the minimum necessary to use the AMS
7558 They do not, in particular, contain any of the `theorem' environments used
7559 for setting theorems, lemmas, and the like.
7560 These are contained, instead, in the
7561 \begin_inset Flex CharStyle:Code
7564 \begin_layout Plain Layout
7570 module, which is loaded by default when when you select one of the AMS
7572 (It can also be used with other classes and can be removed, if you would
7573 rather use something else.) Less commonly used environments are in the
7574 \begin_inset Flex CharStyle:Code
7577 \begin_layout Plain Layout
7578 Theorems (AMS-Extended)
7583 module, which must be loaded manually.
7586 \begin_layout Standard
7587 By default, theorems and the like are numbered consecutively throughout
7588 the document, but this may be modified by loading the module
7589 \begin_inset Flex CharStyle:Code
7592 \begin_layout Plain Layout
7593 Theorems (Order by Section)
7598 or, if you are using
7599 \begin_inset Flex CharStyle:Code
7602 \begin_layout Plain Layout
7609 \begin_inset Flex CharStyle:Code
7612 \begin_layout Plain Layout
7613 Theorems (Order by Chapter)
7619 These will number the results as
7620 \begin_inset Formula $n.m$
7623 , where the first number refers to the section (or chapter) and the second
7624 refers to the total number of results so far in that section (or chapter).
7625 Many environments are also available unnumbered.
7626 These are indicated by an asterisk at the end.
7627 If you happen to want
7631 unnumbered results, the the module
7632 \begin_inset Flex CharStyle:Code
7635 \begin_layout Plain Layout
7641 provides that option.
7644 \begin_layout Standard
7645 Note that these modules do not
7649 to be used with the AMS classes.
7650 It is perfectly possible to use the
7651 \begin_inset Flex CharStyle:Code
7654 \begin_layout Plain Layout
7660 module, and the others mentioned, with other classes, such as
7661 \begin_inset Flex CharStyle:Code
7664 \begin_layout Plain Layout
7671 \begin_inset Flex CharStyle:Code
7674 \begin_layout Plain Layout
7681 \begin_inset Flex CharStyle:Code
7684 \begin_layout Plain Layout
7693 \begin_layout Subsection
7694 What these layouts provide
7697 \begin_layout Standard
7698 There is a long list of included environments provided by these layouts.
7699 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7700 variety of `theorem' environments.
7701 However, the AMS recommends the environments that are available in LyX.
7705 \begin_layout Standard
7706 The following environments—as well as the standard environments, such as
7708 \begin_inset Flex CharStyle:Noun
7711 \begin_layout Plain Layout
7718 \begin_inset Flex CharStyle:Noun
7721 \begin_layout Plain Layout
7728 \begin_inset Flex CharStyle:Noun
7731 \begin_layout Plain Layout
7738 \begin_inset Flex CharStyle:Noun
7741 \begin_layout Plain Layout
7748 \begin_inset Flex CharStyle:Noun
7751 \begin_layout Plain Layout
7758 \begin_inset Flex CharStyle:Code
7761 \begin_layout Plain Layout
7768 \begin_inset Flex CharStyle:Code
7771 \begin_layout Plain Layout
7780 \begin_layout Description
7781 Address This should be the author's permanent address.
7784 \begin_layout Description
7786 \begin_inset space ~
7789 Address This should be the author's temporary address at the time of submission,
7790 if different from the Address.
7793 \begin_layout Description
7794 Email Author's e-mail address
7797 \begin_layout Description
7798 URL Author's Web address, if desired.
7801 \begin_layout Description
7802 Keywords Key words or phrases used to identify specific topics discussed
7806 \begin_layout Description
7807 Subjectclass These refer to the AMS Subject Classifications, published and
7810 Mathematical Reviews
7813 These are also available online at the AMS cites listed above.
7816 \begin_layout Description
7820 \begin_layout Description
7824 \begin_layout Description
7828 \begin_layout Standard
7829 The following environments are provided by both the
7830 \begin_inset Flex CharStyle:Code
7833 \begin_layout Plain Layout
7840 \begin_inset Flex CharStyle:Code
7843 \begin_layout Plain Layout
7849 modules, in the latter case in both starred (unnumbered) and unstarred
7850 (numbered) versions.
7851 These same environments are provided only in the starred versions by the
7853 \begin_inset Flex CharStyle:Code
7856 \begin_layout Plain Layout
7865 \begin_layout Theorem
7866 This is typically used for the statements of major results.
7870 \begin_layout Corollary*
7871 This is used for statements which follow fairly directly from previous statement
7873 Again, these can be major results.
7878 These are smaller results needed to prove other statements.
7881 \begin_layout Proposition
7882 These are less major results which (hopefully) add to the general theory
7886 \begin_layout Conjecture
7887 These are statements provided without justification, which the author does
7888 not know how to prove, but which seem to be true (to the author, at least).
7891 \begin_layout Definition*
7892 Guess what this is for.
7893 The font is different for this environment than for the previous ones.
7897 \begin_layout Example*
7898 Used for examples illustrating proven results.
7901 \begin_layout Problem
7902 It's not really known what this is for.
7903 You should figure it out.
7906 \begin_layout Exercise*
7907 Write a description for this one.
7910 \begin_layout Remark
7911 This environment is also a type of theorem, usually a lesser sort of observation.
7914 \begin_layout Claim*
7915 Often used in the course of giving a proof of a larger result.
7919 Generally, these are used to break up long arguments, using specific instances
7925 The numbering scheme for cases is on its own, not together with other numbered
7931 At the end of this environment, a QED symbol (usually a square, but it can
7932 vary with different styles) is placed.
7933 If you want to have other environments within this one—for example, Case
7934 environments—and have the QED symbol appear only after them, then the other
7935 environments need to be nested within the proof environment.
7938 Nesting Environments
7944 for information on nesting.
7947 \begin_layout Standard
7948 And these environments are provided by
7949 \begin_inset Flex CharStyle:Code
7952 \begin_layout Plain Layout
7953 Theorems (AMS-Extended)
7961 \begin_layout Criterion*
7962 A required condition.
7965 \begin_layout Algorithm*
7966 A general procedure to be used.
7969 \begin_layout Axiom*
7970 This is a property or statement taken as true within the system being discussed.
7973 \begin_layout Condition*
7974 Sometimes used to state a condition assumed within the present context of
7979 Similar to a Remark.
7982 \begin_layout Notation*
7983 Used for the explanation of, yes, notation.
7986 \begin_layout Summary
7987 Do we really need to tell you?
7990 \begin_layout Acknowledgement*
7994 \begin_layout Conclusion*
7995 Sometimes used at the end of a long train of argument.
7999 Used in a way similar to Proposition, though perhaps lower on the scale.
8002 \begin_layout Standard
8003 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8005 They need to be available on your system in order to use these environments.
8008 \begin_layout Section
8016 \begin_layout Standard
8022 \begin_layout Subsection
8026 \begin_layout Standard
8027 These are the layout files for some of the journals of the American Geophysical
8029 It is assumed that you have both the AGU's own class files and AGUplus
8030 installed (everything to be found at
8031 \begin_inset Flex URL
8034 \begin_layout Plain Layout
8036 ftp://ftp.agu.org/journals/latex/journals
8044 \begin_layout Subsection
8048 \begin_layout Standard
8058 They are still called this in the LyX GUI, though their LaTeX equivalents
8059 in the AGU classes are
8070 \begin_layout Standard
8071 Newly defined styles are
8108 These are mostly manuscript attributes and defined in the AGU class documentati
8112 \begin_layout Standard
8113 I suspect this is still badly incomplete.
8116 \begin_layout Subsection
8120 \begin_layout Standard
8137 \begin_layout Subsection
8141 \begin_layout Itemize
8144 Journal of Geophysical Research
8153 \begin_layout Standard
8154 Add your own, it isn't so hard! Look at the
8165 \begin_layout Subsection
8166 Bugs and things to remember
8169 \begin_layout Standard
8170 In order to use the new layouts, you must remember to do the following for
8174 \begin_layout Enumerate
8180 This can be done in the
8182 Layout\SpecialChar \menuseparator
8187 Document\SpecialChar \menuseparator
8191 (AGU articles are always in English, right? So
8198 \begin_layout Enumerate
8208 (Yes, this is a bug.)
8211 \begin_layout Enumerate
8212 Make sure you use the
8216 bibliography style, by entering
8220 into the second field of the BibTeX inset.
8221 None of the standard styles will do.
8224 \begin_layout Section
8228 \begin_layout Standard
8234 \begin_layout Subsection
8238 \begin_layout Standard
8239 Broadway is for writing plays.
8240 The format is more decorative than Hollywood, and much less standardized.
8241 This format should be suitable for workshops.
8244 \begin_layout Subsection
8248 \begin_layout Standard
8249 The same as in Hollywood.
8252 \begin_layout Subsection
8256 \begin_layout Standard
8261 names as labels then cross-reference the label to insert the name.
8262 The cross-reference dialog will show the current cast of characters.
8265 \begin_layout Subsection
8266 Paper size and Margins
8269 \begin_layout Standard
8270 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8273 \begin_layout Subsection
8277 \begin_layout Standard
8278 The following environments are available.
8279 You can use broadway.bind to get the bind keys shown at the right.
8282 \begin_layout Itemize
8286 \begin_inset Newline newline
8291 You should not have to use this, but it is here for anything that does not
8295 \begin_layout Itemize
8299 \begin_inset space \hfill{}
8303 \begin_inset Newline newline
8308 Used to describe stage setting and the action.
8309 First use of speaker names in all CAPs.
8312 \begin_layout Itemize
8316 \begin_inset space \hfill{}
8320 \begin_inset Newline newline
8325 Automatically numbered.
8326 On screen it will be arabic, but will print as Roman.
8329 \begin_layout Itemize
8333 \begin_inset space \hfill{}
8337 \begin_inset Newline newline
8347 It is just centered text.
8350 \begin_layout Itemize
8354 \begin_inset space \hfill{}
8358 \begin_inset Newline newline
8363 Not automatically numbered.
8364 You supply the number.
8365 This is because I couldn't figure out how.
8368 \begin_layout Itemize
8372 \begin_inset space \hfill{}
8376 \begin_inset Newline newline
8381 A special case of Narrative to describe the setting and action as the curtain
8385 \begin_layout Itemize
8389 \begin_inset space \hfill{}
8393 \begin_inset Newline newline
8398 The speaker's (actor's) title, centered in all CAPS.
8401 \begin_layout Itemize
8405 \begin_inset space \hfill{}
8409 \begin_inset Newline newline
8414 Instructions to the speaker.
8415 The parentheses are automatically inserted.
8416 The ( will appear on screen, but both will be in the printed play.
8417 This environment is only used within
8424 \begin_layout Itemize
8428 \begin_inset space \hfill{}
8432 \begin_inset Newline newline
8437 What the Speaker says.
8440 \begin_layout Itemize
8444 \begin_inset space \hfill{}
8448 \begin_inset Newline newline
8453 The curtain comes down.
8456 \begin_layout Itemize
8460 \begin_inset space \hfill{}
8466 \begin_layout Itemize
8470 \begin_inset space \hfill{}
8476 \begin_layout Itemize
8480 \begin_inset space \hfill{}
8486 \begin_layout Standard
8490 \begin_layout Section
8494 \begin_layout Standard
8499 can be used to type letters according to German conventions.
8500 A template file is included in
8502 .../lyx/share/templates
8504 for you to use as a starting point.
8507 \begin_layout Section
8515 \begin_layout Standard
8521 \begin_layout Subsection
8525 \begin_layout Standard
8526 This is the layout file for the European Geophysical Society journals.
8531 can be downloaded from the web site of the EGS under
8532 \begin_inset Flex URL
8535 \begin_layout Plain Layout
8545 \begin_layout Subsection
8549 \begin_layout Standard
8552 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8560 The current layout file is unfortunately very unmodular and would benefit
8561 from using the various
8568 \begin_layout Section
8572 \begin_layout Standard
8578 \begin_layout Standard
8579 Elsevier Science Publishers B.V.
8580 provides a standard LaTeX document class (
8584 ) for submitting articles to their various journals.
8585 The style file can be downloaded directly from their web site:
8586 \begin_inset Flex URL
8589 \begin_layout Plain Layout
8591 http://authors.elsevier.com/
8597 Instructions are supplied along with the class file, which details the
8598 requirements of the publishers.
8599 LyX includes package that allows for the use of this class, by a layout
8600 and a template file.
8601 Installation of the class file is the same as for any other LaTeX package;
8602 instructions are provided in the Elsevier documentation.
8605 \begin_layout Standard
8615 As the Elsevier class file is based mainly on the standard article class,
8616 most of the normal functionality is provided.
8617 The Elsevier class defines a number of mathematical environments, which
8618 are similar to the AMS environments.
8619 These commands are all described in the Elsevier documentation, and are
8623 \begin_layout Standard
8624 The easiest way to use the Elsevier style is to base documents on the included
8626 It is best not to use options such as fancy headings or the geometry package,
8627 as elements such as these are defined by Elsevier in their style file.
8628 Ideally, no extra packages except those mentioned in the Elsevier documentation
8630 Essentially, Elsevier require as
8631 \begin_inset Quotes eld
8635 \begin_inset Quotes erd
8638 a LaTeX file as possible, as their intention is to take the supplied file
8639 and replace the class file with one for the particular journal to which
8640 the paper has been submitted.
8641 This also means that not too much time should be spent on the formating
8643 When it comes to be published, this will change anyway.
8644 The rest of the usage for this layout is substantially the same as for
8645 the normal article class.
8646 For details of what Elsevier do and don't allow, refer to their documentation.
8649 \begin_layout Section
8655 \begin_inset CommandInset label
8664 \begin_layout Standard
8670 \begin_layout Subsection
8674 \begin_layout Standard
8675 This section describes how to use LyX to make slides for overhead projectors.
8676 There are two document classes that can do this: the default slides class
8682 This section documents the latter.
8685 \begin_layout Standard
8686 I'm going to say this again, nice and clear, so that there's no misunderstanding
8690 \begin_layout Standard
8691 \begin_inset VSpace bigskip
8697 \begin_layout Standard
8701 This section documents the class
8702 \begin_inset Quotes eld
8710 \begin_inset Quotes erd
8718 \begin_layout Standard
8719 \begin_inset VSpace bigskip
8725 \begin_layout Standard
8726 If you're looking for the documentation for
8727 \begin_inset Quotes eld
8735 \begin_inset Quotes erd
8739 \begin_inset space ~
8743 \begin_inset CommandInset ref
8745 reference "sec:slitex"
8750 If your machine doesn't have the
8755 \begin_inset Quotes eld
8763 \begin_inset Quotes erd
8766 ] installed, you'll probably have to use the default
8770 class, which isn't quite as good as
8775 \begin_layout Standard
8780 class is designed for use with version 2.1 of the
8784 LaTeX class file which is now an integral part of LaTeX2e.
8787 \begin_layout Subsection
8791 \begin_layout Standard
8792 Obviously, to use this document class, you need to select
8793 \begin_inset Quotes eld
8801 \begin_inset Quotes erd
8811 \begin_inset space ~
8817 There are some settings in the
8820 \begin_inset space ~
8825 dialog that you should know about that are specific to this class:
8828 \begin_layout Itemize
8829 Don't change the options
8840 \begin_inset space ~
8846 They're ignored by the
8853 \begin_layout Itemize
8854 The default font size is 20
8855 \begin_inset space \thinspace{}
8858 pt with the other options being 17
8859 \begin_inset space \thinspace{}
8863 \begin_inset space \thinspace{}
8867 \begin_inset space \thinspace{}
8873 \begin_layout Itemize
8882 but all math equations are still typeset in the usual roman font.
8885 \begin_layout Itemize
8890 supports A4 and Letter paper sizes as well as a special size for working
8892 \begin_inset space \thinspace{}
8896 It doesn't support A5, B5, legal or executive paper sizes.
8899 \begin_layout Itemize
8900 Don't bother changing the
8904 settings because they are ignored anyway.
8905 All floats appear where they are defined in the text.
8908 \begin_layout Itemize
8913 setting behaves a bit differently for this class.
8918 provides extensive footer and header capabilities including a user-defined
8921 \begin_inset space ~
8925 \begin_inset CommandInset ref
8927 reference "sec:foilfoot"
8932 The title page is treated differently to all other pages in the document
8941 has the logo centered at the bottom of the page (if one is defined).
8942 The possible page style choices and what they do are as follows:
8946 \begin_layout Labeling
8947 \labelwidthstring MMMMMMM
8954 The final output contains no page numbers, or other headers or footers
8955 (except footnotes of course).
8959 \begin_layout Labeling
8960 \labelwidthstring MMMMMMM
8967 The final output contains page numbers centered at the bottom of the page.
8968 No other headings or footers (other than footnotes).
8971 \begin_layout Labeling
8972 \labelwidthstring MMMMMMM
8977 Page numbers in lower right corner.
8978 Additional headers and footers are also shown.
8979 This is also the default.
8982 \begin_layout Labeling
8983 \labelwidthstring MMMMMMM
8988 Gives you access to the
8992 package although its use with
8996 is discouraged by the writer of the
9000 package because of some potential page layout clashes.
9004 \begin_layout Subsubsection
9008 \begin_layout Standard
9009 The following options may be used in the extra class options in the
9011 Document\SpecialChar \menuseparator
9017 \begin_layout Labeling
9018 \labelwidthstring MMMMMMx
9023 This sets up the page layout for 7.33
9024 \begin_inset space \thinspace{}
9028 \begin_inset space \thinspace{}
9031 in paper, which is about the same aspect ratio as a 35
9032 \begin_inset space \thinspace{}
9035 mm slide, making it a bit easier to work with this medium.
9038 \begin_layout Labeling
9039 \labelwidthstring MMMMMMx
9044 Places a rule across the page below the header on every page except the
9048 \begin_layout Labeling
9049 \labelwidthstring MMMMMMx
9054 Places a rule across the page above the footer on every page except the
9058 \begin_layout Labeling
9059 \labelwidthstring MMMMMMx
9064 This is automatically set each time you create a new
9073 to use the dvips driver to rotate those pages that are set as landscape
9077 \begin_layout Labeling
9078 \labelwidthstring MMMMMMx
9083 Simply changes the page dimensions to those of a landscape page but doesn't
9085 Thus if you use this option you need to use an external program to rotate
9086 each page or feed your paper through your printer as landscape.
9087 Note that this option effectively reverses the roles of the
9095 environments (don't worry these are described in the next section).
9098 \begin_layout Labeling
9099 \labelwidthstring MMMMMMx
9104 Equation numbers on the left.
9107 \begin_layout Labeling
9108 \labelwidthstring MMMMMMx
9113 Flush-left equations.
9116 \begin_layout Subsection
9117 Supported Environments
9120 \begin_layout Standard
9121 Most of the environments commonly supported in other classes are also supported
9127 There are several additional environments provided by
9131 as well as a couple added by LyX.
9132 The following environments are shared with other classes:
9135 \begin_layout Standard
9139 \begin_layout Plain Layout
9151 \begin_layout Itemize
9157 \begin_layout Itemize
9163 \begin_layout Itemize
9169 \begin_layout Itemize
9175 \begin_layout Itemize
9181 \begin_layout Itemize
9187 \begin_layout Itemize
9193 \begin_layout Itemize
9199 \begin_layout Itemize
9205 \begin_layout Itemize
9211 \begin_layout Itemize
9217 \begin_layout Itemize
9223 \begin_layout Itemize
9229 \begin_layout Itemize
9235 \begin_layout Itemize
9241 \begin_layout Itemize
9247 \begin_layout Itemize
9253 \begin_layout Itemize
9259 \begin_layout Standard
9263 \begin_layout Plain Layout
9275 \begin_layout Standard
9276 That is, all the major environments apart from the sectioning environments.
9277 Since foils are essentially self-contained sections, with a title and body,
9282 provides specific commands for starting new foils and these are:
9285 \begin_layout Itemize
9291 \begin_layout Itemize
9297 \begin_layout Standard
9298 LyX also provides slightly modified versions of these two environments called:
9301 \begin_layout Itemize
9307 \begin_layout Itemize
9313 \begin_layout Standard
9314 and the differences will be explained in the next section.
9317 \begin_layout Standard
9318 Since foils are often used in presenting ideas or new theorems and such
9323 also provides a comprehensive box of goodies for presenting them:
9326 \begin_layout Standard
9330 \begin_layout Plain Layout
9342 \begin_layout Itemize
9348 \begin_layout Itemize
9354 \begin_layout Itemize
9360 \begin_layout Itemize
9366 \begin_layout Itemize
9372 \begin_layout Itemize
9378 \begin_layout Itemize
9384 \begin_layout Itemize
9390 \begin_layout Itemize
9396 \begin_layout Itemize
9402 \begin_layout Itemize
9408 \begin_layout Standard
9412 \begin_layout Plain Layout
9424 \begin_layout Standard
9425 The starred versions are unnumbered while the unstarred versions are numbered.
9426 There are also two list environments added by LyX and these are:
9429 \begin_layout Itemize
9435 \begin_layout Itemize
9441 \begin_layout Standard
9446 provides some powerful header and footer capabilities that are best set
9447 in the preamble although they may be set at any point in a document.
9448 If you want to change these settings in your document the best place to
9449 do so is at the very top of a foil, i.
9450 \begin_inset space \thinspace{}
9456 \begin_inset space \space{}
9461 straight after the foilhead.
9464 \begin_layout Standard
9465 For this purpose, the following command styles are provided [
9472 \begin_layout Standard
9476 \begin_layout Plain Layout
9488 \begin_layout Itemize
9492 \begin_inset space ~
9498 \begin_layout Itemize
9504 \begin_layout Itemize
9508 \begin_inset space ~
9514 \begin_layout Itemize
9518 \begin_inset space ~
9524 \begin_layout Itemize
9528 \begin_inset space ~
9535 \begin_layout Standard
9536 \begin_inset space ~
9543 \begin_layout Standard
9547 \begin_layout Plain Layout
9559 \begin_layout Standard
9560 There are also a few commands provided by
9564 that aren't directly supported by LyX but I'll tell you what they do and
9565 how to use them in section
9566 \begin_inset space ~
9570 \begin_inset CommandInset ref
9572 reference "sec:unsuppfoils"
9579 \begin_layout Subsection
9580 Building a Set of Foils
9583 \begin_layout Standard
9584 This section will give a simple introduction to using the different environments
9585 to build a set of foils.
9586 If you want to see an example set of foils, take a look at the
9590 file you find in LyX's
9597 \begin_layout Subsubsection
9598 Give It a Title Page
9601 \begin_layout Standard
9602 Unlike other classes that provide
9622 creates the title on a page of its own.
9623 If you leave out the
9627 environment LaTeX will substitute the current date (every time you regenerate
9631 \begin_layout Subsubsection
9635 \begin_layout Standard
9636 As I mentioned earlier, there are four ways of starting a new foil.
9637 For portrait foils you should use
9646 The difference between these two environments is the amount of space between
9647 the title of the foil (the foilhead) and the body of the foil.
9650 \begin_layout Standard
9651 Landscape foils are generated using the
9660 Again the only difference is the spacing between foilhead and body.
9661 Both of the short versions have 0.5 inches less separation between the foilhead
9666 \begin_layout Standard
9667 One problem with the support for landscape foils is the requirement that
9672 driver to generate the PostScript output otherwise the foils won't be rotated.
9673 It is possible to get landscape foils even if you haven't got the
9677 driver provided you can feed your foils sideways through your printer ;-)
9680 \begin_layout Subsubsection
9681 Theorems, Lemmas, Proofs and more
9684 \begin_layout Standard
9685 Due to a small bug in LyX you can't have two of the same type of these environme
9686 nts directly following each other.
9687 They must be separated by something.
9688 If you try, you will just be extending the previous environment as if you
9689 had merged the two environments together.
9690 So, how do you get around this problem? The simplest option is to insert
9691 some text between the two environments or add a
9695 environment between the two with just a
9696 \begin_inset Quotes eld
9704 \begin_inset Quotes erd
9708 This will force LyX to produce two separate environments and hence the
9709 correct LaTeX output.
9710 An example is provided in the example file included with the LyX distribution.
9711 Remember, this problem only occurs if you are trying to place two of the
9712 same type of theorem-like environments one directly after the other.
9715 \begin_layout Subsubsection
9719 \begin_layout Standard
9720 You get all the commonly supported list styles found in other classes as
9721 well as two new ones.
9722 I'll only describe the new ones here.
9723 If you want to find out more about the other list environments check out
9729 If you intend to use itemized lists you might also want to read about the
9733 \begin_inset space ~
9737 \begin_inset space ~
9742 dialog described above in section
9743 \begin_inset space ~
9747 \begin_inset CommandInset ref
9749 reference "sec:bullet"
9756 \begin_layout Standard
9757 The two new list styles,
9765 , are designed to make it easier for you to create lists of do's and don'ts
9766 or right and wrong by providing dedicated environments that use a tick
9767 or a cross as the label of the list.
9768 These lists are in fact dedicated variants of the
9773 They do however require that you have the
9780 \begin_layout Subsubsection
9784 \begin_layout Standard
9789 redefines the floating tables and figures so that they appear exactly where
9790 they are in the text rather than pushing them to the top of the page or
9791 to some user specified location.
9792 In fact if you change the float placement settings they are simply ignored.
9795 \begin_layout Subsubsection
9796 Page Headers and Footers
9797 \begin_inset CommandInset label
9806 \begin_layout Standard
9810 \begin_inset space ~
9819 are two commands used to control the left-footer text string.
9820 The first is meant to allow you to include a graphic logo on your foils
9822 \begin_inset Quotes eld
9830 \begin_inset Quotes erd
9834 While the second is meant to provide a classification for the audience,
9838 \begin_inset space \thinspace{}
9844 \begin_inset space \space{}
9848 It is empty by default.
9851 \begin_layout Standard
9852 The remaining page corners can be filled by
9855 \begin_inset space ~
9860 (which defaults to page numbers),
9863 \begin_inset space ~
9871 \begin_inset space ~
9879 \begin_layout Subsection
9885 \begin_inset CommandInset label
9887 name "sec:unsuppfoils"
9894 \begin_layout Standard
9895 All the commands mentioned below need to be set in a
9903 within another environment.
9906 \begin_layout Subsubsection
9910 \begin_layout Standard
9911 All lengths are adjusted using the
9934 should be replaced by the name given to the length you want to change and
9939 is the length value.
9940 All lengths should be specified in units of length such as inches (
9952 ) or relative to some document or font-based length such as
9962 \begin_layout Standard
9963 It's possible to change the spacing between a foilhead and the body of the
9964 foil by adjusting the length specified by
9971 For example, to make
9976 \begin_inset space \space{}
9979 in closer to their bodies put the following in the preamble:
9985 foilheadskip}{-0.5in}
9988 \begin_layout Standard
9989 The spacings around floats can be adjusted by setting these lengths:
9992 \begin_layout Labeling
9993 \labelwidthstring MMMMMMMMMMM
10000 Separation between the text and the top of the float
10003 \begin_layout Labeling
10004 \labelwidthstring MMMMMMMMMMM
10011 Separation between the float and the caption
10014 \begin_layout Labeling
10015 \labelwidthstring MMMMMMMMMMM
10022 Separation between the caption and the following text
10025 \begin_layout Labeling
10026 \labelwidthstring MMMMMMMMMMM
10033 You can make the captions narrower than the surrounding text by adjusting
10035 Best done relative to
10044 \begin_layout Standard
10045 There are also several title page related lengths that you may find useful
10046 if you have a long title or several authors:
10049 \begin_layout Labeling
10050 \labelwidthstring MMMMMMMMMMM
10057 Separation from headers to
10062 \begin_layout Labeling
10063 \labelwidthstring MMMMMMMMMMM
10081 \begin_layout Labeling
10082 \labelwidthstring MMMMMMMMMMM
10096 \begin_layout Labeling
10097 \labelwidthstring MMMMMMMMMMM
10113 \begin_layout Labeling
10114 \labelwidthstring MMMMMMMMMMM
10130 \begin_layout Standard
10131 The last length related command affects all the list environments.
10142 a list environment then all the vertical spacing between the list items
10144 Note that this is a command not a length so it doesn't require
10150 like the stuff mentioned above.
10153 \begin_layout Subsubsection
10154 Headers and Footers
10157 \begin_layout Standard
10170 commands control whether the logo in the
10174 definition appear on a given page.
10181 in the preamble then none of the foils will have the logo on them.
10182 If you don't want the logo on a particular page place the
10188 directly after the foilhead of that page and the
10194 directly after the next foilhead.
10197 \begin_layout Standard
10198 If you decide to use the
10202 page style setting in the
10205 \begin_inset space ~
10210 dialog you should probably add
10220 to your preamble so headers and footers on landscape pages are correctly
10221 placed when rotated.
10222 This is due to some clashes between the page layouts provided by the
10233 \begin_layout Section
10234 Hollywood (Hollywood spec scripts)
10237 \begin_layout Standard
10243 \begin_layout Subsection
10247 \begin_layout Standard
10248 Getting the format of a Hollywood script right is a
10249 \begin_inset Quotes eld
10253 \begin_inset Quotes erd
10256 It is designed to make the readers focus on content and to be easy and
10257 familiar for the actors to read.
10258 Each page of a script should be one minute of film.
10259 Nothing goes in a script that you cannot see or hear on screen.
10260 The courier 12 pt font should be used throughout.
10264 \begin_layout Subsection
10268 \begin_layout Standard
10269 Speakers' lines should NEVER break in mid-sentence.
10270 If a speaker's lines continue over a page break, repeat the
10274 title followed by (Cont'd).
10277 \begin_layout Subsection
10281 \begin_layout Standard
10286 names as labels then cross-reference the label to insert the name.
10287 The cross-reference dialog will show the current cast of characters.
10288 You can use this to insert the speaker name in narratives also.
10291 \begin_layout Subsection
10292 Paper size and Margins
10295 \begin_layout Standard
10296 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10299 \begin_layout Subsection
10303 \begin_layout Standard
10304 The following environments are available.
10305 You can use hollywood.bind to get the bind keys shown at the right.
10308 \begin_layout Itemize
10312 \begin_inset Newline newline
10317 Used where nothing else works.
10321 \begin_layout Itemize
10327 \begin_inset space \hfill{}
10335 \begin_inset Newline newline
10338 Usually followed by something like
10339 \begin_inset Quotes eld
10342 on Sally waking up.
10343 \begin_inset Quotes erd
10349 \begin_layout Itemize
10353 \begin_inset space \hfill{}
10357 \begin_inset Newline newline
10362 Introduces a new INTERIOR camera set-up.
10363 Always followed by DAY or NIGHT, or something similar to define the lighting
10365 Everthing on this line in CAPS.
10368 \begin_layout Itemize
10372 \begin_inset space \hfill{}
10376 \begin_inset Newline newline
10381 Introduces a new EXTERIOR camera set-up.
10382 Everthing on this line in CAPS.
10385 \begin_layout Itemize
10389 \begin_inset space \hfill{}
10393 \begin_inset Newline newline
10398 The character speaking.
10401 \begin_layout Itemize
10405 \begin_inset space \hfill{}
10409 \begin_inset Newline newline
10414 Instructions to the speaker.
10415 The () are automatically inserted, but only the ( will show in LyX.
10416 Both will be printed.
10419 \begin_layout Itemize
10423 \begin_inset space \hfill{}
10427 \begin_inset Newline newline
10439 \begin_layout Itemize
10443 \begin_inset space \hfill{}
10447 \begin_inset Newline newline
10452 Camera movement instruction.
10454 \begin_inset space \thinspace{}
10458 \begin_inset space \space{}
10464 \begin_layout Itemize
10468 \begin_inset space \hfill{}
10474 \begin_layout Itemize
10478 \begin_inset space \hfill{}
10484 \begin_layout Itemize
10488 \begin_inset space \hfill{}
10494 \begin_layout Itemize
10498 \begin_inset space \hfill{}
10504 \begin_layout Subsection
10508 \begin_layout Itemize
10509 (O.S) — off screen
10512 \begin_layout Itemize
10513 (V.0) — voice over
10516 \begin_layout Itemize
10518 \begin_inset space \thinspace{}
10525 \begin_layout Itemize
10530 \begin_layout Itemize
10531 PAN — camera movement
10534 \begin_layout Itemize
10535 INSERT — cut to close-up of
10538 \begin_layout Section
10542 \begin_layout Standard
10545 Panayotis Papasotiriou
10548 \begin_layout Subsection
10552 \begin_layout Standard
10553 The ijmpc package is a set of macros that facilitates electronic manuscript
10556 International Journal of Modern Physics C
10559 Similarly, the ijmpd package is for creating manuscripts to be submitted
10562 International Journal of Modern Physics D
10565 Both journals are published by World Scientific.
10566 The corresponding document classes are named
10575 These files, together with instructions for the authors, can be downloaded
10577 \begin_inset Flex URL
10580 \begin_layout Plain Layout
10582 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10588 \begin_inset Flex URL
10591 \begin_layout Plain Layout
10593 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10599 Both packages are modified versions of the standard
10600 \begin_inset Quotes eld
10604 \begin_inset Quotes erd
10607 package, and they are almost (but not exactly) identical.
10608 Most of their features are supported by LyX.
10609 I have used LyX successfully to write articles submitted to both journals
10610 without any problem.
10613 \begin_layout Subsection
10617 \begin_layout Standard
10618 As usual, the easiest way to write a paper is to start with a template.
10621 File\SpecialChar \menuseparator
10640 This will give an (almost) empty document that includes the most common
10641 fields found in a manuscript.
10642 Simply overwrite the existing text (including the brackets,
10647 You should keep in mind the following remarks.
10650 \begin_layout Enumerate
10651 LyX won't let you change the font size and the page style of the document,
10652 because such modifications are not allowed by both packages.
10655 \begin_layout Enumerate
10656 The language of the document should not be changed.
10657 Before previewing your paper, be sure that the babel package is not used.
10658 To do this, click on
10660 Tools\SpecialChar \menuseparator
10671 checkbox in the language settings, and click on
10679 , if you wish to make this change permanent).
10682 \begin_layout Enumerate
10684 \begin_inset Quotes eld
10688 \begin_inset Quotes erd
10691 style must be used to define keywords.
10694 \begin_layout Enumerate
10695 The ijmpc package provides a style named
10696 \begin_inset Quotes eld
10699 Classification Codes
10700 \begin_inset Quotes erd
10703 , which can be used to define classification codes, such as PACS numbers.
10704 Note that this facility is not supported by the ijmpd package.
10707 \begin_layout Enumerate
10708 Several new environments are available:
10709 \begin_inset Quotes eld
10713 \begin_inset Quotes erd
10717 \begin_inset Quotes eld
10721 \begin_inset Quotes erd
10725 \begin_inset Quotes eld
10729 \begin_inset Quotes erd
10733 \begin_inset Quotes eld
10737 \begin_inset Quotes erd
10741 \begin_inset Quotes eld
10745 \begin_inset Quotes erd
10749 \begin_inset Quotes eld
10753 \begin_inset Quotes erd
10757 \begin_inset Quotes eld
10761 \begin_inset Quotes erd
10765 \begin_inset Quotes eld
10769 \begin_inset Quotes erd
10773 \begin_inset Quotes eld
10777 \begin_inset Quotes erd
10781 \begin_inset Quotes eld
10785 \begin_inset Quotes erd
10789 \begin_inset Quotes eld
10793 \begin_inset Quotes erd
10797 \begin_inset Quotes eld
10801 \begin_inset Quotes erd
10805 \begin_inset Quotes eld
10809 \begin_inset Quotes erd
10813 \begin_inset Quotes eld
10817 \begin_inset Quotes erd
10821 Their use is more or less obvious.
10822 LyX supports all these environments; it will use the proper label, text
10823 style, and numbering scheme for each of them.
10826 \begin_layout Enumerate
10827 Both packages use basic citations; the natbib package should not be used.
10828 In LyX, citation references are shown as usual; in the output, citations
10829 are shown as superscripts.
10830 If you want to use a citation as normal text, you should use the
10835 \begin_inset space \thinspace{}
10839 \begin_inset space \space{}
10843 \begin_inset Quotes eld
10847 \begin_inset space \space{}
10857 \begin_inset Quotes erd
10863 \begin_layout Enumerate
10865 \begin_inset Quotes eld
10869 \begin_inset Quotes erd
10872 section in both packages.
10873 To put acknowledgments, just use the
10874 \begin_inset Quotes eld
10878 \begin_inset Quotes erd
10884 \begin_layout Enumerate
10885 Appendices may be added to the paper,
10889 the Acknowledgments and
10894 LyX provides a special environment, called
10895 \begin_inset Quotes eld
10899 \begin_inset Quotes erd
10902 which marks the beginning of the appendices.
10903 This environment should be left blank; it just sends a LaTeX command, but
10904 nothing is really printed.
10906 \begin_inset Quotes eld
10910 \begin_inset Quotes erd
10913 is printed with blue letters, as a signal that all sections after that
10914 point are appendices.
10915 To write an appendix, use the
10916 \begin_inset Quotes eld
10920 \begin_inset Quotes erd
10924 LyX will number each appendix with capital letters, as required by both
10927 \begin_inset Quotes eld
10931 \begin_inset Quotes erd
10938 be present before the first appendix; if not, all appendices will be numbered
10939 as normal sections in the output.
10942 \begin_layout Enumerate
10943 The ijmpc and the ijmpd packages use the
10947 command to implement table captions.
10948 As a result, a table created by LyX is printed correctly, but its caption
10950 However, you can use some TeX code to overpass this problem, so that captions
10951 are printed as expected.
10952 To do so, create a float table as usual, remove the caption, and replace
10953 it with the TeX code
10963 (sic); you must also the TeX code
10967 immediately after the tabular material.
10968 Study the example table included in the template files to see how this
10969 trick is implemented.
10970 Alternatively, If you need table captions, you should implement the whole
10975 file, then include this file to the LyX document (
10977 Insert\SpecialChar \menuseparator
10978 File\SpecialChar \menuseparator
10980 \begin_inset space ~
10986 Details on how to create a table float can be found in the files
10994 , included in the corresponding packages.
10997 \begin_layout Subsection
10998 Preparing a paper for submission
11001 \begin_layout Standard
11002 Before you submit your paper you must export the LyX document as a LaTeX
11005 File\SpecialChar \menuseparator
11006 Export\SpecialChar \menuseparator
11013 \begin_layout Plain Layout
11014 Actually you have the choice between LaTeX (plain) and pdflatex.
11015 If you intend to use pdflatex to prepare the paper, you should use the
11016 pdflatex option so that included graphics are converted to PDF format,
11017 ready for use by pdflatex.
11022 , then make the following changes to the resulting
11029 \begin_layout Enumerate
11030 Remove the comment lines before the
11039 \begin_layout Enumerate
11040 Remove everything between (and including) the
11052 commands, except for any commands you specifically put into the LaTeX preamble.
11055 \begin_layout Standard
11060 file should be saved and processed through LaTeX as many times as necessary.
11061 You may also want to check the resulting
11068 \begin_layout Subsection
11072 \begin_layout Standard
11073 The use of TeX code is reduced to two commands, which must be placed at
11074 the top of the document.
11075 If you started writing your paper by using the
11083 template, the TeX code needed is already in its place; you usually don't
11085 You may only modify the first TeX code to specify the information printed
11086 to the top of odd and even pages (authors' names and short paper's title,
11088 This TeX code must have the form
11092 markboth{Authors' Names}{Short Paper's Title}
11097 \begin_layout Section
11101 \begin_layout Standard
11107 \begin_layout Subsection
11111 \begin_layout Standard
11112 The iopart package provides a document class to create electronic manuscript
11113 submission to the journals published by the Institute of Physics.
11114 Instructions for the authors how to create a paper using the iopart class
11115 can be downloaded together with the iopart package from the site
11116 \begin_inset Flex URL
11119 \begin_layout Plain Layout
11121 ftp://ftp.iop.org/pub/journals/latex2e
11129 \begin_layout Subsection
11133 \begin_layout Standard
11134 The easiest way to write a paper is to start with the file
11138 that is available in LyX's examples files folder.
11139 Open this file, save it under a new name, and start writing.
11140 The example file explains how to use the special text environments.
11141 Here are the most important advices:
11144 \begin_layout Itemize
11145 To be able to compile your document to a PDF, PS, or DVI, assure that the
11148 Use AMS math package
11150 in the document settings under
11157 \begin_layout Itemize
11160 The title environment defines the kind of your paper.
11161 So use one of the following environments for the title:
11165 \begin_layout Itemize
11174 \begin_layout Itemize
11183 \begin_layout Itemize
11189 for a Topical review
11192 \begin_layout Itemize
11201 \begin_layout Itemize
11210 \begin_layout Itemize
11216 for a Paper (same as Title)
11219 \begin_layout Itemize
11225 for a Preliminary communication
11228 \begin_layout Itemize
11234 for a Rapid communication
11237 \begin_layout Itemize
11243 for a Letter to the editor
11247 \begin_layout Itemize
11250 All title environments except of
11254 can have an optional short title.
11257 \begin_layout Itemize
11258 There is a general title environment
11262 which is not directly supported by the LyX.
11263 This can be used as TeX code when your document doesn't fit into one of
11264 the other title types.
11267 \begin_layout Standard
11268 For more informations like hints for special table and formula formatting,
11269 look at the IOP author guidelines.
11272 \begin_layout Section
11276 \begin_layout Standard
11279 Panayotis Papasotiriou
11282 \begin_layout Subsection
11286 \begin_layout Standard
11287 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11288 that facilitates electronic manuscript submission to the journals they
11290 Most known of them (at least in my domain of interest) are
11292 Astrophysics and Space Science
11298 , but there are many others (see a complete list at
11299 \begin_inset Flex URL
11302 \begin_layout Plain Layout
11304 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11310 The Kluwer package may be downloaded from the site
11311 \begin_inset Flex URL
11314 \begin_layout Plain Layout
11316 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11322 A complete user guide is contained in that package (but it can also be
11323 downloaded separately).
11326 \begin_layout Standard
11327 LyX supports many features of the package but not everything.
11328 However, the TeX code needed is reduced to some
11329 \begin_inset Quotes eld
11333 \begin_inset Quotes erd
11336 commands of the package (see
11337 \begin_inset space ~
11341 \begin_inset CommandInset ref
11343 reference "subsec:kluwer_peculiarities"
11348 I have recently used LyX to write an article submitted to the
11350 Astrophysics and Space Science
11352 without any problem.
11355 \begin_layout Subsection
11359 \begin_layout Standard
11360 The easiest way to write a paper is to start with the Kluwer template file.
11363 File\SpecialChar \menuseparator
11375 This will give an (almost) empty document that includes the most common
11376 fields found in a manuscript and a short description of their use.
11377 As in most templates, simply overwrite the existing text (including the
11382 ) with the correct information.
11385 \begin_layout Subsection
11386 Preparing a paper for submission
11389 \begin_layout Standard
11390 As in the AASTeX package, before you submit your paper to a journal you
11392 \begin_inset Quotes eld
11396 \begin_inset Quotes erd
11402 \begin_layout Enumerate
11403 Export your paper as a LaTeX file.
11404 To do this, click on
11406 File\SpecialChar \menuseparator
11407 Export\SpecialChar \menuseparator
11414 \begin_layout Enumerate
11419 file with a text editor and make the following changes
11423 \begin_layout Enumerate
11424 remove the comment lines before the
11433 \begin_layout Enumerate
11434 remove everything between (and including) the
11446 commands, except for any commands you specifically put into the LaTeX preamble.
11449 \begin_layout Standard
11458 \begin_layout Enumerate
11463 file through LaTeX as many times as necessary (usually up to three).
11466 \begin_layout Enumerate
11472 \begin_inset space \thinspace{}
11476 \begin_inset space \space{}
11483 , and check if everything is OK (it should, if you didn't make any mistake).
11486 \begin_layout Subsection
11487 \begin_inset Quotes eld
11491 \begin_inset Quotes erd
11494 of the Kluwer package
11495 \begin_inset CommandInset label
11497 name "subsec:kluwer_peculiarities"
11504 \begin_layout Standard
11505 The Kluwer package has the following
11506 \begin_inset Quotes eld
11510 \begin_inset Quotes erd
11516 \begin_layout Enumerate
11517 It is possible to write multiple articles in the same LaTeX file
11521 \begin_layout Plain Layout
11522 I can't imagine any good reason to do this.
11528 Each article must be included in the environment
11529 \begin_inset Quotes eld
11533 \begin_inset Quotes erd
11537 Unfortunately, this environment cannot be omitted, even if you write just
11539 Therefore, each article starts with the command
11545 and, obviously, ends with the command
11552 Although this can be implemented in LyX, I didn't included it, since it
11553 looks ugly and can confuse the novice user.
11554 Therefore, you need to enter them directly and mark them as LaTeX code
11556 \begin_inset Quotes eld
11560 \begin_inset Quotes erd
11566 \begin_layout Enumerate
11567 Information given at the beginning of the article (i.
11568 \begin_inset space \thinspace{}
11572 \begin_inset space \space{}
11575 title, subtitle, author, institution, running title, running author, abstract
11576 and keywords) must be included in an environment called
11577 \begin_inset Quotes eld
11581 \begin_inset Quotes erd
11585 This is not implemented in LyX, so you must enter title, subtitle etc.
11586 \begin_inset space ~
11589 between two TeX code lines (
11604 \begin_layout Enumerate
11605 According to the user manual, the label of each bibliography item must be
11629 \begin_layout Standard
11634 template takes care of all these
11635 \begin_inset Quotes eld
11639 \begin_inset Quotes erd
11643 If you start a new paper using this template you don't need to do anything
11648 \begin_layout Enumerate
11649 don't delete the TeX code included in the template, and
11652 \begin_layout Enumerate
11653 copy the example bibliography item included in the template and modify it
11654 as necessary to enter new bibliography items.
11657 \begin_layout Section
11661 \begin_layout Standard
11667 \begin_layout Subsection
11671 \begin_layout Standard
11672 The LyX document classes
11674 article (koma-script)
11678 report (koma-script)
11696 correspond to the LaTeX document classes
11713 \begin_inset space ~
11716 of the Koma-Script family.
11717 They are replacements for the standard document classes
11733 , resp., and fit better to European typography conventions in a number of
11737 \begin_layout Itemize
11738 Standard character size is 11pt in
11740 article (koma-script)
11744 report (koma-script)
11752 letter (koma-script)
11757 \begin_layout Itemize
11758 Headings, labels of the description environment, and a number of elements
11761 letter (koma-script)
11763 document class are set in a bold sans serif font.
11767 \begin_layout Plain Layout
11768 There is a big difference between the bold sans serif old cm fonts and new
11769 ec fonts, especially in the appearance of headings.
11770 In comparison, the ec bold sans serif fonts look a bit thin.
11771 Here the LaTeX package
11779 helps to produce the
11780 \begin_inset Quotes eld
11784 \begin_inset Quotes erd
11787 appearance when using the ec fonts.
11792 The numbering of chapter headings is made in the same way as the numbering
11793 of section headings, that is without the extra line
11794 \begin_inset Quotes eld
11797 Chapter\SpecialChar \ldots{}
11799 \begin_inset Quotes erd
11803 In addition, the appearance of the headings can be modified by using a
11804 number of options (in LyX to be entered in the field
11807 \begin_inset space ~
11814 Layout\SpecialChar \menuseparator
11818 A detailed German description of these options can be found in the Koma-Script
11826 \begin_layout Itemize
11827 The main means in the Koma-Script document classes to design the type area
11836 (in LyX to be entered in the extra class options field in the dialog
11838 Document\SpecialChar \menuseparator
11842 They make a clearer modification of page margins possible as do the options
11845 Document\SpecialChar \menuseparator
11849 A detailed German description of these and other type area options can
11850 be found in the Koma-Script documentation
11857 \begin_layout Itemize
11858 The LaTeX document classes of the Koma-Script family define a number of
11859 additional commands.
11860 Those part of it which makes sense in LyX is implemented in corresponding
11864 \begin_layout Standard
11865 A detailed German description of the LaTeX document classes of the Koma-Script
11866 family can be found in the Koma-Script documentation
11874 \begin_layout Plain Layout
11875 There is an English translation
11879 , but it is not a complete one.
11884 The following sections describe only those aspects, which are relevant
11888 \begin_layout Subsection
11889 article (koma-script), report (koma-script), and book (koma-script)
11892 \begin_layout Standard
11893 The document classes
11895 article (koma-script)
11899 report (koma-script)
11909 are implemented in the layout files
11922 They contain all the paragraph types of the corresponding standard document
11935 , resp., partly modified, with the exception of the LyX specific
11939 -type, which is replaced by the new
11943 -type having the same functionality.
11948 -Type there is a number of new paragraph types added.
11955 letter (koma-script)
11960 \begin_layout Itemize
11969 : are equivalents to
11977 , resp., additionally inserting an entry in the table of contents.
11986 are not contained in
11988 article (koma-script)
11993 \begin_layout Itemize
12002 : behave exactly as
12010 , resp., additionally clearing running heads.
12015 is not contained in
12017 article (koma-script)
12023 \begin_layout Plain Layout
12036 report (koma-script)
12038 , but since this is identical to
12042 , is has not been implemented in LyX.
12050 \begin_layout Itemize
12055 : generates a heading directly above the following paragraph in the standard
12056 character size without affecting the structure of the document.
12059 \begin_layout Itemize
12068 are special captions which respect the different space settings needed
12069 for captions placed above or below an element (if you follow strict typographic
12070 rules, you might want to place table captions always above the table).
12071 You can also use the class option
12075 , which will switch
12088 You need at least Koma-Script version 2.8q to use this.
12091 \begin_layout Itemize
12096 : can be used to set a bonmot, e.
12097 \begin_inset space \thinspace{}
12101 \begin_inset space \space{}
12104 at the beginning of a chapter.
12105 If you use the optional argument (
12107 Insert\SpecialChar \menuseparator
12109 \begin_inset space ~
12114 ), you can insert the dictum's author there.
12115 Dictum and author are separated by a line.
12116 You need at least Koma-Script version 2.8q to use this.
12121 is not contained in
12123 article (koma-script)
12128 \begin_layout Standard
12129 The following types, together with the standard types
12141 , form the title area of the document.
12142 They must be entered ahead of the first
12143 \begin_inset Quotes eld
12147 \begin_inset Quotes erd
12154 \begin_layout Plain Layout
12155 The corresponding LaTeX commands must appear before the
12166 When such a type is used more than once, the latter usage overwrites the
12167 former one, that means, for every type only the latest usage is valid.
12168 The order of the different types however has, like
12180 , no effect on the appearance of the produced document.
12183 \begin_layout Itemize
12188 : produces a centered paragraph above the ordinary title (
12200 ) for the subject of the document.
12203 \begin_layout Itemize
12208 : produces a centered paragraph below the ordinary title (
12220 ) for the publishers' name.
12223 \begin_layout Itemize
12230 report (koma-script)
12236 produces a centered paragraph on its own page behind the title page, or
12239 article (koma-script)
12241 produces a centered paragraph below the ordinary title (
12257 ) for a dedication.
12260 \begin_layout Itemize
12265 : produces a left aligned paragraph above the ordinary title (
12281 ) for a document`s head.
12284 \begin_layout Itemize
12289 : produces in a double-sided print in
12291 report (koma-script)
12297 a left-aligned paragraph at the top of the title page`s back or has no
12298 effect in a single-sided print or in
12300 article (koma-script)
12305 \begin_layout Itemize
12310 : produces in a double-sided print in
12312 report (koma-script)
12318 a left-aligned paragraph at the bottom of the title page`s back or has
12319 no effect in a single-sided print or in
12321 article (koma-script)
12326 \begin_layout Itemize
12331 : produces a special
12332 \begin_inset Quotes eld
12336 \begin_inset Quotes erd
12339 page ahead of the actual document containing a paragraph without special
12343 \begin_layout Standard
12344 The layout files for the document classes
12346 article (koma-script)
12350 report (koma-script)
12356 do include the file
12361 This is thought of as a place to define your own types.
12366 in your personal layout directory and edit the file!
12369 \begin_layout Subsection
12370 letter (koma-script)
12373 \begin_layout Standard
12377 \begin_layout Plain Layout
12389 \begin_layout Standard
12393 letter (koma-script)
12395 is implemented in the layout file
12400 It contains all the paragraph types of the corresponding standard document
12405 , partly modified, with the exception of the LyX specific types
12417 type, which is replaced by the new
12422 In addition, it contains, in contrast to the standard document class, the
12440 Furthermore, there are a number of new letter specific types.
12443 \begin_layout Standard
12447 \begin_layout Plain Layout
12459 \begin_layout Standard
12460 The appearance of the letter produced by this document class can be controlled
12461 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12465 \begin_layout Plain Layout
12466 For example, the standard appearance of the letter`s heading, consisting
12467 of name and address, is quite self-willed.
12469 \begin_inset Quotes eld
12473 \begin_inset Quotes erd
12476 heading is produced by the following LaTeX commands in the preamble:
12479 \begin_layout LyX-Code
12489 \begin_layout LyX-Code
12505 \begin_layout LyX-Code
12515 \begin_layout LyX-Code
12535 A detailed German description of such LaTeX commands can be found in the
12536 Koma-Script documentation
12541 With it, the letter's author can produce his personal letter layout.
12544 \begin_layout Standard
12553 define the beginning of the letter and must be used in every letter.
12554 To emphasize them in the LyX document class, they are marked with the letter
12564 \begin_inset space ~
12567 in the left margin.
12568 It is possible to write any number of letters in one file.
12573 type produces a new letter using the same addressee and a
12577 type produces a new addressee.
12594 are ordinary paragraph types and can also be used several times in one
12595 and the same letter.
12598 \begin_layout Itemize
12603 : produces a paragraph for the addressee and implicitly defines the beginning
12607 \begin_layout Itemize
12612 : produces a paragraph for the form of address and implicitly produces a
12616 \begin_layout Itemize
12621 : produces a paragraph for a close.
12624 \begin_layout Itemize
12629 : produces a paragraph for a postscript.
12632 \begin_layout Itemize
12637 : produces a paragraph for a distribution list.
12640 \begin_layout Itemize
12645 : produces a paragraph for enclosures.
12648 \begin_layout Standard
12689 are input types provided with a label to enter information, which will
12690 be processed by the document class.
12694 \begin_layout Plain Layout
12695 It could be seen as a matter of inconsequence, that the types
12703 described above are not such input types as well.
12704 Because of the special meaning of those types, however, I have implemented
12705 them as ordinary paragraph types with a one letter mark in the left margin.
12706 Moreover, it would affect my feeling of symmetry, if the
12714 type had such a serious different appearance.
12719 The types must be used ahead of the corresponding
12726 \begin_layout Standard
12727 An implementation of these types in a WYSIWYG fashion does not seem to make
12728 sense, because the real appearance of the produced letter does not only
12729 depend on the usage of the particular type, but also on other factors.
12730 For example, a signature entered in the
12734 type will in the standard behavior appear in the produced letter only,
12735 when in the same letter also a
12740 The entered value of the
12744 type will in the standard behavior not appear in the produced letter at
12746 The possibility to design the letter`s heading freely is already indicated
12747 in a footnote above.
12750 \begin_layout Standard
12751 The input types can also be used as empty paragraphs.
12752 This makes sense e.
12753 \begin_inset space \thinspace{}
12757 \begin_inset space \space{}
12769 type is not used at all, in the standard behavior the value of the
12773 type is used as signature, whereas if an empty
12777 type is used, no signature value is defined.
12780 \begin_layout Standard
12781 By using the input types it is possible to write a letter template, containing
12782 filled input types with your personal dates (name, address, etc.) and empty
12783 input types for other dates you want to enter.
12786 \begin_layout Itemize
12791 : sender's name, in the standard behavior appears as a centered paragraph
12792 in small caps in the letter`s heading.
12795 \begin_layout Itemize
12800 : sender's signature, in the standard behavior appears below the
12809 type is used, the value of the
12813 type appears instead.
12816 \begin_layout Itemize
12821 : sender's address, in the standard behavior appears in a centered paragraph
12822 in the letter`s heading below the sender's name.
12825 \begin_layout Itemize
12830 : sender's telephone number, in the standard behavior only sets the LaTeX
12840 \begin_layout Itemize
12845 : place of the letter`s making.
12848 \begin_layout Itemize
12853 : date of the letter`s making.
12862 , in the standard behavior, produce the place and the date in a right-aligned
12863 line below the addressee's field.
12868 type is used, neither place nor date appear, independent of the value of
12878 type is used, the date of the letter `s production is used.
12881 \begin_layout Itemize
12886 : sender`s back address, in the standard behavior appears above the addressee's
12887 field in a small sans serif font.
12890 \begin_layout Itemize
12895 : special mail information, in the standard behavior appears underlined
12896 above the addressee's field below the back address.
12899 \begin_layout Itemize
12904 : additional information, in the standard behavior appears on right side
12905 below the addressee`s field.
12908 \begin_layout Itemize
12913 : the letter's title, in the standard behavior appears in a big, bold, sans
12914 serif font above the subject.
12917 \begin_layout Itemize
12922 : the letter's subject, in the standard behavior appears in a bold font
12930 \begin_layout Standard
12951 produce a business letter like line above the
12955 line containing the fields
12956 \begin_inset Quotes eld
12960 \begin_inset Quotes erd
12964 \begin_inset Quotes eld
12968 \begin_inset Quotes erd
12972 \begin_inset Quotes eld
12976 \begin_inset Quotes erd
12980 \begin_inset Quotes eld
12984 \begin_inset Quotes erd
12988 \begin_inset Quotes eld
12992 \begin_inset Quotes erd
12996 \begin_inset Quotes eld
13000 \begin_inset Quotes erd
13004 For the date field, the value of the
13010 \begin_inset Quotes eld
13013 business letter types
13014 \begin_inset Quotes erd
13017 is used, the value of the
13021 type however does not appear, but only the LaTeX variable
13028 The ordinary output of place and date in a right-aligned line below the
13029 addressee`s field is suppressed.
13030 The types are implemented as input types provided with a label and must
13031 be used ahead of the corresponding
13038 \begin_layout Itemize
13046 \begin_layout Itemize
13054 \begin_layout Itemize
13062 \begin_layout Itemize
13070 \begin_layout Itemize
13078 \begin_layout Subsection
13079 The new letter class: letter (koma-script v.2)
13082 \begin_layout Standard
13085 Jürgen Spitzmüller
13088 \begin_layout Standard
13089 \begin_inset VSpace medskip
13095 \begin_layout Standard
13097 Koma-Script version 2.8 has introduced a new letter class
13101 which supersedes the now unsupported
13106 It has — on the LaTeX side — a completely new interface and is not compatible
13107 with the old class.
13108 Therefore, LyX supports both, though it is recommended to use the new class.
13111 \begin_layout Standard
13112 This class covers the same functionality as
13114 letter (koma-script),
13117 The basic items are
13121 (receiver's address, same as
13125 in the old layout),
13138 will start a new letter (i.
13139 \begin_inset space \thinspace{}
13143 \begin_inset space \space{}
13146 you can write several letters per document).
13147 New elements are sender's
13163 and the possibility to use a
13169 Insert\SpecialChar \menuseparator
13175 \begin_layout Standard
13176 The biggest improvement is, though, that the letter's layout is configurable
13177 at almost any needs.
13178 This can be done via the preamble or with a special style file (Letter
13179 Class Option, extension
13183 ), that will be read in as a class option.
13187 \begin_layout Plain Layout
13188 The KOMA package comes with some default
13193 There is, for instance, a
13197 file that follows german typesetting rules, or a
13201 that provides the default layout of the old
13206 The latter can be loaded with the class option
13215 ayout\SpecialChar \menuseparator
13220 ocument\SpecialChar \menuseparator
13232 template that is included in LyX for examples.
13233 A detailed description is to be found in the Koma-Script documentation
13241 \begin_layout Subsection
13245 \begin_layout Standard
13246 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13250 \begin_layout Itemize
13251 The chapter number of a
13255 type appears on a line of its own above the chapter heading instead of
13256 appearing in the same line ahead of it.
13257 The cause for that is the LyX internal behavior for the labeltype
13261 in the layout file.
13264 \begin_layout Itemize
13265 The headings of the types
13273 are only put in the
13274 \begin_inset Quotes eld
13278 \begin_inset Quotes erd
13281 LaTeX table of contents, but not in the LyX table of contents (
13283 Document\SpecialChar \menuseparator
13285 \begin_inset space ~
13289 \begin_inset space ~
13297 \begin_layout Itemize
13298 The paragraphs in a
13302 document class appear in a skip separation mode, not indented.
13303 This is the standard behavior, no special LaTeX commands are needed for
13307 Document\SpecialChar \menuseparator
13310 dialog the corresponding radio button indicates
13319 value always has the effect that extra LaTeX commands are inserted in the
13320 document to produce the gap, which is not what is wanted in this case.
13323 \begin_layout Section
13324 Latex8 (IEEE Conference Papers)
13327 \begin_layout Standard
13333 \begin_layout Subsection
13337 \begin_layout Standard
13338 Since this class is specifically for writing submissions to IEEE sponsored
13339 conferences I strongly recommend that you get a copy of their Authors Kit.
13344 package and associated bibliography style file is included in the kit.
13345 The Authors Kit is usually sent out by email once your initial submission
13347 There is a lot of useful information in the Authors Kit explaining formatting
13348 restrictions and so on and I will assume you have read this since that
13349 means I don't have to repeat it all here.
13352 \begin_layout Subsection
13356 \begin_layout Standard
13357 [AR\SpecialChar \@.
13361 \begin_layout Subsection
13362 Supported Environments
13365 \begin_layout Itemize
13371 \begin_layout Itemize
13377 \begin_layout Itemize
13383 \begin_layout Itemize
13389 \begin_layout Itemize
13395 \begin_layout Itemize
13401 \begin_layout Itemize
13407 \begin_layout Itemize
13413 \begin_layout Itemize
13419 \begin_layout Subsection
13420 Differences Between Screen and Paper
13423 \begin_layout Standard
13424 There are slight differences in appearance mainly with the presentation
13425 of section counters.
13426 On screen the trailing period of the section counter is missing but it
13427 will appear in the output so don't let this worry you.
13430 \begin_layout Section
13434 \begin_layout Standard
13437 Jürgen Spitzmüller
13440 \begin_layout Subsection
13444 \begin_layout Standard
13445 Memoir is a very powerful and constantly evolving class.
13446 It has been designed with regard to fictional and non-fictional literature.
13447 Its aim is to let the user have maximum control over the typesetting of
13449 Memoir is based on the standard book class, but it can also emulate the
13450 article class (see below).
13453 \begin_layout Standard
13454 Peter Wilson, the developer of Memoir, is known as the author of lots of
13455 useful packages in the LaTeX world.
13456 Most of them have been merged with Memoir.
13457 Therefore, it is much easier to layout the table of contents, appendices,
13458 chapter designs and such.
13459 LyX, though, does not support all of these goodies natively.
13460 Some of them might be added to forthcoming releases
13464 \begin_layout Plain Layout
13465 You are invited to send suggestions to
13466 \begin_inset Flex URL
13469 \begin_layout Plain Layout
13471 lyx-devel@lists.lyx.org
13481 , lots will probably never, due to the limitations of LyX's framework.
13482 Of course you can still use all features with the help of some native LaTeX
13487 \begin_layout Plain Layout
13492 \begin_layout Plain Layout
13502 \begin_inset space ~
13506 \begin_inset CommandInset ref
13508 reference "sec:Inserting-TeX-Code"
13518 In this section, we can only list those features which are natively supported
13520 For detailed descriptions (and for the rest of features) we are recommending
13521 to have a look at the detailed manual of the Memoir class
13525 \begin_layout Plain Layout
13530 \begin_layout Plain Layout
13540 \begin_inset Flex URL
13543 \begin_layout Plain Layout
13545 CTAN:/macros/latex/memoir/memman.pdf
13555 , which is not only a user guide for the class, but also both a comprehensive
13556 description on good typesetting and a superb example for good typesetting
13560 \begin_layout Subsection
13561 Basic features and restrictions
13564 \begin_layout Standard
13565 Memoir supports basically all features of the standard book classes.
13566 There are, however, some differences, as follows:
13569 \begin_layout Description
13571 \begin_inset space ~
13574 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13577 \begin_layout Description
13579 \begin_inset space ~
13582 style: The fancy page style is not supported, due to a command clash between
13583 Memoir and the fancyhdr package (they are both defining a command with
13584 the same name, which confuses LaTeX).
13585 Instead, Memoir comes with a bunch of own page styles (see
13587 Layout\SpecialChar \menuseparator
13588 Document\SpecialChar \menuseparator
13590 \begin_inset space ~
13596 If you want to use these for the chapter pages, you have to use the command
13603 in the main text or in preamble (e.
13604 \begin_inset space \thinspace{}
13608 \begin_inset space \space{}
13615 chapterstyle{companion}
13620 \begin_layout Description
13621 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13622 an optional argument in the standard classes.
13623 With this, you can specify an alternative version of the title for the
13624 table of contents and the headers (for instance, if the title is too long).
13625 In LyX, you can do this via
13627 Insert\SpecialChar \menuseparator
13629 \begin_inset space ~
13634 at the beginning of a chapter/section.
13635 Memoir features a second optional argument and thus separates the table
13636 of contents from the header.
13637 You can define three variants of a title with this: one for the main text,
13638 one for the table of contents, and one for the headers.
13639 Simply insert two optional arguments if you need this feature, the first
13640 one containing the short title for the Table of Contents, the second one
13641 containing an alternative short title for the headers.
13644 \begin_layout Description
13645 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13646 of contents, the list of figures and the list of table start a new page
13648 Memoir does not follow this route.
13649 You have to insert a page break yourself, if you want to have one.
13652 \begin_layout Description
13653 Titlepage: For some unknown reason, Memoir uses pagination on the title
13654 page (in the standard classes, title pages are
13655 \begin_inset Quotes eld
13659 \begin_inset Quotes erd
13663 \begin_inset space \thinspace{}
13667 \begin_inset space \space{}
13671 If you want an empty title page, type
13675 aliaspagestyle{title}{empty}
13680 \begin_layout Description
13681 Article: With the class option
13687 Layout\SpecialChar \menuseparator
13688 Document\SpecialChar \menuseparator
13690 \begin_inset space ~
13695 ), you can emulate article style.
13696 That is, counters (footnotes, figures, tables etc.) will not be reset on
13697 new chapters, chapters don't start a new page (but are—in contrary to
13698 \begin_inset Quotes eld
13702 \begin_inset Quotes erd
13705 article classes—still allowed), parts, though, use their own page, as in
13709 \begin_layout Description
13710 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13711 font commands, which have been used in the old LaTeX version 2.09 (e.
13712 \begin_inset space \thinspace{}
13716 \begin_inset space \space{}
13732 It produces an error and stops LaTeX whenever such a command appears.
13737 reallows the commands and spits out warnings instead (which does at least
13739 Since a lot of packages and particularly BibTeX style files are still using
13740 those commands, we have decided to use this option by default.
13743 \begin_layout Subsection
13747 \begin_layout Standard
13748 We will only describe the features supported by LyX (which is not much currently
13750 Please consult the Memoir manual
13754 \begin_layout Plain Layout
13759 \begin_layout Plain Layout
13769 \begin_inset Flex URL
13772 \begin_layout Plain Layout
13774 CTAN:/macros/latex/memoir/memman.pdf
13787 \begin_layout Description
13788 Abstract: You may wonder why an abstract is an extra feature.
13789 Well, it is in book class.
13790 Usually books don't have abstracts.
13791 Memoir, however, has.
13792 You can use it wherever and how often you like.
13795 \begin_layout Description
13796 Chapterprecis: You may know this from belletristic: The contents of a chapter
13797 is shortly described below the title and also in the table of contents
13799 \begin_inset space \thinspace{}
13803 \begin_inset space \space{}
13808 Our hero arrives in Troia; he loses some friends; he finds others
13811 Chapterprecis does exactly this.
13812 It is therefore only sensible below a chapter.
13815 \begin_layout Description
13816 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13817 The epigraph environment provides an elegant way of typesetting such a
13819 The motto itself (text) and its author (source) are divided by a short
13821 Unfortunately, we have to fool LyX a bit here again, since the environment
13822 needs two arguments (text and source).
13823 In this case, we have to use curly brackets (in TeX mode) between the two
13834 <author of the slogan>.
13837 \begin_layout Description
13838 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13839 complex figurative poems).
13840 LyX can only support a few of them.
13841 One is poemtitle, which is a centered title for poems, which will also
13842 be added to the table of contents (verse is the standard environment for
13844 Memoir has some enhanced versions of verse, but you need to use TeX code,
13845 because they have to be nested inside regular verse environments, which
13846 is not possible with LyX).
13849 \begin_layout Description
13850 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
13853 \begin_layout Section
13854 Article (mwart), book (mwbk) and report (mwrep)
13855 \begin_inset OptArg
13858 \begin_layout Plain Layout
13871 \begin_layout Standard
13877 \begin_layout Standard
13878 The LyX document classes
13894 correspond to the LaTeX document classes
13907 They are replacements for the standard document classes
13919 , resp., and fit better to Polish typography conventions in a number of points.
13923 \begin_layout Standard
13927 \begin_layout Itemize
13928 Unnumbered titles (with star, e.
13929 \begin_inset space \thinspace{}
13933 \begin_inset space \space{}
13940 ) are added into table of contents,
13943 \begin_layout Itemize
13944 Additional page styles:
13948 \begin_layout Description
13949 uheadings header with separated lines,
13952 \begin_layout Description
13953 myheadings custom header, contents headers via commands:
13968 \begin_layout Description
13969 myuheadings custom header with separated lines,
13972 \begin_layout Description
13973 outer page number is placed on outer side of page
13977 \begin_layout Itemize
13982 \begin_layout Description
13983 rmheadings serif titles — default,
13986 \begin_layout Description
13987 sfheadings sansserif titles,
13990 \begin_layout Description
13991 authortitle on title page first placed is author next title — default,
13994 \begin_layout Description
13995 titleauthor on title page first placed is title next author,
13998 \begin_layout Description
13999 withmarginpar reserve place on page for margins.
14003 \begin_layout Section
14007 \begin_layout Standard
14012 provides an alternative to the standard
14017 It provides similar functionality, but you might prefer this layout with
14018 sans serif sections, headings, and more.
14021 \begin_layout Section
14025 \begin_layout Standard
14031 \begin_layout Standard
14032 \begin_inset VSpace bigskip
14038 \begin_layout Standard
14043 \begin_inset space ~
14048 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14049 \begin_inset Formula $\beta$
14052 release of May, 1999) class.
14055 \begin_layout Standard
14060 textclass, which works with RevTeX 3.1.
14061 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14062 That means that it doesn't interact very well with LyX, which requires
14063 LaTeX2e, although it has been kludged to work.
14064 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14068 \begin_inset space ~
14073 textclass should also be pretty easy to use.
14076 \begin_layout Standard
14077 These documents are supposed to be used in
14081 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14082 macros, and assume you'll know what to put in the preamble if necessary.
14085 \begin_layout Subsection
14089 \begin_layout Standard
14090 All you need to do is install RevTeX 4, as described in the package's README
14092 The package can be found at The RevTeX 4 Web Site
14093 \begin_inset Flex URL
14096 \begin_layout Plain Layout
14098 http://publish.aps.org/revtex4/
14104 Install it somewhere that LaTeX can see it.
14105 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14107 \begin_inset space \thinspace{}
14111 \begin_inset space \space{}
14114 not the directory where you installed the class file.) Then, if you reconfigure
14115 LyX, it will find the class file and let you use the RevTeX4 textclass.
14118 \begin_layout Standard
14119 Probably the easiest way to get started is either to import a RevTeX 4 document
14127 \begin_inset space ~
14132 template, found in the templates directory.
14135 \begin_layout Subsection
14139 \begin_layout Standard
14140 Optional arguments to
14147 \begin_inset Quotes eld
14151 \begin_inset Quotes erd
14155 \begin_inset Quotes eld
14159 \begin_inset Quotes erd
14169 \begin_inset space ~
14177 \begin_inset space ~
14183 Remember that in RevTeX, at least one optional argument is required!
14186 \begin_layout Standard
14187 Other preamble matter, like
14194 \begin_inset space ~
14200 \begin_inset space ~
14205 dialog, also as usual.
14208 \begin_layout Subsection
14212 \begin_layout Standard
14213 The layouts basically correspond to the commands in RevTeX4.0.
14214 For example, the Email layout corresponds to
14221 Note that (at least as of RevTeX 4.0 Beta), the
14229 layouts are exactly equivalent, so you shouldn't need to use both.
14233 \begin_layout Plain Layout
14234 In case you're curious, both were included so that
14238 would be able to translate both
14258 \begin_layout Subsection
14262 \begin_layout Standard
14263 There are a couple of important unique aspects of RevTeX 4 which might cause
14264 bugs that will be even more confusing in LyX.
14267 \begin_layout Standard
14285 The LyX equivalent is that there is a separate Thanks layout.
14290 write footnotes in the
14294 layout, or weird things may happen.
14295 See the RevTeX 4 documentation for more details.
14298 \begin_layout Standard
14302 \begin_inset space ~
14310 \begin_inset space ~
14319 layouts must be placed
14327 layout and the corresponding
14344 , the LaTeX won't compile.
14347 \begin_layout Subsection
14351 \begin_layout Standard
14352 The main problem with this layout is that you can't use the optional arguments
14353 to layouts like Email and Title.
14354 (The problem is not unique to this layout; you can't use optional arguments
14355 to the Section layouts either.) This means that after you export that file
14356 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14357 need to edit the LaTeX file with a text editor to add the optional arguments
14359 \begin_inset space \thinspace{}
14363 \begin_inset space \space{}
14366 the running title for the page headers.
14367 Lacking these layouts makes the
14373 (and the equivalent
14379 ) useless, so the corresponding layouts don't exist, and will have to be
14384 \begin_layout Plain Layout
14389 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14390 has not been updated yet to take advantage of it.
14398 \begin_layout Section
14399 Springer Journals (
14406 \begin_layout Standard
14412 \begin_layout Subsection
14416 \begin_layout Standard
14417 These are the layout files for some of the journal formats used by Springer
14418 Verlag and listed on
14419 \begin_inset Flex URL
14422 \begin_layout Plain Layout
14424 http://www.springer.de/author/tex/help-journals.html
14429 , where you should also go to fetch the class files (yes, these are LaTeX2e
14431 It is a modular system: the things common to all journals are implemented
14436 , which journal-specific layout files (such as, e.
14437 \begin_inset space \thinspace{}
14441 \begin_inset space \space{}
14448 for Journal of Geodesy) can include.
14451 \begin_layout Standard
14452 This means that implementing support for any other Springer journal on this
14453 list is as simple as writing your own
14461 file following the outline given in
14469 \begin_layout Standard
14470 It is reasonably well tested only for the Journal of Geodesy.
14479 come with the standard LyX distribution.
14480 Install the relevant class file (downloaded from Springer) in a proper
14481 directory, reconfigure LaTeX (in the teTeX case by running
14485 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14486 and it should work.
14489 \begin_layout Subsection
14493 \begin_layout Standard
14494 A large number of theorem-like styles —
14500 \SpecialChar \ldots{}
14506 \begin_layout Standard
14509 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14510 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14513 See the Springer class file documentation for details.
14516 \begin_layout Subsection
14520 \begin_layout Itemize
14532 \begin_layout Itemize
14535 Probability Theory and Related Fields
14541 — Jean-Marc Lasgouttes
14544 \begin_layout Standard
14545 Add your own, it isn't so hard!
14548 \begin_layout Subsection
14552 \begin_layout Standard
14553 These files are partly based on the older
14557 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14558 file from Springer.
14563 layout, are now defunct.
14564 Jean-Marc Lasgouttes helped out big in making me find my way around the
14565 LyX layout file mechanism.
14568 \begin_layout Subsection
14572 \begin_layout Standard
14574 But probably less than in the old hacked-LaTeX
14581 \begin_layout Standard
14583 \begin_inset space \thinspace{}
14586 g.: does not display the number for theorem-like layouts, just #.
14589 \begin_layout Section
14595 \begin_inset CommandInset label
14604 \begin_layout Standard
14612 \begin_layout Subsection
14616 \begin_layout Standard
14617 This section describes how to use LyX to make slides for overhead projectors.
14618 There are two document classes that can do this: the default slides class
14624 This section documents the former.
14627 \begin_layout Standard
14628 I'm going to say this again, nice and clear, so that there's no misunderstanding
14632 \begin_layout Standard
14633 \begin_inset VSpace bigskip
14639 \begin_layout Standard
14643 This section documents the class
14644 \begin_inset Quotes eld
14652 \begin_inset Quotes erd
14660 \begin_layout Standard
14661 \begin_inset VSpace bigskip
14667 \begin_layout Standard
14668 If you're looking for the documentation for
14669 \begin_inset Quotes eld
14677 \begin_inset Quotes erd
14680 , check out section
14681 \begin_inset space ~
14685 \begin_inset CommandInset ref
14687 reference "sec:foiltex"
14697 \begin_inset Quotes eld
14705 \begin_inset Quotes erd
14708 ] is actually somewhat better than the default
14716 \begin_layout Plain Layout
14717 \SpecialChar \ldots{}
14718 or so I've been told repeatedly by its advocates.
14719 Having never used it, I have no idea if this claim is true or not.
14724 which this section documents.
14727 \begin_layout Standard
14728 This class is the LaTeX2e improvement of the old
14733 Every LaTeX2e distribution includes this class [which I'll just refer to
14735 \begin_inset Quotes eld
14743 \begin_inset Quotes erd
14746 from now on], so you're bound to have it.
14747 As I noted earlier, there are other classes, such as
14751 , which also produce slides for overhead projectors and do a better job
14753 However, there are some things which
14757 can do which the others can't, such as generate overlays.
14758 Read on to learn more!
14761 \begin_layout Subsection
14763 \begin_inset CommandInset label
14765 name "sec:slidesetup"
14772 \begin_layout Standard
14773 Obviously, to use this document class, you need to select
14774 \begin_inset Quotes eld
14782 \begin_inset Quotes erd
14785 from the class list in the
14787 Document\SpecialChar \menuseparator
14791 There are some other special things you should know about this class:
14794 \begin_layout Itemize
14795 Don't bother changing the options
14800 They're not supported by the
14807 \begin_layout Itemize
14811 \begin_inset space ~
14816 behaves a bit differently for this class.
14817 The possible choices and what they do are as follows:
14821 \begin_layout Description
14826 The final output contains page numbers in the lower right corner.
14829 \begin_layout Description
14838 , but also prints out any time markers you've put in.
14839 This is the default.
14842 \begin_layout Description
14847 The final output contains no page numbers, time markers, or alignment markers.
14851 \begin_layout Itemize
14856 class has an extra option:
14862 \begin_inset Quotes eld
14870 \begin_inset Quotes erd
14873 in the extra class options.
14877 \begin_layout Standard
14878 Using this options allows you to add time markers to
14884 \begin_inset space ~
14888 \begin_inset CommandInset ref
14890 reference "sec:slideNote"
14898 \begin_layout Standard
14899 You can also use the template file
14900 \begin_inset Quotes eld
14908 \begin_inset Quotes erd
14911 to automatically set up a document to use the
14917 File\SpecialChar \menuseparator
14919 \begin_inset space ~
14923 \begin_inset space ~
14928 to open your new document].
14929 The template file also contains some examples of the special paragraph
14930 environments used by this class.
14931 I'll describe those next.
14934 \begin_layout Subsection
14935 Paragraph Environments
14938 \begin_layout Subsubsection
14939 Supported Environments
14942 \begin_layout Standard
14943 The first thing you'll notice when you start up a new
14947 document is the font size and type: it's the equivalent of the size
14948 \begin_inset Quotes eld
14956 \begin_inset Quotes erd
14962 \begin_inset space ~
14968 This is also what's used in the output.
14970 \begin_inset Quotes eld
14974 \begin_inset Quotes erd
14977 to remind you that this is a slide.
14978 Your final slides will use a larger font; ergo, you'll have less space.
14979 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
14982 \begin_layout Standard
14983 The next thing that becomes obvious is the changes to the paragraph environment
14984 pull-down box [at the far-left end of the toolbar].
14985 Most of the paragraph environments you're used to seeing are missing.
14986 There are also five new ones.
14991 class itself only supports certain paragraph environments:
14994 \begin_layout Itemize
15000 \begin_layout Itemize
15006 \begin_layout Itemize
15012 \begin_layout Itemize
15018 \begin_layout Itemize
15024 \begin_layout Itemize
15030 \begin_layout Itemize
15036 \begin_layout Itemize
15042 \begin_layout Itemize
15048 \begin_layout Itemize
15054 \begin_layout Itemize
15060 \begin_layout Standard
15061 All of the other standard environments, including the section-heading environmen
15062 ts, aren't used in the
15069 \begin_layout Standard
15070 On the other hand, you'll notice the following new environments:
15073 \begin_layout Itemize
15079 \begin_layout Itemize
15085 \begin_layout Itemize
15091 \begin_layout Itemize
15097 \begin_layout Itemize
15103 \begin_layout Standard
15104 These five are kind of quirky, due to a
15105 \begin_inset Quotes eld
15109 \begin_inset Quotes erd
15113 You see, LyX doesn't permit you to nest any other paragraph environment
15114 into an empty environment.
15115 Now, that's fine and dandy, but it means that you wouldn't be able to start
15116 a slide with anything except plain text.
15117 To deal with this, I've performed a little
15118 \begin_inset Quotes eld
15122 \begin_inset Quotes erd
15128 \begin_layout Subsubsection
15129 Quirks of the New Environments
15130 \begin_inset CommandInset label
15132 name "sec:slideQuirk"
15139 \begin_layout Standard
15140 All five of the new paragraph environments are somewhat quirky due to inherent
15141 limitiations in the current version of LyX.
15142 As I just mentioned, LyX forbids environments that begin with another environme
15144 To get around this, the
15148 environment isn't a paragraph environment as described in the
15156 \begin_layout Standard
15157 You should consider
15170 \begin_inset Quotes eld
15173 pseudo-environments.
15174 \begin_inset Quotes erd
15177 They look like a section heading or a
15178 \begin_inset Quotes eld
15186 \begin_inset Quotes erd
15189 but really begin a [and, if necessary, end the previous] paragraph environment.
15199 \begin_inset Quotes eld
15203 \begin_inset Quotes erd
15206 These two perform some action.
15209 \begin_layout Standard
15210 A common feature of all five environments,
15230 , is a rather long-ish label.
15231 The text following this label — ordinarily the contents of the paragraph
15232 environment — is utterly irrelevant for
15253 LyX completely ignores it.
15254 In fact, you can leave these five environments completely empty.
15258 \begin_layout Standard
15263 to put any text after the rather long-ish label, you might want to.
15264 This could be a short description of the contents of the
15269 In that case, enter in your descriptive comment and hit
15273 as you normally would.
15276 \begin_layout Standard
15277 If, on the other hand, you don't want to enter in any descriptive text,
15278 you'll hit another LyX quirk.
15279 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15280 environment until you put something in the old one.
15284 \begin_layout Itemize
15285 Start entering the text that will
15313 \begin_layout Itemize
15314 Now move to the beginning of that paragraph.
15318 \begin_layout Itemize
15327 \begin_layout Itemize
15328 Finally, change this new, empty paragraph to a
15352 \begin_layout Standard
15353 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15357 \begin_layout Subsection
15358 Making a Presentation with
15371 \begin_layout Subsubsection
15379 \begin_layout Standard
15380 If you're expecting this section to teach you how to actually make a presentatio
15381 n, you'll be sorely disappointed.
15382 Naturally, I'll describe all of the ways the
15386 class can assist you in preparing the materials for a presentation.
15387 Filling in the contents, however, is up to you.
15392 the LyX philosophy.]
15395 \begin_layout Standard
15400 environment [in the manner described in section
15401 \begin_inset space ~
15405 \begin_inset CommandInset ref
15407 reference "sec:slideQuirk"
15411 ] tells LyX to begin a new slide [duh].
15412 The label for this environment/
15413 \begin_inset Quotes erd
15417 \begin_inset Quotes erd
15421 \begin_inset Quotes eld
15425 \begin_inset Quotes erd
15428 in cool blue, followed by the label,
15429 \begin_inset Quotes eld
15433 \begin_inset Quotes erd
15437 Any text or paragraph environments that follow this one go on the new slide.
15441 \begin_layout Standard
15442 Slides are probably the only time you'll need to forcibly end pages in LyX
15443 (this can be specified in the
15448 In fact, you'll want to, once you finish entering the contents of one slide.
15449 If you've entered more text than can physically fit on a slide, the extra
15450 overflows onto a new slide.
15451 I don't recommend doing this, however, since the overflow slide won't have
15452 any page number on it.
15453 Furthermore, it may interfere with any
15457 you've made to accompany the oversized
15464 \begin_layout Standard
15473 environments work the same way as the
15478 They both create an
15479 \begin_inset Quotes eld
15483 \begin_inset Quotes erd
15486 followed by a label [
15487 \begin_inset Quotes eld
15491 \begin_inset Quotes erd
15495 \begin_inset Quotes eld
15499 \begin_inset Quotes erd
15503 The color is a stunning magenta instead of blue, and the
15504 \begin_inset Quotes eld
15508 \begin_inset Quotes erd
15511 will look different, in style and in length.
15512 The label fonts of all three also differ from one another.
15515 \begin_layout Standard
15520 , if the contents of a
15528 exceed the physical size of a slide or sheet of paper, the extra will overflow
15530 Again, you should avoid this.
15531 It defeats the whole purpose of
15542 \begin_layout Subsubsection
15552 \begin_layout Standard
15557 is a slide that sits atop another slide.
15558 Perhaps you wish to discuss a figure on the main
15562 before displaying the text associated with it.
15563 One way to accomplish this is tape a flap of dark paper over the part of
15568 you want to display later.
15569 This method fails, however, if you wish to overlap one graph with another,
15571 You would then have to fumble while speaking to align the two separate,
15576 s to align the two graphs.
15581 environment in both cases makes life much easier.
15584 \begin_layout Standard
15589 receives the page number of its
15590 \begin_inset Quotes eld
15594 \begin_inset Quotes erd
15602 \begin_inset Quotes eld
15610 \begin_inset Quotes erd
15617 \begin_layout Plain Layout
15618 Presumably, mutliple
15623 \begin_inset Quotes eld
15631 \begin_inset Quotes erd
15635 \begin_inset Quotes eld
15643 \begin_inset Quotes erd
15647 \begin_inset Quotes eld
15655 \begin_inset Quotes erd
15659 \begin_inset space ~
15662 appended to the page number of the parent
15672 Clearly, you want the contents of both the
15680 to each fit on a single physical slide! You should probably consider an
15686 \begin_inset Quotes eld
15690 \begin_inset Quotes erd
15702 class provides a visual cue for this: the label at the start of an
15706 is shorter than that at the start of a
15711 Lastly, when you generate printable output, you'll find alignment markers
15712 in all four corners of both the
15716 page and its parent
15721 These will assist you in lining up the two physical slides.
15724 \begin_layout Standard
15725 The major problem in overlaying two slides is aligning the contents of the
15726 two transparencies.
15727 How much space should you leave for that graph on the second slide? Worse
15728 still, what if you want a graph and a sentence on second slide, but there
15729 is text on the main transparency that goes in between them? You could try
15730 and insert vertical space of the right size.
15731 The better way is to use
15742 \begin_layout Standard
15743 As their names imply,
15751 are two command-like paragraph environments that make all subsequent text
15752 invisible and visible, respectively.
15754 \begin_inset space ~
15758 \begin_inset CommandInset ref
15760 reference "sec:slideQuirk"
15764 that you don't place anything
15768 these two environments, however.
15773 , it inserts a centered, sky-blue label into the page reading
15774 \begin_inset Quotes eld
15777 <Invisible Text Follows>
15778 \begin_inset Quotes erd
15782 For paragraphs following this label, the parts of the
15790 ; it doesn't matter which] where they would be contain instead blank space.
15794 \begin_layout Standard
15799 , the corresponding centered label is
15800 \begin_inset Quotes eld
15803 <Visible Text Follows>
15804 \begin_inset Quotes erd
15808 Paragraphs following this label behave normally.
15809 Note that the beginning of a new
15821 automatically shuts off an
15826 It's therefore not necessary to use
15837 \begin_layout Standard
15838 By now, it should be obvious how to create overlay transparencies using
15839 the proper combination of
15858 \begin_layout Enumerate
15863 , including everything that will appear on it, whether on the main slide
15871 \begin_layout Enumerate
15872 Before each figure or paragraph that will appear only on the
15881 If necessary, insert a
15885 environment after the
15892 \begin_layout Enumerate
15897 immediately following the
15904 \begin_layout Enumerate
15905 Copy the contents of this
15916 \begin_layout Enumerate
15921 , change all of the
15932 \begin_layout Standard
15934 You've just made an
15941 \begin_layout Standard
15942 There's one problem with the way I've designed the LyX
15946 class: you can't make text in the middle of a paragraph invisible, nor
15947 make text in the middle of an invisible paragraph visible again.
15948 To accomplish this feat, you'll need to use some inlined LaTeX codes.
15952 \begin_layout Plain Layout
15953 The commands of interest are:
15956 \begin_layout Itemize
15961 invisible \SpecialChar \ldots{}
15965 \begin_layout Itemize
15970 visible \SpecialChar \ldots{}
15974 \begin_layout Plain Layout
15975 \SpecialChar \ldots{}
15976 and need to be marked as TeX.
15978 \begin_inset Quotes eld
15982 \begin_inset Quotes erd
15985 you wish to change goes in between the brackets [and after the
15998 If you don't know how to mark text as TeX, see the appropriate section
16011 \begin_layout Subsubsection
16021 \begin_inset CommandInset label
16023 name "sec:slideNote"
16030 \begin_layout Standard
16039 is associated with a
16040 \begin_inset Quotes eld
16044 \begin_inset Quotes erd
16056 class provides visual cues.
16061 is shorter than that of a
16065 [yet longer than that of an
16069 ] and, like the label of an
16073 is shockingly magenta.
16074 Additionally, the printed
16078 has the page number of its
16079 \begin_inset Quotes eld
16083 \begin_inset Quotes erd
16091 \begin_inset Quotes eld
16099 \begin_inset Quotes erd
16103 \begin_inset Quotes eld
16111 \begin_inset Quotes erd
16115 \begin_inset Quotes eld
16123 \begin_inset Quotes erd
16127 You can have multiple
16131 s associated with a single
16143 , you'll probably want to break up long
16147 s so that they fit on a single sheet of paper.
16150 \begin_layout Standard
16155 is obvious: it contains anything additional you might want to say about
16161 It could also be used as a sheet of reminders for a particular
16166 In the case of the latter, you might want to make use of time markers.
16172 \begin_inset Quotes eld
16176 \begin_inset Quotes erd
16179 support for time markers, a
16184 So, you'll have to resort to using the LaTeX codes.
16187 \begin_layout Standard
16188 To use time markers, you'll need to specify the extra class option
16189 \begin_inset Quotes eld
16197 \begin_inset Quotes erd
16201 \begin_inset space ~
16205 \begin_inset CommandInset ref
16207 reference "sec:slidesetup"
16212 This option turns on timing marks, which will appear in the lower-left-hand
16218 To set what appears in the time marker, you use the LaTeX commands
16219 \begin_inset Quotes eld
16229 \begin_inset Quotes erd
16233 \begin_inset Quotes eld
16243 \begin_inset Quotes erd
16247 The arguments of both commands are time measured in seconds.
16249 \begin_inset Quotes eld
16259 \begin_inset Quotes erd
16262 sets the time marker to a given time.
16264 \begin_inset Quotes eld
16274 \begin_inset Quotes erd
16277 increments the time marker by the specified amount.
16278 Using time markers and
16282 s in this fashion, you can remind yourself how much time to spend on a particula
16290 \begin_layout Standard
16291 There's one last feature to describe.
16292 Clearly, you'd like to print out all of your
16300 s on transparencies while printing all of your
16317 with which it is associated.
16318 What's a person to do?
16321 \begin_layout Standard
16322 Luckily, there are two LaTeX commands that allow you to select what to print
16324 Both must be placed into the preamble of your document.
16326 \begin_inset Quotes eld
16338 \begin_inset Quotes erd
16341 will cause the output to contain only the
16350 Correspondingly, the command
16351 \begin_inset Quotes eld
16363 \begin_inset Quotes erd
16366 prevents the output of anything but
16371 I'd advise placing both commands in the preamble and initially comment
16373 You can then preview your entire presentation as you write.
16374 When you're done writing, you can then uncomment one of the two to select
16375 what you want to print.
16376 I like to uncomment
16377 \begin_inset Quotes eld
16389 \begin_inset Quotes erd
16392 , print to a file with
16393 \begin_inset Quotes eld
16401 \begin_inset Quotes erd
16404 in its name, comment it back out, then uncomment
16405 \begin_inset Quotes eld
16417 \begin_inset Quotes erd
16421 \begin_inset Quotes eld
16429 \begin_inset Quotes erd
16433 I can then send either file to a printer, loading transparencies or plain
16434 paper as appropriate.
16437 \begin_layout Standard
16438 You can also provide other arguments to the
16439 \begin_inset Quotes eld
16449 \begin_inset Quotes erd
16453 \begin_inset Quotes eld
16463 \begin_inset Quotes erd
16467 See a good LaTeX book for details.
16470 \begin_layout Subsection
16475 Class Template File
16478 \begin_layout Standard
16479 I have also provided a template file,
16480 \begin_inset Quotes eld
16488 \begin_inset Quotes erd
16496 To use it, begin your new presentation with
16501 ile\SpecialChar \menuseparator
16503 \begin_inset space ~
16507 \begin_inset space ~
16517 Your new LyX presentation file will contain an example
16538 additionally contain an example of the use of
16547 Lastly, the preamble will contain:
16550 \begin_layout LyX-Code
16551 % Uncomment to print out only slides and overlays
16554 \begin_layout LyX-Code
16558 \begin_layout LyX-Code
16564 \begin_inset Newline newline
16570 \begin_layout LyX-Code
16571 % Uncomment to print out only notes
16574 \begin_layout LyX-Code
16578 \begin_layout LyX-Code
16586 \begin_layout Standard
16587 One final thing: I created this class to support the LaTeX2e
16588 \begin_inset Quotes eld
16596 \begin_inset Quotes erd
16599 class, one of the built-in LaTeX2e classes.
16600 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16601 built-in slide class.
16602 It's here if you want it or need it.
16603 There exist other LaTeX2e classes for creating presentations, such as the
16609 \begin_inset space ~
16613 \begin_inset CommandInset ref
16615 reference "sec:foiltex"
16620 \begin_inset Quotes eld
16628 \begin_inset Quotes erd
16631 package [present on some TeX distributions].
16632 The latter is not yet supported under LyX.
16636 \begin_layout Plain Layout
16637 Perhaps you can take on the task\SpecialChar \ldots{}
16643 I know nothing about these other classes.
16644 Try them out to see what sort of alternative they provide.
16647 \begin_layout Chapter
16648 LyX Features needing Extra Software
16651 \begin_layout Section
16655 \begin_layout Standard
16661 \begin_layout Subsection
16665 \begin_layout Standard
16674 \begin_layout Plain Layout
16679 is not yet available when you are using the LaTeX distribution MiKTeX.
16684 , you'll find in the
16691 \begin_inset space ~
16702 \begin_inset CommandInset href
16704 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16711 \begin_layout Standard
16716 package is a program that was written by
16717 \begin_inset Flex CharStyle:Noun
16720 \begin_layout Plain Layout
16722 \begin_inset space ~
16730 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16731 and easy to forget.
16732 The program runs over your LaTeX file, checks the integrity of the file,
16733 and flags some common errors.
16734 In other technical words, it is
16741 \begin_layout Standard
16742 Well, what is a syntax checker doing in LyX which is supposed to produce
16743 correct LaTeX anyways? The answer is simple: Just as
16747 not only checks the
16751 of C programs, but also does
16755 checks for type-errors,
16759 catches some common
16763 errors, in addition to the syntactical ones.
16768 is capable of detecting several common errors, such as
16771 \begin_layout Itemize
16772 Ellipsis detection:
16773 \begin_inset Newline newline
16776 Use \SpecialChar \ldots{}
16780 \begin_layout Itemize
16781 No space in front of/after parenthesis:
16782 \begin_inset Newline newline
16788 \begin_layout Itemize
16789 Enforcement of normal space after common abbreviations:
16790 \begin_inset Newline newline
16794 \begin_inset space \thinspace{}
16798 \begin_inset space \space{}
16801 is too wide spacing.
16804 \begin_layout Itemize
16805 Enforcement of end-of-sentence space when the last sentence ends with a
16807 \begin_inset Newline newline
16811 And this is wrong spacing.
16814 \begin_layout Itemize
16815 Space in front of labels and similar commands:
16816 \begin_inset Newline newline
16819 The label should stick right up to the text to avoid falling to a wrong
16822 \begin_inset CommandInset label
16832 \begin_layout Plain Layout
16833 This footnote is in danger of falling off to a wrong page
16838 The label is separated too much.
16841 \begin_layout Itemize
16842 Space in front of references, instead of hard spaces:
16843 \begin_inset Newline newline
16846 In you are in bad luck, the text will break right between the referenced
16847 text and reference number, and that's a pity.
16849 \begin_inset CommandInset ref
16851 reference "sec:chktex"
16858 \begin_layout Itemize
16860 \begin_inset Quotes eld
16864 \begin_inset Quotes erd
16868 \begin_inset Formula $\times$
16872 \begin_inset Newline newline
16875 2x2 looks cheap compared to
16876 \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$
18636 \begin_inset Formula $Rev:59$
18639 in your LyX document.
18640 Similarly for other keywords like Id, Date, Author, etc.
18641 Secondly svn output is dependent on your locales, so its very easy that
18642 svn would produce some problematic strings once Date is used.
18643 Thirdly you get the whole 'Rev: 59' string in your document instead of
18645 Until subversion implements user's custom keywords it will be hard to use
18646 this approach reliably or let LyX to support it directly .
18649 \begin_layout Standard
18650 The second possibility would be to write your own external-material template
18652 \begin_inset Flex CharStyle:Code
18655 \begin_layout Plain Layout
18661 utility or parses the output of
18662 \begin_inset Flex CharStyle:Code
18665 \begin_layout Plain Layout
18671 command and returns the result back, when typeseting the document.
18674 \begin_layout Subsection
18675 SVN and Windows Environment
18678 \begin_layout Quote
18679 My inclination is to say that if the user cannot figure out the command
18680 line operations on their own fairly quickly, they would be well advised
18681 to use TortoiseSVN.
18687 \begin_layout Subsubsection
18691 \begin_layout Standard
18692 In addition to installing LyX, and having access to a Subversion repository,
18693 the user will need to install the Subversion client program.
18694 A Windows installer for the client program is available from
18695 \begin_inset CommandInset href
18698 target "http://www.collab.net/nonav/downloads/subversion/"
18703 The user may also want to install
18704 \begin_inset CommandInset href
18707 target "http://tortoisesvn.tigris.org/"
18711 , which integrates Subversion operations into the context (rightclick) menu
18712 of Windows Explorer.
18713 Operations done outside LyX will typically be more convenient using the
18714 Explorer context menu.
18715 Note that TortoiseSVN is not a replacement for the client program, which
18716 is what LyX itself will use.
18719 \begin_layout Subsubsection
18720 Bringing a document under Subversion control
18723 \begin_layout Standard
18724 Before a LyX document can be brought under version control in Subversion,
18725 its parent directory needs to be under version control.
18726 If the document is being added to a project already in the repository,
18727 this is accomplished by checking the project out to the directory where
18728 the new document will be placed.
18729 If the project itself is not yet under version control (for instance, if
18730 this document starts a new project), the directory must be imported into
18732 This is done outside LyX.
18733 Both import and checkout are easily accomplished from the Explorer context
18734 menu using TortoiseSVN, or alternatively can be done using the command
18735 line client at a DOS prompt.
18736 The procedure for importing the project using TortoiseSVN is described
18737 below, assuming an existing repository and a new project being started
18745 For information on using the Subversion client program, run
18752 \begin_layout Enumerate
18759 in Windows Explorer, right click it, and select
18761 TortoiseSVN > Repo-browser
18764 If necessary, adjust the URL for the repository, then click OK.
18767 \begin_layout Enumerate
18768 Right click the level of the repository under which you want to place the
18769 new project folder (typically the top level) and click
18771 Create folder\SpecialChar \ldots{}
18774 Supply a name for the project folder and click OK.
18775 Add a message for the log file if desired, then click OK again.
18776 The new project folder should appear in the repository.
18777 Finally, click OK again to exit the repository browser.
18780 \begin_layout Enumerate
18781 Once again right click
18787 , this time selecting SVN Checkout\SpecialChar \ldots{}
18788 Select the URL of the project folder
18789 you just created in the repository, and set the checkout directory to
18797 You will be warned about a non-empty folder; click OK to proceed.
18798 You should now have a
18809 \begin_layout Enumerate
18810 Create or open your document in LyX and click
18815 ile\SpecialChar \menuseparator
18821 \begin_inset space ~
18824 Control\SpecialChar \menuseparator
18832 Add a log message and click OK to commit the document to version control.
18835 \begin_layout Standard
18836 From this point onward, you should have full functionality in the
18841 ile\SpecialChar \menuseparator
18847 \begin_inset space ~
18853 You also have the option of checking the document in and out, viewing its
18855 using the TortoiseSVN context menu in Windows Explorer or the Subversion
18856 client program from a command prompt.
18859 \begin_layout Subsection
18863 \begin_layout Standard
18864 With the recent addition of the vc-command function LyX power users are
18865 allowed to create their own commands for revision control.
18868 \begin_layout Standard
18869 As an example you can see how two TortoiseSVN commands could be integrated
18873 \begin_layout Description
18875 \begin_inset Flex CharStyle:Code
18878 \begin_layout Plain Layout
18879 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
18887 \begin_layout Description
18889 \begin_inset Flex CharStyle:Code
18892 \begin_layout Plain Layout
18893 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
18901 \begin_layout Section
18902 Literate Programming
18905 \begin_layout Standard
18910 (kayvan@sylvan.com)
18914 original documentation written by
18916 Edmar Wienskoski Jr.
18919 (edmar-w-jr@technologist.com)
18922 \begin_layout Subsection
18926 \begin_layout Standard
18927 The main purpose of this documentation is to show you how to use LyX for
18928 literate programming.
18929 Where it is assumed that you are familiar with this programming technique,
18931 \begin_inset Quotes eld
18935 \begin_inset Quotes erd
18939 \begin_inset Quotes eld
18943 \begin_inset Quotes erd
18947 If that is not the case, please follow the web links provided in the following
18949 There is a lot of good documentation out there covering old development
18950 history to the latest tools tips.
18953 \begin_layout Standard
18954 It is also assumed that you are familiar with LyX itself to a point that
18955 you are comfortable changing your LyX preferences, and X resources file.
18956 If that is not the case please refer to other LyX documentation to cover
18957 your specific needs.
18960 \begin_layout Subsection
18961 Literate Programming
18964 \begin_layout Standard
18965 From the Literate Programming FAQ:
18968 \begin_layout Quotation
18969 Literate programming is the combination of documentation and source together
18970 in a fashion suited for reading by human beings.
18971 In fact, literate programs should be enjoyable reading, even inviting!
18972 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
18973 and documentation in a single file.
18974 Literate programming tools then parse the file to produce either readable
18975 documentation or compilable source.
18976 The WEB style of literate programming was created by D.
18977 \begin_inset space \thinspace{}
18981 Knuth during the development of his TeX typesetting software.
18985 \begin_layout Standard
18986 Another excerpt says:
18989 \begin_layout Quotation
18992 How is literate programming different from verbose commenting?
18995 \begin_layout Quotation
18996 There are three distinguishing characteristics.
18997 In order of importance, they are:
19001 \begin_layout Itemize
19002 flexible order of elaboration
19005 \begin_layout Itemize
19006 automatic support for browsing
19009 \begin_layout Itemize
19010 typeset documentation, especially diagrams and mathematics
19014 \begin_layout Standard
19015 Now that I sparked your curiosity, take a look in the references.
19018 \begin_layout Subsubsection
19022 \begin_layout Standard
19023 The complete Literate Programming FAQ can be found at:
19026 \begin_layout Quote
19027 Literate Programming FAQ
19028 \begin_inset Flex URL
19031 \begin_layout Plain Layout
19033 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
19041 \begin_layout Standard
19042 The FAQ lists 23 (twenty three!) different literate programming tools.
19043 Where some are specialized or
19044 \begin_inset Quotes eld
19048 \begin_inset Quotes erd
19051 for particular programming languages, while other have general scope.
19056 for my own use for several reasons:
19059 \begin_layout Itemize
19060 It can generate the documentation either in LaTeX or HTML.
19063 \begin_layout Itemize
19064 It has a open architecture, i.
19065 \begin_inset space \thinspace{}
19069 \begin_inset space \space{}
19072 it is easy to plug in new filters and to perform special processing that
19077 \begin_layout Itemize
19078 There is a good selection of filters available already (the HTML is one
19082 \begin_layout Itemize
19086 \begin_layout Standard
19087 The Noweb web page can be found at:
19090 \begin_layout Quote
19092 \begin_inset Flex URL
19095 \begin_layout Plain Layout
19097 http://www.cs.virginia.edu/~nr/noweb/
19105 \begin_layout Standard
19106 Starting from there you can reach many other interesting links and even
19107 some literate program examples.
19110 \begin_layout Subsection
19111 LyX and Literate Programming
19114 \begin_layout Standard
19115 The LyX support for Literate Programming is provided by using the generic
19116 LyX converters mechanism.
19117 This support is provided in a
19118 \begin_inset Quotes eld
19122 \begin_inset Quotes erd
19126 \begin_inset space \thinspace{}
19130 \begin_inset space \space{}
19133 you will be able to use this new LyX feature with some other literate programmin
19134 g tool of your choice by just changing your LyX preferences.
19137 \begin_layout Subsubsection
19138 Generating documents and code (weaving and tangling)
19141 \begin_layout Paragraph
19142 Selecting the document class
19145 \begin_layout Standard
19146 If you have installed Noweb and LyX successfully, whenever you open a new
19147 document or try to change the document class of an existing one, you will
19148 find that there are three new document classes available:
19151 \begin_layout Itemize
19155 \begin_layout Itemize
19159 \begin_layout Itemize
19163 \begin_layout Standard
19164 You must select one of them to create your literate documents from.
19168 \begin_layout Standard
19169 Note that literate documents are not limited to these three classes.
19170 New classes can be generated from other styles like letter or in combination
19171 with other class variations like Article (AMS).
19172 If you have special needs that cannot be covered by one of the existing
19173 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
19174 will arrange to insert a new entry, or teach you how to do it.
19178 \begin_layout Plain Layout
19179 It is very simple, it involves the creation of a file with four lines, and
19180 re-running of the auto configuration.
19185 Moreover, if you use a literate tool other than Noweb you may need to create
19186 a new set of document classes for it.
19189 \begin_layout Paragraph
19193 \begin_layout Standard
19194 LyX enables you to write code with a layout named
19202 \begin_layout Plain Layout
19203 The equivalent Noweb term is
19204 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19212 For historical reasons, I got used to the term
19213 \begin_inset Quotes eld
19217 \begin_inset Quotes erd
19220 introduced by other literate tool named Nuweb, which I used for many years
19221 before rendering myself to Noweb.
19226 Noweb delimits scraps like this:
19229 \begin_layout LyX-Code
19233 \begin_layout LyX-Code
19237 \begin_layout LyX-Code
19241 \begin_layout LyX-Code
19245 \begin_layout LyX-Code
19249 \begin_layout Standard
19250 The problem is that whatever is written in between the << and the
19254 must be taken literally, i.
19255 \begin_inset space \thinspace{}
19259 \begin_inset space \space{}
19262 LyX should be prevented from making any special interpretation of what has
19264 This is handled by a special layout named Scrap, that works like a normal
19265 paragraph but has a free spacing capability.
19268 \begin_layout Standard
19269 The down side of the Scrap paragraph layout is that consecutive paragraphs
19270 of code will be spaced with one empty line in the source code and also
19271 in the printed documentation.
19272 The work around is to enter each line of code within a single Scrap, with
19273 a newline (ctrl-return).
19274 The example above will look like this:
19278 \begin_layout Plain Layout
19279 If you have a printed version of this document you will not see any difference
19280 between the previous example and this one.
19288 \begin_layout LyX-Code
19290 \begin_inset Newline newline
19294 \begin_inset Newline newline
19298 \begin_inset Newline newline
19302 \begin_inset Newline newline
19308 \begin_layout Standard
19309 This layout works fine.
19310 The only real inconvenience is that you have to type ctrl-return instead
19315 \begin_layout Plain Layout
19316 It is in my list of
19317 \begin_inset Quotes eld
19321 \begin_inset Quotes erd
19332 \begin_layout Standard
19333 As a special note, you can also use the
19334 \begin_inset Quotes eld
19338 \begin_inset Quotes erd
19341 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
19345 \begin_layout LyX-Code
19347 \begin_inset Newline newline
19350 def some_function(args):
19351 \begin_inset Newline newline
19354 "This is the doc string for this function."
19355 \begin_inset Newline newline
19358 print "My args: ", args
19361 \begin_layout LyX-Code
19362 @ %def some_function
19365 \begin_layout Standard
19366 For an example of this usage and the resulting cross-reference output, look
19367 at the Literate python program in
19369 LIBDIR/examples/listerrors.lyx
19371 which should make this all clear.
19374 \begin_layout Paragraph
19375 Generating the documentation
19378 \begin_layout Standard
19379 At this point you already have a new document file with a proper document
19380 class, and with some code and text on it.
19381 How do I print it? The answer is simple, you select
19383 View\SpecialChar \menuseparator
19387 Just like you would do for a plain document.
19388 No special procedure is required.
19391 \begin_layout Standard
19392 To help orientate you, I will now explain what happens inside LyX:
19395 \begin_layout Enumerate
19398 Update\SpecialChar \menuseparator
19401 menu option is chosen, a LaTeX file is generated.
19406 \begin_layout Standard
19407 If the document is of any literate class the generated file will be named
19408 with an extension name defined by the
19409 \begin_inset Quotes eld
19413 \begin_inset Quotes erd
19416 format (defined in the Preferences panel), otherwise the file will have
19425 \begin_layout Enumerate
19426 Note that the only difference so far is in the name of the file, no special
19427 processing is required by LyX.
19428 Given that you formatted the code using the Scrap layout that, by itself,
19429 takes care of the business.
19432 \begin_layout Enumerate
19433 If the document is of any literate class LyX will then use the internal
19434 LyX to Noweb converter, followed by the Noweb to LaTeX converter
19438 \begin_layout Plain Layout
19439 The converters are defined in the
19441 Tools\SpecialChar \menuseparator
19445 \begin_inset Quotes eld
19449 \begin_inset Quotes erd
19461 manual for general information about converters.
19466 to generate the LaTeX file.
19470 \begin_layout Standard
19471 Otherwise it will just skip this step.
19475 \begin_layout Enumerate
19476 Finally, LaTeX is invoked and the regular post processing continues as in
19480 \begin_layout Standard
19481 Independence from a particular
19482 \begin_inset Quotes eld
19486 \begin_inset Quotes erd
19489 is easily achieved by changing the commands that are run by the various
19493 \begin_layout Paragraph
19494 Generating the code
19497 \begin_layout Standard
19498 When the build menu option is chosen or the corresponding button in the
19499 toolbar is pressed, a LaTeX file is generated just like step 1 above.
19500 Next, LyX invokes the
19505 This converter needs to be defined by the user and is not installed by
19506 default, though the Program format is.
19507 This converter (like any other converter) will have two parts:
19510 \begin_layout Enumerate
19511 The converter program itself.
19512 This program performs the conversion from the one format to the other (in
19513 this case, from the Noweb format to the Program pseudo-format).
19516 \begin_layout Enumerate
19517 The error log parser.
19518 This is a program whose sole purpose is to rewrite error messages in a
19519 format that LyX understands.
19520 This makes it possible for LyX to place error boxes in the right places
19521 in the file buffer.
19524 \begin_layout Standard
19525 The first part, the
19526 \begin_inset Quotes eld
19530 \begin_inset Quotes erd
19533 setting, should be set to
19534 \begin_inset Quotes eld
19542 \begin_inset Quotes erd
19546 This basically means that LyX will call
19547 \begin_inset Quotes eld
19551 \begin_inset Quotes erd
19554 (a program or script) with the name of the Noweb file (normally a file
19555 in the LyX temp directory).
19559 \begin_layout Standard
19560 This is an implementation of
19561 \begin_inset Quotes eld
19565 \begin_inset Quotes erd
19568 that you can place in a directory on your path:
19571 \begin_layout LyX-Code
19575 \begin_layout LyX-Code
19579 \begin_layout LyX-Code
19580 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19583 \begin_layout Standard
19584 The next part of the converter setting is the
19585 \begin_inset Quotes eld
19589 \begin_inset Quotes erd
19592 which is to be set to
19593 \begin_inset Quotes eld
19598 parselog=listerrors
19601 \begin_inset Quotes erd
19605 This will run any errors that are generated by the
19606 \begin_inset Quotes eld
19610 \begin_inset Quotes erd
19613 process through the
19614 \begin_inset Quotes eld
19618 \begin_inset Quotes erd
19624 \begin_layout Standard
19625 The converter code looks in
19633 then on the path for the
19634 \begin_inset Quotes eld
19638 \begin_inset Quotes erd
19644 \begin_layout Standard
19645 The build will normally take place in LyX's temporary directory, so the
19646 files produced by the conversion will be in that directory.
19647 LyX will copy out what it regards as the `main' file, but the
19651 conversion may produce several files, and so most of these would then be
19652 deleted when LyX was closed.
19653 The present solution is to use a `copier',
19657 \begin_layout Plain Layout
19666 manual for information on these.
19675 script in its default mode, so that the entire contents of the temporary
19676 directory is copied.
19677 More will get copied than is needed, to be sure, but nothing will be lost.
19678 If, however, you know what extensions the generated files will have, this
19679 can be improved by using the
19688 This option takes a comma-separated list of extensions to copy.
19689 So, for example, if the conversion will generate only files with the extensions
19698 , then the correct definition would be:
19701 \begin_layout LyX-Code
19702 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19705 \begin_layout Standard
19706 The result will be that only files with these two extensions will be copied
19710 \begin_layout Paragraph
19711 Build instructions in the document
19714 \begin_layout Standard
19715 The last piece of the integration between LyX and noweb is the
19716 \begin_inset Quotes eld
19720 \begin_inset Quotes erd
19724 Generally, the instructions for building your program should be embedded
19725 in a scrap of its own.
19727 \begin_inset Quotes eld
19731 \begin_inset Quotes erd
19734 above uses the notangle command to look for this scrap (called
19735 \begin_inset Quotes eld
19739 \begin_inset Quotes erd
19742 ) and runs its contents through
19743 \begin_inset Quotes eld
19747 \begin_inset Quotes erd
19753 \begin_layout Standard
19754 Typically, such a scrap would look something like this:
19757 \begin_layout LyX-Code
19759 \begin_inset Newline newline
19763 \begin_inset Newline newline
19767 \begin_inset Newline newline
19770 if [ -z "${NOWEB_SOURCE}" ]
19771 \begin_inset Newline newline
19775 \begin_inset Newline newline
19778 NOWEB_SOURCE=myfile.nw
19779 \begin_inset Newline newline
19783 \begin_inset Newline newline
19787 code to extract files ...]
19788 \begin_inset Newline newline
19792 code to compile files ...]
19793 \begin_inset Newline newline
19799 \begin_layout Standard
19802 LIBDIR/examples/listerrors.lyx
19806 LIBDIR/examples/Literate.lyx
19808 which implement two versions of the
19809 \begin_inset Quotes eld
19813 \begin_inset Quotes erd
19816 program for some illustrations of how all of these pieces go together or
19819 LIBDIR/examples/noweb2lyx.lyx.
19822 Interestingly, these three files show off the language-indepence of the
19823 LyX literate programming support since they are written in Python, C and
19827 \begin_layout Subsubsection
19831 \begin_layout Standard
19832 All the Literate Programming support is configured by the
19834 Tools\SpecialChar \menuseparator
19838 \begin_inset Quotes eld
19842 \begin_inset Quotes erd
19846 The important parts are:
19849 \begin_layout Description
19851 \begin_inset space ~
19855 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19863 \begin_inset space ~
19866 format Set up via the Formats tab, this is where the Noweb-specific pieces
19876 , the file extension is set to
19881 This tells LyX to create a file with a
19885 extension in the first step of the conversion process.
19888 \begin_layout Description
19890 \begin_inset space ~
19898 \begin_inset space ~
19901 format This is an empty format whose sole purpose is to be the endpoint
19902 of a conversion (which then allows us to set up a converter for it).
19905 \begin_layout Description
19914 This converter performs the
19915 \begin_inset Quotes eld
19919 \begin_inset Quotes erd
19922 of the literate document.
19923 For Noweb, it is set to
19924 \begin_inset Quotes eld
19929 noweave -delay -index $$i > $$o
19932 \begin_inset Quotes erd
19938 \begin_layout Description
19948 \begin_inset Quotes eld
19952 \begin_inset Quotes erd
19956 As stated above, the Converter is set to
19957 \begin_inset Quotes eld
19965 \begin_inset Quotes erd
19968 , with Flags set to
19969 \begin_inset Quotes eld
19974 originaldir,parselog=listerrors
19977 \begin_inset Quotes erd
19983 \begin_layout Subsubsection
19987 \begin_layout Standard
19988 There is also a new function implemented in the LyX server, the
19989 \begin_inset Quotes eld
19992 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
19996 \begin_layout Standard
19997 When debugging code with ddd/gdb, it is possible to invoke a text editor
19998 at the current execution position with a single key stroke.
19999 The default ddd configuration for that is shift-ctrl-V.
20000 It happens that you can define the editor command line invocation in ddd
20003 Edit\SpecialChar \menuseparator
20004 Preferences\SpecialChar \menuseparator
20007 dialog and changing the "Edit Sources" entry.
20010 \begin_layout Standard
20011 I take advantage of the new created LyX server function and this ddd feature,
20013 \begin_inset Quotes eld
20017 \begin_inset Quotes erd
20023 \begin_layout LyX-Code
20024 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20027 \begin_layout Standard
20028 With this, whenever you are using ddd and find a point in the program that
20029 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20030 ddd you forward this information to LyX through the LyX server and then
20031 the LyX window will show the same file with the cursor at the same position
20032 ddd was pointing to.
20033 No more guessing or long scrolling to locate a point in the program back
20037 \begin_layout Standard
20038 Note however that you must enable the LyX server to get this feature working
20039 (it is disabled by default).
20040 You can enable it in
20052 ) by entering in the
20057 \begin_inset Quotes eld
20062 /home/<your-home-directory>/.lyx/lyxpipe
20065 \begin_inset Quotes erd
20071 \begin_layout Standard
20072 Read the LyX server documentation in the
20074 Customization Manual
20076 for further information.
20079 \begin_layout Subsubsection
20083 \begin_layout Standard
20084 There are six new buttons that can be added to your LyX toolbar.
20085 Five of these buttons are short cuts to layout styles:
20106 The last one is a short cut to the
20107 \begin_inset Quotes eld
20111 \begin_inset Quotes erd
20118 \begin_layout Standard
20119 LyX has a range of buttons that are available for tool bar customization.
20120 In my toolbar I like to combine the six short cuts above with two more:
20125 \SpecialChar \menuseparator
20130 \SpecialChar \menuseparator
20137 View\SpecialChar \menuseparator
20141 Here is how it looks like:
20144 \begin_layout LyX-Code
20148 \begin_layout LyX-Code
20152 \begin_layout LyX-Code
20153 Icon "layout Standard"
20156 \begin_layout LyX-Code
20157 Icon "layout Section"
20160 \begin_layout LyX-Code
20161 Icon "layout LaTeX"
20164 \begin_layout LyX-Code
20165 Icon "layout LyX-Code"
20168 \begin_layout LyX-Code
20169 Icon "layout Scrap"
20172 \begin_layout LyX-Code
20176 \begin_layout LyX-Code
20180 \begin_layout LyX-Code
20181 Icon "buffer-typeset"
20184 \begin_layout LyX-Code
20185 Icon "build-program"
20188 \begin_layout LyX-Code
20192 \begin_layout LyX-Code
20196 \begin_layout LyX-Code
20200 \begin_layout LyX-Code
20204 \begin_layout LyX-Code
20208 \begin_layout Subsubsection
20209 Colors customization
20212 \begin_layout Standard
20213 There are a number of colors in LyX that can be customized in
20218 One of the things that bothers people is the LaTeX font color.
20219 The default color is red, since the scraps uses LaTeX font, and there is
20220 a lot of scraps in literate documents, you may get tired of seeing everything
20222 You can change it by going to the tabs
20231 \begin_layout Standard
20232 The next thing is the visible presence of the newline character in the screen.
20233 You can choose the color of this particular character and make it blend
20235 I recommend you choosing a color that is close to the background but not
20236 equal, that way you still can see it is there, but it is not bothering
20241 \begin_layout Chapter
20242 Secrets of the LaTeX Masters
20243 \begin_inset CommandInset label
20252 \begin_layout Standard
20253 Though LyX is a powerful tool, it cannot hope to support everything that
20254 can be done with pure TeX/LaTeX.
20255 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
20256 as long as you are not afraid to use that
20257 \begin_inset Quotes eld
20261 \begin_inset Quotes erd
20264 button on the toolbar or add things to the LaTeX preamble.
20265 This section lists some tips, tricks, and otherwise cool ideas to give
20266 your document that extra little flair.
20269 Do try this at home
20271 , just start with something a little smaller and less important than your
20275 \begin_layout Standard
20276 Most ideas in this section require less common files in your LaTeX installation.
20277 If you have a system like teTeX, most will already be available.
20278 A few, however, will need to be downloaded from one of the CTAN archives.
20279 Often, there are several ways to do something, or several LaTeX style files
20280 which do the same thing.
20281 We do not endorse one choice over another, we simply claim that we have
20282 done a particular task with a particular file.
20283 Put on your wizard hat, keep an eye out for dragons, and let us begin.
20286 \begin_layout Section
20290 \begin_layout Standard
20293 Lars Gullik Bjønnes
20296 \begin_layout Subsection
20300 \begin_layout Standard
20301 The aim for this chapter
20305 \begin_layout Plain Layout
20306 Editor's note: Lars' original chapter was a masterful description of how
20312 However, it was too long to flow smoothly in this document.
20313 I have therefore chosen to excerpt the most important sections here (sorry,
20314 Lars); you can read the original chapter (and more of the story!) in the
20317 examples/multicol.lyx
20325 is to show how the LaTeX package
20329 can be used in a LyX document.
20330 As LyX doesn't support the
20334 package natively yet, we have to use some small hacks.
20335 By reading this section it should be obvious how to do this.
20338 \begin_layout Subsection
20342 \begin_layout Standard
20347 package allows switching between one and multicolumn format on the same
20349 Footnotes are handled correctly (for the most part), but will be placed
20350 at the bottom of the page and not under each column.
20351 LaTeX's float mechanism, however, is partly disabled in the current implementat
20353 At the moment only page-wide floats can be used within the scope of the
20357 \begin_layout Subsection
20361 \begin_layout Subsubsection
20365 \begin_layout Standard
20366 If you want to have two columns in your text, you have use LaTeX mode to
20371 begin{multicols}{2}
20373 at the point where you want the two column layout to start, and then
20379 where you want it to end.
20383 \begin_layout Standard
20387 \begin_layout Plain Layout
20391 begin{multicols}{2}
20399 \begin_layout Standard
20404 The Adventure of the Empty House
20407 \begin_inset Newline newline
20412 Sir Arthur Conan Doyle
20415 \begin_layout Standard
20418 It was in the spring of the year 1894 that all London was interested, and
20419 the fashionable world dismayed, by the murder of the Honourable Ronald
20420 Adair under most unusual and inexplicable circumstances.
20421 The public has already learned those particulars of the crime which came
20422 out in the police investigation, but a good deal was suppressed upon that
20423 occasion, since the case for the prosecution was so overwhelmingly strong
20424 that it was not necessary to bring forward all the facts.
20425 Only now, at the end of nearly ten years, am I allowed to supply those
20426 missing links which make up the whole of that remarkable chain.
20427 The crime was of interest in itself, but that interest was as nothing to
20428 me compared to the inconceivable sequel, which afforded me the greatest
20429 shock and surprise of any event in my adventurous life.
20430 Even now, after this long interval, I find myself thrilling as I think
20431 of it, and feeling once more that sudden flood of joy, amazement, and increduli
20432 ty which utterly submerged my mind.
20433 Let me say to that public, which has shown some interest in those glimpses
20434 which I have occasionally given them of the thoughts and actions of a very
20435 remarkable man, that they are not to blame me if I have not shared my knowledge
20436 with them, for I should have considered it my first duty to do so, had
20437 I not been barred by a positive prohibition from his own lips, which was
20438 only withdrawn upon the third of last month.
20441 \begin_layout Standard
20445 \begin_layout Plain Layout
20457 \begin_layout Subsubsection
20461 \begin_layout Standard
20462 The same pattern is used when you want more than two columns:
20465 \begin_layout Standard
20469 \begin_layout Plain Layout
20473 begin{multicols}{3}
20481 \begin_layout Standard
20484 It can be imagined that my close intimacy with Sherlock Holmes had interested
20485 me deeply in crime, and that after his disappearance I never failed to
20486 read with care the various problems which came before the public.
20487 And I even attempted, more than once, for my own private satisfaction,
20488 to employ his methods in their solution, though with indifferent success.
20489 There was none, however, which appealed to me like this tragedy of Ronald
20491 As I read the evidence at the inquest, which led up to a verdict of willful
20492 murder against some person or persons unknown, I realized more clearly
20493 than I had ever done the loss which the community had sustained by the
20494 death of Sherlock Holmes.
20495 There were points about this strange business which would, I was sure,
20496 have specially appealed to him, and the efforts of the police would have
20497 been supplemented, or more probably anticipated, by the trained observation
20498 and the alert mind of the first criminal agent in Europe.
20499 All day, as I drove upon my round, I turned over the case in my mind and
20500 found no explanation which appeared to me to be adequate.
20501 At the risk of telling a twice-told tale, I will recapitulate the facts
20502 as they were known to the public at the conclusion of the inquest.
20505 \begin_layout Standard
20509 \begin_layout Plain Layout
20521 \begin_layout Standard
20522 You can have more than 3 columns if you want to, but that might not be very
20523 pleasant for the eye.
20526 \begin_layout Subsubsection
20527 Columns inside columns
20530 \begin_layout Standard
20531 You can even have columns inside columns:
20534 \begin_layout Standard
20538 \begin_layout Plain Layout
20542 begin{multicols}{2}
20550 \begin_layout Standard
20553 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20554 at that time governor of one of the Australian colonies.
20555 Adair's mother had returned from Australia to undergo the operation for
20556 cataract, and she, her son Ronald, and her daughter Hilda were living together
20560 \begin_layout Standard
20564 \begin_layout Plain Layout
20568 begin{multicols}{2}
20576 \begin_layout Standard
20579 The youth moved in the best society–had, so far as was known, no enemies
20580 and no particular vices.
20581 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20582 had been broken off by mutual consent some months before, and there was
20583 no sign that it had left any very profound feeling behind it.
20584 For the rest {sic} the man's life moved in a narrow and conventional circle,
20585 for his habits were quiet and his nature unemotional.
20586 Yet it was upon this easy-going young aristocrat that death came, in most
20587 strange and unexpected form, between the hours of ten and eleven-twenty
20588 on the night of March 30, 1894.
20591 \begin_layout Standard
20595 \begin_layout Plain Layout
20607 \begin_layout Standard
20610 Ronald Adair was fond of cards–playing continually, but never for such stakes
20612 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20613 It was shown that, after dinner on the day of his death, he had played
20614 a rubber of whist at the latter club.
20615 He had also played there in the afternoon.
20620 The evidence of those who had played with him– Mr.
20621 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20622 and that there was a fairly equal fall of the cards.
20623 Adair might have lost five pounds, but not more.
20624 His fortune was a considerable one, and such a loss could not in any way
20626 He had played nearly every day at one club or other, but he was a cautious
20627 player, and usually rose a winner.
20628 It came out in evidence that, in partnership with Colonel Moran, he had
20629 actually won as much as four hundred and twenty pounds in a sitting, some
20630 weeks before, from Godfrey Milner and Lord Balmoral.
20631 So much for his recent history as it came out at the inquest.
20634 \begin_layout Standard
20638 \begin_layout Plain Layout
20650 \begin_layout Standard
20651 Please do read the file
20653 examples/multicol.lyx
20655 for more advanced examples including column and header spacing, vertical
20656 separator lines, and more.
20659 \begin_layout Section
20664 Paragraph Environment
20665 \begin_inset OptArg
20668 \begin_layout Plain Layout
20669 Numbering in Enumerate
20677 \begin_layout Standard
20683 \begin_layout Standard
20684 \begin_inset VSpace bigskip
20690 \begin_layout Standard
20692 The default numbering for the
20696 paragraph environment begins with Arabic numbers and ends with uppercase
20698 Suppose, however, you wanted a different type of numbering scheme.
20699 Here's a quickie example of how to change the numbering scheme:
20702 \begin_layout LyX-Code
20712 \begin_layout LyX-Code
20722 \begin_layout LyX-Code
20732 \begin_layout LyX-Code
20742 \begin_layout Standard
20743 \SpecialChar \ldots{}
20744 which changes the numbering scheme to uppercase Roman numerals, uppercase
20745 letters, Arabic numbers, and lowercase letter.
20748 \begin_layout Standard
20749 Additionally, the previous example also adds a little bit extra to the numbering
20751 For example, the first level label actually looks like:
20752 \begin_inset Quotes eld
20756 \begin_inset Quotes erd
20760 For ease of reading, we'll describe what the numbering schemes look like
20761 using a notation something like this: <
20762 \begin_inset Quotes eld
20766 \begin_inset Quotes erd
20770 \begin_inset space ~
20774 \begin_inset Quotes erd
20778 \begin_inset Quotes erd
20782 \begin_inset space ~
20786 \begin_inset Quotes erd
20790 \begin_inset Quotes erd
20794 \begin_inset space ~
20798 \begin_inset Quotes eld
20802 \begin_inset Quotes erd
20809 \begin_layout Standard
20810 As you can see in the example, there is a label command for each nesting
20817 \SpecialChar \ldots{}
20824 , as well as a counter,
20828 \SpecialChar \ldots{}
20834 There are also five
20835 \begin_inset Quotes eld
20839 \begin_inset Quotes erd
20872 , each of which take one counter as an argument.
20873 You can add characters before or after these, but there's no need to add
20877 \begin_layout Standard
20878 You can get really fancy with these.
20882 \begin_layout LyX-Code
20896 \begin_layout LyX-Code
20908 \begin_layout LyX-Code
20918 \begin_layout LyX-Code
20928 \begin_layout Standard
20929 produces the somewhat out of hand numbering scheme: <
20930 \begin_inset Quotes eld
20934 \begin_inset Quotes erd
20938 \begin_inset space ~
20942 \begin_inset Quotes erd
20946 \begin_inset Quotes erd
20950 \begin_inset space ~
20954 \begin_inset Quotes erd
20958 \begin_inset Quotes erd
20962 \begin_inset space ~
20966 \begin_inset Quotes eld
20970 \begin_inset Quotes erd
20977 \begin_layout Standard
20981 \begin_layout Section
20985 \begin_layout Standard
20991 \begin_layout Standard
20992 \begin_inset VSpace bigskip
20998 \begin_layout Standard
21003 \begin_layout Plain Layout
21009 tmpfont}{cmr17 scaled 2500}{
21021 \begin_layout Standard
21026 \begin_layout Plain Layout
21037 hose of you who like the style of old books probably also like
21038 \begin_inset Quotes eld
21042 \begin_inset Quotes erd
21045 —those large capital letters which begin each new chapter or section.
21046 Implementing them with plain LyX/LaTeX is straightforward (assuming you
21047 know some plain TeX!) but does require a lot of work and many iterations,
21048 as you can see by all the ugly TeX-mode stuff at the beginning of this
21052 \begin_layout Standard
21056 \begin_layout Plain Layout
21062 bigdrop{-1em}{3}{ptmri}{T}+
21067 here is a much easier way of doing this, of course.
21076 ) package from CTAN allows a simple way to add such letters to your documents.
21077 Since this package is not a standard part of teTeX, I can't demonstrate
21078 it within this document, but if you copy this paragraph to a new document,
21080 \begin_inset Quotes eld
21090 \begin_inset Quotes erd
21093 and the pluses from the TeX code at the beginning of the paragraph, and
21098 usepackage{dropcaps}
21100 to your LaTeX preamble, you will get a nice Times Roman Italic
21101 \begin_inset Quotes eld
21105 \begin_inset Quotes erd
21108 , whose height is three lines of text and which protrudes 1 em into the
21110 (Make certain you have copied
21111 \begin_inset Quotes eld
21119 \begin_inset Quotes erd
21122 into a directory where TeX can see it.) The first argument is the amount
21123 of indentation; in this case the negative sign moves it into the margin.
21124 The second argument is the height of the letter in number of lines of text.
21125 The third argument is the font name: virtually anything which has a tfm
21126 file should work (wade through the
21128 .../texmf/fonts/tfm
21130 directory for possibilities).
21131 My personal favorite is
21132 \begin_inset Quotes eld
21140 \begin_inset Quotes erd
21143 , a fancy German font specifically designed for dropped capitals.
21144 The fourth argument is the letter (or letters) to be dropped.
21149 package also offers the
21155 command, as well as a slightly simplified
21164 \begin_layout Section
21165 Non-standard Paragraph Shapes
21168 \begin_layout Standard
21174 \begin_layout Standard
21175 \begin_inset VSpace bigskip
21181 \begin_layout Standard
21185 \begin_layout Plain Layout
21197 \begin_layout Standard
21201 \begin_layout Plain Layout
21210 \begin_layout Plain Layout
21224 \begin_layout Standard
21229 \begin_layout Plain Layout
21240 \begin_layout Plain Layout
21249 \begin_layout Plain Layout
21258 \begin_layout Plain Layout
21267 \begin_layout Plain Layout
21276 \begin_layout Plain Layout
21285 \begin_layout Plain Layout
21294 \begin_layout Plain Layout
21303 \begin_layout Plain Layout
21312 \begin_layout Plain Layout
21321 \begin_layout Plain Layout
21330 \begin_layout Plain Layout
21339 \begin_layout Plain Layout
21348 \begin_layout Plain Layout
21357 \begin_layout Plain Layout
21366 \begin_layout Plain Layout
21375 \begin_layout Plain Layout
21384 \begin_layout Plain Layout
21393 \begin_layout Plain Layout
21402 \begin_layout Plain Layout
21408 There are times when the tyranny of rectangular paragraphs must be overthrown.
21409 In such situations, a call to the delightful plain TeX command
21416 As you can see, completely arbitrary shapes can be laid out with a suitable
21417 set of linelength definitions.
21418 While this parshape may look a bit silly and useless, one could conceive
21419 of situations such as finely tuned dropped capitals, word wrapping around
21420 non-rectangular graphics, etc.
21421 which will benefit from such handcrafting.
21424 \begin_layout Standard
21425 \begin_inset VSpace bigskip
21431 \begin_layout Standard
21436 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21443 is the number of lines of text which define the paragraph.
21444 If there turn out to be fewer lines, the shape is truncated; if there are
21445 more, the excess lines have the same dimensions as the last line of the
21455 entries specify the indentation of the line from the left margin, and the
21456 length of the line as measured from that point.
21457 The shape applies only to the current paragraph; everything is reset to
21458 normal for the next paragraph.
21461 \begin_layout Standard
21465 \begin_layout Plain Layout
21477 \begin_layout Section
21481 \begin_layout Standard
21482 As you can see, the examples in this section range from the useful to the
21484 While I don't expect that anyone will ever need the paragraph shape demonstrate
21485 d in the last section, the important point is that you can do almost anything
21486 you want in LyX if you are willing to figure out how to do it in TeX and
21488 TeX is a fantastically powerful typesetting system and all that power is
21489 available to you since LyX uses it as its backend.