1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \use_default_options false
56 InsetLayout CharStyle:MenuItem
65 \newcommand*{\menuitem}[1]{{\sffamily #1}}
73 \font_typewriter default
74 \font_default_family default
82 \default_output_format default
83 \bibtex_command default
84 \index_command default
88 \pdf_title "LyX's Extended manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's extended documentation"
91 \pdf_keywords "LyX, Documentation, Extended"
93 \pdf_bookmarksnumbered true
94 \pdf_bookmarksopen false
95 \pdf_bookmarksopenlevel 1
100 \pdf_pdfusetitle false
101 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
109 \paperorientation portrait
112 \paragraph_separation indent
114 \quotes_language english
117 \paperpagestyle headings
118 \tracking_changes false
119 \output_changes false
127 Additional LyX Features
135 \begin_layout Plain Layout
137 Principal maintainer of this file is
142 If you have comments or error corrections, please send them to the LyX
143 Documentation mailing list,
144 \begin_inset Flex CharStyle:Code
147 \begin_layout Plain Layout
166 \begin_layout Standard
167 \begin_inset CommandInset toc
168 LatexCommand tableofcontents
175 \begin_layout Chapter
179 \begin_layout Standard
180 This manual is essentially Part II of the
182 User's Guide\SpecialChar \@.
185 The reason for separating this document out is simple: the
189 is already quite lengthy, and it contains information on all of the basic
190 features one needs to know in order to prepare most documents.
191 However, the LyX Team has worked to LyX extensible through various configuratio
192 n files and external packages.
193 That means that if you want to support the
197 package, you can create a layout file (or module) for it without having
199 We've already had contributions of several new features this way.
200 This is the place where all of those get documented.
203 \begin_layout Standard
204 This manual also documents some special features, like fax support, version
205 control, and SGML support, which require additional software to work properly.
206 Lastly, there's a chapter of
208 tools and tips, things you can use to spruce up your documents by directly
209 using the powerful features of
218 and will only ever interface to some, not all,
223 \begin_layout Standard
224 If you haven't read the
228 yet, you are definitely in the wrong manual.
233 is the first place to go, since it describes the notation and format of
235 You should also be thoroughly familiar with the
239 and all of the basic features of LyX before attempting to read this one.
242 \begin_layout Standard
243 Since all the topics in this manual depend heavily on LyX's interaction
246 , this first chapter covers the inner workings of LyX and how to direct
247 LyX to generate exactly the
250 It is obviously for more seasoned LyX users.
253 \begin_layout Chapter
258 \begin_layout Section
263 \begin_layout Standard
264 This chapter is for both TeX-
269 In it, we'll explain how LyX and
271 work together to produce printable output.
272 This is the only place in any of the manuals where we assume you know something
278 \begin_layout Standard
279 At one time, LyX was called a
280 \begin_inset Quotes eld
290 \begin_inset Quotes erd
293 but that's no longer true.
302 \begin_layout Plain Layout
323 These are basically text editors with the ability to run
325 and mark any errors in the file you're editing.
336 , and it also indicates errors in the file, it also does much, much more.
337 For one thing, you don't need to know
339 to use LyX effectively.
340 And LyX has added its own extensions to
343 Try the following sometime: select
344 \begin_inset Flex CharStyle:MenuItem
347 \begin_layout Plain Layout
348 Export\SpecialChar \menuseparator
356 \begin_inset Flex CharStyle:MenuItem
359 \begin_layout Plain Layout
366 \begin_inset Flex CharStyle:MenuItem
369 \begin_layout Plain Layout
370 View\SpecialChar \menuseparator
376 ), then look at the preamble of the resulting
377 \begin_inset Flex CharStyle:Code
380 \begin_layout Plain Layout
388 You'll notice a variety of new macros defined specifically by LyX.
389 These macros are defined automatically, according to the features you use
393 \begin_layout Standard
394 There are several commands that automatically invoke
400 \begin_layout Itemize
401 \begin_inset Flex CharStyle:MenuItem
404 \begin_layout Plain Layout
405 View\SpecialChar \menuseparator
414 \begin_layout Itemize
415 \begin_inset Flex CharStyle:MenuItem
418 \begin_layout Plain Layout
419 View\SpecialChar \menuseparator
420 Update\SpecialChar \menuseparator
429 \begin_layout Itemize
430 \begin_inset Flex CharStyle:MenuItem
433 \begin_layout Plain Layout
434 File\SpecialChar \menuseparator
443 \begin_layout Itemize
444 \begin_inset Flex CharStyle:MenuItem
447 \begin_layout Plain Layout
448 File\SpecialChar \menuseparator
457 \begin_layout Standard
458 They will only invoke
460 if the file has changed since the last time
466 \begin_layout Standard
469 on the file you're editing, it performs these steps:
472 \begin_layout Enumerate
473 Convert the document to
475 and save to a file with the extension
476 \begin_inset Flex CharStyle:Code
479 \begin_layout Plain Layout
487 \begin_inset Flex CharStyle:Code
490 \begin_layout Plain Layout
500 \begin_layout Enumerate
504 \begin_inset Flex CharStyle:Code
507 \begin_layout Plain Layout
514 file (maybe several times), and run any other commands (such as
515 \begin_inset Flex CharStyle:Code
518 \begin_layout Plain Layout
526 \begin_inset Flex CharStyle:Code
529 \begin_layout Plain Layout
536 ) needed to compile the
541 \begin_layout Enumerate
542 If there are any errors, show the error log.
545 \begin_layout Standard
549 \begin_inset Flex CharStyle:MenuItem
552 \begin_layout Plain Layout
555 \SpecialChar \menuseparator
565 viewer to display the
569 \begin_inset Flex CharStyle:MenuItem
572 \begin_layout Plain Layout
575 \SpecialChar \menuseparator
583 , LyX performs further steps:
586 \begin_layout Itemize
588 \begin_inset Flex CharStyle:Code
591 \begin_layout Plain Layout
605 \begin_layout Itemize
609 \begin_inset Flex CharStyle:Code
612 \begin_layout Plain Layout
624 \begin_layout Standard
625 LyX does similar things when viewing, or exporting, other formats.
628 \begin_layout Section
634 \begin_layout Standard
637 file into LyX by using the
638 \begin_inset Flex CharStyle:MenuItem
641 \begin_layout Plain Layout
642 File\SpecialChar \menuseparator
643 Import\SpecialChar \menuseparator
651 This will call a program named
652 \begin_inset Flex CharStyle:Code
655 \begin_layout Plain Layout
662 which will create a file
663 \begin_inset Flex CharStyle:Code
666 \begin_layout Plain Layout
674 \begin_inset Flex CharStyle:Code
677 \begin_layout Plain Layout
685 LyX will then open that file.
689 \begin_layout Plain Layout
690 \begin_inset Flex CharStyle:Code
693 \begin_layout Plain Layout
700 can also be run from the command line, of course.
708 \begin_layout Standard
709 \begin_inset Flex CharStyle:Code
712 \begin_layout Plain Layout
719 will translate most legal
721 , but not everything.
722 It will put things it doesn't understand into TeX code, so after translating
724 \begin_inset Flex CharStyle:Code
727 \begin_layout Plain Layout
734 , you can look for TeX code and hand-edit it until it looks right.
737 \begin_layout Standard
738 If you don't know what TeX code is, read the next section.
741 \begin_layout Section
742 \begin_inset CommandInset label
744 name "sec:Inserting-TeX-Code"
748 Inserting TeX Code into LyX Documents
751 \begin_layout Standard
752 Anything you can do in
754 you can do in LyX, for a very simple reason: You can always insert TeX
755 code into any LyX document.
756 LyX cannot, and will never be able to, display every possible
759 If ever you need to insert
761 commands into your LyX document, you can use the
762 \begin_inset Flex CharStyle:Code
765 \begin_layout Plain Layout
771 box, which you can insert into your document with
772 \begin_inset Flex CharStyle:MenuItem
775 \begin_layout Plain Layout
776 Insert\SpecialChar \menuseparator
785 \begin_layout Standard
786 Here's an example of inserting
788 commands in a LyX document.
789 The code looks like this:
792 \begin_layout LyX-Code
796 \begin_inset Newline newline
806 \begin_inset Newline newline
809 This is an example for a
813 \begin_inset Newline newline
816 can put nearly everything in it, even (non-floating)
817 \begin_inset Newline newline
822 \begin_inset Newline newline
830 \begin_inset Newline newline
834 \begin_inset Newline newline
844 \begin_inset Newline newline
850 \begin_inset Newline newline
860 \begin_inset Newline newline
865 \begin_inset Newline newline
873 \begin_inset Newline newline
879 \begin_inset Newline newline
887 \begin_inset Newline newline
895 \begin_layout LyX-Code
899 \begin_layout Standard
901 \begin_inset Flex CharStyle:Code
904 \begin_layout Plain Layout
910 box containing this text is directly after this paragraph.
911 Those of you reading the manual in LyX will only see the TeX code inset.
912 Those reading a printed version of the manuals will see the actual results:
915 \begin_layout Standard
919 \begin_layout Plain Layout
926 \begin_layout Plain Layout
933 \begin_layout Plain Layout
935 This is an example for a minipage environment.
936 You can put nearly everything in it, even (non-floating) figures and tables.
940 \begin_layout Plain Layout
947 \begin_layout Plain Layout
952 \begin_layout Plain Layout
959 \begin_layout Plain Layout
966 \begin_layout Plain Layout
973 \begin_layout Plain Layout
979 \begin_layout Plain Layout
986 \begin_layout Plain Layout
993 \begin_layout Plain Layout
1000 \begin_layout Plain Layout
1012 \begin_layout Standard
1013 In addition to using TeX code, you can also create a separate file containing
1016 structure and then use
1017 \begin_inset Flex CharStyle:MenuItem
1020 \begin_layout Plain Layout
1021 Insert\SpecialChar \menuseparator
1023 \begin_inset space ~
1031 to include your file (you should select the type
1032 \begin_inset Flex CharStyle:Code
1035 \begin_layout Plain Layout
1042 We recommend that you only do this if you have a
1043 \begin_inset Flex CharStyle:Code
1046 \begin_layout Plain Layout
1058 Otherwise, you'll have a big job tracking down
1063 \begin_layout Standard
1064 There are a few last points to emphasize:
1067 \begin_layout Itemize
1077 \begin_layout Itemize
1078 Beware reinventing the wheel.
1081 \begin_layout Standard
1082 On that last point, LyX does have quite a few features tucked into it, and
1084 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
1085 feature before you decide you have to do it by hand.
1086 Moreover, there are numerous
1088 packages out there to do all sorts of things, from labels to envelopes
1093 \begin_inset CommandInset href
1096 target "http://www.ctan.org/"
1100 for details, and see chapter
1101 \begin_inset CommandInset ref
1103 reference "cha:secrets"
1110 \begin_layout Standard
1111 If you do need to do some wild and fancy things within your document, be
1112 sure to check out a good
1114 book for assistance.
1115 There are a number of them listed in the bibliography of the
1122 \begin_layout Section
1128 \begin_layout Subsection
1134 \begin_layout Standard
1137 , there is no need to explain here what the preamble is good for.
1138 If you don't, the following will give you some ideas—we recommend again
1141 book for further information.
1142 In any case, you should read the points below, because they explain what
1143 you can do and what you don't need to do in the
1145 preamble of a LyX document.
1148 \begin_layout Standard
1151 preamble comes at the very beginning of a document,
1159 \begin_layout Itemize
1160 Declare the document class.
1162 \begin_inset Newline newline
1165 LyX already does this for you.
1166 If you're a seasoned
1170 , and you have a custom document class you want to use, check out the
1172 Customization Manual
1174 for information on how to make LyX interface to it.
1177 \begin_layout Itemize
1178 Declare the usage of packages.
1180 \begin_inset Newline newline
1185 packages provide special commands, which are only available within a document
1186 when the package has been declared in the preamble.
1187 For example, the package
1188 \begin_inset Flex CharStyle:Code
1191 \begin_layout Plain Layout
1198 forces all paragraphs to be indented.
1199 There are other packages for labels, envelopes, margins, etc.
1203 \begin_layout Itemize
1204 Set counters, variables, lengths and widths.
1206 \begin_inset Newline newline
1211 counters and variables which
1215 be set globally from within the preamble in order to have the desired effect.
1216 (There are variables which you can set and reset inside the document, too.)
1217 Margins are a good example of something which must be set in the preamble.
1218 Another example is the label format for lists.
1219 You can actually set these just about anywhere, but it's best to do it
1220 just once, inside the preamble.
1223 \begin_layout Itemize
1224 Declare user defined commands (with
1225 \begin_inset Flex CharStyle:Code
1228 \begin_layout Plain Layout
1238 \begin_inset Flex CharStyle:Code
1241 \begin_layout Plain Layout
1251 \begin_inset Newline newline
1254 These are abbreviations for
1256 commands which appear very often inside a document.
1257 Although the preamble is a good place to declare such commands, they
1261 be declared anywhere (before they are used for the first time, of course).
1262 This can be useful if there is a lot of raw
1264 code in your document, which normally should not be the case.
1267 \begin_layout Standard
1268 LyX adds its own set of definitions to the preamble of the
1269 \begin_inset Flex CharStyle:Code
1272 \begin_layout Plain Layout
1282 files generated by LyX portable.
1285 \begin_layout Subsection
1286 Changing the Preamble
1289 \begin_layout Standard
1290 The commands which LyX adds to the preamble of a
1292 file are fixed; you can't change them without patching LyX itself.
1293 You can, however, add your own stuff to the preamble by selecting
1294 \begin_inset Flex CharStyle:MenuItem
1297 \begin_layout Plain Layout
1301 \begin_inset space ~
1310 \begin_inset Flex CharStyle:MenuItem
1313 \begin_layout Plain Layout
1314 Document\SpecialChar \menuseparator
1321 LyX adds anything in the
1322 \begin_inset Flex CharStyle:MenuItem
1325 \begin_layout Plain Layout
1331 dialog to its own built-in preamble.
1332 Before adding your own declarations in the preamble, you should make sure
1333 that LyX doesn't already support what you want to do.
1334 (Remember what we said about reinventing the wheel?) Also,
1336 make sure your preamble code is correct
1339 LyX doesn't check it for you.
1340 If there is an error, you're likely to get an error like
1341 \begin_inset Quotes eld
1345 \begin_inset Flex CharStyle:Code
1348 \begin_layout Plain Layout
1357 \begin_inset Quotes erd
1361 If you see this error, check your preamble.
1364 \begin_layout Subsection
1368 \begin_layout Standard
1369 Here are some examples of what you can add to a preamble, and what they
1373 \begin_layout Subsubsection
1377 \begin_layout Standard
1378 There are two variables under
1380 that control page position:
1381 \begin_inset Flex CharStyle:Code
1384 \begin_layout Plain Layout
1394 \begin_inset Flex CharStyle:Code
1397 \begin_layout Plain Layout
1407 Their names should be self-explanatory.
1408 These variables are useful if you think for a moment about computer labels.
1409 Sometimes, the size of a print medium and the area of the medium that you
1410 can actually print on aren't the same.
1412 \begin_inset Flex CharStyle:Code
1415 \begin_layout Plain Layout
1425 \begin_inset Flex CharStyle:Code
1428 \begin_layout Plain Layout
1440 \begin_layout Standard
1441 The default values for
1442 \begin_inset Flex CharStyle:Code
1445 \begin_layout Plain Layout
1455 \begin_inset Flex CharStyle:Code
1458 \begin_layout Plain Layout
1468 \begin_inset space \thinspace{}
1472 \begin_inset space \thinspace{}
1476 \begin_inset space \space{}
1479 the page isn't shifted.
1482 drivers always seem to shift the page.
1483 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1484 If you're using LyX on a system that you don't personally maintain, and
1488 \begin_inset Flex CharStyle:Code
1491 \begin_layout Plain Layout
1501 \begin_inset Flex CharStyle:Code
1504 \begin_layout Plain Layout
1514 Suppose you're left and top margins are always 0.5
1515 \begin_inset space \thinspace{}
1519 You can add this to the preamble:
1522 \begin_layout LyX-Code
1534 \begin_layout LyX-Code
1546 \begin_layout Standard
1547 and your margins should now be correct.
1550 \begin_layout Subsubsection
1554 \begin_layout Standard
1555 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1556 There's a rather nice package, available at your nearest
1558 archive, for printing sheets of labels:
1559 \begin_inset Flex CharStyle:Code
1562 \begin_layout Plain Layout
1569 Now, your system may not have this package installed by default.
1570 We leave that up to you to check.
1571 You'll also want to read the documentation for it; we're not going to do
1573 Since this is an example, however, we'll give you an example of how you
1577 \begin_layout Standard
1578 First, make sure you're using the
1579 \begin_inset Flex CharStyle:Code
1582 \begin_layout Plain Layout
1589 Next, you need to put the following in your preamble:
1592 \begin_layout LyX-Code
1600 \begin_layout LyX-Code
1608 \begin_layout LyX-Code
1616 \begin_layout LyX-Code
1625 \begin_layout LyX-Code
1634 \begin_layout LyX-Code
1643 \begin_layout LyX-Code
1652 \begin_layout Standard
1653 This sets things up for Avery label sheets, stock #
1656 You're now ready to print labels, but you'll need to insert
1658 code, placing the commands
1659 \begin_inset Flex CharStyle:Code
1662 \begin_layout Plain Layout
1671 \begin_inset Flex CharStyle:Code
1674 \begin_layout Plain Layout
1682 around each label text.
1683 This and other special features of
1684 \begin_inset Flex CharStyle:Code
1687 \begin_layout Plain Layout
1693 are explained in its documentation.
1696 \begin_layout Standard
1697 Someday, someone may write a LyX layout file to support this package directly.
1698 Maybe that someone is you.
1701 \begin_layout Subsubsection
1702 Example #3: Paragraph Indentation
1705 \begin_layout Standard
1706 Americans are trained to indent the first line of
1711 As with all of their other weird quirks, most Americans will whine and
1712 moan until they can have their way and indent the first line of all paragraphs.
1721 \begin_layout Standard
1722 Of course, this behavior isn't standard typography.
1723 In books, you typically only indent the first line of a paragraph
1727 it follows another one.
1728 The idea behind indenting the first line of a paragraph is to distinguish
1729 neighboring paragraphs from one another.
1730 If there is no previous paragraph—for example, if it follows a figure or
1731 is the first paragraph in a section—then there is no need for indentation.
1735 \begin_layout Standard
1736 If you're a typical American (we're still joking!), though, you don't care
1737 about such esoteric things; you want your indentation! Add this to the
1741 \begin_layout LyX-Code
1751 \begin_layout Standard
1752 If your TeX distribution isn't
1754 , you'll have this package, and all of your paragraphs will get the indentation
1755 the Founding Fathers intended they should have.
1758 \begin_layout Subsubsection
1759 Example #4: This Document
1762 \begin_layout Standard
1763 You can also check out the preamble of this document to get an idea of some
1764 of the advanced things you can do.
1765 Also, there are more examples and an assortment of
1768 \begin_inset Quotes eld
1772 \begin_inset Quotes erd
1776 \begin_inset space ~
1780 \begin_inset CommandInset ref
1782 reference "cha:secrets"
1790 \begin_layout Section
1796 \begin_layout Standard
1801 to blithely ignore any errors and keep going.
1811 ,LyX displays a dialog listing the errors.
1812 Clicking on any one of them will take you to the position in your LyX file
1813 where the error occurred.
1817 \begin_layout Plain Layout
1821 is a tough job, and LyX doesn't always go to the right line.
1822 There are also cases where
1824 reports the error on one line, but the actual error is earlier.
1825 This is not unlike forgetting a closing brace in a program: You'll get
1826 an error, but only later.
1834 \begin_layout Standard
1835 Some folks also like to look at the log file directly: It is available from
1837 \begin_inset Flex CharStyle:MenuItem
1840 \begin_layout Plain Layout
1843 \SpecialChar \menuseparator
1847 \begin_inset space ~
1856 There are some fairly common error messages and warnings.
1857 We'll cover those here.
1858 You should look at a good
1860 book for a complete listing.
1863 \begin_layout Itemize
1864 \begin_inset Flex CharStyle:Code
1867 \begin_layout Plain Layout
1876 \begin_inset Newline newline
1879 Anything beginning with these words is a warning message for the purpose
1881 \begin_inset Quotes eld
1885 \begin_inset Quotes erd
1891 You'll get messages like this if you added or changed cross-references
1892 or bibliography entries, in which case,
1894 is trying to tell you that you need to make another run.
1895 You can by-and-large ignore these.
1898 \begin_layout Itemize
1899 \begin_inset Flex CharStyle:Code
1902 \begin_layout Plain Layout
1911 \begin_inset Newline newline
1914 Another warning message, this time about fonts which
1917 The rest of the message will often say something about a replacement font
1921 You can safely ignore these, too.
1924 \begin_layout Itemize
1925 \begin_inset Flex CharStyle:Code
1928 \begin_layout Plain Layout
1938 \begin_inset Newline newline
1948 They are warnings about lines that were too long and run past the right
1950 Almost always, this is unnoticeable in the final output.
1951 (It can be just a point or two.) Or, only one or two characters extend past
1955 seems to generate at least one of these messages for just about any document
1957 \begin_inset Newline newline
1960 You can ignore these messages.
1961 Your eyes will tell you if there's a problem with something that's too
1962 wide; just look at the output.
1966 \begin_layout Plain Layout
1967 You can also enable the `
1970 \begin_inset Flex CharStyle:MenuItem
1973 \begin_layout Plain Layout
1976 \SpecialChar \menuseparator
1986 will draw a black box in the margin of lines that are overfull.
1994 \begin_layout Itemize
1995 \begin_inset Flex CharStyle:Code
1998 \begin_layout Plain Layout
2010 \begin_inset Newline newline
2013 Not quite as common as its cousin.
2016 seems to like to print lines that are a bit too wide as opposed to ones
2017 that are a bit too narrow.
2018 We have no idea why.
2021 \begin_layout Itemize
2022 \begin_inset Flex CharStyle:Code
2025 \begin_layout Plain Layout
2035 \begin_inset Flex CharStyle:Code
2038 \begin_layout Plain Layout
2050 \begin_inset Newline newline
2053 Warnings about troubles breaking the page.
2054 Once again, just look at the output.
2055 Your eyes will tell you where something has gone wrong.
2058 \begin_layout Itemize
2059 \begin_inset Flex CharStyle:Code
2062 \begin_layout Plain Layout
2066 \begin_inset Quotes els
2072 \begin_inset Quotes ers
2081 \begin_inset Newline newline
2085 \begin_inset Quotes eld
2091 \begin_inset Quotes erd
2094 isn't installed on this system.
2095 This usually appears because some package your document needs isn't installed.
2096 If you didn't touch the preamble or didn't use the
2097 \begin_inset Flex CharStyle:Code
2100 \begin_layout Plain Layout
2110 command, then one of the packages LyX tried to load is missing.
2112 \begin_inset Flex CharStyle:MenuItem
2115 \begin_layout Plain Layout
2116 Help\SpecialChar \menuseparator
2124 to get a list of packages that LyX knows about.
2125 This file is updated whenever you reconfigure LyX (using
2126 \begin_inset Flex CharStyle:MenuItem
2129 \begin_layout Plain Layout
2130 Tools\SpecialChar \menuseparator
2136 ) and tells you which packages have been detected and what they do.
2137 \begin_inset Newline newline
2141 \begin_inset Flex CharStyle:Code
2144 \begin_layout Plain Layout
2154 command and the package in question isn't installed, then you'll need to
2155 install it yourself.
2158 \begin_layout Itemize
2159 \begin_inset Flex CharStyle:Code
2162 \begin_layout Plain Layout
2165 Error: Unknown option
2171 \begin_inset Newline newline
2174 Error messages beginning with this are trying to tell you that you specified
2175 a bad or undefined option to a package.
2176 Check the package's documentation.
2179 \begin_layout Itemize
2180 \begin_inset Flex CharStyle:Code
2183 \begin_layout Plain Layout
2184 Undefined control sequence
2190 \begin_inset Newline newline
2195 code into your document, but made a typo, you'll get one of these.
2196 You may have forgotten to load a package.
2197 In any case, this error message usually means that you used an undefined
2202 \begin_layout Standard
2203 There are other error and warning messages.
2204 Some are self-explanatory.
2208 Others are downright cryptic.
2209 These are usually TeX error messages, and we really have
2213 what they mean or how to decipher them.
2217 \begin_layout Standard
2218 There's a general sequence you should follow if you get error messages:
2221 \begin_layout Enumerate
2224 code you inserted for typos.
2227 \begin_layout Enumerate
2228 If there are no typos, check that you used the command(s) correctly.
2231 \begin_layout Enumerate
2232 If you get a bunch of error boxes piled up at the very top of the document—and
2233 especially if you see a
2234 \begin_inset Quotes eld
2238 \begin_inset Flex CharStyle:Code
2241 \begin_layout Plain Layout
2250 \begin_inset Quotes erd
2253 error—it means that there are errors in the preamble.
2254 Start debugging your preamble.
2257 \begin_layout Enumerate
2258 If you didn't add anything to the preamble and didn't add any
2260 code to the document, the first suspect is your
2262 distribution itself.
2263 Check for missing packages and install them.
2266 \begin_layout Enumerate
2267 Okay, so there are no missing packages.
2268 Did you use any of the fine-tuning options in LyX? Specifically, did you
2273 any of them, like trying to manually insert lots of
2274 \begin_inset Flex CharStyle:Code
2277 \begin_layout Plain Layout
2279 \begin_inset space ~
2288 \begin_inset Flex CharStyle:Code
2291 \begin_layout Plain Layout
2299 \begin_inset Flex CharStyle:Code
2302 \begin_layout Plain Layout
2309 ? Did you try to kludge something together with these instead of using the
2310 appropriate paragraph environment?
2313 \begin_layout Enumerate
2314 All right, you didn't use any of the fine-tuning options, you played by
2316 Did you try to pull a fancy maneuver? Did you do something funky inside
2317 a table or an equation, like inserting a graphic into a table cell?
2320 \begin_layout Enumerate
2321 Do you have long sections of text where
2323 cannot find a place to break a line? By default,
2325 is rather strict about how much extra inter-word spacing it will add in
2326 order to break a line.
2327 Preferably, you should rework the paragraph to avoid the problem.
2328 If this isn't an option, you can wrap your text in
2329 \begin_inset Flex CharStyle:Code
2332 \begin_layout Plain Layout
2343 line breaking more, well, sloppy.
2346 \begin_layout Enumerate
2347 Did you go overboard with the nesting? LyX (currently) doesn't check to
2348 make sure you're in the limits for nesting environments.
2349 If you nested a bunch of environments to the
2350 \begin_inset Formula $17^{\mathrm{th}}$
2353 level, that's the problem.
2359 \begin_layout Enumerate
2360 Okay, you didn't get any error messages, but your output looks awful.
2361 If you have a table or figure that's too wide or long for the page, you
2366 \begin_layout Enumerate
2367 rescale the figure so it fits.
2370 \begin_layout Enumerate
2371 trim down the table so it fits.
2375 \begin_layout Enumerate
2376 If something else is wrong with the output, and you didn't try to pull anything
2377 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2380 \begin_layout Standard
2381 If all this doesn't help—well, then
2385 you might have found a bug in LyX\SpecialChar \ldots{}
2389 \begin_layout Chapter
2393 \begin_layout Section
2394 Customizing Bibliographies with
2398 \begin_layout Standard
2399 The basics how to use
2401 are explained in section
2403 Bibliography databases (
2412 The following subsections explain special bibliography features supported
2416 \begin_layout Subsection
2417 Alternative Citation Styles
2420 \begin_layout Standard
2424 \begin_inset space \thinspace{}
2428 \begin_inset space \space{}
2432 \begin_inset Quotes eld
2438 \begin_inset Quotes erd
2441 ) to refer to a cited work.
2442 However, in many scientific disciplines, other citation styles are in use.
2443 The most common one is the author-year style (e.
2444 \begin_inset space \thinspace{}
2448 \begin_inset space \space{}
2452 \begin_inset Quotes eld
2458 \begin_inset Quotes erd
2462 LyX supports two packages that provide this style,
2463 \begin_inset Flex CharStyle:Code
2466 \begin_layout Plain Layout
2474 \begin_inset Flex CharStyle:Code
2477 \begin_layout Plain Layout
2485 Both packages have their pros and cons, which cannot be listed in detail.
2486 If you only want to have simple author-year (or author-numerical) style,
2487 or if you want to use one of the countless style files for
2488 \begin_inset Flex CharStyle:Code
2491 \begin_layout Plain Layout
2498 , than the established
2499 \begin_inset Flex CharStyle:Code
2502 \begin_layout Plain Layout
2509 package is probably your choice.
2510 If you need special features like short title references, ibidem etc., you
2512 \begin_inset Flex CharStyle:Code
2515 \begin_layout Plain Layout
2525 \begin_layout Standard
2526 The handling of both packages in LyX is basically the same.
2528 \begin_inset Flex CharStyle:MenuItem
2531 \begin_layout Plain Layout
2532 Document\SpecialChar \menuseparator
2539 \begin_inset Flex CharStyle:MenuItem
2542 \begin_layout Plain Layout
2549 \begin_inset Flex CharStyle:MenuItem
2552 \begin_layout Plain Layout
2560 \begin_inset Flex CharStyle:MenuItem
2563 \begin_layout Plain Layout
2571 With both packages, you will get some extra features in the citation dialog
2572 and you can select the style of the reference (
2573 \begin_inset Quotes eld
2579 \begin_inset Quotes erd
2583 \begin_inset Quotes eld
2589 \begin_inset Quotes erd
2593 \begin_inset Quotes eld
2599 \begin_inset Quotes erd
2603 \begin_inset Quotes eld
2609 \begin_inset Quotes erd
2613 Note that both packages need specifically designed style files.
2614 They both ship their own, but there are lots of additional style files,
2615 and there is even an interactive style file builder
2619 \begin_layout Plain Layout
2621 \begin_inset Flex URL
2624 \begin_layout Plain Layout
2626 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2637 \begin_inset Flex CharStyle:Code
2640 \begin_layout Plain Layout
2650 \begin_layout Subsection
2651 Sectioned Bibliographies
2654 \begin_layout Standard
2655 Sometimes you might need to divide your bibliography into several sections.
2656 If you are for instance a historian, the possibility to separate sources
2657 and scientific works is most likely a
2658 \begin_inset Quotes eld
2662 \begin_inset Quotes erd
2668 itself does not allow you to do this.
2669 But with the help of some
2673 can be extended to fit your needs.
2676 \begin_layout Standard
2677 LyX provides native support for one of these packages,
2685 \begin_layout Plain Layout
2687 \begin_inset Flex URL
2690 \begin_layout Plain Layout
2692 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2702 The advantage of this package (compared to other packages like
2706 ) is that you don't need to define new citation commands.
2707 Instead, you need to prepare different bibliographic databases which include
2708 the entries for the different sections of the bibliography.
2709 For example: If you want to divide your bibliography into the sections
2711 \begin_inset Quotes eld
2715 \begin_inset Quotes erd
2719 \begin_inset Quotes eld
2723 \begin_inset Quotes erd
2726 , you first need to create two bibliographic databases, e.
2727 \begin_inset space \thinspace{}
2731 \begin_inset space \space{}
2735 \begin_inset Flex CharStyle:Code
2738 \begin_layout Plain Layout
2745 \begin_inset Flex CharStyle:Code
2748 \begin_layout Plain Layout
2758 \begin_layout Standard
2760 \begin_inset Flex CharStyle:MenuItem
2763 \begin_layout Plain Layout
2764 Document\SpecialChar \menuseparator
2771 \begin_inset Flex CharStyle:MenuItem
2774 \begin_layout Plain Layout
2781 \begin_inset Flex CharStyle:MenuItem
2784 \begin_layout Plain Layout
2785 Sectioned bibliography
2791 Now you can insert multiple
2793 bibliographies, one for each section of your bibliography.
2794 Returning to our example: Insert the
2797 \begin_inset Flex CharStyle:Code
2800 \begin_layout Plain Layout
2806 and a second one for the database
2807 \begin_inset Flex CharStyle:Code
2810 \begin_layout Plain Layout
2817 You are free to use the same or different styles for each section.
2818 Additionally, you can chose if the bibliography section should contain
2820 \begin_inset Quotes eld
2823 all cited references
2824 \begin_inset Quotes erd
2827 of the specified database(s) (which is the default),
2828 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2846 This might be useful if you would like to separate your bibliography into
2848 \begin_inset Quotes eld
2852 \begin_inset Quotes erd
2856 \begin_inset Quotes eld
2862 \begin_inset Quotes erd
2866 \begin_inset Quotes eld
2870 \begin_inset Quotes erd
2874 The titles for the sections can be added as ordinary sections or subsections.
2876 \begin_inset Flex CharStyle:Code
2879 \begin_layout Plain Layout
2886 removes the bibliography title, you have manually re-add that, too (as
2887 a chapter* or section*, for instance).
2890 \begin_layout Subsection
2891 Multiple Bibliographies
2894 \begin_layout Standard
2895 Multiple bibliographies, e.
2896 \begin_inset space \thinspace{}
2900 \begin_inset space \space{}
2903 a bibliography for each section or chapter of the document, are not supported
2908 \begin_inset Flex CharStyle:Code
2911 \begin_layout Plain Layout
2918 package, which is used for the creation of sectioned bibliographies in
2919 LyX (see the previous section), provides an easy way to solve this task,
2920 if you are willing to use some
2921 \begin_inset Flex CharStyle:MenuItem
2924 \begin_layout Plain Layout
2931 \begin_inset space ~
2935 \begin_inset CommandInset ref
2937 reference "sec:Inserting-TeX-Code"
2945 \begin_layout Plain Layout
2946 An alternative approach is to use the
2947 \begin_inset Flex CharStyle:Code
2950 \begin_layout Plain Layout
2958 \begin_inset Flex CharStyle:Code
2961 \begin_layout Plain Layout
2968 package, respectively.
2976 \begin_layout Standard
2978 \begin_inset Flex CharStyle:MenuItem
2981 \begin_layout Plain Layout
2982 Document\SpecialChar \menuseparator
2989 \begin_inset Flex CharStyle:MenuItem
2992 \begin_layout Plain Layout
2999 \begin_inset Flex CharStyle:MenuItem
3002 \begin_layout Plain Layout
3003 Sectioned bibliography
3009 In the document, you have to enclose the sections, which shall contain
3010 their own bibliography (including the
3012 bibliography itself), between
3013 \begin_inset Flex CharStyle:Code
3016 \begin_layout Plain Layout
3027 \begin_inset Flex CharStyle:Code
3030 \begin_layout Plain Layout
3040 (those commands have to be inserted as TeX code).
3041 The bibliography will contain all references which have been cited in the
3043 \begin_inset Flex CharStyle:Code
3046 \begin_layout Plain Layout
3058 If you are using this approach, then every citation reference has to be
3060 \begin_inset Flex CharStyle:Code
3063 \begin_layout Plain Layout
3072 \begin_inset Flex CharStyle:Code
3075 \begin_layout Plain Layout
3085 \begin_layout Section
3091 \begin_layout Subsection
3095 \begin_layout Standard
3096 When you are working on a large file with many sections, it is often convenient
3097 to break up the document into several files, or perhaps you have something
3098 where a table may change from time to time, but the preceding text does
3100 In these cases, you should seriously consider using
3103 For example, scientific papers often have five major sections: the introduction
3104 , observations, results, discussion, and conclusion.
3105 Each of these could be its own separate LyX file, with one
3106 \begin_inset Quotes eld
3110 \begin_inset Quotes erd
3113 file which contains the title, authors, abstract, references, etc., plus
3114 the five included files.
3115 It is important to note that each of these files is a full LyX file which
3116 can be formatted and printed on its own, as well as included in a master
3118 Each of these files must have the same document class, however—don't attempt
3119 to mix book classes with article classes.
3120 You may also include
3122 files; however, these files must not have their own preamble (i.
3123 \begin_inset space \thinspace{}
3127 \begin_inset space \space{}
3130 everything up to and including the
3131 \begin_inset Flex CharStyle:Code
3134 \begin_layout Plain Layout
3143 \begin_inset Flex CharStyle:Code
3146 \begin_layout Plain Layout
3154 line must be deleted) or else errors will be generated when you try to
3160 \begin_layout Standard
3161 LyX allows you to include files quite easily with
3162 \begin_inset Flex CharStyle:MenuItem
3165 \begin_layout Plain Layout
3166 Insert\SpecialChar \menuseparator
3170 \begin_inset space ~
3179 When you click on this selection a small box is inserted into the file
3180 at the current cursor location.
3181 Clicking on the box raises a dialog which allows you to select the file
3182 to be included, and the method of its inclusion.
3186 \begin_layout Standard
3187 The file selection box should by now be obvious.
3188 The three inclusion methods are
3189 \begin_inset Quotes eld
3193 \begin_inset Quotes erd
3197 \begin_inset Quotes eld
3201 \begin_inset Quotes erd
3205 \begin_inset Quotes eld
3209 \begin_inset Quotes erd
3213 The difference between
3214 \begin_inset Quotes eld
3218 \begin_inset Quotes erd
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3229 is really only meaningful to
3231 , but the practical difference is that files which are
3232 \begin_inset Quotes eld
3236 \begin_inset Quotes erd
3239 are typeset beginning on a new page, while files which are
3240 \begin_inset Quotes eld
3244 \begin_inset Quotes erd
3247 are typeset starting on the current page.
3250 \begin_layout Standard
3251 Generally, the master file is converted into a full
3253 file before typesetting, while the included files are converted to
3255 files which do not have all the preamble information.
3258 \begin_layout Standard
3260 \begin_inset Quotes eld
3264 \begin_inset Quotes erd
3267 included file allows you to include a file typeset exactly as it appears
3269 \begin_inset space \thinspace{}
3273 \begin_inset space \space{}
3277 \begin_inset Flex CharStyle:Code
3280 \begin_layout Plain Layout
3286 mode, with the characters set in a fixed-width typewriter font.
3287 Normally, spaces in this file are invisible, though two consecutive spaces
3288 are conserved, unlike LyX's normal treatment of spaces.
3289 However, setting the
3290 \begin_inset Flex CharStyle:MenuItem
3293 \begin_layout Plain Layout
3295 \begin_inset space ~
3299 \begin_inset space ~
3303 \begin_inset space ~
3313 typesets a mark to unambiguously define the presence of a space.
3317 \begin_layout Subsection
3318 Cross-References Between Files
3321 \begin_layout Standard
3322 \begin_inset Box Shadowbox
3331 height_special "totalheight"
3334 \begin_layout Plain Layout
3335 This section is somewhat out of date.
3336 Need to describe default master documents and how children are opened when
3348 \begin_layout Standard
3349 It is possible to set up cross-references between the different files.
3350 First, open all the files in question: let's call them A and B in a two
3351 file example, where B is included in A.
3352 Let's say you insert a label in A, then want to reference it in B.
3353 Open the cross-reference dialog in whilst in document B, and you can select
3355 \begin_inset Quotes eld
3359 \begin_inset Quotes erd
3365 \begin_layout Subsection
3366 Bibliography Lists in all
3370 \begin_layout Standard
3371 \begin_inset Box Frameless
3380 height_special "totalheight"
3383 \begin_layout Plain Layout
3384 This section also needs updating.
3385 There is now material about this on the
3387 , and it could be copied here.
3395 \begin_layout Standard
3396 Copy the bibliography list with all entries to all
3398 and transform them to a comment.
3399 This way LyX will find the
3400 \begin_inset Flex CharStyle:Code
3403 \begin_layout Plain Layout
3409 -files and you can easily insert references without making the bibliography
3413 \begin_layout Standard
3414 As the bibliography list is in a comment,
3416 won't use use it and the references will look like this: [?], instead of
3418 One solution is to use the
3421 \begin_inset Flex CharStyle:Code
3424 \begin_layout Plain Layout
3430 that will only include comments by processing the files separately.
3431 To do this, add in the
3438 \begin_layout LyX-Code
3446 \begin_layout LyX-Code
3454 \begin_layout Standard
3456 \begin_inset Flex URL
3459 \begin_layout Plain Layout
3461 http://wiki.lyx.org/FAQ/Unsorted#toc31
3469 \begin_layout Section
3470 Fancy Headers and Footers
3473 \begin_layout Standard
3474 The default page layout is rather plain; for an
3475 \begin_inset Flex CharStyle:Code
3478 \begin_layout Plain Layout
3484 document class, all you get is a centered page number at the bottom of
3488 -script's book class, so it appears to be a bit fancier.
3489 But to really put on a show, you need to set the document page style to
3491 \begin_inset Quotes eld
3495 \begin_inset Quotes erd
3498 , as mentioned in the
3503 This section describes the
3505 code you need to insert in your
3507 preamble in order to get the desired effects.
3510 \begin_layout Standard
3511 For more information on fancy headers, see the
3512 \begin_inset Flex CharStyle:Code
3515 \begin_layout Plain Layout
3522 package documentation.
3523 This can be found in the file
3524 \begin_inset Flex CharStyle:Code
3527 \begin_layout Plain Layout
3536 , which should have been installed with your
3539 \begin_inset CommandInset href
3542 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3549 \begin_layout Standard
3550 The page header is divided into three fields, not surprisingly labeled
3551 \begin_inset Quotes eld
3555 \begin_inset Quotes erd
3559 \begin_inset Quotes eld
3563 \begin_inset Quotes erd
3567 \begin_inset Quotes eld
3571 \begin_inset Quotes erd
3575 The footer is also divided into these three fields.
3578 commands to set these fields in the simplest manner are
3579 \begin_inset Flex CharStyle:Code
3582 \begin_layout Plain Layout
3592 \begin_inset Flex CharStyle:Code
3595 \begin_layout Plain Layout
3605 \begin_inset Flex CharStyle:Code
3608 \begin_layout Plain Layout
3618 \begin_inset Flex CharStyle:Code
3621 \begin_layout Plain Layout
3631 Suppose you wish to put your name in the upper left hand corner of each
3633 Simply insert the following command in the preamble:
3636 \begin_layout Standard
3649 \begin_layout Standard
3650 You will now see your name in the upper left.
3651 If a field has a default entry that you would like to get rid of (often
3652 the page number appears in the central footer, simply include a command
3653 with a blank argument, e.
3654 \begin_inset space \thinspace{}
3660 \begin_layout Standard
3670 \begin_layout Standard
3671 Let's get really fancy: lets put the section number with the word
3672 \begin_inset Quotes eld
3676 \begin_inset Quotes erd
3680 \begin_inset space \thinspace{}
3684 \begin_inset space \space{}
3687 Section 3) in the upper left, the page number (e.
3688 \begin_inset space \thinspace{}
3692 \begin_inset space \space{}
3695 Page 4) in the upper right, your name in the lower left, and the date in
3697 The following commands should now appear in the preamble:
3700 \begin_layout Standard
3714 \begin_layout Standard
3724 \begin_layout Standard
3738 \begin_layout Standard
3751 \begin_layout Standard
3761 \begin_layout Standard
3773 \begin_layout Standard
3775 \begin_inset Flex CharStyle:Code
3778 \begin_layout Plain Layout
3788 \begin_inset Flex CharStyle:Code
3791 \begin_layout Plain Layout
3802 section and page counters, and so print out the current section and page
3805 \begin_inset Flex CharStyle:Code
3808 \begin_layout Plain Layout
3816 simply prints out today's date.
3819 \begin_layout Standard
3820 The thicknesses of the horizontal rules drawn beneath the header and above
3821 the footer can also be modified.
3822 If you don't want one of the rules, set its thickness to 0.
3823 The header rule has a default thickness of 0.
3825 , the footer rule is
3833 \begin_inset Flex CharStyle:Code
3836 \begin_layout Plain Layout
3853 \begin_inset Flex CharStyle:Code
3856 \begin_layout Plain Layout
3872 to set the thicknesses.
3875 \begin_layout Standard
3876 You can switch the header/footer settings on and off for individual pages
3878 \begin_inset Flex CharStyle:Code
3881 \begin_layout Plain Layout
3892 \begin_inset Flex CharStyle:Code
3895 \begin_layout Plain Layout
3906 \begin_inset Flex CharStyle:Code
3909 \begin_layout Plain Layout
3920 Simply insert them in the text on the page you want changed and mark them
3922 In fact, title pages are marked as plain by default, while following pages
3923 are marked fancy when using the global fancy setting.
3926 \begin_layout Standard
3927 As a final example, it is possible to include an image in the header or
3929 Suppose you want to put a company logo in the upper
3932 You might try something like
3935 \begin_layout Standard
3957 \begin_layout Standard
3959 (you may need to preface this with
3960 \begin_inset Flex CharStyle:Code
3963 \begin_layout Plain Layout
3974 if you don't include graphics elsewhere in your document).
3977 \begin_layout Section
3978 Itemize Bullet Selection
3979 \begin_inset CommandInset label
3988 \begin_layout Standard
3994 \begin_layout Subsection
3998 \begin_layout Standard
4001 bullet shapes that can be accessed from a simple dialog.
4002 Using this dialog you can easily specify what bullet shape to use at each
4003 level of an itemized list.
4004 These settings are document-wide so you won't be able to specify different
4005 sets of bullets for different paragraphs.
4009 \begin_layout Plain Layout
4010 Well, actually you can but you'll have to do it by hand.
4018 \begin_layout Subsection
4022 \begin_layout Standard
4023 Open the dialog by selecting the
4024 \begin_inset Flex CharStyle:MenuItem
4027 \begin_layout Plain Layout
4028 Document\SpecialChar \menuseparator
4034 menu item and then select the
4035 \begin_inset Flex CharStyle:MenuItem
4038 \begin_layout Plain Layout
4047 \begin_layout Standard
4048 The dialog provides you with a table of bullet shapes.
4049 A column of buttons on the left of the table provides access to the six
4050 different panels of bullet shapes.
4051 The row of buttons across the top is used to select which bullet depth
4053 A text entry under the table shows the currently selected bullet shape's
4056 equivalent and this can be edited if desired.
4057 If you do modify the text you will also need to specify any needed packages
4063 \begin_layout Standard
4064 The six panels are divided up by the packages they require.
4065 The following table shows the mappings from button name to
4070 \begin_layout Standard
4072 \begin_inset Tabular
4073 <lyxtabular version="3" rows="7" columns="2">
4074 <features tabularvalignment="middle">
4075 <column alignment="center" valignment="top" width="0pt">
4076 <column alignment="center" valignment="top" width="0pt">
4078 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4081 \begin_layout Plain Layout
4096 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4099 \begin_layout Plain Layout
4116 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4119 \begin_layout Plain Layout
4134 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4137 \begin_layout Plain Layout
4154 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4157 \begin_layout Plain Layout
4172 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4175 \begin_layout Plain Layout
4193 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4196 \begin_layout Plain Layout
4211 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4214 \begin_layout Plain Layout
4232 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4235 \begin_layout Plain Layout
4250 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4253 \begin_layout Plain Layout
4271 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4274 \begin_layout Plain Layout
4289 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4292 \begin_layout Plain Layout
4310 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4313 \begin_layout Plain Layout
4328 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4331 \begin_layout Plain Layout
4355 \begin_layout Standard
4356 LyX doesn't stop you using bullets from packages you don't have.
4357 If you get errors from
4359 when you try to view or print the file, then it is likely you are missing
4364 \begin_layout Plain Layout
4365 LyX doesn't restrict your use since you may be editing locally and exporting
4374 \begin_layout Subsection
4378 \begin_layout Standard
4379 Select which bullet depth you want to change then select the bullet shape
4381 Any changes will not be visible in LyX, but are visible when viewing the
4385 \begin_layout Standard
4386 You can reset a bullet shape to the default simply by clicking your right
4387 mouse button on the appropriate bullet depth button.
4391 \begin_layout Plain Layout
4396 want to have multiple sets of paragraphs with different sets of bullets
4397 in each, then you're going to have to get your hands dirty with TeX code.
4398 The bullet selection dialog can help though because it provides you with
4401 code for a wide range of bullet shapes.
4402 To make your own custom paragraphs you have the following options:
4405 \begin_layout Plain Layout
4409 \begin_layout Plain Layout
4425 \begin_layout Plain Layout
4429 \begin_layout Plain Layout
4451 \begin_layout Itemize
4455 \begin_inset Flex CharStyle:Code
4458 \begin_layout Plain Layout
4468 to specify a new bullet shape for a given depth.
4469 You'll also need to save the current bullet shape so you can restore it
4473 In this itemized list the following
4475 code was used to change the bullet used for the first depth.
4479 \begin_layout LyX-Code
4493 \begin_layout LyX-Code
4514 \begin_layout Itemize
4515 Note that the itemize depth is specified in Roman numerals as part of the
4526 \begin_layout Itemize
4530 \begin_layout Plain Layout
4543 Specify each individual entry by starting each item with the bullet shape
4544 enclosed in square brackets and set as
4545 \begin_inset Flex CharStyle:MenuItem
4548 \begin_layout Plain Layout
4555 For example, this item was started with
4556 \begin_inset Flex CharStyle:Code
4559 \begin_layout Plain Layout
4574 \begin_layout Plain Layout
4578 \begin_layout Plain Layout
4594 \begin_layout Plain Layout
4595 You'll also need to revert the
4597 back to its previous setting for the global bullet shape settings to remain
4599 The way used here was:
4602 \begin_layout LyX-Code
4623 \begin_layout Chapter
4627 \begin_layout Section
4631 \begin_layout Standard
4634 allows other programs to talk to LyX, invoke LyX commands, and retrieve
4635 information about the LyX internal state.
4636 This is only intended for advanced users, but they should find it useful.
4637 It is by writing to the LyX server, for example, that bibliography managers,
4641 \begin_inset Quotes eld
4645 \begin_inset Quotes erd
4651 \begin_layout Standard
4652 Please note that, at present,
4654 the server does not work
4662 \begin_layout Plain Layout
4663 There is no reason it cannot do so.
4664 But none of the developers on Windows have yet implemented this functionality
4670 but it does work with
4675 \begin_layout Section
4676 Starting the LyX Server
4679 \begin_layout Standard
4680 The LyX server works through the use of a pair of named pipes.
4681 These are usually located in
4682 \begin_inset Flex CharStyle:Code
4685 \begin_layout Plain Layout
4693 \begin_inset Quotes eld
4697 \begin_inset Flex CharStyle:Code
4700 \begin_layout Plain Layout
4709 \begin_inset Quotes erd
4713 \begin_inset Quotes eld
4717 \begin_inset Flex CharStyle:Code
4720 \begin_layout Plain Layout
4729 \begin_inset Quotes erd
4733 External programs write into
4734 \begin_inset Flex CharStyle:Code
4737 \begin_layout Plain Layout
4745 and read back data from
4746 \begin_inset Flex CharStyle:Code
4749 \begin_layout Plain Layout
4758 The stem of the pipe names can be defined in the
4759 \begin_inset Flex CharStyle:MenuItem
4762 \begin_layout Plain Layout
4763 Tools\SpecialChar \menuseparator
4770 \begin_inset Flex CharStyle:Code
4773 \begin_layout Plain Layout
4788 configure this manually in order for the server to start.
4791 \begin_layout Standard
4793 \begin_inset Flex CharStyle:Code
4796 \begin_layout Plain Layout
4803 \begin_inset Flex CharStyle:Code
4806 \begin_layout Plain Layout
4812 ' to create the pipes.
4813 If one of the pipes already exists, LyX will assume that another LyX process
4814 is already running and will not start the server.
4815 If for some other reason, an unused
4816 \begin_inset Quotes eld
4820 \begin_inset Quotes erd
4823 pipe is left in existence when LyX closes, then LyX will try to delete
4825 If this fails for some reason, you will need to delete the pipes manually
4826 and then restart LyX.
4829 \begin_layout Standard
4830 To have several LyX processes with servers at the same time, you have to
4831 use different configurations, perhaps by using separate user directories,
4833 \begin_inset Flex CharStyle:Code
4836 \begin_layout Plain Layout
4842 file, for each process.
4845 \begin_layout Standard
4846 If you are developing a client program, you might find it useful to enable
4847 debugging information from the LyX server.
4848 Do this by starting LyX as
4849 \begin_inset Flex CharStyle:Code
4852 \begin_layout Plain Layout
4866 \begin_layout Standard
4867 You can find a complete example client written in C in the source distribution
4869 \begin_inset Flex CharStyle:Code
4872 \begin_layout Plain Layout
4883 \begin_layout Standard
4884 Another useful tool is command-line based client you will find in
4885 \begin_inset Flex CharStyle:Code
4888 \begin_layout Plain Layout
4900 \begin_layout Section
4901 Normal communication
4904 \begin_layout Standard
4905 To issue a LyX call, the client writes a line of ASCII text into the input
4907 This line has the following format:
4926 \begin_layout Description
4929 is a name that the client can choose arbitrarily.
4930 Its only use is that LyX will echo it if it sends an answer—so a client
4931 can dispatch results from different
4936 \begin_layout Description
4937 function is the function you want LyX to perform.
4938 It is the same as the commands you'd use in the
4943 \begin_layout Description
4944 argument is an optional argument which is meaningful only to some functions
4946 \begin_inset Quotes eld
4950 \begin_inset Quotes erd
4955 will insert the argument as text at the cursor position).
4958 \begin_layout Standard
4959 The answer from LyX will arrive in the output pipe and be of the form
4976 \begin_layout Standard
4985 are just echoed from the command request, while
4989 is more or less useful information filled according to how the command
4990 execution worked out.
4991 Some commands, such as
4992 \begin_inset Quotes eld
4996 \begin_inset Quotes erd
4999 , will return information about the internal state of LyX, while other will
5000 return an empty data-response.
5001 This means that the command execution went fine.
5004 \begin_layout Standard
5005 In case of errors, the response from LyX will have this form
5022 \begin_layout Standard
5027 should contain an explanation of why the command failed.
5030 \begin_layout Standard
5034 \begin_layout LyX-Code
5037 :test:beginning-of-buffer:" >~/.
5040 \begin_inset Newline newline
5050 \begin_inset Newline newline
5056 \begin_inset Newline newline
5062 \begin_layout Section
5066 \begin_layout Standard
5067 LyX can notify clients of events going on asynchronously.
5068 Currently it will only do this if the user binds a key sequence with the
5070 \begin_inset Quotes eld
5074 \begin_inset Quotes erd
5078 The format of the string LyX sends is as follows:
5082 \begin_inset Flex CharStyle:Code
5085 \begin_layout Plain Layout
5096 \begin_layout Standard
5101 is the printed representation of the key sequence that was actually typed
5105 \begin_layout Standard
5106 This mechanism can be used to extend LyX's command set and implement macros.
5107 Bind some key sequence to
5108 \begin_inset Quotes eld
5112 \begin_inset Quotes erd
5116 Then start a client that listens on the output pipe, dispatches the command
5117 according to the sequence, and starts a function that may use LyX calls
5118 and LyX requests to issue a command or a series of commands to LyX.
5121 \begin_layout Section
5122 The simple LyX Server Protocol
5125 \begin_layout Standard
5126 LyX implements a simple protocol that can be used for session management.
5127 All messages are of the form
5142 \begin_layout Standard
5148 \begin_inset Quotes eld
5152 \begin_inset Quotes erd
5156 \begin_inset Quotes eld
5160 \begin_inset Quotes erd
5165 \begin_inset Quotes eld
5169 \begin_inset Quotes erd
5172 is received from a client, LyX will report back to inform the client that
5173 it's listening to it's messages, while
5174 \begin_inset Quotes eld
5178 \begin_inset Quotes erd
5181 sent from LyX will inform clients that LyX is closing.
5184 \begin_layout Section
5192 \begin_layout Standard
5201 \begin_layout Plain Layout
5202 The following viewers offer the reverse
5221 facility (also called
5226 This means that you can tell LyX to put the cursor to a specific line in
5227 the document by clicking at the respective position in the
5232 To achieve this, the viewer must be able to communicate with LyX.
5233 This is done via the LyX server either by using the named pipe (
5237 ), or the UNIX domain socket (
5241 ) that LyX creates in its temporary directory (this is the way the
5242 \begin_inset Flex CharStyle:Code
5245 \begin_layout Plain Layout
5252 program communicates with LyX).
5253 In some cases, you need a helper script that mediates between the viewer
5254 and LyX, in others, the viewer can communicate with LyX directly.
5255 This depends on the selected viewer and on your operating system.
5256 The same applies to the way viewers need to be configured and the way the
5257 reverse search is actually performed.
5258 In what follows, we will thus describe how to setup reverse search for
5260 Before we turn to this, though, we will explain what needs to be done generally
5261 to enable reverse search in the
5268 \begin_layout Subsection
5269 Enabling reverse search
5272 \begin_layout Standard
5275 provides several different methods for reverse search.
5276 Some are built-in in the
5277 \begin_inset Flex CharStyle:Code
5280 \begin_layout Plain Layout
5287 program, some are provided by external packages.
5288 Your choice depends on whether your
5290 distribution already provides a given method (the built-in methods are
5291 rather new) and whether your viewer can cope with it.
5292 The available methods are described in the following.
5295 \begin_layout Subsubsection*
5305 \begin_layout Standard
5306 This method provides the
5308 file with the necessary information for reverse search.
5311 since quite some time (any somewhat recent
5313 distribution should include it), and it works reliably.
5314 To enable it, change the
5315 \begin_inset Flex CharStyle:MenuItem
5318 \begin_layout Plain Layout
5325 \begin_layout Plain Layout
5341 \begin_inset Flex CharStyle:MenuItem
5344 \begin_layout Plain Layout
5351 \begin_layout Plain Layout
5367 \begin_inset Flex CharStyle:MenuItem
5370 \begin_layout Plain Layout
5371 Preferences\SpecialChar \menuseparator
5372 File Handling\SpecialChar \menuseparator
5379 \begin_inset Flex CharStyle:Code
5382 \begin_layout Plain Layout
5391 If this doesn't work, check if your TeX engine needs different options
5392 (the syntax might differ in some distributions).
5395 \begin_layout Subsubsection*
5403 \begin_layout Standard
5412 provide reverse search facility for
5418 output, respectively.
5419 In order to enable it, load the packages in the LyX preamble:
5422 \begin_layout Itemize
5423 \begin_inset Flex CharStyle:Code
5426 \begin_layout Plain Layout
5443 \begin_layout Itemize
5445 \begin_inset Flex CharStyle:Code
5448 \begin_layout Plain Layout
5465 \begin_layout Standard
5466 If you want to be able to perform both
5470 reverse searches, you can also insert in the preamble the following lines
5473 \begin_layout LyX-Code
5481 \begin_inset Newline newline
5489 \begin_inset Newline newline
5499 \begin_inset Newline newline
5505 \begin_inset Newline newline
5515 \begin_inset Newline newline
5524 \begin_layout Standard
5525 This way, you can preview the file as either
5531 ) and the right package will be used.
5534 \begin_layout Standard
5537 might affect the output layout of your document.
5538 It is therefore advised to disable
5540 for final documents.
5543 \begin_layout Subsubsection*
5544 Built-in reverse search via
5553 \begin_layout Standard
5555 \begin_inset Flex CharStyle:Code
5558 \begin_layout Plain Layout
5566 have built-in support for both
5575 facility is basically the result of the integration of the
5579 program and its merge with the
5591 distribution in order to use it.
5592 Also note that only a few
5594 viewers (Skim on the Mac,
5596 on Windows) already provide
5601 \begin_layout Standard
5607 \begin_inset Flex CharStyle:MenuItem
5610 \begin_layout Plain Layout
5617 \begin_layout Plain Layout
5633 \begin_inset Flex CharStyle:MenuItem
5636 \begin_layout Plain Layout
5643 \begin_layout Plain Layout
5659 \begin_inset Flex CharStyle:MenuItem
5662 \begin_layout Plain Layout
5663 Preferences\SpecialChar \menuseparator
5664 File Handling\SpecialChar \menuseparator
5671 \begin_inset Flex CharStyle:Code
5674 \begin_layout Plain Layout
5685 \begin_inset Flex CharStyle:MenuItem
5688 \begin_layout Plain Layout
5695 \begin_layout Plain Layout
5716 \begin_inset Flex CharStyle:Code
5719 \begin_layout Plain Layout
5730 Check the documentation of your viewer whether the viewer needs to be configure
5737 \begin_layout Plain Layout
5739 \begin_inset Flex CharStyle:Code
5742 \begin_layout Plain Layout
5753 If your viewer does not support it, you should instead use
5754 \begin_inset Flex CharStyle:Code
5757 \begin_layout Plain Layout
5773 \begin_layout Subsection
5774 Configuring and using specific viewers
5777 \begin_layout Subsubsection*
5783 \begin_layout Standard
5785 \begin_inset Flex CharStyle:Code
5788 \begin_layout Plain Layout
5795 , you don't need to do anything else for performing a reverse
5797 search, as LyX already provides the necessary hooks for automatically using
5799 \begin_inset Flex CharStyle:Code
5802 \begin_layout Plain Layout
5810 Just setup your document as described above (reverse search is triggered
5813 -click or Alt-click on Mac
5818 \begin_layout Standard
5819 However, if for whatever reason you want to use the named pipe instead of
5820 the socket for communicating with LyX, simply change the
5823 \begin_inset Flex CharStyle:MenuItem
5826 \begin_layout Plain Layout
5827 Preferences\SpecialChar \menuseparator
5828 File Handling\SpecialChar \menuseparator
5838 \begin_layout Plain Layout
5842 \begin_inset Flex CharStyle:Code
5845 \begin_layout Plain Layout
5862 \begin_inset Flex CharStyle:Code
5865 \begin_layout Plain Layout
5877 \begin_inset Flex CharStyle:Code
5880 \begin_layout Plain Layout
5888 is a suitable script.
5889 For example, a minimal shell script is the following one:
5892 \begin_layout LyX-Code
5894 \begin_inset Newline newline
5902 \begin_inset Newline newline
5912 \begin_inset Newline newline
5915 echo "$COMMAND" > "${
5918 \begin_inset Newline newline
5926 \begin_layout Standard
5928 \begin_inset Flex CharStyle:Code
5931 \begin_layout Plain Layout
5942 \begin_layout Plain Layout
5951 pipe path specified in
5952 \begin_inset Flex CharStyle:MenuItem
5955 \begin_layout Plain Layout
5956 Preferences\SpecialChar \menuseparator
5966 \begin_layout Plain Layout
5968 \begin_inset Flex CharStyle:Code
5971 \begin_layout Plain Layout
5977 folder of a source distribution you can find a
5978 \begin_inset Flex CharStyle:Code
5981 \begin_layout Plain Layout
5988 script which is able to locate the
5992 based on your preferences.
6000 \begin_layout Subsubsection*
6008 \begin_layout Standard
6010 \begin_inset Flex CharStyle:Code
6013 \begin_layout Plain Layout
6023 , add the following lines:
6026 \begin_layout LyX-Code
6031 \begin_layout Plain Layout
6043 \begin_inset Newline newline
6049 \begin_layout Standard
6050 Modify the lines accordingly if you install LyX somewhere else than in the
6051 Applications folder.
6054 \begin_layout Standard
6055 Reverse search is triggered by Alt-click (OPTION-click).
6058 \begin_layout Subsubsection*
6064 \begin_layout Standard
6066 \begin_inset Flex CharStyle:Code
6069 \begin_layout Plain Layout
6070 open -a Skim.app $$i
6075 to the viewer setting in
6076 \begin_inset Flex CharStyle:MenuItem
6079 \begin_layout Plain Layout
6080 Preferences\SpecialChar \menuseparator
6081 File Handling\SpecialChar \menuseparator
6082 File formats\SpecialChar \menuseparator
6093 \begin_inset Flex CharStyle:MenuItem
6096 \begin_layout Plain Layout
6097 Skim\SpecialChar \menuseparator
6098 Preferences\SpecialChar \menuseparator
6108 \begin_layout Plain Layout
6118 \begin_layout Standard
6119 Reverse search is triggered by COMMAND-SHIFT-click
6122 \begin_layout Subsubsection*
6130 \begin_layout Standard
6132 \begin_inset Flex CharStyle:MenuItem
6135 \begin_layout Plain Layout
6136 Settings\SpecialChar \menuseparator
6139 \SpecialChar \ldots{}
6140 \SpecialChar \menuseparator
6147 \begin_inset Quotes eld
6151 \begin_inset Quotes erd
6155 \begin_inset Flex CharStyle:Code
6158 \begin_layout Plain Layout
6169 \begin_layout Standard
6170 Reverse search is triggered by SHIFT-click.
6173 \begin_layout Subsubsection*
6179 \begin_layout Standard
6180 Launch yap, choose its
6181 \begin_inset Flex CharStyle:MenuItem
6184 \begin_layout Plain Layout
6185 View\SpecialChar \menuseparator
6192 \begin_inset Quotes eld
6198 \begin_inset Quotes erd
6203 \begin_inset Quotes eld
6206 New\SpecialChar \ldots{}
6208 \begin_inset Quotes erd
6211 button and, in the window that opens, enter
6212 \begin_inset Quotes eld
6216 \begin_inset Quotes erd
6219 (or any other name you like) in the
6220 \begin_inset Quotes eld
6224 \begin_inset Quotes erd
6228 Now click on the button labeled
6229 \begin_inset Quotes eld
6232 \SpecialChar \ldots{}
6234 \begin_inset Quotes erd
6237 to open a file dialog and navigate to the directory containing the batch
6239 \begin_inset Flex CharStyle:Code
6242 \begin_layout Plain Layout
6252 \begin_inset Flex CharStyle:Code
6255 \begin_layout Plain Layout
6263 and then specify the program arguments as
6264 \begin_inset Flex CharStyle:Code
6267 \begin_layout Plain Layout
6273 if you want to use the shell script above, or as
6274 \begin_inset Flex CharStyle:Code
6277 \begin_layout Plain Layout
6283 if you want to use the
6284 \begin_inset Flex CharStyle:Code
6287 \begin_layout Plain Layout
6295 Since yap is a native Windows application, the
6297 it provides should be converted to
6299 style before being passed to
6300 \begin_inset Flex CharStyle:Code
6303 \begin_layout Plain Layout
6312 \begin_inset Flex CharStyle:Code
6315 \begin_layout Plain Layout
6322 , and this is the purpose of the
6323 \begin_inset Flex CharStyle:Code
6326 \begin_layout Plain Layout
6334 wrapper, which is as follows:
6337 \begin_layout LyX-Code
6339 \begin_inset Newline newline
6347 \begin_inset Newline newline
6357 \begin_inset Newline newline
6361 \begin_inset Newline newline
6367 \begin_inset Newline newline
6378 \begin_layout Standard
6379 You have to make sure that both
6380 \begin_inset Flex CharStyle:Code
6383 \begin_layout Plain Layout
6392 \begin_inset Flex CharStyle:Code
6395 \begin_layout Plain Layout
6404 are in the command PATH, otherwise you have to use their full
6406 path in the above batch file.
6409 \begin_layout Standard
6410 In yap, reverse search is triggered by double-click.
6413 \begin_layout Subsubsection*
6421 \begin_layout Standard
6424 , you can set the name of the program that communicates with LyX by simply
6428 \begin_inset Flex CharStyle:Code
6431 \begin_layout Plain Layout
6442 The program will remember the setting and using the
6443 \begin_inset Flex CharStyle:Code
6446 \begin_layout Plain Layout
6452 option will not be needed from now on
6456 \begin_layout Plain Layout
6457 It has been reported that
6459 is not able to remember the settings if it is installed in the Program
6460 Files system folder.
6461 This problem can be avoided by installing it somewhere else, for example
6463 \begin_inset Flex CharStyle:Code
6466 \begin_layout Plain Layout
6479 (in this way you will be using the
6482 \begin_inset Flex CharStyle:Code
6485 \begin_layout Plain Layout
6491 option if you want to use the
6493 and be sure that the
6494 \begin_inset Flex CharStyle:Code
6497 \begin_layout Plain Layout
6505 script is in your command PATH).
6510 viewer, you should enter
6511 \begin_inset Flex CharStyle:Code
6514 \begin_layout Plain Layout
6522 in the viewer setting in
6523 \begin_inset Flex CharStyle:MenuItem
6526 \begin_layout Plain Layout
6527 Preferences\SpecialChar \menuseparator
6528 File Handling\SpecialChar \menuseparator
6529 File formats\SpecialChar \menuseparator
6540 \begin_inset Flex CharStyle:Code
6543 \begin_layout Plain Layout
6551 is the following script (to be placed in your command PATH,
6552 \begin_inset Flex CharStyle:Code
6555 \begin_layout Plain Layout
6563 being the best choice):
6566 \begin_layout LyX-Code
6568 \begin_inset Newline newline
6576 \begin_inset Newline newline
6588 \begin_layout Standard
6589 This is needed because
6591 is a native Windows application and does not understand the
6598 \begin_layout Standard
6599 Reverse search is triggered by double-click.
6602 \begin_layout Chapter
6603 Special Document Classes
6606 \begin_layout Section
6610 \begin_layout Standard
6617 \begin_layout Subsection
6621 \begin_layout Standard
6622 This section describes how LyX can be used to write articles for submission
6623 to the scientific journal
6625 Astronomy and Astrophysics
6634 \begin_inset Flex URL
6637 \begin_layout Plain Layout
6639 http://www.edpsciences.fr/aa/
6646 of the document class
6653 This package can be downloaded from the ftp site
6656 \begin_layout Standard
6657 \begin_inset VSpace medskip
6663 \begin_layout Standard
6665 \begin_inset Flex URL
6668 \begin_layout Plain Layout
6670 ftp://ftp.edpsciences.org/pub/aa/readme.html
6678 \begin_layout Standard
6679 \begin_inset VSpace medskip
6685 \begin_layout Standard
6686 A manual comes together with that package, and this text is not meant to
6687 replace the original manual but merely a short guide how to realize the
6688 correct form of your paper.
6692 \begin_layout Standard
6693 Please note that the publisher of the journal was changed from Springer
6694 to EDP Sciences starting January 1,
6697 That change implicated also some slight changes of the style files, namely
6698 the removal of the thesaurus command.
6701 supports the newest version of these style files, V 5.
6704 If you have an older version installed, please upgrade.
6705 For compatibility, the old (version 4) layout has been kept as
6712 Please refer to the comments in
6722 \begin_layout Subsection
6726 \begin_layout Standard
6727 It is recommended you start from the example template distributed with LyX.
6728 If you are not using a template, note the following settings:
6731 \begin_layout Itemize
6738 Document\SpecialChar \menuseparator
6741 dialog (OK, that one was obvious).
6744 \begin_layout Itemize
6745 Don't change the option
6748 \begin_inset space ~
6758 The whole layout is done by the macros, you shouldn't change anything.
6761 \begin_layout Subsection
6765 \begin_layout Standard
6766 First thing to enter is the header information.
6767 It consists of seven entries, of which some are optional.
6771 \begin_layout Itemize
6779 \begin_layout Itemize
6787 \begin_layout Itemize
6795 \begin_layout Itemize
6803 \begin_layout Itemize
6808 : [optional] if more than one author: whom to contact for offprint requests.
6811 \begin_layout Itemize
6816 : [optional] mail address for contacts.
6819 \begin_layout Itemize
6827 Received: <date>; Accepted <date>
6830 \begin_layout Standard
6831 There is no need to issue the
6838 command, this is done automatically by LyX when the header is finished.
6839 Although the order of the single header entries doesn't matter it is advised
6840 to keep the above sequence, just to get the best optics and meets the layout
6841 of the real document.
6844 \begin_layout Standard
6845 If you want to place footnotes in the header block, e.
6846 \begin_inset space \thinspace{}
6850 \begin_inset space \space{}
6853 to state your present address, just use the standard footnote via the menu
6856 Insert\SpecialChar \menuseparator
6871 \begin_layout Standard
6872 In addition to these topics, the macros use three additional
6874 commands that have no counterpart in LyX:
6877 \begin_layout Itemize
6884 to separate different names for more than one author and institute, respectivel
6888 \begin_layout Itemize
6897 to mark corresponding author/institute pairs.
6898 The institutes are numbered sequentially as they appear in the
6902 field, so you have to put a marker to each author.
6905 \begin_layout Itemize
6912 to supply an email address for fast contact.
6915 \begin_layout Standard
6916 In all cases, the appropriate command has to be entered in LyX and marked
6924 \begin_layout Subsection
6928 \begin_layout Standard
6929 The abstract should immediately follow the header block.
6930 With version 5 the abstract environment was changed to a command, and there
6933 to only one paragraph.
6934 In addition, it should contain an entry with the keywords.
6935 This is not yet implemented for LyX, therefore you have to enter the
6943 by hand and mark it as
6946 Refer to the example paper.
6949 \begin_layout Subsection
6950 Supported environments
6953 \begin_layout Standard
6954 The A&A paper layout supports the following environments for structuring
6958 \begin_layout Itemize
6964 \begin_layout Itemize
6970 \begin_layout Itemize
6976 \begin_layout Itemize
6982 \begin_layout Itemize
6988 \begin_layout Itemize
6994 \begin_layout Itemize
7000 \begin_layout Itemize
7006 \begin_layout Itemize
7012 \begin_layout Itemize
7018 \begin_layout Itemize
7024 \begin_layout Itemize
7030 \begin_layout Subsection
7031 Commands not supported by LyX
7034 \begin_layout Standard
7035 Some commands are not yet supported by the
7040 Some have already been mentioned.
7041 For the sake of completeness, they are listed all together here:
7044 \begin_layout Itemize
7052 \begin_layout Itemize
7060 \begin_layout Itemize
7068 \begin_layout Itemize
7077 \begin_layout Itemize
7085 \begin_layout Itemize
7093 \begin_layout Itemize
7101 \begin_layout Itemize
7111 \begin_layout Standard
7112 If you want to use any of these commands, you have to enter them yourself.
7115 Do not forget to mark them as
7120 \begin_layout Subsection
7121 Figure and Table Floats
7124 \begin_layout Standard
7125 LyX provides support for the necessary float environments
7127 figure, figure*, table
7133 , therefore we won't tell much about it here.
7137 \begin_inset space ~
7143 Just remember that tables should be left-aligned.
7144 For that, select the table and change the alignment in
7146 Edit\SpecialChar \menuseparator
7148 \begin_inset space ~
7154 \begin_layout Standard
7155 There is only one special thing: the figures with caption besides the figure.
7156 To create such a figure, you have to do the following:
7159 \begin_layout Enumerate
7160 Create a wide figure float:
7162 Insert\SpecialChar \menuseparator
7163 Float\SpecialChar \menuseparator
7166 , then right click in the figure and select
7172 \begin_inset space ~
7180 \begin_layout Enumerate
7181 Enter your caption text.
7184 \begin_layout Enumerate
7189 to move the cursor above the caption.
7192 \begin_layout Enumerate
7196 \begin_layout Enumerate
7197 Position the cursor behind the figure and insert a horizontal fill:
7199 Insert\SpecialChar \menuseparator
7201 \begin_inset space ~
7204 Character\SpecialChar \menuseparator
7206 \begin_inset space ~
7214 \begin_layout Enumerate
7220 \begin_inset space ~
7228 \begin_layout Enumerate
7242 Do not close the brace!
7245 \begin_layout Enumerate
7246 Position the cursor behind the caption text, switch to
7248 mode and insert the closing brace:
7251 \begin_inset space ~
7263 \begin_layout Standard
7264 Also, refer to the figures in the example paper.
7267 \begin_layout Subsection
7271 \begin_layout Standard
7272 For submission, the paper has to be
7274 in a special double-spacing layout.
7275 For this purpose, you have to give the option
7282 This must be done using the extra class options field in the
7284 Document\SpecialChar \menuseparator
7288 Just enter the string
7295 \begin_layout Subsection
7299 \begin_layout Standard
7304 directory contains an example paper written with LyX.
7305 It is the example paper from the original macro package, translated to
7307 Use it for inspiration, and compare the original
7309 code with LyX way of writing.
7312 \begin_layout Section
7317 \begin_layout Standard
7324 \begin_layout Subsection
7328 \begin_layout Standard
7331 is a set of macros produced by the American Astronomical Society to facilitate
7332 electronic manuscript submission to the three journals they publish: the
7333 Astrophysical Journal (including the Letters and Supplement), the Astronomical
7334 Journal, and the Publications of the Astronomical Society of the Pacific.
7337 to be an excellent tool for generating these documents, especially given
7338 its equation, citation, and figure handling capabilities.
7339 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7340 is the version described here, or higher.
7341 Versions prior to 5.0 are intended for use with
7345 and are fundamentally incompatible with LyX.
7348 package may be downloaded from the
7353 \begin_layout Standard
7354 \begin_inset VSpace medskip
7360 \begin_layout Standard
7362 \begin_inset Flex URL
7365 \begin_layout Plain Layout
7367 http://www.journals.uchicago.edu/AAS/AASTeX
7375 \begin_layout Standard
7376 \begin_inset VSpace medskip
7382 \begin_layout Standard
7383 A complete user guide is contained in that package and you should familiarize
7384 yourself with it thoroughly before embarking on writing a paper in LyX.
7385 LyX will not reduce the need to figure out all the
7387 commands, it will only reduce the drudgery of typing everything in.
7388 It is your responsibility to ensure that the final exported
7390 document conforms completely to the requirements of the journal to which
7391 you are submitting your paper.
7394 \begin_layout Subsection
7395 Starting a New Paper
7398 \begin_layout Standard
7399 I strongly suggest that you start with the
7404 File\SpecialChar \menuseparator
7411 , enter the new file name, then choose the
7418 This will show the most common fields found in a manuscript.
7419 Simply overwrite the existing text (including the brackets,
7423 ) with the correct information.
7426 commands and environments can be implemented directly in LyX, but some
7427 cannot: most noticeably
7441 , which should stick out like a sore thumb if you actually just opened the
7443 For commands such as these, the
7445 code must be entered directly and marked as such.
7446 Such commands are referred to as TeX code, or Evil Red Text.
7447 I tried to minimize the amount of TeX code needed in an
7449 document, but there is still a bit more required than any of us would like.
7452 \begin_layout Subsection
7453 Finishing Your Paper
7456 \begin_layout Standard
7457 When the paper is finished to your satisfaction and previews/prints correctly,
7459 \begin_inset Quotes eld
7465 \begin_inset Quotes erd
7468 actions which need to be done before you submit it to the journals.
7472 \begin_layout Enumerate
7473 Export your paper as a
7477 File\SpecialChar \menuseparator
7478 Export\SpecialChar \menuseparator
7486 \begin_layout Enumerate
7492 file with your favorite text editor
7496 \begin_layout Enumerate
7497 remove the comment lines before the
7507 \begin_layout Enumerate
7518 line if it appears (usually just after
7535 \begin_layout Enumerate
7536 remove everything between (and including) the
7550 commands, except for any commands you specifically put into the
7552 preamble (which should appear immediately after the
7553 \begin_inset Quotes eld
7559 \begin_inset Quotes erd
7571 \begin_layout Enumerate
7572 Run the resulting file through
7574 to make sure it still processes correctly.
7577 \begin_layout Enumerate
7578 Reread the journal requirements to make sure your
7580 and formats are correct.
7583 \begin_layout Enumerate
7587 \begin_layout Subsection
7588 Comments On Specific Commands
7591 \begin_layout Standard
7592 I will not describe the detailed usage of the individual
7602 ) gives a good description of each.
7603 Thus it's probably easiest for me to go down the list as found in the guide
7604 and offer comments where necessary.
7605 So let's begin \SpecialChar \ldots{}
7609 \begin_layout Subsubsection
7610 Things that work as expected
7613 \begin_layout Standard
7617 \begin_layout Plain Layout
7629 \begin_layout Standard
7630 Because they work as you might expect, I simply list them and the section
7765 .2), all the cite commands and their variations (2.
7803 .4, amongst other places),
7841 \begin_layout Standard
7842 The following style options also work correctly:
7863 Simply put them in the
7869 Layout\SpecialChar \menuseparator
7875 \begin_layout Standard
7879 \begin_layout Plain Layout
7891 \begin_layout Subsubsection
7892 Things that work, but require more comment
7895 \begin_layout Standard
7896 The following items work, but require a little more discussion:
7899 \begin_layout Itemize
7900 These items are reserved for use by the journal editors, but you can put
7903 preamble if you feel compelled to do so:
7938 \begin_layout Itemize
7939 These items may be placed in the
7941 preamble, and are included as blanks in the template file:
7965 \begin_layout Itemize
7972 (2.3) – can only be used
7973 \begin_inset Quotes eld
7977 \begin_inset Quotes erd
7980 , not in the middle of a paragraph.
7981 Use TeX code if you need to embed it.
7984 \begin_layout Itemize
7991 (2.3) – will have extra {} after it.
7992 This should not cause an error.
7995 \begin_layout Itemize
8003 (2.6) – can only be used
8004 \begin_inset Quotes eld
8008 \begin_inset Quotes erd
8011 , not in the middle of a paragraph.
8012 Use TeX code if you need to embed it.
8015 \begin_layout Itemize
8023 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8027 \begin_layout Itemize
8035 (2.8) – same as for
8043 \begin_layout Itemize
8051 (2.9) – will have extra {} after it.
8052 This should not cause an error.
8055 \begin_layout Itemize
8064 ) – will have extra {} after it.
8065 This should not cause an error.
8068 \begin_layout Itemize
8078 .2) – you can insert an optional
8080 argument by placing the cursor at the beginning of the text and selecting
8083 Insert\SpecialChar \menuseparator
8088 \begin_inset Quotes eld
8092 \begin_inset Quotes erd
8095 inserts an optional argument of the type needed by
8103 Hopefully it will be renamed someday.
8106 \begin_layout Itemize
8123 for the catalog ID optional parameter
8126 \begin_layout Itemize
8143 for the catalog ID optional parameter
8146 \begin_layout Subsubsection
8147 Things not implemented, use TeX code
8150 \begin_layout Standard
8154 \begin_layout Plain Layout
8166 \begin_layout Standard
8200 ), Journal name abbreviations (2.
8256 .4, insert it as the first element in the
8258 cell after where you want it.
8259 Don't use any of LyX's rules in the table),
8277 .5), much of Misc (2.
8337 \begin_layout Standard
8341 \begin_layout Plain Layout
8353 \begin_layout Subsubsection
8354 Things that cannot be implemented
8357 \begin_layout Standard
8358 \SpecialChar \ldots{}
8359 at least in any meaningful sort of way, so I suggest ignoring them.
8360 They are the references environment (2.
8367 If you really, really need to use
8369 , I suggest editing it in a separate file with a text editor, then using
8372 Insert\SpecialChar \menuseparator
8374 \begin_inset space ~
8379 to include it in your LyX document.
8386 file to see an example of this.
8389 \begin_layout Subsection
8390 FAQs, Tips, Tricks, and Other Ruminations
8393 \begin_layout Subsubsection
8399 \begin_layout Standard
8400 It can be a bit tricky to get LyX to recognize a new layout and document
8402 When all else fails, do this:
8405 \begin_layout Enumerate
8417 distribution into a directory completely unrelated to
8431 \begin_layout Enumerate
8444 \begin_layout Enumerate
8447 Tools\SpecialChar \menuseparator
8450 in LyX, then restart LyX.
8453 \begin_layout Enumerate
8454 Open a regular new file, not from a template.
8457 appear in the class list in
8459 Document\SpecialChar \menuseparator
8465 \begin_layout Standard
8466 If you get a warning from an existing
8468 document about not being able to find the
8470 layout or a message about
8471 \begin_inset Quotes eld
8474 You should not mix title layouts with normal ones
8475 \begin_inset Quotes erd
8478 , things haven't been installed correctly.
8481 \begin_layout Subsubsection
8484 error processing a table
8487 \begin_layout Standard
8488 LyX, by default, attempts to center the table caption/title.
8489 This seems to produce a bad interaction in
8491 so you should click somewhere in the caption/title, then select
8493 Edit\SpecialChar \menuseparator
8495 \begin_inset space ~
8509 This took care of it for me.
8512 \begin_layout Subsubsection
8516 \begin_layout Standard
8517 A couple of things: 1) I have noticed some funny spacing in the reference
8518 entries in the text.
8519 When you enter the bibliography item data, make sure their is
8523 space between the last author and the parenthesis setting off the year;
8527 \begin_inset space \thinspace{}
8531 \begin_inset space \space{}
8551 2) Entering the references at all is not obvious.
8552 The easiest thing is to start typing your first reference at the end of
8553 the document, then mark it as type
8558 That will put a small gray box in front of what you just typed.
8559 Click on the box to fill in the rest of the information.
8560 For new references, go to the end of an existing reference and press return.
8561 That will create a new line with its own box, etc.
8564 \begin_layout Subsubsection
8570 \begin_layout Standard
8573 provides its own figure commands (
8580 , for example), I much prefer
8582 standard figure commands (with the default
8593 \begin_inset space ~
8596 commands as TeX code into a Figure Float box if you desire, but I never
8597 have much luck getting the layout right.
8598 With the standard graphics, LyX will insert a
8610 preamble and handle the figures in the standard
8612 way, interspersing the figures in the text.
8615 accepts figures exactly this way now;
8618 \begin_inset Quotes eld
8621 stack everything at the end
8622 \begin_inset Quotes erd
8628 \begin_layout Subsubsection
8629 Things I could have done, but didn't
8632 \begin_layout Standard
8634 \begin_inset Quotes eld
8638 \begin_inset Quotes erd
8641 things I could have implemented, but chose not to.
8642 For instance, I saw no point in double-spacing the text in the LyX window,
8643 even though it is double-spaced in the paper manuscript.
8644 Also, I chose not to make separate layouts for the
8649 Since I assume you will spend most of your time in the plain manuscript
8650 mode anyway, I decided not to chew up more disk space with this.
8654 \begin_layout Subsection
8658 \begin_layout Standard
8659 Your mileage may vary.
8660 I've now had papers published by both
8666 % of the effort done in LyX; the last 2% was the
8668 post-processing and a few cleanups.
8669 I have had no trouble with the submission process, and I'm sure the journals
8670 were never aware that there might be a difference.
8671 So, go forth and publish!
8674 \begin_layout Section
8681 \begin_layout Standard
8684 David Johnson; updated by Richard Heck
8687 \begin_layout Standard
8688 \begin_inset VSpace bigskip
8694 \begin_layout Standard
8700 layouts are set up to conform to suggested styles for mathematical papers
8701 to be submitted to American Mathematical Society publications.
8702 The layouts are not tailored to a specific journal, but easily can be.
8703 You should refer to the
8705 documentation for specific instructions for each journal (usually it will
8706 entail only changing a single line in the TeX output).
8707 That documentation is available on the Web at
8708 \begin_inset Flex URL
8711 \begin_layout Plain Layout
8719 \begin_inset Flex URL
8722 \begin_layout Plain Layout
8724 ftp://ftp.ams.org/pub/tex/amslatex/
8730 These layouts are appropriate, and useful, for any mathematical writing.
8734 \begin_layout Standard
8742 \begin_layout Itemize
8750 \begin_layout Itemize
8755 book (really, monograph) format.
8759 \begin_layout Standard
8760 The layouts themselves contain only the minimum necessary to use the
8763 They do not, in particular, contain any of the `
8765 environments used for setting theorems, lemmas, and the like.
8766 These are contained, instead, in the
8767 \begin_inset Flex CharStyle:Code
8770 \begin_layout Plain Layout
8778 module, which is loaded by default when when you select one of the
8781 (It can also be used with other classes and can be removed, if you would
8782 rather use something else.) Less commonly used environments are in the
8783 \begin_inset Flex CharStyle:Code
8786 \begin_layout Plain Layout
8794 module, which must be loaded manually.
8797 \begin_layout Standard
8798 By default, theorems and the like are numbered consecutively throughout
8799 the document, but this may be modified by loading the module
8800 \begin_inset Flex CharStyle:Code
8803 \begin_layout Plain Layout
8804 Theorems (Order by Section)
8809 or, if you are using
8810 \begin_inset Flex CharStyle:Code
8813 \begin_layout Plain Layout
8822 \begin_inset Flex CharStyle:Code
8825 \begin_layout Plain Layout
8826 Theorems (Order by Chapter)
8832 These will number the results as
8833 \begin_inset Formula $n.m$
8836 , where the first number refers to the section (or chapter) and the second
8837 refers to the total number of results so far in that section (or chapter).
8838 Many environments are also available unnumbered.
8839 These are indicated by an asterisk at the end.
8840 If you happen to want
8844 unnumbered results, the the module
8845 \begin_inset Flex CharStyle:Code
8848 \begin_layout Plain Layout
8854 provides that option.
8857 \begin_layout Standard
8858 Note that these modules do not
8865 It is perfectly possible to use the
8866 \begin_inset Flex CharStyle:Code
8869 \begin_layout Plain Layout
8877 module, and the others mentioned, with other classes, such as
8878 \begin_inset Flex CharStyle:Code
8881 \begin_layout Plain Layout
8888 \begin_inset Flex CharStyle:Code
8891 \begin_layout Plain Layout
8898 \begin_inset Flex CharStyle:Code
8901 \begin_layout Plain Layout
8912 \begin_layout Subsection
8913 What these layouts provide
8916 \begin_layout Standard
8917 There is a long list of included environments provided by these layouts.
8922 , there is, in fact, an opportunity to define an unlimited variety of `
8927 recommends the environments that are available in LyX.
8931 \begin_layout Standard
8932 The following environments—as well as the standard environments, such as
8934 \begin_inset Flex CharStyle:Noun
8937 \begin_layout Plain Layout
8944 \begin_inset Flex CharStyle:Noun
8947 \begin_layout Plain Layout
8954 \begin_inset Flex CharStyle:Noun
8957 \begin_layout Plain Layout
8964 \begin_inset Flex CharStyle:Noun
8967 \begin_layout Plain Layout
8974 \begin_inset Flex CharStyle:Noun
8977 \begin_layout Plain Layout
8984 \begin_inset Flex CharStyle:Code
8987 \begin_layout Plain Layout
8996 \begin_inset Flex CharStyle:Code
8999 \begin_layout Plain Layout
9010 \begin_layout Description
9011 Address This should be the author's permanent address.
9014 \begin_layout Description
9016 \begin_inset space ~
9019 Address This should be the author's temporary address at the time of submission,
9020 if different from the Address.
9023 \begin_layout Description
9024 Email Author's e-mail address
9027 \begin_layout Description
9028 URL Author's Web address, if desired.
9031 \begin_layout Description
9032 Keywords Key words or phrases used to identify specific topics discussed
9036 \begin_layout Description
9041 Subject Classifications, published and described in
9043 Mathematical Reviews
9046 These are also available
9053 \begin_layout Description
9057 \begin_layout Description
9061 \begin_layout Description
9065 \begin_layout Standard
9066 The following environments are provided by both the
9067 \begin_inset Flex CharStyle:Code
9070 \begin_layout Plain Layout
9077 \begin_inset Flex CharStyle:Code
9080 \begin_layout Plain Layout
9088 modules, in the latter case in both starred (unnumbered) and
9090 (numbered) versions.
9091 These same environments are provided only in the starred versions by the
9093 \begin_inset Flex CharStyle:Code
9096 \begin_layout Plain Layout
9105 \begin_layout Theorem
9106 This is typically used for the statements of major results.
9110 \begin_layout Corollary*
9111 This is used for statements which follow fairly directly from previous statement
9113 Again, these can be major results.
9118 These are smaller results needed to prove other statements.
9121 \begin_layout Proposition
9122 These are less major results which (hopefully) add to the general theory
9126 \begin_layout Conjecture
9127 These are statements provided without justification, which the author does
9128 not know how to prove, but which seem to be true (to the author, at least).
9131 \begin_layout Definition*
9132 Guess what this is for.
9133 The font is different for this environment than for the previous ones.
9137 \begin_layout Example*
9138 Used for examples illustrating
9143 \begin_layout Problem
9144 It's not really known what this is for.
9145 You should figure it out.
9148 \begin_layout Exercise*
9149 Write a description for this one.
9152 \begin_layout Remark
9153 This environment is also a type of theorem, usually a lesser sort of observation.
9156 \begin_layout Claim*
9157 Often used in the course of giving a proof of a larger result.
9161 Generally, these are used to break up long arguments, using specific instances
9167 The numbering scheme for cases is on its own, not together with other numbered
9173 At the end of this environment, a QED symbol (usually a square, but it can
9174 vary with different styles) is placed.
9175 If you want to have other environments within this one—for example, Case
9176 environments—and have the QED symbol appear only after them, then the other
9177 environments need to be nested within the proof environment.
9180 Nesting Environments
9186 for information on nesting.
9189 \begin_layout Standard
9190 And these environments are provided by
9191 \begin_inset Flex CharStyle:Code
9194 \begin_layout Plain Layout
9205 \begin_layout Criterion*
9206 A required condition.
9209 \begin_layout Algorithm*
9210 A general procedure to be used.
9213 \begin_layout Axiom*
9214 This is a property or statement taken as true within the system being discussed.
9217 \begin_layout Condition*
9218 Sometimes used to state a condition assumed within the present context of
9223 Similar to a Remark.
9226 \begin_layout Notation*
9227 Used for the explanation of, yes, notation.
9230 \begin_layout Summary
9231 Do we really need to tell you?
9234 \begin_layout Acknowledgement*
9240 \begin_layout Conclusion*
9241 Sometimes used at the end of a long train of argument.
9245 Used in a way similar to Proposition, though perhaps lower on the scale.
9248 \begin_layout Standard
9251 classes automatically provide the
9258 They need to be available on your system in order to use these environments.
9261 \begin_layout Section
9271 \begin_layout Standard
9277 \begin_layout Subsection
9281 \begin_layout Standard
9282 These are the layout files for some of the journals of the American Geophysical
9284 It is assumed that you have both the
9288 installed (everything to be found at
9289 \begin_inset Flex URL
9292 \begin_layout Plain Layout
9294 ftp://ftp.agu.org/journals/latex/journals
9302 \begin_layout Subsection
9306 \begin_layout Standard
9316 They are still called this in the LyX GUI, though their
9332 \begin_layout Standard
9333 Newly defined styles are
9370 These are mostly manuscript attributes and defined in the
9372 class documentation.
9375 \begin_layout Standard
9376 I suspect this is still badly incomplete.
9379 \begin_layout Subsection
9383 \begin_layout Standard
9400 \begin_layout Subsection
9404 \begin_layout Itemize
9407 Journal of Geophysical Research
9417 \begin_layout Standard
9418 Add your own, it isn't so hard! Look at the
9431 \begin_layout Subsection
9432 Bugs and things to remember
9435 \begin_layout Standard
9436 In order to use the new layouts, you must remember to do the following for
9440 \begin_layout Enumerate
9446 This can be done in the
9448 Layout\SpecialChar \menuseparator
9453 Document\SpecialChar \menuseparator
9459 articles are always in English, right? So
9466 \begin_layout Enumerate
9476 (Yes, this is a bug.)
9479 \begin_layout Enumerate
9480 Make sure you use the
9486 bibliography style, by entering
9490 into the second field of the
9493 None of the standard styles will do.
9496 \begin_layout Section
9500 \begin_layout Standard
9507 \begin_layout Subsection
9511 \begin_layout Standard
9512 Broadway is for writing plays.
9513 The format is more decorative than Hollywood, and much less standardized.
9514 This format should be suitable for workshops.
9517 \begin_layout Subsection
9521 \begin_layout Standard
9522 The same as in Hollywood.
9525 \begin_layout Subsection
9529 \begin_layout Standard
9534 names as labels then cross-reference the label to insert the name.
9535 The cross-reference dialog will show the current cast of characters.
9538 \begin_layout Subsection
9539 Paper size and Margins
9542 \begin_layout Standard
9555 \begin_layout Subsection
9559 \begin_layout Standard
9560 The following environments are available.
9563 .bind to get the bind keys shown at the right.
9566 \begin_layout Itemize
9570 \begin_inset Newline newline
9575 You should not have to use this, but it is here for anything that does not
9579 \begin_layout Itemize
9583 \begin_inset space \hfill{}
9587 \begin_inset Newline newline
9592 Used to describe stage setting and the action.
9593 First use of speaker names in all
9598 \begin_layout Itemize
9602 \begin_inset space \hfill{}
9606 \begin_inset Newline newline
9611 Automatically numbered.
9612 On screen it will be
9614 , but will print as Roman.
9617 \begin_layout Itemize
9621 \begin_inset space \hfill{}
9625 \begin_inset Newline newline
9635 It is just centered text.
9638 \begin_layout Itemize
9642 \begin_inset space \hfill{}
9646 \begin_inset Newline newline
9651 Not automatically numbered.
9652 You supply the number.
9653 This is because I couldn't figure out how.
9656 \begin_layout Itemize
9660 \begin_inset space \hfill{}
9664 \begin_inset Newline newline
9669 A special case of Narrative to describe the setting and action as the curtain
9673 \begin_layout Itemize
9677 \begin_inset space \hfill{}
9681 \begin_inset Newline newline
9686 The speaker's (actor's) title, centered in all CAPS.
9689 \begin_layout Itemize
9693 \begin_inset space \hfill{}
9697 \begin_inset Newline newline
9702 Instructions to the speaker.
9703 The parentheses are automatically inserted.
9704 The ( will appear on screen, but both will be in the printed play.
9705 This environment is only used within
9712 \begin_layout Itemize
9717 \begin_inset space \hfill{}
9721 \begin_inset Newline newline
9726 What the Speaker says.
9729 \begin_layout Itemize
9733 \begin_inset space \hfill{}
9737 \begin_inset Newline newline
9742 The curtain comes down.
9745 \begin_layout Itemize
9749 \begin_inset space \hfill{}
9755 \begin_layout Itemize
9759 \begin_inset space \hfill{}
9765 \begin_layout Itemize
9769 \begin_inset space \hfill{}
9775 \begin_layout Standard
9779 \begin_layout Section
9784 \begin_layout Standard
9789 can be used to type letters according to German conventions.
9790 A template file is included in
9796 for you to use as a starting point.
9799 \begin_layout Section
9809 \begin_layout Standard
9815 \begin_layout Subsection
9819 \begin_layout Standard
9820 This is the layout file for the European Geophysical Society journals.
9827 can be downloaded from the web site of the
9830 \begin_inset Flex URL
9833 \begin_layout Plain Layout
9843 \begin_layout Subsection
9847 \begin_layout Standard
9850 Right_address, Latex_Title,
9856 , Received, Accepted
9863 The current layout file is unfortunately very
9865 and would benefit from using the various
9872 \begin_layout Section
9878 \begin_layout Standard
9885 \begin_layout Standard
9888 Science Publishers B.V.
9897 ) for submitting articles to their various journals.
9898 The style file can be downloaded directly from their web site:
9899 \begin_inset Flex URL
9902 \begin_layout Plain Layout
9904 http://authors.elsevier.com/
9910 Instructions are supplied along with the class file, which details the
9911 requirements of the publishers.
9912 LyX includes package that allows for the use of this class, by a layout
9913 and a template file.
9914 Installation of the class file is the same as for any other
9916 package; instructions are provided in the
9921 \begin_layout Standard
9936 class file is based mainly on the standard article class, most of the normal
9937 functionality is provided.
9940 class defines a number of mathematical environments, which are similar
9944 These commands are all described in the
9946 documentation, and are available in LyX.
9949 \begin_layout Standard
9950 The easiest way to use the
9952 style is to base documents on the included template file.
9953 It is best not to use options such as fancy headings or the geometry package,
9954 as elements such as these are defined by
9956 in their style file.
9957 Ideally, no extra packages except those mentioned in the
9959 documentation should be used.
9963 \begin_inset Quotes eld
9967 \begin_inset Quotes erd
9972 file as possible, as their intention is to take the supplied file and replace
9973 the class file with one for the particular journal to which the paper has
9975 This also means that not too much time should be spent on the
9978 When it comes to be published, this will change anyway.
9979 The rest of the usage for this layout is substantially the same as for
9980 the normal article class.
9983 do and don't allow, refer to their documentation.
9986 \begin_layout Section
9992 \begin_inset CommandInset label
10001 \begin_layout Standard
10007 \begin_layout Subsection
10011 \begin_layout Standard
10012 This section describes how to use LyX to make slides for overhead projectors.
10013 There are two document classes that can do this: the default slides class
10019 This section documents the latter.
10022 \begin_layout Standard
10023 I'm going to say this again, nice and clear, so that there's no misunderstanding
10027 \begin_layout Standard
10028 \begin_inset VSpace bigskip
10034 \begin_layout Standard
10038 This section documents the class
10039 \begin_inset Quotes eld
10049 \begin_inset Quotes erd
10057 \begin_layout Standard
10058 \begin_inset VSpace bigskip
10064 \begin_layout Standard
10065 If you're looking for the documentation for
10066 \begin_inset Quotes eld
10074 \begin_inset Quotes erd
10077 , check out section
10078 \begin_inset space ~
10082 \begin_inset CommandInset ref
10084 reference "sec:slitex"
10089 If your machine doesn't have the
10094 \begin_inset Quotes eld
10104 \begin_inset Quotes erd
10107 ] installed, you'll probably have to use the default
10111 class, which isn't quite as good as
10116 \begin_layout Standard
10121 class is designed for use with version 2.1 of the
10128 class file which is now an integral part of
10133 \begin_layout Subsection
10137 \begin_layout Standard
10138 Obviously, to use this document class, you need to select
10139 \begin_inset Quotes eld
10149 \begin_inset Quotes erd
10159 \begin_inset space ~
10165 There are some settings in the
10168 \begin_inset space ~
10173 dialog that you should know about that are specific to this class:
10176 \begin_layout Itemize
10177 Don't change the options
10188 \begin_inset space ~
10194 They're ignored by the
10201 \begin_layout Itemize
10202 The default font size is
10205 \begin_inset space \thinspace{}
10208 pt with the other options being
10211 \begin_inset space \thinspace{}
10217 \begin_inset space \thinspace{}
10223 \begin_inset space \thinspace{}
10229 \begin_layout Itemize
10230 The default font is
10238 but all math equations are still typeset in the usual roman font.
10241 \begin_layout Itemize
10248 and Letter paper sizes as well as a special size for working with
10251 \begin_inset space \thinspace{}
10259 , legal or executive paper sizes.
10262 \begin_layout Itemize
10263 Don't bother changing the
10267 settings because they are ignored anyway.
10268 All floats appear where they are defined in the text.
10271 \begin_layout Itemize
10276 setting behaves a bit differently for this class.
10281 provides extensive footer and header capabilities including a user-defined
10284 \begin_inset space ~
10288 \begin_inset CommandInset ref
10290 reference "sec:foilfoot"
10295 The title page is treated differently to all other pages in the document
10304 has the logo centered at the bottom of the page (if one is defined).
10305 The possible page style choices and what they do are as follows:
10309 \begin_layout Labeling
10310 \labelwidthstring MMMMMMM
10317 The final output contains no page numbers, or other headers or footers
10318 (except footnotes of course).
10322 \begin_layout Labeling
10323 \labelwidthstring MMMMMMM
10330 The final output contains page numbers centered at the bottom of the page.
10331 No other headings or footers (other than footnotes).
10334 \begin_layout Labeling
10335 \labelwidthstring MMMMMMM
10340 Page numbers in lower right corner.
10341 Additional headers and footers are also shown.
10342 This is also the default.
10345 \begin_layout Labeling
10346 \labelwidthstring MMMMMMM
10351 Gives you access to the
10355 package although its use with
10359 is discouraged by the writer of the
10363 package because of some potential page layout clashes.
10367 \begin_layout Subsubsection
10371 \begin_layout Standard
10372 The following options may be used in the extra class options in the
10374 Document\SpecialChar \menuseparator
10380 \begin_layout Labeling
10381 \labelwidthstring MMMMMMx
10386 This sets up the page layout for 7.
10389 \begin_inset space \thinspace{}
10395 \begin_inset space \thinspace{}
10398 in paper, which is about the same aspect ratio as a
10401 \begin_inset space \thinspace{}
10404 mm slide, making it a bit easier to work with this medium.
10407 \begin_layout Labeling
10408 \labelwidthstring MMMMMMx
10413 Places a rule across the page below the header on every page except the
10417 \begin_layout Labeling
10418 \labelwidthstring MMMMMMx
10423 Places a rule across the page above the footer on every page except the
10427 \begin_layout Labeling
10428 \labelwidthstring MMMMMMx
10433 This is automatically set each time you create a new
10444 driver to rotate those pages that are set as landscape foils.
10447 \begin_layout Labeling
10448 \labelwidthstring MMMMMMx
10453 Simply changes the page dimensions to those of a landscape page but doesn't
10455 Thus if you use this option you need to use an external program to rotate
10456 each page or feed your paper through your printer as landscape.
10457 Note that this option effectively reverses the roles of the
10465 environments (don't worry these are described in the next section).
10468 \begin_layout Labeling
10469 \labelwidthstring MMMMMMx
10474 Equation numbers on the left.
10477 \begin_layout Labeling
10478 \labelwidthstring MMMMMMx
10483 Flush-left equations.
10486 \begin_layout Subsection
10487 Supported Environments
10490 \begin_layout Standard
10491 Most of the environments commonly supported in other classes are also supported
10497 There are several additional environments provided by
10501 as well as a couple added by LyX.
10502 The following environments are shared with other classes:
10505 \begin_layout Standard
10509 \begin_layout Plain Layout
10513 begin{multicols}{2}
10521 \begin_layout Itemize
10527 \begin_layout Itemize
10533 \begin_layout Itemize
10539 \begin_layout Itemize
10545 \begin_layout Itemize
10551 \begin_layout Itemize
10557 \begin_layout Itemize
10563 \begin_layout Itemize
10569 \begin_layout Itemize
10575 \begin_layout Itemize
10581 \begin_layout Itemize
10587 \begin_layout Itemize
10593 \begin_layout Itemize
10599 \begin_layout Itemize
10605 \begin_layout Itemize
10611 \begin_layout Itemize
10617 \begin_layout Itemize
10623 \begin_layout Itemize
10629 \begin_layout Standard
10633 \begin_layout Plain Layout
10645 \begin_layout Standard
10646 That is, all the major environments apart from the sectioning environments.
10647 Since foils are essentially self-contained sections, with a title and body,
10652 provides specific commands for starting new foils and these are:
10655 \begin_layout Itemize
10661 \begin_layout Itemize
10667 \begin_layout Standard
10668 LyX also provides slightly modified versions of these two environments called:
10671 \begin_layout Itemize
10677 \begin_layout Itemize
10680 ShortRotatefoilhead
10683 \begin_layout Standard
10684 and the differences will be explained in the next section.
10687 \begin_layout Standard
10688 Since foils are often used in presenting ideas or new theorems and such
10693 also provides a comprehensive box of goodies for presenting them:
10696 \begin_layout Standard
10700 \begin_layout Plain Layout
10704 begin{multicols}{2}
10712 \begin_layout Itemize
10718 \begin_layout Itemize
10724 \begin_layout Itemize
10730 \begin_layout Itemize
10736 \begin_layout Itemize
10742 \begin_layout Itemize
10748 \begin_layout Itemize
10754 \begin_layout Itemize
10760 \begin_layout Itemize
10766 \begin_layout Itemize
10772 \begin_layout Itemize
10778 \begin_layout Standard
10782 \begin_layout Plain Layout
10794 \begin_layout Standard
10795 The starred versions are unnumbered while the
10797 versions are numbered.
10798 There are also two list environments added by LyX and these are:
10801 \begin_layout Itemize
10807 \begin_layout Itemize
10813 \begin_layout Standard
10818 provides some powerful header and footer capabilities that are best set
10819 in the preamble although they may be set at any point in a document.
10820 If you want to change these settings in your document the best place to
10821 do so is at the very top of a foil, i.
10822 \begin_inset space \thinspace{}
10828 \begin_inset space \space{}
10838 \begin_layout Standard
10839 For this purpose, the following command styles are provided [
10846 \begin_layout Standard
10850 \begin_layout Plain Layout
10854 begin{multicols}{2}
10862 \begin_layout Itemize
10866 \begin_inset space ~
10872 \begin_layout Itemize
10878 \begin_layout Itemize
10882 \begin_inset space ~
10888 \begin_layout Itemize
10892 \begin_inset space ~
10898 \begin_layout Itemize
10902 \begin_inset space ~
10909 \begin_layout Standard
10910 \begin_inset space ~
10917 \begin_layout Standard
10921 \begin_layout Plain Layout
10933 \begin_layout Standard
10934 There are also a few commands provided by
10938 that aren't directly supported by LyX but I'll tell you what they do and
10939 how to use them in section
10940 \begin_inset space ~
10944 \begin_inset CommandInset ref
10946 reference "sec:unsuppfoils"
10953 \begin_layout Subsection
10954 Building a Set of Foils
10957 \begin_layout Standard
10958 This section will give a simple introduction to using the different environments
10959 to build a set of foils.
10960 If you want to see an example set of foils, take a look at the
10965 file you find in LyX's
10972 \begin_layout Subsubsection
10973 Give It a Title Page
10976 \begin_layout Standard
10977 Unlike other classes that provide
10997 creates the title on a page of its own.
10998 If you leave out the
11004 will substitute the current date (every time you regenerate the output).
11007 \begin_layout Subsubsection
11011 \begin_layout Standard
11012 As I mentioned earlier, there are four ways of starting a new foil.
11013 For portrait foils you should use
11023 The difference between these two environments is the amount of space between
11024 the title of the foil (the
11026 ) and the body of the foil.
11029 \begin_layout Standard
11030 Landscape foils are generated using the
11036 ShortRotatefoilhead
11039 Again the only difference is the spacing between
11042 Both of the short versions have 0.5 inches less separation between the
11048 \begin_layout Standard
11049 One problem with the support for landscape foils is the requirement that
11050 you have to use the
11054 driver to generate the
11056 output otherwise the foils won't be rotated.
11057 It is possible to get landscape foils even if you haven't got the
11061 driver provided you can feed your foils sideways through your printer ;-)
11064 \begin_layout Subsubsection
11065 Theorems, Lemmas, Proofs and more
11068 \begin_layout Standard
11069 Due to a small bug in LyX you can't have two of the same type of these environme
11070 nts directly following each other.
11071 They must be separated by something.
11072 If you try, you will just be extending the previous environment as if you
11073 had merged the two environments together.
11074 So, how do you get around this problem? The simplest option is to insert
11075 some text between the two environments or add a
11079 environment between the two with just a
11080 \begin_inset Quotes eld
11088 \begin_inset Quotes erd
11092 This will force LyX to produce two separate environments and hence the
11096 An example is provided in the example file included with the LyX distribution.
11097 Remember, this problem only occurs if you are trying to place two of the
11098 same type of theorem-like environments one directly after the other.
11101 \begin_layout Subsubsection
11105 \begin_layout Standard
11106 You get all the commonly supported list styles found in other classes as
11107 well as two new ones.
11108 I'll only describe the new ones here.
11109 If you want to find out more about the other list environments check out
11115 If you intend to use itemized lists you might also want to read about the
11119 \begin_inset space ~
11123 \begin_inset space ~
11128 dialog described above in section
11129 \begin_inset space ~
11133 \begin_inset CommandInset ref
11135 reference "sec:bullet"
11142 \begin_layout Standard
11143 The two new list styles,
11151 , are designed to make it easier for you to create lists of
11155 or right and wrong by providing dedicated environments that use a tick
11156 or a cross as the label of the list.
11157 These lists are in fact dedicated variants of the
11162 They do however require that you have the
11166 packages installed.
11169 \begin_layout Subsubsection
11173 \begin_layout Standard
11178 redefines the floating tables and figures so that they appear exactly where
11179 they are in the text rather than pushing them to the top of the page or
11180 to some user specified location.
11181 In fact if you change the float placement settings they are simply ignored.
11184 \begin_layout Subsubsection
11185 Page Headers and Footers
11186 \begin_inset CommandInset label
11188 name "sec:foilfoot"
11195 \begin_layout Standard
11199 \begin_inset space ~
11208 are two commands used to control the left-footer text string.
11209 The first is meant to allow you to include a graphic logo on your foils
11211 \begin_inset Quotes eld
11219 \begin_inset Quotes erd
11223 While the second is meant to provide a classification for the audience,
11227 \begin_inset space \thinspace{}
11233 \begin_inset space \space{}
11237 It is empty by default.
11240 \begin_layout Standard
11241 The remaining page corners can be filled by
11244 \begin_inset space ~
11249 (which defaults to page numbers),
11252 \begin_inset space ~
11260 \begin_inset space ~
11268 \begin_layout Subsection
11274 \begin_inset CommandInset label
11276 name "sec:unsuppfoils"
11283 \begin_layout Standard
11284 All the commands mentioned below need to be set in a
11292 within another environment.
11295 \begin_layout Subsubsection
11299 \begin_layout Standard
11300 All lengths are adjusted using the
11325 should be replaced by the name given to the length you want to change and
11330 is the length value.
11331 All lengths should be specified in units of length such as inches (
11343 ) or relative to some document or font-based length such as
11354 \begin_layout Standard
11355 It's possible to change the spacing between a
11357 and the body of the foil by adjusting the length specified by
11365 For example, to make
11372 \begin_inset space \space{}
11375 in closer to their bodies put the following in the preamble:
11390 \begin_layout Standard
11391 The spacings around floats can be adjusted by setting these lengths:
11394 \begin_layout Labeling
11395 \labelwidthstring MMMMMMMMMMM
11403 Separation between the text and the top of the float
11406 \begin_layout Labeling
11407 \labelwidthstring MMMMMMMMMMM
11415 Separation between the float and the caption
11418 \begin_layout Labeling
11419 \labelwidthstring MMMMMMMMMMM
11427 Separation between the caption and the following text
11430 \begin_layout Labeling
11431 \labelwidthstring MMMMMMMMMMM
11439 You can make the captions narrower than the surrounding text by adjusting
11441 Best done relative to
11451 \begin_layout Standard
11452 There are also several title page related lengths that you may find useful
11453 if you have a long title or several authors:
11456 \begin_layout Labeling
11457 \labelwidthstring MMMMMMMMMMM
11465 Separation from headers to
11470 \begin_layout Labeling
11471 \labelwidthstring MMMMMMMMMMM
11490 \begin_layout Labeling
11491 \labelwidthstring MMMMMMMMMMM
11506 \begin_layout Labeling
11507 \labelwidthstring MMMMMMMMMMM
11524 \begin_layout Labeling
11525 \labelwidthstring MMMMMMMMMMM
11542 \begin_layout Standard
11543 The last length related command affects all the list environments.
11555 a list environment then all the vertical spacing between the list items
11557 Note that this is a command not a length so it doesn't require
11564 like the stuff mentioned above.
11567 \begin_layout Subsubsection
11568 Headers and Footers
11571 \begin_layout Standard
11586 commands control whether the logo in the
11590 definition appear on a given page.
11598 in the preamble then none of the foils will have the logo on them.
11599 If you don't want the logo on a particular page place the
11608 of that page and the
11615 directly after the next
11620 \begin_layout Standard
11621 If you decide to use the
11625 page style setting in the
11628 \begin_inset space ~
11633 dialog you should probably add
11646 to your preamble so headers and footers on landscape pages are correctly
11647 placed when rotated.
11648 This is due to some clashes between the page layouts provided by the
11659 \begin_layout Section
11660 Hollywood (Hollywood spec scripts)
11663 \begin_layout Standard
11670 \begin_layout Subsection
11674 \begin_layout Standard
11675 Getting the format of a Hollywood script right is a
11676 \begin_inset Quotes eld
11680 \begin_inset Quotes erd
11683 It is designed to make the readers focus on content and to be easy and
11684 familiar for the actors to read.
11685 Each page of a script should be one minute of film.
11686 Nothing goes in a script that you cannot see or hear on screen.
11689 pt font should be used throughout.
11693 \begin_layout Subsection
11697 \begin_layout Standard
11700 lines should NEVER break in mid-sentence.
11701 If a speaker's lines continue over a page break, repeat the
11705 title followed by (
11710 \begin_layout Subsection
11714 \begin_layout Standard
11719 names as labels then cross-reference the label to insert the name.
11720 The cross-reference dialog will show the current cast of characters.
11721 You can use this to insert the speaker name in narratives also.
11724 \begin_layout Subsection
11725 Paper size and Margins
11728 \begin_layout Standard
11741 \begin_layout Subsection
11745 \begin_layout Standard
11746 The following environments are available.
11749 .bind to get the bind keys shown at the right.
11752 \begin_layout Itemize
11756 \begin_inset Newline newline
11761 Used where nothing else works.
11765 \begin_layout Itemize
11771 \begin_inset space \hfill{}
11779 \begin_inset Newline newline
11782 Usually followed by something like
11783 \begin_inset Quotes eld
11786 on Sally waking up.
11787 \begin_inset Quotes erd
11793 \begin_layout Itemize
11797 \begin_inset space \hfill{}
11801 \begin_inset Newline newline
11806 Introduces a new INTERIOR camera set-up.
11807 Always followed by DAY or NIGHT, or something similar to define the lighting
11811 on this line in CAPS.
11814 \begin_layout Itemize
11818 \begin_inset space \hfill{}
11822 \begin_inset Newline newline
11827 Introduces a new EXTERIOR camera set-up.
11830 on this line in CAPS.
11833 \begin_layout Itemize
11837 \begin_inset space \hfill{}
11841 \begin_inset Newline newline
11846 The character speaking.
11849 \begin_layout Itemize
11853 \begin_inset space \hfill{}
11857 \begin_inset Newline newline
11862 Instructions to the speaker.
11863 The () are automatically inserted, but only the ( will show in LyX.
11864 Both will be printed.
11867 \begin_layout Itemize
11872 \begin_inset space \hfill{}
11876 \begin_inset Newline newline
11888 \begin_layout Itemize
11892 \begin_inset space \hfill{}
11896 \begin_inset Newline newline
11901 Camera movement instruction.
11903 \begin_inset space \thinspace{}
11907 \begin_inset space \space{}
11913 \begin_layout Itemize
11917 \begin_inset space \hfill{}
11923 \begin_layout Itemize
11927 \begin_inset space \hfill{}
11933 \begin_layout Itemize
11937 \begin_inset space \hfill{}
11943 \begin_layout Itemize
11947 \begin_inset space \hfill{}
11953 \begin_layout Subsection
11957 \begin_layout Itemize
11958 (O.S) — off screen
11961 \begin_layout Itemize
11962 (V.0) — voice over
11965 \begin_layout Itemize
11967 \begin_inset space \thinspace{}
11974 \begin_layout Itemize
11979 \begin_layout Itemize
11980 PAN — camera movement
11983 \begin_layout Itemize
11984 INSERT — cut to close-up of
11987 \begin_layout Section
11994 \begin_layout Standard
12002 \begin_layout Subsection
12006 \begin_layout Standard
12009 package is a set of macros that facilitates electronic manuscript submission
12012 International Journal of Modern Physics C
12017 package is for creating manuscripts to be submitted to the
12019 International Journal of Modern Physics D
12022 Both journals are published by World Scientific.
12023 The corresponding document classes are named
12040 These files, together with instructions for the authors, can be downloaded
12042 \begin_inset Flex URL
12045 \begin_layout Plain Layout
12047 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12053 \begin_inset Flex URL
12056 \begin_layout Plain Layout
12058 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12064 Both packages are modified versions of the standard
12065 \begin_inset Quotes eld
12069 \begin_inset Quotes erd
12072 package, and they are almost (but not exactly) identical.
12073 Most of their features are supported by LyX.
12074 I have used LyX successfully to write articles submitted to both journals
12075 without any problem.
12078 \begin_layout Subsection
12082 \begin_layout Standard
12083 As usual, the easiest way to write a paper is to start with a template.
12086 File\SpecialChar \menuseparator
12109 This will give an (almost) empty document that includes the most common
12110 fields found in a manuscript.
12111 Simply overwrite the existing text (including the brackets,
12116 You should keep in mind the following remarks.
12119 \begin_layout Enumerate
12120 LyX won't let you change the font size and the page style of the document,
12121 because such modifications are not allowed by both packages.
12124 \begin_layout Enumerate
12125 The language of the document should not be changed.
12126 Before previewing your paper, be sure that the babel package is not used.
12127 To do this, click on
12129 Tools\SpecialChar \menuseparator
12142 in the language settings, and click on
12150 , if you wish to make this change permanent).
12153 \begin_layout Enumerate
12155 \begin_inset Quotes eld
12159 \begin_inset Quotes erd
12162 style must be used to define keywords.
12165 \begin_layout Enumerate
12168 package provides a style named
12169 \begin_inset Quotes eld
12172 Classification Codes
12173 \begin_inset Quotes erd
12176 , which can be used to define classification codes, such as
12179 Note that this facility is not supported by the
12184 \begin_layout Enumerate
12185 Several new environments are available:
12186 \begin_inset Quotes eld
12190 \begin_inset Quotes erd
12194 \begin_inset Quotes eld
12198 \begin_inset Quotes erd
12202 \begin_inset Quotes eld
12206 \begin_inset Quotes erd
12210 \begin_inset Quotes eld
12214 \begin_inset Quotes erd
12218 \begin_inset Quotes eld
12222 \begin_inset Quotes erd
12226 \begin_inset Quotes eld
12230 \begin_inset Quotes erd
12234 \begin_inset Quotes eld
12238 \begin_inset Quotes erd
12242 \begin_inset Quotes eld
12246 \begin_inset Quotes erd
12250 \begin_inset Quotes eld
12254 \begin_inset Quotes erd
12258 \begin_inset Quotes eld
12262 \begin_inset Quotes erd
12266 \begin_inset Quotes eld
12270 \begin_inset Quotes erd
12274 \begin_inset Quotes eld
12278 \begin_inset Quotes erd
12282 \begin_inset Quotes eld
12286 \begin_inset Quotes erd
12290 \begin_inset Quotes eld
12294 \begin_inset Quotes erd
12298 Their use is more or less obvious.
12299 LyX supports all these environments; it will use the proper label, text
12300 style, and numbering scheme for each of them.
12303 \begin_layout Enumerate
12304 Both packages use basic citations; the
12306 package should not be used.
12307 In LyX, citation references are shown as usual; in the output, citations
12308 are shown as superscripts.
12309 If you want to use a citation as normal text, you should use the
12314 \begin_inset space \thinspace{}
12318 \begin_inset space \space{}
12322 \begin_inset Quotes eld
12326 \begin_inset space \space{}
12338 \begin_inset Quotes erd
12344 \begin_layout Enumerate
12346 \begin_inset Quotes eld
12350 \begin_inset Quotes erd
12353 section in both packages.
12354 To put acknowledgments, just use the
12355 \begin_inset Quotes eld
12359 \begin_inset Quotes erd
12365 \begin_layout Enumerate
12366 Appendices may be added to the paper,
12370 the Acknowledgments and
12375 LyX provides a special environment, called
12376 \begin_inset Quotes eld
12380 \begin_inset Quotes erd
12383 which marks the beginning of the appendices.
12384 This environment should be left blank; it just sends a
12386 command, but nothing is really printed.
12388 \begin_inset Quotes eld
12392 \begin_inset Quotes erd
12395 is printed with blue letters, as a signal that all sections after that
12396 point are appendices.
12397 To write an appendix, use the
12398 \begin_inset Quotes eld
12402 \begin_inset Quotes erd
12406 LyX will number each appendix with capital letters, as required by both
12409 \begin_inset Quotes eld
12413 \begin_inset Quotes erd
12420 be present before the first appendix; if not, all appendices will be numbered
12421 as normal sections in the output.
12424 \begin_layout Enumerate
12433 command to implement table captions.
12434 As a result, a table created by LyX is printed correctly, but its caption
12436 However, you can use some TeX code to overpass this problem, so that captions
12437 are printed as expected.
12438 To do so, create a float table as usual, remove the caption, and replace
12439 it with the TeX code
12451 (sic); you must also the TeX code
12455 immediately after the tabular material.
12456 Study the example table included in the template files to see how this
12457 trick is implemented.
12458 Alternatively, If you need table captions, you should implement the whole
12464 file, then include this file to the LyX document (
12466 Insert\SpecialChar \menuseparator
12467 File\SpecialChar \menuseparator
12469 \begin_inset space ~
12475 Details on how to create a table float can be found in the files
12491 , included in the corresponding packages.
12494 \begin_layout Subsection
12495 Preparing a paper for submission
12498 \begin_layout Standard
12499 Before you submit your paper you must export the LyX document as a
12503 File\SpecialChar \menuseparator
12504 Export\SpecialChar \menuseparator
12512 \begin_layout Plain Layout
12513 Actually you have the choice between
12518 If you intend to use
12520 to prepare the paper, you should use the
12522 option so that included graphics are converted to
12524 format, ready for use by
12531 , then make the following changes to the resulting
12539 \begin_layout Enumerate
12540 Remove the comment lines before the
12550 \begin_layout Enumerate
12551 Remove everything between (and including) the
12565 commands, except for any commands you specifically put into the
12570 \begin_layout Standard
12576 file should be saved and processed through
12578 as many times as necessary.
12579 You may also want to check the resulting
12587 \begin_layout Subsection
12591 \begin_layout Standard
12592 The use of TeX code is reduced to two commands, which must be placed at
12593 the top of the document.
12594 If you started writing your paper by using the
12606 template, the TeX code needed is already in its place; you usually don't
12608 You may only modify the first TeX code to specify the information printed
12609 to the top of odd and even pages (
12611 names and short paper's title, respectively).
12612 This TeX code must have the form
12620 Names}{Short Paper's Title}
12625 \begin_layout Section
12630 \begin_layout Standard
12638 \begin_layout Subsection
12642 \begin_layout Standard
12645 package provides a document class to create electronic manuscript submission
12646 to the journals published by the Institute of Physics.
12647 Instructions for the authors how to create a paper using the
12649 class can be downloaded together with the
12651 package from the site
12652 \begin_inset Flex URL
12655 \begin_layout Plain Layout
12657 ftp://ftp.iop.org/pub/journals/latex2e
12665 \begin_layout Subsection
12669 \begin_layout Standard
12670 The easiest way to write a paper is to start with the file
12676 that is available in LyX's examples files folder.
12677 Open this file, save it under a new name, and start writing.
12678 The example file explains how to use the special text environments.
12679 Here are the most important advices:
12682 \begin_layout Itemize
12683 To be able to compile your document to a
12687 , assure that the two options
12693 in the document settings under
12700 \begin_layout Itemize
12703 The title environment defines the kind of your paper.
12704 So use one of the following environments for the title:
12708 \begin_layout Itemize
12717 \begin_layout Itemize
12726 \begin_layout Itemize
12732 for a Topical review
12735 \begin_layout Itemize
12744 \begin_layout Itemize
12753 \begin_layout Itemize
12759 for a Paper (same as Title)
12762 \begin_layout Itemize
12768 for a Preliminary communication
12771 \begin_layout Itemize
12777 for a Rapid communication
12780 \begin_layout Itemize
12786 for a Letter to the editor
12790 \begin_layout Itemize
12793 All title environments except of
12797 can have an optional short title.
12800 \begin_layout Itemize
12801 There is a general title environment
12805 which is not directly supported by the LyX.
12806 This can be used as TeX code when your document doesn't fit into one of
12807 the other title types.
12810 \begin_layout Standard
12813 like hints for special table and formula formatting, look at the
12818 \begin_layout Section
12823 \begin_layout Standard
12831 \begin_layout Subsection
12835 \begin_layout Standard
12838 package is a set of macros produced by
12840 Academic Publishers that facilitates electronic manuscript submission to
12841 the journals they publish.
12842 Most known of them (at least in my domain of interest) are
12844 Astrophysics and Space Science
12850 , but there are many others (see a complete list at
12851 \begin_inset Flex URL
12854 \begin_layout Plain Layout
12856 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12864 package may be downloaded from the site
12865 \begin_inset Flex URL
12868 \begin_layout Plain Layout
12870 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12876 A complete user guide is contained in that package (but it can also be
12877 downloaded separately).
12880 \begin_layout Standard
12881 LyX supports many features of the package but not everything.
12882 However, the TeX code needed is reduced to some
12883 \begin_inset Quotes eld
12887 \begin_inset Quotes erd
12890 commands of the package (see
12891 \begin_inset space ~
12895 \begin_inset CommandInset ref
12897 reference "subsec:kluwer_peculiarities"
12902 I have recently used LyX to write an article submitted to the
12904 Astrophysics and Space Science
12906 without any problem.
12909 \begin_layout Subsection
12913 \begin_layout Standard
12914 The easiest way to write a paper is to start with the
12919 File\SpecialChar \menuseparator
12933 This will give an (almost) empty document that includes the most common
12934 fields found in a manuscript and a short description of their use.
12935 As in most templates, simply overwrite the existing text (including the
12940 ) with the correct information.
12943 \begin_layout Subsection
12944 Preparing a paper for submission
12947 \begin_layout Standard
12950 package, before you submit your paper to a journal you must
12951 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12963 \begin_layout Enumerate
12964 Export your paper as a
12967 To do this, click on
12969 File\SpecialChar \menuseparator
12970 Export\SpecialChar \menuseparator
12978 \begin_layout Enumerate
12984 file with a text editor and make the following changes
12988 \begin_layout Enumerate
12989 remove the comment lines before the
12999 \begin_layout Enumerate
13000 remove everything between (and including) the
13014 commands, except for any commands you specifically put into the
13019 \begin_layout Standard
13029 \begin_layout Enumerate
13037 as many times as necessary (usually up to three).
13040 \begin_layout Enumerate
13047 \begin_inset space \thinspace{}
13051 \begin_inset space \space{}
13058 , and check if everything is OK (it should, if you didn't make any mistake).
13061 \begin_layout Subsection
13062 \begin_inset Quotes eld
13066 \begin_inset Quotes erd
13072 \begin_inset CommandInset label
13074 name "subsec:kluwer_peculiarities"
13081 \begin_layout Standard
13084 package has the following
13085 \begin_inset Quotes eld
13089 \begin_inset Quotes erd
13095 \begin_layout Enumerate
13096 It is possible to write multiple articles in the same
13102 \begin_layout Plain Layout
13103 I can't imagine any good reason to do this.
13109 Each article must be included in the environment
13110 \begin_inset Quotes eld
13114 \begin_inset Quotes erd
13118 Unfortunately, this environment cannot be omitted, even if you write just
13120 Therefore, each article starts with the command
13126 and, obviously, ends with the command
13133 Although this can be implemented in LyX, I didn't included it, since it
13134 looks ugly and can confuse the novice user.
13135 Therefore, you need to enter them directly and mark them as
13137 code (the well-known
13138 \begin_inset Quotes eld
13142 \begin_inset Quotes erd
13148 \begin_layout Enumerate
13149 Information given at the beginning of the article (i.
13150 \begin_inset space \thinspace{}
13154 \begin_inset space \space{}
13157 title, subtitle, author, institution, running title, running author, abstract
13158 and keywords) must be included in an environment called
13159 \begin_inset Quotes eld
13163 \begin_inset Quotes erd
13167 This is not implemented in LyX, so you must enter title, subtitle etc.
13168 \begin_inset space ~
13171 between two TeX code lines (
13186 \begin_layout Enumerate
13187 According to the user manual, the label of each bibliography item must be
13213 \begin_layout Standard
13220 template takes care of all these
13221 \begin_inset Quotes eld
13225 \begin_inset Quotes erd
13229 If you start a new paper using this template you don't need to do anything
13234 \begin_layout Enumerate
13235 don't delete the TeX code included in the template, and
13238 \begin_layout Enumerate
13239 copy the example bibliography item included in the template and modify it
13240 as necessary to enter new bibliography items.
13243 \begin_layout Section
13249 \begin_layout Standard
13257 \begin_layout Subsection
13261 \begin_layout Standard
13262 The LyX document classes
13321 \begin_inset space ~
13327 They are replacements for the standard document classes
13347 , resp., and fit better to European typography conventions in a number of
13351 \begin_layout Itemize
13352 Standard character size is
13383 \begin_layout Itemize
13384 Headings, labels of the description environment, and a number of elements
13391 document class are set in a bold sans serif font.
13395 \begin_layout Plain Layout
13396 There is a big difference between the bold sans serif old cm fonts and new
13399 fonts, especially in the appearance of headings.
13402 bold sans serif fonts look a bit thin.
13414 helps to produce the
13415 \begin_inset Quotes eld
13419 \begin_inset Quotes erd
13422 appearance when using the
13429 The numbering of chapter headings is made in the same way as the numbering
13430 of section headings, that is without the extra line
13431 \begin_inset Quotes eld
13434 Chapter\SpecialChar \ldots{}
13436 \begin_inset Quotes erd
13440 In addition, the appearance of the headings can be modified by using a
13441 number of options (in LyX to be entered in the field
13444 \begin_inset space ~
13451 Layout\SpecialChar \menuseparator
13455 A detailed German description of these options can be found in the
13457 -Script documentation
13464 \begin_layout Itemize
13465 The main means in the
13467 -Script document classes to design the type area are the options
13475 (in LyX to be entered in the extra class options field in the dialog
13477 Document\SpecialChar \menuseparator
13481 They make a clearer modification of page margins possible as do the options
13484 Document\SpecialChar \menuseparator
13488 A detailed German description of these and other type area options can
13491 -Script documentation
13498 \begin_layout Itemize
13501 document classes of the
13503 -Script family define a number of additional commands.
13504 Those part of it which makes sense in LyX is implemented in corresponding
13508 \begin_layout Standard
13509 A detailed German description of the
13511 document classes of the
13513 -Script family can be found in the
13515 -Script documentation
13523 \begin_layout Plain Layout
13524 There is an English translation
13528 , but it is not a complete one.
13533 The following sections describe only those aspects, which are relevant
13537 \begin_layout Subsection
13542 -script), and book (
13547 \begin_layout Standard
13548 The document classes
13570 are implemented in the layout files
13586 They contain all the paragraph types of the corresponding standard document
13599 , resp., partly modified, with the exception of the LyX specific
13603 -type, which is replaced by the new
13607 -type having the same functionality.
13612 -Type there is a number of new paragraph types added.
13626 \begin_layout Itemize
13637 : are equivalents to
13645 , resp., additionally inserting an entry in the table of contents.
13654 are not contained in
13663 \begin_layout Itemize
13674 : behave exactly as
13682 , resp., additionally clearing running heads.
13688 is not contained in
13698 \begin_layout Plain Layout
13719 , but since this is identical to
13723 , is has not been implemented in LyX.
13731 \begin_layout Itemize
13736 : generates a heading directly above the following paragraph in the standard
13737 character size without affecting the structure of the document.
13740 \begin_layout Itemize
13749 are special captions which respect the different space settings needed
13750 for captions placed above or below an element (if you follow strict typographic
13751 rules, you might want to place table captions always above the table).
13752 You can also use the class option
13756 , which will switch
13776 \begin_layout Itemize
13781 : can be used to set a
13784 \begin_inset space \thinspace{}
13788 \begin_inset space \space{}
13791 at the beginning of a chapter.
13792 If you use the optional argument (
13794 Insert\SpecialChar \menuseparator
13796 \begin_inset space ~
13801 ), you can insert the dictum's author there.
13802 Dictum and author are separated by a line.
13812 is not contained in
13821 \begin_layout Standard
13822 The following types, together with the standard types
13834 , form the title area of the document.
13835 They must be entered ahead of the first
13836 \begin_inset Quotes eld
13840 \begin_inset Quotes erd
13847 \begin_layout Plain Layout
13850 commands must appear before the
13862 When such a type is used more than once, the latter usage overwrites the
13863 former one, that means, for every type only the latest usage is valid.
13864 The order of the different types however has, like
13876 , no effect on the appearance of the produced document.
13879 \begin_layout Itemize
13884 : produces a centered paragraph above the ordinary title (
13896 ) for the subject of the document.
13899 \begin_layout Itemize
13904 : produces a centered paragraph below the ordinary title (
13921 \begin_layout Itemize
13938 produces a centered paragraph on its own page behind the title page, or
13945 produces a centered paragraph below the ordinary title (
13961 ) for a dedication.
13964 \begin_layout Itemize
13969 : produces a left aligned paragraph above the ordinary title (
13985 ) for a document`s head.
13988 \begin_layout Itemize
13993 : produces in a double-sided print in
14005 a left-aligned paragraph at the top of the title page`s back or has no
14006 effect in a single-sided print or in
14015 \begin_layout Itemize
14020 : produces in a double-sided print in
14032 a left-aligned paragraph at the bottom of the title page`s back or has
14033 no effect in a single-sided print or in
14042 \begin_layout Itemize
14047 : produces a special
14048 \begin_inset Quotes eld
14052 \begin_inset Quotes erd
14055 page ahead of the actual document containing a paragraph without special
14059 \begin_layout Standard
14060 The layout files for the document classes
14078 do include the file
14084 This is thought of as a place to define your own types.
14090 in your personal layout directory and edit the file!
14093 \begin_layout Subsection
14099 \begin_layout Standard
14103 \begin_layout Plain Layout
14115 \begin_layout Standard
14123 is implemented in the layout file
14129 It contains all the paragraph types of the corresponding standard document
14134 , partly modified, with the exception of the LyX specific types
14146 type, which is replaced by the new
14151 In addition, it contains, in contrast to the standard document class, the
14169 Furthermore, there are a number of new letter specific types.
14172 \begin_layout Standard
14176 \begin_layout Plain Layout
14188 \begin_layout Standard
14189 The appearance of the letter produced by this document class can be controlled
14192 commands, which you can put in the
14198 \begin_layout Plain Layout
14199 For example, the standard appearance of the letter`s heading, consisting
14200 of name and address, is quite self-willed.
14202 \begin_inset Quotes eld
14206 \begin_inset Quotes erd
14209 heading is produced by the following
14211 commands in the preamble:
14214 \begin_layout LyX-Code
14230 \begin_layout LyX-Code
14254 \begin_layout LyX-Code
14270 \begin_layout LyX-Code
14302 A detailed German description of such
14304 commands can be found in the
14306 -Script documentation
14311 With it, the letter's author can produce his personal letter layout.
14314 \begin_layout Standard
14323 define the beginning of the letter and must be used in every letter.
14324 To emphasize them in the LyX document class, they are marked with the letter
14334 \begin_inset space ~
14337 in the left margin.
14338 It is possible to write any number of letters in one file.
14343 type produces a new letter using the same addressee and a
14347 type produces a new addressee.
14364 are ordinary paragraph types and can also be used several times in one
14365 and the same letter.
14368 \begin_layout Itemize
14373 : produces a paragraph for the addressee and implicitly defines the beginning
14377 \begin_layout Itemize
14382 : produces a paragraph for the form of address and implicitly produces a
14386 \begin_layout Itemize
14391 : produces a paragraph for a close.
14394 \begin_layout Itemize
14399 : produces a paragraph for a postscript.
14402 \begin_layout Itemize
14407 : produces a paragraph for a distribution list.
14410 \begin_layout Itemize
14415 : produces a paragraph for enclosures.
14418 \begin_layout Standard
14459 are input types provided with a label to enter information, which will
14460 be processed by the document class.
14464 \begin_layout Plain Layout
14465 It could be seen as a matter of
14475 described above are not such input types as well.
14476 Because of the special meaning of those types, however, I have implemented
14477 them as ordinary paragraph types with a one letter mark in the left margin.
14478 Moreover, it would affect my feeling of symmetry, if the
14486 type had such a serious different appearance.
14491 The types must be used ahead of the corresponding
14498 \begin_layout Standard
14499 An implementation of these types in a WYSIWYG fashion does not seem to make
14500 sense, because the real appearance of the produced letter does not only
14501 depend on the usage of the particular type, but also on other factors.
14502 For example, a signature entered in the
14506 type will in the standard behavior appear in the produced letter only,
14507 when in the same letter also a
14512 The entered value of the
14516 type will in the standard behavior not appear in the produced letter at
14518 The possibility to design the letter`s heading freely is already indicated
14519 in a footnote above.
14522 \begin_layout Standard
14523 The input types can also be used as empty paragraphs.
14524 This makes sense e.
14525 \begin_inset space \thinspace{}
14529 \begin_inset space \space{}
14541 type is not used at all, in the standard behavior the value of the
14545 type is used as signature, whereas if an empty
14549 type is used, no signature value is defined.
14552 \begin_layout Standard
14553 By using the input types it is possible to write a letter template, containing
14554 filled input types with your personal dates (name, address, etc.) and empty
14555 input types for other dates you want to enter.
14558 \begin_layout Itemize
14563 : sender's name, in the standard behavior appears as a centered paragraph
14564 in small caps in the letter`s heading.
14567 \begin_layout Itemize
14572 : sender's signature, in the standard behavior appears below the
14581 type is used, the value of the
14585 type appears instead.
14588 \begin_layout Itemize
14593 : sender's address, in the standard behavior appears in a centered paragraph
14594 in the letter`s heading below the sender's name.
14597 \begin_layout Itemize
14602 : sender's telephone number, in the standard behavior only sets the
14614 \begin_layout Itemize
14619 : place of the letter`s making.
14622 \begin_layout Itemize
14627 : date of the letter`s making.
14636 , in the standard behavior, produce the place and the date in a right-aligned
14637 line below the addressee's field.
14642 type is used, neither place nor date appear, independent of the value of
14652 type is used, the date of the letter `s production is used.
14655 \begin_layout Itemize
14660 : sender`s back address, in the standard behavior appears above the addressee's
14661 field in a small sans serif font.
14664 \begin_layout Itemize
14669 : special mail information, in the standard behavior appears underlined
14670 above the addressee's field below the back address.
14673 \begin_layout Itemize
14678 : additional information, in the standard behavior appears on right side
14679 below the addressee`s field.
14682 \begin_layout Itemize
14687 : the letter's title, in the standard behavior appears in a big, bold, sans
14688 serif font above the subject.
14691 \begin_layout Itemize
14696 : the letter's subject, in the standard behavior appears in a bold font
14704 \begin_layout Standard
14725 produce a business letter like line above the
14729 line containing the fields
14730 \begin_inset Quotes eld
14734 \begin_inset Quotes erd
14738 \begin_inset Quotes eld
14742 \begin_inset Quotes erd
14746 \begin_inset Quotes eld
14750 \begin_inset Quotes erd
14754 \begin_inset Quotes eld
14758 \begin_inset Quotes erd
14762 \begin_inset Quotes eld
14766 \begin_inset Quotes erd
14770 \begin_inset Quotes eld
14774 \begin_inset Quotes erd
14778 For the date field, the value of the
14784 \begin_inset Quotes eld
14787 business letter types
14788 \begin_inset Quotes erd
14791 is used, the value of the
14795 type however does not appear, but only the
14805 The ordinary output of place and date in a right-aligned line below the
14806 addressee`s field is suppressed.
14807 The types are implemented as input types provided with a label and must
14808 be used ahead of the corresponding
14815 \begin_layout Itemize
14823 \begin_layout Itemize
14831 \begin_layout Itemize
14839 \begin_layout Itemize
14847 \begin_layout Itemize
14855 \begin_layout Subsection
14856 The new letter class: letter (
14861 \begin_layout Standard
14864 Jürgen Spitzmüller
14867 \begin_layout Standard
14868 \begin_inset VSpace medskip
14874 \begin_layout Standard
14878 -Script version 2.8 has introduced a new letter class
14882 which supersedes the now unsupported
14889 side — a completely new interface and is not compatible with the old class.
14890 Therefore, LyX supports both, though it is recommended to use the new class.
14893 \begin_layout Standard
14894 This class covers the same functionality as
14901 The basic items are
14905 (receiver's address, same as
14909 in the old layout),
14922 will start a new letter (i.
14923 \begin_inset space \thinspace{}
14927 \begin_inset space \space{}
14930 you can write several letters per document).
14931 New elements are sender's
14947 and the possibility to use a
14953 Insert\SpecialChar \menuseparator
14959 \begin_layout Standard
14960 The biggest improvement is, though, that the letter's layout is configurable
14961 at almost any needs.
14962 This can be done via the preamble or with a special style file (Letter
14963 Class Option, extension
14968 ), that will be read in as a class option.
14972 \begin_layout Plain Layout
14975 package comes with some default
14981 There is, for instance, a
14988 typesetting rules, or a
14994 that provides the default layout of the old
14999 The latter can be loaded with the class option
15008 ayout\SpecialChar \menuseparator
15013 ocument\SpecialChar \menuseparator
15027 template that is included in LyX for examples.
15028 A detailed description is to be found in the
15030 -Script documentation (
15037 \begin_layout Subsection
15041 \begin_layout Standard
15044 -Script document classes in LyX, the LyX internals cause some problems.
15047 \begin_layout Itemize
15048 The chapter number of a
15052 type appears on a line of its own above the chapter heading instead of
15053 appearing in the same line ahead of it.
15054 The cause for that is the LyX internal behavior for the
15060 in the layout file.
15063 \begin_layout Itemize
15064 The headings of the types
15072 are only put in the
15073 \begin_inset Quotes eld
15077 \begin_inset Quotes erd
15082 table of contents, but not in the LyX table of contents (
15084 Document\SpecialChar \menuseparator
15086 \begin_inset space ~
15090 \begin_inset space ~
15098 \begin_layout Itemize
15099 The paragraphs in a
15103 document class appear in a skip separation mode, not indented.
15104 This is the standard behavior, no special
15106 commands are needed for that.
15109 Document\SpecialChar \menuseparator
15112 dialog the corresponding radio button indicates
15121 value always has the effect that extra
15123 commands are inserted in the document to produce the gap, which is not
15124 what is wanted in this case.
15127 \begin_layout Section
15135 \begin_layout Standard
15141 \begin_layout Subsection
15145 \begin_layout Standard
15146 Since this class is specifically for writing submissions to
15148 sponsored conferences I strongly recommend that you get a copy of their
15154 package and associated bibliography style file is included in the kit.
15155 The Authors Kit is usually sent out by email once your initial submission
15157 There is a lot of useful information in the Authors Kit explaining formatting
15158 restrictions and so on and I will assume you have read this since that
15159 means I don't have to repeat it all here.
15162 \begin_layout Subsection
15166 \begin_layout Standard
15167 [AR\SpecialChar \@.
15171 \begin_layout Subsection
15172 Supported Environments
15175 \begin_layout Itemize
15181 \begin_layout Itemize
15187 \begin_layout Itemize
15193 \begin_layout Itemize
15199 \begin_layout Itemize
15205 \begin_layout Itemize
15211 \begin_layout Itemize
15217 \begin_layout Itemize
15223 \begin_layout Itemize
15229 \begin_layout Subsection
15230 Differences Between Screen and Paper
15233 \begin_layout Standard
15234 There are slight differences in appearance mainly with the presentation
15235 of section counters.
15236 On screen the trailing period of the section counter is missing but it
15237 will appear in the output so don't let this worry you.
15240 \begin_layout Section
15244 \begin_layout Standard
15247 Jürgen Spitzmüller
15250 \begin_layout Subsection
15254 \begin_layout Standard
15255 Memoir is a very powerful and constantly evolving class.
15256 It has been designed with regard to fictional and non-fictional literature.
15257 Its aim is to let the user have maximum control over the typesetting of
15259 Memoir is based on the standard book class, but it can also emulate the
15260 article class (see below).
15263 \begin_layout Standard
15264 Peter Wilson, the developer of Memoir, is known as the author of lots of
15265 useful packages in the
15268 Most of them have been merged with Memoir.
15269 Therefore, it is much easier to layout the table of contents, appendices,
15270 chapter designs and such.
15271 LyX, though, does not support all of these goodies
15274 Some of them might be added to forthcoming releases
15278 \begin_layout Plain Layout
15279 You are invited to send suggestions to
15280 \begin_inset Flex URL
15283 \begin_layout Plain Layout
15285 lyx-devel@lists.lyx.org
15295 , lots will probably never, due to the limitations of LyX's framework.
15296 Of course you can still use all features with the help of some native
15302 \begin_layout Plain Layout
15307 \begin_layout Plain Layout
15317 \begin_inset space ~
15321 \begin_inset CommandInset ref
15323 reference "sec:Inserting-TeX-Code"
15333 In this section, we can only list those features which are
15336 For detailed descriptions (and for the rest of features) we are recommending
15337 to have a look at the detailed manual of the Memoir class
15341 \begin_layout Plain Layout
15346 \begin_layout Plain Layout
15356 \begin_inset Flex URL
15359 \begin_layout Plain Layout
15361 CTAN:/macros/latex/memoir/memman.pdf
15371 , which is not only a user guide for the class, but also both a comprehensive
15372 description on good typesetting and a superb example for good typesetting
15376 \begin_layout Subsection
15377 Basic features and restrictions
15380 \begin_layout Standard
15381 Memoir supports basically all features of the standard book classes.
15382 There are, however, some differences, as follows:
15385 \begin_layout Description
15387 \begin_inset space ~
15390 sizes: Memoir has a broader range of font sizes: 9,
15402 \begin_layout Description
15404 \begin_inset space ~
15407 style: The fancy page style is not supported, due to a command clash between
15410 package (they are both defining a command with the same name, which confuses
15414 Instead, Memoir comes with a bunch of own page styles (see
15416 Layout\SpecialChar \menuseparator
15417 Document\SpecialChar \menuseparator
15419 \begin_inset space ~
15425 If you want to use these for the chapter pages, you have to use the command
15433 in the main text or in preamble (e.
15434 \begin_inset space \thinspace{}
15438 \begin_inset space \space{}
15452 \begin_layout Description
15455 (chapter, section, subsection etc.) are coming with an optional argument
15456 in the standard classes.
15457 With this, you can specify an alternative version of the title for the
15458 table of contents and the headers (for instance, if the title is too long).
15459 In LyX, you can do this via
15461 Insert\SpecialChar \menuseparator
15463 \begin_inset space ~
15468 at the beginning of a chapter/section.
15469 Memoir features a second optional argument and thus separates the table
15470 of contents from the header.
15471 You can define three variants of a title with this: one for the main text,
15472 one for the table of contents, and one for the headers.
15473 Simply insert two optional arguments if you need this feature, the first
15474 one containing the short title for the Table of Contents, the second one
15475 containing an alternative short title for the headers.
15478 \begin_layout Description
15483 : In the standard classes (and in many other classes), the table of contents,
15484 the list of figures and the list of table start a new page automatically.
15485 Memoir does not follow this route.
15486 You have to insert a page break yourself, if you want to have one.
15489 \begin_layout Description
15492 : For some unknown reason, Memoir uses pagination on the title page (in
15493 the standard classes, title pages are
15494 \begin_inset Quotes eld
15498 \begin_inset Quotes erd
15502 \begin_inset space \thinspace{}
15506 \begin_inset space \space{}
15512 If you want an empty title page, type
15523 \begin_layout Description
15524 Article: With the class option
15530 Layout\SpecialChar \menuseparator
15531 Document\SpecialChar \menuseparator
15533 \begin_inset space ~
15538 ), you can emulate article style.
15539 That is, counters (footnotes, figures, tables etc.) will not be reset on
15540 new chapters, chapters don't start a new page (but are—in contrary to
15541 \begin_inset Quotes eld
15545 \begin_inset Quotes erd
15548 article classes—still allowed), parts, though, use their own page, as in
15552 \begin_layout Description
15555 : By default, Memoir does not allow the use of the deprecated font commands,
15556 which have been used in the old
15561 \begin_inset space \thinspace{}
15565 \begin_inset space \space{}
15581 It produces an error and stops
15583 whenever such a command appears.
15590 the commands and spits out warnings instead (which does at least not stop
15594 Since a lot of packages and particularly
15596 style files are still using those commands, we have decided to use this
15600 \begin_layout Subsection
15604 \begin_layout Standard
15605 We will only describe the features supported by LyX (which is not much currently
15607 Please consult the Memoir manual
15611 \begin_layout Plain Layout
15616 \begin_layout Plain Layout
15626 \begin_inset Flex URL
15629 \begin_layout Plain Layout
15631 CTAN:/macros/latex/memoir/memman.pdf
15644 \begin_layout Description
15645 Abstract: You may wonder why an abstract is an extra feature.
15646 Well, it is in book class.
15647 Usually books don't have abstracts.
15648 Memoir, however, has.
15649 You can use it wherever and how often you like.
15652 \begin_layout Description
15655 : You may know this from belletristic: The contents of a chapter is shortly
15656 described below the title and also in the table of contents (e.
15657 \begin_inset space \thinspace{}
15661 \begin_inset space \space{}
15666 Our hero arrives in
15668 ; he loses some friends; he finds others
15674 It is therefore only sensible below a chapter.
15677 \begin_layout Description
15678 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15679 The epigraph environment provides an elegant way of typesetting such a
15681 The motto itself (text) and its author (source) are divided by a short
15683 Unfortunately, we have to fool LyX a bit here again, since the environment
15684 needs two arguments (text and source).
15685 In this case, we have to use curly brackets (in TeX mode) between the two
15696 <author of the slogan>.
15699 \begin_layout Description
15702 : Memoir has lots of possibilities to typeset poetry (up to very complex
15704 LyX can only support a few of them.
15707 , which is a centered title for poems, which will also be added to the table
15708 of contents (verse is the standard environment for poems.
15709 Memoir has some enhanced versions of verse, but you need to use TeX code,
15710 because they have to be nested inside regular verse environments, which
15711 is not possible with LyX).
15714 \begin_layout Description
15719 , but it adds no entry to the table of contents.
15722 \begin_layout Section
15730 \begin_inset OptArg
15733 \begin_layout Plain Layout
15746 \begin_layout Standard
15754 \begin_layout Standard
15755 The LyX document classes
15798 They are replacements for the standard document classes
15813 , resp., and fit better to Polish typography conventions in a number of points.
15817 \begin_layout Standard
15821 \begin_layout Itemize
15822 Unnumbered titles (with star, e.
15823 \begin_inset space \thinspace{}
15827 \begin_inset space \space{}
15834 ) are added into table of contents,
15837 \begin_layout Itemize
15838 Additional page styles:
15842 \begin_layout Description
15845 header with separated lines,
15848 \begin_layout Description
15851 custom header, contents headers via commands:
15868 \begin_layout Description
15871 custom header with separated lines,
15874 \begin_layout Description
15875 outer page number is placed on outer side of page
15879 \begin_layout Itemize
15884 \begin_layout Description
15887 serif titles — default,
15890 \begin_layout Description
15898 \begin_layout Description
15901 on title page first placed is author next title — default,
15904 \begin_layout Description
15907 on title page first placed is title next author,
15910 \begin_layout Description
15913 reserve place on page for margins.
15917 \begin_layout Section
15921 \begin_layout Standard
15926 provides an alternative to the standard
15931 It provides similar functionality, but you might prefer this layout with
15932 sans serif sections, headings, and more.
15935 \begin_layout Section
15940 \begin_layout Standard
15948 \begin_layout Standard
15949 \begin_inset VSpace bigskip
15955 \begin_layout Standard
15961 \begin_inset space ~
15968 works with the American Physical
15973 \begin_inset Formula $\beta$
15981 \begin_layout Standard
15993 .1 is basically obsolete, as it works with
15998 That means that it doesn't interact very well with LyX, which requires
16001 , although it has been kludged to work.
16004 4.0 has been designed to work much more cleanly with
16010 \begin_inset space ~
16017 should also be pretty easy to use.
16020 \begin_layout Standard
16021 These documents are supposed to be used in
16027 4.0 documents, so we don't describe any of the special
16029 macros, and assume you'll know what to put in the preamble if necessary.
16032 \begin_layout Subsection
16036 \begin_layout Standard
16037 All you need to do is install
16039 4, as described in the package's
16042 The package can be found at The
16045 \begin_inset Flex URL
16048 \begin_layout Plain Layout
16050 http://publish.aps.org/revtex4/
16056 Install it somewhere that
16059 Test it by trying to
16063 4 document in some random directory (i.
16064 \begin_inset space \thinspace{}
16068 \begin_inset space \space{}
16071 not the directory where you installed the class file.) Then, if you reconfigure
16072 LyX, it will find the class file and let you use the
16079 \begin_layout Standard
16080 Probably the easiest way to get started is either to import a
16090 \begin_inset space ~
16095 template, found in the templates directory.
16098 \begin_layout Subsection
16102 \begin_layout Standard
16103 Optional arguments to
16111 \begin_inset Quotes eld
16117 \begin_inset Quotes erd
16121 \begin_inset Quotes eld
16127 \begin_inset Quotes erd
16137 \begin_inset space ~
16145 \begin_inset space ~
16153 , at least one optional argument is required!
16156 \begin_layout Standard
16157 Other preamble matter, like
16164 \begin_inset space ~
16171 \begin_inset space ~
16176 dialog, also as usual.
16179 \begin_layout Subsection
16183 \begin_layout Standard
16184 The layouts basically correspond to the commands in
16187 For example, the Email layout corresponds to
16194 Note that (at least as of
16204 layouts are exactly equivalent, so you shouldn't need to use both.
16208 \begin_layout Plain Layout
16209 In case you're curious, both were included so that
16213 would be able to translate both
16233 \begin_layout Subsection
16237 \begin_layout Standard
16238 There are a couple of important unique aspects of
16240 4 which might cause bugs that will be even more confusing in LyX.
16243 \begin_layout Standard
16263 The LyX equivalent is that there is a separate Thanks layout.
16268 write footnotes in the
16272 layout, or weird things may happen.
16275 4 documentation for more details.
16278 \begin_layout Standard
16282 \begin_inset space ~
16290 \begin_inset space ~
16299 layouts must be placed
16307 layout and the corresponding
16329 \begin_layout Subsection
16333 \begin_layout Standard
16334 The main problem with this layout is that you can't use the optional arguments
16335 to layouts like Email and Title.
16336 (The problem is not unique to this layout; you can't use optional arguments
16337 to the Section layouts either.) This means that after you export that file
16340 (which you'll need to do eventually to send it in to
16342 ), you'll need to edit the
16344 file with a text editor to add the optional arguments to set, e.
16345 \begin_inset space \thinspace{}
16349 \begin_inset space \space{}
16352 the running title for the page headers.
16353 Lacking these layouts makes the
16360 (and the equivalent
16367 ) useless, so the corresponding layouts don't exist, and will have to be
16372 \begin_layout Plain Layout
16379 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
16380 has not been updated yet to take advantage of it.
16388 \begin_layout Section
16389 Springer Journals (
16396 \begin_layout Standard
16402 \begin_layout Subsection
16406 \begin_layout Standard
16407 These are the layout files for some of the journal formats used by Springer
16411 \begin_inset Flex URL
16414 \begin_layout Plain Layout
16416 http://www.springer.de/author/tex/help-journals.html
16421 , where you should also go to fetch the class files (yes, these are
16424 It is a modular system: the things common to all journals are implemented
16430 , which journal-specific layout files (such as, e.
16431 \begin_inset space \thinspace{}
16435 \begin_inset space \space{}
16443 for Journal of Geodesy) can include.
16446 \begin_layout Standard
16447 This means that implementing support for any other Springer journal on this
16448 list is as simple as writing your own
16458 file following the outline given in
16467 \begin_layout Standard
16468 It is reasonably well tested only for the Journal of Geodesy.
16477 come with the standard LyX distribution.
16478 Install the relevant class file (downloaded from Springer) in a proper
16479 directory, reconfigure
16487 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
16488 and it should work.
16491 \begin_layout Subsection
16495 \begin_layout Standard
16496 A large number of theorem-like styles —
16502 \SpecialChar \ldots{}
16508 \begin_layout Standard
16511 Headnote, Dedication, Subtitle, Running_
16513 _Title, Author_Running, Institute, Mail, Offprints, Keywords,
16519 See the Springer class file documentation for details.
16522 \begin_layout Subsection
16526 \begin_layout Itemize
16539 \begin_layout Itemize
16542 Probability Theory and Related Fields
16553 \begin_layout Standard
16554 Add your own, it isn't so hard!
16557 \begin_layout Subsection
16561 \begin_layout Standard
16562 These files are partly based on the older
16567 , which was again based on a tinkered-with version of an old
16571 style file from Springer.
16576 layout, are now defunct.
16579 helped out big in making me find my way around the LyX layout file mechanism.
16582 \begin_layout Subsection
16586 \begin_layout Standard
16588 But probably less than in the old hacked-
16597 \begin_layout Standard
16599 \begin_inset space \thinspace{}
16602 g.: does not display the number for theorem-like layouts, just #.
16605 \begin_layout Section
16611 \begin_inset CommandInset label
16620 \begin_layout Standard
16628 \begin_layout Subsection
16632 \begin_layout Standard
16633 This section describes how to use LyX to make slides for overhead projectors.
16634 There are two document classes that can do this: the default slides class
16640 This section documents the former.
16643 \begin_layout Standard
16644 I'm going to say this again, nice and clear, so that there's no misunderstanding
16648 \begin_layout Standard
16649 \begin_inset VSpace bigskip
16655 \begin_layout Standard
16659 This section documents the class
16660 \begin_inset Quotes eld
16668 \begin_inset Quotes erd
16676 \begin_layout Standard
16677 \begin_inset VSpace bigskip
16683 \begin_layout Standard
16684 If you're looking for the documentation for
16685 \begin_inset Quotes eld
16695 \begin_inset Quotes erd
16698 , check out section
16699 \begin_inset space ~
16703 \begin_inset CommandInset ref
16705 reference "sec:foiltex"
16715 \begin_inset Quotes eld
16725 \begin_inset Quotes erd
16728 ] is actually somewhat better than the default
16736 \begin_layout Plain Layout
16737 \SpecialChar \ldots{}
16738 or so I've been told repeatedly by its advocates.
16739 Having never used it, I have no idea if this claim is true or not.
16744 which this section documents.
16747 \begin_layout Standard
16750 improvement of the old
16757 distribution includes this class [which I'll just refer to as
16758 \begin_inset Quotes eld
16766 \begin_inset Quotes erd
16769 from now on], so you're bound to have it.
16770 As I noted earlier, there are other classes, such as
16774 , which also produce slides for overhead projectors and do a better job
16776 However, there are some things which
16780 can do which the others can't, such as generate overlays.
16781 Read on to learn more!
16784 \begin_layout Subsection
16786 \begin_inset CommandInset label
16788 name "sec:slidesetup"
16795 \begin_layout Standard
16796 Obviously, to use this document class, you need to select
16797 \begin_inset Quotes eld
16805 \begin_inset Quotes erd
16808 from the class list in the
16810 Document\SpecialChar \menuseparator
16814 There are some other special things you should know about this class:
16817 \begin_layout Itemize
16818 Don't bother changing the options
16823 They're not supported by the
16830 \begin_layout Itemize
16834 \begin_inset space ~
16839 behaves a bit differently for this class.
16840 The possible choices and what they do are as follows:
16844 \begin_layout Description
16849 The final output contains page numbers in the lower right corner.
16852 \begin_layout Description
16861 , but also prints out any time markers you've put in.
16862 This is the default.
16865 \begin_layout Description
16870 The final output contains no page numbers, time markers, or alignment markers.
16874 \begin_layout Itemize
16879 class has an extra option:
16885 \begin_inset Quotes eld
16893 \begin_inset Quotes erd
16896 in the extra class options.
16900 \begin_layout Standard
16901 Using this options allows you to add time markers to
16907 \begin_inset space ~
16911 \begin_inset CommandInset ref
16913 reference "sec:slideNote"
16921 \begin_layout Standard
16922 You can also use the template file
16923 \begin_inset Quotes eld
16932 \begin_inset Quotes erd
16935 to automatically set up a document to use the
16941 File\SpecialChar \menuseparator
16943 \begin_inset space ~
16947 \begin_inset space ~
16952 to open your new document].
16953 The template file also contains some examples of the special paragraph
16954 environments used by this class.
16955 I'll describe those next.
16958 \begin_layout Subsection
16959 Paragraph Environments
16962 \begin_layout Subsubsection
16963 Supported Environments
16966 \begin_layout Standard
16967 The first thing you'll notice when you start up a new
16971 document is the font size and type: it's the equivalent of the size
16972 \begin_inset Quotes eld
16980 \begin_inset Quotes erd
16986 \begin_inset space ~
16992 This is also what's used in the output.
16994 \begin_inset Quotes eld
16998 \begin_inset Quotes erd
17001 to remind you that this is a slide.
17002 Your final slides will use a larger font; ergo, you'll have less space.
17003 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17006 \begin_layout Standard
17007 The next thing that becomes obvious is the changes to the paragraph environment
17008 pull-down box [at the far-left end of the toolbar].
17009 Most of the paragraph environments you're used to seeing are missing.
17010 There are also five new ones.
17015 class itself only supports certain paragraph environments:
17018 \begin_layout Itemize
17024 \begin_layout Itemize
17030 \begin_layout Itemize
17036 \begin_layout Itemize
17042 \begin_layout Itemize
17048 \begin_layout Itemize
17054 \begin_layout Itemize
17060 \begin_layout Itemize
17066 \begin_layout Itemize
17072 \begin_layout Itemize
17078 \begin_layout Itemize
17084 \begin_layout Standard
17085 All of the other standard environments, including the section-heading environmen
17086 ts, aren't used in the
17093 \begin_layout Standard
17094 On the other hand, you'll notice the following new environments:
17097 \begin_layout Itemize
17103 \begin_layout Itemize
17109 \begin_layout Itemize
17115 \begin_layout Itemize
17121 \begin_layout Itemize
17127 \begin_layout Standard
17128 These five are kind of quirky, due to a
17129 \begin_inset Quotes eld
17133 \begin_inset Quotes erd
17137 You see, LyX doesn't permit you to nest any other paragraph environment
17138 into an empty environment.
17139 Now, that's fine and dandy, but it means that you wouldn't be able to start
17140 a slide with anything except plain text.
17141 To deal with this, I've performed a little
17142 \begin_inset Quotes eld
17148 \begin_inset Quotes erd
17154 \begin_layout Subsubsection
17155 Quirks of the New Environments
17156 \begin_inset CommandInset label
17158 name "sec:slideQuirk"
17165 \begin_layout Standard
17166 All five of the new paragraph environments are somewhat quirky due to inherent
17169 in the current version of LyX.
17170 As I just mentioned, LyX forbids environments that begin with another environme
17172 To get around this, the
17176 environment isn't a paragraph environment as described in the
17184 \begin_layout Standard
17185 You should consider
17198 \begin_inset Quotes eld
17201 pseudo-environments.
17202 \begin_inset Quotes erd
17205 They look like a section heading or a
17206 \begin_inset Quotes eld
17214 \begin_inset Quotes erd
17217 but really begin a [and, if necessary, end the previous] paragraph environment.
17227 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17234 These two perform some action.
17237 \begin_layout Standard
17238 A common feature of all five environments,
17258 , is a rather long-
17261 The text following this label — ordinarily the contents of the paragraph
17262 environment — is utterly irrelevant for
17283 LyX completely ignores it.
17284 In fact, you can leave these five environments completely empty.
17288 \begin_layout Standard
17293 to put any text after the rather long-
17295 label, you might want to.
17296 This could be a short description of the contents of the
17301 In that case, enter in your descriptive comment and hit
17305 as you normally would.
17308 \begin_layout Standard
17309 If, on the other hand, you don't want to enter in any descriptive text,
17310 you'll hit another LyX quirk.
17311 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
17312 environment until you put something in the old one.
17316 \begin_layout Itemize
17317 Start entering the text that will
17345 \begin_layout Itemize
17346 Now move to the beginning of that paragraph.
17350 \begin_layout Itemize
17359 \begin_layout Itemize
17360 Finally, change this new, empty paragraph to a
17384 \begin_layout Standard
17385 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
17389 \begin_layout Subsection
17390 Making a Presentation with
17403 \begin_layout Subsubsection
17411 \begin_layout Standard
17412 If you're expecting this section to teach you how to actually make a presentatio
17413 n, you'll be sorely disappointed.
17414 Naturally, I'll describe all of the ways the
17418 class can assist you in preparing the materials for a presentation.
17419 Filling in the contents, however, is up to you.
17424 the LyX philosophy.]
17427 \begin_layout Standard
17432 environment [in the manner described in section
17433 \begin_inset space ~
17437 \begin_inset CommandInset ref
17439 reference "sec:slideQuirk"
17443 ] tells LyX to begin a new slide [duh].
17444 The label for this environment/
17445 \begin_inset Quotes erd
17449 \begin_inset Quotes erd
17453 \begin_inset Quotes eld
17457 \begin_inset Quotes erd
17460 in cool blue, followed by the label,
17461 \begin_inset Quotes eld
17467 \begin_inset Quotes erd
17471 Any text or paragraph environments that follow this one go on the new slide.
17475 \begin_layout Standard
17476 Slides are probably the only time you'll need to forcibly end pages in LyX
17477 (this can be specified in the
17482 In fact, you'll want to, once you finish entering the contents of one slide.
17483 If you've entered more text than can physically fit on a slide, the extra
17484 overflows onto a new slide.
17485 I don't recommend doing this, however, since the overflow slide won't have
17486 any page number on it.
17487 Furthermore, it may interfere with any
17491 you've made to accompany the
17500 \begin_layout Standard
17509 environments work the same way as the
17514 They both create an
17515 \begin_inset Quotes eld
17519 \begin_inset Quotes erd
17522 followed by a label [
17523 \begin_inset Quotes eld
17529 \begin_inset Quotes erd
17533 \begin_inset Quotes eld
17539 \begin_inset Quotes erd
17543 The color is a stunning magenta instead of blue, and the
17544 \begin_inset Quotes eld
17548 \begin_inset Quotes erd
17551 will look different, in style and in length.
17552 The label fonts of all three also differ from one another.
17555 \begin_layout Standard
17560 , if the contents of a
17568 exceed the physical size of a slide or sheet of paper, the extra will overflow
17570 Again, you should avoid this.
17571 It defeats the whole purpose of
17582 \begin_layout Subsubsection
17592 \begin_layout Standard
17597 is a slide that sits atop another slide.
17598 Perhaps you wish to discuss a figure on the main
17602 before displaying the text associated with it.
17603 One way to accomplish this is tape a flap of dark paper over the part of
17608 you want to display later.
17609 This method fails, however, if you wish to overlap one graph with another,
17611 You would then have to fumble while speaking to align the two separate,
17616 s to align the two graphs.
17621 environment in both cases makes life much easier.
17624 \begin_layout Standard
17629 receives the page number of its
17630 \begin_inset Quotes eld
17634 \begin_inset Quotes erd
17642 \begin_inset Quotes eld
17650 \begin_inset Quotes erd
17657 \begin_layout Plain Layout
17665 \begin_inset Quotes eld
17673 \begin_inset Quotes erd
17677 \begin_inset Quotes eld
17685 \begin_inset Quotes erd
17689 \begin_inset Quotes eld
17697 \begin_inset Quotes erd
17701 \begin_inset space ~
17704 appended to the page number of the parent
17714 Clearly, you want the contents of both the
17722 to each fit on a single physical slide! You should probably consider an
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17744 class provides a visual cue for this: the label at the start of an
17748 is shorter than that at the start of a
17753 Lastly, when you generate printable output, you'll find alignment markers
17754 in all four corners of both the
17758 page and its parent
17763 These will assist you in lining up the two physical slides.
17766 \begin_layout Standard
17767 The major problem in overlaying two slides is aligning the contents of the
17768 two transparencies.
17769 How much space should you leave for that graph on the second slide? Worse
17770 still, what if you want a graph and a sentence on second slide, but there
17771 is text on the main transparency that goes in between them? You could try
17772 and insert vertical space of the right size.
17773 The better way is to use
17784 \begin_layout Standard
17785 As their names imply,
17793 are two command-like paragraph environments that make all subsequent text
17794 invisible and visible, respectively.
17796 \begin_inset space ~
17800 \begin_inset CommandInset ref
17802 reference "sec:slideQuirk"
17806 that you don't place anything
17810 these two environments, however.
17815 , it inserts a centered, sky-blue label into the page reading
17816 \begin_inset Quotes eld
17819 <Invisible Text Follows>
17820 \begin_inset Quotes erd
17824 For paragraphs following this label, the parts of the
17832 ; it doesn't matter which] where they would be contain instead blank space.
17836 \begin_layout Standard
17841 , the corresponding centered label is
17842 \begin_inset Quotes eld
17845 <Visible Text Follows>
17846 \begin_inset Quotes erd
17850 Paragraphs following this label behave normally.
17851 Note that the beginning of a new
17863 automatically shuts off an
17868 It's therefore not necessary to use
17879 \begin_layout Standard
17880 By now, it should be obvious how to create overlay transparencies using
17881 the proper combination of
17900 \begin_layout Enumerate
17905 , including everything that will appear on it, whether on the main slide
17913 \begin_layout Enumerate
17914 Before each figure or paragraph that will appear only on the
17923 If necessary, insert a
17927 environment after the
17934 \begin_layout Enumerate
17939 immediately following the
17946 \begin_layout Enumerate
17947 Copy the contents of this
17958 \begin_layout Enumerate
17963 , change all of the
17976 \begin_layout Standard
17978 You've just made an
17985 \begin_layout Standard
17986 There's one problem with the way I've designed the LyX
17990 class: you can't make text in the middle of a paragraph invisible, nor
17991 make text in the middle of an invisible paragraph visible again.
17992 To accomplish this feat, you'll need to use some
18000 \begin_layout Plain Layout
18001 The commands of interest are:
18004 \begin_layout Itemize
18009 invisible \SpecialChar \ldots{}
18013 \begin_layout Itemize
18018 visible \SpecialChar \ldots{}
18022 \begin_layout Plain Layout
18023 \SpecialChar \ldots{}
18024 and need to be marked as TeX.
18026 \begin_inset Quotes eld
18030 \begin_inset Quotes erd
18033 you wish to change goes in between the brackets [and after the
18046 If you don't know how to mark text as TeX, see the appropriate section
18059 \begin_layout Subsubsection
18069 \begin_inset CommandInset label
18071 name "sec:slideNote"
18078 \begin_layout Standard
18087 is associated with a
18088 \begin_inset Quotes eld
18092 \begin_inset Quotes erd
18104 class provides visual cues.
18109 is shorter than that of a
18113 [yet longer than that of an
18117 ] and, like the label of an
18121 is shockingly magenta.
18122 Additionally, the printed
18126 has the page number of its
18127 \begin_inset Quotes eld
18131 \begin_inset Quotes erd
18139 \begin_inset Quotes eld
18147 \begin_inset Quotes erd
18151 \begin_inset Quotes eld
18159 \begin_inset Quotes erd
18163 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18175 You can have multiple
18179 s associated with a single
18191 , you'll probably want to break up long
18195 s so that they fit on a single sheet of paper.
18198 \begin_layout Standard
18203 is obvious: it contains anything additional you might want to say about
18209 It could also be used as a sheet of reminders for a particular
18214 In the case of the latter, you might want to make use of time markers.
18220 \begin_inset Quotes eld
18224 \begin_inset Quotes erd
18227 support for time markers, a
18232 So, you'll have to resort to using the
18237 \begin_layout Standard
18238 To use time markers, you'll need to specify the extra class option
18239 \begin_inset Quotes eld
18247 \begin_inset Quotes erd
18251 \begin_inset space ~
18255 \begin_inset CommandInset ref
18257 reference "sec:slidesetup"
18262 This option turns on timing marks, which will appear in the lower-left-hand
18268 To set what appears in the time marker, you use the
18271 \begin_inset Quotes eld
18283 \begin_inset Quotes erd
18287 \begin_inset Quotes eld
18299 \begin_inset Quotes erd
18303 The arguments of both commands are time measured in seconds.
18305 \begin_inset Quotes eld
18317 \begin_inset Quotes erd
18320 sets the time marker to a given time.
18322 \begin_inset Quotes eld
18334 \begin_inset Quotes erd
18337 increments the time marker by the specified amount.
18338 Using time markers and
18342 s in this fashion, you can remind yourself how much time to spend on a particula
18350 \begin_layout Standard
18351 There's one last feature to describe.
18352 Clearly, you'd like to print out all of your
18360 s on transparencies while printing all of your
18377 with which it is associated.
18378 What's a person to do?
18381 \begin_layout Standard
18382 Luckily, there are two
18384 commands that allow you to select what to print out.
18385 Both must be placed into the preamble of your document.
18387 \begin_inset Quotes eld
18401 \begin_inset Quotes erd
18404 will cause the output to contain only the
18413 Correspondingly, the command
18414 \begin_inset Quotes eld
18428 \begin_inset Quotes erd
18431 prevents the output of anything but
18436 I'd advise placing both commands in the preamble and initially comment
18438 You can then preview your entire presentation as you write.
18439 When you're done writing, you can then
18441 one of the two to select what you want to print.
18445 \begin_inset Quotes eld
18459 \begin_inset Quotes erd
18462 , print to a file with
18463 \begin_inset Quotes eld
18471 \begin_inset Quotes erd
18474 in its name, comment it back out, then
18477 \begin_inset Quotes eld
18491 \begin_inset Quotes erd
18495 \begin_inset Quotes eld
18504 \begin_inset Quotes erd
18508 I can then send either file to a printer, loading transparencies or plain
18509 paper as appropriate.
18512 \begin_layout Standard
18513 You can also provide other arguments to the
18514 \begin_inset Quotes eld
18526 \begin_inset Quotes erd
18530 \begin_inset Quotes eld
18542 \begin_inset Quotes erd
18551 \begin_layout Subsection
18556 Class Template File
18559 \begin_layout Standard
18560 I have also provided a template file,
18561 \begin_inset Quotes eld
18570 \begin_inset Quotes erd
18578 To use it, begin your new presentation with
18583 ile\SpecialChar \menuseparator
18585 \begin_inset space ~
18589 \begin_inset space ~
18599 Your new LyX presentation file will contain an example
18620 additionally contain an example of the use of
18629 Lastly, the preamble will contain:
18632 \begin_layout LyX-Code
18635 to print out only slides and overlays
18638 \begin_layout LyX-Code
18642 \begin_layout LyX-Code
18650 \begin_inset Newline newline
18656 \begin_layout LyX-Code
18659 to print out only notes
18662 \begin_layout LyX-Code
18666 \begin_layout LyX-Code
18676 \begin_layout Standard
18677 One final thing: I created this class to support the
18680 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18691 class, one of the built-in
18694 Neither I nor the rest of the LyX Team endorse or oppose the use of this
18695 built-in slide class.
18696 It's here if you want it or need it.
18699 classes for creating presentations, such as the
18704 \begin_inset space ~
18708 \begin_inset CommandInset ref
18710 reference "sec:foiltex"
18715 \begin_inset Quotes eld
18723 \begin_inset Quotes erd
18726 package [present on some TeX distributions].
18727 The latter is not yet supported under LyX.
18731 \begin_layout Plain Layout
18732 Perhaps you can take on the task\SpecialChar \ldots{}
18738 I know nothing about these other classes.
18739 Try them out to see what sort of alternative they provide.
18742 \begin_layout Chapter
18743 LyX Features needing Extra Software
18746 \begin_layout Section
18750 \begin_layout Standard
18758 \begin_layout Subsection
18762 \begin_layout Standard
18771 \begin_layout Plain Layout
18776 is not yet available when you are using the
18785 , you'll find in the
18792 \begin_inset space ~
18805 \begin_inset CommandInset href
18807 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18814 \begin_layout Standard
18819 package is a program that was written by
18820 \begin_inset Flex CharStyle:Noun
18823 \begin_layout Plain Layout
18825 \begin_inset space ~
18834 in frustration because some constructs in
18836 are sometimes non-intuitive, and easy to forget.
18837 The program runs over your
18839 file, checks the integrity of the file, and flags some common errors.
18840 In other technical words, it is
18849 \begin_layout Standard
18850 Well, what is a syntax checker doing in LyX which is supposed to produce
18853 anyways? The answer is simple: Just as
18857 not only checks the
18861 of C programs, but also does
18865 checks for type-errors,
18869 catches some common
18873 errors, in addition to the syntactical ones.
18878 is capable of detecting several common errors, such as
18881 \begin_layout Itemize
18882 Ellipsis detection:
18883 \begin_inset Newline newline
18886 Use \SpecialChar \ldots{}
18890 \begin_layout Itemize
18891 No space in front of/after parenthesis:
18892 \begin_inset Newline newline
18898 \begin_layout Itemize
18899 Enforcement of normal space after common abbreviations:
18900 \begin_inset Newline newline
18904 \begin_inset space \thinspace{}
18908 \begin_inset space \space{}
18911 is too wide spacing.
18914 \begin_layout Itemize
18915 Enforcement of end-of-sentence space when the last sentence ends with a
18917 \begin_inset Newline newline
18921 And this is wrong spacing.
18924 \begin_layout Itemize
18925 Space in front of labels and similar commands:
18926 \begin_inset Newline newline
18929 The label should stick right up to the text to avoid falling to a wrong
18932 \begin_inset CommandInset label
18942 \begin_layout Plain Layout
18943 This footnote is in danger of falling off to a wrong page
18948 The label is separated too much.
18951 \begin_layout Itemize
18952 Space in front of references, instead of hard spaces:
18953 \begin_inset Newline newline
18956 In you are in bad luck, the text will break right between the referenced
18957 text and reference number, and that's a pity.
18959 \begin_inset CommandInset ref
18961 reference "sec:chktex"
18968 \begin_layout Itemize
18970 \begin_inset Quotes eld
18974 \begin_inset Quotes erd
18978 \begin_inset Formula $\times$
18982 \begin_inset Newline newline
18987 looks cheap compared to
18988 \begin_inset Formula $2\times2$
18994 \begin_layout Standard
18995 and more \SpecialChar \ldots{}
18996 It is an invaluable tool when you are
18997 \begin_inset Quotes eld
19001 \begin_inset Quotes erd
19004 your document before printing, and you should run it right after the obligatory
19005 spelling check, and before you go fine tuning the typesetting.
19008 \begin_layout Subsection
19012 \begin_layout Standard
19013 If you have the program installed, usage is as simple as choosing
19015 Tools\SpecialChar \menuseparator
19017 \begin_inset space ~
19023 This will make LyX generate a
19025 file of your document, start
19029 to check it, and then make LyX insert
19030 \begin_inset Quotes eld
19034 \begin_inset Quotes erd
19037 with the warnings from
19041 , if there were any.
19042 The warnings will be placed close to the point of the mistake, and you
19043 can quickly find them by using the
19045 Navigate\SpecialChar \menuseparator
19048 menu item, or the shortcut key
19057 Open the error boxes by clicking on them with the mouse, or use the shortcut
19066 bindings, or the corresponding
19075 Read the warning and correct the mistake, if it is a mistake.
19076 If you have trouble understanding what the warning is about, you can safely
19078 Remember that there is a hidden layer between the document on screen and
19079 the technical details in invoking
19083 , and this gap can make some warnings seem arcane or just right down plain
19087 \begin_layout Standard
19088 This document is an excellent testing bed for the feature, and it should
19089 provide quite a few warnings for you to fiddle with.
19090 Since computers are only so smart, expect most of the warnings to be false
19094 \begin_layout Subsection
19095 How to fine tune it
19098 \begin_layout Standard
19099 Sometimes, you'll find that
19103 makes more noise than suits your mood.
19104 Then you can choose not to use it, wait until your mood changes, or try
19109 to get better along with you.
19110 Another choice in the most desperate situations is to use
19112 View\SpecialChar \menuseparator
19114 \begin_inset space ~
19118 \begin_inset space ~
19122 \begin_inset space ~
19127 , which will get rid of all warnings instantly.
19130 \begin_layout Standard
19139 very configurable and extensible, you shouldn't expect to solve all problems
19145 Since LyX has to generate a somewhat special
19147 file to be able to match the line numbers from the
19155 \begin_layout Plain Layout
19156 You can inspect the specific output from
19162 Edit\SpecialChar \menuseparator
19164 \begin_inset space ~
19170 \begin_inset space ~
19184 to the internal document structure, some of the warnings will not seen
19185 to appear correctly.
19186 There are two things you can do about this:
19189 \begin_layout Itemize
19194 invocation command line in
19210 installation configuration file (usually with the file
19215 See below to learn what warnings can be enabled and disabled on the command
19220 \begin_layout Itemize
19221 Export your document as a raw
19225 File\SpecialChar \menuseparator
19226 Export\SpecialChar \menuseparator
19235 Invoked in this way, it can be a hassle to find the corresponding place
19236 in the document inside LyX, but with a little patience, you should be able
19240 \begin_layout Standard
19241 Here follows the warning messages that can be enabled and disabled in
19250 to disable a warning, and
19254 to enable a warning.
19255 The emphasized entries are disabled by default, because the default is
19279 \begin_layout Standard
19280 Notice that you should only use the options that enable and disable warnings,
19281 because LyX relies on some of the other command line parameters to be set
19282 in a specific way to have a chance to communicate with
19289 \begin_layout Enumerate
19293 Command terminated with space.
19296 \begin_layout Enumerate
19299 Non-breaking space (
19300 \begin_inset Quotes eld
19308 \begin_inset Quotes erd
19311 ) should have been used.
19314 \begin_layout Enumerate
19318 You should enclose the previous parenthesis with
19319 \begin_inset Quotes eld
19327 \begin_inset Quotes erd
19333 \begin_layout Enumerate
19336 Italic correction (
19337 \begin_inset Quotes eld
19347 \begin_inset Quotes erd
19350 ) found in non-italic buffer.
19353 \begin_layout Enumerate
19356 Italic correction (
19357 \begin_inset Quotes eld
19367 \begin_inset Quotes erd
19370 ) found more than once.
19373 \begin_layout Enumerate
19377 No italic correction (
19378 \begin_inset Quotes eld
19388 \begin_inset Quotes erd
19394 \begin_layout Enumerate
19398 \begin_inset Quotes eld
19406 \begin_inset Quotes erd
19410 \begin_inset Quotes eld
19418 \begin_inset Quotes erd
19424 \begin_layout Enumerate
19427 Wrong length of dash may have been used.
19430 \begin_layout Enumerate
19434 \begin_inset Quotes eld
19442 \begin_inset Quotes erd
19446 \begin_inset Quotes eld
19454 \begin_inset Quotes erd
19460 \begin_layout Enumerate
19464 \begin_inset Quotes eld
19472 \begin_inset Quotes erd
19478 \begin_layout Enumerate
19482 \begin_inset Quotes eld
19490 \begin_inset Quotes erd
19493 to achieve an ellipsis.
19496 \begin_layout Enumerate
19499 Inter-word spacing (
19500 \begin_inset Quotes eld
19510 \begin_inset Quotes eld
19513 ) should perhaps be used.
19516 \begin_layout Enumerate
19519 Inter-sentence spacing (
19520 \begin_inset Quotes eld
19530 \begin_inset Quotes erd
19533 ) should perhaps be used.
19536 \begin_layout Enumerate
19539 Could not find argument for command.
19542 \begin_layout Enumerate
19546 \begin_inset Quotes eld
19554 \begin_inset Quotes erd
19560 \begin_layout Enumerate
19563 Math mode still on at end of
19568 \begin_layout Enumerate
19572 \begin_inset Quotes eld
19580 \begin_inset Quotes erd
19583 doesn't match the number of
19584 \begin_inset Quotes eld
19592 \begin_inset Quotes erd
19598 \begin_layout Enumerate
19601 You should use either
19604 \begin_inset Quotes eld
19612 \begin_inset Quotes erd
19617 as an alternative to
19618 \begin_inset Quotes eld
19626 \begin_inset Quotes erd
19632 \begin_layout Enumerate
19650 \begin_layout Enumerate
19653 User-specified pattern found.
19656 \begin_layout Enumerate
19659 This command might not be intended.
19662 \begin_layout Enumerate
19669 \begin_layout Enumerate
19689 \begin_layout Enumerate
19692 Delete this space to maintain correct page references.
19695 \begin_layout Enumerate
19699 You might wish to put this between a pair of
19700 \begin_inset Quotes eld
19708 \begin_inset Quotes erd
19714 \begin_layout Enumerate
19717 You ought to remove spaces in front of punctuation.
19720 \begin_layout Enumerate
19728 \begin_layout Enumerate
19737 in front of small punctuation.
19740 \begin_layout Enumerate
19748 may look prettier here.
19751 \begin_layout Enumerate
19755 Multiple spaces detected in output.
19758 \begin_layout Enumerate
19761 This text may be ignored.
19764 \begin_layout Enumerate
19770 \begin_inset Quotes eld
19775 to begin quotation, not
19782 \begin_layout Enumerate
19789 to end quotation, not
19792 \begin_inset Quotes eld
19800 \begin_layout Enumerate
19806 \begin_layout Enumerate
19809 You should perhaps use
19810 \begin_inset Quotes eld
19818 \begin_inset Quotes erd
19824 \begin_layout Enumerate
19827 You should put a space in front of/after parenthesis.
19830 \begin_layout Enumerate
19833 You should avoid spaces in front of/after parenthesis.
19836 \begin_layout Enumerate
19840 You should not use punctuation in front of/after quotes.
19843 \begin_layout Enumerate
19846 Double space found.
19849 \begin_layout Enumerate
19852 You should put punctuation outside inner/inside display math mode.
19855 \begin_layout Enumerate
19858 You ought to not use primitive TeX in
19863 \begin_layout Enumerate
19866 You should remove spaces in front of
19867 \begin_inset Quotes eld
19875 \begin_inset Quotes erd
19881 \begin_layout Enumerate
19884 \begin_inset Quotes eld
19892 \begin_inset Quotes erd
19895 is normally not followed by
19896 \begin_inset Quotes eld
19904 \begin_inset Quotes erd
19910 \begin_layout Standard
19911 In later versions of LyX, we hope to provide a more complete interface to
19912 this tool (and it's smaller cousin
19916 ) to exploit the full power of it.
19917 But it's not exactly useless as it is now: go try it on one of your existing
19918 documents of a certain length and be surprised.
19921 \begin_layout Section
19922 Version Control in LyX
19925 \begin_layout Standard
19940 \begin_layout Subsection
19944 \begin_layout Standard
19945 A friend of mine wanted to try LyX for a group project.
19946 When he didn't find support for version control or file locking, he dropped
19948 This angered me a bit, so I thought that I should at least make support
19951 (with the possibility of
19955 as a future improvement.) This has now been done.
19956 LyX now supports some of the most basic
19959 If you need to something a bit more sophisticated you will have to do that
19960 manually in an xterm.
19963 \begin_layout Standard
19964 Before you begin to use the version control features in LyX, you should
19966 \begin_inset Quotes eld
19972 \begin_inset Quotes erd
19975 (a man file, read it with
19981 This file describes all the basic features of
19984 You should especially notice the comment about a
19986 directory, and the notion of a master
19988 file (the file ending in
19995 \begin_layout Standard
20001 You should be familiar with
20005 usage before start using it under LyX.
20006 Most of the log messages are not currently displayed after operations -
20007 you can check them in terminal window if unsure.
20010 \begin_layout Standard
20011 The implementation in LyX assumes a recent version of the GNU
20017 package—no guarantees are made for older versions.
20020 \begin_layout Standard
20021 For introducing your own external commands consult
20023 -command in the manual of LyX functions.
20026 \begin_layout Subsection
20032 \begin_layout Standard
20033 The following sections describe the
20035 commands supported by LyX.
20036 You can find them in the
20038 File\SpecialChar \menuseparator
20040 \begin_inset space ~
20048 LyX was tested against
20053 \begin_layout Subsubsection
20059 \begin_layout Standard
20060 If your document is not under revision control, this is the only item shown
20062 And if it is under revision control, the
20066 item is not visible.
20070 \begin_layout Standard
20071 This command registers your document with
20073 (unless you are under the directory managed by
20076 You are asked interactively to supply an initial description of the document.
20077 The document is now set in Read-Only mode and you have to
20080 \begin_inset space ~
20084 \begin_inset space ~
20088 \begin_inset space ~
20093 , before making any changes to it.
20094 A document under revision control has a
20095 \begin_inset Quotes eld
20100 :<version> <locker>]
20101 \begin_inset Quotes erd
20111 \begin_layout Standard
20114 command that is run:
20117 -q -u -i -t-"<initial description>" <file-name>
20120 \begin_layout Standard
20126 to understand the switches.
20130 \begin_layout Subsubsection
20136 \begin_layout Standard
20137 When you are finished editing a file, you check in your changes.
20138 When you do this, you are asked for a description of the changes.
20139 This is stored in the history log.
20140 The version number is bumped, your changes are applied to the master
20142 file, the document is unlocked and set to Read-Only mode.
20146 \begin_layout Standard
20152 -q -u -m"<description>" <file-name>
20155 \begin_layout Subsubsection
20161 \begin_layout Standard
20162 By doing this you lock the document so that only you can edit it.
20163 This will also make the document Read-Write only for you.
20164 You will usually continue editing for a while and when you are finished
20165 you check in your changes.
20166 The status line is changed to reflect that you have locked the file.
20170 \begin_layout Standard
20175 co -q -l <file-name>
20178 \begin_layout Subsubsection
20181 Revert To Repository Version
20184 \begin_layout Standard
20185 This will discard all changes made to the document since the last check
20187 You get a warning before changes are discarded.
20190 \begin_layout Standard
20195 co -f -u<version> <file-name>
20198 \begin_layout Subsubsection
20205 \begin_layout Standard
20206 This makes as if the last check in never happened.
20207 No changes are made to the document loaded into LyX, but the last version
20208 is removed from the master
20214 \begin_layout Standard
20220 -o<version> <file-name>
20223 \begin_layout Subsubsection
20229 \begin_layout Standard
20230 This show the complete history of the
20238 is shown in a browser.
20247 \begin_layout Subsection
20253 \begin_layout Standard
20256 is now partially supported by LyX.
20257 You can find the commands in the
20259 File\SpecialChar \menuseparator
20261 \begin_inset space ~
20271 \begin_layout Subsubsection
20277 \begin_layout Standard
20278 If your document is not under revision control, this is the only item shown
20280 And if it is under revision control, the
20287 item is not visible.
20291 \begin_layout Standard
20292 This command registers in
20294 your document ONLY in case you have already the documents directory under
20297 control (in particular
20303 This means you have to checkout the archive by yourself.
20307 \begin_layout Standard
20308 Then you are asked interactively to supply an initial description of the
20310 Don't forget that registered file is not yet
20315 \begin_layout Standard
20318 command that is run:
20322 \begin_inset Quotes erd
20326 \begin_inset Quotes eld
20330 \begin_inset Quotes erd
20336 \begin_layout Standard
20342 to understand the switches.
20346 \begin_layout Subsubsection
20352 \begin_layout Standard
20353 When you are finished editing a file, you commit your changes.
20354 When you do this, you are asked for a description of the changes.
20355 After that changes are
20360 \begin_layout Standard
20366 -q commit -m"<description>" "<file-name>"
20369 \begin_layout Subsubsection
20372 Revert To Repository Version
20375 \begin_layout Standard
20376 This will discard all changes made to the document since the last check
20378 You get a warning before changes are discarded.
20379 Firstly the file is deleted, secondly
20381 update command is run.
20384 \begin_layout Standard
20391 \begin_inset Quotes eld
20395 \begin_inset Quotes erd
20401 \begin_layout Subsubsection
20407 \begin_layout Standard
20408 This show the complete history of the
20415 \begin_inset Quotes eld
20419 \begin_inset Quotes erd
20424 is shown in a browser.
20427 \begin_layout Subsection
20433 \begin_layout Standard
20436 is now partially supported by LyX.
20437 You can find the commands in the
20439 File\SpecialChar \menuseparator
20441 \begin_inset space ~
20449 Please note that if you use password protected access to repository via
20450 ssh, you will be asked in terminal window.
20451 LyX was tested against
20456 \begin_layout Subsubsection
20462 \begin_layout Standard
20463 If your document is not under revision control, this is the only item shown
20465 And if it is under revision control, the
20472 item is not visible.
20476 \begin_layout Standard
20477 This command registers in
20479 your document ONLY in case you have already the documents directory under
20482 control (in particular
20489 This means you have to checkout the archive by yourself.
20493 \begin_layout Standard
20494 Then you are asked interactively to supply an initial description of the
20496 Don't forget that registered file is not yet
20501 \begin_layout Standard
20504 command that is run:
20508 \begin_inset Quotes eld
20512 \begin_inset Quotes erd
20518 \begin_layout Standard
20524 to understand the switches.
20528 \begin_layout Subsubsection
20534 \begin_layout Standard
20535 When you are finished editing a file, you commit your changes.
20536 When you do this, you are asked for a description of the changes.
20537 After that changes are
20542 \begin_layout Standard
20549 \begin_layout Plain Layout
20550 In case locking is not enabled.
20552 \begin_inset CommandInset ref
20554 reference "subsec:SVN-File-Locking"
20566 commit -q -m"<description>" <file-name>
20569 \begin_layout Subsubsection
20575 \begin_layout Standard
20576 Updates the changes of this file from the repository.
20577 Be sure you understand
20579 merging and conflicts resolving before using this function, because all
20580 conflicts has to be done manually by you!
20583 \begin_layout Standard
20590 \begin_layout Plain Layout
20600 \begin_inset Quotes eld
20604 \begin_inset Quotes erd
20610 \begin_layout Subsubsection
20613 Revert To Repository Version
20616 \begin_layout Standard
20617 This will discard all changes made to the document since the last check
20619 You get a warning before changes are discarded.
20623 \begin_layout Standard
20630 \begin_inset Quotes eld
20634 \begin_inset Quotes erd
20640 \begin_layout Subsubsection
20646 \begin_layout Standard
20647 This show the complete history of the
20654 \begin_inset Quotes eld
20658 \begin_inset Quotes erd
20663 is shown in a browser.
20666 \begin_layout Subsubsection
20668 \begin_inset CommandInset label
20670 name "subsec:SVN-File-Locking"
20677 \begin_layout Standard
20678 The file exchange through various revision control systems brings the problem
20679 of merge conflicts in case two different users try to edit the same (parts
20681 When such conflict happens it needs manual resolving and one reasonable
20682 alternative is to provide some kind of locking mechanism, which guarantees
20683 that only one user is allowed to edit file at the given time.
20686 \begin_layout Standard
20689 has two mechanisms to provide such kind of mutual exclusivity for file
20692 setting of write permissions based on
20693 \begin_inset Flex CharStyle:Code
20696 \begin_layout Plain Layout
20710 \begin_layout Plain Layout
20715 .red-bean.com/en/1.2/
20724 In a case this property is detected for a given document LyX starts to
20727 locks for document editing automatically and the whole check-in/out mechanism
20728 switches to the same regimen as for
20731 This in particular means there are two different modes how file is used
20735 \begin_layout Itemize
20737 The loaded file is in the read-only mode.
20740 on needs to check-out.
20745 consists of update from repository and gaining write lock.
20746 If the lock is not possible to obtain, we remain in unlocked state.
20749 \begin_layout Itemize
20751 The loaded file is in the
20754 No other user is allowed to edit the file.
20761 changes and releasing write-lock.
20762 If no changes have been made to the document, no commit will be produced
20766 \begin_layout Plain Layout
20767 Don't be puzzled by the fact that you will be asked for commit message anyway.
20772 and only the write-lock will be released.
20775 \begin_layout Standard
20781 \begin_layout Labeling
20782 \labelwidthstring 00.00.0000
20787 commit -q -m"<description>" "<file-name>"
20788 \begin_inset Newline newline
20793 unlock "<file-name>"
20796 \begin_layout Labeling
20797 \labelwidthstring 00.00.0000
20801 update "<file-name>"
20802 \begin_inset Newline newline
20810 \begin_layout Subsection
20813 and Windows Environment
20816 \begin_layout Quote
20817 My inclination is to say that if the user cannot figure out the command
20818 line operations on their own fairly quickly, they would be well advised
20827 \begin_layout Subsubsection
20831 \begin_layout Standard
20832 In addition to installing LyX, and having access to a Subversion repository,
20833 the user will need to install the Subversion client program.
20834 A Windows installer for the client program is available from
20835 \begin_inset CommandInset href
20838 target "http://www.collab.net/nonav/downloads/subversion/"
20843 The user may also want to install
20844 \begin_inset CommandInset href
20847 target "http://tortoisesvn.tigris.org/"
20851 , which integrates Subversion operations into the context (
20853 ) menu of Windows Explorer.
20854 Operations done outside LyX will typically be more convenient using the
20855 Explorer context menu.
20858 is not a replacement for the client program, which is what LyX itself will
20862 \begin_layout Subsubsection
20863 Bringing a document under Subversion control
20866 \begin_layout Standard
20867 Before a LyX document can be brought under version control in Subversion,
20868 its parent directory needs to be under version control.
20869 If the document is being added to a project already in the repository,
20870 this is accomplished by checking the project out to the directory where
20871 the new document will be placed.
20872 If the project itself is not yet under version control (for instance, if
20873 this document starts a new project), the directory must be imported into
20875 This is done outside LyX.
20876 Both import and checkout are easily accomplished from the Explorer context
20879 , or alternatively can be done using the command line client at a DOS prompt.
20880 The procedure for importing the project using
20882 is described below, assuming an existing repository and a new project being
20890 For information on using the Subversion client program, run
20898 \begin_layout Enumerate
20905 in Windows Explorer, right click it, and select
20913 If necessary, adjust the URL for the repository, then click OK.
20916 \begin_layout Enumerate
20917 Right click the level of the repository under which you want to place the
20918 new project folder (typically the top level) and click
20920 Create folder\SpecialChar \ldots{}
20923 Supply a name for the project folder and click OK.
20924 Add a message for the log file if desired, then click OK again.
20925 The new project folder should appear in the repository.
20926 Finally, click OK again to exit the repository browser.
20929 \begin_layout Enumerate
20930 Once again right click
20936 , this time selecting
20938 Checkout\SpecialChar \ldots{}
20939 Select the URL of the project folder you just created in the repositor
20940 y, and set the checkout directory to
20948 You will be warned about a non-empty folder; click OK to proceed.
20949 You should now have a
20961 \begin_layout Enumerate
20962 Create or open your document in LyX and click
20967 ile\SpecialChar \menuseparator
20973 \begin_inset space ~
20976 Control\SpecialChar \menuseparator
20984 Add a log message and click OK to commit the document to version control.
20987 \begin_layout Standard
20988 From this point onward, you should have full functionality in the
20993 ile\SpecialChar \menuseparator
20999 \begin_inset space ~
21005 You also have the option of checking the document in and out, viewing its
21009 context menu in Windows Explorer or the Subversion client program from
21013 \begin_layout Subsection
21017 \begin_layout Standard
21018 With the recent addition of the
21020 -command function LyX power users are allowed to create their own commands
21021 for revision control.
21024 \begin_layout Standard
21025 As an example you can see how two
21027 commands could be integrated directly:
21030 \begin_layout Description
21032 \begin_inset Flex CharStyle:Code
21035 \begin_layout Plain Layout
21040 /command:commit /path:$$p"
21048 \begin_layout Description
21050 \begin_inset Flex CharStyle:Code
21053 \begin_layout Plain Layout
21058 /command:revert /path:$$p"
21066 \begin_layout Section
21067 Literate Programming
21070 \begin_layout Standard
21082 original documentation written by
21097 \begin_layout Subsection
21101 \begin_layout Standard
21102 The main purpose of this documentation is to show you how to use LyX for
21103 literate programming.
21104 Where it is assumed that you are familiar with this programming technique,
21106 \begin_inset Quotes eld
21110 \begin_inset Quotes erd
21114 \begin_inset Quotes eld
21118 \begin_inset Quotes erd
21122 If that is not the case, please follow the web links provided in the following
21124 There is a lot of good documentation out there covering old development
21125 history to the latest tools tips.
21128 \begin_layout Standard
21129 It is also assumed that you are familiar with LyX itself to a point that
21130 you are comfortable changing your LyX preferences, and X resources file.
21131 If that is not the case please refer to other LyX documentation to cover
21132 your specific needs.
21135 \begin_layout Subsection
21136 Literate Programming
21139 \begin_layout Standard
21140 From the Literate Programming FAQ:
21143 \begin_layout Quotation
21144 Literate programming is the combination of documentation and source together
21145 in a fashion suited for reading by human beings.
21146 In fact, literate programs should be enjoyable reading, even inviting!
21147 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21148 and documentation in a single file.
21149 Literate programming tools then parse the file to produce either readable
21150 documentation or compilable source.
21151 The WEB style of literate programming was created by D.
21152 \begin_inset space \thinspace{}
21156 Knuth during the development of his TeX typesetting software.
21160 \begin_layout Standard
21161 Another excerpt says:
21164 \begin_layout Quotation
21167 How is literate programming different from verbose commenting?
21170 \begin_layout Quotation
21171 There are three distinguishing characteristics.
21172 In order of importance, they are:
21176 \begin_layout Itemize
21177 flexible order of elaboration
21180 \begin_layout Itemize
21181 automatic support for browsing
21184 \begin_layout Itemize
21185 typeset documentation, especially diagrams and mathematics
21189 \begin_layout Standard
21190 Now that I sparked your curiosity, take a look in the references.
21193 \begin_layout Subsubsection
21197 \begin_layout Standard
21198 The complete Literate Programming FAQ can be found at:
21201 \begin_layout Quote
21202 Literate Programming FAQ
21203 \begin_inset Flex URL
21206 \begin_layout Plain Layout
21208 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
21216 \begin_layout Standard
21219 (twenty three!) different literate programming tools.
21220 Where some are specialized or
21221 \begin_inset Quotes eld
21225 \begin_inset Quotes erd
21228 for particular programming languages, while other have general scope.
21233 for my own use for several reasons:
21236 \begin_layout Itemize
21237 It can generate the documentation either in
21242 \begin_layout Itemize
21243 It has a open architecture, i.
21244 \begin_inset space \thinspace{}
21248 \begin_inset space \space{}
21251 it is easy to plug in new filters and to perform special processing that
21256 \begin_layout Itemize
21257 There is a good selection of filters available already (the HTML is one
21261 \begin_layout Itemize
21265 \begin_layout Standard
21268 web page can be found at:
21271 \begin_layout Quote
21275 \begin_inset Flex URL
21278 \begin_layout Plain Layout
21280 http://www.cs.virginia.edu/~nr/noweb/
21288 \begin_layout Standard
21289 Starting from there you can reach many other interesting links and even
21290 some literate program examples.
21293 \begin_layout Subsection
21294 LyX and Literate Programming
21297 \begin_layout Standard
21298 The LyX support for Literate Programming is provided by using the generic
21299 LyX converters mechanism.
21300 This support is provided in a
21301 \begin_inset Quotes eld
21307 \begin_inset Quotes erd
21311 \begin_inset space \thinspace{}
21315 \begin_inset space \space{}
21318 you will be able to use this new LyX feature with some other literate programmin
21319 g tool of your choice by just changing your LyX preferences.
21322 \begin_layout Subsubsection
21323 Generating documents and code (weaving and tangling)
21326 \begin_layout Paragraph
21327 Selecting the document class
21330 \begin_layout Standard
21331 If you have installed
21333 and LyX successfully, whenever you open a new document or try to change
21334 the document class of an existing one, you will find that there are three
21335 new document classes available:
21338 \begin_layout Itemize
21344 \begin_layout Itemize
21350 \begin_layout Itemize
21356 \begin_layout Standard
21357 You must select one of them to create your literate documents from.
21361 \begin_layout Standard
21362 Note that literate documents are not limited to these three classes.
21363 New classes can be generated from other styles like letter or in combination
21364 with other class variations like Article (
21367 If you have special needs that cannot be covered by one of the existing
21368 classes, let the LyX developers list (
21374 .org) know and we will arrange to insert a new entry, or teach you how to
21379 \begin_layout Plain Layout
21380 It is very simple, it involves the creation of a file with four lines, and
21381 re-running of the auto configuration.
21386 Moreover, if you use a literate tool other than
21388 you may need to create a new set of document classes for it.
21391 \begin_layout Paragraph
21395 \begin_layout Standard
21396 LyX enables you to write code with a layout named
21404 \begin_layout Plain Layout
21408 \begin_inset Quotes eld
21412 \begin_inset Quotes erd
21416 For historical reasons, I got used to the term
21417 \begin_inset Quotes eld
21421 \begin_inset Quotes erd
21424 introduced by other literate tool named
21426 , which I used for many years before rendering myself to
21435 delimits scraps like this:
21438 \begin_layout LyX-Code
21442 \begin_layout LyX-Code
21446 \begin_layout LyX-Code
21450 \begin_layout LyX-Code
21454 \begin_layout LyX-Code
21458 \begin_layout Standard
21459 The problem is that whatever is written in between the << and the
21463 must be taken literally, i.
21464 \begin_inset space \thinspace{}
21468 \begin_inset space \space{}
21471 LyX should be prevented from making any special interpretation of what has
21473 This is handled by a special layout named Scrap, that works like a normal
21474 paragraph but has a free spacing capability.
21477 \begin_layout Standard
21478 The down side of the Scrap paragraph layout is that consecutive paragraphs
21479 of code will be spaced with one empty line in the source code and also
21480 in the printed documentation.
21481 The work around is to enter each line of code within a single Scrap, with
21485 The example above will look like this:
21489 \begin_layout Plain Layout
21490 If you have a printed version of this document you will not see any difference
21491 between the previous example and this one.
21499 \begin_layout LyX-Code
21501 \begin_inset Newline newline
21505 \begin_inset Newline newline
21509 \begin_inset Newline newline
21513 \begin_inset Newline newline
21519 \begin_layout Standard
21520 This layout works fine.
21521 The only real inconvenience is that you have to type
21523 -return instead of a plain return.
21527 \begin_layout Plain Layout
21528 It is in my list of
21529 \begin_inset Quotes eld
21533 \begin_inset Quotes erd
21544 \begin_layout Standard
21545 As a special note, you can also use the
21546 \begin_inset Quotes eld
21550 \begin_inset Quotes erd
21555 in your scraps to add items to
21557 identifier cross-reference:
21560 \begin_layout LyX-Code
21562 \begin_inset Newline newline
21568 \begin_inset Newline newline
21571 "This is the doc string for this function."
21572 \begin_inset Newline newline
21581 \begin_layout LyX-Code
21582 @ %def some_function
21585 \begin_layout Standard
21586 For an example of this usage and the resulting cross-reference output, look
21587 at the Literate python program in
21595 which should make this all clear.
21598 \begin_layout Paragraph
21599 Generating the documentation
21602 \begin_layout Standard
21603 At this point you already have a new document file with a proper document
21604 class, and with some code and text on it.
21605 How do I print it? The answer is simple, you select
21607 View\SpecialChar \menuseparator
21613 Just like you would do for a plain document.
21614 No special procedure is required.
21617 \begin_layout Standard
21618 To help orientate you, I will now explain what happens inside LyX:
21621 \begin_layout Enumerate
21624 Update\SpecialChar \menuseparator
21628 menu option is chosen, a
21635 \begin_layout Standard
21636 If the document is of any literate class the generated file will be named
21637 with an extension name defined by the
21638 \begin_inset Quotes eld
21642 \begin_inset Quotes erd
21645 format (defined in the Preferences panel), otherwise the file will have
21655 \begin_layout Enumerate
21656 Note that the only difference so far is in the name of the file, no special
21657 processing is required by LyX.
21658 Given that you formatted the code using the Scrap layout that, by itself,
21659 takes care of the business.
21662 \begin_layout Enumerate
21663 If the document is of any literate class LyX will then use the internal
21666 converter, followed by the
21674 \begin_layout Plain Layout
21675 The converters are defined in the
21677 Tools\SpecialChar \menuseparator
21681 \begin_inset Quotes eld
21685 \begin_inset Quotes erd
21697 manual for general information about converters.
21708 \begin_layout Standard
21709 Otherwise it will just skip this step.
21713 \begin_layout Enumerate
21716 is invoked and the regular post processing continues as in a plain document.
21719 \begin_layout Standard
21720 Independence from a particular
21721 \begin_inset Quotes eld
21725 \begin_inset Quotes erd
21728 is easily achieved by changing the commands that are run by the various
21732 \begin_layout Paragraph
21733 Generating the code
21736 \begin_layout Standard
21737 When the build menu option is chosen or the corresponding button in the
21738 toolbar is pressed, a
21740 file is generated just like step 1 above.
21741 Next, LyX invokes the
21747 This converter needs to be defined by the user and is not installed by
21748 default, though the Program format is.
21749 This converter (like any other converter) will have two parts:
21752 \begin_layout Enumerate
21753 The converter program itself.
21754 This program performs the conversion from the one format to the other (in
21755 this case, from the
21757 format to the Program pseudo-format).
21760 \begin_layout Enumerate
21761 The error log parser.
21762 This is a program whose sole purpose is to rewrite error messages in a
21763 format that LyX understands.
21764 This makes it possible for LyX to place error boxes in the right places
21765 in the file buffer.
21768 \begin_layout Standard
21769 The first part, the
21770 \begin_inset Quotes eld
21774 \begin_inset Quotes erd
21777 setting, should be set to
21778 \begin_inset Quotes eld
21786 \begin_inset Quotes erd
21790 This basically means that LyX will call
21791 \begin_inset Quotes eld
21795 \begin_inset Quotes erd
21798 (a program or script) with the name of the
21800 file (normally a file in the LyX temp directory).
21804 \begin_layout Standard
21805 This is an implementation of
21806 \begin_inset Quotes eld
21810 \begin_inset Quotes erd
21813 that you can place in a directory on your path:
21816 \begin_layout LyX-Code
21820 \begin_layout LyX-Code
21824 \begin_layout LyX-Code
21836 \begin_layout Standard
21837 The next part of the converter setting is the
21838 \begin_inset Quotes eld
21842 \begin_inset Quotes erd
21845 which is to be set to
21846 \begin_inset Quotes eld
21856 \begin_inset Quotes erd
21860 This will run any errors that are generated by the
21861 \begin_inset Quotes eld
21865 \begin_inset Quotes erd
21868 process through the
21869 \begin_inset Quotes eld
21875 \begin_inset Quotes erd
21881 \begin_layout Standard
21882 The converter code looks in
21892 then on the path for the
21893 \begin_inset Quotes eld
21899 \begin_inset Quotes erd
21905 \begin_layout Standard
21906 The build will normally take place in LyX's temporary directory, so the
21907 files produced by the conversion will be in that directory.
21908 LyX will copy out what it regards as the `
21915 conversion may produce several files, and so most of these would then be
21916 deleted when LyX was closed.
21917 The present solution is to use a `
21923 \begin_layout Plain Layout
21932 manual for information on these.
21942 script in its default mode, so that the entire contents of the temporary
21943 directory is copied.
21944 More will get copied than is needed, to be sure, but nothing will be lost.
21945 If, however, you know what extensions the generated files will have, this
21946 can be improved by using the
21955 This option takes a comma-separated list of extensions to copy.
21956 So, for example, if the conversion will generate only files with the extensions
21965 , then the correct definition would be:
21968 \begin_layout LyX-Code
21971 $$s/scripts/ext_copy.
21976 \begin_layout Standard
21977 The result will be that only files with these two extensions will be copied
21981 \begin_layout Paragraph
21982 Build instructions in the document
21985 \begin_layout Standard
21986 The last piece of the integration between LyX and
21989 \begin_inset Quotes eld
21993 \begin_inset Quotes erd
21997 Generally, the instructions for building your program should be embedded
21998 in a scrap of its own.
22002 \begin_inset Quotes eld
22006 \begin_inset Quotes erd
22011 command to look for this scrap (called
22012 \begin_inset Quotes eld
22016 \begin_inset Quotes erd
22019 ) and runs its contents through
22020 \begin_inset Quotes eld
22024 \begin_inset Quotes erd
22030 \begin_layout Standard
22031 Typically, such a scrap would look something like this:
22034 \begin_layout LyX-Code
22036 \begin_inset Newline newline
22040 \begin_inset Newline newline
22044 \begin_inset Newline newline
22050 \begin_inset Newline newline
22054 \begin_inset Newline newline
22064 \begin_inset Newline newline
22070 \begin_inset Newline newline
22074 code to extract files ...]
22075 \begin_inset Newline newline
22079 code to compile files ...]
22080 \begin_inset Newline newline
22086 \begin_layout Standard
22098 /examples/Literate.
22101 which implement two versions of the
22102 \begin_inset Quotes eld
22108 \begin_inset Quotes erd
22111 program for some illustrations of how all of these pieces go together or
22122 Interestingly, these three files show off the language-
22124 of the LyX literate programming support since they are written in Python,
22125 C and Perl respectively.
22128 \begin_layout Subsubsection
22132 \begin_layout Standard
22133 All the Literate Programming support is configured by the
22135 Tools\SpecialChar \menuseparator
22139 \begin_inset Quotes eld
22143 \begin_inset Quotes erd
22147 The important parts are:
22150 \begin_layout Description
22152 \begin_inset space ~
22156 \begin_inset Quotes eld
22160 \begin_inset Quotes erd
22164 \begin_inset space ~
22167 format Set up via the Formats tab, this is where the
22169 -specific pieces are set up.
22178 , the file extension is set to
22184 This tells LyX to create a file with a
22189 extension in the first step of the conversion process.
22192 \begin_layout Description
22194 \begin_inset space ~
22202 \begin_inset space ~
22205 format This is an empty format whose sole purpose is to be the endpoint
22206 of a conversion (which then allows us to set up a converter for it).
22209 \begin_layout Description
22218 This converter performs the
22219 \begin_inset Quotes eld
22223 \begin_inset Quotes erd
22226 of the literate document.
22230 \begin_inset Quotes eld
22236 -delay -index $$i > $$o
22239 \begin_inset Quotes erd
22245 \begin_layout Description
22255 \begin_inset Quotes eld
22259 \begin_inset Quotes erd
22263 As stated above, the Converter is set to
22264 \begin_inset Quotes eld
22272 \begin_inset Quotes erd
22275 , with Flags set to
22276 \begin_inset Quotes eld
22288 \begin_inset Quotes erd
22294 \begin_layout Subsubsection
22298 \begin_layout Standard
22299 There is also a new function implemented in the LyX server, the
22300 \begin_inset Quotes eld
22305 -file-row" function, to be used with
22313 \begin_layout Standard
22314 When debugging code with
22318 , it is possible to invoke a text editor at the current execution position
22319 with a single key stroke.
22322 configuration for that is shift-
22325 It happens that you can define the editor command line invocation in
22329 Edit\SpecialChar \menuseparator
22330 Preferences\SpecialChar \menuseparator
22333 dialog and changing the "Edit Sources" entry.
22336 \begin_layout Standard
22337 I take advantage of the new created LyX server function and this
22340 \begin_inset Quotes eld
22344 \begin_inset Quotes erd
22350 \begin_layout LyX-Code
22355 -file-row:@FILE@ @LINE@" >~/.
22360 \begin_layout Standard
22361 With this, whenever you are using
22363 and find a point in the program that you want to edit, you just press shift-
22369 you forward this information to LyX through the LyX server and then the
22370 LyX window will show the same file with the cursor at the same position
22374 No more guessing or long scrolling to locate a point in the program back
22378 \begin_layout Standard
22379 Note however that you must enable the LyX server to get this feature working
22380 (it is disabled by default).
22381 You can enable it in
22393 ) by entering in the
22399 \begin_inset Quotes eld
22404 /home/<your-home-directory>/.
22410 \begin_inset Quotes erd
22416 \begin_layout Standard
22417 Read the LyX server documentation in the
22419 Customization Manual
22421 for further information.
22424 \begin_layout Subsubsection
22428 \begin_layout Standard
22429 There are six new buttons that can be added to your LyX toolbar.
22430 Five of these buttons are short cuts to layout styles:
22451 The last one is a short cut to the
22452 \begin_inset Quotes eld
22456 \begin_inset Quotes erd
22463 \begin_layout Standard
22464 LyX has a range of buttons that are available for tool bar customization.
22465 In my toolbar I like to combine the six short cuts above with two more:
22470 \SpecialChar \menuseparator
22475 \SpecialChar \menuseparator
22482 View\SpecialChar \menuseparator
22487 Here is how it looks like:
22490 \begin_layout LyX-Code
22494 \begin_layout LyX-Code
22498 \begin_layout LyX-Code
22499 Icon "layout Standard"
22502 \begin_layout LyX-Code
22503 Icon "layout Section"
22506 \begin_layout LyX-Code
22512 \begin_layout LyX-Code
22513 Icon "layout LyX-Code"
22516 \begin_layout LyX-Code
22517 Icon "layout Scrap"
22520 \begin_layout LyX-Code
22524 \begin_layout LyX-Code
22528 \begin_layout LyX-Code
22529 Icon "buffer-typeset"
22532 \begin_layout LyX-Code
22533 Icon "build-program"
22536 \begin_layout LyX-Code
22540 \begin_layout LyX-Code
22544 \begin_layout LyX-Code
22548 \begin_layout LyX-Code
22552 \begin_layout LyX-Code
22556 \begin_layout Subsubsection
22557 Colors customization
22560 \begin_layout Standard
22561 There are a number of colors in LyX that can be customized in
22566 One of the things that bothers people is the
22569 The default color is red, since the scraps uses
22571 font, and there is a lot of scraps in literate documents, you may get tired
22572 of seeing everything in red.
22573 You can change it by going to the tabs
22582 \begin_layout Standard
22583 The next thing is the visible presence of the newline character in the screen.
22584 You can choose the color of this particular character and make it blend
22586 I recommend you choosing a color that is close to the background but not
22587 equal, that way you still can see it is there, but it is not bothering
22592 \begin_layout Chapter
22596 \begin_inset CommandInset label
22605 \begin_layout Standard
22606 Though LyX is a powerful tool, it cannot hope to support everything that
22607 can be done with pure TeX/
22610 However, many familiar dirty TeX and
22612 tricks can be done within LyX, as long as you are not afraid to use that
22614 \begin_inset Quotes eld
22618 \begin_inset Quotes erd
22621 button on the toolbar or add things to the
22624 This section lists some tips, tricks, and otherwise cool ideas to give
22625 your document that extra little flair.
22628 Do try this at home
22630 , just start with something a little smaller and less important than your
22634 \begin_layout Standard
22635 Most ideas in this section require less common files in your
22638 If you have a system like
22640 , most will already be available.
22641 A few, however, will need to be downloaded from one of the
22644 Often, there are several ways to do something, or several
22646 style files which do the same thing.
22647 We do not endorse one choice over another, we simply claim that we have
22648 done a particular task with a particular file.
22649 Put on your wizard hat, keep an eye out for dragons, and let us begin.
22652 \begin_layout Section
22656 \begin_layout Standard
22665 \begin_layout Subsection
22669 \begin_layout Standard
22670 The aim for this chapter
22674 \begin_layout Plain Layout
22677 original chapter was a masterful description of how to use the
22682 However, it was too long to flow smoothly in this document.
22683 I have therefore chosen to excerpt the most important sections here (sorry,
22684 Lars); you can read the original chapter (and more of the story!) in the
22705 can be used in a LyX document.
22706 As LyX doesn't support the
22712 yet, we have to use some small hacks.
22713 By reading this section it should be obvious how to do this.
22716 \begin_layout Subsection
22720 \begin_layout Standard
22725 package allows switching between one and
22727 format on the same page.
22728 Footnotes are handled correctly (for the most part), but will be placed
22729 at the bottom of the page and not under each column.
22732 float mechanism, however, is partly disabled in the current implementation.
22733 At the moment only page-wide floats can be used within the scope of the
22737 \begin_layout Subsection
22741 \begin_layout Subsubsection
22745 \begin_layout Standard
22746 If you want to have two columns in your text, you have use
22756 at the point where you want the two column layout to start, and then
22764 where you want it to end.
22768 \begin_layout Standard
22772 \begin_layout Plain Layout
22776 begin{multicols}{2}
22784 \begin_layout Standard
22789 The Adventure of the Empty House
22792 \begin_inset Newline newline
22797 Sir Arthur Conan Doyle
22800 \begin_layout Standard
22803 It was in the spring of the year
22805 that all London was interested, and the fashionable world dismayed, by
22808 Ronald Adair under most unusual and inexplicable circumstances.
22809 The public has already learned those particulars of the crime which came
22810 out in the police investigation, but a good deal was suppressed upon that
22811 occasion, since the case for the prosecution was so overwhelmingly strong
22812 that it was not necessary to bring forward all the facts.
22813 Only now, at the end of nearly ten years, am I allowed to supply those
22814 missing links which make up the whole of that remarkable chain.
22815 The crime was of interest in itself, but that interest was as nothing to
22816 me compared to the inconceivable sequel, which afforded me the greatest
22817 shock and surprise of any event in my adventurous life.
22818 Even now, after this long interval, I find myself thrilling as I think
22819 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22820 ty which utterly submerged my mind.
22821 Let me say to that public, which has shown some interest in those glimpses
22822 which I have occasionally given them of the thoughts and actions of a very
22823 remarkable man, that they are not to blame me if I have not shared my knowledge
22824 with them, for I should have considered it my first duty to do so, had
22825 I not been barred by a positive prohibition from his own lips, which was
22826 only withdrawn upon the third of last month.
22829 \begin_layout Standard
22833 \begin_layout Plain Layout
22845 \begin_layout Subsubsection
22849 \begin_layout Standard
22850 The same pattern is used when you want more than two columns:
22853 \begin_layout Standard
22857 \begin_layout Plain Layout
22861 begin{multicols}{3}
22869 \begin_layout Standard
22872 It can be imagined that my close intimacy with Sherlock Holmes had interested
22873 me deeply in crime, and that after his disappearance I never failed to
22874 read with care the various problems which came before the public.
22875 And I even attempted, more than once, for my own private satisfaction,
22876 to employ his methods in their solution, though with indifferent success.
22877 There was none, however, which appealed to me like this tragedy of Ronald
22879 As I read the evidence at the inquest, which led up to a verdict of willful
22880 murder against some person or persons unknown, I realized more clearly
22881 than I had ever done the loss which the community had sustained by the
22882 death of Sherlock Holmes.
22883 There were points about this strange business which would, I was sure,
22884 have specially appealed to him, and the efforts of the police would have
22885 been supplemented, or more probably anticipated, by the trained observation
22886 and the alert mind of the first criminal agent in Europe.
22887 All day, as I drove upon my round, I turned over the case in my mind and
22888 found no explanation which appeared to me to be adequate.
22889 At the risk of telling a twice-told tale, I will recapitulate the facts
22890 as they were known to the public at the conclusion of the inquest.
22893 \begin_layout Standard
22897 \begin_layout Plain Layout
22909 \begin_layout Standard
22910 You can have more than 3 columns if you want to, but that might not be very
22911 pleasant for the eye.
22914 \begin_layout Subsubsection
22915 Columns inside columns
22918 \begin_layout Standard
22919 You can even have columns inside columns:
22922 \begin_layout Standard
22926 \begin_layout Plain Layout
22930 begin{multicols}{2}
22938 \begin_layout Standard
22943 Ronald Adair was the second son of the Earl of
22945 , at that time governor of one of the Australian colonies.
22946 Adair's mother had returned from Australia to undergo the operation for
22947 cataract, and she, her son Ronald, and her daughter Hilda were living together
22953 \begin_layout Standard
22957 \begin_layout Plain Layout
22961 begin{multicols}{2}
22969 \begin_layout Standard
22972 The youth moved in the best society–had, so far as was known, no enemies
22973 and no particular vices.
22974 He had been engaged to Miss Edith
22978 , but the engagement had been broken off by mutual consent some months before,
22979 and there was no sign that it had left any very profound feeling behind
22981 For the rest {sic} the man's life moved in a narrow and conventional circle,
22982 for his habits were quiet and his nature unemotional.
22983 Yet it was upon this easy-going young aristocrat that death came, in most
22984 strange and unexpected form, between the hours of ten and eleven-twenty
22985 on the night of March
22992 \begin_layout Standard
22996 \begin_layout Plain Layout
23008 \begin_layout Standard
23011 Ronald Adair was fond of cards–playing continually, but never for such stakes
23013 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
23014 It was shown that, after dinner on the day of his death, he had played
23015 a rubber of whist at the latter club.
23016 He had also played there in the afternoon.
23021 The evidence of those who had played with him– Mr.
23022 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
23023 and that there was a fairly equal fall of the cards.
23024 Adair might have lost five pounds, but not more.
23025 His fortune was a considerable one, and such a loss could not in any way
23027 He had played nearly every day at one club or other, but he was a cautious
23028 player, and usually rose a winner.
23029 It came out in evidence that, in partnership with Colonel Moran, he had
23030 actually won as much as four hundred and twenty pounds in a sitting, some
23031 weeks before, from Godfrey
23036 So much for his recent history as it came out at the inquest.
23039 \begin_layout Standard
23043 \begin_layout Plain Layout
23055 \begin_layout Standard
23056 Please do read the file
23063 for more advanced examples including column and header spacing, vertical
23064 separator lines, and more.
23067 \begin_layout Section
23072 Paragraph Environment
23073 \begin_inset OptArg
23076 \begin_layout Plain Layout
23077 Numbering in Enumerate
23085 \begin_layout Standard
23091 \begin_layout Standard
23092 \begin_inset VSpace bigskip
23098 \begin_layout Standard
23100 The default numbering for the
23104 paragraph environment begins with Arabic numbers and ends with uppercase
23106 Suppose, however, you wanted a different type of numbering scheme.
23107 Here's a quickie example of how to change the numbering scheme:
23110 \begin_layout LyX-Code
23126 \begin_layout LyX-Code
23144 \begin_layout LyX-Code
23162 \begin_layout LyX-Code
23180 \begin_layout Standard
23181 \SpecialChar \ldots{}
23182 which changes the numbering scheme to uppercase Roman numerals, uppercase
23183 letters, Arabic numbers, and lowercase letter.
23186 \begin_layout Standard
23187 Additionally, the previous example also adds a little bit extra to the numbering
23189 For example, the first level label actually looks like:
23190 \begin_inset Quotes eld
23194 \begin_inset Quotes erd
23198 For ease of reading, we'll describe what the numbering schemes look like
23199 using a notation something like this: <
23200 \begin_inset Quotes eld
23204 \begin_inset Quotes erd
23208 \begin_inset space ~
23212 \begin_inset Quotes erd
23216 \begin_inset Quotes erd
23220 \begin_inset space ~
23224 \begin_inset Quotes erd
23228 \begin_inset Quotes erd
23232 \begin_inset space ~
23236 \begin_inset Quotes eld
23240 \begin_inset Quotes erd
23247 \begin_layout Standard
23248 As you can see in the example, there is a label command for each nesting
23256 \SpecialChar \ldots{}
23264 , as well as a counter,
23268 \SpecialChar \ldots{}
23274 There are also five
23275 \begin_inset Quotes eld
23279 \begin_inset Quotes erd
23318 , each of which take one counter as an argument.
23319 You can add characters before or after these, but there's no need to add
23323 \begin_layout Standard
23324 You can get really fancy with these.
23328 \begin_layout LyX-Code
23350 \begin_layout LyX-Code
23374 \begin_layout LyX-Code
23392 \begin_layout LyX-Code
23408 \begin_layout Standard
23409 produces the somewhat out of hand numbering scheme: <
23410 \begin_inset Quotes eld
23414 \begin_inset Quotes erd
23418 \begin_inset space ~
23422 \begin_inset Quotes erd
23426 \begin_inset Quotes erd
23430 \begin_inset space ~
23434 \begin_inset Quotes erd
23438 \begin_inset Quotes erd
23442 \begin_inset space ~
23446 \begin_inset Quotes eld
23450 \begin_inset Quotes erd
23457 \begin_layout Standard
23461 \begin_layout Section
23465 \begin_layout Standard
23472 \begin_layout Standard
23473 \begin_inset VSpace bigskip
23479 \begin_layout Standard
23484 \begin_layout Plain Layout
23490 tmpfont}{cmr17 scaled 2500}{
23502 \begin_layout Standard
23507 \begin_layout Plain Layout
23518 hose of you who like the style of old books probably also like
23519 \begin_inset Quotes eld
23523 \begin_inset Quotes erd
23526 —those large capital letters which begin each new chapter or section.
23527 Implementing them with plain LyX/
23529 is straightforward (assuming you know some plain TeX!) but does require
23530 a lot of work and many iterations, as you can see by all the ugly TeX-mode
23531 stuff at the beginning of this paragraph.
23534 \begin_layout Standard
23538 \begin_layout Plain Layout
23544 bigdrop{-1em}{3}{ptmri}{T}+
23549 here is a much easier way of doing this, of course.
23560 allows a simple way to add such letters to your documents.
23561 Since this package is not a standard part of
23563 , I can't demonstrate it within this document, but if you copy this paragraph
23564 to a new document, delete the
23565 \begin_inset Quotes eld
23575 \begin_inset Quotes erd
23578 and the pluses from the TeX code at the beginning of the paragraph, and
23591 preamble, you will get a nice Times Roman Italic
23592 \begin_inset Quotes eld
23596 \begin_inset Quotes erd
23599 , whose height is three lines of text and which protrudes 1 em into the
23601 (Make certain you have copied
23602 \begin_inset Quotes eld
23611 \begin_inset Quotes erd
23614 into a directory where TeX can see it.) The first argument is the amount
23615 of indentation; in this case the negative sign moves it into the margin.
23616 The second argument is the height of the letter in number of lines of text.
23617 The third argument is the font name: virtually anything which has a
23619 file should work (wade through the
23626 directory for possibilities).
23627 My personal favorite is
23628 \begin_inset Quotes eld
23636 \begin_inset Quotes erd
23639 , a fancy German font specifically designed for dropped capitals.
23640 The fourth argument is the letter (or letters) to be dropped.
23645 package also offers the
23652 command, as well as a slightly simplified
23661 \begin_layout Section
23662 Non-standard Paragraph Shapes
23665 \begin_layout Standard
23672 \begin_layout Standard
23673 \begin_inset VSpace bigskip
23679 \begin_layout Standard
23683 \begin_layout Plain Layout
23695 \begin_layout Standard
23699 \begin_layout Plain Layout
23708 \begin_layout Plain Layout
23722 \begin_layout Standard
23727 \begin_layout Plain Layout
23738 \begin_layout Plain Layout
23747 \begin_layout Plain Layout
23756 \begin_layout Plain Layout
23765 \begin_layout Plain Layout
23774 \begin_layout Plain Layout
23783 \begin_layout Plain Layout
23792 \begin_layout Plain Layout
23801 \begin_layout Plain Layout
23810 \begin_layout Plain Layout
23819 \begin_layout Plain Layout
23828 \begin_layout Plain Layout
23837 \begin_layout Plain Layout
23846 \begin_layout Plain Layout
23855 \begin_layout Plain Layout
23864 \begin_layout Plain Layout
23873 \begin_layout Plain Layout
23882 \begin_layout Plain Layout
23891 \begin_layout Plain Layout
23900 \begin_layout Plain Layout
23906 There are times when the tyranny of rectangular paragraphs must be overthrown.
23907 In such situations, a call to the delightful plain TeX command
23915 As you can see, completely arbitrary shapes can be laid out with a suitable
23921 may look a bit silly and useless, one could conceive of situations such
23922 as finely tuned dropped capitals, word wrapping around non-rectangular
23924 which will benefit from such handcrafting.
23927 \begin_layout Standard
23928 \begin_inset VSpace bigskip
23934 \begin_layout Standard
23951 \SpecialChar \ldots{}
23961 is the number of lines of text which define the paragraph.
23962 If there turn out to be fewer lines, the shape is truncated; if there are
23963 more, the excess lines have the same dimensions as the last line of the
23975 entries specify the indentation of the line from the left margin, and the
23976 length of the line as measured from that point.
23977 The shape applies only to the current paragraph; everything is reset to
23978 normal for the next paragraph.
23981 \begin_layout Standard
23985 \begin_layout Plain Layout
23997 \begin_layout Section
24001 \begin_layout Standard
24002 As you can see, the examples in this section range from the useful to the
24004 While I don't expect that anyone will ever need the paragraph shape demonstrate
24005 d in the last section, the important point is that you can do almost anything
24006 you want in LyX if you are willing to figure out how to do it in TeX and
24010 TeX is a fantastically powerful typesetting system and all that power is
24011 available to you since LyX uses it as its