1 #LyX 1.6.2svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \use_default_options false
56 InsetLayout CharStyle:MenuItem
65 \newcommand*{\menuitem}[1]{{\sffamily #1}}
73 \font_typewriter default
74 \font_default_family default
84 \pdf_title "LyX's Extended manual"
85 \pdf_author "LyX Team"
86 \pdf_subject "LyX's extended documentation"
87 \pdf_keywords "LyX, Documentation, Extended"
89 \pdf_bookmarksnumbered true
90 \pdf_bookmarksopen false
91 \pdf_bookmarksopenlevel 1
96 \pdf_pdfusetitle false
97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
104 \paperorientation portrait
107 \paragraph_separation indent
109 \quotes_language english
112 \paperpagestyle headings
113 \tracking_changes false
114 \output_changes false
122 Additional LyX Features
130 \begin_layout Plain Layout
132 Principal maintainer of this file is
137 If you have comments or error corrections, please send them to the LyX
138 Documentation mailing list,
139 \begin_inset Flex CharStyle:Code
142 \begin_layout Plain Layout
144 <lyx-docs@lists.lyx.org>
157 \begin_layout Standard
158 \begin_inset CommandInset toc
159 LatexCommand tableofcontents
166 \begin_layout Chapter
170 \begin_layout Standard
171 This manual is essentially Part II of the
173 User's Guide\SpecialChar \@.
176 The reason for separating this document out is simple: the
180 is already quite lengthy, and it contains information on all of the basic
181 features one needs to know in order to prepare most documents.
182 However, the LyX Team has worked to LyX extensible through various configuratio
183 n files and external packages.
184 That means that if you want to support the Fizzwizzle LaTeX package, you
185 can create a layout file (or module) for it without having to alter LyX
187 We've already had contributions of several new features this way.
188 This is the place where all of those get documented.
191 \begin_layout Standard
192 This manual also documents some special features, like fax support, version
193 control, and SGML support, which require additional software to work properly.
194 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
195 spruce up your documents by directly using the powerful features of LaTeX.
200 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
203 \begin_layout Standard
204 If you haven't read the
208 yet, you are definitely in the wrong manual.
213 is the first place to go, since it describes the notation and format of
215 You should also be thoroughly familiar with the
219 and all of the basic features of LyX before attempting to read this one.
222 \begin_layout Standard
223 Since all the topics in this manual depend heavily on LyX's interaction
224 with LaTeX, this first chapter covers the inner workings of LyX and how
225 to direct LyX to generate exactly the LaTeX code you want.
226 It is obviously for more seasoned LyX users.
229 \begin_layout Chapter
233 \begin_layout Section
237 \begin_layout Standard
238 This chapter is for both TeX-nicians and the LaTeX-curious.
239 In it, we'll explain how LyX and LaTeX work together to produce printable
241 This is the only place in any of the manuals where we assume you know something
245 \begin_layout Standard
246 At one time, LyX was called a
247 \begin_inset Quotes eld
250 WYSIWYM frontend to LaTeX,
251 \begin_inset Quotes erd
254 but that's no longer true.
255 There are frontends to LaTeX out there.
259 \begin_layout Plain Layout
260 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
261 There are also the LaTeX modes for vi and emacs, of course.
266 These are basically text editors with the ability to run LaTeX and mark
267 any errors in the file you're editing.
276 run LaTeX, and it also indicates errors in the file, it also does much,
278 For one thing, you don't need to know LaTeX to use LyX effectively.
279 And LyX has added its own extensions to LaTeX.
280 Try the following sometime: select
281 \begin_inset Flex CharStyle:MenuItem
284 \begin_layout Plain Layout
285 Export\SpecialChar \menuseparator
292 \begin_inset Flex CharStyle:MenuItem
295 \begin_layout Plain Layout
302 \begin_inset Flex CharStyle:MenuItem
305 \begin_layout Plain Layout
306 View\SpecialChar \menuseparator
312 ), then look at the preamble of the resulting
313 \begin_inset Flex CharStyle:Code
316 \begin_layout Plain Layout
323 You'll notice a variety of new macros defined specifically by LyX.
324 These macros are defined automatically, according to the features you use
328 \begin_layout Standard
329 There are several commands that automatically invoke LaTeX.
333 \begin_layout Itemize
334 \begin_inset Flex CharStyle:MenuItem
337 \begin_layout Plain Layout
338 View\SpecialChar \menuseparator
347 \begin_layout Itemize
348 \begin_inset Flex CharStyle:MenuItem
351 \begin_layout Plain Layout
352 View\SpecialChar \menuseparator
353 Update\SpecialChar \menuseparator
362 \begin_layout Itemize
363 \begin_inset Flex CharStyle:MenuItem
366 \begin_layout Plain Layout
367 File\SpecialChar \menuseparator
376 \begin_layout Itemize
377 \begin_inset Flex CharStyle:MenuItem
380 \begin_layout Plain Layout
381 File\SpecialChar \menuseparator
390 \begin_layout Standard
391 They will only invoke LaTeX if the file has changed since the last time
396 \begin_layout Standard
397 When LyX runs LaTeX on the file you're editing, it performs these steps:
400 \begin_layout Enumerate
401 Convert the document to LaTeX and save to a file with the extension
402 \begin_inset Flex CharStyle:Code
405 \begin_layout Plain Layout
412 \begin_inset Flex CharStyle:Code
415 \begin_layout Plain Layout
424 \begin_layout Enumerate
426 \begin_inset Flex CharStyle:Code
429 \begin_layout Plain Layout
435 file (maybe several times), and run any other commands (such as
436 \begin_inset Flex CharStyle:Code
439 \begin_layout Plain Layout
446 \begin_inset Flex CharStyle:Code
449 \begin_layout Plain Layout
455 ) needed to compile the LaTeX file.
458 \begin_layout Enumerate
459 If there are any errors, show the error log.
462 \begin_layout Standard
463 If you've run LaTeX using
464 \begin_inset Flex CharStyle:MenuItem
467 \begin_layout Plain Layout
470 \SpecialChar \menuseparator
478 , LyX then runs a DVI viewer to display the DVI-file.
480 \begin_inset Flex CharStyle:MenuItem
483 \begin_layout Plain Layout
486 \SpecialChar \menuseparator
494 , LyX performs further steps:
497 \begin_layout Itemize
499 \begin_inset Flex CharStyle:Code
502 \begin_layout Plain Layout
508 to convert the DVI file to PostScript.
511 \begin_layout Itemize
512 Run a PostScript viewer, such as
513 \begin_inset Flex CharStyle:Code
516 \begin_layout Plain Layout
522 , to display the PostScript file.
525 \begin_layout Standard
526 LyX does similar things when viewing, or exporting, other formats.
529 \begin_layout Section
530 Translating LaTeX files into LyX
533 \begin_layout Standard
534 You can import a LaTeX file into LyX by using the
535 \begin_inset Flex CharStyle:MenuItem
538 \begin_layout Plain Layout
539 File\SpecialChar \menuseparator
540 Import\SpecialChar \menuseparator
547 This will call a program named
548 \begin_inset Flex CharStyle:Code
551 \begin_layout Plain Layout
557 which will create a file
558 \begin_inset Flex CharStyle:Code
561 \begin_layout Plain Layout
568 \begin_inset Flex CharStyle:Code
571 \begin_layout Plain Layout
578 LyX will then open that file.
582 \begin_layout Plain Layout
583 \begin_inset Flex CharStyle:Code
586 \begin_layout Plain Layout
592 can also be run from the command line, of course.
600 \begin_layout Standard
601 \begin_inset Flex CharStyle:Code
604 \begin_layout Plain Layout
610 will translate most legal LaTeX, but not everything.
611 It will put things it doesn't understand into TeX code, so after translating
613 \begin_inset Flex CharStyle:Code
616 \begin_layout Plain Layout
622 , you can look for TeX code and hand-edit it until it looks right.
625 \begin_layout Standard
626 If you don't know what TeX code is, read the next section.
629 \begin_layout Section
630 \begin_inset CommandInset label
632 name "sec:Inserting-TeX-Code"
636 Inserting TeX Code into LyX Documents
639 \begin_layout Standard
640 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
641 You can always insert TeX code into any LyX document.
642 LyX cannot, and will never be able to, display every possible LaTeX construct.
643 If ever you need to insert LaTeX commands into your LyX document, you can
645 \begin_inset Flex CharStyle:Code
648 \begin_layout Plain Layout
654 box, which you can insert into your document with
655 \begin_inset Flex CharStyle:MenuItem
658 \begin_layout Plain Layout
659 Insert\SpecialChar \menuseparator
668 \begin_layout Standard
669 Here's an example of inserting LaTeX commands in a LyX document.
670 The code looks like this:
673 \begin_layout LyX-Code
677 \begin_inset Newline newline
683 \begin_inset Newline newline
686 This is an example for a minipage environment.
688 \begin_inset Newline newline
691 can put nearly everything in it, even (non-floating)
692 \begin_inset Newline newline
697 \begin_inset Newline newline
703 \begin_inset Newline newline
707 \begin_inset Newline newline
713 \begin_inset Newline newline
719 \begin_inset Newline newline
725 \begin_inset Newline newline
730 \begin_inset Newline newline
736 \begin_inset Newline newline
742 \begin_inset Newline newline
748 \begin_inset Newline newline
756 \begin_layout LyX-Code
760 \begin_layout Standard
762 \begin_inset Flex CharStyle:Code
765 \begin_layout Plain Layout
771 box containing this text is directly after this paragraph.
772 Those of you reading the manual in LyX will only see the TeX code inset.
773 Those reading a printed version of the manuals will see the actual results:
776 \begin_layout Standard
780 \begin_layout Plain Layout
787 \begin_layout Plain Layout
794 \begin_layout Plain Layout
796 This is an example for a minipage environment.
797 You can put nearly everything in it, even (non-floating) figures and tables.
801 \begin_layout Plain Layout
808 \begin_layout Plain Layout
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
827 \begin_layout Plain Layout
834 \begin_layout Plain Layout
840 \begin_layout Plain Layout
847 \begin_layout Plain Layout
854 \begin_layout Plain Layout
861 \begin_layout Plain Layout
873 \begin_layout Standard
874 In addition to using TeX code, you can also create a separate file containing
875 some complex LaTeX structure and then use
876 \begin_inset Flex CharStyle:MenuItem
879 \begin_layout Plain Layout
880 Insert\SpecialChar \menuseparator
890 to include your file (you should select the type
891 \begin_inset Flex CharStyle:Code
894 \begin_layout Plain Layout
901 We recommend that you only do this if you have a
902 \begin_inset Flex CharStyle:Code
905 \begin_layout Plain Layout
916 Otherwise, you'll have a big job tracking down LaTeX errors.
919 \begin_layout Standard
920 There are a few last points to emphasize:
923 \begin_layout Itemize
928 check if your LaTeX code is correct.
931 \begin_layout Itemize
932 Beware reinventing the wheel.
935 \begin_layout Standard
936 On that last point, LyX does have quite a few features tucked into it, and
938 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
939 feature before you decide you have to do it by hand.
940 Moreover, there are numerous LaTeX packages out there to do all sorts of
941 things, from labels to envelopes to fancy multipage tables.
943 \begin_inset CommandInset href
946 target "http://www.ctan.org/"
950 for details, and see chapter
951 \begin_inset CommandInset ref
953 reference "cha:secrets"
960 \begin_layout Standard
961 If you do need to do some wild and fancy things within your document, be
962 sure to check out a good LaTeX book for assistance.
963 There are a number of them listed in the bibliography of the
970 \begin_layout Section
971 LyX and the LaTeX Preamble
974 \begin_layout Subsection
975 About the LaTeX Preamble
978 \begin_layout Standard
979 If you already know LaTeX, there is no need to explain here what the preamble
981 If you don't, the following will give you some ideas—we recommend again
982 that you consult a LaTeX book for further information.
983 In any case, you should read the points below, because they explain what
984 you can do and what you don't need to do in the LaTeX preamble of a LyX
988 \begin_layout Standard
989 The LaTeX preamble comes at the very beginning of a document,
997 \begin_layout Itemize
998 Declare the document class.
1000 \begin_inset Newline newline
1003 LyX already does this for you.
1004 If you're a seasoned LaTeX-nician, and you have a custom document class
1005 you want to use, check out the
1007 Customization Manual
1009 for information on how to make LyX interface to it.
1012 \begin_layout Itemize
1013 Declare the usage of packages.
1015 \begin_inset Newline newline
1018 LaTeX packages provide special commands, which are only available within
1019 a document when the package has been declared in the preamble.
1020 For example, the package
1021 \begin_inset Flex CharStyle:Code
1024 \begin_layout Plain Layout
1030 forces all paragraphs to be indented.
1031 There are other packages for labels, envelopes, margins, etc.
1035 \begin_layout Itemize
1036 Set counters, variables, lengths and widths.
1038 \begin_inset Newline newline
1041 There are several LaTeX counters and variables which
1045 be set globally from within the preamble in order to have the desired effect.
1046 (There are variables which you can set and reset inside the document, too.)
1047 Margins are a good example of something which must be set in the preamble.
1048 Another example is the label format for lists.
1049 You can actually set these just about anywhere, but it's best to do it
1050 just once, inside the preamble.
1053 \begin_layout Itemize
1054 Declare user defined commands (with
1055 \begin_inset Flex CharStyle:Code
1058 \begin_layout Plain Layout
1067 \begin_inset Flex CharStyle:Code
1070 \begin_layout Plain Layout
1079 \begin_inset Newline newline
1082 These are abbreviations for LaTeX commands which appear very often inside
1084 Although the preamble is a good place to declare such commands, they
1088 be declared anywhere (before they are used for the first time, of course).
1089 This can be useful if there is a lot of raw LaTeX code in your document,
1090 which normally should not be the case.
1093 \begin_layout Standard
1094 LyX adds its own set of definitions to the preamble of the
1095 \begin_inset Flex CharStyle:Code
1098 \begin_layout Plain Layout
1105 This makes LaTeX files generated by LyX portable.
1108 \begin_layout Subsection
1109 Changing the Preamble
1112 \begin_layout Standard
1113 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1114 can't change them without patching LyX itself.
1115 You can, however, add your own stuff to the preamble by selecting
1116 \begin_inset Flex CharStyle:MenuItem
1119 \begin_layout Plain Layout
1121 \begin_inset space ~
1130 \begin_inset Flex CharStyle:MenuItem
1133 \begin_layout Plain Layout
1134 Document\SpecialChar \menuseparator
1141 LyX adds anything in the
1142 \begin_inset Flex CharStyle:MenuItem
1145 \begin_layout Plain Layout
1151 dialog to its own built-in preamble.
1152 Before adding your own declarations in the preamble, you should make sure
1153 that LyX doesn't already support what you want to do.
1154 (Remember what we said about reinventing the wheel?) Also,
1156 make sure your preamble code is correct
1159 LyX doesn't check it for you.
1160 If there is an error, you're likely to get an error like
1161 \begin_inset Quotes eld
1165 \begin_inset Flex CharStyle:Code
1168 \begin_layout Plain Layout
1177 \begin_inset Quotes erd
1181 If you see this error, check your preamble.
1184 \begin_layout Subsection
1188 \begin_layout Standard
1189 Here are some examples of what you can add to a preamble, and what they
1193 \begin_layout Subsubsection
1197 \begin_layout Standard
1198 There are two variables under LaTeX that control page position:
1199 \begin_inset Flex CharStyle:Code
1202 \begin_layout Plain Layout
1211 \begin_inset Flex CharStyle:Code
1214 \begin_layout Plain Layout
1223 Their names should be self-explanatory.
1224 These variables are useful if you think for a moment about computer labels.
1225 Sometimes, the size of a print medium and the area of the medium that you
1226 can actually print on aren't the same.
1228 \begin_inset Flex CharStyle:Code
1231 \begin_layout Plain Layout
1240 \begin_inset Flex CharStyle:Code
1243 \begin_layout Plain Layout
1254 \begin_layout Standard
1255 The default values for
1256 \begin_inset Flex CharStyle:Code
1259 \begin_layout Plain Layout
1268 \begin_inset Flex CharStyle:Code
1271 \begin_layout Plain Layout
1280 \begin_inset space \thinspace{}
1284 \begin_inset space \thinspace{}
1288 \begin_inset space \space{}
1291 the page isn't shifted.
1292 Unfortunately, some DVI drivers always seem to shift the page.
1293 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1294 If you're using LyX on a system that you don't personally maintain, and
1295 your sysadmin is a doofus,
1296 \begin_inset Flex CharStyle:Code
1299 \begin_layout Plain Layout
1308 \begin_inset Flex CharStyle:Code
1311 \begin_layout Plain Layout
1320 Suppose you're left and top margins are always 0.5
1321 \begin_inset space \thinspace{}
1325 You can add this to the preamble:
1328 \begin_layout LyX-Code
1336 \begin_layout LyX-Code
1344 \begin_layout Standard
1345 and your margins should now be correct.
1348 \begin_layout Subsubsection
1352 \begin_layout Standard
1353 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1354 There's a rather nice package, available at your nearest CTAN archive,
1355 for printing sheets of labels:
1356 \begin_inset Flex CharStyle:Code
1359 \begin_layout Plain Layout
1366 Now, your system may not have this package installed by default.
1367 We leave that up to you to check.
1368 You'll also want to read the documentation for it; we're not going to do
1370 Since this is an example, however, we'll give you an example of how you
1374 \begin_layout Standard
1375 First, make sure you're using the
1376 \begin_inset Flex CharStyle:Code
1379 \begin_layout Plain Layout
1386 Next, you need to put the following in your preamble:
1389 \begin_layout LyX-Code
1395 \begin_layout LyX-Code
1401 \begin_layout LyX-Code
1407 \begin_layout LyX-Code
1413 \begin_layout LyX-Code
1419 \begin_layout LyX-Code
1425 \begin_layout LyX-Code
1431 \begin_layout Standard
1432 This sets things up for Avery label sheets, stock #5360.
1433 You're now ready to print labels, but you'll need to insert LaTeX code,
1434 placing the commands
1435 \begin_inset Flex CharStyle:Code
1438 \begin_layout Plain Layout
1447 \begin_inset Flex CharStyle:Code
1450 \begin_layout Plain Layout
1458 around each label text.
1459 This and other special features of
1460 \begin_inset Flex CharStyle:Code
1463 \begin_layout Plain Layout
1469 are explained in its documentation.
1472 \begin_layout Standard
1473 Someday, someone may write a LyX layout file to support this package directly.
1474 Maybe that someone is you.
1477 \begin_layout Subsubsection
1478 Example #3: Paragraph Indentation
1481 \begin_layout Standard
1482 Americans are trained to indent the first line of
1487 As with all of their other weird quirks, most Americans will whine and
1488 moan until they can have their way and indent the first line of all paragraphs.
1497 \begin_layout Standard
1498 Of course, this behavior isn't standard typography.
1499 In books, you typically only indent the first line of a paragraph
1503 it follows another one.
1504 The idea behind indenting the first line of a paragraph is to distinguish
1505 neighboring paragraphs from one another.
1506 If there is no previous paragraph—for example, if it follows a figure or
1507 is the first paragraph in a section—then there is no need for indentation.
1511 \begin_layout Standard
1512 If you're a typical American (we're still joking!), though, you don't care
1513 about such esoteric things; you want your indentation! Add this to the
1517 \begin_layout LyX-Code
1520 usepackage{indentfirst}
1523 \begin_layout Standard
1524 If your TeX distribution isn't braindead, you'll have this package, and
1525 all of your paragraphs will get the indentation the Founding Fathers intended
1529 \begin_layout Subsubsection
1530 Example #4: This Document
1533 \begin_layout Standard
1534 You can also check out the preamble of this document to get an idea of some
1535 of the advanced things you can do.
1536 Also, there are more examples and an assortment of LaTeX
1537 \begin_inset Quotes eld
1541 \begin_inset Quotes erd
1545 \begin_inset space ~
1549 \begin_inset CommandInset ref
1551 reference "cha:secrets"
1559 \begin_layout Section
1560 LyX and LaTeX Errors
1563 \begin_layout Standard
1564 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1566 It then uses the logfile from the LaTeX run to do a post-mortem.
1567 After analyzing the logfile,LyX displays a dialog listing the errors.
1568 Clicking on any one of them will take you to the position in your LyX file
1569 where the error occurred.
1573 \begin_layout Plain Layout
1575 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1577 There are also cases where LaTeX reports the error on one line, but the
1578 actual error is earlier.
1579 This is not unlike forgetting a closing brace in a program: You'll get
1580 an error, but only later.
1588 \begin_layout Standard
1589 Some folks also like to look at the log file directly: It is available from
1591 \begin_inset Flex CharStyle:MenuItem
1594 \begin_layout Plain Layout
1597 \SpecialChar \menuseparator
1601 \begin_inset space ~
1610 There are some fairly common error messages and warnings.
1611 We'll cover those here.
1612 You should look at a good LaTeX book for a complete listing.
1615 \begin_layout Itemize
1616 \begin_inset Flex CharStyle:Code
1619 \begin_layout Plain Layout
1626 \begin_inset Newline newline
1629 Anything beginning with these words is a warning message for the purpose
1631 \begin_inset Quotes eld
1635 \begin_inset Quotes erd
1638 the LaTeX code itself.
1639 You'll get messages like this if you added or changed cross-references
1640 or bibliography entries, in which case, LaTeX is trying to tell you that
1641 you need to make another run.
1642 You can by-and-large ignore these.
1645 \begin_layout Itemize
1646 \begin_inset Flex CharStyle:Code
1649 \begin_layout Plain Layout
1656 \begin_inset Newline newline
1659 Another warning message, this time about fonts which LaTeX couldn't find.
1660 The rest of the message will often say something about a replacement font
1662 You can safely ignore these, too.
1665 \begin_layout Itemize
1666 \begin_inset Flex CharStyle:Code
1669 \begin_layout Plain Layout
1678 \begin_inset Newline newline
1686 They are warnings about lines that were too long and run past the right
1688 Almost always, this is unnoticeable in the final output.
1689 (It can be just a point or two.) Or, only one or two characters extend past
1691 LaTeX seems to generate at least one of these messages for just about any
1693 \begin_inset Newline newline
1696 You can ignore these messages.
1697 Your eyes will tell you if there's a problem with something that's too
1698 wide; just look at the output.
1702 \begin_layout Plain Layout
1703 You can also enable the `draft' option in
1704 \begin_inset Flex CharStyle:MenuItem
1707 \begin_layout Plain Layout
1710 \SpecialChar \menuseparator
1718 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1726 \begin_layout Itemize
1727 \begin_inset Flex CharStyle:Code
1730 \begin_layout Plain Layout
1739 \begin_inset Newline newline
1742 Not quite as common as its cousin.
1743 LaTeX seems to like to print lines that are a bit too wide as opposed to
1744 ones that are a bit too narrow.
1745 We have no idea why.
1748 \begin_layout Itemize
1749 \begin_inset Flex CharStyle:Code
1752 \begin_layout Plain Layout
1761 \begin_inset Flex CharStyle:Code
1764 \begin_layout Plain Layout
1773 \begin_inset Newline newline
1776 Warnings about troubles breaking the page.
1777 Once again, just look at the output.
1778 Your eyes will tell you where something has gone wrong.
1781 \begin_layout Itemize
1782 \begin_inset Flex CharStyle:Code
1785 \begin_layout Plain Layout
1787 \begin_inset Quotes els
1791 \begin_inset Quotes ers
1800 \begin_inset Newline newline
1804 \begin_inset Quotes eld
1808 \begin_inset Quotes erd
1811 isn't installed on this system.
1812 This usually appears because some package your document needs isn't installed.
1813 If you didn't touch the preamble or didn't use the
1814 \begin_inset Flex CharStyle:Code
1817 \begin_layout Plain Layout
1825 command, then one of the packages LyX tried to load is missing.
1827 \begin_inset Flex CharStyle:MenuItem
1830 \begin_layout Plain Layout
1831 Help\SpecialChar \menuseparator
1837 to get a list of packages that LyX knows about.
1838 This file is updated whenever you reconfigure LyX (using
1839 \begin_inset Flex CharStyle:MenuItem
1842 \begin_layout Plain Layout
1843 Tools\SpecialChar \menuseparator
1849 ) and tells you which packages have been detected and what they do.
1850 \begin_inset Newline newline
1854 \begin_inset Flex CharStyle:Code
1857 \begin_layout Plain Layout
1865 command and the package in question isn't installed, then you'll need to
1866 install it yourself.
1869 \begin_layout Itemize
1870 \begin_inset Flex CharStyle:Code
1873 \begin_layout Plain Layout
1874 LaTeX Error: Unknown option
1880 \begin_inset Newline newline
1883 Error messages beginning with this are trying to tell you that you specified
1884 a bad or undefined option to a package.
1885 Check the package's documentation.
1888 \begin_layout Itemize
1889 \begin_inset Flex CharStyle:Code
1892 \begin_layout Plain Layout
1893 Undefined control sequence
1899 \begin_inset Newline newline
1902 If you've inserted LaTeX code into your document, but made a typo, you'll
1904 You may have forgotten to load a package.
1905 In any case, this error message usually means that you used an undefined
1910 \begin_layout Standard
1911 There are other error and warning messages.
1912 Some are self-explanatory.
1913 These are usually LaTeX messages.
1914 Others are downright cryptic.
1915 These are usually TeX error messages, and we really have
1919 what they mean or how to decipher them.
1923 \begin_layout Standard
1924 There's a general sequence you should follow if you get error messages:
1927 \begin_layout Enumerate
1928 Look at the LaTeX code you inserted for typos.
1931 \begin_layout Enumerate
1932 If there are no typos, check that you used the command(s) correctly.
1935 \begin_layout Enumerate
1936 If you get a bunch of error boxes piled up at the very top of the document—and
1937 especially if you see a
1938 \begin_inset Quotes eld
1942 \begin_inset Flex CharStyle:Code
1945 \begin_layout Plain Layout
1954 \begin_inset Quotes erd
1957 error—it means that there are errors in the preamble.
1958 Start debugging your preamble.
1961 \begin_layout Enumerate
1962 If you didn't add anything to the preamble and didn't add any LaTeX code
1963 to the document, the first suspect is your LaTeX distribution itself.
1964 Check for missing packages and install them.
1967 \begin_layout Enumerate
1968 Okay, so there are no missing packages.
1969 Did you use any of the fine-tuning options in LyX? Specifically, did you
1974 any of them, like trying to manually insert lots of
1975 \begin_inset Flex CharStyle:Code
1978 \begin_layout Plain Layout
1980 \begin_inset space ~
1989 \begin_inset Flex CharStyle:Code
1992 \begin_layout Plain Layout
1999 \begin_inset Flex CharStyle:Code
2002 \begin_layout Plain Layout
2008 ? Did you try to kludge something together with these instead of using the
2009 appropriate paragraph environment?
2012 \begin_layout Enumerate
2013 All right, you didn't use any of the fine-tuning options, you played by
2015 Did you try to pull a fancy maneuver? Did you do something funky inside
2016 a table or an equation, like inserting a graphic into a table cell?
2019 \begin_layout Enumerate
2020 Do you have long sections of text where LaTeX cannot find a place to break
2021 a line? By default, LaTeX is rather strict about how much extra inter-word
2022 spacing it will add in order to break a line.
2023 Preferably, you should rework the paragraph to avoid the problem.
2024 If this isn't an option, you can wrap your text in
2025 \begin_inset Flex CharStyle:Code
2028 \begin_layout Plain Layout
2036 to make LaTeX's line breaking more, well, sloppy.
2039 \begin_layout Enumerate
2040 Did you go overboard with the nesting? LyX (currently) doesn't check to
2041 make sure you're in the limits for nesting environments.
2042 If you nested a bunch of environments to the
2043 \begin_inset Formula $17^{\mathrm{th}}$
2046 level, that's the problem.
2047 (The limit in LaTeX is five.)
2050 \begin_layout Enumerate
2051 Okay, you didn't get any error messages, but your output looks awful.
2052 If you have a table or figure that's too wide or long for the page, you
2057 \begin_layout Enumerate
2058 rescale the figure so it fits.
2061 \begin_layout Enumerate
2062 trim down the table so it fits.
2066 \begin_layout Enumerate
2067 If something else is wrong with the output, and you didn't try to pull anything
2068 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2071 \begin_layout Standard
2072 If all this doesn't help—well, then
2076 you might have found a bug in LyX\SpecialChar \ldots{}
2080 \begin_layout Chapter
2084 \begin_layout Section
2085 Customizing Bibliographies with BibTeX
2088 \begin_layout Standard
2089 The basics how to use BibTeX are explained in section
2091 Bibliography databases (BibTeX)
2098 The following subsections explain special bibliography features supported
2102 \begin_layout Subsection
2103 Alternative Citation Styles
2106 \begin_layout Standard
2107 Standard BibTeX uses numbers (e.
2108 \begin_inset space \thinspace{}
2112 \begin_inset space \space{}
2116 \begin_inset Quotes eld
2120 \begin_inset Quotes erd
2123 ) to refer to a cited work.
2124 However, in many scientific disciplines, other citation styles are in use.
2125 The most common one is the author-year style (e.
2126 \begin_inset space \thinspace{}
2130 \begin_inset space \space{}
2134 \begin_inset Quotes eld
2138 \begin_inset Quotes erd
2142 LyX supports two packages that provide this style,
2143 \begin_inset Flex CharStyle:Code
2146 \begin_layout Plain Layout
2153 \begin_inset Flex CharStyle:Code
2156 \begin_layout Plain Layout
2163 Both packages have their pros and cons, which cannot be listed in detail.
2164 If you only want to have simple author-year (or author-numerical) style,
2165 or if you want to use one of the countless style files for
2166 \begin_inset Flex CharStyle:Code
2169 \begin_layout Plain Layout
2175 , than the established
2176 \begin_inset Flex CharStyle:Code
2179 \begin_layout Plain Layout
2185 package is probably your choice.
2186 If you need special features like short title references, ibidem etc., you
2188 \begin_inset Flex CharStyle:Code
2191 \begin_layout Plain Layout
2200 \begin_layout Standard
2201 The handling of both packages in LyX is basically the same.
2203 \begin_inset Flex CharStyle:MenuItem
2206 \begin_layout Plain Layout
2207 Document\SpecialChar \menuseparator
2214 \begin_inset Flex CharStyle:MenuItem
2217 \begin_layout Plain Layout
2224 \begin_inset Flex CharStyle:MenuItem
2227 \begin_layout Plain Layout
2234 \begin_inset Flex CharStyle:MenuItem
2237 \begin_layout Plain Layout
2244 With both packages, you will get some extra features in the citation dialog
2245 and you can select the style of the reference (
2246 \begin_inset Quotes eld
2250 \begin_inset Quotes erd
2254 \begin_inset Quotes eld
2258 \begin_inset Quotes erd
2262 \begin_inset Quotes eld
2266 \begin_inset Quotes erd
2270 \begin_inset Quotes eld
2274 \begin_inset Quotes erd
2278 Note that both packages need specifically designed style files.
2279 They both ship their own, but there are lots of additional style files,
2280 and there is even an interactive style file builder
2284 \begin_layout Plain Layout
2286 \begin_inset Flex URL
2289 \begin_layout Plain Layout
2291 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2302 \begin_inset Flex CharStyle:Code
2305 \begin_layout Plain Layout
2314 \begin_layout Subsection
2315 Sectioned Bibliographies
2318 \begin_layout Standard
2319 Sometimes you might need to divide your bibliography into several sections.
2320 If you are for instance a historian, the possibility to separate sources
2321 and scientific works is most likely a
2322 \begin_inset Quotes eld
2326 \begin_inset Quotes erd
2330 Unfortunately, BibTeX itself does not allow you to do this.
2331 But with the help of some LaTeX packages, BibTeX can be extended to fit
2335 \begin_layout Standard
2336 LyX provides native support for one of these packages,
2344 \begin_layout Plain Layout
2346 \begin_inset Flex URL
2349 \begin_layout Plain Layout
2351 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2361 The advantage of this package (compared to other packages like
2365 ) is that you don't need to define new citation commands.
2366 Instead, you need to prepare different bibliographic databases which include
2367 the entries for the different sections of the bibliography.
2368 For example: If you want to divide your bibliography into the sections
2370 \begin_inset Quotes eld
2374 \begin_inset Quotes erd
2378 \begin_inset Quotes eld
2382 \begin_inset Quotes erd
2385 , you first need to create two bibliographic databases, e.
2386 \begin_inset space \thinspace{}
2390 \begin_inset space \space{}
2394 \begin_inset Flex CharStyle:Code
2397 \begin_layout Plain Layout
2404 \begin_inset Flex CharStyle:Code
2407 \begin_layout Plain Layout
2417 \begin_layout Standard
2419 \begin_inset Flex CharStyle:MenuItem
2422 \begin_layout Plain Layout
2423 Document\SpecialChar \menuseparator
2430 \begin_inset Flex CharStyle:MenuItem
2433 \begin_layout Plain Layout
2440 \begin_inset Flex CharStyle:MenuItem
2443 \begin_layout Plain Layout
2444 Sectioned bibliography
2450 Now you can insert multiple BibTeX bibliographies, one for each section
2451 of your bibliography.
2452 Returning to our example: Insert the BibTeX bibliography
2453 \begin_inset Flex CharStyle:Code
2456 \begin_layout Plain Layout
2462 and a second one for the database
2463 \begin_inset Flex CharStyle:Code
2466 \begin_layout Plain Layout
2473 You are free to use the same or different styles for each section.
2474 Additionally, you can chose if the bibliography section should contain
2476 \begin_inset Quotes eld
2479 all cited references
2480 \begin_inset Quotes erd
2483 of the specified database(s) (which is the default),
2484 \begin_inset Quotes eld
2487 all uncited references
2488 \begin_inset Quotes erd
2492 \begin_inset Quotes eld
2496 \begin_inset Quotes erd
2500 This might be useful if you would like to separate your bibliography into
2502 \begin_inset Quotes eld
2506 \begin_inset Quotes erd
2510 \begin_inset Quotes eld
2514 \begin_inset Quotes erd
2518 \begin_inset Quotes eld
2522 \begin_inset Quotes erd
2526 The titles for the sections can be added as ordinary sections or subsections.
2528 \begin_inset Flex CharStyle:Code
2531 \begin_layout Plain Layout
2537 removes the bibliography title, you have manually re-add that, too (as
2538 a chapter* or section*, for instance).
2541 \begin_layout Subsection
2542 Multiple Bibliographies
2545 \begin_layout Standard
2546 Multiple bibliographies, e.
2547 \begin_inset space \thinspace{}
2551 \begin_inset space \space{}
2554 a bibliography for each section or chapter of the document, are not supported
2557 \begin_inset Flex CharStyle:Code
2560 \begin_layout Plain Layout
2566 package, which is used for the creation of sectioned bibliographies in
2567 LyX (see the previous section), provides an easy way to solve this task,
2568 if you are willing to use some
2569 \begin_inset Flex CharStyle:MenuItem
2572 \begin_layout Plain Layout
2579 \begin_inset space ~
2583 \begin_inset CommandInset ref
2585 reference "sec:Inserting-TeX-Code"
2593 \begin_layout Plain Layout
2594 An alternative approach is to use the
2595 \begin_inset Flex CharStyle:Code
2598 \begin_layout Plain Layout
2605 \begin_inset Flex CharStyle:Code
2608 \begin_layout Plain Layout
2614 package, respectively.
2622 \begin_layout Standard
2624 \begin_inset Flex CharStyle:MenuItem
2627 \begin_layout Plain Layout
2628 Document\SpecialChar \menuseparator
2635 \begin_inset Flex CharStyle:MenuItem
2638 \begin_layout Plain Layout
2645 \begin_inset Flex CharStyle:MenuItem
2648 \begin_layout Plain Layout
2649 Sectioned bibliography
2655 In the document, you have to enclose the sections, which shall contain
2656 their own bibliography (including the BibTeX bibliography itself), between
2658 \begin_inset Flex CharStyle:Code
2661 \begin_layout Plain Layout
2670 \begin_inset Flex CharStyle:Code
2673 \begin_layout Plain Layout
2681 (those commands have to be inserted as TeX code).
2682 The bibliography will contain all references which have been cited in the
2684 \begin_inset Flex CharStyle:Code
2687 \begin_layout Plain Layout
2698 If you are using this approach, then every citation reference has to be
2700 \begin_inset Flex CharStyle:Code
2703 \begin_layout Plain Layout
2711 \begin_inset Flex CharStyle:Code
2714 \begin_layout Plain Layout
2723 \begin_layout Section
2727 \begin_layout Subsection
2731 \begin_layout Standard
2732 When you are working on a large file with many sections, it is often convenient
2733 to break up the document into several files, or perhaps you have something
2734 where a table may change from time to time, but the preceding text does
2736 In these cases, you should seriously consider using multipart documents.
2737 For example, scientific papers often have five major sections: the introduction
2738 , observations, results, discussion, and conclusion.
2739 Each of these could be its own separate LyX file, with one
2740 \begin_inset Quotes eld
2744 \begin_inset Quotes erd
2747 file which contains the title, authors, abstract, references, etc., plus
2748 the five included files.
2749 It is important to note that each of these files is a full LyX file which
2750 can be formatted and printed on its own, as well as included in a master
2752 Each of these files must have the same document class, however—don't attempt
2753 to mix book classes with article classes.
2754 You may also include LaTeX files; however, these files must not have their
2756 \begin_inset space \thinspace{}
2760 \begin_inset space \space{}
2763 everything up to and including the
2764 \begin_inset Flex CharStyle:Code
2767 \begin_layout Plain Layout
2776 \begin_inset Flex CharStyle:Code
2779 \begin_layout Plain Layout
2787 line must be deleted) or else errors will be generated when you try to
2791 \begin_layout Standard
2792 LyX allows you to include files quite easily with
2793 \begin_inset Flex CharStyle:MenuItem
2796 \begin_layout Plain Layout
2797 Insert\SpecialChar \menuseparator
2799 \begin_inset space ~
2808 When you click on this selection a small box is inserted into the file
2809 at the current cursor location.
2810 Clicking on the box raises a dialog which allows you to select the file
2811 to be included, and the method of its inclusion.
2815 \begin_layout Standard
2816 The file selection box should by now be obvious.
2817 The three inclusion methods are
2818 \begin_inset Quotes eld
2822 \begin_inset Quotes erd
2826 \begin_inset Quotes eld
2830 \begin_inset Quotes erd
2834 \begin_inset Quotes eld
2838 \begin_inset Quotes erd
2842 The difference between
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2851 \begin_inset Quotes eld
2855 \begin_inset Quotes erd
2858 is really only meaningful to LaTeXperts, but the practical difference is
2859 that files which are
2860 \begin_inset Quotes eld
2864 \begin_inset Quotes erd
2867 are typeset beginning on a new page, while files which are
2868 \begin_inset Quotes eld
2872 \begin_inset Quotes erd
2875 are typeset starting on the current page.
2878 \begin_layout Standard
2879 Generally, the master file is converted into a full LaTeX file before typesettin
2880 g, while the included files are converted to LaTeX files which do not have
2881 all the preamble information.
2884 \begin_layout Standard
2886 \begin_inset Quotes eld
2890 \begin_inset Quotes erd
2893 included file allows you to include a file typeset exactly as it appears
2895 \begin_inset space \thinspace{}
2899 \begin_inset space \space{}
2903 \begin_inset Flex CharStyle:Code
2906 \begin_layout Plain Layout
2912 mode, with the characters set in a fixed-width typewriter font.
2913 Normally, spaces in this file are invisible, though two consecutive spaces
2914 are conserved, unlike LyX's normal treatment of spaces.
2915 However, setting the
2916 \begin_inset Flex CharStyle:MenuItem
2919 \begin_layout Plain Layout
2921 \begin_inset space ~
2925 \begin_inset space ~
2929 \begin_inset space ~
2937 checkbox typesets a mark to unambiguously define the presence of a space.
2941 \begin_layout Subsection
2942 Cross-References Between Files
2945 \begin_layout Standard
2946 \begin_inset Box Shadowbox
2955 height_special "totalheight"
2958 \begin_layout Plain Layout
2959 This section is somewhat out of date.
2960 Need to describe default master documents and how children are opened when
2970 \begin_layout Standard
2971 It is possible to set up cross-references between the different files.
2972 First, open all the files in question: let's call them A and B in a two
2973 file example, where B is included in A.
2974 Let's say you insert a label in A, then want to reference it in B.
2975 Open the cross-reference dialog in whilst in document B, and you can select
2977 \begin_inset Quotes eld
2981 \begin_inset Quotes erd
2987 \begin_layout Subsection
2988 Bibliography Lists in all Subdocuments
2991 \begin_layout Standard
2992 \begin_inset Box Frameless
3001 height_special "totalheight"
3004 \begin_layout Plain Layout
3005 This section also needs updating.
3006 There is now material about this on the wiki, and it could be copied here.
3014 \begin_layout Standard
3015 Copy the bibliography list with all entries to all subdocuments and transform
3017 This way LyX will find the
3018 \begin_inset Flex CharStyle:Code
3021 \begin_layout Plain Layout
3027 -files and you can easily insert references without making the bibliography
3031 \begin_layout Standard
3032 As the bibliography list is in a comment, LaTeX won't use use it and the
3033 references will look like this: [?], instead of like this: [1].
3034 One solution is to use the LaTeX-package
3035 \begin_inset Flex CharStyle:Code
3038 \begin_layout Plain Layout
3044 that will only include comments by processing the files separately.
3045 To do this, add in the LaTeX preamble of every subdocument the following:
3048 \begin_layout LyX-Code
3054 \begin_layout LyX-Code
3057 includecomment{comment}
3060 \begin_layout Standard
3062 \begin_inset Flex URL
3065 \begin_layout Plain Layout
3067 http://wiki.lyx.org/FAQ/Unsorted#toc31
3075 \begin_layout Section
3076 Fancy Headers and Footers
3079 \begin_layout Standard
3080 The default page layout is rather plain; for an
3081 \begin_inset Flex CharStyle:Code
3084 \begin_layout Plain Layout
3090 document class, all you get is a centered page number at the bottom of
3092 This document uses KOMA-script's book class, so it appears to be a bit
3094 But to really put on a show, you need to set the document page style to
3096 \begin_inset Quotes eld
3100 \begin_inset Quotes erd
3103 , as mentioned in the
3108 This section describes the LaTeX code you need to insert in your LaTeX
3109 preamble in order to get the desired effects.
3112 \begin_layout Standard
3113 The page header is divided into three fields, not surprisingly labeled
3114 \begin_inset Quotes eld
3118 \begin_inset Quotes erd
3122 \begin_inset Quotes eld
3126 \begin_inset Quotes erd
3130 \begin_inset Quotes eld
3134 \begin_inset Quotes erd
3138 The footer is also divided into these three fields.
3139 The LaTeX commands to set these fields in the simplest manner are
3140 \begin_inset Flex CharStyle:Code
3143 \begin_layout Plain Layout
3152 \begin_inset Flex CharStyle:Code
3155 \begin_layout Plain Layout
3164 \begin_inset Flex CharStyle:Code
3167 \begin_layout Plain Layout
3176 \begin_inset Flex CharStyle:Code
3179 \begin_layout Plain Layout
3188 Suppose you wish to put your name in the upper left hand corner of each
3190 Simply insert the following command in the preamble:
3193 \begin_layout Standard
3202 \begin_layout Standard
3203 You will now see your name in the upper left.
3204 If a field has a default entry that you would like to get rid of (often
3205 the page number appears in the central footer, simply include a command
3206 with a blank argument, e.
3207 \begin_inset space \thinspace{}
3213 \begin_layout Standard
3221 \begin_layout Standard
3222 Let's get really fancy: lets put the section number with the word
3223 \begin_inset Quotes eld
3227 \begin_inset Quotes erd
3231 \begin_inset space \thinspace{}
3235 \begin_inset space \space{}
3238 Section 3) in the upper left, the page number (e.
3239 \begin_inset space \thinspace{}
3243 \begin_inset space \space{}
3246 Page 4) in the upper right, your name in the lower left, and the date in
3248 The following commands should now appear in the preamble:
3251 \begin_layout Standard
3261 \begin_layout Standard
3269 \begin_layout Standard
3279 \begin_layout Standard
3288 \begin_layout Standard
3296 \begin_layout Standard
3306 \begin_layout Standard
3308 \begin_inset Flex CharStyle:Code
3311 \begin_layout Plain Layout
3320 \begin_inset Flex CharStyle:Code
3323 \begin_layout Plain Layout
3331 access LaTeX's section and page counters, and so print out the current
3332 section and page numbers.
3334 \begin_inset Flex CharStyle:Code
3337 \begin_layout Plain Layout
3345 simply prints out today's date.
3348 \begin_layout Standard
3349 The thicknesses of the horizontal rules drawn beneath the header and above
3350 the footer can also be modified.
3351 If you don't want one of the rules, set its thickness to 0.
3352 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3358 \begin_inset Flex CharStyle:Code
3361 \begin_layout Plain Layout
3366 headrulewidth}{0.4pt}
3372 \begin_inset Flex CharStyle:Code
3375 \begin_layout Plain Layout
3380 footrulewidth}{0.4pt}
3385 to set the thicknesses.
3388 \begin_layout Standard
3389 You can switch the header/footer settings on and off for individual pages
3391 \begin_inset Flex CharStyle:Code
3394 \begin_layout Plain Layout
3397 thispagestyle{empty}
3403 \begin_inset Flex CharStyle:Code
3406 \begin_layout Plain Layout
3409 thispagestyle{plain}
3415 \begin_inset Flex CharStyle:Code
3418 \begin_layout Plain Layout
3421 thispagestyle{fancy}
3427 Simply insert them in the text on the page you want changed and mark them
3429 In fact, title pages are marked as plain by default, while following pages
3430 are marked fancy when using the global fancy setting.
3433 \begin_layout Standard
3434 There are more complex commands which will let you insert things in the
3435 upper left on odd numbered pages, etc., but we will refer you to the
3436 \begin_inset Flex CharStyle:Code
3439 \begin_layout Plain Layout
3445 package documentation for more information.
3447 \begin_inset Flex CharStyle:Code
3450 \begin_layout Plain Layout
3459 \begin_layout Standard
3460 As a final example, it is possible to include an image in the header or
3462 Suppose you want to put a company logo in the upper lefthand corner.
3463 You might try something like
3466 \begin_layout Standard
3475 includegraphics{logo.eps}}}
3478 \begin_layout Standard
3480 (you may need to preface this with
3481 \begin_inset Flex CharStyle:Code
3484 \begin_layout Plain Layout
3488 usepackage{graphics}
3493 if you don't include graphics elsewhere in your document).
3496 \begin_layout Section
3497 Itemize Bullet Selection
3498 \begin_inset CommandInset label
3507 \begin_layout Standard
3513 \begin_layout Subsection
3517 \begin_layout Standard
3518 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3519 Using this dialog you can easily specify what bullet shape to use at each
3520 level of an itemized list.
3521 These settings are document-wide so you won't be able to specify different
3522 sets of bullets for different paragraphs.
3526 \begin_layout Plain Layout
3527 Well, actually you can but you'll have to do it by hand.
3535 \begin_layout Subsection
3539 \begin_layout Standard
3540 Open the dialog by selecting the
3541 \begin_inset Flex CharStyle:MenuItem
3544 \begin_layout Plain Layout
3545 Document\SpecialChar \menuseparator
3551 menu item and then select the
3552 \begin_inset Flex CharStyle:MenuItem
3555 \begin_layout Plain Layout
3564 \begin_layout Standard
3565 The dialog provides you with a table of bullet shapes.
3566 A column of buttons on the left of the table provides access to the six
3567 different panels of bullet shapes.
3568 The row of buttons across the top is used to select which bullet depth
3570 A text entry under the table shows the currently selected bullet shape's
3571 LaTeX equivalent and this can be edited if desired.
3572 If you do modify the text you will also need to specify any needed packages
3573 in the LaTeX preamble.
3576 \begin_layout Standard
3577 The six panels are divided up by the packages they require.
3578 The following table shows the mappings from button name to LaTeX packages.
3581 \begin_layout Standard
3583 \begin_inset Tabular
3584 <lyxtabular version="3" rows="7" columns="2">
3586 <column alignment="center" valignment="top" width="0pt">
3587 <column alignment="center" valignment="top" width="0pt">
3589 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3592 \begin_layout Plain Layout
3607 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3610 \begin_layout Plain Layout
3627 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3630 \begin_layout Plain Layout
3645 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3648 \begin_layout Plain Layout
3664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3667 \begin_layout Plain Layout
3682 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3685 \begin_layout Plain Layout
3702 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3705 \begin_layout Plain Layout
3720 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3723 \begin_layout Plain Layout
3740 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3743 \begin_layout Plain Layout
3758 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3761 \begin_layout Plain Layout
3778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3781 \begin_layout Plain Layout
3796 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3799 \begin_layout Plain Layout
3816 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3819 \begin_layout Plain Layout
3834 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3837 \begin_layout Plain Layout
3860 \begin_layout Standard
3861 LyX doesn't stop you using bullets from packages you don't have.
3862 If you get errors from LaTeX when you try to view or print the file, then
3863 it is likely you are missing a package.
3867 \begin_layout Plain Layout
3868 LyX doesn't restrict your use since you may be editing locally and exporting
3877 \begin_layout Subsection
3881 \begin_layout Standard
3882 Select which bullet depth you want to change then select the bullet shape
3884 Any changes will not be visible in LyX, but are visible when viewing the
3888 \begin_layout Standard
3889 You can reset a bullet shape to the default simply by clicking your right
3890 mouse button on the appropriate bullet depth button.
3894 \begin_layout Plain Layout
3899 want to have multiple sets of paragraphs with different sets of bullets
3900 in each, then you're going to have to get your hands dirty with TeX code.
3901 The bullet selection dialog can help though because it provides you with
3902 the LaTeX code for a wide range of bullet shapes.
3903 To make your own custom paragraphs you have the following options:
3906 \begin_layout Plain Layout
3910 \begin_layout Plain Layout
3926 \begin_layout Plain Layout
3930 \begin_layout Plain Layout
3952 \begin_layout Itemize
3953 Use the LaTeX command
3954 \begin_inset Flex CharStyle:Code
3957 \begin_layout Plain Layout
3965 to specify a new bullet shape for a given depth.
3966 You'll also need to save the current bullet shape so you can restore it
3968 In this itemized list the following LaTeX code was used to change the bullet
3969 used for the first depth.
3973 \begin_layout LyX-Code
3983 \begin_layout LyX-Code
4000 \begin_layout Itemize
4001 Note that the itemize depth is specified in Roman numerals as part of the
4011 \begin_layout Itemize
4015 \begin_layout Plain Layout
4028 Specify each individual entry by starting each item with the bullet shape
4029 enclosed in square brackets and set as
4030 \begin_inset Flex CharStyle:MenuItem
4033 \begin_layout Plain Layout
4040 For example, this item was started with
4041 \begin_inset Flex CharStyle:Code
4044 \begin_layout Plain Layout
4059 \begin_layout Plain Layout
4063 \begin_layout Plain Layout
4079 \begin_layout Plain Layout
4080 You'll also need to revert the labelitem back to its previous setting for
4081 the global bullet shape settings to remain in effect.
4082 The way used here was:
4085 \begin_layout LyX-Code
4100 \begin_layout Chapter
4104 \begin_layout Section
4108 \begin_layout Standard
4109 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4110 and retrieve information about the LyX internal state.
4111 This is only intended for advanced users, but they should find it useful.
4112 It is by writing to the LyX server, for example, that bibliography managers,
4113 such as JabRef, are able to
4114 \begin_inset Quotes eld
4118 \begin_inset Quotes erd
4124 \begin_layout Standard
4125 Please note that, at present,
4127 the server does not work on Windows
4133 \begin_layout Plain Layout
4134 There is no reason it cannot do so.
4135 But none of the developers on Windows have yet implemented this functionality
4144 \begin_layout Section
4145 Starting the LyX Server
4148 \begin_layout Standard
4149 The LyX server works through the use of a pair of named pipes.
4150 These are usually located in
4151 \begin_inset Flex CharStyle:Code
4154 \begin_layout Plain Layout
4161 \begin_inset Quotes eld
4165 \begin_inset Flex CharStyle:Code
4168 \begin_layout Plain Layout
4175 \begin_inset Quotes erd
4179 \begin_inset Quotes eld
4183 \begin_inset Flex CharStyle:Code
4186 \begin_layout Plain Layout
4193 \begin_inset Quotes erd
4197 External programs write into
4198 \begin_inset Flex CharStyle:Code
4201 \begin_layout Plain Layout
4207 and read back data from
4208 \begin_inset Flex CharStyle:Code
4211 \begin_layout Plain Layout
4218 The stem of the pipe names can be defined in the
4219 \begin_inset Flex CharStyle:MenuItem
4222 \begin_layout Plain Layout
4223 Tools\SpecialChar \menuseparator
4230 \begin_inset Flex CharStyle:Code
4233 \begin_layout Plain Layout
4234 "/home/myhome/lyxpipe"
4244 configure this manually in order for the server to start.
4247 \begin_layout Standard
4249 \begin_inset Flex CharStyle:Code
4252 \begin_layout Plain Layout
4259 \begin_inset Flex CharStyle:Code
4262 \begin_layout Plain Layout
4268 ' to create the pipes.
4269 If one of the pipes already exists, LyX will assume that another LyX process
4270 is already running and will not start the server.
4271 If for some other reason, an unused
4272 \begin_inset Quotes eld
4276 \begin_inset Quotes erd
4279 pipe is left in existence when LyX closes, then LyX will try to delete
4281 If this fails for some reason, you will need to delete the pipes manually
4282 and then restart LyX.
4285 \begin_layout Standard
4286 To have several LyX processes with servers at the same time, you have to
4287 use different configurations, perhaps by using separate user directories,
4289 \begin_inset Flex CharStyle:Code
4292 \begin_layout Plain Layout
4298 file, for each process.
4301 \begin_layout Standard
4302 If you are developing a client program, you might find it useful to enable
4303 debugging information from the LyX server.
4304 Do this by starting LyX as
4305 \begin_inset Flex CharStyle:Code
4308 \begin_layout Plain Layout
4317 \begin_layout Standard
4318 You can find a complete example client written in C in the source distribution
4320 \begin_inset Flex CharStyle:Code
4323 \begin_layout Plain Layout
4324 development/lyxserver/server_monitor.c
4332 \begin_layout Standard
4333 Another useful tool is command-line based client you will find in
4334 \begin_inset Flex CharStyle:Code
4337 \begin_layout Plain Layout
4338 src/client/lyxclient
4346 \begin_layout Section
4347 Normal communication
4350 \begin_layout Standard
4351 To issue a LyX call, the client writes a line of ASCII text into the input
4353 This line has the following format:
4370 \begin_layout Description
4371 clientname is a name that the client can choose arbitrarily.
4372 Its only use is that LyX will echo it if it sends an answer—so a client
4373 can dispatch results from different requesters.
4376 \begin_layout Description
4377 function is the function you want LyX to perform.
4378 It is the same as the commands you'd use in the minibuffer.
4381 \begin_layout Description
4382 argument is an optional argument which is meaningful only to some functions
4384 \begin_inset Quotes eld
4388 \begin_inset Quotes erd
4391 LFUN will insert the argument as text at the cursor position).
4394 \begin_layout Standard
4395 The answer from LyX will arrive in the output pipe and be of the form
4412 \begin_layout Standard
4421 are just echoed from the command request, while
4425 is more or less useful information filled according to how the command
4426 execution worked out.
4427 Some commands, such as
4428 \begin_inset Quotes eld
4432 \begin_inset Quotes erd
4435 , will return information about the internal state of LyX, while other will
4436 return an empty data-response.
4437 This means that the command execution went fine.
4440 \begin_layout Standard
4441 In case of errors, the response from LyX will have this form
4458 \begin_layout Standard
4463 should contain an explanation of why the command failed.
4466 \begin_layout Standard
4470 \begin_layout LyX-Code
4471 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4474 \begin_layout LyX-Code
4475 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4476 \begin_inset Newline newline
4479 read a <~/.lyxpipe.out
4480 \begin_inset Newline newline
4486 \begin_layout Section
4490 \begin_layout Standard
4491 LyX can notify clients of events going on asynchronously.
4492 Currently it will only do this if the user binds a key sequence with the
4494 \begin_inset Quotes eld
4498 \begin_inset Quotes erd
4502 The format of the string LyX sends is as follows:
4506 \begin_inset Flex CharStyle:Code
4509 \begin_layout Plain Layout
4520 \begin_layout Standard
4525 is the printed representation of the key sequence that was actually typed
4529 \begin_layout Standard
4530 This mechanism can be used to extend LyX's command set and implement macros.
4531 Bind some key sequence to
4532 \begin_inset Quotes eld
4536 \begin_inset Quotes erd
4540 Then start a client that listens on the output pipe, dispatches the command
4541 according to the sequence, and starts a function that may use LyX calls
4542 and LyX requests to issue a command or a series of commands to LyX.
4545 \begin_layout Section
4546 The simple LyX Server Protocol
4549 \begin_layout Standard
4550 LyX implements a simple protocol that can be used for session management.
4551 All messages are of the form
4564 \begin_layout Standard
4570 \begin_inset Quotes eld
4574 \begin_inset Quotes erd
4578 \begin_inset Quotes eld
4582 \begin_inset Quotes erd
4587 \begin_inset Quotes eld
4591 \begin_inset Quotes erd
4594 is received from a client, LyX will report back to inform the client that
4595 it's listening to it's messages, while
4596 \begin_inset Quotes eld
4600 \begin_inset Quotes erd
4603 sent from LyX will inform clients that LyX is closing.
4606 \begin_layout Chapter
4607 Special Document Classes
4610 \begin_layout Section
4614 \begin_layout Standard
4620 \begin_layout Subsection
4624 \begin_layout Standard
4625 This section describes how LyX can be used to write articles for submission
4626 to the scientific journal
4628 Astronomy and Astrophysics
4630 (www.edpsciences.fr/aa/
4631 \begin_inset Flex URL
4634 \begin_layout Plain Layout
4636 http://www.edpsciences.fr/aa/
4641 ) using Version 5.01 of the document class
4646 This package can be downloaded from the ftp site
4649 \begin_layout Standard
4650 \begin_inset VSpace medskip
4656 \begin_layout Standard
4658 \begin_inset Flex URL
4661 \begin_layout Plain Layout
4663 ftp://ftp.edpsciences.org/pub/aa/readme.html
4671 \begin_layout Standard
4672 \begin_inset VSpace medskip
4678 \begin_layout Standard
4679 A manual comes together with that package, and this text is not meant to
4680 replace the original manual but merely a short guide how to realize the
4681 correct form of your paper.
4685 \begin_layout Standard
4686 Please note that the publisher of the journal was changed from Springer
4687 to EDP Sciences starting January 1, 2001.
4688 That change implicated also some slight changes of the style files, namely
4689 the removal of the thesaurus command.
4690 The LyX class aa supports the newest version of these style files, V 5.01.
4691 If you have an older version installed, please upgrade.
4692 For compatibility, the old (version 4) layout has been kept as
4697 Please refer to the comments in
4699 LyXDir/layouts/aapaper.layout
4704 \begin_layout Subsection
4708 \begin_layout Standard
4709 It is recommended you start from the example template distributed with LyX.
4710 If you are not using a template, note the following settings:
4713 \begin_layout Itemize
4720 Document\SpecialChar \menuseparator
4723 dialog (OK, that one was obvious).
4726 \begin_layout Itemize
4727 Don't change the option
4730 \begin_inset space ~
4740 The whole layout is done by the macros, you shouldn't change anything.
4743 \begin_layout Subsection
4747 \begin_layout Standard
4748 First thing to enter is the header information.
4749 It consists of seven entries, of which some are optional.
4753 \begin_layout Itemize
4761 \begin_layout Itemize
4769 \begin_layout Itemize
4777 \begin_layout Itemize
4785 \begin_layout Itemize
4790 : [optional] if more than one author: whom to contact for offprint requests.
4793 \begin_layout Itemize
4798 : [optional] mail address for contacts.
4801 \begin_layout Itemize
4809 Received: <date>; Accepted <date>
4812 \begin_layout Standard
4813 There is no need to issue the
4819 command, this is done automatically by LyX when the header is finished.
4820 Although the order of the single header entries doesn't matter it is advised
4821 to keep the above sequence, just to get the best optics and meets the layout
4822 of the real document.
4825 \begin_layout Standard
4826 If you want to place footnotes in the header block, e.
4827 \begin_inset space \thinspace{}
4831 \begin_inset space \space{}
4834 to state your present address, just use the standard footnote via the menu
4837 Insert\SpecialChar \menuseparator
4841 LyX will automagically use the term
4850 \begin_layout Standard
4851 In addition to these topics, the macros use three additional LaTeX commands
4852 that have no counterpart in LyX:
4855 \begin_layout Itemize
4862 to separate different names for more than one author and institute, respectivel
4866 \begin_layout Itemize
4873 to mark corresponding author/institute pairs.
4874 The institutes are numbered sequentially as they appear in the
4878 field, so you have to put a marker to each author.
4881 \begin_layout Itemize
4888 to supply an email address for fast contact.
4891 \begin_layout Standard
4892 In all cases, the appropriate command has to be entered in LyX and marked
4898 \begin_layout Subsection
4902 \begin_layout Standard
4903 The abstract should immediately follow the header block.
4904 With version 5 the abstract environment was changed to a command, and there
4905 is now a resctriction to only one paragraph.
4906 In addition, it should contain an entry with the keywords.
4907 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4914 by hand and mark it as LaTeX code.
4915 Refer to the example paper.
4918 \begin_layout Subsection
4919 Supported environments
4922 \begin_layout Standard
4923 The A&A paper layout supports the following environments for structuring
4927 \begin_layout Itemize
4933 \begin_layout Itemize
4939 \begin_layout Itemize
4945 \begin_layout Itemize
4951 \begin_layout Itemize
4957 \begin_layout Itemize
4963 \begin_layout Itemize
4969 \begin_layout Itemize
4975 \begin_layout Itemize
4981 \begin_layout Itemize
4987 \begin_layout Itemize
4993 \begin_layout Itemize
4999 \begin_layout Subsection
5000 Commands not supported by LyX
5003 \begin_layout Standard
5004 Some commands are not yet supported by the
5009 Some have already been mentioned.
5010 For the sake of completeness, they are listed all together here:
5013 \begin_layout Itemize
5021 \begin_layout Itemize
5029 \begin_layout Itemize
5037 \begin_layout Itemize
5045 \begin_layout Itemize
5053 \begin_layout Itemize
5061 \begin_layout Itemize
5069 \begin_layout Itemize
5077 \begin_layout Standard
5078 If you want to use any of these commands, you have to enter them yourself.
5081 Do not forget to mark them as LaTeX code!
5084 \begin_layout Subsection
5085 Figure and Table Floats
5088 \begin_layout Standard
5089 LyX provides support for the necessary float environments
5091 figure, figure*, table
5097 , therefore we won't tell much about it here.
5101 \begin_inset space ~
5107 Just remember that tables should be left-aligned.
5108 For that, select the table and change the alignment in
5110 Edit\SpecialChar \menuseparator
5112 \begin_inset space ~
5118 \begin_layout Standard
5119 There is only one special thing: the figures with caption besides the figure.
5120 To create such a figure, you have to do the following:
5123 \begin_layout Enumerate
5124 Create a wide figure float:
5126 Insert\SpecialChar \menuseparator
5127 Float\SpecialChar \menuseparator
5130 , then right click in the figure and select
5136 \begin_inset space ~
5144 \begin_layout Enumerate
5145 Enter your caption text.
5148 \begin_layout Enumerate
5153 to move the cursor above the caption.
5156 \begin_layout Enumerate
5160 \begin_layout Enumerate
5161 Position the cursor behind the figure and insert a horizontal fill:
5163 Insert\SpecialChar \menuseparator
5165 \begin_inset space ~
5168 Character\SpecialChar \menuseparator
5170 \begin_inset space ~
5178 \begin_layout Enumerate
5179 Switch to LaTeX mode:
5182 \begin_inset space ~
5190 \begin_layout Enumerate
5200 Do not close the brace!
5203 \begin_layout Enumerate
5204 Position the cursor behind the caption text, switch to LaTeX mode and insert
5208 \begin_inset space ~
5220 \begin_layout Standard
5221 Also, refer to the figures in the example paper.
5224 \begin_layout Subsection
5228 \begin_layout Standard
5229 For submission, the paper has to be formated in a special double-spacing
5231 For this purpose, you have to give the option
5235 to the documentclass.
5236 This must be done using the extra class options field in the
5238 Document\SpecialChar \menuseparator
5242 Just enter the string
5249 \begin_layout Subsection
5253 \begin_layout Standard
5258 directory contains an example paper written with LyX.
5259 It is the example paper from the original macro package, translated to
5261 Use it for inspiration, and compare the original LaTeX code with LyX way
5265 \begin_layout Section
5269 \begin_layout Standard
5275 \begin_layout Subsection
5279 \begin_layout Standard
5280 AASTeX is a set of macros produced by the American Astronomical Society
5281 to facilitate electronic manuscript submission to the three journals they
5282 publish: the Astrophysical Journal (including the Letters and Supplement),
5283 the Astronomical Journal, and the Publications of the Astronomical Society
5285 LyX has proven to be an excellent tool for generating these documents,
5286 especially given its equation, citation, and figure handling capabilities.
5287 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5288 is the version described here, or higher.
5289 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5290 incompatible with LyX.
5291 The AASTeX package may be downloaded from the AASTeX Web site
5294 \begin_layout Standard
5295 \begin_inset VSpace medskip
5301 \begin_layout Standard
5303 \begin_inset Flex URL
5306 \begin_layout Plain Layout
5308 http://www.journals.uchicago.edu/AAS/AASTeX
5316 \begin_layout Standard
5317 \begin_inset VSpace medskip
5323 \begin_layout Standard
5324 A complete user guide is contained in that package and you should familiarize
5325 yourself with it thoroughly before embarking on writing a paper in LyX.
5326 LyX will not reduce the need to figure out all the AASTeX commands, it
5327 will only reduce the drudgery of typing everything in.
5328 It is your responsibility to ensure that the final exported LaTeX document
5329 conforms completely to the requirements of the journal to which you are
5330 submitting your paper.
5333 \begin_layout Subsection
5334 Starting a New Paper
5337 \begin_layout Standard
5338 I strongly suggest that you start with the AASTeX template file.
5341 File\SpecialChar \menuseparator
5348 , enter the new file name, then choose the
5353 This will show the most common fields found in a manuscript.
5354 Simply overwrite the existing text (including the brackets,
5358 ) with the correct information.
5359 Many of the AASTeX commands and environments can be implemented directly
5360 in LyX, but some cannot: most noticeably
5372 , which should stick out like a sore thumb if you actually just opened the
5374 For commands such as these, the LaTeX code must be entered directly and
5376 Such commands are referred to as TeX code, or Evil Red Text.
5377 I tried to minimize the amount of TeX code needed in an AASTeX document,
5378 but there is still a bit more required than any of us would like.
5381 \begin_layout Subsection
5382 Finishing Your Paper
5385 \begin_layout Standard
5386 When the paper is finished to your satisfaction and previews/prints correctly,
5388 \begin_inset Quotes eld
5392 \begin_inset Quotes erd
5395 actions which need to be done before you submit it to the journals.
5399 \begin_layout Enumerate
5400 Export your paper as a LaTeX file (
5402 File\SpecialChar \menuseparator
5403 Export\SpecialChar \menuseparator
5410 \begin_layout Enumerate
5415 file with your favorite text editor
5419 \begin_layout Enumerate
5420 remove the comment lines before the
5429 \begin_layout Enumerate
5434 usepackage...{fontenc}
5436 line if it appears (usually just after
5451 \begin_layout Enumerate
5452 remove everything between (and including) the
5464 commands, except for any commands you specifically put into the LaTeX preamble
5465 (which should appear immediately after the
5466 \begin_inset Quotes eld
5469 User specified LaTeX commands
5470 \begin_inset Quotes erd
5481 \begin_layout Enumerate
5482 Run the resulting file through LaTeX to make sure it still processes correctly.
5485 \begin_layout Enumerate
5486 Reread the journal requirements to make sure your filenames and formats
5490 \begin_layout Enumerate
5494 \begin_layout Subsection
5495 Comments On Specific Commands
5498 \begin_layout Standard
5499 I will not describe the detailed usage of the individual AASTeX commands:
5500 the AASTeX User Guide (
5504 ) gives a good description of each.
5505 Thus it's probably easiest for me to go down the list as found in the guide
5506 and offer comments where necessary.
5507 So let's begin \SpecialChar \ldots{}
5511 \begin_layout Subsubsection
5512 Things that work as expected
5515 \begin_layout Standard
5519 \begin_layout Plain Layout
5531 \begin_layout Standard
5532 Because they work as you might expect, I simply list them and the section
5633 begin{thebibliography}
5641 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5642 graphicx figure commands (2.14.1),
5666 (2.15.4, amongst other places),
5693 \begin_layout Standard
5694 The following style options also work correctly:
5715 Simply put them in the
5721 Layout\SpecialChar \menuseparator
5727 \begin_layout Standard
5731 \begin_layout Plain Layout
5743 \begin_layout Subsubsection
5744 Things that work, but require more comment
5747 \begin_layout Standard
5748 The following items work, but require a little more discussion:
5751 \begin_layout Itemize
5752 These items are reserved for use by the journal editors, but you can put
5753 them into the LaTeX preamble if you feel compelled to do so:
5786 \begin_layout Itemize
5787 These items may be placed in the LaTeX preamble, and are included as blanks
5788 in the template file:
5809 \begin_layout Itemize
5816 (2.3) – can only be used
5817 \begin_inset Quotes eld
5821 \begin_inset Quotes erd
5824 , not in the middle of a paragraph.
5825 Use TeX code if you need to embed it.
5828 \begin_layout Itemize
5835 (2.3) – will have extra {} after it.
5836 This should not cause an error.
5839 \begin_layout Itemize
5846 (2.6) – can only be used
5847 \begin_inset Quotes eld
5851 \begin_inset Quotes erd
5854 , not in the middle of a paragraph.
5855 Use TeX code if you need to embed it.
5858 \begin_layout Itemize
5865 (2.8) – can't insert a cross-reference tag, you must type the tag name by
5869 \begin_layout Itemize
5876 (2.8) – same as for
5883 \begin_layout Itemize
5890 (2.9) – will have extra {} after it.
5891 This should not cause an error.
5894 \begin_layout Itemize
5901 (2.11) – will have extra {} after it.
5902 This should not cause an error.
5905 \begin_layout Itemize
5912 (2.14.2) – you can insert an optional filename argument by placing the cursor
5913 at the beginning of the text and selecting
5915 Insert\SpecialChar \menuseparator
5920 \begin_inset Quotes eld
5924 \begin_inset Quotes erd
5927 inserts an optional argument of the type needed by
5934 Hopefully it will be renamed someday.
5937 \begin_layout Itemize
5944 (2.17.1) – same as
5950 for the catalog ID optional parameter
5953 \begin_layout Itemize
5960 (2.17.1) – same as
5966 for the catalog ID optional parameter
5969 \begin_layout Subsubsection
5970 Things not implemented, use TeX code
5973 \begin_layout Standard
5977 \begin_layout Plain Layout
5989 \begin_layout Standard
6012 setcounter{equation}
6014 (2.12), Journal name abbreviations (2.13.4),
6050 (2.15.4, insert it as the first element in the lefthand cell after where
6052 Don't use any of LyX's rules in the table),
6064 (2.15.5), much of Misc (2.17, except
6115 \begin_layout Standard
6119 \begin_layout Plain Layout
6131 \begin_layout Subsubsection
6132 Things that cannot be implemented
6135 \begin_layout Standard
6136 \SpecialChar \ldots{}
6137 at least in any meaningful sort of way, so I suggest ignoring them.
6138 They are the references environment (2.13.3), and the deluxetable environment
6140 If you really, really need to use deluxetable, I suggest editing it in
6141 a separate file with a text editor, then using
6143 Insert\SpecialChar \menuseparator
6145 \begin_inset space ~
6150 to include it in your LyX document.
6155 file to see an example of this.
6158 \begin_layout Subsection
6159 FAQs, Tips, Tricks, and Other Ruminations
6162 \begin_layout Subsubsection
6163 Getting LyX and AASTeX to cooperate
6166 \begin_layout Standard
6167 It can be a bit tricky to get LyX to recognize a new layout and document
6169 When all else fails, do this:
6172 \begin_layout Enumerate
6173 Make certain that LaTeX can find AASTeX.
6174 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6175 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6182 \begin_layout Enumerate
6194 \begin_layout Enumerate
6197 Tools\SpecialChar \menuseparator
6200 in LyX, then restart LyX.
6203 \begin_layout Enumerate
6204 Open a regular new file, not from a template.
6205 Does AASTeX appear in the class list in
6207 Document\SpecialChar \menuseparator
6213 \begin_layout Standard
6214 If you get a warning from an existing AASTeX document about not being able
6215 to find the AASTeX layout or a message about
6216 \begin_inset Quotes eld
6219 You should not mix title layouts with normal ones
6220 \begin_inset Quotes erd
6223 , things haven't been installed correctly.
6226 \begin_layout Subsubsection
6227 LaTeX error processing a table
6230 \begin_layout Standard
6231 LyX, by default, attempts to center the table caption/title.
6232 This seems to produce a bad interaction in AASTeX so you should click somewhere
6233 in the caption/title, then select
6235 Edit\SpecialChar \menuseparator
6237 \begin_inset space ~
6251 This took care of it for me.
6254 \begin_layout Subsubsection
6258 \begin_layout Standard
6259 A couple of things: 1) I have noticed some funny spacing in the reference
6260 entries in the text.
6261 When you enter the bibliography item data, make sure their is
6265 space between the last author and the parenthesis setting off the year;
6269 \begin_inset space \thinspace{}
6273 \begin_inset space \space{}
6287 2) Entering the references at all is not obvious.
6288 The easiest thing is to start typing your first reference at the end of
6289 the document, then mark it as type
6294 That will put a small gray box in front of what you just typed.
6295 Click on the box to fill in the rest of the information.
6296 For new references, go to the end of an existing reference and press return.
6297 That will create a new line with its own box, etc.
6300 \begin_layout Subsubsection
6304 \begin_layout Standard
6305 Even though AASTeX provides its own figure commands (
6311 , for example), I much prefer LaTeX's standard figure commands (with the
6320 \begin_inset space ~
6323 commands as TeX code into a Figure Float box if you desire, but I never
6324 have much luck getting the layout right.
6325 With the standard graphics, LyX will insert a
6329 usepackage{graphicx}
6331 command into the LaTeX preamble and handle the figures in the standard
6332 LaTeX2e way, interspersing the figures in the text.
6333 I believe ApJ accepts figures exactly this way now; AJ might still use
6335 \begin_inset Quotes eld
6338 stack everything at the end
6339 \begin_inset Quotes erd
6345 \begin_layout Subsubsection
6346 Things I could have done, but didn't
6349 \begin_layout Standard
6351 \begin_inset Quotes eld
6355 \begin_inset Quotes erd
6358 things I could have implemented, but chose not to.
6359 For instance, I saw no point in double-spacing the text in the LyX window,
6360 even though it is double-spaced in the paper manuscript.
6361 Also, I chose not to make separate layouts for the preprint and preprint2
6363 Since I assume you will spend most of your time in the plain manuscript
6364 mode anyway, I decided not to chew up more disk space with this.
6368 \begin_layout Subsection
6372 \begin_layout Standard
6373 Your mileage may vary.
6374 I've now had papers published by both ApJ and AJ that have had 98% of the
6375 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6377 I have had no trouble with the submission process, and I'm sure the journals
6378 were never aware that there might be a difference.
6379 So, go forth and publish!
6382 \begin_layout Section
6386 \begin_layout Standard
6389 David Johnson; updated by Richard Heck
6392 \begin_layout Standard
6393 \begin_inset VSpace bigskip
6399 \begin_layout Standard
6401 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
6402 papers to be submitted to American Mathematical Society publications.
6403 The layouts are not tailored to a specific journal, but easily can be.
6404 You should refer to the AMS documentation for specific instructions for
6405 each journal (usually it will entail only changing a single line in the
6407 That documentation is available on the Web at
6408 \begin_inset Flex URL
6411 \begin_layout Plain Layout
6419 \begin_inset Flex URL
6422 \begin_layout Plain Layout
6424 ftp://ftp.ams.org/pub/tex/amslatex/
6430 These layouts are appropriate, and useful, for any mathematical writing.
6434 \begin_layout Standard
6435 There are two basic AMS LaTeX layouts:
6438 \begin_layout Itemize
6439 amsart: The standard AMS article format.
6442 \begin_layout Itemize
6443 amsbook: the standard AMS book (really, monograph) format.
6447 \begin_layout Standard
6448 The layouts themselves contain only the minimum necessary to use the AMS
6450 They do not, in particular, contain any of the `theorem' environments used
6451 for setting theorems, lemmas, and the like.
6452 These are contained, instead, in the
6453 \begin_inset Flex CharStyle:Code
6456 \begin_layout Plain Layout
6462 module, which is loaded by default when when you select one of the AMS
6464 (It can also be used with other classes and can be removed, if you would
6465 rather use something else.) Less commonly used environments are in the
6466 \begin_inset Flex CharStyle:Code
6469 \begin_layout Plain Layout
6470 Theorems (AMS-Extended)
6475 module, which must be loaded manually.
6478 \begin_layout Standard
6479 By default, theorems and the like are numbered consecutively throughout
6480 the document, but this may be modified by loading the module
6481 \begin_inset Flex CharStyle:Code
6484 \begin_layout Plain Layout
6485 Theorems (Order by Section)
6490 or, if you are using
6491 \begin_inset Flex CharStyle:Code
6494 \begin_layout Plain Layout
6501 \begin_inset Flex CharStyle:Code
6504 \begin_layout Plain Layout
6505 Theorems (Order by Chapter)
6511 These will number the results as
6512 \begin_inset Formula $n.m$
6515 , where the first number refers to the section (or chapter) and the second
6516 refers to the total number of results so far in that section (or chapter).
6517 Many environments are also available unnumbered.
6518 These are indicated by an asterisk at the end.
6519 If you happen to want
6523 unnumbered results, the the module
6524 \begin_inset Flex CharStyle:Code
6527 \begin_layout Plain Layout
6533 provides that option.
6536 \begin_layout Standard
6537 Note that these modules do not
6541 to be used with the AMS classes.
6542 It is perfectly possible to use the
6543 \begin_inset Flex CharStyle:Code
6546 \begin_layout Plain Layout
6552 module, and the others mentioned, with other classes, such as
6553 \begin_inset Flex CharStyle:Code
6556 \begin_layout Plain Layout
6563 \begin_inset Flex CharStyle:Code
6566 \begin_layout Plain Layout
6573 \begin_inset Flex CharStyle:Code
6576 \begin_layout Plain Layout
6585 \begin_layout Subsection
6586 What these layouts provide
6589 \begin_layout Standard
6590 There is a long list of included environments provided by these layouts.
6591 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
6592 variety of `theorem' environments.
6593 However, the AMS recommends the environments that are available in LyX.
6597 \begin_layout Standard
6598 The following environments—as well as the standard environments, such as
6600 \begin_inset Flex CharStyle:Noun
6603 \begin_layout Plain Layout
6610 \begin_inset Flex CharStyle:Noun
6613 \begin_layout Plain Layout
6620 \begin_inset Flex CharStyle:Noun
6623 \begin_layout Plain Layout
6630 \begin_inset Flex CharStyle:Noun
6633 \begin_layout Plain Layout
6640 \begin_inset Flex CharStyle:Noun
6643 \begin_layout Plain Layout
6650 \begin_inset Flex CharStyle:Code
6653 \begin_layout Plain Layout
6660 \begin_inset Flex CharStyle:Code
6663 \begin_layout Plain Layout
6672 \begin_layout Description
6673 Address This should be the author's permanent address.
6676 \begin_layout Description
6678 \begin_inset space ~
6681 Address This should be the author's temporary address at the time of submission,
6682 if different from the Address.
6685 \begin_layout Description
6686 Email Author's e-mail address
6689 \begin_layout Description
6690 URL Author's Web address, if desired.
6693 \begin_layout Description
6694 Keywords Key words or phrases used to identify specific topics discussed
6698 \begin_layout Description
6699 Subjectclass These refer to the AMS Subject Classifications, published and
6702 Mathematical Reviews
6705 These are also available online at the AMS cites listed above.
6708 \begin_layout Description
6712 \begin_layout Description
6716 \begin_layout Description
6720 \begin_layout Standard
6721 The following environments are provided by both the
6722 \begin_inset Flex CharStyle:Code
6725 \begin_layout Plain Layout
6732 \begin_inset Flex CharStyle:Code
6735 \begin_layout Plain Layout
6741 modules, in the latter case in both starred (unnumbered) and unstarred
6742 (numbered) versions.
6743 These same environments are provided only in the starred versions by the
6745 \begin_inset Flex CharStyle:Code
6748 \begin_layout Plain Layout
6757 \begin_layout Theorem
6758 This is typically used for the statements of major results.
6762 \begin_layout Corollary*
6763 This is used for statements which follow fairly directly from previous statement
6765 Again, these can be major results.
6770 These are smaller results needed to prove other statements.
6773 \begin_layout Proposition
6774 These are less major results which (hopefully) add to the general theory
6778 \begin_layout Conjecture
6779 These are statements provided without justification, which the author does
6780 not know how to prove, but which seem to be true (to the author, at least).
6783 \begin_layout Definition*
6784 Guess what this is for.
6785 The font is different for this environment than for the previous ones.
6789 \begin_layout Example*
6790 Used for examples illustrating proven results.
6793 \begin_layout Problem
6794 It's not really known what this is for.
6795 You should figure it out.
6798 \begin_layout Exercise*
6799 Write a description for this one.
6802 \begin_layout Remark
6803 This environment is also a type of theorem, usually a lesser sort of observation.
6806 \begin_layout Claim*
6807 Often used in the course of giving a proof of a larger result.
6811 Generally, these are used to break up long arguments, using specific instances
6817 The numbering scheme for cases is on its own, not together with other numbered
6823 At the end of this environment, a QED symbol (usually a square, but it can
6824 vary with different styles) is placed.
6825 If you want to have other environments within this one—for example, Case
6826 environments—and have the QED symbol appear only after them, then the other
6827 environments need to be nested within the proof environment.
6830 Nesting Environments
6836 for information on nesting.
6839 \begin_layout Standard
6840 And these environments are provided by
6841 \begin_inset Flex CharStyle:Code
6844 \begin_layout Plain Layout
6845 Theorems (AMS-Extended)
6853 \begin_layout Criterion*
6854 A required condition.
6857 \begin_layout Algorithm*
6858 A general procedure to be used.
6861 \begin_layout Axiom*
6862 This is a property or statement taken as true within the system being discussed.
6865 \begin_layout Condition*
6866 Sometimes used to state a condition assumed within the present context of
6871 Similar to a Remark.
6874 \begin_layout Notation*
6875 Used for the explanation of, yes, notation.
6878 \begin_layout Summary
6879 Do we really need to tell you?
6882 \begin_layout Acknowledgement*
6886 \begin_layout Conclusion*
6887 Sometimes used at the end of a long train of argument.
6891 Used in a way similar to Proposition, though perhaps lower on the scale.
6894 \begin_layout Standard
6895 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
6897 They need to be available on your system in order to use these environments.
6900 \begin_layout Section
6908 \begin_layout Standard
6914 \begin_layout Subsection
6918 \begin_layout Standard
6919 These are the layout files for some of the journals of the American Geophysical
6921 It is assumed that you have both the AGU's own class files and AGUplus
6922 installed (everything to be found at
6923 \begin_inset Flex URL
6926 \begin_layout Plain Layout
6928 ftp://ftp.agu.org/journals/latex/journals
6936 \begin_layout Subsection
6940 \begin_layout Standard
6950 They are still called this in the LyX GUI, though their LaTeX equivalents
6951 in the AGU classes are
6962 \begin_layout Standard
6963 Newly defined styles are
7000 These are mostly manuscript attributes and defined in the AGU class documentati
7004 \begin_layout Standard
7005 I suspect this is still badly incomplete.
7008 \begin_layout Subsection
7012 \begin_layout Standard
7029 \begin_layout Subsection
7033 \begin_layout Itemize
7036 Journal of Geophysical Research
7045 \begin_layout Standard
7046 Add your own, it isn't so hard! Look at the
7057 \begin_layout Subsection
7058 Bugs and things to remember
7061 \begin_layout Standard
7062 In order to use the new layouts, you must remember to do the following for
7066 \begin_layout Enumerate
7072 This can be done in the
7074 Layout\SpecialChar \menuseparator
7079 Document\SpecialChar \menuseparator
7083 (AGU articles are always in English, right? So
7090 \begin_layout Enumerate
7100 (Yes, this is a bug.)
7103 \begin_layout Enumerate
7104 Make sure you use the
7108 bibliography style, by entering
7112 into the second field of the BibTeX inset.
7113 None of the standard styles will do.
7116 \begin_layout Section
7120 \begin_layout Standard
7126 \begin_layout Subsection
7130 \begin_layout Standard
7131 Broadway is for writing plays.
7132 The format is more decorative than Hollywood, and much less standardized.
7133 This format should be suitable for workshops.
7136 \begin_layout Subsection
7140 \begin_layout Standard
7141 The same as in Hollywood.
7144 \begin_layout Subsection
7148 \begin_layout Standard
7153 names as labels then cross-reference the label to insert the name.
7154 The cross-reference dialog will show the current cast of characters.
7157 \begin_layout Subsection
7158 Paper size and Margins
7161 \begin_layout Standard
7162 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7165 \begin_layout Subsection
7169 \begin_layout Standard
7170 The following environments are available.
7171 You can use broadway.bind to get the bind keys shown at the right.
7174 \begin_layout Itemize
7178 \begin_inset Newline newline
7183 You should not have to use this, but it is here for anything that does not
7187 \begin_layout Itemize
7191 \begin_inset space \hfill{}
7195 \begin_inset Newline newline
7200 Used to describe stage setting and the action.
7201 First use of speaker names in all CAPs.
7204 \begin_layout Itemize
7208 \begin_inset space \hfill{}
7212 \begin_inset Newline newline
7217 Automatically numbered.
7218 On screen it will be arabic, but will print as Roman.
7221 \begin_layout Itemize
7225 \begin_inset space \hfill{}
7229 \begin_inset Newline newline
7239 It is just centered text.
7242 \begin_layout Itemize
7246 \begin_inset space \hfill{}
7250 \begin_inset Newline newline
7255 Not automatically numbered.
7256 You supply the number.
7257 This is because I couldn't figure out how.
7260 \begin_layout Itemize
7264 \begin_inset space \hfill{}
7268 \begin_inset Newline newline
7273 A special case of Narrative to describe the setting and action as the curtain
7277 \begin_layout Itemize
7281 \begin_inset space \hfill{}
7285 \begin_inset Newline newline
7290 The speaker's (actor's) title, centered in all CAPS.
7293 \begin_layout Itemize
7297 \begin_inset space \hfill{}
7301 \begin_inset Newline newline
7306 Instructions to the speaker.
7307 The parentheses are automatically inserted.
7308 The ( will appear on screen, but both will be in the printed play.
7309 This environment is only used within
7316 \begin_layout Itemize
7320 \begin_inset space \hfill{}
7324 \begin_inset Newline newline
7329 What the Speaker says.
7332 \begin_layout Itemize
7336 \begin_inset space \hfill{}
7340 \begin_inset Newline newline
7345 The curtain comes down.
7348 \begin_layout Itemize
7352 \begin_inset space \hfill{}
7358 \begin_layout Itemize
7362 \begin_inset space \hfill{}
7368 \begin_layout Itemize
7372 \begin_inset space \hfill{}
7378 \begin_layout Standard
7382 \begin_layout Section
7386 \begin_layout Standard
7391 can be used to type letters according to German conventions.
7392 A template file is included in
7394 .../lyx/share/templates
7396 for you to use as a starting point.
7399 \begin_layout Section
7407 \begin_layout Standard
7413 \begin_layout Subsection
7417 \begin_layout Standard
7418 This is the layout file for the European Geophysical Society journals.
7423 can be downloaded from the web site of the EGS under
7424 \begin_inset Flex URL
7427 \begin_layout Plain Layout
7437 \begin_layout Subsection
7441 \begin_layout Standard
7444 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
7452 The current layout file is unfortunately very unmodular and would benefit
7453 from using the various
7460 \begin_layout Section
7464 \begin_layout Standard
7470 \begin_layout Standard
7471 Elsevier Science Publishers B.V.
7472 provides a standard LaTeX document class (
7476 ) for submitting articles to their various journals.
7477 The style file can be downloaded directly from their web site:
7478 \begin_inset Flex URL
7481 \begin_layout Plain Layout
7483 http://authors.elsevier.com/
7489 Instructions are supplied along with the class file, which details the
7490 requirements of the publishers.
7491 LyX includes package that allows for the use of this class, by a layout
7492 and a template file.
7493 Installation of the class file is the same as for any other LaTeX package;
7494 instructions are provided in the Elsevier documentation.
7497 \begin_layout Standard
7507 As the Elsevier class file is based mainly on the standard article class,
7508 most of the normal functionality is provided.
7509 The Elsevier class defines a number of mathematical environments, which
7510 are similar to the AMS environments.
7511 These commands are all described in the Elsevier documentation, and are
7515 \begin_layout Standard
7516 The easiest way to use the Elsevier style is to base documents on the included
7518 It is best not to use options such as fancy headings or the geometry package,
7519 as elements such as these are defined by Elsevier in their style file.
7520 Ideally, no extra packages except those mentioned in the Elsevier documentation
7522 Essentially, Elsevier require as
7523 \begin_inset Quotes eld
7527 \begin_inset Quotes erd
7530 a LaTeX file as possible, as their intention is to take the supplied file
7531 and replace the class file with one for the particular journal to which
7532 the paper has been submitted.
7533 This also means that not too much time should be spent on the formating
7535 When it comes to be published, this will change anyway.
7536 The rest of the usage for this layout is substantially the same as for
7537 the normal article class.
7538 For details of what Elsevier do and don't allow, refer to their documentation.
7541 \begin_layout Section
7550 \begin_inset CommandInset label
7559 \begin_layout Standard
7565 \begin_layout Subsection
7569 \begin_layout Standard
7570 This section describes how to use LyX to make slides for overhead projectors.
7571 There are two document classes that can do this: the default slides class
7577 This section documents the latter.
7580 \begin_layout Standard
7581 I'm going to say this again, nice and clear, so that there's no misunderstanding
7585 \begin_layout Standard
7586 \begin_inset VSpace bigskip
7592 \begin_layout Standard
7596 This section documents the class
7597 \begin_inset Quotes eld
7605 \begin_inset Quotes erd
7613 \begin_layout Standard
7614 \begin_inset VSpace bigskip
7620 \begin_layout Standard
7621 If you're looking for the documentation for
7622 \begin_inset Quotes eld
7630 \begin_inset Quotes erd
7634 \begin_inset space ~
7638 \begin_inset CommandInset ref
7640 reference "sec:slitex"
7645 If your machine doesn't have the
7650 \begin_inset Quotes eld
7658 \begin_inset Quotes erd
7661 ] installed, you'll probably have to use the default
7665 class, which isn't quite as good as
7670 \begin_layout Standard
7675 class is designed for use with version 2.1 of the
7679 LaTeX class file which is now an integral part of LaTeX2e.
7682 \begin_layout Subsection
7686 \begin_layout Standard
7687 Obviously, to use this document class, you need to select
7688 \begin_inset Quotes eld
7696 \begin_inset Quotes erd
7706 \begin_inset space ~
7712 There are some settings in the
7715 \begin_inset space ~
7720 dialog that you should know about that are specific to this class:
7723 \begin_layout Itemize
7724 Don't change the options
7735 \begin_inset space ~
7741 They're ignored by the
7748 \begin_layout Itemize
7749 The default font size is 20
7750 \begin_inset space \thinspace{}
7753 pt with the other options being 17
7754 \begin_inset space \thinspace{}
7758 \begin_inset space \thinspace{}
7762 \begin_inset space \thinspace{}
7768 \begin_layout Itemize
7777 but all math equations are still typeset in the usual roman font.
7780 \begin_layout Itemize
7785 TeX supports A4 and Letter paper sizes as well as a special size for working
7787 \begin_inset space \thinspace{}
7791 It doesn't support A5, B5, legal or executive paper sizes.
7794 \begin_layout Itemize
7795 Don't bother changing the
7799 settings because they are ignored anyway.
7800 All floats appear where they are defined in the text.
7803 \begin_layout Itemize
7808 setting behaves a bit differently for this class.
7813 TeX provides extensive footer and header capabilities including a user-defined
7816 \begin_inset space ~
7820 \begin_inset CommandInset ref
7822 reference "sec:foilfoot"
7827 The title page is treated differently to all other pages in the document
7836 has the logo centered at the bottom of the page (if one is defined).
7837 The possible page style choices and what they do are as follows:
7841 \begin_layout Labeling
7842 \labelwidthstring MMMMMMM
7849 The final output contains no page numbers, or other headers or footers
7850 (except footnotes of course).
7854 \begin_layout Labeling
7855 \labelwidthstring MMMMMMM
7862 The final output contains page numbers centered at the bottom of the page.
7863 No other headings or footers (other than footnotes).
7866 \begin_layout Labeling
7867 \labelwidthstring MMMMMMM
7872 Page numbers in lower right corner.
7873 Additional headers and footers are also shown.
7874 This is also the default.
7877 \begin_layout Labeling
7878 \labelwidthstring MMMMMMM
7883 Gives you access to the
7887 package although its use with
7891 TeX is discouraged by the writer of the
7895 TeX package because of some potential page layout clashes.
7899 \begin_layout Subsubsection
7903 \begin_layout Standard
7904 The following options may be used in the extra class options in the
7906 Document\SpecialChar \menuseparator
7912 \begin_layout Labeling
7913 \labelwidthstring MMMMMMx
7918 This sets up the page layout for 7.33
7919 \begin_inset space \thinspace{}
7923 \begin_inset space \thinspace{}
7926 in paper, which is about the same aspect ratio as a 35
7927 \begin_inset space \thinspace{}
7930 mm slide, making it a bit easier to work with this medium.
7933 \begin_layout Labeling
7934 \labelwidthstring MMMMMMx
7939 Places a rule across the page below the header on every page except the
7943 \begin_layout Labeling
7944 \labelwidthstring MMMMMMx
7949 Places a rule across the page above the footer on every page except the
7953 \begin_layout Labeling
7954 \labelwidthstring MMMMMMx
7959 This is automatically set each time you create a new
7968 TeX to use the dvips driver to rotate those pages that are set as landscape
7972 \begin_layout Labeling
7973 \labelwidthstring MMMMMMx
7978 Simply changes the page dimensions to those of a landscape page but doesn't
7980 Thus if you use this option you need to use an external program to rotate
7981 each page or feed your paper through your printer as landscape.
7982 Note that this option effectively reverses the roles of the
7990 environments (don't worry these are described in the next section).
7993 \begin_layout Labeling
7994 \labelwidthstring MMMMMMx
7999 Equation numbers on the left.
8002 \begin_layout Labeling
8003 \labelwidthstring MMMMMMx
8008 Flush-left equations.
8011 \begin_layout Subsection
8012 Supported Environments
8015 \begin_layout Standard
8016 Most of the environments commonly supported in other classes are also supported
8022 There are several additional environments provided by
8026 TeX as well as a couple added by LyX.
8027 The following environments are shared with other classes:
8030 \begin_layout Standard
8034 \begin_layout Plain Layout
8046 \begin_layout Itemize
8052 \begin_layout Itemize
8058 \begin_layout Itemize
8064 \begin_layout Itemize
8070 \begin_layout Itemize
8076 \begin_layout Itemize
8082 \begin_layout Itemize
8088 \begin_layout Itemize
8094 \begin_layout Itemize
8100 \begin_layout Itemize
8106 \begin_layout Itemize
8112 \begin_layout Itemize
8118 \begin_layout Itemize
8124 \begin_layout Itemize
8130 \begin_layout Itemize
8136 \begin_layout Itemize
8142 \begin_layout Itemize
8148 \begin_layout Itemize
8154 \begin_layout Standard
8158 \begin_layout Plain Layout
8170 \begin_layout Standard
8171 That is, all the major environments apart from the sectioning environments.
8172 Since foils are essentially self-contained sections, with a title and body,
8177 TeX provides specific commands for starting new foils and these are:
8180 \begin_layout Itemize
8186 \begin_layout Itemize
8192 \begin_layout Standard
8193 LyX also provides slightly modified versions of these two environments called:
8196 \begin_layout Itemize
8202 \begin_layout Itemize
8208 \begin_layout Standard
8209 and the differences will be explained in the next section.
8212 \begin_layout Standard
8213 Since foils are often used in presenting ideas or new theorems and such
8218 TeX also provides a comprehensive box of goodies for presenting them:
8221 \begin_layout Standard
8225 \begin_layout Plain Layout
8237 \begin_layout Itemize
8243 \begin_layout Itemize
8249 \begin_layout Itemize
8255 \begin_layout Itemize
8261 \begin_layout Itemize
8267 \begin_layout Itemize
8273 \begin_layout Itemize
8279 \begin_layout Itemize
8285 \begin_layout Itemize
8291 \begin_layout Itemize
8297 \begin_layout Itemize
8303 \begin_layout Standard
8307 \begin_layout Plain Layout
8319 \begin_layout Standard
8320 The starred versions are unnumbered while the unstarred versions are numbered.
8321 There are also two list environments added by LyX and these are:
8324 \begin_layout Itemize
8330 \begin_layout Itemize
8336 \begin_layout Standard
8341 TeX provides some powerful header and footer capabilities that are best
8342 set in the preamble although they may be set at any point in a document.
8343 If you want to change these settings in your document the best place to
8344 do so is at the very top of a foil, i.
8345 \begin_inset space \thinspace{}
8351 \begin_inset space \space{}
8356 straight after the foilhead.
8359 \begin_layout Standard
8360 For this purpose, the following command styles are provided [
8367 \begin_layout Standard
8371 \begin_layout Plain Layout
8383 \begin_layout Itemize
8387 \begin_inset space ~
8393 \begin_layout Itemize
8399 \begin_layout Itemize
8403 \begin_inset space ~
8409 \begin_layout Itemize
8413 \begin_inset space ~
8419 \begin_layout Itemize
8423 \begin_inset space ~
8430 \begin_layout Standard
8431 \begin_inset space ~
8438 \begin_layout Standard
8442 \begin_layout Plain Layout
8454 \begin_layout Standard
8455 There are also a few commands provided by
8459 TeX that aren't directly supported by LyX but I'll tell you what they do
8460 and how to use them in section
8461 \begin_inset space ~
8465 \begin_inset CommandInset ref
8467 reference "sec:unsuppfoils"
8474 \begin_layout Subsection
8475 Building a Set of Foils
8478 \begin_layout Standard
8479 This section will give a simple introduction to using the different environments
8480 to build a set of foils.
8481 If you want to see an example set of foils, take a look at the
8485 file you find in LyX's
8492 \begin_layout Subsubsection
8493 Give It a Title Page
8496 \begin_layout Standard
8497 Unlike other classes that provide
8517 creates the title on a page of its own.
8518 If you leave out the
8522 environment LaTeX will substitute the current date (every time you regenerate
8526 \begin_layout Subsubsection
8530 \begin_layout Standard
8531 As I mentioned earlier, there are four ways of starting a new foil.
8532 For portrait foils you should use
8541 The difference between these two environments is the amount of space between
8542 the title of the foil (the foilhead) and the body of the foil.
8545 \begin_layout Standard
8546 Landscape foils are generated using the
8555 Again the only difference is the spacing between foilhead and body.
8556 Both of the short versions have 0.5 inches less separation between the foilhead
8561 \begin_layout Standard
8562 One problem with the support for landscape foils is the requirement that
8567 driver to generate the PostScript output otherwise the foils won't be rotated.
8568 It is possible to get landscape foils even if you haven't got the
8572 driver provided you can feed your foils sideways through your printer ;-)
8575 \begin_layout Subsubsection
8576 Theorems, Lemmas, Proofs and more
8579 \begin_layout Standard
8580 Due to a small bug in LyX you can't have two of the same type of these environme
8581 nts directly following each other.
8582 They must be separated by something.
8583 If you try, you will just be extending the previous environment as if you
8584 had merged the two environments together.
8585 So, how do you get around this problem? The simplest option is to insert
8586 some text between the two environments or add a
8590 environment between the two with just a
8591 \begin_inset Quotes eld
8599 \begin_inset Quotes erd
8603 This will force LyX to produce two separate environments and hence the
8604 correct LaTeX output.
8605 An example is provided in the example file included with the LyX distribution.
8606 Remember, this problem only occurs if you are trying to place two of the
8607 same type of theorem-like environments one directly after the other.
8610 \begin_layout Subsubsection
8614 \begin_layout Standard
8615 You get all the commonly supported list styles found in other classes as
8616 well as two new ones.
8617 I'll only describe the new ones here.
8618 If you want to find out more about the other list environments check out
8624 If you intend to use itemized lists you might also want to read about the
8628 \begin_inset space ~
8632 \begin_inset space ~
8637 dialog described above in section
8638 \begin_inset space ~
8642 \begin_inset CommandInset ref
8644 reference "sec:bullet"
8651 \begin_layout Standard
8652 The two new list styles,
8660 , are designed to make it easier for you to create lists of do's and don'ts
8661 or right and wrong by providing dedicated environments that use a tick
8662 or a cross as the label of the list.
8663 These lists are in fact dedicated variants of the
8668 They do however require that you have the
8675 \begin_layout Subsubsection
8679 \begin_layout Standard
8684 TeX redefines the floating tables and figures so that they appear exactly
8685 where they are in the text rather than pushing them to the top of the page
8686 or to some user specified location.
8687 In fact if you change the float placement settings they are simply ignored.
8690 \begin_layout Subsubsection
8691 Page Headers and Footers
8692 \begin_inset CommandInset label
8701 \begin_layout Standard
8705 \begin_inset space ~
8714 are two commands used to control the left-footer text string.
8715 The first is meant to allow you to include a graphic logo on your foils
8717 \begin_inset Quotes eld
8725 \begin_inset Quotes erd
8729 While the second is meant to provide a classification for the audience,
8733 \begin_inset space \thinspace{}
8739 \begin_inset space \space{}
8743 It is empty by default.
8746 \begin_layout Standard
8747 The remaining page corners can be filled by
8750 \begin_inset space ~
8755 (which defaults to page numbers),
8758 \begin_inset space ~
8766 \begin_inset space ~
8774 \begin_layout Subsection
8780 \begin_inset CommandInset label
8782 name "sec:unsuppfoils"
8789 \begin_layout Standard
8790 All the commands mentioned below need to be set in a
8798 within another environment.
8801 \begin_layout Subsubsection
8805 \begin_layout Standard
8806 All lengths are adjusted using the
8829 should be replaced by the name given to the length you want to change and
8834 is the length value.
8835 All lengths should be specified in units of length such as inches (
8847 ) or relative to some document or font-based length such as
8857 \begin_layout Standard
8858 It's possible to change the spacing between a foilhead and the body of the
8859 foil by adjusting the length specified by
8866 For example, to make
8871 \begin_inset space \space{}
8874 in closer to their bodies put the following in the preamble:
8880 foilheadskip}{-0.5in}
8883 \begin_layout Standard
8884 The spacings around floats can be adjusted by setting these lengths:
8887 \begin_layout Labeling
8888 \labelwidthstring MMMMMMMMMMM
8895 Separation between the text and the top of the float
8898 \begin_layout Labeling
8899 \labelwidthstring MMMMMMMMMMM
8906 Separation between the float and the caption
8909 \begin_layout Labeling
8910 \labelwidthstring MMMMMMMMMMM
8917 Separation between the caption and the following text
8920 \begin_layout Labeling
8921 \labelwidthstring MMMMMMMMMMM
8928 You can make the captions narrower than the surrounding text by adjusting
8930 Best done relative to
8939 \begin_layout Standard
8940 There are also several title page related lengths that you may find useful
8941 if you have a long title or several authors:
8944 \begin_layout Labeling
8945 \labelwidthstring MMMMMMMMMMM
8952 Separation from headers to
8957 \begin_layout Labeling
8958 \labelwidthstring MMMMMMMMMMM
8976 \begin_layout Labeling
8977 \labelwidthstring MMMMMMMMMMM
8991 \begin_layout Labeling
8992 \labelwidthstring MMMMMMMMMMM
9008 \begin_layout Labeling
9009 \labelwidthstring MMMMMMMMMMM
9025 \begin_layout Standard
9026 The last length related command affects all the list environments.
9037 a list environment then all the vertical spacing between the list items
9039 Note that this is a command not a length so it doesn't require
9045 like the stuff mentioned above.
9048 \begin_layout Subsubsection
9052 \begin_layout Standard
9065 commands control whether the logo in the
9069 definition appear on a given page.
9076 in the preamble then none of the foils will have the logo on them.
9077 If you don't want the logo on a particular page place the
9083 directly after the foilhead of that page and the
9089 directly after the next foilhead.
9092 \begin_layout Standard
9093 If you decide to use the
9097 page style setting in the
9100 \begin_inset space ~
9105 dialog you should probably add
9115 to your preamble so headers and footers on landscape pages are correctly
9116 placed when rotated.
9117 This is due to some clashes between the page layouts provided by the
9128 \begin_layout Section
9129 Hollywood (Hollywood spec scripts)
9132 \begin_layout Standard
9138 \begin_layout Subsection
9142 \begin_layout Standard
9143 Getting the format of a Hollywood script right is a
9144 \begin_inset Quotes eld
9148 \begin_inset Quotes erd
9151 It is designed to make the readers focus on content and to be easy and
9152 familiar for the actors to read.
9153 Each page of a script should be one minute of film.
9154 Nothing goes in a script that you cannot see or hear on screen.
9155 The courier 12 pt font should be used throughout.
9159 \begin_layout Subsection
9163 \begin_layout Standard
9164 Speakers' lines should NEVER break in mid-sentence.
9165 If a speaker's lines continue over a page break, repeat the
9169 title followed by (Cont'd).
9172 \begin_layout Subsection
9176 \begin_layout Standard
9181 names as labels then cross-reference the label to insert the name.
9182 The cross-reference dialog will show the current cast of characters.
9183 You can use this to insert the speaker name in narratives also.
9186 \begin_layout Subsection
9187 Paper size and Margins
9190 \begin_layout Standard
9191 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9194 \begin_layout Subsection
9198 \begin_layout Standard
9199 The following environments are available.
9200 You can use hollywood.bind to get the bind keys shown at the right.
9203 \begin_layout Itemize
9207 \begin_inset Newline newline
9212 Used where nothing else works.
9216 \begin_layout Itemize
9222 \begin_inset space \hfill{}
9230 \begin_inset Newline newline
9233 Usually followed by something like
9234 \begin_inset Quotes eld
9238 \begin_inset Quotes erd
9244 \begin_layout Itemize
9248 \begin_inset space \hfill{}
9252 \begin_inset Newline newline
9257 Introduces a new INTERIOR camera set-up.
9258 Always followed by DAY or NIGHT, or something similar to define the lighting
9260 Everthing on this line in CAPS.
9263 \begin_layout Itemize
9267 \begin_inset space \hfill{}
9271 \begin_inset Newline newline
9276 Introduces a new EXTERIOR camera set-up.
9277 Everthing on this line in CAPS.
9280 \begin_layout Itemize
9284 \begin_inset space \hfill{}
9288 \begin_inset Newline newline
9293 The character speaking.
9296 \begin_layout Itemize
9300 \begin_inset space \hfill{}
9304 \begin_inset Newline newline
9309 Instructions to the speaker.
9310 The () are automatically inserted, but only the ( will show in LyX.
9311 Both will be printed.
9314 \begin_layout Itemize
9318 \begin_inset space \hfill{}
9322 \begin_inset Newline newline
9334 \begin_layout Itemize
9338 \begin_inset space \hfill{}
9342 \begin_inset Newline newline
9347 Camera movement instruction.
9349 \begin_inset space \thinspace{}
9353 \begin_inset space \space{}
9359 \begin_layout Itemize
9363 \begin_inset space \hfill{}
9369 \begin_layout Itemize
9373 \begin_inset space \hfill{}
9379 \begin_layout Itemize
9383 \begin_inset space \hfill{}
9389 \begin_layout Itemize
9393 \begin_inset space \hfill{}
9399 \begin_layout Subsection
9403 \begin_layout Itemize
9404 (O.S) — off screen
9407 \begin_layout Itemize
9408 (V.0) — voice over
9411 \begin_layout Itemize
9413 \begin_inset space \thinspace{}
9420 \begin_layout Itemize
9425 \begin_layout Itemize
9426 PAN — camera movement
9429 \begin_layout Itemize
9430 INSERT — cut to close-up of
9433 \begin_layout Section
9437 \begin_layout Standard
9440 Panayotis Papasotiriou
9443 \begin_layout Subsection
9447 \begin_layout Standard
9448 The ijmpc package is a set of macros that facilitates electronic manuscript
9451 International Journal of Modern Physics C
9454 Similarly, the ijmpd package is for creating manuscripts to be submitted
9457 International Journal of Modern Physics D
9460 Both journals are published by World Scientific.
9461 The corresponding document classes are named
9470 These files, together with instructions for the authors, can be downloaded
9472 \begin_inset Flex URL
9475 \begin_layout Plain Layout
9477 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
9483 \begin_inset Flex URL
9486 \begin_layout Plain Layout
9488 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
9494 Both packages are modified versions of the standard
9495 \begin_inset Quotes eld
9499 \begin_inset Quotes erd
9502 package, and they are almost (but not exactly) identical.
9503 Most of their features are supported by LyX.
9504 I have used LyX successfully to write articles submitted to both journals
9505 without any problem.
9508 \begin_layout Subsection
9512 \begin_layout Standard
9513 As usual, the easiest way to write a paper is to start with a template.
9516 File\SpecialChar \menuseparator
9535 This will give an (almost) empty document that includes the most common
9536 fields found in a manuscript.
9537 Simply overwrite the existing text (including the brackets,
9542 You should keep in mind the following remarks.
9545 \begin_layout Enumerate
9546 LyX won't let you change the font size and the page style of the document,
9547 because such modifications are not allowed by both packages.
9550 \begin_layout Enumerate
9551 The language of the document should not be changed.
9552 Before previewing your paper, be sure that the babel package is not used.
9553 To do this, click on
9555 Tools\SpecialChar \menuseparator
9566 checkbox in the language settings, and click on
9574 , if you wish to make this change permanent).
9577 \begin_layout Enumerate
9579 \begin_inset Quotes eld
9583 \begin_inset Quotes erd
9586 style must be used to define keywords.
9589 \begin_layout Enumerate
9590 The ijmpc package provides a style named
9591 \begin_inset Quotes eld
9594 Classification Codes
9595 \begin_inset Quotes erd
9598 , which can be used to define classification codes, such as PACS numbers.
9599 Note that this facility is not supported by the ijmpd package.
9602 \begin_layout Enumerate
9603 Several new environments are available:
9604 \begin_inset Quotes eld
9608 \begin_inset Quotes erd
9612 \begin_inset Quotes eld
9616 \begin_inset Quotes erd
9620 \begin_inset Quotes eld
9624 \begin_inset Quotes erd
9628 \begin_inset Quotes eld
9632 \begin_inset Quotes erd
9636 \begin_inset Quotes eld
9640 \begin_inset Quotes erd
9644 \begin_inset Quotes eld
9648 \begin_inset Quotes erd
9652 \begin_inset Quotes eld
9656 \begin_inset Quotes erd
9660 \begin_inset Quotes eld
9664 \begin_inset Quotes erd
9668 \begin_inset Quotes eld
9672 \begin_inset Quotes erd
9676 \begin_inset Quotes eld
9680 \begin_inset Quotes erd
9684 \begin_inset Quotes eld
9688 \begin_inset Quotes erd
9692 \begin_inset Quotes eld
9696 \begin_inset Quotes erd
9700 \begin_inset Quotes eld
9704 \begin_inset Quotes erd
9708 \begin_inset Quotes eld
9712 \begin_inset Quotes erd
9716 Their use is more or less obvious.
9717 LyX supports all these environments; it will use the proper label, text
9718 style, and numbering scheme for each of them.
9721 \begin_layout Enumerate
9722 Both packages use basic citations; the natbib package should not be used.
9723 In LyX, citation references are shown as usual; in the output, citations
9724 are shown as superscripts.
9725 If you want to use a citation as normal text, you should use the
9730 \begin_inset space \thinspace{}
9734 \begin_inset space \space{}
9738 \begin_inset Quotes eld
9742 \begin_inset space \space{}
9752 \begin_inset Quotes erd
9758 \begin_layout Enumerate
9760 \begin_inset Quotes eld
9764 \begin_inset Quotes erd
9767 section in both packages.
9768 To put acknowledgments, just use the
9769 \begin_inset Quotes eld
9773 \begin_inset Quotes erd
9779 \begin_layout Enumerate
9780 Appendices may be added to the paper,
9784 the Acknowledgments and
9789 LyX provides a special environment, called
9790 \begin_inset Quotes eld
9794 \begin_inset Quotes erd
9797 which marks the beginning of the appendices.
9798 This environment should be left blank; it just sends a LaTeX command, but
9799 nothing is really printed.
9801 \begin_inset Quotes eld
9805 \begin_inset Quotes erd
9808 is printed with blue letters, as a signal that all sections after that
9809 point are appendices.
9810 To write an appendix, use the
9811 \begin_inset Quotes eld
9815 \begin_inset Quotes erd
9819 LyX will number each appendix with capital letters, as required by both
9822 \begin_inset Quotes eld
9826 \begin_inset Quotes erd
9833 be present before the first appendix; if not, all appendices will be numbered
9834 as normal sections in the output.
9837 \begin_layout Enumerate
9838 The ijmpc and the ijmpd packages use the
9842 command to implement table captions.
9843 As a result, a table created by LyX is printed correctly, but its caption
9845 However, you can use some TeX code to overpass this problem, so that captions
9846 are printed as expected.
9847 To do so, create a float table as usual, remove the caption, and replace
9848 it with the TeX code
9858 (sic); you must also the TeX code
9862 immediately after the tabular material.
9863 Study the example table included in the template files to see how this
9864 trick is implemented.
9865 Alternatively, If you need table captions, you should implement the whole
9870 file, then include this file to the LyX document (
9872 Insert\SpecialChar \menuseparator
9873 File\SpecialChar \menuseparator
9875 \begin_inset space ~
9881 Details on how to create a table float can be found in the files
9889 , included in the corresponding packages.
9892 \begin_layout Subsection
9893 Preparing a paper for submission
9896 \begin_layout Standard
9897 Before you submit your paper you must export the LyX document as a LaTeX
9900 File\SpecialChar \menuseparator
9901 Export\SpecialChar \menuseparator
9912 \begin_layout Plain Layout
9913 Actually you have the choice between LaTeX (plain) and pdflatex.
9914 If you intend to use pdflatex to prepare the paper, you should use the
9915 pdflatex option so that included graphics are converted to PDF format,
9916 ready for use by pdflatex.
9921 , then make the following changes to the resulting
9928 \begin_layout Enumerate
9929 Remove the comment lines before the
9938 \begin_layout Enumerate
9939 Remove everything between (and including) the
9951 commands, except for any commands you specifically put into the LaTeX preamble.
9954 \begin_layout Standard
9959 file should be saved and processed through LaTeX as many times as necessary.
9960 You may also want to check the resulting
9967 \begin_layout Subsection
9971 \begin_layout Standard
9972 The use of TeX code is reduced to two commands, which must be placed at
9973 the top of the document.
9974 If you started writing your paper by using the
9982 template, the TeX code needed is already in its place; you usually don't
9984 You may only modify the first TeX code to specify the information printed
9985 to the top of odd and even pages (authors' names and short paper's title,
9987 This TeX code must have the form
9991 markboth{Authors' Names}{Short Paper's Title}
9996 \begin_layout Section
10000 \begin_layout Standard
10006 \begin_layout Subsection
10010 \begin_layout Standard
10011 The iopart package provides a document class to create electronic manuscript
10012 submission to the journals published by the Institute of Physics.
10013 Instructions for the authors how to create a paper using the iopart class
10014 can be downloaded together with the iopart package from the site
10015 \begin_inset Flex URL
10018 \begin_layout Plain Layout
10020 ftp://ftp.iop.org/pub/journals/latex2e
10028 \begin_layout Subsection
10032 \begin_layout Standard
10033 The easiest way to write a paper is to start with the file
10037 that is available in LyX's examples files folder.
10038 Open this file, save it under a new name, and start writing.
10039 The example file explains how to use the special text environments.
10040 Here are the most important advices:
10043 \begin_layout Itemize
10044 To be able to compile your document to a PDF, PS, or DVI, assure that the
10047 Use AMS math package
10049 in the document settings under
10056 \begin_layout Itemize
10059 The title environment defines the kind of your paper.
10060 So use one of the following environments for the title:
10064 \begin_layout Itemize
10073 \begin_layout Itemize
10082 \begin_layout Itemize
10088 for a Topical review
10091 \begin_layout Itemize
10100 \begin_layout Itemize
10109 \begin_layout Itemize
10115 for a Paper (same as Title)
10118 \begin_layout Itemize
10124 for a Preliminary communication
10127 \begin_layout Itemize
10133 for a Rapid communication
10136 \begin_layout Itemize
10142 for a Letter to the editor
10146 \begin_layout Itemize
10149 All title environments except of
10153 can have an optional short title.
10156 \begin_layout Itemize
10157 There is a general title environment
10161 which is not directly supported by the LyX.
10162 This can be used as TeX code when your document doesn't fit into one of
10163 the other title types.
10166 \begin_layout Standard
10167 For more informations like hints for special table and formula formatting,
10168 look at the IOP author guidelines.
10171 \begin_layout Section
10175 \begin_layout Standard
10178 Panayotis Papasotiriou
10181 \begin_layout Subsection
10185 \begin_layout Standard
10186 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
10187 that facilitates electronic manuscript submission to the journals they
10189 Most known of them (at least in my domain of interest) are
10191 Astrophysics and Space Science
10197 , but there are many others (see a complete list at
10198 \begin_inset Flex URL
10201 \begin_layout Plain Layout
10203 http://www.wkap.nl/jrnllist.htm/JRNLHOME
10209 The Kluwer package may be downloaded from the site
10210 \begin_inset Flex URL
10213 \begin_layout Plain Layout
10215 http://www.wkap.nl/kaphtml.htm/STYLEFILES
10221 A complete user guide is contained in that package (but it can also be
10222 downloaded separately).
10225 \begin_layout Standard
10226 LyX supports many features of the package but not everything.
10227 However, the TeX code needed is reduced to some
10228 \begin_inset Quotes eld
10232 \begin_inset Quotes erd
10235 commands of the package (see
10236 \begin_inset space ~
10240 \begin_inset CommandInset ref
10242 reference "subsec:kluwer_peculiarities"
10247 I have recently used LyX to write an article submitted to the
10249 Astrophysics and Space Science
10251 without any problem.
10254 \begin_layout Subsection
10258 \begin_layout Standard
10259 The easiest way to write a paper is to start with the Kluwer template file.
10262 File\SpecialChar \menuseparator
10274 This will give an (almost) empty document that includes the most common
10275 fields found in a manuscript and a short description of their use.
10276 As in most templates, simply overwrite the existing text (including the
10281 ) with the correct information.
10284 \begin_layout Subsection
10285 Preparing a paper for submission
10288 \begin_layout Standard
10289 As in the AASTeX package, before you submit your paper to a journal you
10291 \begin_inset Quotes eld
10295 \begin_inset Quotes erd
10301 \begin_layout Enumerate
10302 Export your paper as a LaTeX file.
10303 To do this, click on
10305 File\SpecialChar \menuseparator
10306 Export\SpecialChar \menuseparator
10313 \begin_layout Enumerate
10318 file with a text editor and make the following changes
10322 \begin_layout Enumerate
10323 remove the comment lines before the
10332 \begin_layout Enumerate
10333 remove everything between (and including) the
10345 commands, except for any commands you specifically put into the LaTeX preamble.
10348 \begin_layout Standard
10357 \begin_layout Enumerate
10362 file through LaTeX as many times as necessary (usually up to three).
10365 \begin_layout Enumerate
10371 \begin_inset space \thinspace{}
10375 \begin_inset space \space{}
10382 , and check if everything is OK (it should, if you didn't make any mistake).
10385 \begin_layout Subsection
10386 \begin_inset Quotes eld
10390 \begin_inset Quotes erd
10393 of the Kluwer package
10394 \begin_inset CommandInset label
10396 name "subsec:kluwer_peculiarities"
10403 \begin_layout Standard
10404 The Kluwer package has the following
10405 \begin_inset Quotes eld
10409 \begin_inset Quotes erd
10415 \begin_layout Enumerate
10416 It is possible to write multiple articles in the same LaTeX file
10420 \begin_layout Plain Layout
10421 I can't imagine any good reason to do this.
10427 Each article must be included in the environment
10428 \begin_inset Quotes eld
10432 \begin_inset Quotes erd
10436 Unfortunately, this environment cannot be omitted, even if you write just
10438 Therefore, each article starts with the command
10444 and, obviously, ends with the command
10451 Although this can be implemented in LyX, I didn't included it, since it
10452 looks ugly and can confuse the novice user.
10453 Therefore, you need to enter them directly and mark them as LaTeX code
10455 \begin_inset Quotes eld
10459 \begin_inset Quotes erd
10465 \begin_layout Enumerate
10466 Information given at the beginning of the article (i.
10467 \begin_inset space \thinspace{}
10471 \begin_inset space \space{}
10474 title, subtitle, author, institution, running title, running author, abstract
10475 and keywords) must be included in an environment called
10476 \begin_inset Quotes eld
10480 \begin_inset Quotes erd
10484 This is not implemented in LyX, so you must enter title, subtitle etc.
10485 \begin_inset space ~
10488 between two TeX code lines (
10503 \begin_layout Enumerate
10504 According to the user manual, the label of each bibliography item must be
10528 \begin_layout Standard
10533 template takes care of all these
10534 \begin_inset Quotes eld
10538 \begin_inset Quotes erd
10542 If you start a new paper using this template you don't need to do anything
10547 \begin_layout Enumerate
10548 don't delete the TeX code included in the template, and
10551 \begin_layout Enumerate
10552 copy the example bibliography item included in the template and modify it
10553 as necessary to enter new bibliography items.
10556 \begin_layout Section
10560 \begin_layout Standard
10566 \begin_layout Subsection
10570 \begin_layout Standard
10571 The LyX document classes
10573 article (koma-script)
10577 report (koma-script)
10595 correspond to the LaTeX document classes
10612 \begin_inset space ~
10615 of the Koma-Script family.
10616 They are replacements for the standard document classes
10632 , resp., and fit better to European typography conventions in a number of
10636 \begin_layout Itemize
10637 Standard character size is 11pt in
10639 article (koma-script)
10643 report (koma-script)
10651 letter (koma-script)
10656 \begin_layout Itemize
10657 Headings, labels of the description environment, and a number of elements
10660 letter (koma-script)
10662 document class are set in a bold sans serif font.
10666 \begin_layout Plain Layout
10667 There is a big difference between the bold sans serif old cm fonts and new
10668 ec fonts, especially in the appearance of headings.
10669 In comparison, the ec bold sans serif fonts look a bit thin.
10670 Here the LaTeX package
10678 helps to produce the
10679 \begin_inset Quotes eld
10683 \begin_inset Quotes erd
10686 appearance when using the ec fonts.
10691 The numbering of chapter headings is made in the same way as the numbering
10692 of section headings, that is without the extra line
10693 \begin_inset Quotes eld
10696 Chapter\SpecialChar \ldots{}
10698 \begin_inset Quotes erd
10702 In addition, the appearance of the headings can be modified by using a
10703 number of options (in LyX to be entered in the field
10706 \begin_inset space ~
10713 Layout\SpecialChar \menuseparator
10717 A detailed German description of these options can be found in the Koma-Script
10725 \begin_layout Itemize
10726 The main means in the Koma-Script document classes to design the type area
10735 (in LyX to be entered in the extra class options field in the dialog
10737 Document\SpecialChar \menuseparator
10741 They make a clearer modification of page margins possible as do the options
10744 Document\SpecialChar \menuseparator
10748 A detailed German description of these and other type area options can
10749 be found in the Koma-Script documentation
10756 \begin_layout Itemize
10757 The LaTeX document classes of the Koma-Script family define a number of
10758 additional commands.
10759 Those part of it which makes sense in LyX is implemented in corresponding
10763 \begin_layout Standard
10764 A detailed German description of the LaTeX document classes of the Koma-Script
10765 family can be found in the Koma-Script documentation
10773 \begin_layout Plain Layout
10774 There is an English translation
10778 , but it is not a complete one.
10783 The following sections describe only those aspects, which are relevant
10787 \begin_layout Subsection
10788 article (koma-script), report (koma-script), and book (koma-script)
10791 \begin_layout Standard
10792 The document classes
10794 article (koma-script)
10798 report (koma-script)
10808 are implemented in the layout files
10821 They contain all the paragraph types of the corresponding standard document
10834 , resp., partly modified, with the exception of the LyX specific
10838 -type, which is replaced by the new
10842 -type having the same functionality.
10847 -Type there is a number of new paragraph types added.
10854 letter (koma-script)
10859 \begin_layout Itemize
10868 : are equivalents to
10876 , resp., additionally inserting an entry in the table of contents.
10885 are not contained in
10887 article (koma-script)
10892 \begin_layout Itemize
10901 : behave exactly as
10909 , resp., additionally clearing running heads.
10914 is not contained in
10916 article (koma-script)
10922 \begin_layout Plain Layout
10935 report (koma-script)
10937 , but since this is identical to
10941 , is has not been implemented in LyX.
10949 \begin_layout Itemize
10954 : generates a heading directly above the following paragraph in the standard
10955 character size without affecting the structure of the document.
10958 \begin_layout Itemize
10967 are special captions which respect the different space settings needed
10968 for captions placed above or below an element (if you follow strict typographic
10969 rules, you might want to place table captions always above the table).
10970 You can also use the class option
10974 , which will switch
10987 You need at least Koma-Script version 2.8q to use this.
10990 \begin_layout Itemize
10995 : can be used to set a bonmot, e.
10996 \begin_inset space \thinspace{}
11000 \begin_inset space \space{}
11003 at the beginning of a chapter.
11004 If you use the optional argument (
11006 Insert\SpecialChar \menuseparator
11008 \begin_inset space ~
11013 ), you can insert the dictum's author there.
11014 Dictum and author are separated by a line.
11015 You need at least Koma-Script version 2.8q to use this.
11020 is not contained in
11022 article (koma-script)
11027 \begin_layout Standard
11028 The following types, together with the standard types
11040 , form the title area of the document.
11041 They must be entered ahead of the first
11042 \begin_inset Quotes eld
11046 \begin_inset Quotes erd
11053 \begin_layout Plain Layout
11054 The corresponding LaTeX commands must appear before the
11065 When such a type is used more than once, the latter usage overwrites the
11066 former one, that means, for every type only the latest usage is valid.
11067 The order of the different types however has, like
11079 , no effect on the appearance of the produced document.
11082 \begin_layout Itemize
11087 : produces a centered paragraph above the ordinary title (
11099 ) for the subject of the document.
11102 \begin_layout Itemize
11107 : produces a centered paragraph below the ordinary title (
11119 ) for the publishers' name.
11122 \begin_layout Itemize
11129 report (koma-script)
11135 produces a centered paragraph on its own page behind the title page, or
11138 article (koma-script)
11140 produces a centered paragraph below the ordinary title (
11156 ) for a dedication.
11159 \begin_layout Itemize
11164 : produces a left aligned paragraph above the ordinary title (
11180 ) for a document`s head.
11183 \begin_layout Itemize
11188 : produces in a double-sided print in
11190 report (koma-script)
11196 a left-aligned paragraph at the top of the title page`s back or has no
11197 effect in a single-sided print or in
11199 article (koma-script)
11204 \begin_layout Itemize
11209 : produces in a double-sided print in
11211 report (koma-script)
11217 a left-aligned paragraph at the bottom of the title page`s back or has
11218 no effect in a single-sided print or in
11220 article (koma-script)
11225 \begin_layout Itemize
11230 : produces a special
11231 \begin_inset Quotes eld
11235 \begin_inset Quotes erd
11238 page ahead of the actual document containing a paragraph without special
11242 \begin_layout Standard
11243 The layout files for the document classes
11245 article (koma-script)
11249 report (koma-script)
11255 do include the file
11260 This is thought of as a place to define your own types.
11265 in your personal layout directory and edit the file!
11268 \begin_layout Subsection
11269 letter (koma-script)
11272 \begin_layout Standard
11276 \begin_layout Plain Layout
11288 \begin_layout Standard
11292 letter (koma-script)
11294 is implemented in the layout file
11299 It contains all the paragraph types of the corresponding standard document
11304 , partly modified, with the exception of the LyX specific types
11316 type, which is replaced by the new
11321 In addition, it contains, in contrast to the standard document class, the
11339 Furthermore, there are a number of new letter specific types.
11342 \begin_layout Standard
11346 \begin_layout Plain Layout
11358 \begin_layout Standard
11359 The appearance of the letter produced by this document class can be controlled
11360 by a number of LaTeX commands, which you can put in the LaTeX preamble.
11364 \begin_layout Plain Layout
11365 For example, the standard appearance of the letter`s heading, consisting
11366 of name and address, is quite self-willed.
11368 \begin_inset Quotes eld
11372 \begin_inset Quotes erd
11375 heading is produced by the following LaTeX commands in the preamble:
11378 \begin_layout LyX-Code
11388 \begin_layout LyX-Code
11404 \begin_layout LyX-Code
11414 \begin_layout LyX-Code
11434 A detailed German description of such LaTeX commands can be found in the
11435 Koma-Script documentation
11440 With it, the letter's author can produce his personal letter layout.
11443 \begin_layout Standard
11452 define the beginning of the letter and must be used in every letter.
11453 To emphasize them in the LyX document class, they are marked with the letter
11463 \begin_inset space ~
11466 in the left margin.
11467 It is possible to write any number of letters in one file.
11472 type produces a new letter using the same addressee and a
11476 type produces a new addressee.
11493 are ordinary paragraph types and can also be used several times in one
11494 and the same letter.
11497 \begin_layout Itemize
11502 : produces a paragraph for the addressee and implicitly defines the beginning
11506 \begin_layout Itemize
11511 : produces a paragraph for the form of address and implicitly produces a
11515 \begin_layout Itemize
11520 : produces a paragraph for a close.
11523 \begin_layout Itemize
11528 : produces a paragraph for a postscript.
11531 \begin_layout Itemize
11536 : produces a paragraph for a distribution list.
11539 \begin_layout Itemize
11544 : produces a paragraph for enclosures.
11547 \begin_layout Standard
11588 are input types provided with a label to enter information, which will
11589 be processed by the document class.
11593 \begin_layout Plain Layout
11594 It could be seen as a matter of inconsequence, that the types
11602 described above are not such input types as well.
11603 Because of the special meaning of those types, however, I have implemented
11604 them as ordinary paragraph types with a one letter mark in the left margin.
11605 Moreover, it would affect my feeling of symmetry, if the
11613 type had such a serious different appearance.
11618 The types must be used ahead of the corresponding
11625 \begin_layout Standard
11626 An implementation of these types in a WYSIWYG fashion does not seem to make
11627 sense, because the real appearance of the produced letter does not only
11628 depend on the usage of the particular type, but also on other factors.
11629 For example, a signature entered in the
11633 type will in the standard behavior appear in the produced letter only,
11634 when in the same letter also a
11639 The entered value of the
11643 type will in the standard behavior not appear in the produced letter at
11645 The possibility to design the letter`s heading freely is already indicated
11646 in a footnote above.
11649 \begin_layout Standard
11650 The input types can also be used as empty paragraphs.
11651 This makes sense e.
11652 \begin_inset space \thinspace{}
11656 \begin_inset space \space{}
11668 type is not used at all, in the standard behavior the value of the
11672 type is used as signature, whereas if an empty
11676 type is used, no signature value is defined.
11679 \begin_layout Standard
11680 By using the input types it is possible to write a letter template, containing
11681 filled input types with your personal dates (name, address, etc.) and empty
11682 input types for other dates you want to enter.
11685 \begin_layout Itemize
11690 : sender's name, in the standard behavior appears as a centered paragraph
11691 in small caps in the letter`s heading.
11694 \begin_layout Itemize
11699 : sender's signature, in the standard behavior appears below the
11708 type is used, the value of the
11712 type appears instead.
11715 \begin_layout Itemize
11720 : sender's address, in the standard behavior appears in a centered paragraph
11721 in the letter`s heading below the sender's name.
11724 \begin_layout Itemize
11729 : sender's telephone number, in the standard behavior only sets the LaTeX
11739 \begin_layout Itemize
11744 : place of the letter`s making.
11747 \begin_layout Itemize
11752 : date of the letter`s making.
11761 , in the standard behavior, produce the place and the date in a right-aligned
11762 line below the addressee's field.
11767 type is used, neither place nor date appear, independent of the value of
11777 type is used, the date of the letter `s production is used.
11780 \begin_layout Itemize
11785 : sender`s back address, in the standard behavior appears above the addressee's
11786 field in a small sans serif font.
11789 \begin_layout Itemize
11794 : special mail information, in the standard behavior appears underlined
11795 above the addressee's field below the back address.
11798 \begin_layout Itemize
11803 : additional information, in the standard behavior appears on right side
11804 below the addressee`s field.
11807 \begin_layout Itemize
11812 : the letter's title, in the standard behavior appears in a big, bold, sans
11813 serif font above the subject.
11816 \begin_layout Itemize
11821 : the letter's subject, in the standard behavior appears in a bold font
11829 \begin_layout Standard
11850 produce a business letter like line above the
11854 line containing the fields
11855 \begin_inset Quotes eld
11859 \begin_inset Quotes erd
11863 \begin_inset Quotes eld
11867 \begin_inset Quotes erd
11871 \begin_inset Quotes eld
11875 \begin_inset Quotes erd
11879 \begin_inset Quotes eld
11883 \begin_inset Quotes erd
11887 \begin_inset Quotes eld
11891 \begin_inset Quotes erd
11895 \begin_inset Quotes eld
11899 \begin_inset Quotes erd
11903 For the date field, the value of the
11909 \begin_inset Quotes eld
11912 business letter types
11913 \begin_inset Quotes erd
11916 is used, the value of the
11920 type however does not appear, but only the LaTeX variable
11927 The ordinary output of place and date in a right-aligned line below the
11928 addressee`s field is suppressed.
11929 The types are implemented as input types provided with a label and must
11930 be used ahead of the corresponding
11937 \begin_layout Itemize
11945 \begin_layout Itemize
11953 \begin_layout Itemize
11961 \begin_layout Itemize
11969 \begin_layout Itemize
11977 \begin_layout Subsection
11978 The new letter class: letter (koma-script v.2)
11981 \begin_layout Standard
11984 Jürgen Spitzmüller
11987 \begin_layout Standard
11988 \begin_inset VSpace medskip
11994 \begin_layout Standard
11996 Koma-Script version 2.8 has introduced a new letter class
12000 which supersedes the now unsupported
12005 It has — on the LaTeX side — a completely new interface and is not compatible
12006 with the old class.
12007 Therefore, LyX supports both, though it is recommended to use the new class.
12010 \begin_layout Standard
12011 This class covers the same functionality as
12013 letter (koma-script),
12016 The basic items are
12020 (receiver's address, same as
12024 in the old layout),
12037 will start a new letter (i.
12038 \begin_inset space \thinspace{}
12042 \begin_inset space \space{}
12045 you can write several letters per document).
12046 New elements are sender's
12062 and the possibility to use a
12068 Insert\SpecialChar \menuseparator
12074 \begin_layout Standard
12075 The biggest improvement is, though, that the letter's layout is configurable
12076 at almost any needs.
12077 This can be done via the preamble or with a special style file (Letter
12078 Class Option, extension
12082 ), that will be read in as a class option.
12086 \begin_layout Plain Layout
12087 The KOMA package comes with some default
12092 There is, for instance, a
12096 file that follows german typesetting rules, or a
12100 that provides the default layout of the old
12105 The latter can be loaded with the class option
12114 ayout\SpecialChar \menuseparator
12119 ocument\SpecialChar \menuseparator
12131 template that is included in LyX for examples.
12132 A detailed description is to be found in the Koma-Script documentation
12140 \begin_layout Subsection
12144 \begin_layout Standard
12145 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
12149 \begin_layout Itemize
12150 The chapter number of a
12154 type appears on a line of its own above the chapter heading instead of
12155 appearing in the same line ahead of it.
12156 The cause for that is the LyX internal behavior for the labeltype
12160 in the layout file.
12163 \begin_layout Itemize
12164 The headings of the types
12172 are only put in the
12173 \begin_inset Quotes eld
12177 \begin_inset Quotes erd
12180 LaTeX table of contents, but not in the LyX table of contents (
12182 Document\SpecialChar \menuseparator
12184 \begin_inset space ~
12188 \begin_inset space ~
12196 \begin_layout Itemize
12197 The paragraphs in a
12201 document class appear in a skip separation mode, not indented.
12202 This is the standard behavior, no special LaTeX commands are needed for
12206 Document\SpecialChar \menuseparator
12209 dialog the corresponding radio button indicates
12218 value always has the effect that extra LaTeX commands are inserted in the
12219 document to produce the gap, which is not what is wanted in this case.
12222 \begin_layout Section
12223 Latex8 (IEEE Conference Papers)
12226 \begin_layout Standard
12232 \begin_layout Subsection
12236 \begin_layout Standard
12237 Since this class is specifically for writing submissions to IEEE sponsored
12238 conferences I strongly recommend that you get a copy of their Authors Kit.
12243 package and associated bibliography style file is included in the kit.
12244 The Authors Kit is usually sent out by email once your initial submission
12246 There is a lot of useful information in the Authors Kit explaining formatting
12247 restrictions and so on and I will assume you have read this since that
12248 means I don't have to repeat it all here.
12251 \begin_layout Subsection
12255 \begin_layout Standard
12256 [AR\SpecialChar \@.
12260 \begin_layout Subsection
12261 Supported Environments
12264 \begin_layout Itemize
12270 \begin_layout Itemize
12276 \begin_layout Itemize
12282 \begin_layout Itemize
12288 \begin_layout Itemize
12294 \begin_layout Itemize
12300 \begin_layout Itemize
12306 \begin_layout Itemize
12312 \begin_layout Itemize
12318 \begin_layout Subsection
12319 Differences Between Screen and Paper
12322 \begin_layout Standard
12323 There are slight differences in appearance mainly with the presentation
12324 of section counters.
12325 On screen the trailing period of the section counter is missing but it
12326 will appear in the output so don't let this worry you.
12329 \begin_layout Section
12333 \begin_layout Standard
12336 Jürgen Spitzmüller
12339 \begin_layout Subsection
12343 \begin_layout Standard
12344 Memoir is a very powerful and constantly evolving class.
12345 It has been designed with regard to fictional and non-fictional literature.
12346 Its aim is to let the user have maximum control over the typesetting of
12348 Memoir is based on the standard book class, but it can also emulate the
12349 article class (see below).
12352 \begin_layout Standard
12353 Peter Wilson, the developer of Memoir, is known as the author of lots of
12354 useful packages in the LaTeX world.
12355 Most of them have been merged with Memoir.
12356 Therefore, it is much easier to layout the table of contents, appendices,
12357 chapter designs and such.
12358 LyX, though, does not support all of these goodies natively.
12359 Some of them might be added to forthcoming releases
12363 \begin_layout Plain Layout
12364 You are invited to send suggestions to
12365 \begin_inset Flex URL
12368 \begin_layout Plain Layout
12370 lyx-devel@lists.lyx.org
12380 , lots will probably never, due to the limitations of LyX's framework.
12381 Of course you can still use all features with the help of some native LaTeX
12386 \begin_layout Plain Layout
12391 \begin_layout Plain Layout
12401 \begin_inset space ~
12405 \begin_inset CommandInset ref
12407 reference "sec:Inserting-TeX-Code"
12417 In this section, we can only list those features which are natively supported
12419 For detailed descriptions (and for the rest of features) we are recommending
12420 to have a look at the detailed manual of the Memoir class
12424 \begin_layout Plain Layout
12429 \begin_layout Plain Layout
12439 \begin_inset Flex URL
12442 \begin_layout Plain Layout
12444 CTAN:/macros/latex/memoir/memman.pdf
12454 , which is not only a user guide for the class, but also both a comprehensive
12455 description on good typesetting and a superb example for good typesetting
12459 \begin_layout Subsection
12460 Basic features and restrictions
12463 \begin_layout Standard
12464 Memoir supports basically all features of the standard book classes.
12465 There are, however, some differences, as follows:
12468 \begin_layout Description
12470 \begin_inset space ~
12473 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
12476 \begin_layout Description
12478 \begin_inset space ~
12481 style: The fancy page style is not supported, due to a command clash between
12482 Memoir and the fancyhdr package (they are both defining a command with
12483 the same name, which confuses LaTeX).
12484 Instead, Memoir comes with a bunch of own page styles (see
12486 Layout\SpecialChar \menuseparator
12487 Document\SpecialChar \menuseparator
12489 \begin_inset space ~
12495 If you want to use these for the chapter pages, you have to use the command
12502 in the main text or in preamble (e.
12503 \begin_inset space \thinspace{}
12507 \begin_inset space \space{}
12514 chapterstyle{companion}
12519 \begin_layout Description
12520 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
12521 an optional argument in the standard classes.
12522 With this, you can specify an alternative version of the title for the
12523 table of contents and the headers (for instance, if the title is too long).
12524 In LyX, you can do this via
12526 Insert\SpecialChar \menuseparator
12528 \begin_inset space ~
12533 at the beginning of a chapter/section.
12534 Memoir features a second optional argument and thus separates the table
12535 of contents from the header.
12536 You can define three variants of a title with this: one for the main text,
12537 one for the table of contents, and one for the headers.
12538 Simply insert two optional arguments if you need this feature, the first
12539 one containing the short title for the Table of Contents, the second one
12540 containing an alternative short title for the headers.
12543 \begin_layout Description
12544 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
12545 of contents, the list of figures and the list of table start a new page
12547 Memoir does not follow this route.
12548 You have to insert a page break yourself, if you want to have one.
12551 \begin_layout Description
12552 Titlepage: For some unknown reason, Memoir uses pagination on the title
12553 page (in the standard classes, title pages are
12554 \begin_inset Quotes eld
12558 \begin_inset Quotes erd
12562 \begin_inset space \thinspace{}
12566 \begin_inset space \space{}
12570 If you want an empty title page, type
12574 aliaspagestyle{title}{empty}
12579 \begin_layout Description
12580 Article: With the class option
12586 Layout\SpecialChar \menuseparator
12587 Document\SpecialChar \menuseparator
12589 \begin_inset space ~
12594 ), you can emulate article style.
12595 That is, counters (footnotes, figures, tables etc.) will not be reset on
12596 new chapters, chapters don't start a new page (but are—in contrary to
12597 \begin_inset Quotes eld
12601 \begin_inset Quotes erd
12604 article classes—still allowed), parts, though, use their own page, as in
12608 \begin_layout Description
12609 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
12610 font commands, which have been used in the old LaTeX version 2.09 (e.
12611 \begin_inset space \thinspace{}
12615 \begin_inset space \space{}
12631 It produces an error and stops LaTeX whenever such a command appears.
12636 reallows the commands and spits out warnings instead (which does at least
12638 Since a lot of packages and particularly BibTeX style files are still using
12639 those commands, we have decided to use this option by default.
12642 \begin_layout Subsection
12646 \begin_layout Standard
12647 We will only describe the features supported by LyX (which is not much currently
12649 Please consult the Memoir manual
12653 \begin_layout Plain Layout
12658 \begin_layout Plain Layout
12668 \begin_inset Flex URL
12671 \begin_layout Plain Layout
12673 CTAN:/macros/latex/memoir/memman.pdf
12686 \begin_layout Description
12687 Abstract: You may wonder why an abstract is an extra feature.
12688 Well, it is in book class.
12689 Usually books don't have abstracts.
12690 Memoir, however, has.
12691 You can use it wherever and how often you like.
12694 \begin_layout Description
12695 Chapterprecis: You may know this from belletristic: The contents of a chapter
12696 is shortly described below the title and also in the table of contents
12698 \begin_inset space \thinspace{}
12702 \begin_inset space \space{}
12707 Our hero arrives in Troia; he loses some friends; he finds others
12710 Chapterprecis does exactly this.
12711 It is therefore only sensible below a chapter.
12714 \begin_layout Description
12715 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
12716 The epigraph environment provides an elegant way of typesetting such a
12718 The motto itself (text) and its author (source) are divided by a short
12720 Unfortunately, we have to fool LyX a bit here again, since the environment
12721 needs two arguments (text and source).
12722 In this case, we have to use curly brackets (in TeX mode) between the two
12733 <author of the slogan>.
12736 \begin_layout Description
12737 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
12738 complex figurative poems).
12739 LyX can only support a few of them.
12740 One is poemtitle, which is a centered title for poems, which will also
12741 be added to the table of contents (verse is the standard environment for
12743 Memoir has some enhanced versions of verse, but you need to use TeX code,
12744 because they have to be nested inside regular verse environments, which
12745 is not possible with LyX).
12748 \begin_layout Description
12749 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
12752 \begin_layout Section
12753 Article (mwart), book (mwbk) and report (mwrep)
12754 \begin_inset OptArg
12757 \begin_layout Plain Layout
12770 \begin_layout Standard
12776 \begin_layout Standard
12777 The LyX document classes
12793 correspond to the LaTeX document classes
12806 They are replacements for the standard document classes
12818 , resp., and fit better to Polish typography conventions in a number of points.
12822 \begin_layout Standard
12826 \begin_layout Itemize
12827 Unnumbered titles (with star, e.
12828 \begin_inset space \thinspace{}
12832 \begin_inset space \space{}
12839 ) are added into table of contents,
12842 \begin_layout Itemize
12843 Additional page styles:
12847 \begin_layout Description
12848 uheadings header with separated lines,
12851 \begin_layout Description
12852 myheadings custom header, contents headers via commands:
12867 \begin_layout Description
12868 myuheadings custom header with separated lines,
12871 \begin_layout Description
12872 outer page number is placed on outer side of page
12876 \begin_layout Itemize
12881 \begin_layout Description
12882 rmheadings serif titles — default,
12885 \begin_layout Description
12886 sfheadings sansserif titles,
12889 \begin_layout Description
12890 authortitle on title page first placed is author next title — default,
12893 \begin_layout Description
12894 titleauthor on title page first placed is title next author,
12897 \begin_layout Description
12898 withmarginpar reserve place on page for margins.
12902 \begin_layout Section
12906 \begin_layout Standard
12911 provides an alternative to the standard
12916 It provides similar functionality, but you might prefer this layout with
12917 sans serif sections, headings, and more.
12920 \begin_layout Section
12924 \begin_layout Standard
12930 \begin_layout Standard
12931 \begin_inset VSpace bigskip
12937 \begin_layout Standard
12942 \begin_inset space ~
12947 textclass works with the American Physical Sociey's RevTeX 4.0 (the
12948 \begin_inset Formula $\beta$
12951 release of May, 1999) class.
12954 \begin_layout Standard
12959 textclass, which works with RevTeX 3.1.
12960 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
12961 That means that it doesn't interact very well with LyX, which requires
12962 LaTeX2e, although it has been kludged to work.
12963 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
12967 \begin_inset space ~
12972 textclass should also be pretty easy to use.
12975 \begin_layout Standard
12976 These documents are supposed to be used in
12980 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
12981 macros, and assume you'll know what to put in the preamble if necessary.
12984 \begin_layout Subsection
12988 \begin_layout Standard
12989 All you need to do is install RevTeX 4, as described in the package's README
12991 The package can be found at The RevTeX 4 Web Site
12992 \begin_inset Flex URL
12995 \begin_layout Plain Layout
12997 http://publish.aps.org/revtex4/
13003 Install it somewhere that LaTeX can see it.
13004 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13006 \begin_inset space \thinspace{}
13010 \begin_inset space \space{}
13013 not the directory where you installed the class file.) Then, if you reconfigure
13014 LyX, it will find the class file and let you use the RevTeX4 textclass.
13017 \begin_layout Standard
13018 Probably the easiest way to get started is either to import a RevTeX 4 document
13026 \begin_inset space ~
13031 template, found in the templates directory.
13034 \begin_layout Subsection
13038 \begin_layout Standard
13039 Optional arguments to
13046 \begin_inset Quotes eld
13050 \begin_inset Quotes erd
13054 \begin_inset Quotes eld
13058 \begin_inset Quotes erd
13068 \begin_inset space ~
13076 \begin_inset space ~
13082 Remember that in RevTeX, at least one optional argument is required!
13085 \begin_layout Standard
13086 Other preamble matter, like
13093 \begin_inset space ~
13103 \begin_inset space ~
13108 dialog, also as usual.
13111 \begin_layout Subsection
13115 \begin_layout Standard
13116 The layouts basically correspond to the commands in RevTeX4.0.
13117 For example, the Email layout corresponds to
13124 Note that (at least as of RevTeX 4.0 Beta), the
13132 layouts are exactly equivalent, so you shouldn't need to use both.
13136 \begin_layout Plain Layout
13137 In case you're curious, both were included so that
13141 would be able to translate both
13161 \begin_layout Subsection
13165 \begin_layout Standard
13166 There are a couple of important unique aspects of RevTeX 4 which might cause
13167 bugs that will be even more confusing in LyX.
13170 \begin_layout Standard
13188 The LyX equivalent is that there is a separate Thanks layout.
13193 write footnotes in the
13197 layout, or weird things may happen.
13198 See the RevTeX 4 documentation for more details.
13201 \begin_layout Standard
13205 \begin_inset space ~
13213 \begin_inset space ~
13222 layouts must be placed
13230 layout and the corresponding
13247 , the LaTeX won't compile.
13250 \begin_layout Subsection
13254 \begin_layout Standard
13255 The main problem with this layout is that you can't use the optional arguments
13256 to layouts like Email and Title.
13257 (The problem is not unique to this layout; you can't use optional arguments
13258 to the Section layouts either.) This means that after you export that file
13259 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13260 need to edit the LaTeX file with a text editor to add the optional arguments
13262 \begin_inset space \thinspace{}
13266 \begin_inset space \space{}
13269 the running title for the page headers.
13270 Lacking these layouts makes the
13276 (and the equivalent
13282 ) useless, so the corresponding layouts don't exist, and will have to be
13287 \begin_layout Plain Layout
13292 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13293 has not been updated yet to take advantage of it.
13301 \begin_layout Section
13302 Springer Journals (
13309 \begin_layout Standard
13315 \begin_layout Subsection
13319 \begin_layout Standard
13320 These are the layout files for some of the journal formats used by Springer
13321 Verlag and listed on
13322 \begin_inset Flex URL
13325 \begin_layout Plain Layout
13327 http://www.springer.de/author/tex/help-journals.html
13332 , where you should also go to fetch the class files (yes, these are LaTeX2e
13334 It is a modular system: the things common to all journals are implemented
13339 , which journal-specific layout files (such as, e.
13340 \begin_inset space \thinspace{}
13344 \begin_inset space \space{}
13351 for Journal of Geodesy) can include.
13354 \begin_layout Standard
13355 This means that implementing support for any other Springer journal on this
13356 list is as simple as writing your own
13364 file following the outline given in
13372 \begin_layout Standard
13373 It is reasonably well tested only for the Journal of Geodesy.
13382 come with the standard LyX distribution.
13383 Install the relevant class file (downloaded from Springer) in a proper
13384 directory, reconfigure LaTeX (in the teTeX case by running
13388 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
13389 and it should work.
13392 \begin_layout Subsection
13396 \begin_layout Standard
13397 A large number of theorem-like styles —
13403 \SpecialChar \ldots{}
13409 \begin_layout Standard
13412 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
13413 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
13416 See the Springer class file documentation for details.
13419 \begin_layout Subsection
13423 \begin_layout Itemize
13435 \begin_layout Itemize
13438 Probability Theory and Related Fields
13444 — Jean-Marc Lasgouttes
13447 \begin_layout Standard
13448 Add your own, it isn't so hard!
13451 \begin_layout Subsection
13455 \begin_layout Standard
13456 These files are partly based on the older
13460 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
13461 file from Springer.
13466 layout, are now defunct.
13467 Jean-Marc Lasgouttes helped out big in making me find my way around the
13468 LyX layout file mechanism.
13471 \begin_layout Subsection
13475 \begin_layout Standard
13477 But probably less than in the old hacked-LaTeX
13484 \begin_layout Standard
13486 \begin_inset space \thinspace{}
13489 g.: does not display the number for theorem-like layouts, just #.
13492 \begin_layout Section
13498 \begin_inset CommandInset label
13507 \begin_layout Standard
13515 \begin_layout Subsection
13519 \begin_layout Standard
13520 This section describes how to use LyX to make slides for overhead projectors.
13521 There are two document classes that can do this: the default slides class
13527 This section documents the former.
13530 \begin_layout Standard
13531 I'm going to say this again, nice and clear, so that there's no misunderstanding
13535 \begin_layout Standard
13536 \begin_inset VSpace bigskip
13542 \begin_layout Standard
13546 This section documents the class
13547 \begin_inset Quotes eld
13555 \begin_inset Quotes erd
13563 \begin_layout Standard
13564 \begin_inset VSpace bigskip
13570 \begin_layout Standard
13571 If you're looking for the documentation for
13572 \begin_inset Quotes eld
13580 \begin_inset Quotes erd
13583 , check out section
13584 \begin_inset space ~
13588 \begin_inset CommandInset ref
13590 reference "sec:foiltex"
13600 \begin_inset Quotes eld
13608 \begin_inset Quotes erd
13611 ] is actually somewhat better than the default
13619 \begin_layout Plain Layout
13620 \SpecialChar \ldots{}
13621 or so I've been told repeatedly by its advocates.
13622 Having never used it, I have no idea if this claim is true or not.
13627 which this section documents.
13630 \begin_layout Standard
13631 This class is the LaTeX2e improvement of the old
13636 Every LaTeX2e distribution includes this class [which I'll just refer to
13638 \begin_inset Quotes eld
13646 \begin_inset Quotes erd
13649 from now on], so you're bound to have it.
13650 As I noted earlier, there are other classes, such as
13654 , which also produce slides for overhead projectors and do a better job
13656 However, there are some things which
13660 can do which the others can't, such as generate overlays.
13661 Read on to learn more!
13664 \begin_layout Subsection
13666 \begin_inset CommandInset label
13668 name "sec:slidesetup"
13675 \begin_layout Standard
13676 Obviously, to use this document class, you need to select
13677 \begin_inset Quotes eld
13685 \begin_inset Quotes erd
13688 from the class list in the
13690 Document\SpecialChar \menuseparator
13694 There are some other special things you should know about this class:
13697 \begin_layout Itemize
13698 Don't bother changing the options
13703 They're not supported by the
13710 \begin_layout Itemize
13714 \begin_inset space ~
13719 behaves a bit differently for this class.
13720 The possible choices and what they do are as follows:
13724 \begin_layout Description
13729 The final output contains page numbers in the lower right corner.
13732 \begin_layout Description
13741 , but also prints out any time markers you've put in.
13742 This is the default.
13745 \begin_layout Description
13750 The final output contains no page numbers, time markers, or alignment markers.
13754 \begin_layout Itemize
13759 class has an extra option:
13765 \begin_inset Quotes eld
13773 \begin_inset Quotes erd
13776 in the extra class options.
13780 \begin_layout Standard
13781 Using this options allows you to add time markers to
13787 \begin_inset space ~
13791 \begin_inset CommandInset ref
13793 reference "sec:slideNote"
13801 \begin_layout Standard
13802 You can also use the template file
13803 \begin_inset Quotes eld
13811 \begin_inset Quotes erd
13814 to automatically set up a document to use the
13820 File\SpecialChar \menuseparator
13822 \begin_inset space ~
13826 \begin_inset space ~
13831 to open your new document].
13832 The template file also contains some examples of the special paragraph
13833 environments used by this class.
13834 I'll describe those next.
13837 \begin_layout Subsection
13838 Paragraph Environments
13841 \begin_layout Subsubsection
13842 Supported Environments
13845 \begin_layout Standard
13846 The first thing you'll notice when you start up a new
13850 document is the font size and type: it's the equivalent of the size
13851 \begin_inset Quotes eld
13859 \begin_inset Quotes erd
13865 \begin_inset space ~
13871 This is also what's used in the output.
13873 \begin_inset Quotes eld
13877 \begin_inset Quotes erd
13880 to remind you that this is a slide.
13881 Your final slides will use a larger font; ergo, you'll have less space.
13882 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
13885 \begin_layout Standard
13886 The next thing that becomes obvious is the changes to the paragraph environment
13887 pull-down box [at the far-left end of the toolbar].
13888 Most of the paragraph environments you're used to seeing are missing.
13889 There are also five new ones.
13894 class itself only supports certain paragraph environments:
13897 \begin_layout Itemize
13903 \begin_layout Itemize
13909 \begin_layout Itemize
13915 \begin_layout Itemize
13921 \begin_layout Itemize
13927 \begin_layout Itemize
13933 \begin_layout Itemize
13939 \begin_layout Itemize
13945 \begin_layout Itemize
13951 \begin_layout Itemize
13957 \begin_layout Itemize
13963 \begin_layout Standard
13964 All of the other standard environments, including the section-heading environmen
13965 ts, aren't used in the
13972 \begin_layout Standard
13973 On the other hand, you'll notice the following new environments:
13976 \begin_layout Itemize
13982 \begin_layout Itemize
13988 \begin_layout Itemize
13994 \begin_layout Itemize
14000 \begin_layout Itemize
14006 \begin_layout Standard
14007 These five are kind of quirky, due to a
14008 \begin_inset Quotes eld
14012 \begin_inset Quotes erd
14016 You see, LyX doesn't permit you to nest any other paragraph environment
14017 into an empty environment.
14018 Now, that's fine and dandy, but it means that you wouldn't be able to start
14019 a slide with anything except plain text.
14020 To deal with this, I've performed a little
14021 \begin_inset Quotes eld
14025 \begin_inset Quotes erd
14031 \begin_layout Subsubsection
14032 Quirks of the New Environments
14033 \begin_inset CommandInset label
14035 name "sec:slideQuirk"
14042 \begin_layout Standard
14043 All five of the new paragraph environments are somewhat quirky due to inherent
14044 limitiations in the current version of LyX.
14045 As I just mentioned, LyX forbids environments that begin with another environme
14047 To get around this, the
14051 environment isn't a paragraph environment as described in the
14059 \begin_layout Standard
14060 You should consider
14073 \begin_inset Quotes eld
14076 pseudo-environments.
14077 \begin_inset Quotes erd
14080 They look like a section heading or a
14081 \begin_inset Quotes eld
14089 \begin_inset Quotes erd
14092 but really begin a [and, if necessary, end the previous] paragraph environment.
14102 \begin_inset Quotes eld
14106 \begin_inset Quotes erd
14109 These two perform some action.
14112 \begin_layout Standard
14113 A common feature of all five environments,
14133 , is a rather long-ish label.
14134 The text following this label — ordinarily the contents of the paragraph
14135 environment — is utterly irrelevant for
14156 LyX completely ignores it.
14157 In fact, you can leave these five environments completely empty.
14161 \begin_layout Standard
14166 to put any text after the rather long-ish label, you might want to.
14167 This could be a short description of the contents of the
14172 In that case, enter in your descriptive comment and hit
14176 as you normally would.
14179 \begin_layout Standard
14180 If, on the other hand, you don't want to enter in any descriptive text,
14181 you'll hit another LyX quirk.
14182 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
14183 environment until you put something in the old one.
14187 \begin_layout Itemize
14188 Start entering the text that will
14216 \begin_layout Itemize
14217 Now move to the beginning of that paragraph.
14221 \begin_layout Itemize
14230 \begin_layout Itemize
14231 Finally, change this new, empty paragraph to a
14255 \begin_layout Standard
14256 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
14260 \begin_layout Subsection
14261 Making a Presentation with
14274 \begin_layout Subsubsection
14282 \begin_layout Standard
14283 If you're expecting this section to teach you how to actually make a presentatio
14284 n, you'll be sorely disappointed.
14285 Naturally, I'll describe all of the ways the
14289 class can assist you in preparing the materials for a presentation.
14290 Filling in the contents, however, is up to you.
14295 the LyX philosophy.]
14298 \begin_layout Standard
14303 environment [in the manner described in section
14304 \begin_inset space ~
14308 \begin_inset CommandInset ref
14310 reference "sec:slideQuirk"
14314 ] tells LyX to begin a new slide [duh].
14315 The label for this environment/
14316 \begin_inset Quotes erd
14320 \begin_inset Quotes erd
14324 \begin_inset Quotes eld
14328 \begin_inset Quotes erd
14331 in cool blue, followed by the label,
14332 \begin_inset Quotes eld
14336 \begin_inset Quotes erd
14340 Any text or paragraph environments that follow this one go on the new slide.
14344 \begin_layout Standard
14345 Slides are probably the only time you'll need to forcibly end pages in LyX
14346 (this can be specified in the
14351 In fact, you'll want to, once you finish entering the contents of one slide.
14352 If you've entered more text than can physically fit on a slide, the extra
14353 overflows onto a new slide.
14354 I don't recommend doing this, however, since the overflow slide won't have
14355 any page number on it.
14356 Furthermore, it may interfere with any
14360 you've made to accompany the oversized
14367 \begin_layout Standard
14376 environments work the same way as the
14381 They both create an
14382 \begin_inset Quotes eld
14386 \begin_inset Quotes erd
14389 followed by a label [
14390 \begin_inset Quotes eld
14394 \begin_inset Quotes erd
14398 \begin_inset Quotes eld
14402 \begin_inset Quotes erd
14406 The color is a stunning magenta instead of blue, and the
14407 \begin_inset Quotes eld
14411 \begin_inset Quotes erd
14414 will look different, in style and in length.
14415 The label fonts of all three also differ from one another.
14418 \begin_layout Standard
14423 , if the contents of a
14431 exceed the physical size of a slide or sheet of paper, the extra will overflow
14433 Again, you should avoid this.
14434 It defeats the whole purpose of
14445 \begin_layout Subsubsection
14455 \begin_layout Standard
14460 is a slide that sits atop another slide.
14461 Perhaps you wish to discuss a figure on the main
14465 before displaying the text associated with it.
14466 One way to accomplish this is tape a flap of dark paper over the part of
14471 you want to display later.
14472 This method fails, however, if you wish to overlap one graph with another,
14474 You would then have to fumble while speaking to align the two separate,
14479 s to align the two graphs.
14484 environment in both cases makes life much easier.
14487 \begin_layout Standard
14492 receives the page number of its
14493 \begin_inset Quotes eld
14497 \begin_inset Quotes erd
14505 \begin_inset Quotes eld
14513 \begin_inset Quotes erd
14520 \begin_layout Plain Layout
14521 Presumably, mutliple
14526 \begin_inset Quotes eld
14534 \begin_inset Quotes erd
14538 \begin_inset Quotes eld
14546 \begin_inset Quotes erd
14550 \begin_inset Quotes eld
14558 \begin_inset Quotes erd
14562 \begin_inset space ~
14565 appended to the page number of the parent
14575 Clearly, you want the contents of both the
14583 to each fit on a single physical slide! You should probably consider an
14589 \begin_inset Quotes eld
14593 \begin_inset Quotes erd
14605 class provides a visual cue for this: the label at the start of an
14609 is shorter than that at the start of a
14614 Lastly, when you generate printable output, you'll find alignment markers
14615 in all four corners of both the
14619 page and its parent
14624 These will assist you in lining up the two physical slides.
14627 \begin_layout Standard
14628 The major problem in overlaying two slides is aligning the contents of the
14629 two transparencies.
14630 How much space should you leave for that graph on the second slide? Worse
14631 still, what if you want a graph and a sentence on second slide, but there
14632 is text on the main transparency that goes in between them? You could try
14633 and insert vertical space of the right size.
14634 The better way is to use
14645 \begin_layout Standard
14646 As their names imply,
14654 are two command-like paragraph environments that make all subsequent text
14655 invisible and visible, respectively.
14657 \begin_inset space ~
14661 \begin_inset CommandInset ref
14663 reference "sec:slideQuirk"
14667 that you don't place anything
14671 these two environments, however.
14676 , it inserts a centered, sky-blue label into the page reading
14677 \begin_inset Quotes eld
14680 <Invisible Text Follows>
14681 \begin_inset Quotes erd
14685 For paragraphs following this label, the parts of the
14693 ; it doesn't matter which] where they would be contain instead blank space.
14697 \begin_layout Standard
14702 , the corresponding centered label is
14703 \begin_inset Quotes eld
14706 <Visible Text Follows>
14707 \begin_inset Quotes erd
14711 Paragraphs following this label behave normally.
14712 Note that the beginning of a new
14724 automatically shuts off an
14729 It's therefore not necessary to use
14740 \begin_layout Standard
14741 By now, it should be obvious how to create overlay transparencies using
14742 the proper combination of
14761 \begin_layout Enumerate
14766 , including everything that will appear on it, whether on the main slide
14774 \begin_layout Enumerate
14775 Before each figure or paragraph that will appear only on the
14784 If necessary, insert a
14788 environment after the
14795 \begin_layout Enumerate
14800 immediately following the
14807 \begin_layout Enumerate
14808 Copy the contents of this
14819 \begin_layout Enumerate
14824 , change all of the
14835 \begin_layout Standard
14837 You've just made an
14844 \begin_layout Standard
14845 There's one problem with the way I've designed the LyX
14849 class: you can't make text in the middle of a paragraph invisible, nor
14850 make text in the middle of an invisible paragraph visible again.
14851 To accomplish this feat, you'll need to use some inlined LaTeX codes.
14855 \begin_layout Plain Layout
14856 The commands of interest are:
14859 \begin_layout Itemize
14864 invisible \SpecialChar \ldots{}
14868 \begin_layout Itemize
14873 visible \SpecialChar \ldots{}
14877 \begin_layout Plain Layout
14878 \SpecialChar \ldots{}
14879 and need to be marked as TeX.
14881 \begin_inset Quotes eld
14885 \begin_inset Quotes erd
14888 you wish to change goes in between the brackets [and after the
14901 If you don't know how to mark text as TeX, see the appropriate section
14914 \begin_layout Subsubsection
14924 \begin_inset CommandInset label
14926 name "sec:slideNote"
14933 \begin_layout Standard
14942 is associated with a
14943 \begin_inset Quotes eld
14947 \begin_inset Quotes erd
14959 class provides visual cues.
14964 is shorter than that of a
14968 [yet longer than that of an
14972 ] and, like the label of an
14976 is shockingly magenta.
14977 Additionally, the printed
14981 has the page number of its
14982 \begin_inset Quotes eld
14986 \begin_inset Quotes erd
14994 \begin_inset Quotes eld
15002 \begin_inset Quotes erd
15006 \begin_inset Quotes eld
15014 \begin_inset Quotes erd
15018 \begin_inset Quotes eld
15026 \begin_inset Quotes erd
15030 You can have multiple
15034 s associated with a single
15046 , you'll probably want to break up long
15050 s so that they fit on a single sheet of paper.
15053 \begin_layout Standard
15058 is obvious: it contains anything additional you might want to say about
15064 It could also be used as a sheet of reminders for a particular
15069 In the case of the latter, you might want to make use of time markers.
15075 \begin_inset Quotes eld
15079 \begin_inset Quotes erd
15082 support for time markers, a
15087 So, you'll have to resort to using the LaTeX codes.
15090 \begin_layout Standard
15091 To use time markers, you'll need to specify the extra class option
15092 \begin_inset Quotes eld
15100 \begin_inset Quotes erd
15104 \begin_inset space ~
15108 \begin_inset CommandInset ref
15110 reference "sec:slidesetup"
15115 This option turns on timing marks, which will appear in the lower-left-hand
15121 To set what appears in the time marker, you use the LaTeX commands
15122 \begin_inset Quotes eld
15132 \begin_inset Quotes erd
15136 \begin_inset Quotes eld
15146 \begin_inset Quotes erd
15150 The arguments of both commands are time measured in seconds.
15152 \begin_inset Quotes eld
15162 \begin_inset Quotes erd
15165 sets the time marker to a given time.
15167 \begin_inset Quotes eld
15177 \begin_inset Quotes erd
15180 increments the time marker by the specified amount.
15181 Using time markers and
15185 s in this fashion, you can remind yourself how much time to spend on a particula
15193 \begin_layout Standard
15194 There's one last feature to describe.
15195 Clearly, you'd like to print out all of your
15203 s on transparencies while printing all of your
15220 with which it is associated.
15221 What's a person to do?
15224 \begin_layout Standard
15225 Luckily, there are two LaTeX commands that allow you to select what to print
15227 Both must be placed into the preamble of your document.
15229 \begin_inset Quotes eld
15241 \begin_inset Quotes erd
15244 will cause the output to contain only the
15253 Correspondingly, the command
15254 \begin_inset Quotes eld
15266 \begin_inset Quotes erd
15269 prevents the output of anything but
15274 I'd advise placing both commands in the preamble and initially comment
15276 You can then preview your entire presentation as you write.
15277 When you're done writing, you can then uncomment one of the two to select
15278 what you want to print.
15279 I like to uncomment
15280 \begin_inset Quotes eld
15292 \begin_inset Quotes erd
15295 , print to a file with
15296 \begin_inset Quotes eld
15304 \begin_inset Quotes erd
15307 in its name, comment it back out, then uncomment
15308 \begin_inset Quotes eld
15320 \begin_inset Quotes erd
15324 \begin_inset Quotes eld
15332 \begin_inset Quotes erd
15336 I can then send either file to a printer, loading transparencies or plain
15337 paper as appropriate.
15340 \begin_layout Standard
15341 You can also provide other arguments to the
15342 \begin_inset Quotes eld
15352 \begin_inset Quotes erd
15356 \begin_inset Quotes eld
15366 \begin_inset Quotes erd
15370 See a good LaTeX book for details.
15373 \begin_layout Subsection
15378 Class Template File
15381 \begin_layout Standard
15382 I have also provided a template file,
15383 \begin_inset Quotes eld
15391 \begin_inset Quotes erd
15399 To use it, begin your new presentation with
15404 ile\SpecialChar \menuseparator
15406 \begin_inset space ~
15410 \begin_inset space ~
15420 Your new LyX presentation file will contain an example
15441 additionally contain an example of the use of
15450 Lastly, the preamble will contain:
15453 \begin_layout LyX-Code
15454 % Uncomment to print out only slides and overlays
15457 \begin_layout LyX-Code
15461 \begin_layout LyX-Code
15467 \begin_inset Newline newline
15473 \begin_layout LyX-Code
15474 % Uncomment to print out only notes
15477 \begin_layout LyX-Code
15481 \begin_layout LyX-Code
15489 \begin_layout Standard
15490 One final thing: I created this class to support the LaTeX2e
15491 \begin_inset Quotes eld
15499 \begin_inset Quotes erd
15502 class, one of the built-in LaTeX2e classes.
15503 Neither I nor the rest of the LyX Team endorse or oppose the use of this
15504 built-in slide class.
15505 It's here if you want it or need it.
15506 There exist other LaTeX2e classes for creating presentations, such as the
15512 \begin_inset space ~
15516 \begin_inset CommandInset ref
15518 reference "sec:foiltex"
15523 \begin_inset Quotes eld
15531 \begin_inset Quotes erd
15534 package [present on some TeX distributions].
15535 The latter is not yet supported under LyX.
15539 \begin_layout Plain Layout
15540 Perhaps you can take on the task\SpecialChar \ldots{}
15546 I know nothing about these other classes.
15547 Try them out to see what sort of alternative they provide.
15550 \begin_layout Chapter
15551 LyX Features needing Extra Software
15554 \begin_layout Section
15558 \begin_layout Standard
15564 \begin_layout Subsection
15568 \begin_layout Standard
15577 \begin_layout Plain Layout
15582 is not yet available when you are using the LaTeX distribution MiKTeX.
15587 , you'll find in the
15594 \begin_inset space ~
15605 \begin_inset CommandInset href
15607 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
15614 \begin_layout Standard
15619 package is a program that was written by
15620 \begin_inset Flex CharStyle:Noun
15623 \begin_layout Plain Layout
15625 \begin_inset space ~
15633 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15634 and easy to forget.
15635 The program runs over your LaTeX file, checks the integrity of the file,
15636 and flags some common errors.
15637 In other technical words, it is
15644 \begin_layout Standard
15645 Well, what is a syntax checker doing in LyX which is supposed to produce
15646 correct LaTeX anyways? The answer is simple: Just as
15650 not only checks the
15654 of C programs, but also does
15658 checks for type-errors,
15662 catches some common
15666 errors, in addition to the syntactical ones.
15671 is capable of detecting several common errors, such as
15674 \begin_layout Itemize
15675 Ellipsis detection:
15676 \begin_inset Newline newline
15679 Use \SpecialChar \ldots{}
15683 \begin_layout Itemize
15684 No space in front of/after parenthesis:
15685 \begin_inset Newline newline
15691 \begin_layout Itemize
15692 Enforcement of normal space after common abbreviations:
15693 \begin_inset Newline newline
15697 \begin_inset space \thinspace{}
15701 \begin_inset space \space{}
15704 is too wide spacing.
15707 \begin_layout Itemize
15708 Enforcement of end-of-sentence space when the last sentence ends with a
15710 \begin_inset Newline newline
15714 And this is wrong spacing.
15717 \begin_layout Itemize
15718 Space in front of labels and similar commands:
15719 \begin_inset Newline newline
15722 The label should stick right up to the text to avoid falling to a wrong
15725 \begin_inset CommandInset label
15735 \begin_layout Plain Layout
15736 This footnote is in danger of falling off to a wrong page
15741 The label is separated too much.
15744 \begin_layout Itemize
15745 Space in front of references, instead of hard spaces:
15746 \begin_inset Newline newline
15749 In you are in bad luck, the text will break right between the referenced
15750 text and reference number, and that's a pity.
15752 \begin_inset CommandInset ref
15754 reference "sec:chktex"
15761 \begin_layout Itemize
15763 \begin_inset Quotes eld
15767 \begin_inset Quotes erd
15771 \begin_inset Formula $\times$
15775 \begin_inset Newline newline
15778 2x2 looks cheap compared to
15779 \begin_inset Formula $2\times2$
15785 \begin_layout Standard
15786 and more \SpecialChar \ldots{}
15787 It is an invaluable tool when you are
15788 \begin_inset Quotes eld
15792 \begin_inset Quotes erd
15795 your document before printing, and you should run it right after the obligatory
15796 spelling check, and before you go fine tuning the typesetting.
15799 \begin_layout Subsection
15803 \begin_layout Standard
15804 If you have the program installed, usage is as simple as choosing
15806 Tools\SpecialChar \menuseparator
15808 \begin_inset space ~
15814 This will make LyX generate a LaTeX file of your document, start
15818 to check it, and then make LyX insert
15819 \begin_inset Quotes eld
15823 \begin_inset Quotes erd
15826 with the warnings from
15830 , if there were any.
15831 The warnings will be placed close to the point of the mistake, and you
15832 can quickly find them by using the
15834 Navigate\SpecialChar \menuseparator
15837 menu item, or the shortcut key
15846 Open the error boxes by clicking on them with the mouse, or use the shortcut
15855 bindings, or the corresponding
15864 Read the warning and correct the mistake, if it is a mistake.
15865 If you have trouble understanding what the warning is about, you can safely
15867 Remember that there is a hidden layer between the document on screen and
15868 the technical details in invoking
15872 , and this gap can make some warnings seem arcane or just right down plain
15876 \begin_layout Standard
15877 This document is an excellent testing bed for the feature, and it should
15878 provide quite a few warnings for you to fiddle with.
15879 Since computers are only so smart, expect most of the warnings to be false
15883 \begin_layout Subsection
15884 How to fine tune it
15887 \begin_layout Standard
15888 Sometimes, you'll find that
15892 makes more noise than suits your mood.
15893 Then you can choose not to use it, wait until your mood changes, or try
15898 to get better along with you.
15899 Another choice in the most desperate situations is to use
15901 View\SpecialChar \menuseparator
15903 \begin_inset space ~
15907 \begin_inset space ~
15911 \begin_inset space ~
15916 , which will get rid of all warnings instantly.
15919 \begin_layout Standard
15928 very configurable and extensible, you shouldn't expect to solve all problems
15934 Since LyX has to generate a somewhat special LaTeX file to be able to match
15935 the line numbers from the
15943 \begin_layout Plain Layout
15944 You can inspect the specific output from
15950 Edit\SpecialChar \menuseparator
15952 \begin_inset space ~
15956 \begin_inset space ~
15970 to the internal document structure, some of the warnings will not seen
15971 to appear correctly.
15972 There are two things you can do about this:
15975 \begin_layout Itemize
15980 invocation command line in
15996 installation configuration file (usually with the file
16001 See below to learn what warnings can be enabled and disabled on the command
16006 \begin_layout Itemize
16007 Export your document as a raw LaTeX file using
16009 File\SpecialChar \menuseparator
16010 Export\SpecialChar \menuseparator
16018 Invoked in this way, it can be a hassle to find the corresponding place
16019 in the document inside LyX, but with a little patience, you should be able
16023 \begin_layout Standard
16024 Here follows the warning messages that can be enabled and disabled in
16033 to disable a warning, and
16037 to enable a warning.
16038 The emphasized entries are disabled by default, because the default is
16041 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16046 \begin_layout Standard
16047 Notice that you should only use the options that enable and disable warnings,
16048 because LyX relies on some of the other command line parameters to be set
16049 in a specific way to have a chance to communicate with
16056 \begin_layout Enumerate
16060 Command terminated with space.
16063 \begin_layout Enumerate
16066 Non-breaking space (
16067 \begin_inset Quotes eld
16075 \begin_inset Quotes erd
16078 ) should have been used.
16081 \begin_layout Enumerate
16085 You should enclose the previous parenthesis with
16086 \begin_inset Quotes eld
16094 \begin_inset Quotes erd
16100 \begin_layout Enumerate
16103 Italic correction (
16104 \begin_inset Quotes eld
16114 \begin_inset Quotes erd
16117 ) found in non-italic buffer.
16120 \begin_layout Enumerate
16123 Italic correction (
16124 \begin_inset Quotes eld
16134 \begin_inset Quotes erd
16137 ) found more than once.
16140 \begin_layout Enumerate
16144 No italic correction (
16145 \begin_inset Quotes eld
16155 \begin_inset Quotes erd
16161 \begin_layout Enumerate
16165 \begin_inset Quotes eld
16173 \begin_inset Quotes erd
16177 \begin_inset Quotes eld
16185 \begin_inset Quotes erd
16191 \begin_layout Enumerate
16194 Wrong length of dash may have been used.
16197 \begin_layout Enumerate
16201 \begin_inset Quotes eld
16209 \begin_inset Quotes erd
16213 \begin_inset Quotes eld
16221 \begin_inset Quotes erd
16227 \begin_layout Enumerate
16231 \begin_inset Quotes eld
16239 \begin_inset Quotes erd
16245 \begin_layout Enumerate
16249 \begin_inset Quotes eld
16257 \begin_inset Quotes erd
16260 to achieve an ellipsis.
16263 \begin_layout Enumerate
16266 Inter-word spacing (
16267 \begin_inset Quotes eld
16277 \begin_inset Quotes eld
16280 ) should perhaps be used.
16283 \begin_layout Enumerate
16286 Inter-sentence spacing (
16287 \begin_inset Quotes eld
16297 \begin_inset Quotes erd
16300 ) should perhaps be used.
16303 \begin_layout Enumerate
16306 Could not find argument for command.
16309 \begin_layout Enumerate
16313 \begin_inset Quotes eld
16321 \begin_inset Quotes erd
16327 \begin_layout Enumerate
16330 Math mode still on at end of LaTeX file.
16333 \begin_layout Enumerate
16337 \begin_inset Quotes eld
16345 \begin_inset Quotes erd
16348 doesn't match the number of
16349 \begin_inset Quotes eld
16357 \begin_inset Quotes erd
16363 \begin_layout Enumerate
16366 You should use either
16369 \begin_inset Quotes eld
16377 \begin_inset Quotes erd
16382 as an alternative to
16383 \begin_inset Quotes eld
16391 \begin_inset Quotes erd
16397 \begin_layout Enumerate
16404 " (ASCII 39) instead of "
16411 \begin_layout Enumerate
16414 User-specified pattern found.
16417 \begin_layout Enumerate
16420 This command might not be intended.
16423 \begin_layout Enumerate
16430 \begin_layout Enumerate
16448 \begin_layout Enumerate
16451 Delete this space to maintain correct page references.
16454 \begin_layout Enumerate
16458 You might wish to put this between a pair of
16459 \begin_inset Quotes eld
16467 \begin_inset Quotes erd
16473 \begin_layout Enumerate
16476 You ought to remove spaces in front of punctuation.
16479 \begin_layout Enumerate
16482 Could not execute LaTeX command.
16485 \begin_layout Enumerate
16494 in front of small punctuation.
16497 \begin_layout Enumerate
16505 may look prettier here.
16508 \begin_layout Enumerate
16512 Multiple spaces detected in output.
16515 \begin_layout Enumerate
16518 This text may be ignored.
16521 \begin_layout Enumerate
16527 \begin_inset Quotes eld
16532 to begin quotation, not
16539 \begin_layout Enumerate
16546 to end quotation, not
16549 \begin_inset Quotes eld
16557 \begin_layout Enumerate
16563 \begin_layout Enumerate
16566 You should perhaps use
16567 \begin_inset Quotes eld
16575 \begin_inset Quotes erd
16581 \begin_layout Enumerate
16584 You should put a space in front of/after parenthesis.
16587 \begin_layout Enumerate
16590 You should avoid spaces in front of/after parenthesis.
16593 \begin_layout Enumerate
16597 You should not use punctuation in front of/after quotes.
16600 \begin_layout Enumerate
16603 Double space found.
16606 \begin_layout Enumerate
16609 You should put punctuation outside inner/inside display math mode.
16612 \begin_layout Enumerate
16615 You ought to not use primitive TeX in LaTeX code.
16618 \begin_layout Enumerate
16621 You should remove spaces in front of
16622 \begin_inset Quotes eld
16630 \begin_inset Quotes erd
16636 \begin_layout Enumerate
16639 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16650 is normally not followed by
16651 \begin_inset Quotes eld
16659 \begin_inset Quotes erd
16665 \begin_layout Standard
16666 In later versions of LyX, we hope to provide a more complete interface to
16667 this tool (and it's smaller cousin
16671 ) to exploit the full power of it.
16672 But it's not exactly useless as it is now: go try it on one of your existing
16673 documents of a certain length and be surprised.
16676 \begin_layout Section
16677 Version Control in LyX
16680 \begin_layout Standard
16683 Lars Gullik Bjønnes,
16690 \begin_layout Subsection
16694 \begin_layout Standard
16695 A friend of mine wanted to try LyX for a group project.
16696 When he didn't find support for version control or file locking, he dropped
16698 This angered me a bit, so I thought that I should at least make support
16699 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16700 This has now been done.
16701 LyX now supports some of the most basic RCS commands.
16702 If you need to something a bit more sophisticated you will have to do that
16703 manually in an xterm.
16706 \begin_layout Standard
16707 Before you begin to use the version control features in LyX, you should
16709 \begin_inset Quotes eld
16713 \begin_inset Quotes erd
16716 (a man file, read it with
16721 This file describes all the basic features of RCS.
16722 You should especially notice the comment about a RCS directory, and the
16723 notion of a master RCS file (the file ending in
16730 \begin_layout Standard
16731 Later basic CVS/SVN support was added.
16732 You should be familiar with CVS/SVN usage before start using it under LyX.
16733 Most of the log messages are not currently displayed after operations -
16734 you can check them in terminal window if unsure.
16737 \begin_layout Standard
16738 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
16739 package—no guarantees are made for older versions.
16742 \begin_layout Standard
16743 For introducing your own external commands consult vc-command in the manual
16747 \begin_layout Subsection
16748 RCS commands in LyX
16751 \begin_layout Standard
16752 The following sections describe the RCS commands supported by LyX.
16753 You can find them in the
16755 File\SpecialChar \menuseparator
16757 \begin_inset space ~
16763 LyX was tested against RCS 5.7.
16766 \begin_layout Subsubsection
16772 \begin_layout Standard
16773 If your document is not under revision control, this is the only item shown
16775 And if it is under revision control, the
16779 item is not visible.
16783 \begin_layout Standard
16784 This command registers your document with RCS (unless you are under the
16785 directory managed by CVS)\SpecialChar \@.
16786 You are asked interactively to supply an initial
16787 description of the document.
16788 The document is now set in Read-Only mode and you have to
16791 \begin_inset space ~
16795 \begin_inset space ~
16799 \begin_inset space ~
16804 , before making any changes to it.
16805 A document under revision control has a
16806 \begin_inset Quotes eld
16809 [RCS:<version> <locker>]
16810 \begin_inset Quotes erd
16813 item tagged to the filename in the minibuffer.
16816 \begin_layout Standard
16817 RCS command that is run:
16819 ci -q -u -i -t-"<initial description>" <file-name>
16822 \begin_layout Standard
16827 to understand the switches.
16831 \begin_layout Subsubsection
16837 \begin_layout Standard
16838 When you are finished editing a file, you check in your changes.
16839 When you do this, you are asked for a description of the changes.
16840 This is stored in the history log.
16841 The version number is bumped, your changes are applied to the master RCS
16842 file, the document is unlocked and set to Read-Only mode.
16846 \begin_layout Standard
16849 ci -q -u -m"<description>" <file-name>
16852 \begin_layout Subsubsection
16858 \begin_layout Standard
16859 By doing this you lock the document so that only you can edit it.
16860 This will also make the document Read-Write only for you.
16861 You will usually continue editing for a while and when you are finished
16862 you check in your changes.
16863 The status line is changed to reflect that you have locked the file.
16867 \begin_layout Standard
16870 co -q -l <file-name>
16873 \begin_layout Subsubsection
16876 Revert To Repository Version
16879 \begin_layout Standard
16880 This will discard all changes made to the document since the last check
16882 You get a warning before changes are discarded.
16885 \begin_layout Standard
16888 co -f -u<version> <file-name>
16891 \begin_layout Subsubsection
16897 \begin_layout Standard
16898 This makes as if the last check in never happened.
16899 No changes are made to the document loaded into LyX, but the last version
16900 is removed from the master RCS file.
16904 \begin_layout Standard
16907 rcs -o<version> <file-name>
16910 \begin_layout Subsubsection
16916 \begin_layout Standard
16917 This show the complete history of the RCS document.
16922 is shown in a browser.
16930 \begin_layout Subsection
16931 CVS commands in LyX
16934 \begin_layout Standard
16935 CVS is now partially supported by LyX.
16936 You can find the commands in the
16938 File\SpecialChar \menuseparator
16940 \begin_inset space ~
16948 \begin_layout Subsubsection
16954 \begin_layout Standard
16955 If your document is not under revision control, this is the only item shown
16957 And if it is under revision control, the
16964 item is not visible.
16968 \begin_layout Standard
16969 This command registers in CVS your document ONLY in case you have already
16970 the documents directory under CVS control (in particular
16975 This means you have to checkout the archive by yourself.
16979 \begin_layout Standard
16980 Then you are asked interactively to supply an initial description of the
16982 Don't forget that registered file is not yet commited.
16985 \begin_layout Standard
16986 CVS command that is run:
16989 \begin_inset Quotes erd
16993 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17003 \begin_layout Standard
17008 to understand the switches.
17012 \begin_layout Subsubsection
17018 \begin_layout Standard
17019 When you are finished editing a file, you commit your changes.
17020 When you do this, you are asked for a description of the changes.
17021 After that changes are commited.
17024 \begin_layout Standard
17027 cvs -q commit -m"<description>" "<file-name>"
17030 \begin_layout Subsubsection
17033 Revert To Repository Version
17036 \begin_layout Standard
17037 This will discard all changes made to the document since the last check
17039 You get a warning before changes are discarded.
17040 Firstly the file is deleted, secondly CVS update command is run.
17043 \begin_layout Standard
17047 \begin_inset Quotes eld
17051 \begin_inset Quotes erd
17057 \begin_layout Subsubsection
17063 \begin_layout Standard
17064 This show the complete history of the CVS document.
17068 \begin_inset Quotes eld
17072 \begin_inset Quotes erd
17077 is shown in a browser.
17080 \begin_layout Subsection
17081 SVN commands in LyX
17084 \begin_layout Standard
17085 SVN is now partially supported by LyX.
17086 You can find the commands in the
17088 File\SpecialChar \menuseparator
17090 \begin_inset space ~
17096 Please note that if you use password protected access to repository via
17097 ssh, you will be asked in terminal window.
17098 LyX was tested against SVN 1.4 and 1.5.
17101 \begin_layout Subsubsection
17107 \begin_layout Standard
17108 If your document is not under revision control, this is the only item shown
17110 And if it is under revision control, the
17117 item is not visible.
17121 \begin_layout Standard
17122 This command registers in SVN your document ONLY in case you have already
17123 the documents directory under SVN control (in particular
17128 This means you have to checkout the archive by yourself.
17132 \begin_layout Standard
17133 Then you are asked interactively to supply an initial description of the
17135 Don't forget that registered file is not yet commited.
17138 \begin_layout Standard
17139 SVN command that is run:
17142 \begin_inset Quotes eld
17146 \begin_inset Quotes erd
17152 \begin_layout Standard
17157 to understand the switches.
17161 \begin_layout Subsubsection
17167 \begin_layout Standard
17168 When you are finished editing a file, you commit your changes.
17169 When you do this, you are asked for a description of the changes.
17170 After that changes are commited.
17173 \begin_layout Standard
17178 \begin_layout Plain Layout
17179 In case locking is not enabled.
17181 \begin_inset CommandInset ref
17183 reference "subsec:SVN-File-Locking"
17194 svn commit -q -m"<description>" <file-name>
17197 \begin_layout Subsubsection
17203 \begin_layout Standard
17204 Updates the changes of this file from the repository.
17205 Be sure you understand SVN merging and conflicts resolving before using
17206 this function, because all conflicts has to be done manually by you!
17209 \begin_layout Standard
17214 \begin_layout Plain Layout
17223 \begin_inset Quotes eld
17227 \begin_inset Quotes erd
17233 \begin_layout Subsubsection
17236 Revert To Repository Version
17239 \begin_layout Standard
17240 This will discard all changes made to the document since the last check
17242 You get a warning before changes are discarded.
17246 \begin_layout Standard
17250 \begin_inset Quotes eld
17254 \begin_inset Quotes erd
17260 \begin_layout Subsubsection
17266 \begin_layout Standard
17267 This show the complete history of the SVN document.
17271 \begin_inset Quotes eld
17275 \begin_inset Quotes erd
17280 is shown in a browser.
17283 \begin_layout Subsubsection
17285 \begin_inset CommandInset label
17287 name "subsec:SVN-File-Locking"
17294 \begin_layout Standard
17295 The file exchange through various revision control systems brings the problem
17296 of merge conflicts in case two different users try to edit the same (parts
17298 When such conflict happens it needs manual resolving and one reasonable
17299 alternative is to provide some kind of locking mechanism, which guarantees
17300 that only one user is allowed to edit file at the given time.
17303 \begin_layout Standard
17304 SVN has two mechanisms to provide such kind of mutual exclusivity for file
17305 access - locks and automatical setting of write permissions based on
17306 \begin_inset Flex CharStyle:Code
17309 \begin_layout Plain Layout
17319 \begin_layout Plain Layout
17320 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
17326 In a case this property is detected for a given document LyX starts to
17327 use SVN locks for document editing automatically and the whole check-in/out
17328 mechanism switches to the same regimen as for RCS.
17329 This in particular means there are two different modes how file is used
17333 \begin_layout Itemize
17335 The loaded file is in the read-only mode.
17336 For editation on needs to check-out.
17341 consists of update from repository and gaining write lock.
17342 If the lock is not possible to obtain, we remain in unlocked state.
17345 \begin_layout Itemize
17347 The loaded file is in the 'normal' edit mode.
17348 No other user is allowed to edit the file.
17353 consists of commiting changes and releasing write-lock.
17354 If no changes have been made to the document, no commit will be produced
17358 \begin_layout Plain Layout
17359 Don't be puzzled by the fact that you will be asked for commit message anyway.
17364 and only the write-lock will be released.
17367 \begin_layout Standard
17371 \begin_layout Labeling
17372 \labelwidthstring 00.00.0000
17375 svn commit -q -m"<description>" "<file-name>"
17376 \begin_inset Newline newline
17379 svn unlock "<file-name>"
17382 \begin_layout Labeling
17383 \labelwidthstring 00.00.0000
17386 svn update "<file-name>"
17387 \begin_inset Newline newline
17390 svn lock "<file-name>"
17393 \begin_layout Subsection
17394 SVN and Windows Environment
17397 \begin_layout Quote
17398 My inclination is to say that if the user cannot figure out the command
17399 line operations on their own fairly quickly, they would be well advised
17400 to use TortoiseSVN.
17406 \begin_layout Subsubsection
17410 \begin_layout Standard
17411 In addition to installing LyX, and having access to a Subversion repository,
17412 the user will need to install the Subversion client program.
17413 A Windows installer for the client program is available from
17414 \begin_inset CommandInset href
17417 target "http://www.collab.net/nonav/downloads/subversion/"
17422 The user may also want to install
17423 \begin_inset CommandInset href
17426 target "http://tortoisesvn.tigris.org/"
17430 , which integrates Subversion operations into the context (rightclick) menu
17431 of Windows Explorer.
17432 Operations done outside LyX will typically be more convenient using the
17433 Explorer context menu.
17434 Note that TortoiseSVN is not a replacement for the client program, which
17435 is what LyX itself will use.
17438 \begin_layout Subsubsection
17439 Bringing a document under Subversion control
17442 \begin_layout Standard
17443 Before a LyX document can be brought under version control in Subversion,
17444 its parent directory needs to be under version control.
17445 If the document is being added to a project already in the repository,
17446 this is accomplished by checking the project out to the directory where
17447 the new document will be placed.
17448 If the project itself is not yet under version control (for instance, if
17449 this document starts a new project), the directory must be imported into
17451 This is done outside LyX.
17452 Both import and checkout are easily accomplished from the Explorer context
17453 menu using TortoiseSVN, or alternatively can be done using the command
17454 line client at a DOS prompt.
17455 The procedure for importing the project using TortoiseSVN is described
17456 below, assuming an existing repository and a new project being started
17464 For information on using the Subversion client program, run
17471 \begin_layout Enumerate
17478 in Windows Explorer, right click it, and select
17480 TortoiseSVN > Repo-browser
17483 If necessary, adjust the URL for the repository, then click OK.
17486 \begin_layout Enumerate
17487 Right click the level of the repository under which you want to place the
17488 new project folder (typically the top level) and click
17490 Create folder\SpecialChar \ldots{}
17493 Supply a name for the project folder and click OK.
17494 Add a message for the log file if desired, then click OK again.
17495 The new project folder should appear in the repository.
17496 Finally, click OK again to exit the repository browser.
17499 \begin_layout Enumerate
17500 Once again right click
17506 , this time selecting SVN Checkout\SpecialChar \ldots{}
17507 Select the URL of the project folder
17508 you just created in the repository, and set the checkout directory to
17516 You will be warned about a non-empty folder; click OK to proceed.
17517 You should now have a
17528 \begin_layout Enumerate
17529 Create or open your document in LyX and click
17534 ile\SpecialChar \menuseparator
17540 \begin_inset space ~
17543 Control\SpecialChar \menuseparator
17551 Add a log message and click OK to commit the document to version control.
17554 \begin_layout Standard
17555 From this point onward, you should have full functionality in the
17560 ile\SpecialChar \menuseparator
17566 \begin_inset space ~
17572 You also have the option of checking the document in and out, viewing its
17574 using the TortoiseSVN context menu in Windows Explorer or the Subversion
17575 client program from a command prompt.
17578 \begin_layout Subsection
17582 \begin_layout Standard
17583 With the recent addition of the vc-command function LyX power users are
17584 allowed to create their own commands for revision control.
17587 \begin_layout Standard
17588 As an example you can see how two TortoiseSVN commands could be integrated
17592 \begin_layout Description
17594 \begin_inset Flex CharStyle:Code
17597 \begin_layout Plain Layout
17598 vc-command DS "." "TortoiseProc /command:commit /path:$$p"
17606 \begin_layout Description
17608 \begin_inset Flex CharStyle:Code
17611 \begin_layout Plain Layout
17612 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
17620 \begin_layout Section
17621 Literate Programming
17624 \begin_layout Standard
17629 (kayvan@sylvan.com)
17633 original documentation written by
17635 Edmar Wienskoski Jr.
17638 (edmar-w-jr@technologist.com)
17641 \begin_layout Subsection
17645 \begin_layout Standard
17646 The main purpose of this documentation is to show you how to use LyX for
17647 literate programming.
17648 Where it is assumed that you are familiar with this programming technique,
17650 \begin_inset Quotes eld
17654 \begin_inset Quotes erd
17658 \begin_inset Quotes eld
17662 \begin_inset Quotes erd
17666 If that is not the case, please follow the web links provided in the following
17668 There is a lot of good documentation out there covering old development
17669 history to the latest tools tips.
17672 \begin_layout Standard
17673 It is also assumed that you are familiar with LyX itself to a point that
17674 you are comfortable changing your LyX preferences, and X resources file.
17675 If that is not the case please refer to other LyX documentation to cover
17676 your specific needs.
17679 \begin_layout Subsection
17680 Literate Programming
17683 \begin_layout Standard
17684 From the Literate Programming FAQ:
17687 \begin_layout Quotation
17688 Literate programming is the combination of documentation and source together
17689 in a fashion suited for reading by human beings.
17690 In fact, literate programs should be enjoyable reading, even inviting!
17691 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17692 and documentation in a single file.
17693 Literate programming tools then parse the file to produce either readable
17694 documentation or compilable source.
17695 The WEB style of literate programming was created by D.
17696 \begin_inset space \thinspace{}
17700 Knuth during the development of his TeX typesetting software.
17704 \begin_layout Standard
17705 Another excerpt says:
17708 \begin_layout Quotation
17711 How is literate programming different from verbose commenting?
17714 \begin_layout Quotation
17715 There are three distinguishing characteristics.
17716 In order of importance, they are:
17720 \begin_layout Itemize
17721 flexible order of elaboration
17724 \begin_layout Itemize
17725 automatic support for browsing
17728 \begin_layout Itemize
17729 typeset documentation, especially diagrams and mathematics
17733 \begin_layout Standard
17734 Now that I sparked your curiosity, take a look in the references.
17737 \begin_layout Subsubsection
17741 \begin_layout Standard
17742 The complete Literate Programming FAQ can be found at:
17745 \begin_layout Quote
17746 Literate Programming FAQ
17747 \begin_inset Flex URL
17750 \begin_layout Plain Layout
17752 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
17760 \begin_layout Standard
17761 The FAQ lists 23 (twenty three!) different literate programming tools.
17762 Where some are specialized or
17763 \begin_inset Quotes eld
17767 \begin_inset Quotes erd
17770 for particular programming languages, while other have general scope.
17775 for my own use for several reasons:
17778 \begin_layout Itemize
17779 It can generate the documentation either in LaTeX or HTML.
17782 \begin_layout Itemize
17783 It has a open architecture, i.
17784 \begin_inset space \thinspace{}
17788 \begin_inset space \space{}
17791 it is easy to plug in new filters and to perform special processing that
17796 \begin_layout Itemize
17797 There is a good selection of filters available already (the HTML is one
17801 \begin_layout Itemize
17805 \begin_layout Standard
17806 The Noweb web page can be found at:
17809 \begin_layout Quote
17811 \begin_inset Flex URL
17814 \begin_layout Plain Layout
17816 http://www.cs.virginia.edu/~nr/noweb/
17824 \begin_layout Standard
17825 Starting from there you can reach many other interesting links and even
17826 some literate program examples.
17829 \begin_layout Subsection
17830 LyX and Literate Programming
17833 \begin_layout Standard
17834 The LyX support for Literate Programming is provided by using the generic
17835 LyX converters mechanism.
17836 This support is provided in a
17837 \begin_inset Quotes eld
17841 \begin_inset Quotes erd
17845 \begin_inset space \thinspace{}
17849 \begin_inset space \space{}
17852 you will be able to use this new LyX feature with some other literate programmin
17853 g tool of your choice by just changing your LyX preferences.
17856 \begin_layout Subsubsection
17857 Generating documents and code (weaving and tangling)
17860 \begin_layout Paragraph
17861 Selecting the document class
17864 \begin_layout Standard
17865 If you have installed Noweb and LyX successfully, whenever you open a new
17866 document or try to change the document class of an existing one, you will
17867 find that there are three new document classes available:
17870 \begin_layout Itemize
17874 \begin_layout Itemize
17878 \begin_layout Itemize
17882 \begin_layout Standard
17883 You must select one of them to create your literate documents from.
17887 \begin_layout Standard
17888 Note that literate documents are not limited to these three classes.
17889 New classes can be generated from other styles like letter or in combination
17890 with other class variations like Article (AMS).
17891 If you have special needs that cannot be covered by one of the existing
17892 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17893 will arrange to insert a new entry, or teach you how to do it.
17897 \begin_layout Plain Layout
17898 It is very simple, it involves the creation of a file with four lines, and
17899 re-running of the auto configuration.
17904 Moreover, if you use a literate tool other than Noweb you may need to create
17905 a new set of document classes for it.
17908 \begin_layout Paragraph
17912 \begin_layout Standard
17913 LyX enables you to write code with a layout named
17921 \begin_layout Plain Layout
17922 The equivalent Noweb term is
17923 \begin_inset Quotes eld
17927 \begin_inset Quotes erd
17931 For historical reasons, I got used to the term
17932 \begin_inset Quotes eld
17936 \begin_inset Quotes erd
17939 introduced by other literate tool named Nuweb, which I used for many years
17940 before rendering myself to Noweb.
17945 Noweb delimits scraps like this:
17948 \begin_layout LyX-Code
17952 \begin_layout LyX-Code
17956 \begin_layout LyX-Code
17960 \begin_layout LyX-Code
17964 \begin_layout LyX-Code
17968 \begin_layout Standard
17969 The problem is that whatever is written in between the << and the
17973 must be taken literally, i.
17974 \begin_inset space \thinspace{}
17978 \begin_inset space \space{}
17981 LyX should be prevented from making any special interpretation of what has
17983 This is handled by a special layout named Scrap, that works like a normal
17984 paragraph but has a free spacing capability.
17987 \begin_layout Standard
17988 The down side of the Scrap paragraph layout is that consecutive paragraphs
17989 of code will be spaced with one empty line in the source code and also
17990 in the printed documentation.
17991 The work around is to enter each line of code within a single Scrap, with
17992 a newline (ctrl-return).
17993 The example above will look like this:
17997 \begin_layout Plain Layout
17998 If you have a printed version of this document you will not see any difference
17999 between the previous example and this one.
18007 \begin_layout LyX-Code
18009 \begin_inset Newline newline
18013 \begin_inset Newline newline
18017 \begin_inset Newline newline
18021 \begin_inset Newline newline
18027 \begin_layout Standard
18028 This layout works fine.
18029 The only real inconvenience is that you have to type ctrl-return instead
18034 \begin_layout Plain Layout
18035 It is in my list of
18036 \begin_inset Quotes eld
18040 \begin_inset Quotes erd
18051 \begin_layout Standard
18052 As a special note, you can also use the
18053 \begin_inset Quotes eld
18057 \begin_inset Quotes erd
18060 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
18064 \begin_layout LyX-Code
18066 \begin_inset Newline newline
18069 def some_function(args):
18070 \begin_inset Newline newline
18073 "This is the doc string for this function."
18074 \begin_inset Newline newline
18077 print "My args: ", args
18080 \begin_layout LyX-Code
18081 @ %def some_function
18084 \begin_layout Standard
18085 For an example of this usage and the resulting cross-reference output, look
18086 at the Literate python program in
18088 LIBDIR/examples/listerrors.lyx
18090 which should make this all clear.
18093 \begin_layout Paragraph
18094 Generating the documentation
18097 \begin_layout Standard
18098 At this point you already have a new document file with a proper document
18099 class, and with some code and text on it.
18100 How do I print it? The answer is simple, you select
18102 View\SpecialChar \menuseparator
18106 Just like you would do for a plain document.
18107 No special procedure is required.
18110 \begin_layout Standard
18111 To help orientate you, I will now explain what happens inside LyX:
18114 \begin_layout Enumerate
18117 Update\SpecialChar \menuseparator
18120 menu option is chosen, a LaTeX file is generated.
18125 \begin_layout Standard
18126 If the document is of any literate class the generated file will be named
18127 with an extension name defined by the
18128 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 format (defined in the Preferences panel), otherwise the file will have
18144 \begin_layout Enumerate
18145 Note that the only difference so far is in the name of the file, no special
18146 processing is required by LyX.
18147 Given that you formatted the code using the Scrap layout that, by itself,
18148 takes care of the business.
18151 \begin_layout Enumerate
18152 If the document is of any literate class LyX will then use the internal
18153 LyX to Noweb converter, followed by the Noweb to LaTeX converter
18157 \begin_layout Plain Layout
18158 The converters are defined in the
18160 Tools\SpecialChar \menuseparator
18164 \begin_inset Quotes eld
18168 \begin_inset Quotes erd
18180 manual for general information about converters.
18185 to generate the LaTeX file.
18189 \begin_layout Standard
18190 Otherwise it will just skip this step.
18194 \begin_layout Enumerate
18195 Finally, LaTeX is invoked and the regular post processing continues as in
18199 \begin_layout Standard
18200 Independence from a particular
18201 \begin_inset Quotes eld
18205 \begin_inset Quotes erd
18208 is easily achieved by changing the commands that are run by the various
18212 \begin_layout Paragraph
18213 Generating the code
18216 \begin_layout Standard
18217 When the build menu option is chosen or the corresponding button in the
18218 toolbar is pressed, a LaTeX file is generated just like step 1 above.
18219 Next, LyX invokes the
18224 This converter needs to be defined by the user and is not installed by
18225 default, though the Program format is.
18226 This converter (like any other converter) will have two parts:
18229 \begin_layout Enumerate
18230 The converter program itself.
18231 This program performs the conversion from the one format to the other (in
18232 this case, from the Noweb format to the Program pseudo-format).
18235 \begin_layout Enumerate
18236 The error log parser.
18237 This is a program whose sole purpose is to rewrite error messages in a
18238 format that LyX understands.
18239 This makes it possible for LyX to place error boxes in the right places
18240 in the file buffer.
18243 \begin_layout Standard
18244 The first part, the
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18252 setting, should be set to
18253 \begin_inset Quotes eld
18261 \begin_inset Quotes erd
18265 This basically means that LyX will call
18266 \begin_inset Quotes eld
18270 \begin_inset Quotes erd
18273 (a program or script) with the name of the Noweb file (normally a file
18274 in the LyX temp directory).
18278 \begin_layout Standard
18279 This is an implementation of
18280 \begin_inset Quotes eld
18284 \begin_inset Quotes erd
18287 that you can place in a directory on your path:
18290 \begin_layout LyX-Code
18294 \begin_layout LyX-Code
18298 \begin_layout LyX-Code
18299 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18302 \begin_layout Standard
18303 The next part of the converter setting is the
18304 \begin_inset Quotes eld
18308 \begin_inset Quotes erd
18311 which is to be set to
18312 \begin_inset Quotes eld
18317 parselog=listerrors
18320 \begin_inset Quotes erd
18324 This will run any errors that are generated by the
18325 \begin_inset Quotes eld
18329 \begin_inset Quotes erd
18332 process through the
18333 \begin_inset Quotes eld
18337 \begin_inset Quotes erd
18343 \begin_layout Standard
18344 The converter code looks in
18352 then on the path for the
18353 \begin_inset Quotes eld
18357 \begin_inset Quotes erd
18363 \begin_layout Standard
18364 The build will normally take place in LyX's temporary directory, so the
18365 files produced by the conversion will be in that directory.
18366 LyX will copy out what it regards as the `main' file, but the
18370 conversion may produce several files, and so most of these would then be
18371 deleted when LyX was closed.
18372 The present solution is to use a `copier',
18376 \begin_layout Plain Layout
18385 manual for information on these.
18394 script in its default mode, so that the entire contents of the temporary
18395 directory is copied.
18396 More will get copied than is needed, to be sure, but nothing will be lost.
18397 If, however, you know what extensions the generated files will have, this
18398 can be improved by using the
18407 This option takes a comma-separated list of extensions to copy.
18408 So, for example, if the conversion will generate only files with the extensions
18417 , then the correct definition would be:
18420 \begin_layout LyX-Code
18421 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18424 \begin_layout Standard
18425 The result will be that only files with these two extensions will be copied
18429 \begin_layout Paragraph
18430 Build instructions in the document
18433 \begin_layout Standard
18434 The last piece of the integration between LyX and noweb is the
18435 \begin_inset Quotes eld
18439 \begin_inset Quotes erd
18443 Generally, the instructions for building your program should be embedded
18444 in a scrap of its own.
18446 \begin_inset Quotes eld
18450 \begin_inset Quotes erd
18453 above uses the notangle command to look for this scrap (called
18454 \begin_inset Quotes eld
18458 \begin_inset Quotes erd
18461 ) and runs its contents through
18462 \begin_inset Quotes eld
18466 \begin_inset Quotes erd
18472 \begin_layout Standard
18473 Typically, such a scrap would look something like this:
18476 \begin_layout LyX-Code
18478 \begin_inset Newline newline
18482 \begin_inset Newline newline
18486 \begin_inset Newline newline
18489 if [ -z "${NOWEB_SOURCE}" ]
18490 \begin_inset Newline newline
18494 \begin_inset Newline newline
18497 NOWEB_SOURCE=myfile.nw
18498 \begin_inset Newline newline
18502 \begin_inset Newline newline
18506 code to extract files ...]
18507 \begin_inset Newline newline
18511 code to compile files ...]
18512 \begin_inset Newline newline
18518 \begin_layout Standard
18521 LIBDIR/examples/listerrors.lyx
18525 LIBDIR/examples/Literate.lyx
18527 which implement two versions of the
18528 \begin_inset Quotes eld
18532 \begin_inset Quotes erd
18535 program for some illustrations of how all of these pieces go together or
18538 LIBDIR/examples/noweb2lyx.lyx.
18541 Interestingly, these three files show off the language-indepence of the
18542 LyX literate programming support since they are written in Python, C and
18546 \begin_layout Subsubsection
18550 \begin_layout Standard
18551 All the Literate Programming support is configured by the
18553 Tools\SpecialChar \menuseparator
18557 \begin_inset Quotes eld
18561 \begin_inset Quotes erd
18565 The important parts are:
18568 \begin_layout Description
18570 \begin_inset space ~
18574 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18582 \begin_inset space ~
18585 format Set up via the Formats tab, this is where the Noweb-specific pieces
18595 , the file extension is set to
18600 This tells LyX to create a file with a
18604 extension in the first step of the conversion process.
18607 \begin_layout Description
18609 \begin_inset space ~
18617 \begin_inset space ~
18620 format This is an empty format whose sole purpose is to be the endpoint
18621 of a conversion (which then allows us to set up a converter for it).
18624 \begin_layout Description
18633 This converter performs the
18634 \begin_inset Quotes eld
18638 \begin_inset Quotes erd
18641 of the literate document.
18642 For Noweb, it is set to
18643 \begin_inset Quotes eld
18648 noweave -delay -index $$i > $$o
18651 \begin_inset Quotes erd
18657 \begin_layout Description
18667 \begin_inset Quotes eld
18671 \begin_inset Quotes erd
18675 As stated above, the Converter is set to
18676 \begin_inset Quotes eld
18684 \begin_inset Quotes erd
18687 , with Flags set to
18688 \begin_inset Quotes eld
18693 originaldir,parselog=listerrors
18696 \begin_inset Quotes erd
18702 \begin_layout Subsubsection
18706 \begin_layout Standard
18707 There is also a new function implemented in the LyX server, the
18708 \begin_inset Quotes eld
18711 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18715 \begin_layout Standard
18716 When debugging code with ddd/gdb, it is possible to invoke a text editor
18717 at the current execution position with a single key stroke.
18718 The default ddd configuration for that is shift-ctrl-V.
18719 It happens that you can define the editor command line invocation in ddd
18722 Edit\SpecialChar \menuseparator
18723 Preferences\SpecialChar \menuseparator
18726 dialog and changing the "Edit Sources" entry.
18729 \begin_layout Standard
18730 I take advantage of the new created LyX server function and this ddd feature,
18732 \begin_inset Quotes eld
18736 \begin_inset Quotes erd
18742 \begin_layout LyX-Code
18743 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18746 \begin_layout Standard
18747 With this, whenever you are using ddd and find a point in the program that
18748 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18749 ddd you forward this information to LyX through the LyX server and then
18750 the LyX window will show the same file with the cursor at the same position
18751 ddd was pointing to.
18752 No more guessing or long scrolling to locate a point in the program back
18756 \begin_layout Standard
18757 Note however that you must enable the LyX server to get this feature working
18758 (it is disabled by default).
18759 You can enable it in
18771 ) by entering in the
18776 \begin_inset Quotes eld
18781 /home/<your-home-directory>/.lyx/lyxpipe
18784 \begin_inset Quotes erd
18790 \begin_layout Standard
18791 Read the LyX server documentation in the
18793 Customization Manual
18795 for further information.
18798 \begin_layout Subsubsection
18802 \begin_layout Standard
18803 There are six new buttons that can be added to your LyX toolbar.
18804 Five of these buttons are short cuts to layout styles:
18825 The last one is a short cut to the
18826 \begin_inset Quotes eld
18830 \begin_inset Quotes erd
18837 \begin_layout Standard
18838 LyX has a range of buttons that are available for tool bar customization.
18839 In my toolbar I like to combine the six short cuts above with two more:
18844 \SpecialChar \menuseparator
18849 \SpecialChar \menuseparator
18856 View\SpecialChar \menuseparator
18860 Here is how it looks like:
18863 \begin_layout LyX-Code
18867 \begin_layout LyX-Code
18871 \begin_layout LyX-Code
18872 Icon "layout Standard"
18875 \begin_layout LyX-Code
18876 Icon "layout Section"
18879 \begin_layout LyX-Code
18880 Icon "layout LaTeX"
18883 \begin_layout LyX-Code
18884 Icon "layout LyX-Code"
18887 \begin_layout LyX-Code
18888 Icon "layout Scrap"
18891 \begin_layout LyX-Code
18895 \begin_layout LyX-Code
18899 \begin_layout LyX-Code
18900 Icon "buffer-typeset"
18903 \begin_layout LyX-Code
18904 Icon "build-program"
18907 \begin_layout LyX-Code
18911 \begin_layout LyX-Code
18915 \begin_layout LyX-Code
18919 \begin_layout LyX-Code
18923 \begin_layout LyX-Code
18927 \begin_layout Subsubsection
18928 Colors customization
18931 \begin_layout Standard
18932 There are a number of colors in LyX that can be customized in
18937 One of the things that bothers people is the LaTeX font color.
18938 The default color is red, since the scraps uses LaTeX font, and there is
18939 a lot of scraps in literate documents, you may get tired of seeing everything
18941 You can change it by going to the tabs
18950 \begin_layout Standard
18951 The next thing is the visible presence of the newline character in the screen.
18952 You can choose the color of this particular character and make it blend
18954 I recommend you choosing a color that is close to the background but not
18955 equal, that way you still can see it is there, but it is not bothering
18960 \begin_layout Chapter
18961 Secrets of the LaTeX Masters
18962 \begin_inset CommandInset label
18971 \begin_layout Standard
18972 Though LyX is a powerful tool, it cannot hope to support everything that
18973 can be done with pure TeX/LaTeX.
18974 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18975 as long as you are not afraid to use that
18976 \begin_inset Quotes eld
18980 \begin_inset Quotes erd
18983 button on the toolbar or add things to the LaTeX preamble.
18984 This section lists some tips, tricks, and otherwise cool ideas to give
18985 your document that extra little flair.
18988 Do try this at home
18990 , just start with something a little smaller and less important than your
18994 \begin_layout Standard
18995 Most ideas in this section require less common files in your LaTeX installation.
18996 If you have a system like teTeX, most will already be available.
18997 A few, however, will need to be downloaded from one of the CTAN archives.
18998 Often, there are several ways to do something, or several LaTeX style files
18999 which do the same thing.
19000 We do not endorse one choice over another, we simply claim that we have
19001 done a particular task with a particular file.
19002 Put on your wizard hat, keep an eye out for dragons, and let us begin.
19005 \begin_layout Section
19009 \begin_layout Standard
19012 Lars Gullik Bjønnes
19015 \begin_layout Subsection
19019 \begin_layout Standard
19020 The aim for this chapter
19024 \begin_layout Plain Layout
19025 Editor's note: Lars' original chapter was a masterful description of how
19031 However, it was too long to flow smoothly in this document.
19032 I have therefore chosen to excerpt the most important sections here (sorry,
19033 Lars); you can read the original chapter (and more of the story!) in the
19036 examples/multicol.lyx
19044 is to show how the LaTeX package
19048 can be used in a LyX document.
19049 As LyX doesn't support the
19053 package natively yet, we have to use some small hacks.
19054 By reading this section it should be obvious how to do this.
19057 \begin_layout Subsection
19061 \begin_layout Standard
19066 package allows switching between one and multicolumn format on the same
19068 Footnotes are handled correctly (for the most part), but will be placed
19069 at the bottom of the page and not under each column.
19070 LaTeX's float mechanism, however, is partly disabled in the current implementat
19072 At the moment only page-wide floats can be used within the scope of the
19076 \begin_layout Subsection
19080 \begin_layout Subsubsection
19084 \begin_layout Standard
19085 If you want to have two columns in your text, you have use LaTeX mode to
19090 begin{multicols}{2}
19092 at the point where you want the two column layout to start, and then
19098 where you want it to end.
19102 \begin_layout Standard
19106 \begin_layout Plain Layout
19110 begin{multicols}{2}
19118 \begin_layout Standard
19123 The Adventure of the Empty House
19126 \begin_inset Newline newline
19131 Sir Arthur Conan Doyle
19134 \begin_layout Standard
19137 It was in the spring of the year 1894 that all London was interested, and
19138 the fashionable world dismayed, by the murder of the Honourable Ronald
19139 Adair under most unusual and inexplicable circumstances.
19140 The public has already learned those particulars of the crime which came
19141 out in the police investigation, but a good deal was suppressed upon that
19142 occasion, since the case for the prosecution was so overwhelmingly strong
19143 that it was not necessary to bring forward all the facts.
19144 Only now, at the end of nearly ten years, am I allowed to supply those
19145 missing links which make up the whole of that remarkable chain.
19146 The crime was of interest in itself, but that interest was as nothing to
19147 me compared to the inconceivable sequel, which afforded me the greatest
19148 shock and surprise of any event in my adventurous life.
19149 Even now, after this long interval, I find myself thrilling as I think
19150 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19151 ty which utterly submerged my mind.
19152 Let me say to that public, which has shown some interest in those glimpses
19153 which I have occasionally given them of the thoughts and actions of a very
19154 remarkable man, that they are not to blame me if I have not shared my knowledge
19155 with them, for I should have considered it my first duty to do so, had
19156 I not been barred by a positive prohibition from his own lips, which was
19157 only withdrawn upon the third of last month.
19160 \begin_layout Standard
19164 \begin_layout Plain Layout
19176 \begin_layout Subsubsection
19180 \begin_layout Standard
19181 The same pattern is used when you want more than two columns:
19184 \begin_layout Standard
19188 \begin_layout Plain Layout
19192 begin{multicols}{3}
19200 \begin_layout Standard
19203 It can be imagined that my close intimacy with Sherlock Holmes had interested
19204 me deeply in crime, and that after his disappearance I never failed to
19205 read with care the various problems which came before the public.
19206 And I even attempted, more than once, for my own private satisfaction,
19207 to employ his methods in their solution, though with indifferent success.
19208 There was none, however, which appealed to me like this tragedy of Ronald
19210 As I read the evidence at the inquest, which led up to a verdict of willful
19211 murder against some person or persons unknown, I realized more clearly
19212 than I had ever done the loss which the community had sustained by the
19213 death of Sherlock Holmes.
19214 There were points about this strange business which would, I was sure,
19215 have specially appealed to him, and the efforts of the police would have
19216 been supplemented, or more probably anticipated, by the trained observation
19217 and the alert mind of the first criminal agent in Europe.
19218 All day, as I drove upon my round, I turned over the case in my mind and
19219 found no explanation which appeared to me to be adequate.
19220 At the risk of telling a twice-told tale, I will recapitulate the facts
19221 as they were known to the public at the conclusion of the inquest.
19224 \begin_layout Standard
19228 \begin_layout Plain Layout
19240 \begin_layout Standard
19241 You can have more than 3 columns if you want to, but that might not be very
19242 pleasant for the eye.
19245 \begin_layout Subsubsection
19246 Columns inside columns
19249 \begin_layout Standard
19250 You can even have columns inside columns:
19253 \begin_layout Standard
19257 \begin_layout Plain Layout
19261 begin{multicols}{2}
19269 \begin_layout Standard
19272 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19273 at that time governor of one of the Australian colonies.
19274 Adair's mother had returned from Australia to undergo the operation for
19275 cataract, and she, her son Ronald, and her daughter Hilda were living together
19279 \begin_layout Standard
19283 \begin_layout Plain Layout
19287 begin{multicols}{2}
19295 \begin_layout Standard
19298 The youth moved in the best society–had, so far as was known, no enemies
19299 and no particular vices.
19300 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19301 had been broken off by mutual consent some months before, and there was
19302 no sign that it had left any very profound feeling behind it.
19303 For the rest {sic} the man's life moved in a narrow and conventional circle,
19304 for his habits were quiet and his nature unemotional.
19305 Yet it was upon this easy-going young aristocrat that death came, in most
19306 strange and unexpected form, between the hours of ten and eleven-twenty
19307 on the night of March 30, 1894.
19310 \begin_layout Standard
19314 \begin_layout Plain Layout
19326 \begin_layout Standard
19329 Ronald Adair was fond of cards–playing continually, but never for such stakes
19331 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19332 It was shown that, after dinner on the day of his death, he had played
19333 a rubber of whist at the latter club.
19334 He had also played there in the afternoon.
19339 The evidence of those who had played with him– Mr.
19340 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
19341 and that there was a fairly equal fall of the cards.
19342 Adair might have lost five pounds, but not more.
19343 His fortune was a considerable one, and such a loss could not in any way
19345 He had played nearly every day at one club or other, but he was a cautious
19346 player, and usually rose a winner.
19347 It came out in evidence that, in partnership with Colonel Moran, he had
19348 actually won as much as four hundred and twenty pounds in a sitting, some
19349 weeks before, from Godfrey Milner and Lord Balmoral.
19350 So much for his recent history as it came out at the inquest.
19353 \begin_layout Standard
19357 \begin_layout Plain Layout
19369 \begin_layout Standard
19370 Please do read the file
19372 examples/multicol.lyx
19374 for more advanced examples including column and header spacing, vertical
19375 separator lines, and more.
19378 \begin_layout Section
19383 Paragraph Environment
19384 \begin_inset OptArg
19387 \begin_layout Plain Layout
19388 Numbering in Enumerate
19396 \begin_layout Standard
19402 \begin_layout Standard
19403 \begin_inset VSpace bigskip
19409 \begin_layout Standard
19411 The default numbering for the
19415 paragraph environment begins with Arabic numbers and ends with uppercase
19417 Suppose, however, you wanted a different type of numbering scheme.
19418 Here's a quickie example of how to change the numbering scheme:
19421 \begin_layout LyX-Code
19431 \begin_layout LyX-Code
19441 \begin_layout LyX-Code
19451 \begin_layout LyX-Code
19461 \begin_layout Standard
19462 \SpecialChar \ldots{}
19463 which changes the numbering scheme to uppercase Roman numerals, uppercase
19464 letters, Arabic numbers, and lowercase letter.
19467 \begin_layout Standard
19468 Additionally, the previous example also adds a little bit extra to the numbering
19470 For example, the first level label actually looks like:
19471 \begin_inset Quotes eld
19475 \begin_inset Quotes erd
19479 For ease of reading, we'll describe what the numbering schemes look like
19480 using a notation something like this: <
19481 \begin_inset Quotes eld
19485 \begin_inset Quotes erd
19489 \begin_inset space ~
19493 \begin_inset Quotes erd
19497 \begin_inset Quotes erd
19501 \begin_inset space ~
19505 \begin_inset Quotes erd
19509 \begin_inset Quotes erd
19513 \begin_inset space ~
19517 \begin_inset Quotes eld
19521 \begin_inset Quotes erd
19528 \begin_layout Standard
19529 As you can see in the example, there is a label command for each nesting
19536 \SpecialChar \ldots{}
19543 , as well as a counter,
19547 \SpecialChar \ldots{}
19553 There are also five
19554 \begin_inset Quotes eld
19558 \begin_inset Quotes erd
19591 , each of which take one counter as an argument.
19592 You can add characters before or after these, but there's no need to add
19596 \begin_layout Standard
19597 You can get really fancy with these.
19601 \begin_layout LyX-Code
19615 \begin_layout LyX-Code
19627 \begin_layout LyX-Code
19637 \begin_layout LyX-Code
19647 \begin_layout Standard
19648 produces the somewhat out of hand numbering scheme: <
19649 \begin_inset Quotes eld
19653 \begin_inset Quotes erd
19657 \begin_inset space ~
19661 \begin_inset Quotes erd
19665 \begin_inset Quotes erd
19669 \begin_inset space ~
19673 \begin_inset Quotes erd
19677 \begin_inset Quotes erd
19681 \begin_inset space ~
19685 \begin_inset Quotes eld
19689 \begin_inset Quotes erd
19696 \begin_layout Standard
19700 \begin_layout Section
19704 \begin_layout Standard
19710 \begin_layout Standard
19711 \begin_inset VSpace bigskip
19717 \begin_layout Standard
19722 \begin_layout Plain Layout
19728 tmpfont}{cmr17 scaled 2500}{
19740 \begin_layout Standard
19745 \begin_layout Plain Layout
19756 hose of you who like the style of old books probably also like
19757 \begin_inset Quotes eld
19761 \begin_inset Quotes erd
19764 —those large capital letters which begin each new chapter or section.
19765 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19766 know some plain TeX!) but does require a lot of work and many iterations,
19767 as you can see by all the ugly TeX-mode stuff at the beginning of this
19771 \begin_layout Standard
19775 \begin_layout Plain Layout
19781 bigdrop{-1em}{3}{ptmri}{T}+
19786 here is a much easier way of doing this, of course.
19795 ) package from CTAN allows a simple way to add such letters to your documents.
19796 Since this package is not a standard part of teTeX, I can't demonstrate
19797 it within this document, but if you copy this paragraph to a new document,
19799 \begin_inset Quotes eld
19809 \begin_inset Quotes erd
19812 and the pluses from the TeX code at the beginning of the paragraph, and
19817 usepackage{dropcaps}
19819 to your LaTeX preamble, you will get a nice Times Roman Italic
19820 \begin_inset Quotes eld
19824 \begin_inset Quotes erd
19827 , whose height is three lines of text and which protrudes 1 em into the
19829 (Make certain you have copied
19830 \begin_inset Quotes eld
19838 \begin_inset Quotes erd
19841 into a directory where TeX can see it.) The first argument is the amount
19842 of indentation; in this case the negative sign moves it into the margin.
19843 The second argument is the height of the letter in number of lines of text.
19844 The third argument is the font name: virtually anything which has a tfm
19845 file should work (wade through the
19847 .../texmf/fonts/tfm
19849 directory for possibilities).
19850 My personal favorite is
19851 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19862 , a fancy German font specifically designed for dropped capitals.
19863 The fourth argument is the letter (or letters) to be dropped.
19868 package also offers the
19874 command, as well as a slightly simplified
19883 \begin_layout Section
19884 Non-standard Paragraph Shapes
19887 \begin_layout Standard
19893 \begin_layout Standard
19894 \begin_inset VSpace bigskip
19900 \begin_layout Standard
19904 \begin_layout Plain Layout
19916 \begin_layout Standard
19920 \begin_layout Plain Layout
19929 \begin_layout Plain Layout
19943 \begin_layout Standard
19948 \begin_layout Plain Layout
19959 \begin_layout Plain Layout
19968 \begin_layout Plain Layout
19977 \begin_layout Plain Layout
19986 \begin_layout Plain Layout
19995 \begin_layout Plain Layout
20004 \begin_layout Plain Layout
20013 \begin_layout Plain Layout
20022 \begin_layout Plain Layout
20031 \begin_layout Plain Layout
20040 \begin_layout Plain Layout
20049 \begin_layout Plain Layout
20058 \begin_layout Plain Layout
20067 \begin_layout Plain Layout
20076 \begin_layout Plain Layout
20085 \begin_layout Plain Layout
20094 \begin_layout Plain Layout
20103 \begin_layout Plain Layout
20112 \begin_layout Plain Layout
20121 \begin_layout Plain Layout
20127 There are times when the tyranny of rectangular paragraphs must be overthrown.
20128 In such situations, a call to the delightful plain TeX command
20135 As you can see, completely arbitrary shapes can be laid out with a suitable
20136 set of linelength definitions.
20137 While this parshape may look a bit silly and useless, one could conceive
20138 of situations such as finely tuned dropped capitals, word wrapping around
20139 non-rectangular graphics, etc.
20140 which will benefit from such handcrafting.
20143 \begin_layout Standard
20144 \begin_inset VSpace bigskip
20150 \begin_layout Standard
20155 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
20162 is the number of lines of text which define the paragraph.
20163 If there turn out to be fewer lines, the shape is truncated; if there are
20164 more, the excess lines have the same dimensions as the last line of the
20174 entries specify the indentation of the line from the left margin, and the
20175 length of the line as measured from that point.
20176 The shape applies only to the current paragraph; everything is reset to
20177 normal for the next paragraph.
20180 \begin_layout Standard
20184 \begin_layout Plain Layout
20196 \begin_layout Section
20200 \begin_layout Standard
20201 As you can see, the examples in this section range from the useful to the
20203 While I don't expect that anyone will ever need the paragraph shape demonstrate
20204 d in the last section, the important point is that you can do almost anything
20205 you want in LyX if you are willing to figure out how to do it in TeX and
20207 TeX is a fantastically powerful typesetting system and all that power is
20208 available to you since LyX uses it as its backend.