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
54 \maintain_unincluded_children false
57 InsetLayout CharStyle:MenuItem
66 \newcommand*{\menuitem}[1]{{\sffamily #1}}
75 \font_typewriter default
76 \font_default_family default
84 \default_output_format default
86 \bibtex_command default
87 \index_command default
91 \pdf_title "LyX's Additional Features manual"
92 \pdf_author "LyX Team"
93 \pdf_subject "LyX's additional features documentation"
94 \pdf_keywords "LyX, Documentation, Additional"
96 \pdf_bookmarksnumbered true
97 \pdf_bookmarksopen false
98 \pdf_bookmarksopenlevel 1
103 \pdf_pdfusetitle false
104 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
114 \paperorientation portrait
123 \paragraph_separation indent
124 \paragraph_indentation default
125 \quotes_language english
128 \paperpagestyle headings
129 \tracking_changes false
130 \output_changes false
140 Additional LyX Features
148 \begin_layout Plain Layout
150 Principal maintainer of this file is
155 If you have comments or error corrections, please send them to the LyX
156 Documentation mailing list,
157 \begin_inset Flex Code
160 \begin_layout Plain Layout
162 <lyx-docs@lists.lyx.org>
175 \begin_layout Standard
176 \begin_inset CommandInset toc
177 LatexCommand tableofcontents
184 \begin_layout Chapter
188 \begin_layout Standard
189 This manual is essentially Part II of the
191 User's Guide\SpecialChar \@.
194 The reason for separating this document out is simple: the
198 is already quite lengthy, and it contains information on all of the basic
199 features one needs to know in order to prepare most documents.
200 However, the LyX Team has worked to make LyX extensible through various
201 configuration files and external packages.
202 That means that if you want to support the Fizzwizzle LaTeX package, you
203 can create a layout file (or module) for it without having to alter LyX
205 We've already had contributions of several new features this way, and some
206 of them are documented here.
207 There are also some more `advanced' features, such as how to control the
208 presentation of bibliographies and how to work with multi-part documents,
209 that are not covered in the
213 and are discussed here.
216 \begin_layout Standard
217 This manual also documents some special features, like fax support, version
218 control, and SGML support, which require additional software to work properly.
219 There is also a chapter on LyX's support for HTML.
220 And lastly, there's a chapter of LaTeX tools and tips, things you can use
221 to spruce up your documents by directly using the powerful features of
227 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
230 \begin_layout Standard
231 If you haven't read the
235 yet, you are definitely in the wrong manual.
240 is the first place to go, since it describes the notation and format of
242 You should also be thoroughly familiar with the
246 and all of the basic features of LyX before attempting to read this one.
249 \begin_layout Standard
250 Since many of the topics in this manual depend heavily on LyX's interaction
251 with LaTeX, this first chapter covers the inner workings of LyX and how
252 to direct LyX to generate exactly the LaTeX code you want.
253 It is obviously for more seasoned LyX users.
256 \begin_layout Chapter
260 \begin_layout Section
264 \begin_layout Standard
265 This chapter is for both TeX-nicians and the LaTeX-curious.
266 In it, we'll explain how LyX and LaTeX work together to produce printable
268 This is the only place in any of the manuals where we assume you know something
272 \begin_layout Standard
273 At one time, LyX was called a
274 \begin_inset Quotes eld
277 WYSIWYM frontend to LaTeX,
278 \begin_inset Quotes erd
281 but that's no longer true.
282 There are frontends to LaTeX out there.
286 \begin_layout Plain Layout
287 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
288 There are also the LaTeX modes for vi and emacs, of course.
293 These are basically text editors with the ability to run LaTeX and mark
294 any errors in the file you're editing.
303 run LaTeX, and it also indicates errors in the file, it also does much,
305 For one thing, you don't need to know LaTeX to use LyX effectively.
306 And LyX has added its own extensions to LaTeX.
307 Try the following sometime: select
308 \begin_inset Flex MenuItem
311 \begin_layout Plain Layout
312 Export\SpecialChar \menuseparator
319 \begin_inset Flex MenuItem
322 \begin_layout Plain Layout
329 \begin_inset Flex MenuItem
332 \begin_layout Plain Layout
333 View\SpecialChar \menuseparator
339 ), then look at the preamble of the resulting
340 \begin_inset Flex Code
343 \begin_layout Plain Layout
350 You'll notice a variety of new macros defined specifically by LyX.
351 These macros are defined automatically, according to the features you use
355 \begin_layout Standard
356 There are several commands that automatically invoke LaTeX.
360 \begin_layout Itemize
361 \begin_inset Flex MenuItem
364 \begin_layout Plain Layout
365 View\SpecialChar \menuseparator
374 \begin_layout Itemize
375 \begin_inset Flex MenuItem
378 \begin_layout Plain Layout
379 View\SpecialChar \menuseparator
380 Update\SpecialChar \menuseparator
389 \begin_layout Itemize
390 \begin_inset Flex MenuItem
393 \begin_layout Plain Layout
394 File\SpecialChar \menuseparator
403 \begin_layout Itemize
404 \begin_inset Flex MenuItem
407 \begin_layout Plain Layout
408 File\SpecialChar \menuseparator
417 \begin_layout Standard
418 They will only invoke LaTeX if the file has changed since the last time
423 \begin_layout Standard
424 When LyX runs LaTeX on the file you're editing, it performs these steps:
427 \begin_layout Enumerate
428 Convert the document to LaTeX and save to a file with the extension
429 \begin_inset Flex Code
432 \begin_layout Plain Layout
439 \begin_inset Flex Code
442 \begin_layout Plain Layout
451 \begin_layout Enumerate
453 \begin_inset Flex Code
456 \begin_layout Plain Layout
462 file (maybe several times), and run any other commands (such as
463 \begin_inset Flex Code
466 \begin_layout Plain Layout
473 \begin_inset Flex Code
476 \begin_layout Plain Layout
482 ) needed to compile the LaTeX file.
485 \begin_layout Enumerate
486 If there are any errors, show the error log.
489 \begin_layout Standard
490 If you've run LaTeX using
491 \begin_inset Flex MenuItem
494 \begin_layout Plain Layout
497 \SpecialChar \menuseparator
505 , LyX then runs a DVI viewer to display the DVI-file.
507 \begin_inset Flex MenuItem
510 \begin_layout Plain Layout
513 \SpecialChar \menuseparator
521 , LyX performs further steps:
524 \begin_layout Itemize
526 \begin_inset Flex Code
529 \begin_layout Plain Layout
535 to convert the DVI file to PostScript.
538 \begin_layout Itemize
539 Run a PostScript viewer, such as
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
549 , to display the PostScript file.
552 \begin_layout Standard
553 LyX does similar things when viewing, or exporting, other formats.
556 \begin_layout Section
557 Translating LaTeX files into LyX
560 \begin_layout Standard
561 You can import a LaTeX file into LyX by using the
562 \begin_inset Flex MenuItem
565 \begin_layout Plain Layout
566 File\SpecialChar \menuseparator
567 Import\SpecialChar \menuseparator
574 This will call a program named
575 \begin_inset Flex Code
578 \begin_layout Plain Layout
584 which will create a file
585 \begin_inset Flex Code
588 \begin_layout Plain Layout
595 \begin_inset Flex Code
598 \begin_layout Plain Layout
605 LyX will then open that file.
609 \begin_layout Plain Layout
610 \begin_inset Flex Code
613 \begin_layout Plain Layout
619 can also be run from the command line, of course.
627 \begin_layout Standard
628 \begin_inset Flex Code
631 \begin_layout Plain Layout
637 will translate most legal LaTeX, but not everything.
638 It will put things it doesn't understand into TeX code, so after translating
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
649 , you can look for TeX code and hand-edit it until it looks right.
652 \begin_layout Standard
653 If you don't know what TeX code is, read the next section.
656 \begin_layout Section
657 \begin_inset CommandInset label
659 name "sec:Inserting-TeX-Code"
663 Inserting TeX Code into LyX Documents
666 \begin_layout Standard
667 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
668 You can always insert TeX code into any LyX document.
669 LyX cannot, and will never be able to, display every possible LaTeX construct.
670 If ever you need to insert LaTeX commands into your LyX document, you can
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
681 box, which you can insert into your document with
682 \begin_inset Flex MenuItem
685 \begin_layout Plain Layout
686 Insert\SpecialChar \menuseparator
695 \begin_layout Standard
696 Here's an example of inserting LaTeX commands in a LyX document.
697 The code looks like this:
700 \begin_layout LyX-Code
704 \begin_inset Newline newline
710 \begin_inset Newline newline
713 This is an example for a minipage environment.
715 \begin_inset Newline newline
718 can put nearly everything in it, even (non-floating)
719 \begin_inset Newline newline
724 \begin_inset Newline newline
730 \begin_inset Newline newline
734 \begin_inset Newline newline
740 \begin_inset Newline newline
746 \begin_inset Newline newline
752 \begin_inset Newline newline
757 \begin_inset Newline newline
763 \begin_inset Newline newline
769 \begin_inset Newline newline
775 \begin_inset Newline newline
783 \begin_layout LyX-Code
787 \begin_layout Standard
789 \begin_inset Flex Code
792 \begin_layout Plain Layout
798 box containing this text is directly after this paragraph.
799 Those of you reading the manual in LyX will only see the TeX code inset.
800 Those reading a printed version of the manuals will see the actual results:
803 \begin_layout Standard
807 \begin_layout Plain Layout
814 \begin_layout Plain Layout
821 \begin_layout Plain Layout
823 This is an example for a minipage environment.
824 You can put nearly everything in it, even (non-floating) figures and tables.
828 \begin_layout Plain Layout
835 \begin_layout Plain Layout
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
854 \begin_layout Plain Layout
861 \begin_layout Plain Layout
867 \begin_layout Plain Layout
874 \begin_layout Plain Layout
881 \begin_layout Plain Layout
888 \begin_layout Plain Layout
900 \begin_layout Standard
901 In addition to using TeX code, you can also create a separate file containing
902 some complex LaTeX structure and then use
903 \begin_inset Flex MenuItem
906 \begin_layout Plain Layout
907 Insert\SpecialChar \menuseparator
917 to include your file (you should select the type
918 \begin_inset Flex Code
921 \begin_layout Plain Layout
928 We recommend that you only do this if you have a
929 \begin_inset Flex Code
932 \begin_layout Plain Layout
943 Otherwise, you'll have a big job tracking down LaTeX errors.
946 \begin_layout Standard
947 There are a few last points to emphasize:
950 \begin_layout Itemize
955 check if your LaTeX code is correct.
958 \begin_layout Itemize
959 Beware reinventing the wheel.
962 \begin_layout Standard
963 On that last point, LyX does have quite a few features tucked into it, and
965 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
966 feature before you decide you have to do it by hand.
967 Moreover, there are numerous LaTeX packages out there to do all sorts of
968 things, from labels to envelopes to fancy multipage tables.
970 \begin_inset CommandInset href
973 target "http://www.ctan.org/"
977 for details, and see chapter
978 \begin_inset CommandInset ref
980 reference "cha:secrets"
987 \begin_layout Standard
988 If you do need to do some wild and fancy things within your document, be
989 sure to check out a good LaTeX book for assistance.
990 There are a number of them listed in the bibliography of the
997 \begin_layout Section
998 LyX and the LaTeX Preamble
1001 \begin_layout Subsection
1002 About the LaTeX Preamble
1005 \begin_layout Standard
1006 If you already know LaTeX, there is no need to explain here what the preamble
1008 If you don't, the following will give you some ideas—we recommend again
1009 that you consult a LaTeX book for further information.
1010 In any case, you should read the points below, because they explain what
1011 you can do and what you don't need to do in the LaTeX preamble of a LyX
1015 \begin_layout Standard
1016 The LaTeX preamble comes at the very beginning of a document,
1024 \begin_layout Itemize
1025 Declare the document class.
1027 \begin_inset Newline newline
1030 LyX already does this for you.
1031 If you're a seasoned LaTeX-nician, and you have a custom document class
1032 you want to use, check out the
1034 Customization Manual
1036 for information on how to make LyX interface to it.
1039 \begin_layout Itemize
1040 Declare the usage of packages.
1042 \begin_inset Newline newline
1045 LaTeX packages provide special commands, which are only available within
1046 a document when the package has been declared in the preamble.
1047 For example, the package
1048 \begin_inset Flex Code
1051 \begin_layout Plain Layout
1057 forces all paragraphs to be indented.
1058 There are other packages for labels, envelopes, margins, etc.
1062 \begin_layout Itemize
1063 Set counters, variables, lengths and widths.
1065 \begin_inset Newline newline
1068 There are several LaTeX counters and variables which
1072 be set globally from within the preamble in order to have the desired effect.
1073 (There are variables which you can set and reset inside the document, too.)
1074 Margins are a good example of something which must be set in the preamble.
1075 Another example is the label format for lists.
1076 You can actually set these just about anywhere, but it's best to do it
1077 just once, inside the preamble.
1080 \begin_layout Itemize
1081 Declare user defined commands (with
1082 \begin_inset Flex Code
1085 \begin_layout Plain Layout
1094 \begin_inset Flex Code
1097 \begin_layout Plain Layout
1106 \begin_inset Newline newline
1109 These are abbreviations for LaTeX commands which appear very often inside
1111 Although the preamble is a good place to declare such commands, they
1115 be declared anywhere (before they are used for the first time, of course).
1116 This can be useful if there is a lot of raw LaTeX code in your document,
1117 which normally should not be the case.
1120 \begin_layout Standard
1121 LyX adds its own set of definitions to the preamble of the
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1132 This makes LaTeX files generated by LyX portable.
1135 \begin_layout Subsection
1136 Changing the Preamble
1139 \begin_layout Standard
1140 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1141 can't change them without patching LyX itself.
1142 You can, however, add your own stuff to the preamble by selecting
1143 \begin_inset Flex MenuItem
1146 \begin_layout Plain Layout
1148 \begin_inset space ~
1157 \begin_inset Flex MenuItem
1160 \begin_layout Plain Layout
1161 Document\SpecialChar \menuseparator
1168 LyX adds anything in the
1169 \begin_inset Flex MenuItem
1172 \begin_layout Plain Layout
1178 dialog to its own built-in preamble.
1179 Before adding your own declarations in the preamble, you should make sure
1180 that LyX doesn't already support what you want to do.
1181 (Remember what we said about reinventing the wheel?) Also,
1183 make sure your preamble code is correct
1186 LyX doesn't check it for you.
1187 If there is an error, you're likely to get an error like
1188 \begin_inset Quotes eld
1192 \begin_inset Flex Code
1195 \begin_layout Plain Layout
1204 \begin_inset Quotes erd
1208 If you see this error, check your preamble.
1211 \begin_layout Subsection
1215 \begin_layout Standard
1216 Here are some examples of what you can add to a preamble, and what they
1220 \begin_layout Subsubsection
1224 \begin_layout Standard
1225 There are two variables under LaTeX that control page position:
1226 \begin_inset Flex Code
1229 \begin_layout Plain Layout
1238 \begin_inset Flex Code
1241 \begin_layout Plain Layout
1250 Their names should be self-explanatory.
1251 These variables are useful if you think for a moment about computer labels.
1252 Sometimes, the size of a print medium and the area of the medium that you
1253 can actually print on aren't the same.
1255 \begin_inset Flex Code
1258 \begin_layout Plain Layout
1267 \begin_inset Flex Code
1270 \begin_layout Plain Layout
1281 \begin_layout Standard
1282 The default values for
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1295 \begin_inset Flex Code
1298 \begin_layout Plain Layout
1307 \begin_inset space \thinspace{}
1311 \begin_inset space \thinspace{}
1315 \begin_inset space \space{}
1318 the page isn't shifted.
1319 Unfortunately, some DVI drivers always seem to shift the page.
1320 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1321 If you're using LyX on a system that you don't personally maintain, and
1322 your sysadmin is a doofus,
1323 \begin_inset Flex Code
1326 \begin_layout Plain Layout
1335 \begin_inset Flex Code
1338 \begin_layout Plain Layout
1347 Suppose your left and top margins are always 0.5
1348 \begin_inset space \thinspace{}
1352 You can add this to the preamble:
1355 \begin_layout LyX-Code
1363 \begin_layout LyX-Code
1371 \begin_layout Standard
1372 and your margins should now be correct.
1375 \begin_layout Subsubsection
1379 \begin_layout Standard
1380 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1381 There's a rather nice package, available at your nearest CTAN archive,
1382 for printing sheets of labels:
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1393 Now, your system may not have this package installed by default.
1394 We leave that up to you to check.
1395 You'll also want to read the documentation for it; we're not going to do
1397 Since this is an example, however, we'll give you an example of how you
1401 \begin_layout Standard
1402 First, make sure you're using the
1403 \begin_inset Flex Code
1406 \begin_layout Plain Layout
1413 Next, you need to put the following in your preamble:
1416 \begin_layout LyX-Code
1422 \begin_layout LyX-Code
1428 \begin_layout LyX-Code
1434 \begin_layout LyX-Code
1440 \begin_layout LyX-Code
1446 \begin_layout LyX-Code
1452 \begin_layout LyX-Code
1458 \begin_layout Standard
1459 This sets things up for Avery label sheets, stock #5360.
1460 You're now ready to print labels, but you'll need to insert LaTeX code,
1461 placing the commands
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1485 around each label text.
1486 This and other special features of
1487 \begin_inset Flex Code
1490 \begin_layout Plain Layout
1496 are explained in its documentation.
1499 \begin_layout Standard
1500 Someday, someone may write a LyX layout file to support this package directly.
1501 Maybe that someone is you.
1504 \begin_layout Subsubsection
1505 Example #3: Paragraph Indentation
1508 \begin_layout Standard
1509 Americans are trained to indent the first line of
1514 As with all of their other weird quirks, most Americans will whine and
1515 moan until they can have their way and indent the first line of all paragraphs.
1524 \begin_layout Standard
1525 Of course, this behavior isn't standard typography.
1526 In books, you typically only indent the first line of a paragraph
1530 it follows another one.
1531 The idea behind indenting the first line of a paragraph is to distinguish
1532 neighboring paragraphs from one another.
1533 If there is no previous paragraph—for example, if it follows a figure or
1534 is the first paragraph in a section—then there is no need for indentation.
1538 \begin_layout Standard
1539 If you're a typical American (we're still joking!), though, you don't care
1540 about such esoteric things; you want your indentation! Add this to the
1544 \begin_layout LyX-Code
1547 usepackage{indentfirst}
1550 \begin_layout Standard
1551 If your TeX distribution isn't braindead, you'll have this package, and
1552 all of your paragraphs will get the indentation the Founding Fathers intended
1556 \begin_layout Subsubsection
1557 Example #4: This Document
1560 \begin_layout Standard
1561 You can also check out the preamble of this document to get an idea of some
1562 of the advanced things you can do.
1563 Also, there are more examples and an assortment of LaTeX
1564 \begin_inset Quotes eld
1568 \begin_inset Quotes erd
1572 \begin_inset space ~
1576 \begin_inset CommandInset ref
1578 reference "cha:secrets"
1586 \begin_layout Section
1587 LyX and LaTeX Errors
1590 \begin_layout Standard
1591 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1593 It then uses the logfile from the LaTeX run to do a post-mortem.
1594 After analyzing the logfile,LyX displays a dialog listing the errors.
1595 Clicking on any one of them will take you to the position in your LyX file
1596 where the error occurred.
1600 \begin_layout Plain Layout
1602 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1604 There are also cases where LaTeX reports the error on one line, but the
1605 actual error is earlier.
1606 This is not unlike forgetting a closing brace in a program: You'll get
1607 an error, but only later.
1615 \begin_layout Standard
1616 Some folks also like to look at the log file directly: It is available from
1618 \begin_inset Flex MenuItem
1621 \begin_layout Plain Layout
1624 \SpecialChar \menuseparator
1628 \begin_inset space ~
1637 There are some fairly common error messages and warnings.
1638 We'll cover those here.
1639 You should look at a good LaTeX book for a complete listing.
1642 \begin_layout Itemize
1643 \begin_inset Flex Code
1646 \begin_layout Plain Layout
1653 \begin_inset Newline newline
1656 Anything beginning with these words is a warning message for the purpose
1658 \begin_inset Quotes eld
1662 \begin_inset Quotes erd
1665 the LaTeX code itself.
1666 You'll get messages like this if you added or changed cross-references
1667 or bibliography entries, in which case, LaTeX is trying to tell you that
1668 you need to make another run.
1669 You can by-and-large ignore these.
1672 \begin_layout Itemize
1673 \begin_inset Flex Code
1676 \begin_layout Plain Layout
1683 \begin_inset Newline newline
1686 Another warning message, this time about fonts which LaTeX couldn't find.
1687 The rest of the message will often say something about a replacement font
1689 You can safely ignore these, too.
1692 \begin_layout Itemize
1693 \begin_inset Flex Code
1696 \begin_layout Plain Layout
1705 \begin_inset Newline newline
1713 They are warnings about lines that were too long and run past the right
1715 Almost always, this is unnoticeable in the final output.
1716 (It can be just a point or two.) Or, only one or two characters extend past
1718 LaTeX seems to generate at least one of these messages for just about any
1720 \begin_inset Newline newline
1723 You can ignore these messages.
1724 Your eyes will tell you if there's a problem with something that's too
1725 wide; just look at the output.
1729 \begin_layout Plain Layout
1730 You can also enable the `draft' option in
1731 \begin_inset Flex MenuItem
1734 \begin_layout Plain Layout
1737 \SpecialChar \menuseparator
1745 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1753 \begin_layout Itemize
1754 \begin_inset Flex Code
1757 \begin_layout Plain Layout
1766 \begin_inset Newline newline
1769 Not quite as common as its cousin.
1770 LaTeX seems to like to print lines that are a bit too wide as opposed to
1771 ones that are a bit too narrow.
1772 We have no idea why.
1775 \begin_layout Itemize
1776 \begin_inset Flex Code
1779 \begin_layout Plain Layout
1788 \begin_inset Flex Code
1791 \begin_layout Plain Layout
1800 \begin_inset Newline newline
1803 Warnings about troubles breaking the page.
1804 Once again, just look at the output.
1805 Your eyes will tell you where something has gone wrong.
1808 \begin_layout Itemize
1809 \begin_inset Flex Code
1812 \begin_layout Plain Layout
1814 \begin_inset Quotes els
1818 \begin_inset Quotes ers
1827 \begin_inset Newline newline
1831 \begin_inset Quotes eld
1835 \begin_inset Quotes erd
1838 isn't installed on this system.
1839 This usually appears because some package your document needs isn't installed.
1840 If you didn't touch the preamble or didn't use the
1841 \begin_inset Flex Code
1844 \begin_layout Plain Layout
1852 command, then one of the packages LyX tried to load is missing.
1854 \begin_inset Flex MenuItem
1857 \begin_layout Plain Layout
1858 Help\SpecialChar \menuseparator
1864 to get a list of packages that LyX knows about.
1865 This file is updated whenever you reconfigure LyX (using
1866 \begin_inset Flex MenuItem
1869 \begin_layout Plain Layout
1870 Tools\SpecialChar \menuseparator
1876 ) and tells you which packages have been detected and what they do.
1877 \begin_inset Newline newline
1881 \begin_inset Flex Code
1884 \begin_layout Plain Layout
1892 command and the package in question isn't installed, then you'll need to
1893 install it yourself.
1896 \begin_layout Itemize
1897 \begin_inset Flex Code
1900 \begin_layout Plain Layout
1901 LaTeX Error: Unknown option
1907 \begin_inset Newline newline
1910 Error messages beginning with this are trying to tell you that you specified
1911 a bad or undefined option to a package.
1912 Check the package's documentation.
1915 \begin_layout Itemize
1916 \begin_inset Flex Code
1919 \begin_layout Plain Layout
1920 Undefined control sequence
1926 \begin_inset Newline newline
1929 If you've inserted LaTeX code into your document, but made a typo, you'll
1931 You may have forgotten to load a package.
1932 In any case, this error message usually means that you used an undefined
1937 \begin_layout Standard
1938 There are other error and warning messages.
1939 Some are self-explanatory.
1940 These are usually LaTeX messages.
1941 Others are downright cryptic.
1942 These are usually TeX error messages, and we really have
1946 what they mean or how to decipher them.
1950 \begin_layout Standard
1951 There's a general sequence you should follow if you get error messages:
1954 \begin_layout Enumerate
1955 Look at the LaTeX code you inserted for typos.
1958 \begin_layout Enumerate
1959 If there are no typos, check that you used the command(s) correctly.
1962 \begin_layout Enumerate
1963 If you get a bunch of error boxes piled up at the very top of the document—and
1964 especially if you see a
1965 \begin_inset Quotes eld
1969 \begin_inset Flex Code
1972 \begin_layout Plain Layout
1981 \begin_inset Quotes erd
1984 error—it means that there are errors in the preamble.
1985 Start debugging your preamble.
1988 \begin_layout Enumerate
1989 If you didn't add anything to the preamble and didn't add any LaTeX code
1990 to the document, the first suspect is your LaTeX distribution itself.
1991 Check for missing packages and install them.
1994 \begin_layout Enumerate
1995 Okay, so there are no missing packages.
1996 Did you use any of the fine-tuning options in LyX? Specifically, did you
2001 any of them, like trying to manually insert lots of
2002 \begin_inset Flex Code
2005 \begin_layout Plain Layout
2007 \begin_inset space ~
2016 \begin_inset Flex Code
2019 \begin_layout Plain Layout
2026 \begin_inset Flex Code
2029 \begin_layout Plain Layout
2035 ? Did you try to kludge something together with these instead of using the
2036 appropriate paragraph environment?
2039 \begin_layout Enumerate
2040 All right, you didn't use any of the fine-tuning options, you played by
2042 Did you try to pull a fancy maneuver? Did you do something funky inside
2043 a table or an equation, like inserting a graphic into a table cell?
2046 \begin_layout Enumerate
2047 Do you have long sections of text where LaTeX cannot find a place to break
2048 a line? By default, LaTeX is rather strict about how much extra inter-word
2049 spacing it will add in order to break a line.
2050 Preferably, you should rework the paragraph to avoid the problem.
2051 If this isn't an option, you can wrap your text in
2052 \begin_inset Flex Code
2055 \begin_layout Plain Layout
2063 to make LaTeX's line breaking more, well, sloppy.
2066 \begin_layout Enumerate
2067 Did you go overboard with the nesting? LyX (currently) doesn't check to
2068 make sure you're in the limits for nesting environments.
2069 If you nested a bunch of environments to the
2070 \begin_inset Formula $17^{\mathrm{th}}$
2073 level, that's the problem.
2074 (The limit in LaTeX is five.)
2077 \begin_layout Enumerate
2078 Okay, you didn't get any error messages, but your output looks awful.
2079 If you have a table or figure that's too wide or long for the page, you
2084 \begin_layout Enumerate
2085 rescale the figure so it fits.
2088 \begin_layout Enumerate
2089 trim down the table so it fits.
2093 \begin_layout Enumerate
2094 If something else is wrong with the output, and you didn't try to pull anything
2095 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2098 \begin_layout Standard
2099 If all this doesn't help—well, then
2103 you might have found a bug in LyX\SpecialChar \ldots{}
2107 \begin_layout Chapter
2111 \begin_layout Section
2112 Customizing Bibliographies with BibTeX
2115 \begin_layout Standard
2116 The most basic information about how to use BibTeX with LyX is contained
2119 Bibliography databases (BibTeX)
2126 The following subsections explain special bibliography features supported
2130 \begin_layout Subsection
2131 Alternative Citation Styles
2134 \begin_layout Standard
2135 Standard BibTeX uses numbers (e.
2136 \begin_inset space \thinspace{}
2140 \begin_inset space \space{}
2144 \begin_inset Quotes eld
2148 \begin_inset Quotes erd
2151 ) to refer to a cited work.
2152 However, in many scientific disciplines, other citation styles are in use.
2153 The most common one is the author-year style (e.
2154 \begin_inset space \thinspace{}
2158 \begin_inset space \space{}
2162 \begin_inset Quotes eld
2166 \begin_inset Quotes erd
2170 LyX supports two packages that provide this style,
2171 \begin_inset Flex Code
2174 \begin_layout Plain Layout
2181 \begin_inset Flex Code
2184 \begin_layout Plain Layout
2191 Both packages have their pros and cons, which cannot be listed in detail.
2192 If you only want to have simple author-year (or author-numerical) style,
2193 or if you want to use one of the countless style files for
2194 \begin_inset Flex Code
2197 \begin_layout Plain Layout
2203 , than the established
2204 \begin_inset Flex Code
2207 \begin_layout Plain Layout
2213 package is probably your choice.
2214 If you need special features like short title references, ibidem etc., you
2216 \begin_inset Flex Code
2219 \begin_layout Plain Layout
2228 \begin_layout Standard
2229 The handling of both packages in LyX is basically the same.
2231 \begin_inset Flex MenuItem
2234 \begin_layout Plain Layout
2235 Document\SpecialChar \menuseparator
2242 \begin_inset Flex MenuItem
2245 \begin_layout Plain Layout
2252 \begin_inset Flex MenuItem
2255 \begin_layout Plain Layout
2262 \begin_inset Flex MenuItem
2265 \begin_layout Plain Layout
2272 With both packages, you will get some extra features in the citation dialog
2273 and you can select the style of the reference (
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2282 \begin_inset Quotes eld
2286 \begin_inset Quotes erd
2290 \begin_inset Quotes eld
2294 \begin_inset Quotes erd
2298 \begin_inset Quotes eld
2302 \begin_inset Quotes erd
2306 Note that both packages need specifically designed style files.
2307 They both ship their own, but there are lots of additional style files,
2308 and there is even an interactive style file builder
2312 \begin_layout Plain Layout
2314 \begin_inset Flex URL
2317 \begin_layout Plain Layout
2319 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2330 \begin_inset Flex Code
2333 \begin_layout Plain Layout
2342 \begin_layout Subsection
2343 Sectioned Bibliographies
2346 \begin_layout Standard
2347 Sometimes you might need to divide your bibliography into several sections.
2348 If you are for instance a historian, the possibility to separate sources
2349 and scientific works is most likely a
2350 \begin_inset Quotes eld
2354 \begin_inset Quotes erd
2358 Unfortunately, BibTeX itself does not allow you to do this.
2359 But with the help of some LaTeX packages, BibTeX can be extended to fit
2363 \begin_layout Standard
2364 LyX provides native support for one of these packages,
2372 \begin_layout Plain Layout
2374 \begin_inset Flex URL
2377 \begin_layout Plain Layout
2379 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2389 The advantage of this package (compared to other packages like
2393 ) is that you don't need to define new citation commands.
2394 Instead, you need to prepare different bibliographic databases which include
2395 the entries for the different sections of the bibliography.
2396 For example: If you want to divide your bibliography into the sections
2398 \begin_inset Quotes eld
2402 \begin_inset Quotes erd
2406 \begin_inset Quotes eld
2410 \begin_inset Quotes erd
2413 , you first need to create two bibliographic databases, e.
2414 \begin_inset space \thinspace{}
2418 \begin_inset space \space{}
2422 \begin_inset Flex Code
2425 \begin_layout Plain Layout
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2445 \begin_layout Standard
2447 \begin_inset Flex MenuItem
2450 \begin_layout Plain Layout
2451 Document\SpecialChar \menuseparator
2458 \begin_inset Flex MenuItem
2461 \begin_layout Plain Layout
2468 \begin_inset Flex MenuItem
2471 \begin_layout Plain Layout
2472 Sectioned bibliography
2478 Now you can insert multiple BibTeX bibliographies, one for each section
2479 of your bibliography.
2480 Returning to our example: Insert the BibTeX bibliography
2481 \begin_inset Flex Code
2484 \begin_layout Plain Layout
2490 and a second one for the database
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2501 You are free to use the same or different styles for each section.
2502 Additionally, you can chose if the bibliography section should contain
2504 \begin_inset Quotes eld
2507 all cited references
2508 \begin_inset Quotes erd
2511 of the specified database(s) (which is the default),
2512 \begin_inset Quotes eld
2515 all uncited references
2516 \begin_inset Quotes erd
2520 \begin_inset Quotes eld
2524 \begin_inset Quotes erd
2528 This might be useful if you would like to separate your bibliography into
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2538 \begin_inset Quotes eld
2542 \begin_inset Quotes erd
2546 \begin_inset Quotes eld
2550 \begin_inset Quotes erd
2554 The titles for the sections can be added as ordinary sections or subsections.
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2565 removes the bibliography title, you have manually re-add that, too (as
2566 a chapter* or section*, for instance).
2569 \begin_layout Subsection
2570 Multiple Bibliographies
2573 \begin_layout Standard
2574 Multiple bibliographies, e.
2575 \begin_inset space \thinspace{}
2579 \begin_inset space \space{}
2582 a bibliography for each section or chapter of the document, are not supported
2585 \begin_inset Flex Code
2588 \begin_layout Plain Layout
2594 package, which is used for the creation of sectioned bibliographies in
2595 LyX (see the previous section), provides an easy way to solve this task,
2596 if you are willing to use some
2597 \begin_inset Flex MenuItem
2600 \begin_layout Plain Layout
2607 \begin_inset space ~
2611 \begin_inset CommandInset ref
2613 reference "sec:Inserting-TeX-Code"
2621 \begin_layout Plain Layout
2622 An alternative approach is to use the
2623 \begin_inset Flex Code
2626 \begin_layout Plain Layout
2633 \begin_inset Flex Code
2636 \begin_layout Plain Layout
2642 package, respectively.
2650 \begin_layout Standard
2652 \begin_inset Flex MenuItem
2655 \begin_layout Plain Layout
2656 Document\SpecialChar \menuseparator
2663 \begin_inset Flex MenuItem
2666 \begin_layout Plain Layout
2673 \begin_inset Flex MenuItem
2676 \begin_layout Plain Layout
2677 Sectioned bibliography
2683 In the document, you have to enclose the sections, which shall contain
2684 their own bibliography (including the BibTeX bibliography itself), between
2686 \begin_inset Flex Code
2689 \begin_layout Plain Layout
2698 \begin_inset Flex Code
2701 \begin_layout Plain Layout
2709 (those commands have to be inserted as TeX code).
2710 The bibliography will contain all references which have been cited in the
2712 \begin_inset Flex Code
2715 \begin_layout Plain Layout
2726 If you are using this approach, then every citation reference has to be
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2739 \begin_inset Flex Code
2742 \begin_layout Plain Layout
2751 \begin_layout Section
2755 \begin_layout Subsection
2759 \begin_layout Standard
2760 When you are working on a large file with many sections, it is often convenient
2761 to break up the document into several files, or perhaps you have something
2762 where a table may change from time to time, but the preceding text does
2764 In these cases, you should seriously consider using multipart documents.
2765 For example, scientific papers often have five major sections: the introduction
2766 , observations, results, discussion, and conclusion.
2767 Each of these could be its own separate LyX file, with one
2768 \begin_inset Quotes eld
2772 \begin_inset Quotes erd
2775 file which contains the title, authors, abstract, references, etc., plus
2776 the five included files.
2777 It is important to note that each of these files is a full LyX file which
2778 can be formatted and printed on its own, as well as included in a master
2780 Each of these files must have the same document class, however—don't attempt
2781 to mix book classes with article classes.
2782 You may also include LaTeX files; however, these files must not have their
2784 \begin_inset space \thinspace{}
2788 \begin_inset space \space{}
2791 everything up to and including the
2792 \begin_inset Flex Code
2795 \begin_layout Plain Layout
2804 \begin_inset Flex Code
2807 \begin_layout Plain Layout
2815 line must be deleted) or else errors will be generated when you try to
2819 \begin_layout Standard
2820 LyX allows you to include files quite easily with
2821 \begin_inset Flex MenuItem
2824 \begin_layout Plain Layout
2825 Insert\SpecialChar \menuseparator
2827 \begin_inset space ~
2836 When you click on this selection a small box is inserted into the file
2837 at the current cursor location.
2838 Clicking on the box raises a dialog which allows you to select the file
2839 to be included, and the method of its inclusion.
2843 \begin_layout Standard
2844 The file selection box should by now be obvious.
2845 The three inclusion methods are
2846 \begin_inset Quotes eld
2850 \begin_inset Quotes erd
2854 \begin_inset Quotes eld
2858 \begin_inset Quotes erd
2862 \begin_inset Quotes eld
2866 \begin_inset Quotes erd
2870 The difference between
2871 \begin_inset Quotes eld
2875 \begin_inset Quotes erd
2879 \begin_inset Quotes eld
2883 \begin_inset Quotes erd
2886 is really only meaningful to LaTeXperts, but the practical difference is
2887 that files which are
2888 \begin_inset Quotes eld
2892 \begin_inset Quotes erd
2895 are typeset beginning on a new page, while files which are
2896 \begin_inset Quotes eld
2900 \begin_inset Quotes erd
2903 are typeset starting on the current page.
2906 \begin_layout Standard
2907 Generally, the master file is converted into a full LaTeX file before typesettin
2908 g, while the included files are converted to LaTeX files which do not have
2909 all the preamble information.
2912 \begin_layout Standard
2914 \begin_inset Quotes eld
2918 \begin_inset Quotes erd
2921 included file allows you to include a file typeset exactly as it appears
2923 \begin_inset space \thinspace{}
2927 \begin_inset space \space{}
2931 \begin_inset Flex Code
2934 \begin_layout Plain Layout
2940 mode, with the characters set in a fixed-width typewriter font.
2941 Normally, spaces in this file are invisible, though two consecutive spaces
2942 are conserved, unlike LyX's normal treatment of spaces.
2943 However, setting the
2944 \begin_inset Flex MenuItem
2947 \begin_layout Plain Layout
2949 \begin_inset space ~
2953 \begin_inset space ~
2957 \begin_inset space ~
2965 checkbox typesets a mark to unambiguously define the presence of a space.
2969 \begin_layout Subsection
2970 Cross-References Between Files
2973 \begin_layout Standard
2974 \begin_inset Box Shadowbox
2984 height_special "totalheight"
2987 \begin_layout Plain Layout
2988 This section is somewhat out of date.
2989 Need to describe default master documents and how children are opened when
2999 \begin_layout Standard
3000 It is possible to set up cross-references between the different files.
3001 First, open all the files in question: let's call them A and B in a two
3002 file example, where B is included in A.
3003 Let's say you insert a label in A, then want to reference it in B.
3004 Open the cross-reference dialog in whilst in document B, and you can select
3006 \begin_inset Quotes eld
3010 \begin_inset Quotes erd
3016 \begin_layout Subsection
3017 Bibliography Lists in all Subdocuments
3020 \begin_layout Standard
3021 \begin_inset Box Frameless
3031 height_special "totalheight"
3034 \begin_layout Plain Layout
3035 This section also needs updating.
3036 There is now material about this on the wiki, and it could be copied here.
3044 \begin_layout Standard
3045 Copy the bibliography list with all entries to all subdocuments and transform
3047 This way LyX will find the
3048 \begin_inset Flex Code
3051 \begin_layout Plain Layout
3057 -files and you can easily insert references without making the bibliography
3061 \begin_layout Standard
3062 As the bibliography list is in a comment, LaTeX won't use use it and the
3063 references will look like this: [?], instead of like this: [1].
3064 One solution is to use the LaTeX-package
3065 \begin_inset Flex Code
3068 \begin_layout Plain Layout
3074 that will only include comments by processing the files separately.
3075 To do this, add in the LaTeX preamble of every subdocument the following:
3078 \begin_layout LyX-Code
3084 \begin_layout LyX-Code
3087 includecomment{comment}
3090 \begin_layout Standard
3092 \begin_inset Flex URL
3095 \begin_layout Plain Layout
3097 http://wiki.lyx.org/FAQ/Unsorted#toc31
3105 \begin_layout Section
3106 Fancy Headers and Footers
3109 \begin_layout Standard
3110 The default page layout is rather plain; for an
3111 \begin_inset Flex Code
3114 \begin_layout Plain Layout
3120 document class, all you get is a centered page number at the bottom of
3122 This document uses KOMA-script's book class, so it appears to be a bit
3124 But to really put on a show, you need to set the document page style to
3126 \begin_inset Quotes eld
3130 \begin_inset Quotes erd
3133 , as mentioned in the
3138 This section describes the LaTeX code you need to insert in your LaTeX
3139 preamble in order to get the desired effects.
3142 \begin_layout Standard
3143 For more information on fancy headers, see the
3144 \begin_inset Flex Code
3147 \begin_layout Plain Layout
3153 package documentation.
3155 \begin_inset Flex URL
3158 \begin_layout Plain Layout
3160 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3168 \begin_layout Standard
3169 The page header is divided into three fields, not surprisingly labeled
3170 \begin_inset Quotes eld
3174 \begin_inset Quotes erd
3178 \begin_inset Quotes eld
3182 \begin_inset Quotes erd
3186 \begin_inset Quotes eld
3190 \begin_inset Quotes erd
3194 The footer is also divided into these three fields.
3195 The LaTeX commands to set these fields in the simplest manner are
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3208 \begin_inset Flex Code
3211 \begin_layout Plain Layout
3220 \begin_inset Flex Code
3223 \begin_layout Plain Layout
3232 \begin_inset Flex Code
3235 \begin_layout Plain Layout
3244 Suppose you wish to put your name in the upper left hand corner of each
3246 Simply insert the following command in the preamble:
3249 \begin_layout Standard
3258 \begin_layout Standard
3259 You will now see your name in the upper left.
3260 If a field has a default entry that you would like to get rid of (often
3261 the page number appears in the central footer, simply include a command
3262 with a blank argument, e.
3263 \begin_inset space \thinspace{}
3269 \begin_layout Standard
3277 \begin_layout Standard
3278 Let's get really fancy: lets put the section number with the word
3279 \begin_inset Quotes eld
3283 \begin_inset Quotes erd
3287 \begin_inset space \thinspace{}
3291 \begin_inset space \space{}
3294 Section 3) in the upper left, the page number (e.
3295 \begin_inset space \thinspace{}
3299 \begin_inset space \space{}
3302 Page 4) in the upper right, your name in the lower left, and the date in
3304 The following commands should now appear in the preamble:
3307 \begin_layout Standard
3317 \begin_layout Standard
3325 \begin_layout Standard
3335 \begin_layout Standard
3344 \begin_layout Standard
3352 \begin_layout Standard
3362 \begin_layout Standard
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3376 \begin_inset Flex Code
3379 \begin_layout Plain Layout
3387 access LaTeX's section and page counters, and so print out the current
3388 section and page numbers.
3390 \begin_inset Flex Code
3393 \begin_layout Plain Layout
3401 simply prints out today's date.
3404 \begin_layout Standard
3405 The thicknesses of the horizontal rules drawn beneath the header and above
3406 the footer can also be modified.
3407 If you don't want one of the rules, set its thickness to 0.
3408 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3422 headrulewidth}{0.4pt}
3428 \begin_inset Flex Code
3431 \begin_layout Plain Layout
3436 footrulewidth}{0.4pt}
3441 to set the thicknesses.
3444 \begin_layout Standard
3445 You can switch the header/footer settings on and off for individual pages
3447 \begin_inset Flex Code
3450 \begin_layout Plain Layout
3453 thispagestyle{empty}
3459 \begin_inset Flex Code
3462 \begin_layout Plain Layout
3465 thispagestyle{plain}
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3477 thispagestyle{fancy}
3483 Simply insert them in the text on the page you want changed and mark them
3485 In fact, title pages are marked as plain by default, while following pages
3486 are marked fancy when using the global fancy setting.
3489 \begin_layout Standard
3490 As a final example, it is possible to include an image in the header or
3492 Suppose you want to put a company logo in the upper lefthand corner.
3493 You might try something like
3496 \begin_layout Standard
3505 includegraphics{logo.eps}}}
3508 \begin_layout Standard
3510 (you may need to preface this with
3511 \begin_inset Flex Code
3514 \begin_layout Plain Layout
3518 usepackage{graphics}
3523 if you don't include graphics elsewhere in your document).
3526 \begin_layout Section
3527 Itemize Bullet Selection
3528 \begin_inset CommandInset label
3537 \begin_layout Standard
3543 \begin_layout Subsection
3547 \begin_layout Standard
3548 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3549 Using this dialog you can easily specify what bullet shape to use at each
3550 level of an itemized list.
3551 These settings are document-wide so you won't be able to specify different
3552 sets of bullets for different paragraphs.
3556 \begin_layout Plain Layout
3557 Well, actually you can but you'll have to do it by hand.
3565 \begin_layout Subsection
3569 \begin_layout Standard
3570 Open the dialog by selecting the
3571 \begin_inset Flex MenuItem
3574 \begin_layout Plain Layout
3575 Document\SpecialChar \menuseparator
3581 menu item and then select the
3582 \begin_inset Flex MenuItem
3585 \begin_layout Plain Layout
3594 \begin_layout Standard
3595 The dialog provides you with a table of bullet shapes.
3596 A column of buttons on the left of the table provides access to the six
3597 different panels of bullet shapes.
3598 The row of buttons across the top is used to select which bullet depth
3600 A text entry under the table shows the currently selected bullet shape's
3601 LaTeX equivalent and this can be edited if desired.
3602 If you do modify the text you will also need to specify any needed packages
3603 in the LaTeX preamble.
3606 \begin_layout Standard
3607 The six panels are divided up by the packages they require.
3608 The following table shows the mappings from button name to LaTeX packages.
3611 \begin_layout Standard
3613 \begin_inset Tabular
3614 <lyxtabular version="3" rows="7" columns="2">
3615 <features tabularvalignment="middle">
3616 <column alignment="center" valignment="top" width="0pt">
3617 <column alignment="center" valignment="top" width="0pt">
3619 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3622 \begin_layout Plain Layout
3637 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3640 \begin_layout Plain Layout
3657 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3660 \begin_layout Plain Layout
3675 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3678 \begin_layout Plain Layout
3694 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3697 \begin_layout Plain Layout
3712 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3715 \begin_layout Plain Layout
3732 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3735 \begin_layout Plain Layout
3750 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3753 \begin_layout Plain Layout
3770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3773 \begin_layout Plain Layout
3788 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3791 \begin_layout Plain Layout
3808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3811 \begin_layout Plain Layout
3826 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3829 \begin_layout Plain Layout
3846 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3849 \begin_layout Plain Layout
3864 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3867 \begin_layout Plain Layout
3890 \begin_layout Standard
3891 LyX doesn't stop you using bullets from packages you don't have.
3892 If you get errors from LaTeX when you try to view or print the file, then
3893 it is likely you are missing a package.
3897 \begin_layout Plain Layout
3898 LyX doesn't restrict your use since you may be editing locally and exporting
3907 \begin_layout Subsection
3911 \begin_layout Standard
3912 Select which bullet depth you want to change then select the bullet shape
3914 Any changes will not be visible in LyX, but are visible when viewing the
3918 \begin_layout Standard
3919 You can reset a bullet shape to the default simply by clicking your right
3920 mouse button on the appropriate bullet depth button.
3924 \begin_layout Plain Layout
3929 want to have multiple sets of paragraphs with different sets of bullets
3930 in each, then you're going to have to get your hands dirty with TeX code.
3931 The bullet selection dialog can help though because it provides you with
3932 the LaTeX code for a wide range of bullet shapes.
3933 To make your own custom paragraphs you have the following options:
3936 \begin_layout Plain Layout
3940 \begin_layout Plain Layout
3956 \begin_layout Plain Layout
3960 \begin_layout Plain Layout
3982 \begin_layout Itemize
3983 Use the LaTeX command
3984 \begin_inset Flex Code
3987 \begin_layout Plain Layout
3995 to specify a new bullet shape for a given depth.
3996 You'll also need to save the current bullet shape so you can restore it
3998 In this itemized list the following LaTeX code was used to change the bullet
3999 used for the first depth.
4003 \begin_layout LyX-Code
4013 \begin_layout LyX-Code
4030 \begin_layout Itemize
4031 Note that the itemize depth is specified in Roman numerals as part of the
4041 \begin_layout Itemize
4045 \begin_layout Plain Layout
4058 Specify each individual entry by starting each item with the bullet shape
4059 enclosed in square brackets and set as
4060 \begin_inset Flex MenuItem
4063 \begin_layout Plain Layout
4070 For example, this item was started with
4071 \begin_inset Flex Code
4074 \begin_layout Plain Layout
4089 \begin_layout Plain Layout
4093 \begin_layout Plain Layout
4109 \begin_layout Plain Layout
4110 You'll also need to revert the labelitem back to its previous setting for
4111 the global bullet shape settings to remain in effect.
4112 The way used here was:
4115 \begin_layout LyX-Code
4130 \begin_layout Chapter
4131 LyX and the World Wide Web
4134 \begin_layout Standard
4135 LyX has long supported the export of documents to various web-friendly formats,
4137 Before verson 2.0, however, HTML export was always accomplished by the use
4138 of external converters.
4142 \begin_layout Plain Layout
4143 For details on the use of external converters with LyX, see the
4147 section of the Customization manual.
4152 These fall into two large groups: there are converters that use LaTeX as
4153 an intermediate format, such as
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4164 \begin_inset Flex Code
4167 \begin_layout Plain Layout
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4183 , relying upon LyX to produce the LaTeX; and there is a converter that works
4184 directly on LyX files,
4185 \begin_inset Flex Code
4188 \begin_layout Plain Layout
4195 All of these have different advantages and disadvantages.
4199 \begin_layout Standard
4200 The LaTeX-based converters have the advantage that, in principle, they know
4201 everything about the exported document that LaTeX does.
4202 Such converters do not care, for example, if a certain block of code was
4203 produced by LyX or was Evil Red Text.
4204 These converters know about
4205 \begin_inset Flex Code
4208 \begin_layout Plain Layout
4214 files, counters, and references, and can often make use of the
4215 \begin_inset Flex Code
4218 \begin_layout Plain Layout
4224 files generated by BibTeX.
4225 On the other hand, LaTeX is a very hard language to parse---it is sometimes
4226 said that only TeX itself understands TeX---and LaTeX-based converters
4227 will often choke on what seem to be quite simple constructs; complex ones
4228 can throw them completely, and as of this writing, for example, the
4232 manual will not export with
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4242 , though the others will.
4243 The other issue concerns how math is handled.
4244 These converters typically convert the formulae into little pictures that
4245 are then linked from the HTML document.
4246 Since these are actually generated by LaTeX, they are accurate.
4247 But they do not scale well, and just getting them to look as if they are
4248 actually meant to be in your document---so that the font sizes seem to
4249 be roughly the same---can be a challenge.
4252 \begin_layout Standard
4254 \begin_inset Flex Code
4257 \begin_layout Plain Layout
4263 solves some of these problems.
4264 In particular, its rendering of math tends to look better than
4265 \begin_inset Flex Code
4268 \begin_layout Plain Layout
4274 's, at least in simpler cases, since it renders math using a combination
4275 of HTML and CSS rather than converting the formulae to images.
4276 But more complex formula tend to be rendered less well than with
4277 \begin_inset Flex Code
4280 \begin_layout Plain Layout
4286 , since there is no reasonable way of scaling parentheses in HTML, for example.
4287 More importantly (as of version 0.39, at least),
4288 \begin_inset Flex Code
4291 \begin_layout Plain Layout
4297 has no support for math macros, for user-defined paragraph or character
4298 styles, or for tables of contents and figures, and its treatment of cross-refer
4300 These limitations make
4301 \begin_inset Flex Code
4304 \begin_layout Plain Layout
4310 unsuitable for many of the documents more advanced LyX users would produce.
4311 In principle, of course, all of these problems could be solved, but the
4312 LyX developers have decided to follow a different path and have made LyX
4313 itself capable of writing XHTML, just as it is capable of writing LaTeX,
4314 DocBook, and plaintext.
4317 \begin_layout Standard
4318 As of this writing, XHTML output remains under development and should probably
4320 \begin_inset Quotes eld
4324 \begin_inset Quotes erd
4331 \begin_layout Plain Layout
4333 \begin_inset Flex Code
4336 \begin_layout Plain Layout
4337 development/HTML.notes
4342 , which can be found in the LyX source tree or
4343 \begin_inset CommandInset href
4345 name "accessed online"
4346 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
4350 , usually contains up-to-date information about the state of XHTML output.
4355 Still, the developers have chosen this approach because it has several
4356 potential advantages over the other two.
4359 \begin_layout Standard
4360 These advantages are primarily due to the fact that the XHTML output routines,
4361 since they are part of LyX, know everything LyX knows about the document
4366 \begin_layout Plain Layout
4367 Another advantege is that, since these routines are internal to LyX, they
4368 are immune to changes in LyX's file format, or to changes in the semantics
4374 So they know about the table of contents (as displayed in the outline),
4375 about the counters associated with different paragraph styles, and about
4376 user-defined styles.
4377 The XHTML output routines know what LyX knows about internationalization,
4378 too, so they will output
4379 \begin_inset Quotes eld
4383 \begin_inset Quotes erd
4387 \begin_inset Quotes eld
4395 \begin_inset Quotes erd
4398 , depending upon the language in effect at the time.
4402 \begin_layout Standard
4403 Quite generally, the output routines know everything LyX knows about document
4404 layout, that is, about how the document is to be rendered on screen.
4405 We use this information when we output the document as XHTML.
4410 generates CSS style information corresponding to the layout information
4411 it uses to render the document on screen: if section headings are supposed
4412 to be sans-serif and bold as seen in LyX, then (by default) they will be
4413 sans-serif and bold when viewed in a web browser, too.
4414 And this is true not just for pre-defined styles, like Section, but for
4415 any style, including user-defined styles.
4416 Indeed, the XHTML output routines make no distinction between user-defined
4417 paragraph and character styles and LyX's own pre-defined styles: in each
4418 case, everything LyX knows about the styles is contained in the layout
4420 And much the same is true as regards pre-defined textual insets, such as
4421 footnotes, and various custom insets.
4425 \begin_layout Standard
4426 The result is that XHTML output can be customized and extended in
4430 the same way LaTeX output can be customized and extended: through layout
4432 See chapter five of the
4436 manual for the details.
4439 \begin_layout Standard
4440 The remainder of this chapter contains more detailed information on XHTML
4441 output, its limitations, and ways to work around those limitations.
4444 \begin_layout Section
4445 Math Output in XHTML
4448 \begin_layout Standard
4449 LyX offers four choices for how math is rendered.
4450 These have various advantages and disadvantages:
4453 \begin_layout Itemize
4455 \begin_inset Newline newline
4458 MathML is a dialect of XML designed specifically for mathematics on the
4459 web, and it typically renders very well in browsers that support it.
4460 The disadvantage is that not all browsers support MathML, and support is
4461 not complete even in the Gecko-based browsers, such as Firefox.
4462 \begin_inset Newline newline
4465 If Lyx is unable to render a formula as MathML---for example, if the formula
4467 \begin_inset Flex Code
4470 \begin_layout Plain Layout
4476 package or ERT---then it will instead output the formula as an image.
4480 \begin_layout Itemize
4482 \begin_inset Newline newline
4486 \begin_inset Flex Code
4489 \begin_layout Plain Layout
4495 outputs math as HTML, styled by CSS.
4499 \begin_layout Plain Layout
4500 LyX has borrowed some of the CSS for its HTML output from
4501 \begin_inset Flex Code
4504 \begin_layout Plain Layout
4515 For simple formulae, this can work quite well, though with more complicated
4516 formulae it tends to break down.
4517 Still, this method has the advantage that it is very widely supported and
4518 so it may be appropriate for documents that contain only a little, fairly
4520 \begin_inset Newline newline
4523 If Lyx is unable to render a formula as MathML---for example, if the formula
4525 \begin_inset Flex Code
4528 \begin_layout Plain Layout
4534 package or ERT---then it will instead output the formula as an image.
4538 \begin_layout Itemize
4540 \begin_inset Newline newline
4544 \begin_inset Flex Code
4547 \begin_layout Plain Layout
4553 , LyX will output formulae as images, the very same images, in fact, that
4554 are used for instant preview.
4558 \begin_layout Plain Layout
4559 Instant preview does
4563 have to be on for images to be output, however.
4568 The advantage to this method is that the images are simply generated by
4569 LaTeX, so they are very accurate.
4570 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4571 so they do not scale terribly well, and one cannot copy them, etc.
4572 \begin_inset Newline newline
4575 The size of the images can be controlled by setting the
4576 \begin_inset Quotes eld
4580 \begin_inset Quotes erd
4584 \begin_inset Flex MenuItem
4587 \begin_layout Plain Layout
4588 Document\SpecialChar \menuseparator
4589 Settings\SpecialChar \menuseparator
4599 \begin_layout Plain Layout
4600 For those who want to know, this controls the resolution of the image in
4601 dots per inch and is based upon a default of 75 dpi.
4607 \begin_inset Newline newline
4610 If LyX for some reason fails to create an image for a formula (e.g., if a
4611 required LaTeX package is not installed), then it will fall back to outputing
4615 \begin_layout Itemize
4617 \begin_inset Newline newline
4620 Finally, LyX will happily output math as LaTeX.
4621 As well as being the output of last resort, this method can be used with
4623 \begin_inset CommandInset href
4626 target "http://www.math.union.edu/~dpvc/jsMath/"
4630 , which uses JavaScript to render LaTeX embedded in HTML documents.
4631 LyX wraps the LaTeX in either a
4632 \begin_inset Flex Code
4635 \begin_layout Plain Layout
4641 (for inline formulas) or
4642 \begin_inset Flex Code
4645 \begin_layout Plain Layout
4651 (for displayed formulas) with
4652 \begin_inset Flex Code
4655 \begin_layout Plain Layout
4661 , as is required for jsMath.
4664 \begin_layout Standard
4665 One of these output methods must be selected under
4666 \begin_inset Flex MenuItem
4669 \begin_layout Plain Layout
4670 Document\SpecialChar \menuseparator
4671 Settings\SpecialChar \menuseparator
4678 By default, LyX outputs MathML.
4679 This is a document-wide setting, therefore.
4682 \begin_layout Standard
4683 Eventually, LyX will offer the user the option to select an alternate output
4684 method for a particular inset, say, one that isn't being rendered very
4689 \begin_layout Plain Layout
4690 That said, since LyX falls back to images if the inset contains ERT, then
4691 one can force output as an image by putting some harmless ERT into the
4693 \begin_inset Formula $a=b\relax$
4704 \begin_layout Section
4705 Bibliography and Citations
4708 \begin_layout Standard
4709 XHTML output fully supports bibliographies and citations.
4713 \begin_layout Standard
4714 Citation labels are generated by the same machinery that generates LyX's
4715 on-screen labels, so the labels will look in the output much as they do
4716 in LyX, though better.
4717 If you are using numerical citations, then LyX will output numerical labels,
4718 such as [1] or [17], rather than simply showing the citation key in square
4719 brackets, as it does on-screen.
4720 If you are using author-year citations, then LyX will add lowercase letters
4721 to the years, just as BibTeX does, if it finds more than one citation for
4722 a given author-year combination.
4723 The labels will be printed with the bibliography entries.
4724 Note that there is, at present, no way to customize the appearance of the
4725 labels, for example, to choose between square brackets and parentheses.
4728 \begin_layout Standard
4729 Bibliography output is handled by the same machinery that handles the presentati
4730 on of reference information in the citation dialog, so you will see in the
4731 XHTML output pretty much what you would see if you were to look at a given
4732 entry in the citation dialog.
4733 The formatting can be customized in your layout file or, preferably, in
4739 manual for the details.
4742 \begin_layout Standard
4743 The main defect at present is that cross-referenced information is printed
4744 with every entry with which it is associated.
4745 So you can see things like this:
4750 \begin_inset Quotes eld
4753 Context and Logical Form
4754 \begin_inset Quotes erd
4759 Language in Context: Selected Essays
4761 (Oxford: Oxford University Press, 2007), pp.
4767 \begin_inset Quotes eld
4770 Semantics in Context
4771 \begin_inset Quotes erd
4776 Language in Context: Selected Essays
4778 (Oxford: Oxford University Press, 2007), pp.
4782 \begin_layout Standard
4783 This should be fixed before long.
4786 \begin_layout Standard
4787 There is no support at present for sectioned bibliographies.
4788 If you have multiple bibliographies, then LyX will print the same bibliography
4792 \begin_layout Section
4796 \begin_layout Standard
4797 LyX will happily export indexes as XHTML, but with certain limitations at
4801 \begin_layout Standard
4802 Index export will be most reliable when you do not attempt to use the fancy
4803 constructs that are described in the section on indexes in the
4811 \begin_layout Plain Layout
4812 The main issue here is that LyX itself does not really handle these.
4813 It just lets you enter what you would have to enter in raw LaTeX.
4818 We'll describe how they are handled using the subsection headings from
4822 \begin_layout Itemize
4823 Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
4824 these, but the entries must be separated by
4825 \begin_inset Quotes eld
4829 \begin_inset Quotes erd
4832 , that is, there must be spaces around the exclamation point.
4833 This is because it is otherwise too difficult to check for escaped exclamation
4834 points, ones in math, and so forth.
4837 \begin_layout Itemize
4838 Page Ranges: There is no support at all for page ranges, since these make
4839 no sense with XHMTL.
4840 Instead, you will just get two index entries, one at either end.
4843 \begin_layout Itemize
4844 Cross-referencing: There is no support for cross-referencing.
4845 If LyX finds an entry containing the
4846 \begin_inset Quotes eld
4849 |see\SpecialChar \ldots{}
4851 \begin_inset Quotes erd
4854 construct, it is just dropped, and the rest is treated as an ordinary index
4858 \begin_layout Itemize
4859 Index Entry Order: LyX does support attempts to fix the sorting order.
4860 It will take what is before the first `@' it finds and use that for sorting,
4861 taking what follows the first `@' to be the actual entry.
4862 At present, LyX does not check for escaped `@', so do not try to index
4866 \begin_layout Itemize
4867 Index Entry Layout: You can format entries by using the text style dialog,
4868 or by using any other method available within LyX itself.
4869 There is no support for constructs like:
4870 \begin_inset Quotes eld
4874 \begin_inset Quotes erd
4878 Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
4879 and everything that follows it.
4882 \begin_layout Itemize
4883 Multiple Indexes: There is no support for multiple indexes.
4884 Rather, all index entries will be printed as one large index.
4885 To avoid our printing several versions of the index, we print only the
4886 main index, so make sure you have one.
4889 \begin_layout Section
4890 Nomenclature and Glossary
4893 \begin_layout Standard
4894 There is at present no support for glossaries.
4897 \begin_layout Chapter
4901 \begin_layout Section
4905 \begin_layout Standard
4906 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4907 and retrieve information about the LyX internal state.
4908 This is only intended for advanced users, but they should find it useful.
4909 It is by writing to the LyX server, for example, that bibliography managers,
4910 such as JabRef, are able to
4911 \begin_inset Quotes eld
4915 \begin_inset Quotes erd
4921 \begin_layout Section
4922 Starting the LyX Server
4925 \begin_layout Standard
4926 The LyX server works through the use of a pair of named pipes.
4927 These are usually located in
4928 \begin_inset Flex Code
4931 \begin_layout Plain Layout
4937 , (except on Windows, where
4941 named pipes are special objects located in
4942 \begin_inset Flex Code
4945 \begin_layout Plain Layout
4957 ) and have the names
4958 \begin_inset Quotes eld
4962 \begin_inset Flex Code
4965 \begin_layout Plain Layout
4972 \begin_inset Quotes erd
4976 \begin_inset Quotes eld
4980 \begin_inset Flex Code
4983 \begin_layout Plain Layout
4990 \begin_inset Quotes erd
4994 External programs write into
4995 \begin_inset Flex Code
4998 \begin_layout Plain Layout
5004 and read back data from
5005 \begin_inset Flex Code
5008 \begin_layout Plain Layout
5015 The stem of the pipe names can be defined in the
5016 \begin_inset Flex MenuItem
5019 \begin_layout Plain Layout
5020 Tools\SpecialChar \menuseparator
5027 \begin_inset Flex Code
5030 \begin_layout Plain Layout
5031 "/home/myhome/lyxpipe"
5037 \begin_inset Flex Code
5040 \begin_layout Plain Layout
5059 configure this manually in order for the server to start.
5062 \begin_layout Standard
5064 \begin_inset Flex Code
5067 \begin_layout Plain Layout
5074 \begin_inset Flex Code
5077 \begin_layout Plain Layout
5083 ' to create the pipes.
5084 If one of the pipes already exists, LyX will assume that another LyX process
5085 is already running and will not start the server.
5086 On POSIX (Unix like) systems, if for some other reason, an unused
5087 \begin_inset Quotes eld
5091 \begin_inset Quotes erd
5094 pipe is left in existence when LyX closes, then LyX will try to delete
5096 If this fails for some reason, you will need to delete the pipes manually
5097 and then restart LyX.
5098 On Windows, pipes are deleted by the OS on program termination or crash,
5100 \begin_inset Quotes eld
5104 \begin_inset Quotes erd
5107 pipes should not be possible.
5110 \begin_layout Standard
5111 To have several LyX processes with servers at the same time, you have to
5112 use different configurations, perhaps by using separate user directories,
5114 \begin_inset Flex Code
5117 \begin_layout Plain Layout
5123 file, for each process.
5126 \begin_layout Standard
5127 If you are developing a client program, you might find it useful to enable
5128 debugging information from the LyX server.
5129 Do this by starting LyX as
5130 \begin_inset Flex Code
5133 \begin_layout Plain Layout
5142 \begin_layout Standard
5143 You can find a complete example client written in C in the source distribution
5145 \begin_inset Flex Code
5148 \begin_layout Plain Layout
5149 development/lyxserver/server_monitor.c
5157 \begin_layout Standard
5158 Another useful tool is command-line based client you will find in
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5163 src/client/lyxclient
5171 \begin_layout Section
5172 Normal communication
5175 \begin_layout Standard
5176 To issue a LyX call, the client writes a line of ASCII text into the input
5178 This line has the following format:
5195 \begin_layout Description
5196 clientname is a name that the client can choose arbitrarily.
5197 Its only use is that LyX will echo it if it sends an answer—so a client
5198 can dispatch results from different requesters.
5201 \begin_layout Description
5202 function is the function you want LyX to perform.
5203 It is the same as the commands you'd use in the minibuffer.
5206 \begin_layout Description
5207 argument is an optional argument which is meaningful only to some functions
5209 \begin_inset Quotes eld
5213 \begin_inset Quotes erd
5216 LFUN will insert the argument as text at the cursor position).
5219 \begin_layout Standard
5220 The answer from LyX will arrive in the output pipe and be of the form
5237 \begin_layout Standard
5246 are just echoed from the command request, while
5250 is more or less useful information filled according to how the command
5251 execution worked out.
5252 Some commands, such as
5253 \begin_inset Quotes eld
5257 \begin_inset Quotes erd
5260 , will return information about the internal state of LyX, while other will
5261 return an empty data-response.
5262 This means that the command execution went fine.
5265 \begin_layout Standard
5266 In case of errors, the response from LyX will have this form
5283 \begin_layout Standard
5288 should contain an explanation of why the command failed.
5291 \begin_layout Standard
5295 \begin_layout LyX-Code
5296 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5297 \begin_inset Newline newline
5300 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5301 \begin_inset Newline newline
5304 read a <~/.lyxpipe.out
5305 \begin_inset Newline newline
5311 \begin_layout Section
5315 \begin_layout Standard
5316 LyX can notify clients of events going on asynchronously.
5317 Currently it will only do this if the user binds a key sequence with the
5319 \begin_inset Quotes eld
5323 \begin_inset Quotes erd
5327 The format of the string LyX sends is as follows:
5331 \begin_inset Flex Code
5334 \begin_layout Plain Layout
5345 \begin_layout Standard
5350 is the printed representation of the key sequence that was actually typed
5354 \begin_layout Standard
5355 This mechanism can be used to extend LyX's command set and implement macros.
5356 Bind some key sequence to
5357 \begin_inset Quotes eld
5361 \begin_inset Quotes erd
5365 Then start a client that listens on the output pipe, dispatches the command
5366 according to the sequence, and starts a function that may use LyX calls
5367 and LyX requests to issue a command or a series of commands to LyX.
5370 \begin_layout Section
5371 The simple LyX Server Protocol
5374 \begin_layout Standard
5375 LyX implements a simple protocol that can be used for session management.
5376 All messages are of the form
5389 \begin_layout Standard
5395 \begin_inset Quotes eld
5399 \begin_inset Quotes erd
5403 \begin_inset Quotes eld
5407 \begin_inset Quotes erd
5412 \begin_inset Quotes eld
5416 \begin_inset Quotes erd
5419 is received from a client, LyX will report back to inform the client that
5420 it's listening to it's messages, while
5421 \begin_inset Quotes eld
5425 \begin_inset Quotes erd
5428 sent from LyX will inform clients that LyX is closing.
5431 \begin_layout Section
5432 Reverse DVI/PDF search
5435 \begin_layout Standard
5436 Some DVI/PDF viewers
5440 \begin_layout Plain Layout
5441 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5442 Skim on Mac OSX and SumatraPDF on Windows.
5451 facility (also called
5456 This means that you can tell LyX to put the cursor to a specific line in
5457 the document by clicking at the respective position in the DVI/PDF output.
5458 To achieve this, the viewer must be able to communicate with LyX.
5459 This is done via the LyX server either by using the named pipe (
5463 ), or the UNIX domain socket (
5467 ) that LyX creates in its temporary directory (this is the way the
5468 \begin_inset Flex Code
5471 \begin_layout Plain Layout
5477 program communicates with LyX).
5478 In some cases, you need a helper script that mediates between the viewer
5479 and LyX, in others, the viewer can communicate with LyX directly.
5480 This depends on the selected viewer and on your operating system.
5481 The same applies to the way viewers need to be configured and the way the
5482 reverse search is actually performed.
5483 In what follows, we will thus describe how to setup reverse search for
5485 Before we turn to this, though, we will explain what needs to be done generally
5486 to enable reverse search in the DVI/PDF output.
5489 \begin_layout Subsection
5491 \change_inserted 2 1274788899
5492 \begin_inset CommandInset label
5494 name "sub:rev-search"
5498 Automatical enabling
5501 \begin_layout Standard
5503 \change_inserted 2 1274789582
5504 In most cases LyX will do the work for you by enabling
5505 \begin_inset Flex MenuItem
5508 \begin_layout Plain Layout
5510 \change_inserted 2 1274789026
5511 Document\SpecialChar \menuseparator
5512 Output\SpecialChar \menuseparator
5519 In such a case LyX will automatically insert SyncTeX macro (for PDF) or
5520 srcltx package (for DVI) respectively.
5521 This option can be easily reached also on
5522 \begin_inset Flex Code
5525 \begin_layout Plain Layout
5527 \change_inserted 2 1274789582
5538 \begin_layout Standard
5540 \change_inserted 2 1274789534
5541 Plase note that including
5542 \begin_inset Flex Code
5545 \begin_layout Plain Layout
5547 \change_inserted 2 1274789498
5556 \begin_inset Flex Code
5559 \begin_layout Plain Layout
5561 \change_inserted 2 1274789484
5569 sometimes have an impact on the typeset and you should switch them off
5570 for the final typesets.
5575 \begin_layout Standard
5577 \change_inserted 2 1274789340
5578 You can also define custom macro in preferences and in case you need some
5579 special tweaks read the next section about manual enabling.
5585 \begin_layout Subsection
5587 \change_inserted 2 1274788680
5593 \begin_layout Standard
5594 LaTeX provides several different methods for reverse search.
5595 Some are built-in in the
5596 \begin_inset Flex Code
5599 \begin_layout Plain Layout
5605 program, some are provided by external packages.
5606 Your choice depends on whether your LaTeX distribution already provides
5607 a given method (the built-in methods are rather new) and whether your viewer
5609 The available methods are described in the following.
5610 \change_inserted 2 1274788557
5614 \begin_layout Subsubsection*
5615 Built-in DVI-search via src-specials (DVI only)
5618 \begin_layout Standard
5619 This method provides the DVI file with the necessary information for reverse
5621 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5622 distribution should include it), and it works reliably.
5623 To enable it, change the
5624 \begin_inset Flex MenuItem
5627 \begin_layout Plain Layout
5632 \begin_layout Plain Layout
5645 \begin_inset Flex MenuItem
5648 \begin_layout Plain Layout
5653 \begin_layout Plain Layout
5660 eX (plain)->DraftDVI
5666 \begin_inset Flex MenuItem
5669 \begin_layout Plain Layout
5670 Preferences\SpecialChar \menuseparator
5671 File Handling\SpecialChar \menuseparator
5678 \begin_inset Flex Code
5681 \begin_layout Plain Layout
5682 latex -src-specials $$i
5688 If this doesn't work, check if your TeX engine needs different options
5689 (the syntax might differ in some distributions).
5692 \begin_layout Subsubsection*
5693 External Packages (PDFSync and scrltx)
5696 \begin_layout Standard
5705 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5707 In order to enable it, load the packages in the LyX preamble:
5710 \begin_layout Itemize
5711 \begin_inset Flex Code
5714 \begin_layout Plain Layout
5722 for reverse PDF search,
5725 \begin_layout Itemize
5727 \begin_inset Flex Code
5730 \begin_layout Plain Layout
5733 usepackage[active]{srcltx}
5738 for reverse DVI search.
5741 \begin_layout Standard
5742 If you want to be able to perform both DVI and PDF reverse searches, you
5743 can also insert in the preamble the following lines
5746 \begin_layout LyX-Code
5750 \begin_inset Newline newline
5756 \begin_inset Newline newline
5762 \begin_inset Newline newline
5768 \begin_inset Newline newline
5773 usepackage[active]{srcltx}
5774 \begin_inset Newline newline
5782 \begin_layout Standard
5783 This way, you can preview the file as either DVI or PDF (pdflatex) and the
5784 right package will be used.
5787 \begin_layout Standard
5788 Note that PDFSync might affect the output layout of your document.
5789 It is therefore advised to disable PDFsync for final documents.
5792 \begin_layout Subsubsection*
5793 Built-in reverse search via SyncTeX (DVI and PDF)
5796 \begin_layout Standard
5798 \begin_inset Flex Code
5801 \begin_layout Plain Layout
5807 have built-in support for both PDF and DVI reverse search.
5812 facility is basically the result of the integration of the PDFSync package
5813 to the pdftex program and its merge with the
5818 You need at least TeXLive 2008 or a recent MikTeX distribution in order
5820 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
5821 already provide SyncTeX support.
5824 \begin_layout Standard
5825 To enable SyncTeX for DVI output, change the
5826 \begin_inset Flex MenuItem
5829 \begin_layout Plain Layout
5834 \begin_layout Plain Layout
5847 \begin_inset Flex MenuItem
5850 \begin_layout Plain Layout
5855 \begin_layout Plain Layout
5862 eX (plain) -> DraftDVI
5868 \begin_inset Flex MenuItem
5871 \begin_layout Plain Layout
5872 Preferences\SpecialChar \menuseparator
5873 File Handling\SpecialChar \menuseparator
5880 \begin_inset Flex Code
5883 \begin_layout Plain Layout
5884 latex -synctex=1 $$i
5889 , and for PDF output, change the
5890 \begin_inset Flex MenuItem
5893 \begin_layout Plain Layout
5898 \begin_layout Plain Layout
5905 eX (pdflatex) -> PDF (pdflatex)
5911 \begin_inset Flex Code
5914 \begin_layout Plain Layout
5915 pdflatex -synctex=1 $$i
5921 Check the documentation of your viewer whether the viewer needs to be configure
5922 d for the use with SyncTeX.
5926 \begin_layout Plain Layout
5928 \begin_inset Flex Code
5931 \begin_layout Plain Layout
5937 option enables gzip compression.
5938 If your viewer does not support it, you should instead use
5939 \begin_inset Flex Code
5942 \begin_layout Plain Layout
5956 \begin_layout Subsection
5957 Configuring and using specific viewers
5960 \begin_layout Subsubsection*
5961 Xdvi (all platforms)
5964 \begin_layout Standard
5966 \begin_inset Flex Code
5969 \begin_layout Plain Layout
5975 , you don't need to do anything else for performing a reverse DVI search,
5976 as LyX already provides the necessary hooks for automatically using the
5978 \begin_inset Flex Code
5981 \begin_layout Plain Layout
5988 Just setup your document as described above (reverse search is triggered
5989 by Ctrl-click or Alt-click on Mac OSX, respectively).
5992 \begin_layout Standard
5993 However, if for whatever reason you want to use the named pipe instead of
5994 the socket for communicating with LyX, simply change the DVI viewer in
5996 \begin_inset Flex MenuItem
5999 \begin_layout Plain Layout
6000 Preferences\SpecialChar \menuseparator
6001 File Handling\SpecialChar \menuseparator
6011 \begin_layout Plain Layout
6012 On Mac OSX you have to use
6013 \begin_inset Flex Code
6016 \begin_layout Plain Layout
6017 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
6028 \begin_inset Flex Code
6031 \begin_layout Plain Layout
6032 xdvi -editor 'lyxeditor.sh %f %l'
6038 \begin_inset Flex Code
6041 \begin_layout Plain Layout
6047 is a suitable script.
6048 For example, a minimal shell script is the following one:
6051 \begin_layout LyX-Code
6053 \begin_inset Newline newline
6056 LYXPIPE="/path/to/lyxpipe"
6057 \begin_inset Newline newline
6060 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6061 \begin_inset Newline newline
6064 echo "$COMMAND" > "${LYXPIPE}".in || exit
6065 \begin_inset Newline newline
6068 read < "${LYXPIPE}".out || exit
6071 \begin_layout Standard
6073 \begin_inset Flex Code
6076 \begin_layout Plain Layout
6086 \begin_layout Plain Layout
6093 XServer pipe path specified in
6094 \begin_inset Flex MenuItem
6097 \begin_layout Plain Layout
6098 Preferences\SpecialChar \menuseparator
6108 \begin_layout Plain Layout
6110 \begin_inset Flex Code
6113 \begin_layout Plain Layout
6119 folder of a source distribution you can find a
6120 \begin_inset Flex Code
6123 \begin_layout Plain Layout
6129 script which is able to locate the
6133 based on your preferences.
6141 \begin_layout Subsubsection*
6145 \begin_layout Standard
6147 \begin_inset Flex Code
6150 \begin_layout Plain Layout
6151 /Applications/MacDviX_Folder/calleditor.script
6156 , add the following lines:
6159 \begin_layout LyX-Code
6164 \begin_layout Plain Layout
6171 X.app/Contents/MacOS/lyxeditor "$2" $1
6172 \begin_inset Newline newline
6178 \begin_layout Standard
6179 Modify the lines accordingly if you install LyX somewhere else than in the
6180 Applications folder.
6183 \begin_layout Standard
6184 Reverse search is triggered by Alt-click (OPTION-click).
6187 \begin_layout Subsubsection*
6191 \begin_layout Standard
6193 \begin_inset Flex Code
6196 \begin_layout Plain Layout
6197 open -a Skim.app $$i
6202 to the viewer setting in
6203 \begin_inset Flex MenuItem
6206 \begin_layout Plain Layout
6207 Preferences\SpecialChar \menuseparator
6208 File Handling\SpecialChar \menuseparator
6209 File formats\SpecialChar \menuseparator
6216 \begin_inset Flex MenuItem
6219 \begin_layout Plain Layout
6220 Skim\SpecialChar \menuseparator
6221 Preferences\SpecialChar \menuseparator
6231 \begin_layout Plain Layout
6241 \begin_layout Standard
6242 Reverse search is triggered by COMMAND-SHIFT-click
6245 \begin_layout Subsubsection*
6249 \begin_layout Standard
6251 \begin_inset Flex MenuItem
6254 \begin_layout Plain Layout
6255 Settings\SpecialChar \menuseparator
6256 Configure Okular\SpecialChar \ldots{}
6257 \SpecialChar \menuseparator
6264 \begin_inset Quotes eld
6268 \begin_inset Quotes erd
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6284 \begin_layout Standard
6285 Reverse search is triggered by SHIFT-click.
6288 \begin_layout Subsubsection*
6292 \begin_layout Standard
6293 Launch yap, choose its
6294 \begin_inset Flex MenuItem
6297 \begin_layout Plain Layout
6298 View\SpecialChar \menuseparator
6305 \begin_inset Quotes eld
6309 \begin_inset Quotes erd
6314 \begin_inset Quotes eld
6317 New\SpecialChar \ldots{}
6319 \begin_inset Quotes erd
6322 button and, in the window that opens, enter
6323 \begin_inset Quotes eld
6327 \begin_inset Quotes erd
6330 (or any other name you like) in the
6331 \begin_inset Quotes eld
6335 \begin_inset Quotes erd
6339 Now click on the button labeled
6340 \begin_inset Quotes eld
6343 \SpecialChar \ldots{}
6345 \begin_inset Quotes erd
6348 to open a file dialog and navigate to the directory containing the batch
6350 \begin_inset Flex Code
6353 \begin_layout Plain Layout
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6370 and then specify the program arguments as
6371 \begin_inset Flex Code
6374 \begin_layout Plain Layout
6382 \begin_inset Flex Code
6385 \begin_layout Plain Layout
6391 wrapper is used for communicating with LyX through the
6398 \begin_layout LyX-Code
6400 \begin_inset Newline newline
6403 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6412 \begin_inset Newline newline
6426 \begin_layout Standard
6427 Make sure that the LyXServer pipe path you specified in LyX is
6428 \begin_inset Flex Code
6431 \begin_layout Plain Layout
6445 , otherwise change the
6446 \begin_inset Flex Code
6449 \begin_layout Plain Layout
6455 wrapper accordingly.
6458 \begin_layout Standard
6459 In yap, reverse search is triggered by double-click.
6462 \begin_layout Subsubsection*
6463 SumatraPDF (Windows)
6466 \begin_layout Standard
6467 In order to use SumatraPDF for inverse search, enter
6468 \begin_inset Flex Code
6471 \begin_layout Plain Layout
6472 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6477 in the viewer setting in
6478 \begin_inset Flex MenuItem
6481 \begin_layout Plain Layout
6482 Preferences\SpecialChar \menuseparator
6483 File Handling\SpecialChar \menuseparator
6484 File formats\SpecialChar \menuseparator
6491 \begin_inset Flex Code
6494 \begin_layout Plain Layout
6500 is the previous wrapper.
6501 If SumatraPDF.exe is not in your command PATH, use its full file name.
6504 \begin_layout Standard
6505 Reverse search is triggered by double-click.
6508 \begin_layout Subsubsection*
6512 \begin_layout Standard
6513 First of all, make sure that yap is your default DVI viewer in the Windows
6514 environment, then launch it, choose its
6515 \begin_inset Flex MenuItem
6518 \begin_layout Plain Layout
6519 View\SpecialChar \menuseparator
6526 \begin_inset Quotes eld
6530 \begin_inset Quotes erd
6535 \begin_inset Quotes eld
6538 New\SpecialChar \ldots{}
6540 \begin_inset Quotes erd
6543 button and, in the window that opens, enter
6544 \begin_inset Quotes eld
6548 \begin_inset Quotes erd
6551 (or any other name you like) in the
6552 \begin_inset Quotes eld
6556 \begin_inset Quotes erd
6560 Now click on the button labeled
6561 \begin_inset Quotes eld
6564 \SpecialChar \ldots{}
6566 \begin_inset Quotes erd
6569 to open a file dialog and navigate to the directory containing the
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6579 program (which is installed by default on Cygwin along with the LyX executable).
6581 \begin_inset Flex Code
6584 \begin_layout Plain Layout
6590 and then specify the program arguments as
6591 \begin_inset Flex Code
6594 \begin_layout Plain Layout
6601 In this way, you will be using the
6605 for communicating with LyX.
6606 If, for whatever reason, you want to use the
6611 \begin_inset Flex Code
6614 \begin_layout Plain Layout
6620 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6623 \begin_layout Standard
6624 In yap, reverse search is triggered by double-click.
6627 \begin_layout Subsubsection*
6631 \begin_layout Standard
6632 In order to use SumatraPDF for inverse search, enter
6633 \begin_inset Flex Code
6636 \begin_layout Plain Layout
6642 in the viewer setting in
6643 \begin_inset Flex MenuItem
6646 \begin_layout Plain Layout
6647 Preferences\SpecialChar \menuseparator
6648 File Handling\SpecialChar \menuseparator
6649 File formats\SpecialChar \menuseparator
6656 \begin_inset Flex Code
6659 \begin_layout Plain Layout
6665 is the following script (to be placed in your command PATH,
6666 \begin_inset Flex Code
6669 \begin_layout Plain Layout
6675 being the best choice):
6678 \begin_layout LyX-Code
6680 \begin_inset Newline newline
6684 \begin_inset Newline newline
6687 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
6690 \begin_layout Standard
6691 This wrapper script is needed because SumatraPDF is a native Windows application
6692 and does not understand the posix paths used by the Cygwin version of LyX.
6693 If SumatraPDF.exe is not in your command PATH, use its full posix path in
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6705 enables communication via the
6711 \begin_inset Flex Code
6714 \begin_layout Plain Layout
6720 option if you want to use the
6724 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6727 \begin_layout Standard
6728 Reverse search is triggered by double-click.
6729 \change_inserted 1 1271453423
6733 \begin_layout Section
6735 \change_inserted 1 1271453442
6739 \begin_layout Standard
6741 \change_inserted 1 1271454338
6742 To make forward search possible you need to provide generated output PDF/DVI
6743 file with additional information about TeX sources.
6744 This can be done via the methods described in the section
6745 \begin_inset CommandInset ref
6747 reference "sub:rev-search"
6754 \begin_layout Standard
6756 \change_inserted 1 1271454479
6757 Secondly you need to configure LyX for using your viewers in
6758 \begin_inset Flex MenuItem
6761 \begin_layout Plain Layout
6763 \change_inserted 1 1271453866
6764 Preferences\SpecialChar \menuseparator
6765 Output\SpecialChar \menuseparator
6772 Only some of the viewers allows this operation --- yap, xdvi, okular, Sumatra
6777 \begin_layout Plain Layout
6779 \change_inserted 1 1271454273
6780 For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
6789 Some other viewers allow at least reloading and positioning to particular
6790 page of the file --- Evince or xpdf --- for these cases you can use external
6792 Please study the prepared examples in the Preferences dialog.
6797 \begin_layout Chapter
6798 Special Document Classes
6801 \begin_layout Section
6805 \begin_layout Standard
6811 \begin_layout Subsection
6815 \begin_layout Standard
6816 This section describes how LyX can be used to write articles for submission
6817 to the scientific journal
6819 Astronomy and Astrophysics
6821 (www.edpsciences.fr/aa/
6822 \begin_inset Flex URL
6825 \begin_layout Plain Layout
6827 http://www.edpsciences.fr/aa/
6832 ) using Version 5.01 of the document class
6837 This package can be downloaded from the ftp site
6840 \begin_layout Standard
6841 \begin_inset VSpace medskip
6847 \begin_layout Standard
6849 \begin_inset Flex URL
6852 \begin_layout Plain Layout
6854 ftp://ftp.edpsciences.org/pub/aa/readme.html
6862 \begin_layout Standard
6863 \begin_inset VSpace medskip
6869 \begin_layout Standard
6870 A manual comes together with that package, and this text is not meant to
6871 replace the original manual but is merely a short guide in how to realize
6872 the correct form of your paper.
6876 \begin_layout Standard
6877 Please note that the publisher of the journal was changed from Springer
6878 to EDP Sciences starting January 1, 2001.
6879 That change involved also some slight changes to the style files, namely
6880 the removal of the thesaurus command.
6881 The LyX class aa supports the newest version of these style files, V 5.01.
6882 If you have an older version installed, please upgrade.
6883 For compatibility, the old (version 4) layout has been kept as
6888 Please refer to the comments in
6890 LyXDir/layouts/aapaper.layout
6895 \begin_layout Subsection
6899 \begin_layout Standard
6900 It is recommended you start from the example template distributed with LyX.
6901 If you are not using a template, note the following settings:
6904 \begin_layout Itemize
6911 Document\SpecialChar \menuseparator
6914 dialog (OK, that one was obvious).
6917 \begin_layout Itemize
6918 Don't change the option
6921 \begin_inset space ~
6931 The whole layout is done by the macros, you shouldn't change anything.
6934 \begin_layout Subsection
6938 \begin_layout Standard
6939 First thing to enter is the header information.
6940 It consists of seven entries, of which some are optional.
6944 \begin_layout Itemize
6952 \begin_layout Itemize
6960 \begin_layout Itemize
6968 \begin_layout Itemize
6976 \begin_layout Itemize
6981 : [optional] if more than one author: whom to contact for offprint requests.
6984 \begin_layout Itemize
6989 : [optional] mail address for contacts.
6992 \begin_layout Itemize
7000 Received: <date>; Accepted <date>
7003 \begin_layout Standard
7004 There is no need to issue the
7010 command, this is done automatically by LyX when the header is finished.
7011 Although the order of the single header entries doesn't matter it is advised
7012 to keep the above sequence, just to get the best optics and meets the layout
7013 of the real document.
7016 \begin_layout Standard
7017 If you want to place footnotes in the header block, e.
7018 \begin_inset space \thinspace{}
7022 \begin_inset space \space{}
7025 to state your present address, just use the standard footnote via the menu
7028 Insert\SpecialChar \menuseparator
7032 LyX will automagically use the term
7041 \begin_layout Standard
7042 In addition to these topics, the macros use three additional LaTeX commands
7043 that have no counterpart in LyX:
7046 \begin_layout Itemize
7053 to separate different names for more than one author and institute, respectivel
7057 \begin_layout Itemize
7064 to mark corresponding author/institute pairs.
7065 The institutes are numbered sequentially as they appear in the
7069 field, so you have to put a marker to each author.
7072 \begin_layout Itemize
7079 to supply an email address for fast contact.
7082 \begin_layout Standard
7083 In all cases, the appropriate command has to be entered in LyX and marked
7089 \begin_layout Subsection
7093 \begin_layout Standard
7094 The abstract should immediately follow the header block.
7095 With version 5 the abstract environment was changed to a command, and there
7096 is now a resctriction to only one paragraph.
7097 In addition, it should contain an entry with the keywords.
7098 This is not yet implemented for LyX, therefore you have to enter the LaTeX
7105 by hand and mark it as LaTeX code.
7106 Refer to the example paper.
7109 \begin_layout Subsection
7110 Supported environments
7113 \begin_layout Standard
7114 The A&A paper layout supports the following environments for structuring
7118 \begin_layout Itemize
7124 \begin_layout Itemize
7130 \begin_layout Itemize
7136 \begin_layout Itemize
7142 \begin_layout Itemize
7148 \begin_layout Itemize
7154 \begin_layout Itemize
7160 \begin_layout Itemize
7166 \begin_layout Itemize
7172 \begin_layout Itemize
7178 \begin_layout Itemize
7184 \begin_layout Itemize
7190 \begin_layout Subsection
7191 Commands not supported by LyX
7194 \begin_layout Standard
7195 Some commands are not yet supported by the
7200 Some have already been mentioned.
7201 For the sake of completeness, they are listed all together here:
7204 \begin_layout Itemize
7212 \begin_layout Itemize
7220 \begin_layout Itemize
7228 \begin_layout Itemize
7236 \begin_layout Itemize
7244 \begin_layout Itemize
7252 \begin_layout Itemize
7260 \begin_layout Itemize
7268 \begin_layout Standard
7269 If you want to use any of these commands, you have to enter them yourself.
7272 Do not forget to mark them as LaTeX code!
7275 \begin_layout Subsection
7276 Figure and Table Floats
7279 \begin_layout Standard
7280 LyX provides support for the necessary float environments
7282 figure, figure*, table
7288 , therefore we won't tell much about it here.
7292 \begin_inset space ~
7298 Just remember that tables should be left-aligned.
7299 For that, select the table and change the alignment in
7301 Edit\SpecialChar \menuseparator
7303 \begin_inset space ~
7309 \begin_layout Standard
7310 There is only one special thing: the figures with caption besides the figure.
7311 To create such a figure, you have to do the following:
7314 \begin_layout Enumerate
7315 Create a wide figure float:
7317 Insert\SpecialChar \menuseparator
7318 Float\SpecialChar \menuseparator
7321 , then right click in the figure and select
7327 \begin_inset space ~
7335 \begin_layout Enumerate
7336 Enter your caption text.
7339 \begin_layout Enumerate
7344 to move the cursor above the caption.
7347 \begin_layout Enumerate
7351 \begin_layout Enumerate
7352 Position the cursor behind the figure and insert a horizontal fill:
7354 Insert\SpecialChar \menuseparator
7356 \begin_inset space ~
7359 Character\SpecialChar \menuseparator
7361 \begin_inset space ~
7369 \begin_layout Enumerate
7370 Switch to LaTeX mode:
7373 \begin_inset space ~
7381 \begin_layout Enumerate
7391 Do not close the brace!
7394 \begin_layout Enumerate
7395 Position the cursor behind the caption text, switch to LaTeX mode and insert
7399 \begin_inset space ~
7411 \begin_layout Standard
7412 Also, refer to the figures in the example paper.
7415 \begin_layout Subsection
7419 \begin_layout Standard
7420 For submission, the paper has to be formated in a special double-spacing
7422 For this purpose, you have to give the option
7426 to the documentclass.
7427 This must be done using the extra class options field in the
7429 Document\SpecialChar \menuseparator
7433 Just enter the string
7440 \begin_layout Subsection
7444 \begin_layout Standard
7449 directory contains an example paper written with LyX.
7450 It is the example paper from the original macro package, translated to
7452 Use it for inspiration, and compare the original LaTeX code with LyX way
7456 \begin_layout Section
7460 \begin_layout Standard
7466 \begin_layout Subsection
7470 \begin_layout Standard
7471 AASTeX is a set of macros produced by the American Astronomical Society
7472 to facilitate electronic manuscript submission to the three journals they
7473 publish: the Astrophysical Journal (including the Letters and Supplement),
7474 the Astronomical Journal, and the Publications of the Astronomical Society
7476 LyX has proven to be an excellent tool for generating these documents,
7477 especially given its equation, citation, and figure handling capabilities.
7478 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7479 is the version described here, or higher.
7480 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7481 incompatible with LyX.
7482 The AASTeX package may be downloaded from the AASTeX Web site
7485 \begin_layout Standard
7486 \begin_inset VSpace medskip
7492 \begin_layout Standard
7494 \begin_inset Flex URL
7497 \begin_layout Plain Layout
7499 http://www.journals.uchicago.edu/AAS/AASTeX
7507 \begin_layout Standard
7508 \begin_inset VSpace medskip
7514 \begin_layout Standard
7515 A complete user guide is contained in that package and you should familiarize
7516 yourself with it thoroughly before embarking on writing a paper in LyX.
7517 LyX will not reduce the need to figure out all the AASTeX commands, it
7518 will only reduce the drudgery of typing everything in.
7519 It is your responsibility to ensure that the final exported LaTeX document
7520 conforms completely to the requirements of the journal to which you are
7521 submitting your paper.
7524 \begin_layout Subsection
7525 Starting a New Paper
7528 \begin_layout Standard
7529 I strongly suggest that you start with the AASTeX template file.
7532 File\SpecialChar \menuseparator
7539 , enter the new file name, then choose the
7544 This will show the most common fields found in a manuscript.
7545 Simply overwrite the existing text (including the brackets,
7549 ) with the correct information.
7550 Many of the AASTeX commands and environments can be implemented directly
7551 in LyX, but some cannot: most noticeably
7563 , which should stick out like a sore thumb if you actually just opened the
7565 For commands such as these, the LaTeX code must be entered directly and
7567 Such commands are referred to as TeX code, or Evil Red Text.
7568 I tried to minimize the amount of TeX code needed in an AASTeX document,
7569 but there is still a bit more required than any of us would like.
7572 \begin_layout Subsection
7573 Finishing Your Paper
7576 \begin_layout Standard
7577 When the paper is finished to your satisfaction and previews/prints correctly,
7579 \begin_inset Quotes eld
7583 \begin_inset Quotes erd
7586 actions which need to be done before you submit it to the journals.
7590 \begin_layout Enumerate
7591 Export your paper as a LaTeX file (
7593 File\SpecialChar \menuseparator
7594 Export\SpecialChar \menuseparator
7601 \begin_layout Enumerate
7606 file with your favorite text editor
7610 \begin_layout Enumerate
7611 remove the comment lines before the
7620 \begin_layout Enumerate
7625 usepackage...{fontenc}
7627 line if it appears (usually just after
7642 \begin_layout Enumerate
7643 remove everything between (and including) the
7655 commands, except for any commands you specifically put into the LaTeX preamble
7656 (which should appear immediately after the
7657 \begin_inset Quotes eld
7660 User specified LaTeX commands
7661 \begin_inset Quotes erd
7672 \begin_layout Enumerate
7673 Run the resulting file through LaTeX to make sure it still processes correctly.
7676 \begin_layout Enumerate
7677 Reread the journal requirements to make sure your filenames and formats
7681 \begin_layout Enumerate
7685 \begin_layout Subsection
7686 Comments On Specific Commands
7689 \begin_layout Standard
7690 I will not describe the detailed usage of the individual AASTeX commands:
7691 the AASTeX User Guide (
7695 ) gives a good description of each.
7696 Thus it's probably easiest for me to go down the list as found in the guide
7697 and offer comments where necessary.
7698 So let's begin \SpecialChar \ldots{}
7702 \begin_layout Subsubsection
7703 Things that work as expected
7706 \begin_layout Standard
7710 \begin_layout Plain Layout
7722 \begin_layout Standard
7723 Because they work as you might expect, I simply list them and the section
7824 begin{thebibliography}
7832 (2.13.2), all the cite commands and their variations (2.13.2), the generic
7833 graphicx figure commands (2.14.1),
7857 (2.15.4, amongst other places),
7884 \begin_layout Standard
7885 The following style options also work correctly:
7906 Simply put them in the
7912 Layout\SpecialChar \menuseparator
7918 \begin_layout Standard
7922 \begin_layout Plain Layout
7934 \begin_layout Subsubsection
7935 Things that work, but require more comment
7938 \begin_layout Standard
7939 The following items work, but require a little more discussion:
7942 \begin_layout Itemize
7943 These items are reserved for use by the journal editors, but you can put
7944 them into the LaTeX preamble if you feel compelled to do so:
7977 \begin_layout Itemize
7978 These items may be placed in the LaTeX preamble, and are included as blanks
7979 in the template file:
8000 \begin_layout Itemize
8007 (2.3) – can only be used
8008 \begin_inset Quotes eld
8012 \begin_inset Quotes erd
8015 , not in the middle of a paragraph.
8016 Use TeX code if you need to embed it.
8019 \begin_layout Itemize
8026 (2.3) – will have extra {} after it.
8027 This should not cause an error.
8030 \begin_layout Itemize
8037 (2.6) – can only be used
8038 \begin_inset Quotes eld
8042 \begin_inset Quotes erd
8045 , not in the middle of a paragraph.
8046 Use TeX code if you need to embed it.
8049 \begin_layout Itemize
8056 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8060 \begin_layout Itemize
8074 \begin_layout Itemize
8081 (2.9) – will have extra {} after it.
8082 This should not cause an error.
8085 \begin_layout Itemize
8092 (2.11) – will have extra {} after it.
8093 This should not cause an error.
8096 \begin_layout Itemize
8103 (2.14.2) – you can insert an optional filename argument by placing the cursor
8104 at the beginning of the text and selecting
8106 Insert\SpecialChar \menuseparator
8111 \begin_inset Quotes eld
8115 \begin_inset Quotes erd
8118 inserts an optional argument of the type needed by
8125 Hopefully it will be renamed someday.
8128 \begin_layout Itemize
8141 for the catalog ID optional parameter
8144 \begin_layout Itemize
8157 for the catalog ID optional parameter
8160 \begin_layout Subsubsection
8161 Things not implemented, use TeX code
8164 \begin_layout Standard
8168 \begin_layout Plain Layout
8180 \begin_layout Standard
8203 setcounter{equation}
8205 (2.12), Journal name abbreviations (2.13.4),
8241 (2.15.4, insert it as the first element in the lefthand cell after where
8243 Don't use any of LyX's rules in the table),
8255 (2.15.5), much of Misc (2.17, except
8306 \begin_layout Standard
8310 \begin_layout Plain Layout
8322 \begin_layout Subsubsection
8323 Things that cannot be implemented
8326 \begin_layout Standard
8327 \SpecialChar \ldots{}
8328 at least in any meaningful sort of way, so I suggest ignoring them.
8329 They are the references environment (2.13.3), and the deluxetable environment
8331 If you really, really need to use deluxetable, I suggest editing it in
8332 a separate file with a text editor, then using
8334 Insert\SpecialChar \menuseparator
8336 \begin_inset space ~
8341 to include it in your LyX document.
8346 file to see an example of this.
8349 \begin_layout Subsection
8350 FAQs, Tips, Tricks, and Other Ruminations
8353 \begin_layout Subsubsection
8354 Getting LyX and AASTeX to cooperate
8357 \begin_layout Standard
8358 It can be a bit tricky to get LyX to recognize a new layout and document
8360 When all else fails, do this:
8363 \begin_layout Enumerate
8364 Make certain that LaTeX can find AASTeX.
8365 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
8366 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
8373 \begin_layout Enumerate
8385 \begin_layout Enumerate
8388 Tools\SpecialChar \menuseparator
8391 in LyX, then restart LyX.
8394 \begin_layout Enumerate
8395 Open a regular new file, not from a template.
8396 Does AASTeX appear in the class list in
8398 Document\SpecialChar \menuseparator
8404 \begin_layout Standard
8405 If you get a warning from an existing AASTeX document about not being able
8406 to find the AASTeX layout or a message about
8407 \begin_inset Quotes eld
8410 You should not mix title layouts with normal ones
8411 \begin_inset Quotes erd
8414 , things haven't been installed correctly.
8417 \begin_layout Subsubsection
8418 LaTeX error processing a table
8421 \begin_layout Standard
8422 LyX, by default, attempts to center the table caption/title.
8423 This seems to produce a bad interaction in AASTeX so you should click somewhere
8424 in the caption/title, then select
8426 Edit\SpecialChar \menuseparator
8428 \begin_inset space ~
8442 This took care of it for me.
8445 \begin_layout Subsubsection
8449 \begin_layout Standard
8450 A couple of things: 1) I have noticed some funny spacing in the reference
8451 entries in the text.
8452 When you enter the bibliography item data, make sure their is
8456 space between the last author and the parenthesis setting off the year;
8460 \begin_inset space \thinspace{}
8464 \begin_inset space \space{}
8478 2) Entering the references at all is not obvious.
8479 The easiest thing is to start typing your first reference at the end of
8480 the document, then mark it as type
8485 That will put a small gray box in front of what you just typed.
8486 Click on the box to fill in the rest of the information.
8487 For new references, go to the end of an existing reference and press return.
8488 That will create a new line with its own box, etc.
8491 \begin_layout Subsubsection
8495 \begin_layout Standard
8496 Even though AASTeX provides its own figure commands (
8502 , for example), I much prefer LaTeX's standard figure commands (with the
8511 \begin_inset space ~
8514 commands as TeX code into a Figure Float box if you desire, but I never
8515 have much luck getting the layout right.
8516 With the standard graphics, LyX will insert a
8520 usepackage{graphicx}
8522 command into the LaTeX preamble and handle the figures in the standard
8523 LaTeX2e way, interspersing the figures in the text.
8524 I believe ApJ accepts figures exactly this way now; AJ might still use
8526 \begin_inset Quotes eld
8529 stack everything at the end
8530 \begin_inset Quotes erd
8536 \begin_layout Subsubsection
8537 Things I could have done, but didn't
8540 \begin_layout Standard
8542 \begin_inset Quotes eld
8546 \begin_inset Quotes erd
8549 things I could have implemented, but chose not to.
8550 For instance, I saw no point in double-spacing the text in the LyX window,
8551 even though it is double-spaced in the paper manuscript.
8552 Also, I chose not to make separate layouts for the preprint and preprint2
8554 Since I assume you will spend most of your time in the plain manuscript
8555 mode anyway, I decided not to chew up more disk space with this.
8559 \begin_layout Subsection
8563 \begin_layout Standard
8564 Your mileage may vary.
8565 I've now had papers published by both ApJ and AJ that have had 98% of the
8566 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8568 I have had no trouble with the submission process, and I'm sure the journals
8569 were never aware that there might be a difference.
8570 So, go forth and publish!
8573 \begin_layout Section
8577 \begin_layout Standard
8580 David Johnson; updated by Richard Heck
8583 \begin_layout Standard
8584 \begin_inset VSpace bigskip
8590 \begin_layout Standard
8592 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8593 papers to be submitted to American Mathematical Society publications.
8594 The layouts are not tailored to a specific journal, but easily can be.
8595 You should refer to the AMS documentation for specific instructions for
8596 each journal (usually it will entail only changing a single line in the
8598 That documentation is available on the Web at
8599 \begin_inset Flex URL
8602 \begin_layout Plain Layout
8610 \begin_inset Flex URL
8613 \begin_layout Plain Layout
8615 ftp://ftp.ams.org/pub/tex/amslatex/
8621 These layouts are appropriate, and useful, for any mathematical writing.
8625 \begin_layout Standard
8626 There are two basic AMS LaTeX layouts:
8629 \begin_layout Itemize
8630 amsart: The standard AMS article format.
8633 \begin_layout Itemize
8634 amsbook: the standard AMS book (really, monograph) format.
8638 \begin_layout Standard
8639 The layouts themselves contain only the minimum necessary to use the AMS
8641 They do not, in particular, contain any of the `theorem' environments used
8642 for setting theorems, lemmas, and the like.
8643 These are contained, instead, in the
8644 \begin_inset Flex Code
8647 \begin_layout Plain Layout
8653 module, which is loaded by default when when you select one of the AMS
8655 (It can also be used with other classes and can be removed, if you would
8656 rather use something else.) Less commonly used environments are in the
8657 \begin_inset Flex Code
8660 \begin_layout Plain Layout
8661 Theorems (AMS-Extended)
8666 module, which must be loaded manually.
8669 \begin_layout Standard
8670 By default, theorems and the like are numbered consecutively throughout
8671 the document, but this may be modified by loading the module
8672 \begin_inset Flex Code
8675 \begin_layout Plain Layout
8676 Theorems (Order by Section)
8681 or, if you are using
8682 \begin_inset Flex Code
8685 \begin_layout Plain Layout
8692 \begin_inset Flex Code
8695 \begin_layout Plain Layout
8696 Theorems (Order by Chapter)
8702 These will number the results as
8703 \begin_inset Formula $n.m$
8706 , where the first number refers to the section (or chapter) and the second
8707 refers to the total number of results so far in that section (or chapter).
8708 Many environments are also available unnumbered.
8709 These are indicated by an asterisk at the end.
8710 If you happen to want
8714 unnumbered results, the module
8715 \begin_inset Flex Code
8718 \begin_layout Plain Layout
8724 provides that option.
8727 \begin_layout Standard
8728 Note that these modules do not
8732 to be used with the AMS classes.
8733 It is perfectly possible to use the
8734 \begin_inset Flex Code
8737 \begin_layout Plain Layout
8743 module, and the others mentioned, with other classes, such as
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8754 \begin_inset Flex Code
8757 \begin_layout Plain Layout
8764 \begin_inset Flex Code
8767 \begin_layout Plain Layout
8776 \begin_layout Subsection
8777 What these layouts provide
8780 \begin_layout Standard
8781 There is a long list of included environments provided by these layouts.
8782 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
8783 variety of `theorem' environments.
8784 However, the AMS recommends the environments that are available in LyX.
8788 \begin_layout Standard
8789 The following environments—as well as the standard environments, such as
8791 \begin_inset Flex Noun
8794 \begin_layout Plain Layout
8801 \begin_inset Flex Noun
8804 \begin_layout Plain Layout
8811 \begin_inset Flex Noun
8814 \begin_layout Plain Layout
8821 \begin_inset Flex Noun
8824 \begin_layout Plain Layout
8831 \begin_inset Flex Noun
8834 \begin_layout Plain Layout
8841 \begin_inset Flex Code
8844 \begin_layout Plain Layout
8851 \begin_inset Flex Code
8854 \begin_layout Plain Layout
8863 \begin_layout Description
8864 Address This should be the author's permanent address.
8867 \begin_layout Description
8869 \begin_inset space ~
8872 Address This should be the author's temporary address at the time of submission,
8873 if different from the Address.
8876 \begin_layout Description
8877 Email Author's e-mail address
8880 \begin_layout Description
8881 URL Author's Web address, if desired.
8884 \begin_layout Description
8885 Keywords Key words or phrases used to identify specific topics discussed
8889 \begin_layout Description
8890 Subjectclass These refer to the AMS Subject Classifications, published and
8893 Mathematical Reviews
8896 These are also available online at the AMS cites listed above.
8899 \begin_layout Description
8903 \begin_layout Description
8907 \begin_layout Description
8911 \begin_layout Standard
8912 The following environments are provided by both the
8913 \begin_inset Flex Code
8916 \begin_layout Plain Layout
8923 \begin_inset Flex Code
8926 \begin_layout Plain Layout
8932 modules, in the latter case in both starred (unnumbered) and unstarred
8933 (numbered) versions.
8934 These same environments are provided only in the starred versions by the
8936 \begin_inset Flex Code
8939 \begin_layout Plain Layout
8948 \begin_layout Theorem
8949 This is typically used for the statements of major results.
8953 \begin_layout Corollary*
8954 This is used for statements which follow fairly directly from previous statement
8956 Again, these can be major results.
8961 These are smaller results needed to prove other statements.
8964 \begin_layout Proposition
8965 These are less major results which (hopefully) add to the general theory
8969 \begin_layout Conjecture
8970 These are statements provided without justification, which the author does
8971 not know how to prove, but which seem to be true (to the author, at least).
8974 \begin_layout Definition*
8975 Guess what this is for.
8976 The font is different for this environment than for the previous ones.
8980 \begin_layout Example*
8981 Used for examples illustrating proven results.
8984 \begin_layout Problem
8985 It's not really known what this is for.
8986 You should figure it out.
8989 \begin_layout Exercise*
8990 Write a description for this one.
8993 \begin_layout Remark
8994 This environment is also a type of theorem, usually a lesser sort of observation.
8997 \begin_layout Claim*
8998 Often used in the course of giving a proof of a larger result.
9002 Generally, these are used to break up long arguments, using specific instances
9008 The numbering scheme for cases is on its own, not together with other numbered
9014 At the end of this environment, a QED symbol (usually a square, but it can
9015 vary with different styles) is placed.
9016 If you want to have other environments within this one—for example, Case
9017 environments—and have the QED symbol appear only after them, then the other
9018 environments need to be nested within the proof environment.
9021 Nesting Environments
9027 for information on nesting.
9030 \begin_layout Standard
9031 And these environments are provided by
9032 \begin_inset Flex Code
9035 \begin_layout Plain Layout
9036 Theorems (AMS-Extended)
9044 \begin_layout Criterion*
9045 A required condition.
9048 \begin_layout Algorithm*
9049 A general procedure to be used.
9052 \begin_layout Axiom*
9053 This is a property or statement taken as true within the system being discussed.
9056 \begin_layout Condition*
9057 Sometimes used to state a condition assumed within the present context of
9062 Similar to a Remark.
9065 \begin_layout Notation*
9066 Used for the explanation of, yes, notation.
9069 \begin_layout Summary
9070 Do we really need to tell you?
9073 \begin_layout Acknowledgement*
9077 \begin_layout Conclusion*
9078 Sometimes used at the end of a long train of argument.
9082 Used in a way similar to Proposition, though perhaps lower on the scale.
9085 \begin_layout Standard
9086 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
9088 They need to be available on your system in order to use these environments.
9091 \begin_layout Section
9099 \begin_layout Standard
9105 \begin_layout Subsection
9109 \begin_layout Standard
9110 These are the layout files for some of the journals of the American Geophysical
9112 It is assumed that you have both the AGU's own class files and AGUplus
9113 installed (everything to be found at
9114 \begin_inset Flex URL
9117 \begin_layout Plain Layout
9119 ftp://ftp.agu.org/journals/latex/journals
9127 \begin_layout Subsection
9131 \begin_layout Standard
9141 They are still called this in the LyX GUI, though their LaTeX equivalents
9142 in the AGU classes are
9153 \begin_layout Standard
9154 Newly defined styles are
9191 These are mostly manuscript attributes and defined in the AGU class documentati
9195 \begin_layout Standard
9196 I suspect this is still badly incomplete.
9199 \begin_layout Subsection
9203 \begin_layout Standard
9220 \begin_layout Subsection
9224 \begin_layout Itemize
9227 Journal of Geophysical Research
9236 \begin_layout Standard
9237 Add your own, it isn't so hard! Look at the
9248 \begin_layout Subsection
9249 Bugs and things to remember
9252 \begin_layout Standard
9253 In order to use the new layouts, you must remember to do the following for
9257 \begin_layout Enumerate
9263 This can be done in the
9265 Layout\SpecialChar \menuseparator
9270 Document\SpecialChar \menuseparator
9274 (AGU articles are always in English, right? So
9281 \begin_layout Enumerate
9291 (Yes, this is a bug.)
9294 \begin_layout Enumerate
9295 Make sure you use the
9299 bibliography style, by entering
9303 into the second field of the BibTeX inset.
9304 None of the standard styles will do.
9307 \begin_layout Section
9311 \begin_layout Standard
9317 \begin_layout Subsection
9321 \begin_layout Standard
9322 Broadway is for writing plays.
9323 The format is more decorative than Hollywood, and much less standardized.
9324 This format should be suitable for workshops.
9327 \begin_layout Subsection
9331 \begin_layout Standard
9332 The same as in Hollywood.
9335 \begin_layout Subsection
9339 \begin_layout Standard
9344 names as labels then cross-reference the label to insert the name.
9345 The cross-reference dialog will show the current cast of characters.
9348 \begin_layout Subsection
9349 Paper size and Margins
9352 \begin_layout Standard
9353 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9356 \begin_layout Subsection
9360 \begin_layout Standard
9361 The following environments are available.
9362 You can use broadway.bind to get the bind keys shown at the right.
9365 \begin_layout Itemize
9369 \begin_inset Newline newline
9374 You should not have to use this, but it is here for anything that does not
9378 \begin_layout Itemize
9382 \begin_inset space \hfill{}
9386 \begin_inset Newline newline
9391 Used to describe stage setting and the action.
9392 First use of speaker names in all CAPs.
9395 \begin_layout Itemize
9399 \begin_inset space \hfill{}
9403 \begin_inset Newline newline
9408 Automatically numbered.
9409 On screen it will be arabic, but will print as Roman.
9412 \begin_layout Itemize
9416 \begin_inset space \hfill{}
9420 \begin_inset Newline newline
9430 It is just centered text.
9433 \begin_layout Itemize
9437 \begin_inset space \hfill{}
9441 \begin_inset Newline newline
9446 Not automatically numbered.
9447 You supply the number.
9448 This is because I couldn't figure out how.
9451 \begin_layout Itemize
9455 \begin_inset space \hfill{}
9459 \begin_inset Newline newline
9464 A special case of Narrative to describe the setting and action as the curtain
9468 \begin_layout Itemize
9472 \begin_inset space \hfill{}
9476 \begin_inset Newline newline
9481 The speaker's (actor's) title, centered in all CAPS.
9484 \begin_layout Itemize
9488 \begin_inset space \hfill{}
9492 \begin_inset Newline newline
9497 Instructions to the speaker.
9498 The parentheses are automatically inserted.
9499 The ( will appear on screen, but both will be in the printed play.
9500 This environment is only used within
9507 \begin_layout Itemize
9511 \begin_inset space \hfill{}
9515 \begin_inset Newline newline
9520 What the Speaker says.
9523 \begin_layout Itemize
9527 \begin_inset space \hfill{}
9531 \begin_inset Newline newline
9536 The curtain comes down.
9539 \begin_layout Itemize
9543 \begin_inset space \hfill{}
9549 \begin_layout Itemize
9553 \begin_inset space \hfill{}
9559 \begin_layout Itemize
9563 \begin_inset space \hfill{}
9569 \begin_layout Standard
9573 \begin_layout Section
9577 \begin_layout Standard
9582 can be used to type letters according to German conventions.
9583 A template file is included in
9585 .../lyx/share/templates
9587 for you to use as a starting point.
9590 \begin_layout Section
9598 \begin_layout Standard
9604 \begin_layout Subsection
9608 \begin_layout Standard
9609 This is the layout file for the European Geophysical Society journals.
9614 can be downloaded from the web site of the EGS under
9615 \begin_inset Flex URL
9618 \begin_layout Plain Layout
9628 \begin_layout Subsection
9632 \begin_layout Standard
9635 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9643 The current layout file is unfortunately very unmodular and would benefit
9644 from using the various
9651 \begin_layout Section
9655 \begin_layout Standard
9661 \begin_layout Standard
9662 Elsevier Science Publishers B.V.
9663 provides a standard LaTeX document class (
9667 ) for submitting articles to their various journals.
9668 The style file can be downloaded directly from their web site:
9669 \begin_inset Flex URL
9672 \begin_layout Plain Layout
9674 http://www.elsevier.com/wps/find/authorsview.authors/latex
9680 Instructions are supplied along with the class file, which details the
9681 requirements of the publishers.
9682 LyX includes a package that allows for the use of this class, by a layout
9683 and a template file.
9684 Installation of the class file is the same as for any other LaTeX package;
9685 instructions are provided in the Elsevier documentation.
9688 \begin_layout Standard
9698 As the Elsevier class file is based mainly on the standard article class,
9699 most of the normal functionality is provided.
9700 The Elsevier class defines a number of mathematical environments, which
9701 are similar to the AMS environments.
9702 These commands are all described in the Elsevier documentation, and are
9706 \begin_layout Standard
9707 The easiest way to use the Elsevier style is to base documents on the included
9709 It is best not to use options such as fancy headings or the geometry package,
9710 as elements such as these are defined by Elsevier in their style file.
9711 Ideally, no extra packages except those mentioned in the Elsevier documentation
9713 Essentially, Elsevier require as
9714 \begin_inset Quotes eld
9718 \begin_inset Quotes erd
9721 a LaTeX file as possible, as their intention is to take the supplied file
9722 and replace the class file with one for the particular journal to which
9723 the paper has been submitted.
9724 This also means that not too much time should be spent on the formating
9726 When it comes to be published, this will change anyway.
9727 The rest of the usage for this layout is substantially the same as for
9728 the normal article class.
9729 For details of what Elsevier do and don't allow, refer to their documentation.
9732 \begin_layout Section
9738 \begin_inset CommandInset label
9747 \begin_layout Standard
9753 \begin_layout Subsection
9757 \begin_layout Standard
9758 This section describes how to use LyX to make slides for overhead projectors.
9759 There are two document classes that can do this: the default slides class
9765 This section documents the latter.
9768 \begin_layout Standard
9769 I'm going to say this again, nice and clear, so that there's no misunderstanding
9773 \begin_layout Standard
9774 \begin_inset VSpace bigskip
9780 \begin_layout Standard
9784 This section documents the class
9785 \begin_inset Quotes eld
9793 \begin_inset Quotes erd
9801 \begin_layout Standard
9802 \begin_inset VSpace bigskip
9808 \begin_layout Standard
9809 If you're looking for the documentation for
9810 \begin_inset Quotes eld
9818 \begin_inset Quotes erd
9822 \begin_inset space ~
9826 \begin_inset CommandInset ref
9828 reference "sec:slitex"
9833 If your machine doesn't have the
9838 \begin_inset Quotes eld
9846 \begin_inset Quotes erd
9849 ] installed, you'll probably have to use the default
9853 class, which isn't quite as good as
9858 \begin_layout Standard
9863 class is designed for use with version 2.1 of the
9867 LaTeX class file which is now an integral part of LaTeX2e.
9870 \begin_layout Subsection
9874 \begin_layout Standard
9875 Obviously, to use this document class, you need to select
9876 \begin_inset Quotes eld
9884 \begin_inset Quotes erd
9894 \begin_inset space ~
9900 There are some settings in the
9903 \begin_inset space ~
9908 dialog that you should know about that are specific to this class:
9911 \begin_layout Itemize
9912 Don't change the options
9923 \begin_inset space ~
9929 They're ignored by the
9936 \begin_layout Itemize
9937 The default font size is 20
9938 \begin_inset space \thinspace{}
9941 pt with the other options being 17
9942 \begin_inset space \thinspace{}
9946 \begin_inset space \thinspace{}
9950 \begin_inset space \thinspace{}
9956 \begin_layout Itemize
9965 but all math equations are still typeset in the usual roman font.
9968 \begin_layout Itemize
9973 supports A4 and Letter paper sizes as well as a special size for working
9975 \begin_inset space \thinspace{}
9979 It doesn't support A5, B5, legal or executive paper sizes.
9982 \begin_layout Itemize
9983 Don't bother changing the
9987 settings because they are ignored anyway.
9988 All floats appear where they are defined in the text.
9991 \begin_layout Itemize
9996 setting behaves a bit differently for this class.
10001 provides extensive footer and header capabilities including a user-defined
10004 \begin_inset space ~
10008 \begin_inset CommandInset ref
10010 reference "sec:foilfoot"
10015 The title page is treated differently to all other pages in the document
10024 has the logo centered at the bottom of the page (if one is defined).
10025 The possible page style choices and what they do are as follows:
10029 \begin_layout Labeling
10030 \labelwidthstring MMMMMMM
10037 The final output contains no page numbers, or other headers or footers
10038 (except footnotes of course).
10042 \begin_layout Labeling
10043 \labelwidthstring MMMMMMM
10050 The final output contains page numbers centered at the bottom of the page.
10051 No other headings or footers (other than footnotes).
10054 \begin_layout Labeling
10055 \labelwidthstring MMMMMMM
10060 Page numbers in lower right corner.
10061 Additional headers and footers are also shown.
10062 This is also the default.
10065 \begin_layout Labeling
10066 \labelwidthstring MMMMMMM
10071 Gives you access to the
10075 package although its use with
10079 is discouraged by the writer of the
10083 package because of some potential page layout clashes.
10087 \begin_layout Subsubsection
10091 \begin_layout Standard
10092 The following options may be used in the extra class options in the
10094 Document\SpecialChar \menuseparator
10100 \begin_layout Labeling
10101 \labelwidthstring MMMMMMx
10106 This sets up the page layout for 7.33
10107 \begin_inset space \thinspace{}
10111 \begin_inset space \thinspace{}
10114 in paper, which is about the same aspect ratio as a 35
10115 \begin_inset space \thinspace{}
10118 mm slide, making it a bit easier to work with this medium.
10121 \begin_layout Labeling
10122 \labelwidthstring MMMMMMx
10127 Places a rule across the page below the header on every page except the
10131 \begin_layout Labeling
10132 \labelwidthstring MMMMMMx
10137 Places a rule across the page above the footer on every page except the
10141 \begin_layout Labeling
10142 \labelwidthstring MMMMMMx
10147 This is automatically set each time you create a new
10156 to use the dvips driver to rotate those pages that are set as landscape
10160 \begin_layout Labeling
10161 \labelwidthstring MMMMMMx
10166 Simply changes the page dimensions to those of a landscape page but doesn't
10168 Thus if you use this option you need to use an external program to rotate
10169 each page or feed your paper through your printer as landscape.
10170 Note that this option effectively reverses the roles of the
10178 environments (don't worry these are described in the next section).
10181 \begin_layout Labeling
10182 \labelwidthstring MMMMMMx
10187 Equation numbers on the left.
10190 \begin_layout Labeling
10191 \labelwidthstring MMMMMMx
10196 Flush-left equations.
10199 \begin_layout Subsection
10200 Supported Environments
10203 \begin_layout Standard
10204 Most of the environments commonly supported in other classes are also supported
10210 There are several additional environments provided by
10214 as well as a couple added by LyX.
10215 The following environments are shared with other classes:
10218 \begin_layout Standard
10222 \begin_layout Plain Layout
10226 begin{multicols}{2}
10234 \begin_layout Itemize
10240 \begin_layout Itemize
10246 \begin_layout Itemize
10252 \begin_layout Itemize
10258 \begin_layout Itemize
10264 \begin_layout Itemize
10270 \begin_layout Itemize
10276 \begin_layout Itemize
10282 \begin_layout Itemize
10288 \begin_layout Itemize
10294 \begin_layout Itemize
10300 \begin_layout Itemize
10306 \begin_layout Itemize
10312 \begin_layout Itemize
10318 \begin_layout Itemize
10324 \begin_layout Itemize
10330 \begin_layout Itemize
10336 \begin_layout Itemize
10342 \begin_layout Standard
10346 \begin_layout Plain Layout
10358 \begin_layout Standard
10359 That is, all the major environments apart from the sectioning environments.
10360 Since foils are essentially self-contained sections, with a title and body,
10365 provides specific commands for starting new foils and these are:
10368 \begin_layout Itemize
10374 \begin_layout Itemize
10380 \begin_layout Standard
10381 LyX also provides slightly modified versions of these two environments called:
10384 \begin_layout Itemize
10390 \begin_layout Itemize
10393 ShortRotatefoilhead
10396 \begin_layout Standard
10397 and the differences will be explained in the next section.
10400 \begin_layout Standard
10401 Since foils are often used in presenting ideas or new theorems and such
10406 also provides a comprehensive box of goodies for presenting them:
10409 \begin_layout Standard
10413 \begin_layout Plain Layout
10417 begin{multicols}{2}
10425 \begin_layout Itemize
10431 \begin_layout Itemize
10437 \begin_layout Itemize
10443 \begin_layout Itemize
10449 \begin_layout Itemize
10455 \begin_layout Itemize
10461 \begin_layout Itemize
10467 \begin_layout Itemize
10473 \begin_layout Itemize
10479 \begin_layout Itemize
10485 \begin_layout Itemize
10491 \begin_layout Standard
10495 \begin_layout Plain Layout
10507 \begin_layout Standard
10508 The starred versions are unnumbered while the unstarred versions are numbered.
10509 There are also two list environments added by LyX and these are:
10512 \begin_layout Itemize
10518 \begin_layout Itemize
10524 \begin_layout Standard
10529 provides some powerful header and footer capabilities that are best set
10530 in the preamble although they may be set at any point in a document.
10531 If you want to change these settings in your document the best place to
10532 do so is at the very top of a foil, i.
10533 \begin_inset space \thinspace{}
10539 \begin_inset space \space{}
10544 straight after the foilhead.
10547 \begin_layout Standard
10548 For this purpose, the following command styles are provided [
10555 \begin_layout Standard
10559 \begin_layout Plain Layout
10563 begin{multicols}{2}
10571 \begin_layout Itemize
10575 \begin_inset space ~
10581 \begin_layout Itemize
10587 \begin_layout Itemize
10591 \begin_inset space ~
10597 \begin_layout Itemize
10601 \begin_inset space ~
10607 \begin_layout Itemize
10611 \begin_inset space ~
10618 \begin_layout Standard
10619 \begin_inset space ~
10626 \begin_layout Standard
10630 \begin_layout Plain Layout
10642 \begin_layout Standard
10643 There are also a few commands provided by
10647 that aren't directly supported by LyX but I'll tell you what they do and
10648 how to use them in section
10649 \begin_inset space ~
10653 \begin_inset CommandInset ref
10655 reference "sec:unsuppfoils"
10662 \begin_layout Subsection
10663 Building a Set of Foils
10666 \begin_layout Standard
10667 This section will give a simple introduction to using the different environments
10668 to build a set of foils.
10669 If you want to see an example set of foils, take a look at the
10673 file you find in LyX's
10680 \begin_layout Subsubsection
10681 Give It a Title Page
10684 \begin_layout Standard
10685 Unlike other classes that provide
10705 creates the title on a page of its own.
10706 If you leave out the
10710 environment LaTeX will substitute the current date (every time you regenerate
10714 \begin_layout Subsubsection
10718 \begin_layout Standard
10719 As I mentioned earlier, there are four ways of starting a new foil.
10720 For portrait foils you should use
10729 The difference between these two environments is the amount of space between
10730 the title of the foil (the foilhead) and the body of the foil.
10733 \begin_layout Standard
10734 Landscape foils are generated using the
10740 ShortRotatefoilhead
10743 Again the only difference is the spacing between foilhead and body.
10744 Both of the short versions have 0.5 inches less separation between the foilhead
10749 \begin_layout Standard
10750 One problem with the support for landscape foils is the requirement that
10751 you have to use the
10755 driver to generate the PostScript output otherwise the foils won't be rotated.
10756 It is possible to get landscape foils even if you haven't got the
10760 driver provided you can feed your foils sideways through your printer ;-)
10763 \begin_layout Subsubsection
10764 Theorems, Lemmas, Proofs and more
10767 \begin_layout Standard
10768 Due to a small bug in LyX you can't have two of the same type of these environme
10769 nts directly following each other.
10770 They must be separated by something.
10771 If you try, you will just be extending the previous environment as if you
10772 had merged the two environments together.
10773 So, how do you get around this problem? The simplest option is to insert
10774 some text between the two environments or add a
10778 environment between the two with just a
10779 \begin_inset Quotes eld
10787 \begin_inset Quotes erd
10791 This will force LyX to produce two separate environments and hence the
10792 correct LaTeX output.
10793 An example is provided in the example file included with the LyX distribution.
10794 Remember, this problem only occurs if you are trying to place two of the
10795 same type of theorem-like environments one directly after the other.
10798 \begin_layout Subsubsection
10802 \begin_layout Standard
10803 You get all the commonly supported list styles found in other classes as
10804 well as two new ones.
10805 I'll only describe the new ones here.
10806 If you want to find out more about the other list environments check out
10812 If you intend to use itemized lists you might also want to read about the
10816 \begin_inset space ~
10820 \begin_inset space ~
10825 dialog described above in section
10826 \begin_inset space ~
10830 \begin_inset CommandInset ref
10832 reference "sec:bullet"
10839 \begin_layout Standard
10840 The two new list styles,
10848 , are designed to make it easier for you to create lists of do's and don'ts
10849 or right and wrong by providing dedicated environments that use a tick
10850 or a cross as the label of the list.
10851 These lists are in fact dedicated variants of the
10856 They do however require that you have the
10860 packages installed.
10863 \begin_layout Subsubsection
10867 \begin_layout Standard
10872 redefines the floating tables and figures so that they appear exactly where
10873 they are in the text rather than pushing them to the top of the page or
10874 to some user specified location.
10875 In fact if you change the float placement settings they are simply ignored.
10878 \begin_layout Subsubsection
10879 Page Headers and Footers
10880 \begin_inset CommandInset label
10882 name "sec:foilfoot"
10889 \begin_layout Standard
10893 \begin_inset space ~
10902 are two commands used to control the left-footer text string.
10903 The first is meant to allow you to include a graphic logo on your foils
10905 \begin_inset Quotes eld
10913 \begin_inset Quotes erd
10917 While the second is meant to provide a classification for the audience,
10921 \begin_inset space \thinspace{}
10927 \begin_inset space \space{}
10931 It is empty by default.
10934 \begin_layout Standard
10935 The remaining page corners can be filled by
10938 \begin_inset space ~
10943 (which defaults to page numbers),
10946 \begin_inset space ~
10954 \begin_inset space ~
10962 \begin_layout Subsection
10968 \begin_inset CommandInset label
10970 name "sec:unsuppfoils"
10977 \begin_layout Standard
10978 All the commands mentioned below need to be set in a
10986 within another environment.
10989 \begin_layout Subsubsection
10993 \begin_layout Standard
10994 All lengths are adjusted using the
11017 should be replaced by the name given to the length you want to change and
11022 is the length value.
11023 All lengths should be specified in units of length such as inches (
11035 ) or relative to some document or font-based length such as
11045 \begin_layout Standard
11046 It's possible to change the spacing between a foilhead and the body of the
11047 foil by adjusting the length specified by
11054 For example, to make
11059 \begin_inset space \space{}
11062 in closer to their bodies put the following in the preamble:
11068 foilheadskip}{-0.5in}
11071 \begin_layout Standard
11072 The spacings around floats can be adjusted by setting these lengths:
11075 \begin_layout Labeling
11076 \labelwidthstring MMMMMMMMMMM
11083 Separation between the text and the top of the float
11086 \begin_layout Labeling
11087 \labelwidthstring MMMMMMMMMMM
11094 Separation between the float and the caption
11097 \begin_layout Labeling
11098 \labelwidthstring MMMMMMMMMMM
11105 Separation between the caption and the following text
11108 \begin_layout Labeling
11109 \labelwidthstring MMMMMMMMMMM
11116 You can make the captions narrower than the surrounding text by adjusting
11118 Best done relative to
11127 \begin_layout Standard
11128 There are also several title page related lengths that you may find useful
11129 if you have a long title or several authors:
11132 \begin_layout Labeling
11133 \labelwidthstring MMMMMMMMMMM
11140 Separation from headers to
11145 \begin_layout Labeling
11146 \labelwidthstring MMMMMMMMMMM
11164 \begin_layout Labeling
11165 \labelwidthstring MMMMMMMMMMM
11179 \begin_layout Labeling
11180 \labelwidthstring MMMMMMMMMMM
11196 \begin_layout Labeling
11197 \labelwidthstring MMMMMMMMMMM
11213 \begin_layout Standard
11214 The last length related command affects all the list environments.
11225 a list environment then all the vertical spacing between the list items
11227 Note that this is a command not a length so it doesn't require
11233 like the stuff mentioned above.
11236 \begin_layout Subsubsection
11237 Headers and Footers
11240 \begin_layout Standard
11253 commands control whether the logo in the
11257 definition appear on a given page.
11264 in the preamble then none of the foils will have the logo on them.
11265 If you don't want the logo on a particular page place the
11271 directly after the foilhead of that page and the
11277 directly after the next foilhead.
11280 \begin_layout Standard
11281 If you decide to use the
11285 page style setting in the
11288 \begin_inset space ~
11293 dialog you should probably add
11303 to your preamble so headers and footers on landscape pages are correctly
11304 placed when rotated.
11305 This is due to some clashes between the page layouts provided by the
11316 \begin_layout Section
11317 Hollywood (Hollywood spec scripts)
11320 \begin_layout Standard
11326 \begin_layout Subsection
11330 \begin_layout Standard
11331 Getting the format of a Hollywood script right is a
11332 \begin_inset Quotes eld
11336 \begin_inset Quotes erd
11339 It is designed to make the readers focus on content and to be easy and
11340 familiar for the actors to read.
11341 Each page of a script should be one minute of film.
11342 Nothing goes in a script that you cannot see or hear on screen.
11343 The courier 12 pt font should be used throughout.
11347 \begin_layout Subsection
11351 \begin_layout Standard
11352 Speakers' lines should NEVER break in mid-sentence.
11353 If a speaker's lines continue over a page break, repeat the
11357 title followed by (Cont'd).
11360 \begin_layout Subsection
11364 \begin_layout Standard
11369 names as labels then cross-reference the label to insert the name.
11370 The cross-reference dialog will show the current cast of characters.
11371 You can use this to insert the speaker name in narratives also.
11374 \begin_layout Subsection
11375 Paper size and Margins
11378 \begin_layout Standard
11379 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11382 \begin_layout Subsection
11386 \begin_layout Standard
11387 The following environments are available.
11388 You can use hollywood.bind to get the bind keys shown at the right.
11391 \begin_layout Itemize
11395 \begin_inset Newline newline
11400 Used where nothing else works.
11404 \begin_layout Itemize
11410 \begin_inset space \hfill{}
11418 \begin_inset Newline newline
11421 Usually followed by something like
11422 \begin_inset Quotes eld
11425 on Sally waking up.
11426 \begin_inset Quotes erd
11432 \begin_layout Itemize
11436 \begin_inset space \hfill{}
11440 \begin_inset Newline newline
11445 Introduces a new INTERIOR camera set-up.
11446 Always followed by DAY or NIGHT, or something similar to define the lighting
11448 Everthing on this line in CAPS.
11451 \begin_layout Itemize
11455 \begin_inset space \hfill{}
11459 \begin_inset Newline newline
11464 Introduces a new EXTERIOR camera set-up.
11465 Everthing on this line in CAPS.
11468 \begin_layout Itemize
11472 \begin_inset space \hfill{}
11476 \begin_inset Newline newline
11481 The character speaking.
11484 \begin_layout Itemize
11488 \begin_inset space \hfill{}
11492 \begin_inset Newline newline
11497 Instructions to the speaker.
11498 The () are automatically inserted, but only the ( will show in LyX.
11499 Both will be printed.
11502 \begin_layout Itemize
11506 \begin_inset space \hfill{}
11510 \begin_inset Newline newline
11522 \begin_layout Itemize
11526 \begin_inset space \hfill{}
11530 \begin_inset Newline newline
11535 Camera movement instruction.
11537 \begin_inset space \thinspace{}
11541 \begin_inset space \space{}
11547 \begin_layout Itemize
11551 \begin_inset space \hfill{}
11557 \begin_layout Itemize
11561 \begin_inset space \hfill{}
11567 \begin_layout Itemize
11571 \begin_inset space \hfill{}
11577 \begin_layout Itemize
11581 \begin_inset space \hfill{}
11587 \begin_layout Subsection
11591 \begin_layout Itemize
11595 \begin_layout Itemize
11599 \begin_layout Itemize
11601 \begin_inset space \thinspace{}
11608 \begin_layout Itemize
11613 \begin_layout Itemize
11614 PAN — camera movement
11617 \begin_layout Itemize
11618 INSERT — cut to close-up of
11621 \begin_layout Section
11625 \begin_layout Standard
11628 Panayotis Papasotiriou
11631 \begin_layout Subsection
11635 \begin_layout Standard
11636 The ijmpc package is a set of macros that facilitates electronic manuscript
11639 International Journal of Modern Physics C
11642 Similarly, the ijmpd package is for creating manuscripts to be submitted
11645 International Journal of Modern Physics D
11648 Both journals are published by World Scientific.
11649 The corresponding document classes are named
11658 These files, together with instructions for the authors, can be downloaded
11660 \begin_inset Flex URL
11663 \begin_layout Plain Layout
11665 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11671 \begin_inset Flex URL
11674 \begin_layout Plain Layout
11676 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11682 Both packages are modified versions of the standard
11683 \begin_inset Quotes eld
11687 \begin_inset Quotes erd
11690 package, and they are almost (but not exactly) identical.
11691 Most of their features are supported by LyX.
11692 I have used LyX successfully to write articles submitted to both journals
11693 without any problem.
11696 \begin_layout Subsection
11700 \begin_layout Standard
11701 As usual, the easiest way to write a paper is to start with a template.
11704 File\SpecialChar \menuseparator
11723 This will give an (almost) empty document that includes the most common
11724 fields found in a manuscript.
11725 Simply overwrite the existing text (including the brackets,
11730 You should keep in mind the following remarks.
11733 \begin_layout Enumerate
11734 LyX won't let you change the font size and the page style of the document,
11735 because such modifications are not allowed by both packages.
11738 \begin_layout Enumerate
11739 The language of the document should not be changed.
11740 Before previewing your paper, be sure that the babel package is not used.
11741 To do this, click on
11743 Tools\SpecialChar \menuseparator
11754 checkbox in the language settings, and click on
11762 , if you wish to make this change permanent).
11765 \begin_layout Enumerate
11767 \begin_inset Quotes eld
11771 \begin_inset Quotes erd
11774 style must be used to define keywords.
11777 \begin_layout Enumerate
11778 The ijmpc package provides a style named
11779 \begin_inset Quotes eld
11782 Classification Codes
11783 \begin_inset Quotes erd
11786 , which can be used to define classification codes, such as PACS numbers.
11787 Note that this facility is not supported by the ijmpd package.
11790 \begin_layout Enumerate
11791 Several new environments are available:
11792 \begin_inset Quotes eld
11796 \begin_inset Quotes erd
11800 \begin_inset Quotes eld
11804 \begin_inset Quotes erd
11808 \begin_inset Quotes eld
11812 \begin_inset Quotes erd
11816 \begin_inset Quotes eld
11820 \begin_inset Quotes erd
11824 \begin_inset Quotes eld
11828 \begin_inset Quotes erd
11832 \begin_inset Quotes eld
11836 \begin_inset Quotes erd
11840 \begin_inset Quotes eld
11844 \begin_inset Quotes erd
11848 \begin_inset Quotes eld
11852 \begin_inset Quotes erd
11856 \begin_inset Quotes eld
11860 \begin_inset Quotes erd
11864 \begin_inset Quotes eld
11868 \begin_inset Quotes erd
11872 \begin_inset Quotes eld
11876 \begin_inset Quotes erd
11880 \begin_inset Quotes eld
11884 \begin_inset Quotes erd
11888 \begin_inset Quotes eld
11892 \begin_inset Quotes erd
11896 \begin_inset Quotes eld
11900 \begin_inset Quotes erd
11904 Their use is more or less obvious.
11905 LyX supports all these environments; it will use the proper label, text
11906 style, and numbering scheme for each of them.
11909 \begin_layout Enumerate
11910 Both packages use basic citations; the natbib package should not be used.
11911 In LyX, citation references are shown as usual; in the output, citations
11912 are shown as superscripts.
11913 If you want to use a citation as normal text, you should use the
11918 \begin_inset space \thinspace{}
11922 \begin_inset space \space{}
11926 \begin_inset Quotes eld
11930 \begin_inset space \space{}
11940 \begin_inset Quotes erd
11946 \begin_layout Enumerate
11948 \begin_inset Quotes eld
11952 \begin_inset Quotes erd
11955 section in both packages.
11956 To put acknowledgments, just use the
11957 \begin_inset Quotes eld
11961 \begin_inset Quotes erd
11967 \begin_layout Enumerate
11968 Appendices may be added to the paper,
11972 the Acknowledgments and
11977 LyX provides a special environment, called
11978 \begin_inset Quotes eld
11982 \begin_inset Quotes erd
11985 which marks the beginning of the appendices.
11986 This environment should be left blank; it just sends a LaTeX command, but
11987 nothing is really printed.
11989 \begin_inset Quotes eld
11993 \begin_inset Quotes erd
11996 is printed with blue letters, as a signal that all sections after that
11997 point are appendices.
11998 To write an appendix, use the
11999 \begin_inset Quotes eld
12003 \begin_inset Quotes erd
12007 LyX will number each appendix with capital letters, as required by both
12010 \begin_inset Quotes eld
12014 \begin_inset Quotes erd
12021 be present before the first appendix; if not, all appendices will be numbered
12022 as normal sections in the output.
12025 \begin_layout Enumerate
12026 The ijmpc and the ijmpd packages use the
12030 command to implement table captions.
12031 As a result, a table created by LyX is printed correctly, but its caption
12033 However, you can use some TeX code to overcome this problem, so that captions
12034 are printed as expected.
12035 To do so, create a float table as usual, remove the caption, and replace
12036 it with the TeX code
12046 (sic); you must also the TeX code
12050 immediately after the tabular material.
12051 Study the example table included in the template files to see how this
12052 trick is implemented.
12053 Alternatively, If you need table captions, you should implement the whole
12058 file, then include this file to the LyX document (
12060 Insert\SpecialChar \menuseparator
12061 File\SpecialChar \menuseparator
12063 \begin_inset space ~
12069 Details on how to create a table float can be found in the files
12077 , included in the corresponding packages.
12080 \begin_layout Subsection
12081 Preparing a paper for submission
12084 \begin_layout Standard
12085 Before you submit your paper you must export the LyX document as a LaTeX
12088 File\SpecialChar \menuseparator
12089 Export\SpecialChar \menuseparator
12096 \begin_layout Plain Layout
12097 Actually you have the choice between LaTeX (plain) and pdflatex.
12098 If you intend to use pdflatex to prepare the paper, you should use the
12099 pdflatex option so that included graphics are converted to PDF format,
12100 ready for use by pdflatex.
12105 , then make the following changes to the resulting
12112 \begin_layout Enumerate
12113 Remove the comment lines before the
12122 \begin_layout Enumerate
12123 Remove everything between (and including) the
12135 commands, except for any commands you specifically put into the LaTeX preamble.
12138 \begin_layout Standard
12143 file should be saved and processed through LaTeX as many times as necessary.
12144 You may also want to check the resulting
12151 \begin_layout Subsection
12155 \begin_layout Standard
12156 The use of TeX code is reduced to two commands, which must be placed at
12157 the top of the document.
12158 If you started writing your paper by using the
12166 template, the TeX code needed is already in its place; you usually don't
12168 You may only modify the first TeX code to specify the information printed
12169 to the top of odd and even pages (authors' names and short paper's title,
12171 This TeX code must have the form
12175 markboth{Authors' Names}{Short Paper's Title}
12180 \begin_layout Section
12184 \begin_layout Standard
12190 \begin_layout Subsection
12194 \begin_layout Standard
12195 The iopart package provides a document class to create electronic manuscript
12196 submission to the journals published by the Institute of Physics.
12197 Instructions for the authors how to create a paper using the iopart class
12198 can be downloaded together with the iopart package from the site
12199 \begin_inset Flex URL
12202 \begin_layout Plain Layout
12204 ftp://ftp.iop.org/pub/journals/latex2e
12212 \begin_layout Subsection
12216 \begin_layout Standard
12217 The easiest way to write a paper is to start with the file
12221 that is available in LyX's examples files folder.
12222 Open this file, save it under a new name, and start writing.
12223 The example file explains how to use the special text environments.
12224 Here are the most important advices:
12227 \begin_layout Itemize
12228 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12231 Use AMS math package
12233 in the document settings under
12240 \begin_layout Itemize
12243 The title environment defines the kind of your paper.
12244 So use one of the following environments for the title:
12248 \begin_layout Itemize
12257 \begin_layout Itemize
12266 \begin_layout Itemize
12272 for a Topical review
12275 \begin_layout Itemize
12284 \begin_layout Itemize
12293 \begin_layout Itemize
12299 for a Paper (same as Title)
12302 \begin_layout Itemize
12308 for a Preliminary communication
12311 \begin_layout Itemize
12317 for a Rapid communication
12320 \begin_layout Itemize
12326 for a Letter to the editor
12330 \begin_layout Itemize
12333 All title environments except of
12337 can have an optional short title.
12340 \begin_layout Itemize
12341 There is a general title environment
12345 which is not directly supported by the LyX.
12346 This can be used as TeX code when your document doesn't fit into one of
12347 the other title types.
12350 \begin_layout Standard
12351 For more informations like hints for special table and formula formatting,
12352 look at the IOP author guidelines.
12355 \begin_layout Section
12359 \begin_layout Standard
12362 Panayotis Papasotiriou
12365 \begin_layout Subsection
12369 \begin_layout Standard
12370 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
12371 that facilitates electronic manuscript submission to the journals they
12373 Most known of them (at least in my domain of interest) are
12375 Astrophysics and Space Science
12381 , but there are many others (see a complete list at
12382 \begin_inset Flex URL
12385 \begin_layout Plain Layout
12387 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12393 The Kluwer package may be downloaded from the site
12394 \begin_inset Flex URL
12397 \begin_layout Plain Layout
12399 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12405 A complete user guide is contained in that package (but it can also be
12406 downloaded separately).
12409 \begin_layout Standard
12410 LyX supports many features of the package but not everything.
12411 However, the TeX code needed is reduced to some
12412 \begin_inset Quotes eld
12416 \begin_inset Quotes erd
12419 commands of the package (see
12420 \begin_inset space ~
12424 \begin_inset CommandInset ref
12426 reference "subsec:kluwer_peculiarities"
12431 I have recently used LyX to write an article submitted to the
12433 Astrophysics and Space Science
12435 without any problem.
12438 \begin_layout Subsection
12442 \begin_layout Standard
12443 The easiest way to write a paper is to start with the Kluwer template file.
12446 File\SpecialChar \menuseparator
12458 This will give an (almost) empty document that includes the most common
12459 fields found in a manuscript and a short description of their use.
12460 As in most templates, simply overwrite the existing text (including the
12465 ) with the correct information.
12468 \begin_layout Subsection
12469 Preparing a paper for submission
12472 \begin_layout Standard
12473 As in the AASTeX package, before you submit your paper to a journal you
12475 \begin_inset Quotes eld
12479 \begin_inset Quotes erd
12485 \begin_layout Enumerate
12486 Export your paper as a LaTeX file.
12487 To do this, click on
12489 File\SpecialChar \menuseparator
12490 Export\SpecialChar \menuseparator
12497 \begin_layout Enumerate
12502 file with a text editor and make the following changes
12506 \begin_layout Enumerate
12507 remove the comment lines before the
12516 \begin_layout Enumerate
12517 remove everything between (and including) the
12529 commands, except for any commands you specifically put into the LaTeX preamble.
12532 \begin_layout Standard
12541 \begin_layout Enumerate
12546 file through LaTeX as many times as necessary (usually up to three).
12549 \begin_layout Enumerate
12555 \begin_inset space \thinspace{}
12559 \begin_inset space \space{}
12566 , and check if everything is OK (it should, if you didn't make any mistake).
12569 \begin_layout Subsection
12570 \begin_inset Quotes eld
12574 \begin_inset Quotes erd
12577 of the Kluwer package
12578 \begin_inset CommandInset label
12580 name "subsec:kluwer_peculiarities"
12587 \begin_layout Standard
12588 The Kluwer package has the following
12589 \begin_inset Quotes eld
12593 \begin_inset Quotes erd
12599 \begin_layout Enumerate
12600 It is possible to write multiple articles in the same LaTeX file
12604 \begin_layout Plain Layout
12605 I can't imagine any good reason to do this.
12611 Each article must be included in the environment
12612 \begin_inset Quotes eld
12616 \begin_inset Quotes erd
12620 Unfortunately, this environment cannot be omitted, even if you write just
12622 Therefore, each article starts with the command
12628 and, obviously, ends with the command
12635 Although this can be implemented in LyX, I didn't included it, since it
12636 looks ugly and can confuse the novice user.
12637 Therefore, you need to enter them directly and mark them as LaTeX code
12639 \begin_inset Quotes eld
12643 \begin_inset Quotes erd
12649 \begin_layout Enumerate
12650 Information given at the beginning of the article (i.
12651 \begin_inset space \thinspace{}
12655 \begin_inset space \space{}
12658 title, subtitle, author, institution, running title, running author, abstract
12659 and keywords) must be included in an environment called
12660 \begin_inset Quotes eld
12664 \begin_inset Quotes erd
12668 This is not implemented in LyX, so you must enter title, subtitle etc.
12669 \begin_inset space ~
12672 between two TeX code lines (
12687 \begin_layout Enumerate
12688 According to the user manual, the label of each bibliography item must be
12712 \begin_layout Standard
12717 template takes care of all these
12718 \begin_inset Quotes eld
12722 \begin_inset Quotes erd
12726 If you start a new paper using this template you don't need to do anything
12731 \begin_layout Enumerate
12732 don't delete the TeX code included in the template, and
12735 \begin_layout Enumerate
12736 copy the example bibliography item included in the template and modify it
12737 as necessary to enter new bibliography items.
12740 \begin_layout Section
12744 \begin_layout Standard
12750 \begin_layout Subsection
12754 \begin_layout Standard
12755 The LyX document classes
12757 article (koma-script)
12761 report (koma-script)
12779 correspond to the LaTeX document classes
12796 \begin_inset space ~
12799 of the Koma-Script family.
12800 They are replacements for the standard document classes
12816 , resp., and fit better to European typography conventions in a number of
12820 \begin_layout Itemize
12821 Standard character size is 11pt in
12823 article (koma-script)
12827 report (koma-script)
12835 letter (koma-script)
12840 \begin_layout Itemize
12841 Headings, labels of the description environment, and a number of elements
12844 letter (koma-script)
12846 document class are set in a bold sans serif font.
12850 \begin_layout Plain Layout
12851 There is a big difference between the bold sans serif old cm fonts and new
12852 ec fonts, especially in the appearance of headings.
12853 In comparison, the ec bold sans serif fonts look a bit thin.
12854 Here the LaTeX package
12862 helps to produce the
12863 \begin_inset Quotes eld
12867 \begin_inset Quotes erd
12870 appearance when using the ec fonts.
12875 The numbering of chapter headings is made in the same way as the numbering
12876 of section headings, that is without the extra line
12877 \begin_inset Quotes eld
12880 Chapter\SpecialChar \ldots{}
12882 \begin_inset Quotes erd
12886 In addition, the appearance of the headings can be modified by using a
12887 number of options (in LyX to be entered in the field
12890 \begin_inset space ~
12897 Layout\SpecialChar \menuseparator
12904 \begin_layout Itemize
12905 The main means in the Koma-Script document classes to design the type area
12914 (in LyX to be entered in the extra class options field in the dialog
12916 Document\SpecialChar \menuseparator
12920 They make a clearer modification of page margins possible as do the options
12923 Document\SpecialChar \menuseparator
12930 \begin_layout Itemize
12931 The LaTeX document classes of the Koma-Script family define a number of
12932 additional commands.
12933 Those part of it which makes sense in LyX is implemented in corresponding
12937 \begin_layout Standard
12938 Detailed descriptions of the LaTeX document classes of the Koma-Script family
12939 can be found in the Koma-Script documentation
12950 \begin_layout Subsection
12951 article (koma-script), report (koma-script), and book (koma-script)
12954 \begin_layout Standard
12955 The document classes
12957 article (koma-script)
12961 report (koma-script)
12971 are implemented in the layout files
12984 They contain all the paragraph types of the corresponding standard document
12997 , resp., partly modified, with the exception of the LyX specific
13001 -type, which is replaced by the new
13005 -type having the same functionality.
13010 -Type there is a number of new paragraph types added.
13017 letter (koma-script)
13022 \begin_layout Itemize
13031 : are equivalents to
13039 , resp., additionally inserting an entry in the table of contents.
13048 are not contained in
13050 article (koma-script)
13055 \begin_layout Itemize
13064 : behave exactly as
13072 , resp., additionally clearing running heads.
13077 is not contained in
13079 article (koma-script)
13085 \begin_layout Plain Layout
13098 report (koma-script)
13100 , but since this is identical to
13104 , is has not been implemented in LyX.
13112 \begin_layout Itemize
13117 : generates a heading directly above the following paragraph in the standard
13118 character size without affecting the structure of the document.
13121 \begin_layout Itemize
13130 are special captions which respect the different space settings needed
13131 for captions placed above or below an element (if you follow strict typographic
13132 rules, you might want to place table captions always above the table).
13133 You can also use the class option
13137 , which will switch
13150 You need at least Koma-Script version 2.8q to use this.
13153 \begin_layout Itemize
13158 : can be used to set a bonmot, e.
13159 \begin_inset space \thinspace{}
13163 \begin_inset space \space{}
13166 at the beginning of a chapter.
13167 If you use the optional argument (
13169 Insert\SpecialChar \menuseparator
13171 \begin_inset space ~
13176 ), you can insert the dictum's author there.
13177 Dictum and author are separated by a line.
13178 You need at least Koma-Script version 2.8q to use this.
13183 is not contained in
13185 article (koma-script)
13190 \begin_layout Standard
13191 The following types, together with the standard types
13203 , form the title area of the document.
13204 They must be entered ahead of the first
13205 \begin_inset Quotes eld
13209 \begin_inset Quotes erd
13216 \begin_layout Plain Layout
13217 The corresponding LaTeX commands must appear before the
13228 When such a type is used more than once, the latter usage overwrites the
13229 former one, that means, for every type only the latest usage is valid.
13230 The order of the different types however has, like
13242 , no effect on the appearance of the produced document.
13245 \begin_layout Itemize
13250 : produces a centered paragraph above the ordinary title (
13262 ) for the subject of the document.
13265 \begin_layout Itemize
13270 : produces a centered paragraph below the ordinary title (
13282 ) for the publishers' name.
13285 \begin_layout Itemize
13292 report (koma-script)
13298 produces a centered paragraph on its own page behind the title page, or
13301 article (koma-script)
13303 produces a centered paragraph below the ordinary title (
13319 ) for a dedication.
13322 \begin_layout Itemize
13327 : produces a left aligned paragraph above the ordinary title (
13343 ) for a document`s head.
13346 \begin_layout Itemize
13351 : produces in a double-sided print in
13353 report (koma-script)
13359 a left-aligned paragraph at the top of the title page`s back or has no
13360 effect in a single-sided print or in
13362 article (koma-script)
13367 \begin_layout Itemize
13372 : produces in a double-sided print in
13374 report (koma-script)
13380 a left-aligned paragraph at the bottom of the title page`s back or has
13381 no effect in a single-sided print or in
13383 article (koma-script)
13388 \begin_layout Itemize
13393 : produces a special
13394 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13401 page ahead of the actual document containing a paragraph without special
13405 \begin_layout Standard
13406 The layout files for the document classes
13408 article (koma-script)
13412 report (koma-script)
13418 do include the file
13423 This is thought of as a place to define your own types.
13428 in your personal layout directory and edit the file!
13431 \begin_layout Subsection
13432 letter (koma-script)
13435 \begin_layout Standard
13439 \begin_layout Plain Layout
13451 \begin_layout Standard
13455 letter (koma-script)
13457 is implemented in the layout file
13462 It contains all the paragraph types of the corresponding standard document
13467 , partly modified, with the exception of the LyX specific types
13479 type, which is replaced by the new
13484 In addition, it contains, in contrast to the standard document class, the
13502 Furthermore, there are a number of new letter specific types.
13505 \begin_layout Standard
13509 \begin_layout Plain Layout
13521 \begin_layout Standard
13522 The appearance of the letter produced by this document class can be controlled
13523 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13527 \begin_layout Plain Layout
13528 For example, the standard appearance of the letter`s heading, consisting
13529 of name and address, is quite self-willed.
13531 \begin_inset Quotes eld
13535 \begin_inset Quotes erd
13538 heading is produced by the following LaTeX commands in the preamble:
13541 \begin_layout LyX-Code
13551 \begin_layout LyX-Code
13567 \begin_layout LyX-Code
13577 \begin_layout LyX-Code
13597 A detailed German description of such LaTeX commands can be found in the
13598 Koma-Script documentation
13603 With it, the letter's author can produce his personal letter layout.
13606 \begin_layout Standard
13615 define the beginning of the letter and must be used in every letter.
13616 To emphasize them in the LyX document class, they are marked with the letter
13626 \begin_inset space ~
13629 in the left margin.
13630 It is possible to write any number of letters in one file.
13635 type produces a new letter using the same addressee and a
13639 type produces a new addressee.
13656 are ordinary paragraph types and can also be used several times in one
13657 and the same letter.
13660 \begin_layout Itemize
13665 : produces a paragraph for the addressee and implicitly defines the beginning
13669 \begin_layout Itemize
13674 : produces a paragraph for the form of address and implicitly produces a
13678 \begin_layout Itemize
13683 : produces a paragraph for a close.
13686 \begin_layout Itemize
13691 : produces a paragraph for a postscript.
13694 \begin_layout Itemize
13699 : produces a paragraph for a distribution list.
13702 \begin_layout Itemize
13707 : produces a paragraph for enclosures.
13710 \begin_layout Standard
13751 are input types provided with a label to enter information, which will
13752 be processed by the document class.
13756 \begin_layout Plain Layout
13757 It could be seen as a matter of inconsequence, that the types
13765 described above are not such input types as well.
13766 Because of the special meaning of those types, however, I have implemented
13767 them as ordinary paragraph types with a one letter mark in the left margin.
13768 Moreover, it would affect my feeling of symmetry, if the
13776 type had such a serious different appearance.
13781 The types must be used ahead of the corresponding
13788 \begin_layout Standard
13789 An implementation of these types in a WYSIWYG fashion does not seem to make
13790 sense, because the real appearance of the produced letter does not only
13791 depend on the usage of the particular type, but also on other factors.
13792 For example, a signature entered in the
13796 type will in the standard behavior appear in the produced letter only,
13797 when in the same letter also a
13802 The entered value of the
13806 type will in the standard behavior not appear in the produced letter at
13808 The possibility to design the letter`s heading freely is already indicated
13809 in a footnote above.
13812 \begin_layout Standard
13813 The input types can also be used as empty paragraphs.
13814 This makes sense e.
13815 \begin_inset space \thinspace{}
13819 \begin_inset space \space{}
13831 type is not used at all, in the standard behavior the value of the
13835 type is used as signature, whereas if an empty
13839 type is used, no signature value is defined.
13842 \begin_layout Standard
13843 By using the input types it is possible to write a letter template, containing
13844 filled input types with your personal dates (name, address, etc.) and empty
13845 input types for other dates you want to enter.
13848 \begin_layout Itemize
13853 : sender's name, in the standard behavior appears as a centered paragraph
13854 in small caps in the letter`s heading.
13857 \begin_layout Itemize
13862 : sender's signature, in the standard behavior appears below the
13871 type is used, the value of the
13875 type appears instead.
13878 \begin_layout Itemize
13883 : sender's address, in the standard behavior appears in a centered paragraph
13884 in the letter`s heading below the sender's name.
13887 \begin_layout Itemize
13892 : sender's telephone number, in the standard behavior only sets the LaTeX
13902 \begin_layout Itemize
13907 : place of the letter`s making.
13910 \begin_layout Itemize
13915 : date of the letter`s making.
13924 , in the standard behavior, produce the place and the date in a right-aligned
13925 line below the addressee's field.
13930 type is used, neither place nor date appear, independent of the value of
13940 type is used, the date of the letter `s production is used.
13943 \begin_layout Itemize
13948 : sender`s back address, in the standard behavior appears above the addressee's
13949 field in a small sans serif font.
13952 \begin_layout Itemize
13957 : special mail information, in the standard behavior appears underlined
13958 above the addressee's field below the back address.
13961 \begin_layout Itemize
13966 : additional information, in the standard behavior appears on right side
13967 below the addressee`s field.
13970 \begin_layout Itemize
13975 : the letter's title, in the standard behavior appears in a big, bold, sans
13976 serif font above the subject.
13979 \begin_layout Itemize
13984 : the letter's subject, in the standard behavior appears in a bold font
13992 \begin_layout Standard
14013 produce a business letter like line above the
14017 line containing the fields
14018 \begin_inset Quotes eld
14022 \begin_inset Quotes erd
14026 \begin_inset Quotes eld
14030 \begin_inset Quotes erd
14034 \begin_inset Quotes eld
14038 \begin_inset Quotes erd
14042 \begin_inset Quotes eld
14046 \begin_inset Quotes erd
14050 \begin_inset Quotes eld
14054 \begin_inset Quotes erd
14058 \begin_inset Quotes eld
14062 \begin_inset Quotes erd
14066 For the date field, the value of the
14072 \begin_inset Quotes eld
14075 business letter types
14076 \begin_inset Quotes erd
14079 is used, the value of the
14083 type however does not appear, but only the LaTeX variable
14090 The ordinary output of place and date in a right-aligned line below the
14091 addressee`s field is suppressed.
14092 The types are implemented as input types provided with a label and must
14093 be used ahead of the corresponding
14100 \begin_layout Itemize
14108 \begin_layout Itemize
14116 \begin_layout Itemize
14124 \begin_layout Itemize
14132 \begin_layout Itemize
14140 \begin_layout Subsection
14141 The new letter class: letter (koma-script v.2)
14144 \begin_layout Standard
14150 \begin_layout Standard
14151 \begin_inset VSpace medskip
14157 \begin_layout Standard
14159 Koma-Script version 2.8 has introduced a new letter class
14163 which supersedes the now unsupported
14168 It has — on the LaTeX side — a completely new interface and is not compatible
14169 with the old class.
14170 Therefore, LyX supports both, though it is recommended you use the new
14174 \begin_layout Standard
14175 This class covers the same functionality as
14177 letter (koma-script),
14180 The basic items are
14184 (receiver's address, same as
14188 in the old layout),
14201 will start a new letter (i.
14202 \begin_inset space \thinspace{}
14206 \begin_inset space \space{}
14209 you can write several letters per document).
14210 New elements are sender's
14226 and the possibility to use a
14232 Insert\SpecialChar \menuseparator
14238 \begin_layout Standard
14239 The biggest improvement is, though, that the letter's layout is configurable
14240 to meet almost any needs.
14241 This can be done via the preamble or with a special style file (Letter
14242 Class Option, extension
14246 ), that will be read in as a class option.
14250 \begin_layout Plain Layout
14251 The KOMA package comes with some default
14256 There is, for instance, a
14260 file that follows german typesetting rules, or a
14264 that provides the default layout of the old
14269 The latter can be loaded with the class option
14278 ayout\SpecialChar \menuseparator
14283 ocument\SpecialChar \menuseparator
14295 template that is included in LyX for examples.
14296 A detailed description is to be found in the Koma-Script documentation
14304 \begin_layout Subsection
14308 \begin_layout Standard
14309 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
14313 \begin_layout Itemize
14314 The chapter number of a
14318 type appears on a line of its own above the chapter heading instead of
14319 appearing in the same line ahead of it.
14320 The cause for that is the LyX internal behavior for the labeltype
14324 in the layout file.
14327 \begin_layout Itemize
14328 The headings of the types
14336 are only put in the
14337 \begin_inset Quotes eld
14341 \begin_inset Quotes erd
14344 LaTeX table of contents, but not in the LyX table of contents (
14346 Document\SpecialChar \menuseparator
14348 \begin_inset space ~
14352 \begin_inset space ~
14360 \begin_layout Itemize
14361 The paragraphs in a
14365 document class appear in a skip separation mode, not indented.
14366 This is the standard behavior, no special LaTeX commands are needed for
14370 Document\SpecialChar \menuseparator
14373 dialog the corresponding radio button indicates
14382 value always has the effect that extra LaTeX commands are inserted in the
14383 document to produce the gap, which is not what is wanted in this case.
14386 \begin_layout Section
14387 Latex8 (IEEE Conference Papers)
14390 \begin_layout Standard
14396 \begin_layout Subsection
14400 \begin_layout Standard
14401 Since this class is specifically for writing submissions to IEEE sponsored
14402 conferences I strongly recommend that you get a copy of their Authors Kit.
14407 package and associated bibliography style file is included in the kit.
14408 The Authors Kit is usually sent out by email once your initial submission
14410 There is a lot of useful information in the Authors Kit explaining formatting
14411 restrictions and so on and I will assume you have read this since that
14412 means I don't have to repeat it all here.
14415 \begin_layout Subsection
14419 \begin_layout Standard
14420 [AR\SpecialChar \@.
14424 \begin_layout Subsection
14425 Supported Environments
14428 \begin_layout Itemize
14434 \begin_layout Itemize
14440 \begin_layout Itemize
14446 \begin_layout Itemize
14452 \begin_layout Itemize
14458 \begin_layout Itemize
14464 \begin_layout Itemize
14470 \begin_layout Itemize
14476 \begin_layout Itemize
14482 \begin_layout Subsection
14483 Differences Between Screen and Paper
14486 \begin_layout Standard
14487 There are slight differences in appearance mainly with the presentation
14488 of section counters.
14489 On screen the trailing period of the section counter is missing but it
14490 will appear in the output so don't let this worry you.
14493 \begin_layout Section
14497 \begin_layout Standard
14503 \begin_layout Subsection
14507 \begin_layout Standard
14508 Memoir is a very powerful and constantly evolving class.
14509 It has been designed with regard to fictional and non-fictional literature.
14510 Its aim is to let the user have maximum control over the typesetting of
14512 Memoir is based on the standard book class, but it can also emulate the
14513 article class (see below).
14516 \begin_layout Standard
14517 Peter Wilson, the developer of Memoir, is known as the author of lots of
14518 useful packages in the LaTeX world.
14519 Most of them have been merged with Memoir.
14520 Therefore, it is much easier to layout the table of contents, appendices,
14521 chapter designs and such.
14522 LyX, though, does not support all of these goodies natively.
14523 Some of them might be added to forthcoming releases
14527 \begin_layout Plain Layout
14528 You are invited to send suggestions to
14529 \begin_inset Flex URL
14532 \begin_layout Plain Layout
14534 lyx-devel@lists.lyx.org
14544 , lots will probably never, due to the limitations of LyX's framework.
14545 Of course you can still use all features with the help of some native LaTeX
14550 \begin_layout Plain Layout
14555 \begin_layout Plain Layout
14565 \begin_inset space ~
14569 \begin_inset CommandInset ref
14571 reference "sec:Inserting-TeX-Code"
14581 In this section, we can only list those features which are natively supported
14583 For detailed descriptions (and for the rest of features) we recommend you
14584 have a look at the detailed manual of the Memoir class
14588 \begin_layout Plain Layout
14593 \begin_layout Plain Layout
14603 \begin_inset Flex URL
14606 \begin_layout Plain Layout
14608 CTAN:/macros/latex/memoir/memman.pdf
14618 , which is not only a user guide for the class, but also both a comprehensive
14619 description on good typesetting and a superb example for good typesetting
14623 \begin_layout Subsection
14624 Basic features and restrictions
14627 \begin_layout Standard
14628 Memoir supports basically all features of the standard book classes.
14629 There are, however, some differences, as follows:
14632 \begin_layout Description
14634 \begin_inset space ~
14637 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14640 \begin_layout Description
14642 \begin_inset space ~
14645 style: The fancy page style is not supported, due to a command clash between
14646 Memoir and the fancyhdr package (they both define a command with the same
14647 name, which confuses LaTeX).
14648 Instead, Memoir comes with a number of its own page styles (see
14650 Layout\SpecialChar \menuseparator
14651 Document\SpecialChar \menuseparator
14653 \begin_inset space ~
14659 If you want to use these for the chapter pages, you have to use the command
14666 in the main text or in preamble (e.
14667 \begin_inset space \thinspace{}
14671 \begin_inset space \space{}
14678 chapterstyle{companion}
14683 \begin_layout Description
14684 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
14685 optional argument in the standard classes.
14686 With this, you can specify an alternative version of the title for the
14687 table of contents and the headers (for instance, if the title is too long).
14688 In LyX, you can do this via
14690 Insert\SpecialChar \menuseparator
14692 \begin_inset space ~
14697 at the beginning of a chapter/section.
14698 Memoir features a second optional argument and thus separates the table
14699 of contents from the header.
14700 You can define three variants of a title with this: one for the main text,
14701 one for the table of contents, and one for the headers.
14702 Simply insert two optional arguments if you need this feature, the first
14703 one containing the short title for the Table of Contents, the second one
14704 containing an alternative short title for the headers.
14707 \begin_layout Description
14708 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14709 of contents, the list of figures and the list of table start a new page
14711 Memoir does not follow this route.
14712 You have to insert a page break yourself, if you want to have one.
14715 \begin_layout Description
14716 Titlepage: For some unknown reason, Memoir uses pagination on the title
14717 page (in the standard classes, title pages are
14718 \begin_inset Quotes eld
14722 \begin_inset Quotes erd
14726 \begin_inset space \thinspace{}
14730 \begin_inset space \space{}
14734 If you want an empty title page, type
14738 aliaspagestyle{title}{empty}
14743 \begin_layout Description
14744 Article: With the class option
14750 Layout\SpecialChar \menuseparator
14751 Document\SpecialChar \menuseparator
14753 \begin_inset space ~
14758 ), you can emulate article style.
14759 That is, counters (footnotes, figures, tables etc.) will not be reset on
14760 new chapters, chapters don't start a new page (but are—in contrary to
14761 \begin_inset Quotes eld
14765 \begin_inset Quotes erd
14768 article classes—still allowed), parts, though, use their own page, as in
14772 \begin_layout Description
14773 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14774 font commands, which have been used in the old LaTeX version 2.09 (e.
14775 \begin_inset space \thinspace{}
14779 \begin_inset space \space{}
14795 It produces an error and stops LaTeX whenever such a command appears.
14800 reallows the commands and spits out warnings instead (which does at least
14802 Since a lot of packages and particularly BibTeX style files are still using
14803 those commands, we have decided to use this option by default.
14806 \begin_layout Subsection
14810 \begin_layout Standard
14811 We will only describe the features supported by LyX (which is not much currently
14813 Please consult the Memoir manual
14817 \begin_layout Plain Layout
14822 \begin_layout Plain Layout
14832 \begin_inset Flex URL
14835 \begin_layout Plain Layout
14837 CTAN:/macros/latex/memoir/memman.pdf
14850 \begin_layout Description
14851 Abstract: You may wonder why an abstract is an extra feature.
14852 Well, it is in book class.
14853 Usually books don't have abstracts.
14854 Memoir, however, has.
14855 You can use it wherever and how often you like.
14858 \begin_layout Description
14859 Chapterprecis: You may know this older typesetting style: The contents of
14860 a chapter are summarized below the title and also in the table of contents
14862 \begin_inset space \thinspace{}
14866 \begin_inset space \space{}
14871 Our hero arrives in Troia; he loses some friends; he finds others
14874 Chapterprecis does exactly this.
14875 It is therefore only sensible below a chapter.
14878 \begin_layout Description
14879 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14880 The epigraph environment provides an elegant way of typesetting such a
14882 The motto itself (text) and its author (source) are divided by a short
14884 Unfortunately, we have to fool LyX a bit here again, since the environment
14885 needs two arguments (text and source).
14886 In this case, we have to use curly brackets (in TeX mode) between the two
14897 <author of the slogan>.
14900 \begin_layout Description
14901 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14902 complex figurative poems).
14903 LyX can only support a few of them.
14904 One is poemtitle, which is a centered title for poems, which will also
14905 be added to the table of contents (verse is the standard environment for
14907 Memoir has some enhanced versions of verse, but you need to use TeX code,
14908 because they have to be nested inside regular verse environments, which
14909 is not possible with LyX).
14912 \begin_layout Description
14913 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14916 \begin_layout Section
14917 Article (mwart), book (mwbk) and report (mwrep)
14918 \begin_inset Argument
14921 \begin_layout Plain Layout
14934 \begin_layout Standard
14940 \begin_layout Standard
14941 The LyX document classes
14957 correspond to the LaTeX document classes
14970 They are replacements for the standard document classes
14982 , resp., and fit better to Polish typography conventions in a number of points.
14986 \begin_layout Standard
14990 \begin_layout Itemize
14991 Unnumbered titles (with star, e.
14992 \begin_inset space \thinspace{}
14996 \begin_inset space \space{}
15003 ) are added into table of contents,
15006 \begin_layout Itemize
15007 Additional page styles:
15011 \begin_layout Description
15012 uheadings header with separated lines,
15015 \begin_layout Description
15016 myheadings custom header, contents headers via commands:
15031 \begin_layout Description
15032 myuheadings custom header with separated lines,
15035 \begin_layout Description
15036 outer page number is placed on outer side of page
15040 \begin_layout Itemize
15045 \begin_layout Description
15046 rmheadings serif titles — default,
15049 \begin_layout Description
15050 sfheadings sansserif titles,
15053 \begin_layout Description
15054 authortitle on title page first placed is author next title — default,
15057 \begin_layout Description
15058 titleauthor on title page first placed is title next author,
15061 \begin_layout Description
15062 withmarginpar reserve place on page for margins.
15066 \begin_layout Section
15070 \begin_layout Standard
15075 provides an alternative to the standard
15080 It provides similar functionality, but you might prefer this layout with
15081 sans serif sections, headings, and more.
15084 \begin_layout Section
15088 \begin_layout Standard
15094 \begin_layout Standard
15095 \begin_inset VSpace bigskip
15101 \begin_layout Standard
15106 \begin_inset space ~
15111 textclass works with the American Physical Sociey's RevTeX 4.0 (the
15112 \begin_inset Formula $\beta$
15115 release of May, 1999) class.
15118 \begin_layout Standard
15123 textclass, which works with RevTeX 3.1.
15124 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
15125 That means that it doesn't interact very well with LyX, which requires
15126 LaTeX2e, although it has been kludged to work.
15127 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
15131 \begin_inset space ~
15136 textclass should also be pretty easy to use.
15139 \begin_layout Standard
15140 These documents are supposed to be used in
15144 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
15145 macros, and assume you'll know what to put in the preamble if necessary.
15148 \begin_layout Subsection
15152 \begin_layout Standard
15153 All you need to do is install RevTeX 4, as described in the package's README
15155 The package can be found at The RevTeX 4 Web Site
15156 \begin_inset Flex URL
15159 \begin_layout Plain Layout
15161 http://publish.aps.org/revtex4/
15167 Install it somewhere that LaTeX can see it.
15168 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
15170 \begin_inset space \thinspace{}
15174 \begin_inset space \space{}
15177 not the directory where you installed the class file.) Then, if you reconfigure
15178 LyX, it will find the class file and let you use the RevTeX4 textclass.
15181 \begin_layout Standard
15182 Probably the easiest way to get started is either to import a RevTeX 4 document
15190 \begin_inset space ~
15195 template, found in the templates directory.
15198 \begin_layout Subsection
15202 \begin_layout Standard
15203 Optional arguments to
15210 \begin_inset Quotes eld
15214 \begin_inset Quotes erd
15218 \begin_inset Quotes eld
15222 \begin_inset Quotes erd
15232 \begin_inset space ~
15240 \begin_inset space ~
15246 Remember that in RevTeX, at least one optional argument is required!
15249 \begin_layout Standard
15250 Other preamble matter, like
15257 \begin_inset space ~
15263 \begin_inset space ~
15268 dialog, also as usual.
15271 \begin_layout Subsection
15275 \begin_layout Standard
15276 The layouts basically correspond to the commands in RevTeX4.0.
15277 For example, the Email layout corresponds to
15284 Note that (at least as of RevTeX 4.0 Beta), the
15292 layouts are exactly equivalent, so you shouldn't need to use both.
15296 \begin_layout Plain Layout
15297 In case you're curious, both were included so that
15301 would be able to translate both
15321 \begin_layout Subsection
15325 \begin_layout Standard
15326 There are a couple of important unique aspects of RevTeX 4 which might cause
15327 bugs that will be even more confusing in LyX.
15330 \begin_layout Standard
15348 The LyX equivalent is that there is a separate Thanks layout.
15353 write footnotes in the
15357 layout, or weird things may happen.
15358 See the RevTeX 4 documentation for more details.
15361 \begin_layout Standard
15365 \begin_inset space ~
15373 \begin_inset space ~
15382 layouts must be placed
15390 layout and the corresponding
15407 , the LaTeX won't compile.
15410 \begin_layout Subsection
15414 \begin_layout Standard
15415 The main problem with this layout is that you can't use the optional arguments
15416 to layouts like Email and Title.
15417 (The problem is not unique to this layout; you can't use optional arguments
15418 to the Section layouts either.) This means that after you export that file
15419 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15420 need to edit the LaTeX file with a text editor to add the optional arguments
15422 \begin_inset space \thinspace{}
15426 \begin_inset space \space{}
15429 the running title for the page headers.
15430 Lacking these layouts makes the
15436 (and the equivalent
15442 ) useless, so the corresponding layouts don't exist, and will have to be
15447 \begin_layout Plain Layout
15452 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15453 has not been updated yet to take advantage of it.
15461 \begin_layout Section
15462 Springer Journals (
15469 \begin_layout Standard
15475 \begin_layout Subsection
15479 \begin_layout Standard
15480 These are the layout files for some of the journal formats used by Springer
15481 Verlag and listed on
15482 \begin_inset Flex URL
15485 \begin_layout Plain Layout
15487 http://www.springer.de/author/tex/help-journals.html
15492 , where you should also go to fetch the class files (yes, these are LaTeX2e
15494 It is a modular system: the things common to all journals are implemented
15499 , which journal-specific layout files (such as, e.
15500 \begin_inset space \thinspace{}
15504 \begin_inset space \space{}
15511 for Journal of Geodesy) can include.
15514 \begin_layout Standard
15515 This means that implementing support for any other Springer journal on this
15516 list is as simple as writing your own
15524 file following the outline given in
15532 \begin_layout Standard
15533 It is reasonably well tested only for the Journal of Geodesy.
15542 come with the standard LyX distribution.
15543 Install the relevant class file (downloaded from Springer) in a proper
15544 directory, reconfigure LaTeX (in the teTeX case by running
15548 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15549 and it should work.
15552 \begin_layout Subsection
15556 \begin_layout Standard
15557 A large number of theorem-like styles —
15563 \SpecialChar \ldots{}
15569 \begin_layout Standard
15572 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15573 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15576 See the Springer class file documentation for details.
15579 \begin_layout Subsection
15583 \begin_layout Itemize
15595 \begin_layout Itemize
15598 Probability Theory and Related Fields
15604 — Jean-Marc Lasgouttes
15607 \begin_layout Standard
15608 Add your own, it isn't so hard!
15611 \begin_layout Subsection
15615 \begin_layout Standard
15616 These files are partly based on the older
15620 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15621 file from Springer.
15626 layout, are now defunct.
15627 Jean-Marc Lasgouttes helped out big in making me find my way around the
15628 LyX layout file mechanism.
15631 \begin_layout Subsection
15635 \begin_layout Standard
15637 But probably less than in the old hacked-LaTeX
15644 \begin_layout Standard
15646 \begin_inset space \thinspace{}
15649 g.: does not display the number for theorem-like layouts, just #.
15652 \begin_layout Section
15658 \begin_inset CommandInset label
15667 \begin_layout Standard
15675 \begin_layout Subsection
15679 \begin_layout Standard
15680 This section describes how to use LyX to make slides for overhead projectors.
15681 There are two document classes that can do this: the default slides class
15687 This section documents the former.
15690 \begin_layout Standard
15691 I'm going to say this again, nice and clear, so that there's no misunderstanding
15695 \begin_layout Standard
15696 \begin_inset VSpace bigskip
15702 \begin_layout Standard
15706 This section documents the class
15707 \begin_inset Quotes eld
15715 \begin_inset Quotes erd
15723 \begin_layout Standard
15724 \begin_inset VSpace bigskip
15730 \begin_layout Standard
15731 If you're looking for the documentation for
15732 \begin_inset Quotes eld
15740 \begin_inset Quotes erd
15743 , check out section
15744 \begin_inset space ~
15748 \begin_inset CommandInset ref
15750 reference "sec:foiltex"
15760 \begin_inset Quotes eld
15768 \begin_inset Quotes erd
15771 ] is actually somewhat better than the default
15779 \begin_layout Plain Layout
15780 \SpecialChar \ldots{}
15781 or so I've been told repeatedly by its advocates.
15782 Having never used it, I have no idea if this claim is true or not.
15787 which this section documents.
15790 \begin_layout Standard
15791 This class is the LaTeX2e improvement of the old
15796 Every LaTeX2e distribution includes this class [which I'll just refer to
15798 \begin_inset Quotes eld
15806 \begin_inset Quotes erd
15809 from now on], so you're bound to have it.
15810 As I noted earlier, there are other classes, such as
15814 , which also produce slides for overhead projectors and do a better job
15816 However, there are some things which
15820 can do which the others can't, such as generate overlays.
15821 Read on to learn more!
15824 \begin_layout Subsection
15826 \begin_inset CommandInset label
15828 name "sec:slidesetup"
15835 \begin_layout Standard
15836 Obviously, to use this document class, you need to select
15837 \begin_inset Quotes eld
15845 \begin_inset Quotes erd
15848 from the class list in the
15850 Document\SpecialChar \menuseparator
15854 There are some other special things you should know about this class:
15857 \begin_layout Itemize
15858 Don't bother changing the options
15863 They're not supported by the
15870 \begin_layout Itemize
15874 \begin_inset space ~
15879 behaves a bit differently for this class.
15880 The possible choices and what they do are as follows:
15884 \begin_layout Description
15889 The final output contains page numbers in the lower right corner.
15892 \begin_layout Description
15901 , but also prints out any time markers you've put in.
15902 This is the default.
15905 \begin_layout Description
15910 The final output contains no page numbers, time markers, or alignment markers.
15914 \begin_layout Itemize
15919 class has an extra option:
15925 \begin_inset Quotes eld
15933 \begin_inset Quotes erd
15936 in the extra class options.
15940 \begin_layout Standard
15941 Using this options allows you to add time markers to
15947 \begin_inset space ~
15951 \begin_inset CommandInset ref
15953 reference "sec:slideNote"
15961 \begin_layout Standard
15962 You can also use the template file
15963 \begin_inset Quotes eld
15971 \begin_inset Quotes erd
15974 to automatically set up a document to use the
15980 File\SpecialChar \menuseparator
15982 \begin_inset space ~
15986 \begin_inset space ~
15991 to open your new document].
15992 The template file also contains some examples of the special paragraph
15993 environments used by this class.
15994 I'll describe those next.
15997 \begin_layout Subsection
15998 Paragraph Environments
16001 \begin_layout Subsubsection
16002 Supported Environments
16005 \begin_layout Standard
16006 The first thing you'll notice when you start up a new
16010 document is the font size and type: it's the equivalent of the size
16011 \begin_inset Quotes eld
16019 \begin_inset Quotes erd
16025 \begin_inset space ~
16031 This is also what's used in the output.
16033 \begin_inset Quotes eld
16037 \begin_inset Quotes erd
16040 to remind you that this is a slide.
16041 Your final slides will use a larger font; ergo, you'll have less space.
16042 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16045 \begin_layout Standard
16046 The next thing that becomes obvious is the changes to the paragraph environment
16047 pull-down box [at the far-left end of the toolbar].
16048 Most of the paragraph environments you're used to seeing are missing.
16049 There are also five new ones.
16054 class itself only supports certain paragraph environments:
16057 \begin_layout Itemize
16063 \begin_layout Itemize
16069 \begin_layout Itemize
16075 \begin_layout Itemize
16081 \begin_layout Itemize
16087 \begin_layout Itemize
16093 \begin_layout Itemize
16099 \begin_layout Itemize
16105 \begin_layout Itemize
16111 \begin_layout Itemize
16117 \begin_layout Itemize
16123 \begin_layout Standard
16124 All of the other standard environments, including the section-heading environmen
16125 ts, aren't used in the
16132 \begin_layout Standard
16133 On the other hand, you'll notice the following new environments:
16136 \begin_layout Itemize
16142 \begin_layout Itemize
16148 \begin_layout Itemize
16154 \begin_layout Itemize
16160 \begin_layout Itemize
16166 \begin_layout Standard
16167 These five are kind of quirky, due to a
16168 \begin_inset Quotes eld
16172 \begin_inset Quotes erd
16176 You see, LyX doesn't permit you to nest any other paragraph environment
16177 into an empty environment.
16178 Now, that's fine and dandy, but it means that you wouldn't be able to start
16179 a slide with anything except plain text.
16180 To deal with this, I've performed a little
16181 \begin_inset Quotes eld
16185 \begin_inset Quotes erd
16191 \begin_layout Subsubsection
16192 Quirks of the New Environments
16193 \begin_inset CommandInset label
16195 name "sec:slideQuirk"
16202 \begin_layout Standard
16203 All five of the new paragraph environments are somewhat quirky due to inherent
16204 limitiations in the current version of LyX.
16205 As I just mentioned, LyX forbids environments that begin with another environme
16207 To get around this, the
16211 environment isn't a paragraph environment as described in the
16219 \begin_layout Standard
16220 You should consider
16233 \begin_inset Quotes eld
16236 pseudo-environments.
16237 \begin_inset Quotes erd
16240 They look like a section heading or a
16241 \begin_inset Quotes eld
16249 \begin_inset Quotes erd
16252 but really begin a [and, if necessary, end the previous] paragraph environment.
16262 \begin_inset Quotes eld
16266 \begin_inset Quotes erd
16269 These two perform some action.
16272 \begin_layout Standard
16273 A common feature of all five environments,
16293 , is a rather long-ish label.
16294 The text following this label — ordinarily the contents of the paragraph
16295 environment — is utterly irrelevant for
16316 LyX completely ignores it.
16317 In fact, you can leave these five environments completely empty.
16321 \begin_layout Standard
16326 to put any text after the rather long-ish label, you might want to.
16327 This could be a short description of the contents of the
16332 In that case, enter your descriptive comment and hit
16336 as you normally would.
16339 \begin_layout Standard
16340 If, on the other hand, you don't want to enter any descriptive text, you'll
16341 hit another LyX quirk.
16342 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
16343 environment until you put something in the old one.
16347 \begin_layout Itemize
16348 Start entering the text that will
16376 \begin_layout Itemize
16377 Now move to the beginning of that paragraph.
16381 \begin_layout Itemize
16390 \begin_layout Itemize
16391 Finally, change this new, empty paragraph to a
16415 \begin_layout Standard
16416 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
16420 \begin_layout Subsection
16421 Making a Presentation with
16434 \begin_layout Subsubsection
16442 \begin_layout Standard
16443 If you're expecting this section to teach you how to actually make a presentatio
16444 n, you'll be sorely disappointed.
16445 Naturally, I'll describe all of the ways the
16449 class can assist you in preparing the materials for a presentation.
16450 Filling in the contents, however, is up to you.
16455 the LyX philosophy.]
16458 \begin_layout Standard
16463 environment [in the manner described in section
16464 \begin_inset space ~
16468 \begin_inset CommandInset ref
16470 reference "sec:slideQuirk"
16474 ] tells LyX to begin a new slide [duh].
16475 The label for this environment/
16476 \begin_inset Quotes erd
16480 \begin_inset Quotes erd
16484 \begin_inset Quotes eld
16488 \begin_inset Quotes erd
16491 in cool blue, followed by the label,
16492 \begin_inset Quotes eld
16496 \begin_inset Quotes erd
16500 Any text or paragraph environments that follow this one go on the new slide.
16504 \begin_layout Standard
16505 Slides are probably the only time you'll need to forcibly end pages in LyX
16506 (this can be specified in the
16511 In fact, you'll want to, once you finish entering the contents of one slide.
16512 If you've entered more text than can physically fit on a slide, the extra
16513 overflows onto a new slide.
16514 I don't recommend doing this, however, since the overflow slide won't have
16515 any page number on it.
16516 Furthermore, it may interfere with any
16520 you've made to accompany the oversized
16527 \begin_layout Standard
16536 environments work the same way as the
16541 They both create an
16542 \begin_inset Quotes eld
16546 \begin_inset Quotes erd
16549 followed by a label [
16550 \begin_inset Quotes eld
16554 \begin_inset Quotes erd
16558 \begin_inset Quotes eld
16562 \begin_inset Quotes erd
16566 The color is a stunning magenta instead of blue, and the
16567 \begin_inset Quotes eld
16571 \begin_inset Quotes erd
16574 will look different, in style and in length.
16575 The label fonts of all three also differ from one another.
16578 \begin_layout Standard
16583 , if the contents of a
16591 exceed the physical size of a slide or sheet of paper, the extra will overflow
16593 Again, you should avoid this.
16594 It defeats the whole purpose of
16605 \begin_layout Subsubsection
16615 \begin_layout Standard
16620 is a slide that sits atop another slide.
16621 Perhaps you wish to discuss a figure on the main
16625 before displaying the text associated with it.
16626 One way to accomplish this is tape a flap of dark paper over the part of
16631 you want to display later.
16632 This method fails, however, if you wish to overlap one graph with another,
16634 You would then have to fumble while speaking to align the two separate,
16639 s to align the two graphs.
16644 environment in both cases makes life much easier.
16647 \begin_layout Standard
16652 receives the page number of its
16653 \begin_inset Quotes eld
16657 \begin_inset Quotes erd
16665 \begin_inset Quotes eld
16673 \begin_inset Quotes erd
16680 \begin_layout Plain Layout
16681 Presumably, mutliple
16686 \begin_inset Quotes eld
16694 \begin_inset Quotes erd
16698 \begin_inset Quotes eld
16706 \begin_inset Quotes erd
16710 \begin_inset Quotes eld
16718 \begin_inset Quotes erd
16722 \begin_inset space ~
16725 appended to the page number of the parent
16735 Clearly, you want the contents of both the
16743 to each fit on a single physical slide! You should probably consider an
16749 \begin_inset Quotes eld
16753 \begin_inset Quotes erd
16765 class provides a visual cue for this: the label at the start of an
16769 is shorter than that at the start of a
16774 Lastly, when you generate printable output, you'll find alignment markers
16775 in all four corners of both the
16779 page and its parent
16784 These will assist you in lining up the two physical slides.
16787 \begin_layout Standard
16788 The major problem in overlaying two slides is aligning the contents of the
16789 two transparencies.
16790 How much space should you leave for that graph on the second slide? Worse
16791 still, what if you want a graph and a sentence on second slide, but there
16792 is text on the main transparency that goes in between them? You could try
16793 and insert vertical space of the right size.
16794 The better way is to use
16805 \begin_layout Standard
16806 As their names imply,
16814 are two command-like paragraph environments that make all subsequent text
16815 invisible and visible, respectively.
16817 \begin_inset space ~
16821 \begin_inset CommandInset ref
16823 reference "sec:slideQuirk"
16827 that you don't place anything
16831 these two environments, however.
16836 , it inserts a centered, sky-blue label into the page reading
16837 \begin_inset Quotes eld
16840 <Invisible Text Follows>
16841 \begin_inset Quotes erd
16845 For paragraphs following this label, the parts of the
16853 ; it doesn't matter which] where they would be contain instead blank space.
16857 \begin_layout Standard
16862 , the corresponding centered label is
16863 \begin_inset Quotes eld
16866 <Visible Text Follows>
16867 \begin_inset Quotes erd
16871 Paragraphs following this label behave normally.
16872 Note that the beginning of a new
16884 automatically shuts off an
16889 It's therefore not necessary to use
16900 \begin_layout Standard
16901 By now, it should be obvious how to create overlay transparencies using
16902 the proper combination of
16921 \begin_layout Enumerate
16926 , including everything that will appear on it, whether on the main slide
16934 \begin_layout Enumerate
16935 Before each figure or paragraph that will appear only on the
16944 If necessary, insert a
16948 environment after the
16955 \begin_layout Enumerate
16960 immediately following the
16967 \begin_layout Enumerate
16968 Copy the contents of this
16979 \begin_layout Enumerate
16984 , change all of the
16995 \begin_layout Standard
16997 You've just made an
17004 \begin_layout Standard
17005 There's one problem with the way I've designed the LyX
17009 class: you can't make text in the middle of a paragraph invisible, nor
17010 make text in the middle of an invisible paragraph visible again.
17011 To accomplish this feat, you'll need to use some inlined LaTeX codes.
17015 \begin_layout Plain Layout
17016 The commands of interest are:
17019 \begin_layout Itemize
17024 invisible \SpecialChar \ldots{}
17028 \begin_layout Itemize
17033 visible \SpecialChar \ldots{}
17037 \begin_layout Plain Layout
17038 \SpecialChar \ldots{}
17039 and need to be marked as TeX.
17041 \begin_inset Quotes eld
17045 \begin_inset Quotes erd
17048 you wish to change goes in between the brackets [and after the
17061 If you don't know how to mark text as TeX, see the appropriate section
17074 \begin_layout Subsubsection
17084 \begin_inset CommandInset label
17086 name "sec:slideNote"
17093 \begin_layout Standard
17102 is associated with a
17103 \begin_inset Quotes eld
17107 \begin_inset Quotes erd
17119 class provides visual cues.
17124 is shorter than that of a
17128 [yet longer than that of an
17132 ] and, like the label of an
17136 is shockingly magenta.
17137 Additionally, the printed
17141 has the page number of its
17142 \begin_inset Quotes eld
17146 \begin_inset Quotes erd
17154 \begin_inset Quotes eld
17162 \begin_inset Quotes erd
17166 \begin_inset Quotes eld
17174 \begin_inset Quotes erd
17178 \begin_inset Quotes eld
17186 \begin_inset Quotes erd
17190 You can have multiple
17194 s associated with a single
17206 , you'll probably want to break up long
17210 s so that they fit on a single sheet of paper.
17213 \begin_layout Standard
17218 is obvious: it contains anything additional you might want to say about
17224 It could also be used as a sheet of reminders for a particular
17229 In the case of the latter, you might want to make use of time markers.
17235 \begin_inset Quotes eld
17239 \begin_inset Quotes erd
17242 support for time markers, a
17247 So, you'll have to resort to using the LaTeX codes.
17250 \begin_layout Standard
17251 To use time markers, you'll need to specify the extra class option
17252 \begin_inset Quotes eld
17260 \begin_inset Quotes erd
17264 \begin_inset space ~
17268 \begin_inset CommandInset ref
17270 reference "sec:slidesetup"
17275 This option turns on timing marks, which will appear in the lower-left-hand
17281 To set what appears in the time marker, you use the LaTeX commands
17282 \begin_inset Quotes eld
17292 \begin_inset Quotes erd
17296 \begin_inset Quotes eld
17306 \begin_inset Quotes erd
17310 The arguments of both commands are time measured in seconds.
17312 \begin_inset Quotes eld
17322 \begin_inset Quotes erd
17325 sets the time marker to a given time.
17327 \begin_inset Quotes eld
17337 \begin_inset Quotes erd
17340 increments the time marker by the specified amount.
17341 Using time markers and
17345 s in this fashion, you can remind yourself how much time to spend on a particula
17353 \begin_layout Standard
17354 There's one last feature to describe.
17355 Clearly, you'd like to print out all of your
17363 s on transparencies while printing all of your
17380 with which it is associated.
17381 What's a person to do?
17384 \begin_layout Standard
17385 Luckily, there are two LaTeX commands that allow you to select what to print
17387 Both must be placed into the preamble of your document.
17389 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 will cause the output to contain only the
17413 Correspondingly, the command
17414 \begin_inset Quotes eld
17426 \begin_inset Quotes erd
17429 prevents the output of anything but
17434 I'd advise placing both commands in the preamble and initially comment
17436 You can then preview your entire presentation as you write.
17437 When you're done writing, you can then uncomment one of the two to select
17438 what you want to print.
17439 I like to uncomment
17440 \begin_inset Quotes eld
17452 \begin_inset Quotes erd
17455 , print to a file with
17456 \begin_inset Quotes eld
17464 \begin_inset Quotes erd
17467 in its name, comment it back out, then uncomment
17468 \begin_inset Quotes eld
17480 \begin_inset Quotes erd
17484 \begin_inset Quotes eld
17492 \begin_inset Quotes erd
17496 I can then send either file to a printer, loading transparencies or plain
17497 paper as appropriate.
17500 \begin_layout Standard
17501 You can also provide other arguments to the
17502 \begin_inset Quotes eld
17512 \begin_inset Quotes erd
17516 \begin_inset Quotes eld
17526 \begin_inset Quotes erd
17530 See a good LaTeX book for details.
17533 \begin_layout Subsection
17538 Class Template File
17541 \begin_layout Standard
17542 I have also provided a template file,
17543 \begin_inset Quotes eld
17551 \begin_inset Quotes erd
17559 To use it, begin your new presentation with
17564 ile\SpecialChar \menuseparator
17566 \begin_inset space ~
17570 \begin_inset space ~
17580 Your new LyX presentation file will contain an example
17601 additionally contain an example of the use of
17610 Lastly, the preamble will contain:
17613 \begin_layout LyX-Code
17614 % Uncomment to print out only slides and overlays
17617 \begin_layout LyX-Code
17621 \begin_layout LyX-Code
17627 \begin_inset Newline newline
17633 \begin_layout LyX-Code
17634 % Uncomment to print out only notes
17637 \begin_layout LyX-Code
17641 \begin_layout LyX-Code
17649 \begin_layout Standard
17650 One final thing: I created this class to support the LaTeX2e
17651 \begin_inset Quotes eld
17659 \begin_inset Quotes erd
17662 class, one of the built-in LaTeX2e classes.
17663 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17664 built-in slide class.
17665 It's here if you want it or need it.
17666 There exist other LaTeX2e classes for creating presentations, such as the
17672 \begin_inset space ~
17676 \begin_inset CommandInset ref
17678 reference "sec:foiltex"
17683 \begin_inset Quotes eld
17691 \begin_inset Quotes erd
17694 package [present on some TeX distributions].
17695 The latter is not yet supported under LyX.
17699 \begin_layout Plain Layout
17700 Perhaps you can take on the task\SpecialChar \ldots{}
17706 I know nothing about these other classes.
17707 Try them out to see what sort of alternative they provide.
17710 \begin_layout Chapter
17711 LyX Features needing Extra Software
17714 \begin_layout Section
17718 \begin_layout Standard
17724 \begin_layout Subsection
17728 \begin_layout Standard
17737 \begin_layout Plain Layout
17742 is not yet available when you are using the LaTeX distribution MiKTeX.
17747 , you'll find in the
17754 \begin_inset space ~
17765 \begin_inset CommandInset href
17767 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17774 \begin_layout Standard
17779 package is a program that was written by
17780 \begin_inset Flex Noun
17783 \begin_layout Plain Layout
17785 \begin_inset space ~
17793 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17794 and easy to forget.
17795 The program runs over your LaTeX file, checks the integrity of the file,
17796 and flags some common errors.
17797 In other technical words, it is
17804 \begin_layout Standard
17805 Well, what is a syntax checker doing in LyX which is supposed to produce
17806 correct LaTeX anyways? The answer is simple: Just as
17810 not only checks the
17814 of C programs, but also does
17818 checks for type-errors,
17822 catches some common
17826 errors, in addition to the syntactical ones.
17831 is capable of detecting several common errors, such as
17834 \begin_layout Itemize
17835 Ellipsis detection:
17836 \begin_inset Newline newline
17839 Use \SpecialChar \ldots{}
17843 \begin_layout Itemize
17844 No space in front of/after parenthesis:
17845 \begin_inset Newline newline
17851 \begin_layout Itemize
17852 Enforcement of normal space after common abbreviations:
17853 \begin_inset Newline newline
17857 \begin_inset space \thinspace{}
17861 \begin_inset space \space{}
17864 is too wide spacing.
17867 \begin_layout Itemize
17868 Enforcement of end-of-sentence space when the last sentence ends with a
17870 \begin_inset Newline newline
17874 And this is wrong spacing.
17877 \begin_layout Itemize
17878 Space in front of labels and similar commands:
17879 \begin_inset Newline newline
17882 The label should stick right up to the text to avoid falling to a wrong
17885 \begin_inset CommandInset label
17895 \begin_layout Plain Layout
17896 This footnote is in danger of falling off to a wrong page
17901 The label is separated too much.
17904 \begin_layout Itemize
17905 Space in front of references, instead of hard spaces:
17906 \begin_inset Newline newline
17909 In you are in bad luck, the text will break right between the referenced
17910 text and reference number, and that's a pity.
17912 \begin_inset CommandInset ref
17914 reference "sec:chktex"
17921 \begin_layout Itemize
17923 \begin_inset Quotes eld
17927 \begin_inset Quotes erd
17931 \begin_inset Formula $\times$
17935 \begin_inset Newline newline
17938 2x2 looks cheap compared to
17939 \begin_inset Formula $2\times2$
17945 \begin_layout Standard
17946 and more \SpecialChar \ldots{}
17947 It is an invaluable tool when you are
17948 \begin_inset Quotes eld
17952 \begin_inset Quotes erd
17955 your document before printing, and you should run it right after the obligatory
17956 spelling check, and before you go fine tuning the typesetting.
17959 \begin_layout Subsection
17963 \begin_layout Standard
17964 If you have the program installed, usage is as simple as choosing
17966 Tools\SpecialChar \menuseparator
17968 \begin_inset space ~
17974 This will make LyX generate a LaTeX file of your document, start
17978 to check it, and then make LyX insert
17979 \begin_inset Quotes eld
17983 \begin_inset Quotes erd
17986 with the warnings from
17990 , if there were any.
17991 The warnings will be placed close to the point of the mistake, and you
17992 can quickly find them by using the
17994 Navigate\SpecialChar \menuseparator
17997 menu item, or the shortcut key
18006 Open the error boxes by clicking on them with the mouse, or use the shortcut
18015 bindings, or the corresponding
18024 Read the warning and correct the mistake, if it is a mistake.
18025 If you have trouble understanding what the warning is about, you can safely
18027 Remember that there is a hidden layer between the document on screen and
18028 the technical details in invoking
18032 , and this gap can make some warnings seem arcane or just right down plain
18036 \begin_layout Standard
18037 This document is an excellent testing bed for the feature, and it should
18038 provide quite a few warnings for you to fiddle with.
18039 Since computers are only so smart, expect most of the warnings to be false
18043 \begin_layout Subsection
18044 How to fine tune it
18047 \begin_layout Standard
18048 Sometimes, you'll find that
18052 makes more noise than suits your mood.
18053 Then you can choose not to use it, wait until your mood changes, or try
18058 to get better along with you.
18059 Another choice in the most desperate situations is to use
18061 View\SpecialChar \menuseparator
18063 \begin_inset space ~
18067 \begin_inset space ~
18071 \begin_inset space ~
18076 , which will get rid of all warnings instantly.
18079 \begin_layout Standard
18088 very configurable and extensible, you shouldn't expect to solve all problems
18094 Since LyX has to generate a somewhat special LaTeX file to be able to match
18095 the line numbers from the
18103 \begin_layout Plain Layout
18104 You can inspect the specific output from
18110 Edit\SpecialChar \menuseparator
18112 \begin_inset space ~
18116 \begin_inset space ~
18130 to the internal document structure, some of the warnings will not seen
18131 to appear correctly.
18132 There are two things you can do about this:
18135 \begin_layout Itemize
18140 invocation command line in
18156 installation configuration file (usually with the file
18161 See below to learn what warnings can be enabled and disabled on the command
18166 \begin_layout Itemize
18167 Export your document as a raw LaTeX file using
18169 File\SpecialChar \menuseparator
18170 Export\SpecialChar \menuseparator
18178 Invoked in this way, it can be a hassle to find the corresponding place
18179 in the document inside LyX, but with a little patience, you should be able
18183 \begin_layout Standard
18184 Here follows the warning messages that can be enabled and disabled in
18193 to disable a warning, and
18197 to enable a warning.
18198 The emphasized entries are disabled by default, because the default is
18201 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18206 \begin_layout Standard
18207 Notice that you should only use the options that enable and disable warnings,
18208 because LyX relies on some of the other command line parameters to be set
18209 in a specific way to have a chance to communicate with
18216 \begin_layout Enumerate
18220 Command terminated with space.
18223 \begin_layout Enumerate
18226 Non-breaking space (
18227 \begin_inset Quotes eld
18235 \begin_inset Quotes erd
18238 ) should have been used.
18241 \begin_layout Enumerate
18245 You should enclose the previous parenthesis with
18246 \begin_inset Quotes eld
18254 \begin_inset Quotes erd
18260 \begin_layout Enumerate
18263 Italic correction (
18264 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18277 ) found in non-italic buffer.
18280 \begin_layout Enumerate
18283 Italic correction (
18284 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18297 ) found more than once.
18300 \begin_layout Enumerate
18304 No italic correction (
18305 \begin_inset Quotes eld
18315 \begin_inset Quotes erd
18321 \begin_layout Enumerate
18325 \begin_inset Quotes eld
18333 \begin_inset Quotes erd
18337 \begin_inset Quotes eld
18345 \begin_inset Quotes erd
18351 \begin_layout Enumerate
18354 Wrong length of dash may have been used.
18357 \begin_layout Enumerate
18361 \begin_inset Quotes eld
18369 \begin_inset Quotes erd
18373 \begin_inset Quotes eld
18381 \begin_inset Quotes erd
18387 \begin_layout Enumerate
18391 \begin_inset Quotes eld
18399 \begin_inset Quotes erd
18405 \begin_layout Enumerate
18409 \begin_inset Quotes eld
18417 \begin_inset Quotes erd
18420 to achieve an ellipsis.
18423 \begin_layout Enumerate
18426 Inter-word spacing (
18427 \begin_inset Quotes eld
18437 \begin_inset Quotes eld
18440 ) should perhaps be used.
18443 \begin_layout Enumerate
18446 Inter-sentence spacing (
18447 \begin_inset Quotes eld
18457 \begin_inset Quotes erd
18460 ) should perhaps be used.
18463 \begin_layout Enumerate
18466 Could not find argument for command.
18469 \begin_layout Enumerate
18473 \begin_inset Quotes eld
18481 \begin_inset Quotes erd
18487 \begin_layout Enumerate
18490 Math mode still on at end of LaTeX file.
18493 \begin_layout Enumerate
18497 \begin_inset Quotes eld
18505 \begin_inset Quotes erd
18508 doesn't match the number of
18509 \begin_inset Quotes eld
18517 \begin_inset Quotes erd
18523 \begin_layout Enumerate
18526 You should use either
18529 \begin_inset Quotes eld
18537 \begin_inset Quotes erd
18542 as an alternative to
18543 \begin_inset Quotes eld
18551 \begin_inset Quotes erd
18557 \begin_layout Enumerate
18564 " (ASCII 39) instead of "
18571 \begin_layout Enumerate
18574 User-specified pattern found.
18577 \begin_layout Enumerate
18580 This command might not be intended.
18583 \begin_layout Enumerate
18590 \begin_layout Enumerate
18608 \begin_layout Enumerate
18611 Delete this space to maintain correct page references.
18614 \begin_layout Enumerate
18618 You might wish to put this between a pair of
18619 \begin_inset Quotes eld
18627 \begin_inset Quotes erd
18633 \begin_layout Enumerate
18636 You ought to remove spaces in front of punctuation.
18639 \begin_layout Enumerate
18642 Could not execute LaTeX command.
18645 \begin_layout Enumerate
18654 in front of small punctuation.
18657 \begin_layout Enumerate
18665 may look prettier here.
18668 \begin_layout Enumerate
18672 Multiple spaces detected in output.
18675 \begin_layout Enumerate
18678 This text may be ignored.
18681 \begin_layout Enumerate
18687 \begin_inset Quotes eld
18692 to begin quotation, not
18699 \begin_layout Enumerate
18706 to end quotation, not
18709 \begin_inset Quotes eld
18717 \begin_layout Enumerate
18723 \begin_layout Enumerate
18726 You should perhaps use
18727 \begin_inset Quotes eld
18735 \begin_inset Quotes erd
18741 \begin_layout Enumerate
18744 You should put a space in front of/after parenthesis.
18747 \begin_layout Enumerate
18750 You should avoid spaces in front of/after parenthesis.
18753 \begin_layout Enumerate
18757 You should not use punctuation in front of/after quotes.
18760 \begin_layout Enumerate
18763 Double space found.
18766 \begin_layout Enumerate
18769 You should put punctuation outside inner/inside display math mode.
18772 \begin_layout Enumerate
18775 You ought to not use primitive TeX in LaTeX code.
18778 \begin_layout Enumerate
18781 You should remove spaces in front of
18782 \begin_inset Quotes eld
18790 \begin_inset Quotes erd
18796 \begin_layout Enumerate
18799 \begin_inset Quotes eld
18807 \begin_inset Quotes erd
18810 is normally not followed by
18811 \begin_inset Quotes eld
18819 \begin_inset Quotes erd
18825 \begin_layout Standard
18826 In later versions of LyX, we hope to provide a more complete interface to
18827 this tool (and it's smaller cousin
18831 ) to exploit the full power of it.
18832 But it's not exactly useless as it is now: go try it on one of your existing
18833 documents of a certain length and be surprised.
18836 \begin_layout Section
18837 Version Control in LyX
18840 \begin_layout Standard
18843 Lars Gullik Bjønnes
18850 \begin_layout Subsection
18854 \begin_layout Standard
18855 A friend of mine wanted to try LyX for a group project.
18856 When he didn't find support for version control or file locking, he dropped
18858 This angered me a bit, so I thought that I should at least make support
18859 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
18860 This has been done.
18861 LyX now supports some of the most basic RCS/CVS/SVN commands.
18862 If you need something a bit more sophisticated you will have to do that
18863 manually in a terminal.
18866 \begin_layout Standard
18867 Before you begin to use the version control features in LyX, you should
18868 be familiar with RCS/CVS/SVN usage before start using it under LyX.
18869 Also note that CVS support was obsoloted by introducing subversion support
18870 so we advice using SVN instead.
18871 Good place to start with Subversion is SVN Book
18875 \begin_layout Plain Layout
18876 \begin_inset CommandInset href
18878 target "http://svnbook.red-bean.com/"
18888 In case of RCS you should read
18889 \begin_inset Quotes eld
18893 \begin_inset Quotes erd
18896 (a man file, read it with
18901 This file describes all the basic features of RCS.
18902 You should especially notice the comment about a RCS directory, and the
18903 notion of a master RCS file (the file ending in
18910 \begin_layout Standard
18911 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18912 package—no guarantees are made for older versions.
18913 Most of the log messages are not currently displayed after operations -
18914 you can check them in Messages pane if unsure.
18917 \begin_layout Standard
18918 For introducing your own external commands consult vc-command in the manual
18922 \begin_layout Subsection
18923 RCS commands in LyX
18926 \begin_layout Standard
18927 The following sections describe the RCS commands supported by LyX.
18928 You can find them in the
18930 File\SpecialChar \menuseparator
18932 \begin_inset space ~
18938 LyX was tested against RCS 5.7.
18941 \begin_layout Subsubsection
18947 \begin_layout Standard
18948 If your document is not under revision control, this is the only item shown
18950 And if it is under revision control, the
18954 item is not visible.
18958 \begin_layout Standard
18959 This command registers your document with RCS (unless you are under the
18960 directory managed by CVS)\SpecialChar \@.
18961 You are asked interactively to supply an initial
18962 description of the document.
18963 The document is now set in Read-Only mode and you have to
18966 \begin_inset space ~
18970 \begin_inset space ~
18974 \begin_inset space ~
18979 , before making any changes to it.
18980 A document under revision control has a
18981 \begin_inset Quotes eld
18984 [RCS:<version> <locker>]
18985 \begin_inset Quotes erd
18988 item tagged to the filename in the minibuffer.
18991 \begin_layout Standard
18992 RCS command that is run:
18994 ci -q -u -i -t-"<initial description>" <file-name>
18997 \begin_layout Standard
19002 to understand the switches.
19006 \begin_layout Subsubsection
19012 \begin_layout Standard
19013 When you are finished editing a file, you check in your changes.
19014 When you do this, you are asked for a description of the changes.
19015 This is stored in the history log.
19016 The version number is bumped, your changes are applied to the master RCS
19017 file, the document is unlocked and set to Read-Only mode.
19021 \begin_layout Standard
19024 ci -q -u -m"<description>" <file-name>
19027 \begin_layout Subsubsection
19033 \begin_layout Standard
19034 By doing this you lock the document so that only you can edit it.
19035 This will also make the document Read-Write only for you.
19036 You will usually continue editing for a while and when you are finished
19037 you check in your changes.
19038 The status line is changed to reflect that you have locked the file.
19042 \begin_layout Standard
19045 co -q -l <file-name>
19048 \begin_layout Subsubsection
19051 Revert To Repository Version
19054 \begin_layout Standard
19055 This will discard all changes made to the document since the last check
19057 You get a warning before changes are discarded.
19060 \begin_layout Standard
19063 co -f -u<version> <file-name>
19066 \begin_layout Subsubsection
19072 \begin_layout Standard
19073 This makes as if the last check in never happened.
19074 No changes are made to the document loaded into LyX, but the last version
19075 is removed from the master RCS file.
19079 \begin_layout Standard
19082 rcs -o<version> <file-name>
19085 \begin_layout Subsubsection
19091 \begin_layout Standard
19092 This show the complete history of the RCS document.
19097 is shown in a browser.
19105 \begin_layout Subsubsection
19109 \begin_layout Standard
19110 LyX supports RCS version number information (only), see
19111 \begin_inset CommandInset ref
19113 reference "sub:VCS-Revision-Information"
19120 \begin_layout Subsection
19121 CVS commands in LyX
19124 \begin_layout Standard
19125 CVS is now partially supported by LyX.
19126 You can find the commands in the
19128 File\SpecialChar \menuseparator
19130 \begin_inset space ~
19136 Focus of the development moved to SVN support, so please use it instead
19137 of CVS if possible.
19140 \begin_layout Subsubsection
19146 \begin_layout Standard
19147 If your document is not under revision control, this is the only item shown
19149 And if it is under revision control, the
19156 item is not visible.
19160 \begin_layout Standard
19161 This command registers in CVS your document ONLY in case you have already
19162 the documents directory under CVS control (in particular
19167 This means you have to checkout the archive by yourself.
19171 \begin_layout Standard
19172 Then you are asked interactively to supply an initial description of the
19174 Don't forget that registered file is not yet commited.
19177 \begin_layout Standard
19178 CVS command that is run:
19181 \begin_inset Quotes erd
19185 \begin_inset Quotes eld
19189 \begin_inset Quotes erd
19195 \begin_layout Standard
19200 to understand the switches.
19204 \begin_layout Subsubsection
19210 \begin_layout Standard
19211 When you are finished editing a file, you commit your changes.
19212 When you do this, you are asked for a description of the changes.
19213 After that changes are commited.
19216 \begin_layout Standard
19219 cvs -q commit -m"<description>" "<file-name>"
19222 \begin_layout Subsubsection
19225 Revert To Repository Version
19228 \begin_layout Standard
19229 This will discard all changes made to the document since the last check
19231 You get a warning before changes are discarded.
19232 Firstly the file is deleted, secondly CVS update command is run.
19235 \begin_layout Standard
19239 \begin_inset Quotes eld
19243 \begin_inset Quotes erd
19249 \begin_layout Subsubsection
19255 \begin_layout Standard
19256 This show the complete history of the CVS document.
19260 \begin_inset Quotes eld
19264 \begin_inset Quotes erd
19269 is shown in a browser.
19272 \begin_layout Subsection
19273 SVN commands in LyX
19276 \begin_layout Standard
19277 SVN is now partially supported by LyX.
19278 You can find the commands in the
19280 File\SpecialChar \menuseparator
19282 \begin_inset space ~
19288 Please note that if you use password protected access to repository via
19289 ssh, you will be asked in terminal window.
19290 LyX was tested against SVN 1.5 and 1.6
19294 \begin_layout Plain Layout
19295 Most of the commands will work with 1.4 too, see
19296 \begin_inset CommandInset ref
19298 reference "sub:SVN-Repo-Update"
19310 \begin_layout Subsubsection
19316 \begin_layout Standard
19317 If your document is not under revision control, this is the only item shown
19319 And if it is under revision control, the
19326 item is not visible.
19330 \begin_layout Standard
19331 This command registers in SVN your document ONLY in case you have already
19332 the documents directory under SVN control (in particular
19337 This means you have to checkout the archive by yourself.
19341 \begin_layout Standard
19342 Then you are asked interactively to supply an initial description of the
19344 Don't forget that registered file is not yet commited.
19347 \begin_layout Standard
19348 SVN command that is run:
19351 \begin_inset Quotes eld
19355 \begin_inset Quotes erd
19361 \begin_layout Standard
19366 to understand the switches.
19370 \begin_layout Subsubsection
19376 \begin_layout Standard
19377 When you are finished editing a file, you commit your changes.
19378 When you do this, you are asked for a description of the changes.
19379 After that changes are commited.
19382 \begin_layout Standard
19387 \begin_layout Plain Layout
19388 In case locking is not enabled.
19390 \begin_inset CommandInset ref
19392 reference "subsec:SVN-File-Locking"
19403 svn commit -q -m"<description>" <file-name>
19406 \begin_layout Subsubsection
19412 \begin_layout Standard
19413 Updates the changes of this file from the repository.
19414 Be sure you understand SVN merging and conflicts resolving before using
19415 this function, because all conflicts has to be resolved manually by you!
19418 \begin_layout Standard
19423 \begin_layout Plain Layout
19431 svn update --non-interactive
19432 \begin_inset Quotes eld
19436 \begin_inset Quotes erd
19442 \begin_layout Subsubsection
19445 Revert To Repository Version
19448 \begin_layout Standard
19449 This will discard all changes made to the document since the last check
19451 You get a warning before changes are discarded.
19455 \begin_layout Standard
19459 \begin_inset Quotes eld
19463 \begin_inset Quotes erd
19469 \begin_layout Subsubsection
19470 \begin_inset CommandInset label
19472 name "sub:SVN-Repo-Update"
19476 Update of the local directory checkout from repository
19480 \begin_layout Plain Layout
19481 Note that this command will work only with subversion
19482 \begin_inset Formula $\geqq1.5$
19493 \begin_layout Standard
19494 All the commands above have one shortcomming - they deal with the current
19496 Once your document contains pictures, includes external
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19506 files and so on administration becomes more complicated.
19507 LyX now supports updating the whole tree in which resides the document
19511 \begin_layout Plain Layout
19512 One need to organize the files structure so that all external files are
19513 in the same directory or subdirectories of the document.
19520 This become especially useful once you cooperate with people which neither
19521 know about subversion management nor they have ambition to commit additional
19522 material to the repository.
19526 \begin_layout Standard
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19531 Update local directory from repository
19536 command updates the whole directory and in case of merge conflicts local
19537 version of the files are left, so no unintended data loss occurs.
19538 If local changes are detected user is warned before update starts.
19541 \begin_layout Labeling
19542 \labelwidthstring 00.00.0000
19544 \begin_inset space ~
19548 \begin_inset space ~
19552 \begin_inset Newline newline
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19565 (Ask if changes are detected.)
19566 \begin_inset Newline newline
19570 \begin_inset Flex Code
19573 \begin_layout Plain Layout
19574 svn update --accept mine-full $path
19582 \begin_layout Standard
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 stands for the path to the document.
19596 \begin_layout Subsubsection
19602 \begin_layout Standard
19603 This show the complete history of the SVN document.
19607 \begin_inset Quotes eld
19611 \begin_inset Quotes erd
19616 is shown in a browser.
19619 \begin_layout Subsubsection
19621 \begin_inset CommandInset label
19623 name "subsec:SVN-File-Locking"
19630 \begin_layout Standard
19631 The file exchange through various revision control systems brings the problem
19632 of merge conflicts in case two different users try to edit the same (parts
19634 When such conflict happens it needs manual resolving and one reasonable
19635 alternative is to provide some kind of locking mechanism, which guarantees
19636 that only one user is allowed to edit file at the given time.
19639 \begin_layout Standard
19640 SVN has two mechanisms to provide such kind of mutual exclusivity for file
19641 access - locks and automatical setting of write permissions (see sec.
19643 \begin_inset CommandInset ref
19645 reference "subsec:Automatical-Locking-Property"
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19663 \begin_layout Plain Layout
19664 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
19670 In a case this property is detected for a given document LyX starts to
19671 use SVN locks for document editing automatically and the whole check-in/out
19672 mechanism switches to the same regimen as for RCS.
19673 This in particular means there are two different modes how file is used
19677 \begin_layout Itemize
19679 The loaded file is in the read-only mode.
19680 For editation on needs to check-out.
19685 consists of update from repository and gaining write lock.
19686 If the lock is not possible to obtain, we remain in unlocked state.
19689 \begin_layout Itemize
19691 The loaded file is in the 'normal' edit mode.
19692 No other user is allowed to edit the file.
19697 consists of commiting changes and releasing write-lock.
19698 If no changes have been made to the document, no commit will be produced
19702 \begin_layout Plain Layout
19703 Don't be puzzled by the fact that you will be asked for commit message anyway.
19708 and only the write-lock will be released.
19711 \begin_layout Standard
19715 \begin_layout Labeling
19716 \labelwidthstring 00.00.0000
19719 svn commit -q -m"<description>" "<file-name>"
19720 \begin_inset Newline newline
19723 svn unlock "<file-name>"
19726 \begin_layout Labeling
19727 \labelwidthstring 00.00.0000
19730 svn update "<file-name>"
19731 \begin_inset Newline newline
19734 svn lock "<file-name>"
19737 \begin_layout Subsubsection
19740 \begin_inset CommandInset label
19742 name "subsec:Automatical-Locking-Property"
19748 Automatical Locking Property
19751 \begin_layout Standard
19752 The above mentioned automatical setting of write permissions of the .lyx
19753 file can be set through
19758 ile\SpecialChar \menuseparator
19764 \begin_inset space ~
19767 Control\SpecialChar \menuseparator
19772 oggle locking property
19775 This command is active only when the file is not locked on the svn server
19777 you need to check-out before proceeding).
19780 \begin_layout Labeling
19781 \labelwidthstring 00.00.0000
19783 \begin_inset space ~
19789 \begin_layout Labeling
19790 \labelwidthstring 00.00.0000
19793 svn propset svn:needs-lock ON "<file-name>"
19796 \begin_layout Labeling
19797 \labelwidthstring 00.00.0000
19800 svn propdel svn:needs-lock "<file-name>"
19803 \begin_layout Subsubsection
19804 \begin_inset CommandInset label
19806 name "sub:VCS-Revision-Information"
19810 Revision Information in Documents
19813 \begin_layout Standard
19814 There are more possibilities how to activate revision information in our
19818 \begin_layout Itemize
19819 LyX supports directly:
19823 \begin_layout Itemize
19824 tree revision information (
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 The result is the output of the
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19845 command, the following table gives you an idea, how to read the results.
19848 \begin_layout Standard
19850 \begin_inset Tabular
19851 <lyxtabular version="3" rows="6" columns="2">
19852 <features tabularvalignment="middle">
19853 <column alignment="center" valignment="top" width="0">
19854 <column alignment="center" valignment="top" width="0">
19856 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19859 \begin_layout Plain Layout
19865 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19868 \begin_layout Plain Layout
19876 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19879 \begin_layout Plain Layout
19885 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
19888 \begin_layout Plain Layout
19889 mixed revision working copy
19896 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19899 \begin_layout Plain Layout
19905 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
19908 \begin_layout Plain Layout
19909 modified working copy
19916 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19919 \begin_layout Plain Layout
19925 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
19928 \begin_layout Plain Layout
19929 switched working copy
19936 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19939 \begin_layout Plain Layout
19945 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
19948 \begin_layout Plain Layout
19949 partial working copy, from a sparse checkout
19956 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19959 \begin_layout Plain Layout
19965 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19968 \begin_layout Plain Layout
19969 mixed revision, modified, switched working copy
19982 \begin_layout Itemize
19983 file revision information.
19984 The result comes from parsing the output of
19985 \begin_inset Flex Code
19988 \begin_layout Plain Layout
19990 \begin_inset space ~
19994 \begin_inset space ~
19998 \begin_inset space ~
20007 Supported flags are:
20011 \begin_layout Itemize
20012 version number of the last commit (
20013 \begin_inset Flex Code
20016 \begin_layout Plain Layout
20025 \begin_layout Itemize
20026 author of the last commit (
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20039 \begin_layout Itemize
20040 date of the last commit (
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20053 \begin_layout Itemize
20054 time of the last commit (
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20068 \begin_layout Standard
20069 You can obtain this info via InsetInfo (e.g.
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20075 info-insert buffer vcs-date
20081 The information will be available only when you have the file stored under
20082 svn managment (i.e.
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20093 directory is available with your document).
20097 \begin_layout Itemize
20098 Another---a hacking one---possibility is to use svn keywords
20102 \begin_layout Plain Layout
20103 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
20109 In short -- you set file keywords property (e.g.
20112 svn propset svn:keywords 'Rev' file.lyx
20114 ) and then paste keyword ERT
20118 \begin_layout Plain Layout
20119 This is an easy way how to ensure that LyX won't break the line in the middle
20125 tag in your document (e.g.
20130 \begin_layout Plain Layout
20138 This way svn client will automatically substitute revision number (e.g.
20143 \begin_layout Plain Layout
20150 ) after each update and commit.
20151 There are more problems with this approach.
20152 Firstly, the '$' character is used in TeX world for math equations, so
20153 any occurence of math formula
20154 \begin_inset Formula $Rev$
20158 \begin_inset Formula $Rev:59$
20161 in your LyX document.
20162 Similarly for other keywords like Id, Date, Author, etc.
20163 Secondly svn output is dependent on your locales, so its very easy that
20164 svn would produce some problematic strings once Date is used.
20165 Thirdly you get the whole 'Rev: 59' string in your document instead of
20167 Until subversion implements user's custom keywords it will be hard to use
20168 this approach reliably or let LyX to support it directly.
20171 \begin_layout Subsection
20172 SVN and Windows Environment
20175 \begin_layout Quote
20176 My inclination is to say that if the user cannot figure out the command
20177 line operations on their own fairly quickly, they would be well advised
20178 to use TortoiseSVN.
20184 \begin_layout Subsubsection
20188 \begin_layout Standard
20189 In addition to installing LyX, and having access to a Subversion repository,
20190 the user will need to install the Subversion client program.
20191 A Windows installer for the client program is available from
20192 \begin_inset CommandInset href
20195 target "http://www.collab.net/nonav/downloads/subversion/"
20200 The user may also want to install
20201 \begin_inset CommandInset href
20204 target "http://tortoisesvn.tigris.org/"
20208 , which integrates Subversion operations into the context (rightclick) menu
20209 of Windows Explorer.
20210 Operations done outside LyX will typically be more convenient using the
20211 Explorer context menu.
20212 Note that TortoiseSVN is not a replacement for the client program, which
20213 is what LyX itself will use.
20216 \begin_layout Subsubsection
20217 Bringing a document under Subversion control
20220 \begin_layout Standard
20221 Before a LyX document can be brought under version control in Subversion,
20222 its parent directory needs to be under version control.
20223 If the document is being added to a project already in the repository,
20224 this is accomplished by checking the project out to the directory where
20225 the new document will be placed.
20226 If the project itself is not yet under version control (for instance, if
20227 this document starts a new project), the directory must be imported into
20229 This is done outside LyX.
20230 Both import and checkout are easily accomplished from the Explorer context
20231 menu using TortoiseSVN, or alternatively can be done using the command
20232 line client at a DOS prompt.
20233 The procedure for importing the project using TortoiseSVN is described
20234 below, assuming an existing repository and a new project being started
20242 For information on using the Subversion client program, run
20249 \begin_layout Enumerate
20256 in Windows Explorer, right click it, and select
20258 TortoiseSVN > Repo-browser
20261 If necessary, adjust the URL for the repository, then click OK.
20264 \begin_layout Enumerate
20265 Right click the level of the repository under which you want to place the
20266 new project folder (typically the top level) and click
20268 Create folder\SpecialChar \ldots{}
20271 Supply a name for the project folder and click OK.
20272 Add a message for the log file if desired, then click OK again.
20273 The new project folder should appear in the repository.
20274 Finally, click OK again to exit the repository browser.
20277 \begin_layout Enumerate
20278 Once again right click
20284 , this time selecting SVN Checkout\SpecialChar \ldots{}
20285 Select the URL of the project folder
20286 you just created in the repository, and set the checkout directory to
20294 You will be warned about a non-empty folder; click OK to proceed.
20295 You should now have a
20306 \begin_layout Enumerate
20307 Create or open your document in LyX and click
20312 ile\SpecialChar \menuseparator
20318 \begin_inset space ~
20321 Control\SpecialChar \menuseparator
20329 Add a log message and click OK to commit the document to version control.
20332 \begin_layout Standard
20333 From this point onward, you should have full functionality in the
20338 ile\SpecialChar \menuseparator
20344 \begin_inset space ~
20350 You also have the option of checking the document in and out, viewing its
20352 using the TortoiseSVN context menu in Windows Explorer or the Subversion
20353 client program from a command prompt.
20356 \begin_layout Subsubsection
20357 SSH tunel used with SVN under Windows
20360 \begin_layout Standard
20361 Compared to linux setting svn client to communicate over ssh under Windows
20362 is rather troublesome task.
20363 We will at least make some hints how to setup client side but former knowledge
20364 about ssh and Windows command line is needed, also be prepared for a great
20365 deal of frustration...
20368 \begin_layout Enumerate
20369 Get svn client for windows, as described in previous sections.
20370 When it is fresh install run some svn command (e.g.
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20381 ) to have created config files, which you will need to change later on.
20384 \begin_layout Enumerate
20385 Choose ssh client for Windows.
20386 There are more possibilities, we will use the one from Putty tools
20390 \begin_layout Plain Layout
20391 \begin_inset Flex URL
20394 \begin_layout Plain Layout
20396 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
20407 You will need to automatize connection, so client doesn't ask for any password
20409 To keep things easy we will use only keys without any additional password
20414 \begin_layout Enumerate
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20426 Save your private .ppk key file and put the public one on the server side.
20427 In case the SVN server runs on linux, note that the format of the public
20428 key is not compatible with linux openssh and you will need to direcly copy-past
20429 e the key from the “
20431 Public key for pasting into OpenSSH authorized_keys file
20433 :” edit field into the server's
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20438 ~/.ssh/authorized_keys
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20456 \begin_layout Enumerate
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20468 In the SVN config file
20472 \begin_layout Plain Layout
20473 Exact path depends on Windows version, usually somewhere around
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20480 Documents and Settings
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20512 , section [tunnels], setup ssh command, e.g.
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20518 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
20527 \begin_layout Plain Layout
20528 It will usually take a lot of time to get exact command right and it depends
20530 For example do not have some remote server saved as a default session in
20532 If things fail, try to connect via plink without SVN first.
20541 \begin_layout Enumerate
20542 Checkout the SVN archive, e.g.
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20548 svn co svn+ssh://user@server/repository_path
20556 \begin_layout Subsubsection
20557 End-of-Line Conversions
20560 \begin_layout Standard
20561 When the collsraborators are mixing Linux and Windows environments, LyX
20562 will use different line endings inside the .lyx files.
20563 This is not problem as far as LyX functionality is concerned, but the commit
20564 diffs will be huge and merge-conflicts prone.
20565 Fortunately SVN itself knows
20569 \begin_layout Plain Layout
20570 \begin_inset Flex URL
20573 \begin_layout Plain Layout
20575 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
20585 how to deal with CR/LF problems when switching .lyx files to the
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20599 \begin_layout Plain Layout
20601 \begin_inset Flex Code
20604 \begin_layout Plain Layout
20605 svn propset svn:eol-style native FILE_NAME
20618 \begin_layout Subsection
20622 \begin_layout Standard
20623 With the recent addition of the vc-command function LyX power users are
20624 allowed to create their own commands for revision control.
20627 \begin_layout Standard
20628 As an example you can see how two TortoiseSVN commands could be integrated
20632 \begin_layout Description
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20638 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
20646 \begin_layout Description
20648 \begin_inset Flex Code
20651 \begin_layout Plain Layout
20652 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
20660 \begin_layout Subsection
20661 Version control and Document comparison
20664 \begin_layout Standard
20665 One of the typical uses of version control is to inspect the changes between
20666 revisions, usually by creating
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20677 While this is useful for plain text files, it is much less useful in the
20678 case of LyX files, which have more complicated structure.
20679 Hence we provide binding to the Document comparison feature.
20680 They are two ways of calling this feature - either by direct call of
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20690 LyX function (for details see LyX functions manual) or by icon/menu item
20692 \begin_inset Flex MenuItem
20695 \begin_layout Plain Layout
20696 Compare with older revision...
20702 One can either compare two chosen revisions of the document or he can simply
20703 compare the current version of edited text with older revisions (where
20705 \begin_inset Flex MenuItem
20708 \begin_layout Plain Layout
20714 ' revisions back means comparison of the edited file with last commited
20719 \begin_layout Standard
20720 This feature is supported for SVN and RCS though due to the more complicated
20721 versioning scheme of RCS there is a constraint -- when addressing the revisions
20722 in dialog, numbers always point to the last number in RCS revision number,
20727 \begin_layout Section
20728 Literate Programming
20731 \begin_layout Standard
20736 (kayvan@sylvan.com)
20740 original documentation written by
20742 Edmar Wienskoski Jr.
20745 (edmar-w-jr@technologist.com)
20748 \begin_layout Subsection
20752 \begin_layout Standard
20753 The main purpose of this documentation is to show you how to use LyX for
20754 literate programming.
20755 Where it is assumed that you are familiar with this programming technique,
20757 \begin_inset Quotes eld
20761 \begin_inset Quotes erd
20765 \begin_inset Quotes eld
20769 \begin_inset Quotes erd
20773 If that is not the case, please follow the web links provided in the following
20775 There is a lot of good documentation out there covering old development
20776 history to the latest tools tips.
20779 \begin_layout Standard
20780 It is also assumed that you are familiar with LyX itself to a point that
20781 you are comfortable changing your LyX preferences, and X resources file.
20782 If that is not the case please refer to other LyX documentation to cover
20783 your specific needs.
20786 \begin_layout Subsection
20787 Literate Programming
20790 \begin_layout Standard
20791 From the Literate Programming FAQ:
20794 \begin_layout Quotation
20795 Literate programming is the combination of documentation and source together
20796 in a fashion suited for reading by human beings.
20797 In fact, literate programs should be enjoyable reading, even inviting!
20798 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20799 and documentation in a single file.
20800 Literate programming tools then parse the file to produce either readable
20801 documentation or compilable source.
20802 The WEB style of literate programming was created by D.
20803 \begin_inset space \thinspace{}
20807 Knuth during the development of his TeX typesetting software.
20811 \begin_layout Standard
20812 Another excerpt says:
20815 \begin_layout Quotation
20818 How is literate programming different from verbose commenting?
20821 \begin_layout Quotation
20822 There are three distinguishing characteristics.
20823 In order of importance, they are:
20827 \begin_layout Itemize
20828 flexible order of elaboration
20831 \begin_layout Itemize
20832 automatic support for browsing
20835 \begin_layout Itemize
20836 typeset documentation, especially diagrams and mathematics
20840 \begin_layout Standard
20841 Now that I sparked your curiosity, take a look in the references.
20844 \begin_layout Subsubsection
20848 \begin_layout Standard
20849 The complete Literate Programming FAQ can be found at:
20852 \begin_layout Quote
20853 Literate Programming FAQ
20854 \begin_inset Flex URL
20857 \begin_layout Plain Layout
20859 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
20867 \begin_layout Standard
20868 The FAQ lists 23 (twenty three!) different literate programming tools.
20869 Where some are specialized or
20870 \begin_inset Quotes eld
20874 \begin_inset Quotes erd
20877 for particular programming languages, while other have general scope.
20882 for my own use for several reasons:
20885 \begin_layout Itemize
20886 It can generate the documentation either in LaTeX or HTML.
20889 \begin_layout Itemize
20890 It has a open architecture, i.
20891 \begin_inset space \thinspace{}
20895 \begin_inset space \space{}
20898 it is easy to plug in new filters and to perform special processing that
20903 \begin_layout Itemize
20904 There is a good selection of filters available already (the HTML is one
20908 \begin_layout Itemize
20912 \begin_layout Standard
20913 The Noweb web page can be found at:
20916 \begin_layout Quote
20918 \begin_inset Flex URL
20921 \begin_layout Plain Layout
20923 http://www.cs.virginia.edu/~nr/noweb/
20931 \begin_layout Standard
20932 Starting from there you can reach many other interesting links and even
20933 some literate program examples.
20936 \begin_layout Subsection
20937 LyX and Literate Programming
20940 \begin_layout Standard
20941 The LyX support for Literate Programming is provided by using the generic
20942 LyX converters mechanism.
20943 This support is provided in a
20944 \begin_inset Quotes eld
20948 \begin_inset Quotes erd
20952 \begin_inset space \thinspace{}
20956 \begin_inset space \space{}
20959 you will be able to use this new LyX feature with some other literate programmin
20960 g tool of your choice by just changing your LyX preferences.
20963 \begin_layout Subsubsection
20964 Generating documents and code (weaving and tangling)
20967 \begin_layout Paragraph
20968 Selecting the document class
20971 \begin_layout Standard
20972 If you have installed Noweb and LyX successfully, whenever you open a new
20973 document or try to change the document class of an existing one, you will
20974 find that there are three new document classes available:
20977 \begin_layout Itemize
20981 \begin_layout Itemize
20985 \begin_layout Itemize
20989 \begin_layout Standard
20990 You must select one of them to create your literate documents from.
20994 \begin_layout Standard
20995 Note that literate documents are not limited to these three classes.
20996 New classes can be generated from other styles like letter or in combination
20997 with other class variations like Article (AMS).
20998 If you have special needs that cannot be covered by one of the existing
20999 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21000 will arrange to insert a new entry, or teach you how to do it.
21004 \begin_layout Plain Layout
21005 It is very simple, it involves the creation of a file with four lines, and
21006 re-running of the auto configuration.
21011 Moreover, if you use a literate tool other than Noweb you may need to create
21012 a new set of document classes for it.
21015 \begin_layout Paragraph
21019 \begin_layout Standard
21020 LyX enables you to write code with a layout named
21028 \begin_layout Plain Layout
21029 The equivalent Noweb term is
21030 \begin_inset Quotes eld
21034 \begin_inset Quotes erd
21038 For historical reasons, I got used to the term
21039 \begin_inset Quotes eld
21043 \begin_inset Quotes erd
21046 introduced by other literate tool named Nuweb, which I used for many years
21047 before rendering myself to Noweb.
21052 Noweb delimits scraps like this:
21055 \begin_layout LyX-Code
21059 \begin_layout LyX-Code
21063 \begin_layout LyX-Code
21067 \begin_layout LyX-Code
21071 \begin_layout LyX-Code
21075 \begin_layout Standard
21076 The problem is that whatever is written in between the << and the
21080 must be taken literally, i.
21081 \begin_inset space \thinspace{}
21085 \begin_inset space \space{}
21088 LyX should be prevented from making any special interpretation of what has
21090 This is handled by a special layout named Scrap, that works like a normal
21091 paragraph but has a free spacing capability.
21094 \begin_layout Standard
21095 The down side of the Scrap paragraph layout is that consecutive paragraphs
21096 of code will be spaced with one empty line in the source code and also
21097 in the printed documentation.
21098 The work around is to enter each line of code within a single Scrap, with
21099 a newline (ctrl-return).
21100 The example above will look like this:
21104 \begin_layout Plain Layout
21105 If you have a printed version of this document you will not see any difference
21106 between the previous example and this one.
21114 \begin_layout LyX-Code
21116 \begin_inset Newline newline
21120 \begin_inset Newline newline
21124 \begin_inset Newline newline
21128 \begin_inset Newline newline
21134 \begin_layout Standard
21135 This layout works fine.
21136 The only real inconvenience is that you have to type ctrl-return instead
21141 \begin_layout Plain Layout
21142 It is in my list of
21143 \begin_inset Quotes eld
21147 \begin_inset Quotes erd
21158 \begin_layout Standard
21159 As a special note, you can also use the
21160 \begin_inset Quotes eld
21164 \begin_inset Quotes erd
21167 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21171 \begin_layout LyX-Code
21173 \begin_inset Newline newline
21176 def some_function(args):
21177 \begin_inset Newline newline
21180 "This is the doc string for this function."
21181 \begin_inset Newline newline
21184 print "My args: ", args
21187 \begin_layout LyX-Code
21188 @ %def some_function
21191 \begin_layout Standard
21192 For an example of this usage and the resulting cross-reference output, look
21193 at the Literate python program in
21195 LIBDIR/examples/listerrors.lyx
21197 which should make this all clear.
21200 \begin_layout Paragraph
21201 Generating the documentation
21204 \begin_layout Standard
21205 At this point you already have a new document file with a proper document
21206 class, and with some code and text on it.
21207 How do I print it? The answer is simple, you select
21209 View\SpecialChar \menuseparator
21213 Just like you would do for a plain document.
21214 No special procedure is required.
21217 \begin_layout Standard
21218 To help orientate you, I will now explain what happens inside LyX:
21221 \begin_layout Enumerate
21224 Update\SpecialChar \menuseparator
21227 menu option is chosen, a LaTeX file is generated.
21232 \begin_layout Standard
21233 If the document is of any literate class the generated file will be named
21234 with an extension name defined by the
21235 \begin_inset Quotes eld
21239 \begin_inset Quotes erd
21242 format (defined in the Preferences panel), otherwise the file will have
21251 \begin_layout Enumerate
21252 Note that the only difference so far is in the name of the file, no special
21253 processing is required by LyX.
21254 Given that you formatted the code using the Scrap layout that, by itself,
21255 takes care of the business.
21258 \begin_layout Enumerate
21259 If the document is of any literate class LyX will then use the internal
21260 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21264 \begin_layout Plain Layout
21265 The converters are defined in the
21267 Tools\SpecialChar \menuseparator
21271 \begin_inset Quotes eld
21275 \begin_inset Quotes erd
21287 manual for general information about converters.
21292 to generate the LaTeX file.
21296 \begin_layout Standard
21297 Otherwise it will just skip this step.
21301 \begin_layout Enumerate
21302 Finally, LaTeX is invoked and the regular post processing continues as in
21306 \begin_layout Standard
21307 Independence from a particular
21308 \begin_inset Quotes eld
21312 \begin_inset Quotes erd
21315 is easily achieved by changing the commands that are run by the various
21319 \begin_layout Paragraph
21320 Generating the code
21323 \begin_layout Standard
21324 When the build menu option is chosen or the corresponding button in the
21325 toolbar is pressed, a LaTeX file is generated just like step 1 above.
21326 Next, LyX invokes the
21331 This converter needs to be defined by the user and is not installed by
21332 default, though the Program format is.
21333 This converter (like any other converter) will have two parts:
21336 \begin_layout Enumerate
21337 The converter program itself.
21338 This program performs the conversion from the one format to the other (in
21339 this case, from the Noweb format to the Program pseudo-format).
21342 \begin_layout Enumerate
21343 The error log parser.
21344 This is a program whose sole purpose is to rewrite error messages in a
21345 format that LyX understands.
21346 This makes it possible for LyX to place error boxes in the right places
21347 in the file buffer.
21350 \begin_layout Standard
21351 The first part, the
21352 \begin_inset Quotes eld
21356 \begin_inset Quotes erd
21359 setting, should be set to
21360 \begin_inset Quotes eld
21368 \begin_inset Quotes erd
21372 This basically means that LyX will call
21373 \begin_inset Quotes eld
21377 \begin_inset Quotes erd
21380 (a program or script) with the name of the Noweb file (normally a file
21381 in the LyX temp directory).
21385 \begin_layout Standard
21386 This is an implementation of
21387 \begin_inset Quotes eld
21391 \begin_inset Quotes erd
21394 that you can place in a directory on your path:
21397 \begin_layout LyX-Code
21401 \begin_layout LyX-Code
21405 \begin_layout LyX-Code
21406 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21409 \begin_layout Standard
21410 The next part of the converter setting is the
21411 \begin_inset Quotes eld
21415 \begin_inset Quotes erd
21418 which is to be set to
21419 \begin_inset Quotes eld
21424 parselog=listerrors
21427 \begin_inset Quotes erd
21431 This will run any errors that are generated by the
21432 \begin_inset Quotes eld
21436 \begin_inset Quotes erd
21439 process through the
21440 \begin_inset Quotes eld
21444 \begin_inset Quotes erd
21450 \begin_layout Standard
21451 The converter code looks in
21459 then on the path for the
21460 \begin_inset Quotes eld
21464 \begin_inset Quotes erd
21470 \begin_layout Standard
21471 The build will normally take place in LyX's temporary directory, so the
21472 files produced by the conversion will be in that directory.
21473 LyX will copy out what it regards as the `main' file, but the
21477 conversion may produce several files, and so most of these would then be
21478 deleted when LyX was closed.
21479 The present solution is to use a `copier',
21483 \begin_layout Plain Layout
21492 manual for information on these.
21501 script in its default mode, so that the entire contents of the temporary
21502 directory is copied.
21503 More will get copied than is needed, to be sure, but nothing will be lost.
21504 If, however, you know what extensions the generated files will have, this
21505 can be improved by using the
21514 This option takes a comma-separated list of extensions to copy.
21515 So, for example, if the conversion will generate only files with the extensions
21524 , then the correct definition would be:
21527 \begin_layout LyX-Code
21528 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
21531 \begin_layout Standard
21532 The result will be that only files with these two extensions will be copied
21536 \begin_layout Paragraph
21537 Build instructions in the document
21540 \begin_layout Standard
21541 The last piece of the integration between LyX and noweb is the
21542 \begin_inset Quotes eld
21546 \begin_inset Quotes erd
21550 Generally, the instructions for building your program should be embedded
21551 in a scrap of its own.
21553 \begin_inset Quotes eld
21557 \begin_inset Quotes erd
21560 above uses the notangle command to look for this scrap (called
21561 \begin_inset Quotes eld
21565 \begin_inset Quotes erd
21568 ) and runs its contents through
21569 \begin_inset Quotes eld
21573 \begin_inset Quotes erd
21579 \begin_layout Standard
21580 Typically, such a scrap would look something like this:
21583 \begin_layout LyX-Code
21585 \begin_inset Newline newline
21589 \begin_inset Newline newline
21593 \begin_inset Newline newline
21596 if [ -z "${NOWEB_SOURCE}" ]
21597 \begin_inset Newline newline
21601 \begin_inset Newline newline
21604 NOWEB_SOURCE=myfile.nw
21605 \begin_inset Newline newline
21609 \begin_inset Newline newline
21613 code to extract files ...]
21614 \begin_inset Newline newline
21618 code to compile files ...]
21619 \begin_inset Newline newline
21625 \begin_layout Standard
21628 LIBDIR/examples/listerrors.lyx
21632 LIBDIR/examples/Literate.lyx
21634 which implement two versions of the
21635 \begin_inset Quotes eld
21639 \begin_inset Quotes erd
21642 program for some illustrations of how all of these pieces go together or
21645 LIBDIR/examples/noweb2lyx.lyx.
21648 Interestingly, these three files show off the language-indepence of the
21649 LyX literate programming support since they are written in Python, C and
21653 \begin_layout Subsubsection
21657 \begin_layout Standard
21658 All the Literate Programming support is configured by the
21660 Tools\SpecialChar \menuseparator
21664 \begin_inset Quotes eld
21668 \begin_inset Quotes erd
21672 The important parts are:
21675 \begin_layout Description
21677 \begin_inset space ~
21681 \begin_inset Quotes eld
21685 \begin_inset Quotes erd
21689 \begin_inset space ~
21692 format Set up via the Formats tab, this is where the Noweb-specific pieces
21702 , the file extension is set to
21707 This tells LyX to create a file with a
21711 extension in the first step of the conversion process.
21714 \begin_layout Description
21716 \begin_inset space ~
21724 \begin_inset space ~
21727 format This is an empty format whose sole purpose is to be the endpoint
21728 of a conversion (which then allows us to set up a converter for it).
21731 \begin_layout Description
21740 This converter performs the
21741 \begin_inset Quotes eld
21745 \begin_inset Quotes erd
21748 of the literate document.
21749 For Noweb, it is set to
21750 \begin_inset Quotes eld
21755 noweave -delay -index $$i > $$o
21758 \begin_inset Quotes erd
21764 \begin_layout Description
21774 \begin_inset Quotes eld
21778 \begin_inset Quotes erd
21782 As stated above, the Converter is set to
21783 \begin_inset Quotes eld
21791 \begin_inset Quotes erd
21794 , with Flags set to
21795 \begin_inset Quotes eld
21800 originaldir,parselog=listerrors
21803 \begin_inset Quotes erd
21809 \begin_layout Subsubsection
21813 \begin_layout Standard
21814 There is also a new function implemented in the LyX server, the
21815 \begin_inset Quotes eld
21818 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21822 \begin_layout Standard
21823 When debugging code with ddd/gdb, it is possible to invoke a text editor
21824 at the current execution position with a single key stroke.
21825 The default ddd configuration for that is shift-ctrl-V.
21826 It happens that you can define the editor command line invocation in ddd
21829 Edit\SpecialChar \menuseparator
21830 Preferences\SpecialChar \menuseparator
21833 dialog and changing the "Edit Sources" entry.
21836 \begin_layout Standard
21837 I take advantage of the new created LyX server function and this ddd feature,
21839 \begin_inset Quotes eld
21843 \begin_inset Quotes erd
21849 \begin_layout LyX-Code
21850 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21853 \begin_layout Standard
21854 With this, whenever you are using ddd and find a point in the program that
21855 you want to edit, you just press shift-ctrl-V (in the ddd window), and
21856 ddd you forward this information to LyX through the LyX server and then
21857 the LyX window will show the same file with the cursor at the same position
21858 ddd was pointing to.
21859 No more guessing or long scrolling to locate a point in the program back
21863 \begin_layout Standard
21864 Note however that you must enable the LyX server to get this feature working
21865 (it is disabled by default).
21866 You can enable it in
21878 ) by entering in the
21883 \begin_inset Quotes eld
21888 /home/<your-home-directory>/.lyx/lyxpipe
21891 \begin_inset Quotes erd
21897 \begin_layout Standard
21898 Read the LyX server documentation in the
21900 Customization Manual
21902 for further information.
21905 \begin_layout Subsubsection
21909 \begin_layout Standard
21910 There are six new buttons that can be added to your LyX toolbar.
21911 Five of these buttons are short cuts to layout styles:
21932 The last one is a short cut to the
21933 \begin_inset Quotes eld
21937 \begin_inset Quotes erd
21944 \begin_layout Standard
21945 LyX has a range of buttons that are available for tool bar customization.
21946 In my toolbar I like to combine the six short cuts above with two more:
21951 \SpecialChar \menuseparator
21956 \SpecialChar \menuseparator
21963 View\SpecialChar \menuseparator
21967 Here is how it looks like:
21970 \begin_layout LyX-Code
21974 \begin_layout LyX-Code
21978 \begin_layout LyX-Code
21979 Icon "layout Standard"
21982 \begin_layout LyX-Code
21983 Icon "layout Section"
21986 \begin_layout LyX-Code
21987 Icon "layout LaTeX"
21990 \begin_layout LyX-Code
21991 Icon "layout LyX-Code"
21994 \begin_layout LyX-Code
21995 Icon "layout Scrap"
21998 \begin_layout LyX-Code
22002 \begin_layout LyX-Code
22006 \begin_layout LyX-Code
22007 Icon "buffer-typeset"
22010 \begin_layout LyX-Code
22011 Icon "build-program"
22014 \begin_layout LyX-Code
22018 \begin_layout LyX-Code
22022 \begin_layout LyX-Code
22026 \begin_layout LyX-Code
22030 \begin_layout LyX-Code
22034 \begin_layout Subsubsection
22035 Colors customization
22038 \begin_layout Standard
22039 There are a number of colors in LyX that can be customized in
22044 One of the things that bothers people is the LaTeX font color.
22045 The default color is red, since the scraps uses LaTeX font, and there is
22046 a lot of scraps in literate documents, you may get tired of seeing everything
22048 You can change it by going to the tabs
22057 \begin_layout Standard
22058 The next thing is the visible presence of the newline character in the screen.
22059 You can choose the color of this particular character and make it blend
22061 I recommend you choosing a color that is close to the background but not
22062 equal, that way you still can see it is there, but it is not bothering
22067 \begin_layout Chapter
22068 Secrets of the LaTeX Masters
22069 \begin_inset CommandInset label
22078 \begin_layout Standard
22079 Though LyX is a powerful tool, it cannot hope to support everything that
22080 can be done with pure TeX/LaTeX.
22081 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
22082 as long as you are not afraid to use that
22083 \begin_inset Quotes eld
22087 \begin_inset Quotes erd
22090 button on the toolbar or add things to the LaTeX preamble.
22091 This section lists some tips, tricks, and otherwise cool ideas to give
22092 your document that extra little flair.
22095 Do try this at home
22097 , just start with something a little smaller and less important than your
22101 \begin_layout Standard
22102 Most ideas in this section require less common files in your LaTeX installation.
22103 If you have a system like teTeX, most will already be available.
22104 A few, however, will need to be downloaded from one of the CTAN archives.
22105 Often, there are several ways to do something, or several LaTeX style files
22106 which do the same thing.
22107 We do not endorse one choice over another, we simply claim that we have
22108 done a particular task with a particular file.
22109 Put on your wizard hat, keep an eye out for dragons, and let us begin.
22112 \begin_layout Section
22116 \begin_layout Standard
22119 Lars Gullik Bjønnes
22122 \begin_layout Subsection
22126 \begin_layout Standard
22127 The aim for this chapter
22131 \begin_layout Plain Layout
22132 Editor's note: Lars' original chapter was a masterful description of how
22138 However, it was too long to flow smoothly in this document.
22139 I have therefore chosen to excerpt the most important sections here (sorry,
22140 Lars); you can read the original chapter (and more of the story!) in the
22143 examples/multicol.lyx
22151 is to show how the LaTeX package
22155 can be used in a LyX document.
22156 As LyX doesn't support the
22160 package natively yet, we have to use some small hacks.
22161 By reading this section it should be obvious how to do this.
22164 \begin_layout Subsection
22168 \begin_layout Standard
22173 package allows switching between one and multicolumn format on the same
22175 Footnotes are handled correctly (for the most part), but will be placed
22176 at the bottom of the page and not under each column.
22177 LaTeX's float mechanism, however, is partly disabled in the current implementat
22179 At the moment only page-wide floats can be used within the scope of the
22183 \begin_layout Subsection
22187 \begin_layout Subsubsection
22191 \begin_layout Standard
22192 If you want to have two columns in your text, you have use LaTeX mode to
22197 begin{multicols}{2}
22199 at the point where you want the two column layout to start, and then
22205 where you want it to end.
22209 \begin_layout Standard
22213 \begin_layout Plain Layout
22217 begin{multicols}{2}
22225 \begin_layout Standard
22230 The Adventure of the Empty House
22233 \begin_inset Newline newline
22238 Sir Arthur Conan Doyle
22241 \begin_layout Standard
22244 It was in the spring of the year 1894 that all London was interested, and
22245 the fashionable world dismayed, by the murder of the Honourable Ronald
22246 Adair under most unusual and inexplicable circumstances.
22247 The public has already learned those particulars of the crime which came
22248 out in the police investigation, but a good deal was suppressed upon that
22249 occasion, since the case for the prosecution was so overwhelmingly strong
22250 that it was not necessary to bring forward all the facts.
22251 Only now, at the end of nearly ten years, am I allowed to supply those
22252 missing links which make up the whole of that remarkable chain.
22253 The crime was of interest in itself, but that interest was as nothing to
22254 me compared to the inconceivable sequel, which afforded me the greatest
22255 shock and surprise of any event in my adventurous life.
22256 Even now, after this long interval, I find myself thrilling as I think
22257 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22258 ty which utterly submerged my mind.
22259 Let me say to that public, which has shown some interest in those glimpses
22260 which I have occasionally given them of the thoughts and actions of a very
22261 remarkable man, that they are not to blame me if I have not shared my knowledge
22262 with them, for I should have considered it my first duty to do so, had
22263 I not been barred by a positive prohibition from his own lips, which was
22264 only withdrawn upon the third of last month.
22267 \begin_layout Standard
22271 \begin_layout Plain Layout
22283 \begin_layout Subsubsection
22287 \begin_layout Standard
22288 The same pattern is used when you want more than two columns:
22291 \begin_layout Standard
22295 \begin_layout Plain Layout
22299 begin{multicols}{3}
22307 \begin_layout Standard
22310 It can be imagined that my close intimacy with Sherlock Holmes had interested
22311 me deeply in crime, and that after his disappearance I never failed to
22312 read with care the various problems which came before the public.
22313 And I even attempted, more than once, for my own private satisfaction,
22314 to employ his methods in their solution, though with indifferent success.
22315 There was none, however, which appealed to me like this tragedy of Ronald
22317 As I read the evidence at the inquest, which led up to a verdict of willful
22318 murder against some person or persons unknown, I realized more clearly
22319 than I had ever done the loss which the community had sustained by the
22320 death of Sherlock Holmes.
22321 There were points about this strange business which would, I was sure,
22322 have specially appealed to him, and the efforts of the police would have
22323 been supplemented, or more probably anticipated, by the trained observation
22324 and the alert mind of the first criminal agent in Europe.
22325 All day, as I drove upon my round, I turned over the case in my mind and
22326 found no explanation which appeared to me to be adequate.
22327 At the risk of telling a twice-told tale, I will recapitulate the facts
22328 as they were known to the public at the conclusion of the inquest.
22331 \begin_layout Standard
22335 \begin_layout Plain Layout
22347 \begin_layout Standard
22348 You can have more than 3 columns if you want to, but that might not be very
22349 pleasant for the eye.
22352 \begin_layout Subsubsection
22353 Columns inside columns
22356 \begin_layout Standard
22357 You can even have columns inside columns:
22360 \begin_layout Standard
22364 \begin_layout Plain Layout
22368 begin{multicols}{2}
22376 \begin_layout Standard
22379 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22380 at that time governor of one of the Australian colonies.
22381 Adair's mother had returned from Australia to undergo the operation for
22382 cataract, and she, her son Ronald, and her daughter Hilda were living together
22386 \begin_layout Standard
22390 \begin_layout Plain Layout
22394 begin{multicols}{2}
22402 \begin_layout Standard
22405 The youth moved in the best society–had, so far as was known, no enemies
22406 and no particular vices.
22407 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22408 had been broken off by mutual consent some months before, and there was
22409 no sign that it had left any very profound feeling behind it.
22410 For the rest {sic} the man's life moved in a narrow and conventional circle,
22411 for his habits were quiet and his nature unemotional.
22412 Yet it was upon this easy-going young aristocrat that death came, in most
22413 strange and unexpected form, between the hours of ten and eleven-twenty
22414 on the night of March 30, 1894.
22417 \begin_layout Standard
22421 \begin_layout Plain Layout
22433 \begin_layout Standard
22436 Ronald Adair was fond of cards–playing continually, but never for such stakes
22438 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22439 It was shown that, after dinner on the day of his death, he had played
22440 a rubber of whist at the latter club.
22441 He had also played there in the afternoon.
22446 The evidence of those who had played with him– Mr.
22447 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
22448 and that there was a fairly equal fall of the cards.
22449 Adair might have lost five pounds, but not more.
22450 His fortune was a considerable one, and such a loss could not in any way
22452 He had played nearly every day at one club or other, but he was a cautious
22453 player, and usually rose a winner.
22454 It came out in evidence that, in partnership with Colonel Moran, he had
22455 actually won as much as four hundred and twenty pounds in a sitting, some
22456 weeks before, from Godfrey Milner and Lord Balmoral.
22457 So much for his recent history as it came out at the inquest.
22460 \begin_layout Standard
22464 \begin_layout Plain Layout
22476 \begin_layout Standard
22477 Please do read the file
22479 examples/multicol.lyx
22481 for more advanced examples including column and header spacing, vertical
22482 separator lines, and more.
22485 \begin_layout Section
22490 Paragraph Environment
22491 \begin_inset Argument
22494 \begin_layout Plain Layout
22495 Numbering in Enumerate
22503 \begin_layout Standard
22509 \begin_layout Standard
22510 \begin_inset VSpace bigskip
22516 \begin_layout Standard
22518 The default numbering for the
22522 paragraph environment begins with Arabic numbers and ends with uppercase
22524 Suppose, however, you wanted a different type of numbering scheme.
22525 Here's a quickie example of how to change the numbering scheme:
22528 \begin_layout LyX-Code
22538 \begin_layout LyX-Code
22548 \begin_layout LyX-Code
22558 \begin_layout LyX-Code
22568 \begin_layout Standard
22569 \SpecialChar \ldots{}
22570 which changes the numbering scheme to uppercase Roman numerals, uppercase
22571 letters, Arabic numbers, and lowercase letter.
22574 \begin_layout Standard
22575 Additionally, the previous example also adds a little bit extra to the numbering
22577 For example, the first level label actually looks like:
22578 \begin_inset Quotes eld
22582 \begin_inset Quotes erd
22586 For ease of reading, we'll describe what the numbering schemes look like
22587 using a notation something like this: <
22588 \begin_inset Quotes eld
22592 \begin_inset Quotes erd
22596 \begin_inset space ~
22600 \begin_inset Quotes erd
22604 \begin_inset Quotes erd
22608 \begin_inset space ~
22612 \begin_inset Quotes erd
22616 \begin_inset Quotes erd
22620 \begin_inset space ~
22624 \begin_inset Quotes eld
22628 \begin_inset Quotes erd
22635 \begin_layout Standard
22636 As you can see in the example, there is a label command for each nesting
22643 \SpecialChar \ldots{}
22650 , as well as a counter,
22654 \SpecialChar \ldots{}
22660 There are also five
22661 \begin_inset Quotes eld
22665 \begin_inset Quotes erd
22698 , each of which take one counter as an argument.
22699 You can add characters before or after these, but there's no need to add
22703 \begin_layout Standard
22704 You can get really fancy with these.
22708 \begin_layout LyX-Code
22722 \begin_layout LyX-Code
22734 \begin_layout LyX-Code
22744 \begin_layout LyX-Code
22754 \begin_layout Standard
22755 produces the somewhat out of hand numbering scheme: <
22756 \begin_inset Quotes eld
22760 \begin_inset Quotes erd
22764 \begin_inset space ~
22768 \begin_inset Quotes erd
22772 \begin_inset Quotes erd
22776 \begin_inset space ~
22780 \begin_inset Quotes erd
22784 \begin_inset Quotes erd
22788 \begin_inset space ~
22792 \begin_inset Quotes eld
22796 \begin_inset Quotes erd
22803 \begin_layout Standard
22807 \begin_layout Section
22811 \begin_layout Standard
22817 \begin_layout Standard
22818 \begin_inset VSpace bigskip
22824 \begin_layout Standard
22829 \begin_layout Plain Layout
22835 tmpfont}{cmr17 scaled 2500}{
22847 \begin_layout Standard
22852 \begin_layout Plain Layout
22863 hose of you who like the style of old books probably also like
22864 \begin_inset Quotes eld
22868 \begin_inset Quotes erd
22871 —those large capital letters which begin each new chapter or section.
22872 Implementing them with plain LyX/LaTeX is straightforward (assuming you
22873 know some plain TeX!) but does require a lot of work and many iterations,
22874 as you can see by all the ugly TeX-mode stuff at the beginning of this
22878 \begin_layout Standard
22882 \begin_layout Plain Layout
22888 bigdrop{-1em}{3}{ptmri}{T}+
22893 here is a much easier way of doing this, of course.
22902 ) package from CTAN allows a simple way to add such letters to your documents.
22903 Since this package is not a standard part of teTeX, I can't demonstrate
22904 it within this document, but if you copy this paragraph to a new document,
22906 \begin_inset Quotes eld
22916 \begin_inset Quotes erd
22919 and the pluses from the TeX code at the beginning of the paragraph, and
22924 usepackage{dropcaps}
22926 to your LaTeX preamble, you will get a nice Times Roman Italic
22927 \begin_inset Quotes eld
22931 \begin_inset Quotes erd
22934 , whose height is three lines of text and which protrudes 1 em into the
22936 (Make certain you have copied
22937 \begin_inset Quotes eld
22945 \begin_inset Quotes erd
22948 into a directory where TeX can see it.) The first argument is the amount
22949 of indentation; in this case the negative sign moves it into the margin.
22950 The second argument is the height of the letter in number of lines of text.
22951 The third argument is the font name: virtually anything which has a tfm
22952 file should work (wade through the
22954 .../texmf/fonts/tfm
22956 directory for possibilities).
22957 My personal favorite is
22958 \begin_inset Quotes eld
22966 \begin_inset Quotes erd
22969 , a fancy German font specifically designed for dropped capitals.
22970 The fourth argument is the letter (or letters) to be dropped.
22975 package also offers the
22981 command, as well as a slightly simplified
22990 \begin_layout Section
22991 Non-standard Paragraph Shapes
22994 \begin_layout Standard
23000 \begin_layout Standard
23001 \begin_inset VSpace bigskip
23007 \begin_layout Standard
23011 \begin_layout Plain Layout
23023 \begin_layout Standard
23027 \begin_layout Plain Layout
23036 \begin_layout Plain Layout
23050 \begin_layout Standard
23055 \begin_layout Plain Layout
23066 \begin_layout Plain Layout
23075 \begin_layout Plain Layout
23084 \begin_layout Plain Layout
23093 \begin_layout Plain Layout
23102 \begin_layout Plain Layout
23111 \begin_layout Plain Layout
23120 \begin_layout Plain Layout
23129 \begin_layout Plain Layout
23138 \begin_layout Plain Layout
23147 \begin_layout Plain Layout
23156 \begin_layout Plain Layout
23165 \begin_layout Plain Layout
23174 \begin_layout Plain Layout
23183 \begin_layout Plain Layout
23192 \begin_layout Plain Layout
23201 \begin_layout Plain Layout
23210 \begin_layout Plain Layout
23219 \begin_layout Plain Layout
23228 \begin_layout Plain Layout
23234 There are times when the tyranny of rectangular paragraphs must be overthrown.
23235 In such situations, a call to the delightful plain TeX command
23242 As you can see, completely arbitrary shapes can be laid out with a suitable
23243 set of linelength definitions.
23244 While this parshape may look a bit silly and useless, one could conceive
23245 of situations such as finely tuned dropped capitals, word wrapping around
23246 non-rectangular graphics, etc.
23247 which will benefit from such handcrafting.
23250 \begin_layout Standard
23251 \begin_inset VSpace bigskip
23257 \begin_layout Standard
23262 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23269 is the number of lines of text which define the paragraph.
23270 If there turn out to be fewer lines, the shape is truncated; if there are
23271 more, the excess lines have the same dimensions as the last line of the
23281 entries specify the indentation of the line from the left margin, and the
23282 length of the line as measured from that point.
23283 The shape applies only to the current paragraph; everything is reset to
23284 normal for the next paragraph.
23287 \begin_layout Standard
23291 \begin_layout Plain Layout
23303 \begin_layout Section
23307 \begin_layout Standard
23308 As you can see, the examples in this section range from the useful to the
23310 While I don't expect that anyone will ever need the paragraph shape demonstrate
23311 d in the last section, the important point is that you can do almost anything
23312 you want in LyX if you are willing to figure out how to do it in TeX and
23314 TeX is a fantastically powerful typesetting system and all that power is
23315 available to you since LyX uses it as its backend.