1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \use_default_options false
54 \maintain_unincluded_children false
57 InsetLayout CharStyle:MenuItem
66 \newcommand*{\menuitem}[1]{{\sffamily #1}}
75 \font_typewriter default
76 \font_default_family default
84 \default_output_format default
85 \bibtex_command default
86 \index_command default
90 \pdf_title "LyX's Additional Features manual"
91 \pdf_author "LyX Team"
92 \pdf_subject "LyX's additional features documentation"
93 \pdf_keywords "LyX, Documentation, Additional"
95 \pdf_bookmarksnumbered true
96 \pdf_bookmarksopen false
97 \pdf_bookmarksopenlevel 1
102 \pdf_pdfusetitle false
103 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
112 \paperorientation portrait
120 \paragraph_separation indent
121 \paragraph_indentation default
122 \quotes_language english
125 \paperpagestyle headings
126 \tracking_changes false
127 \output_changes false
128 \html_use_mathml true
135 Additional LyX Features
143 \begin_layout Plain Layout
145 Principal maintainer of this file is
150 If you have comments or error corrections, please send them to the LyX
151 Documentation mailing list,
152 \begin_inset Flex CharStyle:Code
155 \begin_layout Plain Layout
157 <lyx-docs@lists.lyx.org>
170 \begin_layout Standard
171 \begin_inset CommandInset toc
172 LatexCommand tableofcontents
179 \begin_layout Chapter
183 \begin_layout Standard
184 This manual is essentially Part II of the
186 User's Guide\SpecialChar \@.
189 The reason for separating this document out is simple: the
193 is already quite lengthy, and it contains information on all of the basic
194 features one needs to know in order to prepare most documents.
195 However, the LyX Team has worked to make LyX extensible through various
196 configuration files and external packages.
197 That means that if you want to support the Fizzwizzle LaTeX package, you
198 can create a layout file (or module) for it without having to alter LyX
200 We've already had contributions of several new features this way, and some
201 of them are documented here.
202 There are also some more `advanced' features, such as how to control the
203 presentation of bibliographies and how to work with multi-part documents,
204 that are not covered in the
208 and are discussed here.
211 \begin_layout Standard
212 This manual also documents some special features, like fax support, version
213 control, and SGML support, which require additional software to work properly.
214 There is also a chapter on LyX's support for HTML.
215 And lastly, there's a chapter of LaTeX tools and tips, things you can use
216 to spruce up your documents by directly using the powerful features of
222 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
225 \begin_layout Standard
226 If you haven't read the
230 yet, you are definitely in the wrong manual.
235 is the first place to go, since it describes the notation and format of
237 You should also be thoroughly familiar with the
241 and all of the basic features of LyX before attempting to read this one.
244 \begin_layout Standard
245 Since many of the topics in this manual depend heavily on LyX's interaction
246 with LaTeX, this first chapter covers the inner workings of LyX and how
247 to direct LyX to generate exactly the LaTeX code you want.
248 It is obviously for more seasoned LyX users.
251 \begin_layout Chapter
255 \begin_layout Section
259 \begin_layout Standard
260 This chapter is for both TeX-nicians and the LaTeX-curious.
261 In it, we'll explain how LyX and LaTeX work together to produce printable
263 This is the only place in any of the manuals where we assume you know something
267 \begin_layout Standard
268 At one time, LyX was called a
269 \begin_inset Quotes eld
272 WYSIWYM frontend to LaTeX,
273 \begin_inset Quotes erd
276 but that's no longer true.
277 There are frontends to LaTeX out there.
281 \begin_layout Plain Layout
282 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
283 There are also the LaTeX modes for vi and emacs, of course.
288 These are basically text editors with the ability to run LaTeX and mark
289 any errors in the file you're editing.
298 run LaTeX, and it also indicates errors in the file, it also does much,
300 For one thing, you don't need to know LaTeX to use LyX effectively.
301 And LyX has added its own extensions to LaTeX.
302 Try the following sometime: select
303 \begin_inset Flex CharStyle:MenuItem
306 \begin_layout Plain Layout
307 Export\SpecialChar \menuseparator
314 \begin_inset Flex CharStyle:MenuItem
317 \begin_layout Plain Layout
324 \begin_inset Flex CharStyle:MenuItem
327 \begin_layout Plain Layout
328 View\SpecialChar \menuseparator
334 ), then look at the preamble of the resulting
335 \begin_inset Flex CharStyle:Code
338 \begin_layout Plain Layout
345 You'll notice a variety of new macros defined specifically by LyX.
346 These macros are defined automatically, according to the features you use
350 \begin_layout Standard
351 There are several commands that automatically invoke LaTeX.
355 \begin_layout Itemize
356 \begin_inset Flex CharStyle:MenuItem
359 \begin_layout Plain Layout
360 View\SpecialChar \menuseparator
369 \begin_layout Itemize
370 \begin_inset Flex CharStyle:MenuItem
373 \begin_layout Plain Layout
374 View\SpecialChar \menuseparator
375 Update\SpecialChar \menuseparator
384 \begin_layout Itemize
385 \begin_inset Flex CharStyle:MenuItem
388 \begin_layout Plain Layout
389 File\SpecialChar \menuseparator
398 \begin_layout Itemize
399 \begin_inset Flex CharStyle:MenuItem
402 \begin_layout Plain Layout
403 File\SpecialChar \menuseparator
412 \begin_layout Standard
413 They will only invoke LaTeX if the file has changed since the last time
418 \begin_layout Standard
419 When LyX runs LaTeX on the file you're editing, it performs these steps:
422 \begin_layout Enumerate
423 Convert the document to LaTeX and save to a file with the extension
424 \begin_inset Flex CharStyle:Code
427 \begin_layout Plain Layout
434 \begin_inset Flex CharStyle:Code
437 \begin_layout Plain Layout
446 \begin_layout Enumerate
448 \begin_inset Flex CharStyle:Code
451 \begin_layout Plain Layout
457 file (maybe several times), and run any other commands (such as
458 \begin_inset Flex CharStyle:Code
461 \begin_layout Plain Layout
468 \begin_inset Flex CharStyle:Code
471 \begin_layout Plain Layout
477 ) needed to compile the LaTeX file.
480 \begin_layout Enumerate
481 If there are any errors, show the error log.
484 \begin_layout Standard
485 If you've run LaTeX using
486 \begin_inset Flex CharStyle:MenuItem
489 \begin_layout Plain Layout
492 \SpecialChar \menuseparator
500 , LyX then runs a DVI viewer to display the DVI-file.
502 \begin_inset Flex CharStyle:MenuItem
505 \begin_layout Plain Layout
508 \SpecialChar \menuseparator
516 , LyX performs further steps:
519 \begin_layout Itemize
521 \begin_inset Flex CharStyle:Code
524 \begin_layout Plain Layout
530 to convert the DVI file to PostScript.
533 \begin_layout Itemize
534 Run a PostScript viewer, such as
535 \begin_inset Flex CharStyle:Code
538 \begin_layout Plain Layout
544 , to display the PostScript file.
547 \begin_layout Standard
548 LyX does similar things when viewing, or exporting, other formats.
551 \begin_layout Section
552 Translating LaTeX files into LyX
555 \begin_layout Standard
556 You can import a LaTeX file into LyX by using the
557 \begin_inset Flex CharStyle:MenuItem
560 \begin_layout Plain Layout
561 File\SpecialChar \menuseparator
562 Import\SpecialChar \menuseparator
569 This will call a program named
570 \begin_inset Flex CharStyle:Code
573 \begin_layout Plain Layout
579 which will create a file
580 \begin_inset Flex CharStyle:Code
583 \begin_layout Plain Layout
590 \begin_inset Flex CharStyle:Code
593 \begin_layout Plain Layout
600 LyX will then open that file.
604 \begin_layout Plain Layout
605 \begin_inset Flex CharStyle:Code
608 \begin_layout Plain Layout
614 can also be run from the command line, of course.
622 \begin_layout Standard
623 \begin_inset Flex CharStyle:Code
626 \begin_layout Plain Layout
632 will translate most legal LaTeX, but not everything.
633 It will put things it doesn't understand into TeX code, so after translating
635 \begin_inset Flex CharStyle:Code
638 \begin_layout Plain Layout
644 , you can look for TeX code and hand-edit it until it looks right.
647 \begin_layout Standard
648 If you don't know what TeX code is, read the next section.
651 \begin_layout Section
652 \begin_inset CommandInset label
654 name "sec:Inserting-TeX-Code"
658 Inserting TeX Code into LyX Documents
661 \begin_layout Standard
662 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
663 You can always insert TeX code into any LyX document.
664 LyX cannot, and will never be able to, display every possible LaTeX construct.
665 If ever you need to insert LaTeX commands into your LyX document, you can
667 \begin_inset Flex CharStyle:Code
670 \begin_layout Plain Layout
676 box, which you can insert into your document with
677 \begin_inset Flex CharStyle:MenuItem
680 \begin_layout Plain Layout
681 Insert\SpecialChar \menuseparator
690 \begin_layout Standard
691 Here's an example of inserting LaTeX commands in a LyX document.
692 The code looks like this:
695 \begin_layout LyX-Code
699 \begin_inset Newline newline
705 \begin_inset Newline newline
708 This is an example for a minipage environment.
710 \begin_inset Newline newline
713 can put nearly everything in it, even (non-floating)
714 \begin_inset Newline newline
719 \begin_inset Newline newline
725 \begin_inset Newline newline
729 \begin_inset Newline newline
735 \begin_inset Newline newline
741 \begin_inset Newline newline
747 \begin_inset Newline newline
752 \begin_inset Newline newline
758 \begin_inset Newline newline
764 \begin_inset Newline newline
770 \begin_inset Newline newline
778 \begin_layout LyX-Code
782 \begin_layout Standard
784 \begin_inset Flex CharStyle:Code
787 \begin_layout Plain Layout
793 box containing this text is directly after this paragraph.
794 Those of you reading the manual in LyX will only see the TeX code inset.
795 Those reading a printed version of the manuals will see the actual results:
798 \begin_layout Standard
802 \begin_layout Plain Layout
809 \begin_layout Plain Layout
816 \begin_layout Plain Layout
818 This is an example for a minipage environment.
819 You can put nearly everything in it, even (non-floating) figures and tables.
823 \begin_layout Plain Layout
830 \begin_layout Plain Layout
835 \begin_layout Plain Layout
842 \begin_layout Plain Layout
849 \begin_layout Plain Layout
856 \begin_layout Plain Layout
862 \begin_layout Plain Layout
869 \begin_layout Plain Layout
876 \begin_layout Plain Layout
883 \begin_layout Plain Layout
895 \begin_layout Standard
896 In addition to using TeX code, you can also create a separate file containing
897 some complex LaTeX structure and then use
898 \begin_inset Flex CharStyle:MenuItem
901 \begin_layout Plain Layout
902 Insert\SpecialChar \menuseparator
912 to include your file (you should select the type
913 \begin_inset Flex CharStyle:Code
916 \begin_layout Plain Layout
923 We recommend that you only do this if you have a
924 \begin_inset Flex CharStyle:Code
927 \begin_layout Plain Layout
938 Otherwise, you'll have a big job tracking down LaTeX errors.
941 \begin_layout Standard
942 There are a few last points to emphasize:
945 \begin_layout Itemize
950 check if your LaTeX code is correct.
953 \begin_layout Itemize
954 Beware reinventing the wheel.
957 \begin_layout Standard
958 On that last point, LyX does have quite a few features tucked into it, and
960 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
961 feature before you decide you have to do it by hand.
962 Moreover, there are numerous LaTeX packages out there to do all sorts of
963 things, from labels to envelopes to fancy multipage tables.
965 \begin_inset CommandInset href
968 target "http://www.ctan.org/"
972 for details, and see chapter
973 \begin_inset CommandInset ref
975 reference "cha:secrets"
982 \begin_layout Standard
983 If you do need to do some wild and fancy things within your document, be
984 sure to check out a good LaTeX book for assistance.
985 There are a number of them listed in the bibliography of the
992 \begin_layout Section
993 LyX and the LaTeX Preamble
996 \begin_layout Subsection
997 About the LaTeX Preamble
1000 \begin_layout Standard
1001 If you already know LaTeX, there is no need to explain here what the preamble
1003 If you don't, the following will give you some ideas—we recommend again
1004 that you consult a LaTeX book for further information.
1005 In any case, you should read the points below, because they explain what
1006 you can do and what you don't need to do in the LaTeX preamble of a LyX
1010 \begin_layout Standard
1011 The LaTeX preamble comes at the very beginning of a document,
1019 \begin_layout Itemize
1020 Declare the document class.
1022 \begin_inset Newline newline
1025 LyX already does this for you.
1026 If you're a seasoned LaTeX-nician, and you have a custom document class
1027 you want to use, check out the
1029 Customization Manual
1031 for information on how to make LyX interface to it.
1034 \begin_layout Itemize
1035 Declare the usage of packages.
1037 \begin_inset Newline newline
1040 LaTeX packages provide special commands, which are only available within
1041 a document when the package has been declared in the preamble.
1042 For example, the package
1043 \begin_inset Flex CharStyle:Code
1046 \begin_layout Plain Layout
1052 forces all paragraphs to be indented.
1053 There are other packages for labels, envelopes, margins, etc.
1057 \begin_layout Itemize
1058 Set counters, variables, lengths and widths.
1060 \begin_inset Newline newline
1063 There are several LaTeX counters and variables which
1067 be set globally from within the preamble in order to have the desired effect.
1068 (There are variables which you can set and reset inside the document, too.)
1069 Margins are a good example of something which must be set in the preamble.
1070 Another example is the label format for lists.
1071 You can actually set these just about anywhere, but it's best to do it
1072 just once, inside the preamble.
1075 \begin_layout Itemize
1076 Declare user defined commands (with
1077 \begin_inset Flex CharStyle:Code
1080 \begin_layout Plain Layout
1089 \begin_inset Flex CharStyle:Code
1092 \begin_layout Plain Layout
1101 \begin_inset Newline newline
1104 These are abbreviations for LaTeX commands which appear very often inside
1106 Although the preamble is a good place to declare such commands, they
1110 be declared anywhere (before they are used for the first time, of course).
1111 This can be useful if there is a lot of raw LaTeX code in your document,
1112 which normally should not be the case.
1115 \begin_layout Standard
1116 LyX adds its own set of definitions to the preamble of the
1117 \begin_inset Flex CharStyle:Code
1120 \begin_layout Plain Layout
1127 This makes LaTeX files generated by LyX portable.
1130 \begin_layout Subsection
1131 Changing the Preamble
1134 \begin_layout Standard
1135 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1136 can't change them without patching LyX itself.
1137 You can, however, add your own stuff to the preamble by selecting
1138 \begin_inset Flex CharStyle:MenuItem
1141 \begin_layout Plain Layout
1143 \begin_inset space ~
1152 \begin_inset Flex CharStyle:MenuItem
1155 \begin_layout Plain Layout
1156 Document\SpecialChar \menuseparator
1163 LyX adds anything in the
1164 \begin_inset Flex CharStyle:MenuItem
1167 \begin_layout Plain Layout
1173 dialog to its own built-in preamble.
1174 Before adding your own declarations in the preamble, you should make sure
1175 that LyX doesn't already support what you want to do.
1176 (Remember what we said about reinventing the wheel?) Also,
1178 make sure your preamble code is correct
1181 LyX doesn't check it for you.
1182 If there is an error, you're likely to get an error like
1183 \begin_inset Quotes eld
1187 \begin_inset Flex CharStyle:Code
1190 \begin_layout Plain Layout
1199 \begin_inset Quotes erd
1203 If you see this error, check your preamble.
1206 \begin_layout Subsection
1210 \begin_layout Standard
1211 Here are some examples of what you can add to a preamble, and what they
1215 \begin_layout Subsubsection
1219 \begin_layout Standard
1220 There are two variables under LaTeX that control page position:
1221 \begin_inset Flex CharStyle:Code
1224 \begin_layout Plain Layout
1233 \begin_inset Flex CharStyle:Code
1236 \begin_layout Plain Layout
1245 Their names should be self-explanatory.
1246 These variables are useful if you think for a moment about computer labels.
1247 Sometimes, the size of a print medium and the area of the medium that you
1248 can actually print on aren't the same.
1250 \begin_inset Flex CharStyle:Code
1253 \begin_layout Plain Layout
1262 \begin_inset Flex CharStyle:Code
1265 \begin_layout Plain Layout
1276 \begin_layout Standard
1277 The default values for
1278 \begin_inset Flex CharStyle:Code
1281 \begin_layout Plain Layout
1290 \begin_inset Flex CharStyle:Code
1293 \begin_layout Plain Layout
1302 \begin_inset space \thinspace{}
1306 \begin_inset space \thinspace{}
1310 \begin_inset space \space{}
1313 the page isn't shifted.
1314 Unfortunately, some DVI drivers always seem to shift the page.
1315 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1316 If you're using LyX on a system that you don't personally maintain, and
1317 your sysadmin is a doofus,
1318 \begin_inset Flex CharStyle:Code
1321 \begin_layout Plain Layout
1330 \begin_inset Flex CharStyle:Code
1333 \begin_layout Plain Layout
1342 Suppose you're left and top margins are always 0.5
1343 \begin_inset space \thinspace{}
1347 You can add this to the preamble:
1350 \begin_layout LyX-Code
1358 \begin_layout LyX-Code
1366 \begin_layout Standard
1367 and your margins should now be correct.
1370 \begin_layout Subsubsection
1374 \begin_layout Standard
1375 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1376 There's a rather nice package, available at your nearest CTAN archive,
1377 for printing sheets of labels:
1378 \begin_inset Flex CharStyle:Code
1381 \begin_layout Plain Layout
1388 Now, your system may not have this package installed by default.
1389 We leave that up to you to check.
1390 You'll also want to read the documentation for it; we're not going to do
1392 Since this is an example, however, we'll give you an example of how you
1396 \begin_layout Standard
1397 First, make sure you're using the
1398 \begin_inset Flex CharStyle:Code
1401 \begin_layout Plain Layout
1408 Next, you need to put the following in your preamble:
1411 \begin_layout LyX-Code
1417 \begin_layout LyX-Code
1423 \begin_layout LyX-Code
1429 \begin_layout LyX-Code
1435 \begin_layout LyX-Code
1441 \begin_layout LyX-Code
1447 \begin_layout LyX-Code
1453 \begin_layout Standard
1454 This sets things up for Avery label sheets, stock #5360.
1455 You're now ready to print labels, but you'll need to insert LaTeX code,
1456 placing the commands
1457 \begin_inset Flex CharStyle:Code
1460 \begin_layout Plain Layout
1469 \begin_inset Flex CharStyle:Code
1472 \begin_layout Plain Layout
1480 around each label text.
1481 This and other special features of
1482 \begin_inset Flex CharStyle:Code
1485 \begin_layout Plain Layout
1491 are explained in its documentation.
1494 \begin_layout Standard
1495 Someday, someone may write a LyX layout file to support this package directly.
1496 Maybe that someone is you.
1499 \begin_layout Subsubsection
1500 Example #3: Paragraph Indentation
1503 \begin_layout Standard
1504 Americans are trained to indent the first line of
1509 As with all of their other weird quirks, most Americans will whine and
1510 moan until they can have their way and indent the first line of all paragraphs.
1519 \begin_layout Standard
1520 Of course, this behavior isn't standard typography.
1521 In books, you typically only indent the first line of a paragraph
1525 it follows another one.
1526 The idea behind indenting the first line of a paragraph is to distinguish
1527 neighboring paragraphs from one another.
1528 If there is no previous paragraph—for example, if it follows a figure or
1529 is the first paragraph in a section—then there is no need for indentation.
1533 \begin_layout Standard
1534 If you're a typical American (we're still joking!), though, you don't care
1535 about such esoteric things; you want your indentation! Add this to the
1539 \begin_layout LyX-Code
1542 usepackage{indentfirst}
1545 \begin_layout Standard
1546 If your TeX distribution isn't braindead, you'll have this package, and
1547 all of your paragraphs will get the indentation the Founding Fathers intended
1551 \begin_layout Subsubsection
1552 Example #4: This Document
1555 \begin_layout Standard
1556 You can also check out the preamble of this document to get an idea of some
1557 of the advanced things you can do.
1558 Also, there are more examples and an assortment of LaTeX
1559 \begin_inset Quotes eld
1563 \begin_inset Quotes erd
1567 \begin_inset space ~
1571 \begin_inset CommandInset ref
1573 reference "cha:secrets"
1581 \begin_layout Section
1582 LyX and LaTeX Errors
1585 \begin_layout Standard
1586 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1588 It then uses the logfile from the LaTeX run to do a post-mortem.
1589 After analyzing the logfile,LyX displays a dialog listing the errors.
1590 Clicking on any one of them will take you to the position in your LyX file
1591 where the error occurred.
1595 \begin_layout Plain Layout
1597 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1599 There are also cases where LaTeX reports the error on one line, but the
1600 actual error is earlier.
1601 This is not unlike forgetting a closing brace in a program: You'll get
1602 an error, but only later.
1610 \begin_layout Standard
1611 Some folks also like to look at the log file directly: It is available from
1613 \begin_inset Flex CharStyle:MenuItem
1616 \begin_layout Plain Layout
1619 \SpecialChar \menuseparator
1623 \begin_inset space ~
1632 There are some fairly common error messages and warnings.
1633 We'll cover those here.
1634 You should look at a good LaTeX book for a complete listing.
1637 \begin_layout Itemize
1638 \begin_inset Flex CharStyle:Code
1641 \begin_layout Plain Layout
1648 \begin_inset Newline newline
1651 Anything beginning with these words is a warning message for the purpose
1653 \begin_inset Quotes eld
1657 \begin_inset Quotes erd
1660 the LaTeX code itself.
1661 You'll get messages like this if you added or changed cross-references
1662 or bibliography entries, in which case, LaTeX is trying to tell you that
1663 you need to make another run.
1664 You can by-and-large ignore these.
1667 \begin_layout Itemize
1668 \begin_inset Flex CharStyle:Code
1671 \begin_layout Plain Layout
1678 \begin_inset Newline newline
1681 Another warning message, this time about fonts which LaTeX couldn't find.
1682 The rest of the message will often say something about a replacement font
1684 You can safely ignore these, too.
1687 \begin_layout Itemize
1688 \begin_inset Flex CharStyle:Code
1691 \begin_layout Plain Layout
1700 \begin_inset Newline newline
1708 They are warnings about lines that were too long and run past the right
1710 Almost always, this is unnoticeable in the final output.
1711 (It can be just a point or two.) Or, only one or two characters extend past
1713 LaTeX seems to generate at least one of these messages for just about any
1715 \begin_inset Newline newline
1718 You can ignore these messages.
1719 Your eyes will tell you if there's a problem with something that's too
1720 wide; just look at the output.
1724 \begin_layout Plain Layout
1725 You can also enable the `draft' option in
1726 \begin_inset Flex CharStyle:MenuItem
1729 \begin_layout Plain Layout
1732 \SpecialChar \menuseparator
1740 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1748 \begin_layout Itemize
1749 \begin_inset Flex CharStyle:Code
1752 \begin_layout Plain Layout
1761 \begin_inset Newline newline
1764 Not quite as common as its cousin.
1765 LaTeX seems to like to print lines that are a bit too wide as opposed to
1766 ones that are a bit too narrow.
1767 We have no idea why.
1770 \begin_layout Itemize
1771 \begin_inset Flex CharStyle:Code
1774 \begin_layout Plain Layout
1783 \begin_inset Flex CharStyle:Code
1786 \begin_layout Plain Layout
1795 \begin_inset Newline newline
1798 Warnings about troubles breaking the page.
1799 Once again, just look at the output.
1800 Your eyes will tell you where something has gone wrong.
1803 \begin_layout Itemize
1804 \begin_inset Flex CharStyle:Code
1807 \begin_layout Plain Layout
1809 \begin_inset Quotes els
1813 \begin_inset Quotes ers
1822 \begin_inset Newline newline
1826 \begin_inset Quotes eld
1830 \begin_inset Quotes erd
1833 isn't installed on this system.
1834 This usually appears because some package your document needs isn't installed.
1835 If you didn't touch the preamble or didn't use the
1836 \begin_inset Flex CharStyle:Code
1839 \begin_layout Plain Layout
1847 command, then one of the packages LyX tried to load is missing.
1849 \begin_inset Flex CharStyle:MenuItem
1852 \begin_layout Plain Layout
1853 Help\SpecialChar \menuseparator
1859 to get a list of packages that LyX knows about.
1860 This file is updated whenever you reconfigure LyX (using
1861 \begin_inset Flex CharStyle:MenuItem
1864 \begin_layout Plain Layout
1865 Tools\SpecialChar \menuseparator
1871 ) and tells you which packages have been detected and what they do.
1872 \begin_inset Newline newline
1876 \begin_inset Flex CharStyle:Code
1879 \begin_layout Plain Layout
1887 command and the package in question isn't installed, then you'll need to
1888 install it yourself.
1891 \begin_layout Itemize
1892 \begin_inset Flex CharStyle:Code
1895 \begin_layout Plain Layout
1896 LaTeX Error: Unknown option
1902 \begin_inset Newline newline
1905 Error messages beginning with this are trying to tell you that you specified
1906 a bad or undefined option to a package.
1907 Check the package's documentation.
1910 \begin_layout Itemize
1911 \begin_inset Flex CharStyle:Code
1914 \begin_layout Plain Layout
1915 Undefined control sequence
1921 \begin_inset Newline newline
1924 If you've inserted LaTeX code into your document, but made a typo, you'll
1926 You may have forgotten to load a package.
1927 In any case, this error message usually means that you used an undefined
1932 \begin_layout Standard
1933 There are other error and warning messages.
1934 Some are self-explanatory.
1935 These are usually LaTeX messages.
1936 Others are downright cryptic.
1937 These are usually TeX error messages, and we really have
1941 what they mean or how to decipher them.
1945 \begin_layout Standard
1946 There's a general sequence you should follow if you get error messages:
1949 \begin_layout Enumerate
1950 Look at the LaTeX code you inserted for typos.
1953 \begin_layout Enumerate
1954 If there are no typos, check that you used the command(s) correctly.
1957 \begin_layout Enumerate
1958 If you get a bunch of error boxes piled up at the very top of the document—and
1959 especially if you see a
1960 \begin_inset Quotes eld
1964 \begin_inset Flex CharStyle:Code
1967 \begin_layout Plain Layout
1976 \begin_inset Quotes erd
1979 error—it means that there are errors in the preamble.
1980 Start debugging your preamble.
1983 \begin_layout Enumerate
1984 If you didn't add anything to the preamble and didn't add any LaTeX code
1985 to the document, the first suspect is your LaTeX distribution itself.
1986 Check for missing packages and install them.
1989 \begin_layout Enumerate
1990 Okay, so there are no missing packages.
1991 Did you use any of the fine-tuning options in LyX? Specifically, did you
1996 any of them, like trying to manually insert lots of
1997 \begin_inset Flex CharStyle:Code
2000 \begin_layout Plain Layout
2002 \begin_inset space ~
2011 \begin_inset Flex CharStyle:Code
2014 \begin_layout Plain Layout
2021 \begin_inset Flex CharStyle:Code
2024 \begin_layout Plain Layout
2030 ? Did you try to kludge something together with these instead of using the
2031 appropriate paragraph environment?
2034 \begin_layout Enumerate
2035 All right, you didn't use any of the fine-tuning options, you played by
2037 Did you try to pull a fancy maneuver? Did you do something funky inside
2038 a table or an equation, like inserting a graphic into a table cell?
2041 \begin_layout Enumerate
2042 Do you have long sections of text where LaTeX cannot find a place to break
2043 a line? By default, LaTeX is rather strict about how much extra inter-word
2044 spacing it will add in order to break a line.
2045 Preferably, you should rework the paragraph to avoid the problem.
2046 If this isn't an option, you can wrap your text in
2047 \begin_inset Flex CharStyle:Code
2050 \begin_layout Plain Layout
2058 to make LaTeX's line breaking more, well, sloppy.
2061 \begin_layout Enumerate
2062 Did you go overboard with the nesting? LyX (currently) doesn't check to
2063 make sure you're in the limits for nesting environments.
2064 If you nested a bunch of environments to the
2065 \begin_inset Formula $17^{\mathrm{th}}$
2068 level, that's the problem.
2069 (The limit in LaTeX is five.)
2072 \begin_layout Enumerate
2073 Okay, you didn't get any error messages, but your output looks awful.
2074 If you have a table or figure that's too wide or long for the page, you
2079 \begin_layout Enumerate
2080 rescale the figure so it fits.
2083 \begin_layout Enumerate
2084 trim down the table so it fits.
2088 \begin_layout Enumerate
2089 If something else is wrong with the output, and you didn't try to pull anything
2090 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2093 \begin_layout Standard
2094 If all this doesn't help—well, then
2098 you might have found a bug in LyX\SpecialChar \ldots{}
2102 \begin_layout Chapter
2106 \begin_layout Section
2107 Customizing Bibliographies with BibTeX
2110 \begin_layout Standard
2111 The most basic information about how to use BibTeX with LyX is contained
2114 Bibliography databases (BibTeX)
2121 The following subsections explain special bibliography features supported
2125 \begin_layout Subsection
2126 Alternative Citation Styles
2129 \begin_layout Standard
2130 Standard BibTeX uses numbers (e.
2131 \begin_inset space \thinspace{}
2135 \begin_inset space \space{}
2139 \begin_inset Quotes eld
2143 \begin_inset Quotes erd
2146 ) to refer to a cited work.
2147 However, in many scientific disciplines, other citation styles are in use.
2148 The most common one is the author-year style (e.
2149 \begin_inset space \thinspace{}
2153 \begin_inset space \space{}
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2165 LyX supports two packages that provide this style,
2166 \begin_inset Flex CharStyle:Code
2169 \begin_layout Plain Layout
2176 \begin_inset Flex CharStyle:Code
2179 \begin_layout Plain Layout
2186 Both packages have their pros and cons, which cannot be listed in detail.
2187 If you only want to have simple author-year (or author-numerical) style,
2188 or if you want to use one of the countless style files for
2189 \begin_inset Flex CharStyle:Code
2192 \begin_layout Plain Layout
2198 , than the established
2199 \begin_inset Flex CharStyle:Code
2202 \begin_layout Plain Layout
2208 package is probably your choice.
2209 If you need special features like short title references, ibidem etc., you
2211 \begin_inset Flex CharStyle:Code
2214 \begin_layout Plain Layout
2223 \begin_layout Standard
2224 The handling of both packages in LyX is basically the same.
2226 \begin_inset Flex CharStyle:MenuItem
2229 \begin_layout Plain Layout
2230 Document\SpecialChar \menuseparator
2237 \begin_inset Flex CharStyle:MenuItem
2240 \begin_layout Plain Layout
2247 \begin_inset Flex CharStyle:MenuItem
2250 \begin_layout Plain Layout
2257 \begin_inset Flex CharStyle:MenuItem
2260 \begin_layout Plain Layout
2267 With both packages, you will get some extra features in the citation dialog
2268 and you can select the style of the reference (
2269 \begin_inset Quotes eld
2273 \begin_inset Quotes erd
2277 \begin_inset Quotes eld
2281 \begin_inset Quotes erd
2285 \begin_inset Quotes eld
2289 \begin_inset Quotes erd
2293 \begin_inset Quotes eld
2297 \begin_inset Quotes erd
2301 Note that both packages need specifically designed style files.
2302 They both ship their own, but there are lots of additional style files,
2303 and there is even an interactive style file builder
2307 \begin_layout Plain Layout
2309 \begin_inset Flex URL
2312 \begin_layout Plain Layout
2314 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2325 \begin_inset Flex CharStyle:Code
2328 \begin_layout Plain Layout
2337 \begin_layout Subsection
2338 Sectioned Bibliographies
2341 \begin_layout Standard
2342 Sometimes you might need to divide your bibliography into several sections.
2343 If you are for instance a historian, the possibility to separate sources
2344 and scientific works is most likely a
2345 \begin_inset Quotes eld
2349 \begin_inset Quotes erd
2353 Unfortunately, BibTeX itself does not allow you to do this.
2354 But with the help of some LaTeX packages, BibTeX can be extended to fit
2358 \begin_layout Standard
2359 LyX provides native support for one of these packages,
2367 \begin_layout Plain Layout
2369 \begin_inset Flex URL
2372 \begin_layout Plain Layout
2374 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2384 The advantage of this package (compared to other packages like
2388 ) is that you don't need to define new citation commands.
2389 Instead, you need to prepare different bibliographic databases which include
2390 the entries for the different sections of the bibliography.
2391 For example: If you want to divide your bibliography into the sections
2393 \begin_inset Quotes eld
2397 \begin_inset Quotes erd
2401 \begin_inset Quotes eld
2405 \begin_inset Quotes erd
2408 , you first need to create two bibliographic databases, e.
2409 \begin_inset space \thinspace{}
2413 \begin_inset space \space{}
2417 \begin_inset Flex CharStyle:Code
2420 \begin_layout Plain Layout
2427 \begin_inset Flex CharStyle:Code
2430 \begin_layout Plain Layout
2440 \begin_layout Standard
2442 \begin_inset Flex CharStyle:MenuItem
2445 \begin_layout Plain Layout
2446 Document\SpecialChar \menuseparator
2453 \begin_inset Flex CharStyle:MenuItem
2456 \begin_layout Plain Layout
2463 \begin_inset Flex CharStyle:MenuItem
2466 \begin_layout Plain Layout
2467 Sectioned bibliography
2473 Now you can insert multiple BibTeX bibliographies, one for each section
2474 of your bibliography.
2475 Returning to our example: Insert the BibTeX bibliography
2476 \begin_inset Flex CharStyle:Code
2479 \begin_layout Plain Layout
2485 and a second one for the database
2486 \begin_inset Flex CharStyle:Code
2489 \begin_layout Plain Layout
2496 You are free to use the same or different styles for each section.
2497 Additionally, you can chose if the bibliography section should contain
2499 \begin_inset Quotes eld
2502 all cited references
2503 \begin_inset Quotes erd
2506 of the specified database(s) (which is the default),
2507 \begin_inset Quotes eld
2510 all uncited references
2511 \begin_inset Quotes erd
2515 \begin_inset Quotes eld
2519 \begin_inset Quotes erd
2523 This might be useful if you would like to separate your bibliography into
2525 \begin_inset Quotes eld
2529 \begin_inset Quotes erd
2533 \begin_inset Quotes eld
2537 \begin_inset Quotes erd
2541 \begin_inset Quotes eld
2545 \begin_inset Quotes erd
2549 The titles for the sections can be added as ordinary sections or subsections.
2551 \begin_inset Flex CharStyle:Code
2554 \begin_layout Plain Layout
2560 removes the bibliography title, you have manually re-add that, too (as
2561 a chapter* or section*, for instance).
2564 \begin_layout Subsection
2565 Multiple Bibliographies
2568 \begin_layout Standard
2569 Multiple bibliographies, e.
2570 \begin_inset space \thinspace{}
2574 \begin_inset space \space{}
2577 a bibliography for each section or chapter of the document, are not supported
2580 \begin_inset Flex CharStyle:Code
2583 \begin_layout Plain Layout
2589 package, which is used for the creation of sectioned bibliographies in
2590 LyX (see the previous section), provides an easy way to solve this task,
2591 if you are willing to use some
2592 \begin_inset Flex CharStyle:MenuItem
2595 \begin_layout Plain Layout
2602 \begin_inset space ~
2606 \begin_inset CommandInset ref
2608 reference "sec:Inserting-TeX-Code"
2616 \begin_layout Plain Layout
2617 An alternative approach is to use the
2618 \begin_inset Flex CharStyle:Code
2621 \begin_layout Plain Layout
2628 \begin_inset Flex CharStyle:Code
2631 \begin_layout Plain Layout
2637 package, respectively.
2645 \begin_layout Standard
2647 \begin_inset Flex CharStyle:MenuItem
2650 \begin_layout Plain Layout
2651 Document\SpecialChar \menuseparator
2658 \begin_inset Flex CharStyle:MenuItem
2661 \begin_layout Plain Layout
2668 \begin_inset Flex CharStyle:MenuItem
2671 \begin_layout Plain Layout
2672 Sectioned bibliography
2678 In the document, you have to enclose the sections, which shall contain
2679 their own bibliography (including the BibTeX bibliography itself), between
2681 \begin_inset Flex CharStyle:Code
2684 \begin_layout Plain Layout
2693 \begin_inset Flex CharStyle:Code
2696 \begin_layout Plain Layout
2704 (those commands have to be inserted as TeX code).
2705 The bibliography will contain all references which have been cited in the
2707 \begin_inset Flex CharStyle:Code
2710 \begin_layout Plain Layout
2721 If you are using this approach, then every citation reference has to be
2723 \begin_inset Flex CharStyle:Code
2726 \begin_layout Plain Layout
2734 \begin_inset Flex CharStyle:Code
2737 \begin_layout Plain Layout
2746 \begin_layout Section
2750 \begin_layout Subsection
2754 \begin_layout Standard
2755 When you are working on a large file with many sections, it is often convenient
2756 to break up the document into several files, or perhaps you have something
2757 where a table may change from time to time, but the preceding text does
2759 In these cases, you should seriously consider using multipart documents.
2760 For example, scientific papers often have five major sections: the introduction
2761 , observations, results, discussion, and conclusion.
2762 Each of these could be its own separate LyX file, with one
2763 \begin_inset Quotes eld
2767 \begin_inset Quotes erd
2770 file which contains the title, authors, abstract, references, etc., plus
2771 the five included files.
2772 It is important to note that each of these files is a full LyX file which
2773 can be formatted and printed on its own, as well as included in a master
2775 Each of these files must have the same document class, however—don't attempt
2776 to mix book classes with article classes.
2777 You may also include LaTeX files; however, these files must not have their
2779 \begin_inset space \thinspace{}
2783 \begin_inset space \space{}
2786 everything up to and including the
2787 \begin_inset Flex CharStyle:Code
2790 \begin_layout Plain Layout
2799 \begin_inset Flex CharStyle:Code
2802 \begin_layout Plain Layout
2810 line must be deleted) or else errors will be generated when you try to
2814 \begin_layout Standard
2815 LyX allows you to include files quite easily with
2816 \begin_inset Flex CharStyle:MenuItem
2819 \begin_layout Plain Layout
2820 Insert\SpecialChar \menuseparator
2822 \begin_inset space ~
2831 When you click on this selection a small box is inserted into the file
2832 at the current cursor location.
2833 Clicking on the box raises a dialog which allows you to select the file
2834 to be included, and the method of its inclusion.
2838 \begin_layout Standard
2839 The file selection box should by now be obvious.
2840 The three inclusion methods are
2841 \begin_inset Quotes eld
2845 \begin_inset Quotes erd
2849 \begin_inset Quotes eld
2853 \begin_inset Quotes erd
2857 \begin_inset Quotes eld
2861 \begin_inset Quotes erd
2865 The difference between
2866 \begin_inset Quotes eld
2870 \begin_inset Quotes erd
2874 \begin_inset Quotes eld
2878 \begin_inset Quotes erd
2881 is really only meaningful to LaTeXperts, but the practical difference is
2882 that files which are
2883 \begin_inset Quotes eld
2887 \begin_inset Quotes erd
2890 are typeset beginning on a new page, while files which are
2891 \begin_inset Quotes eld
2895 \begin_inset Quotes erd
2898 are typeset starting on the current page.
2901 \begin_layout Standard
2902 Generally, the master file is converted into a full LaTeX file before typesettin
2903 g, while the included files are converted to LaTeX files which do not have
2904 all the preamble information.
2907 \begin_layout Standard
2909 \begin_inset Quotes eld
2913 \begin_inset Quotes erd
2916 included file allows you to include a file typeset exactly as it appears
2918 \begin_inset space \thinspace{}
2922 \begin_inset space \space{}
2926 \begin_inset Flex CharStyle:Code
2929 \begin_layout Plain Layout
2935 mode, with the characters set in a fixed-width typewriter font.
2936 Normally, spaces in this file are invisible, though two consecutive spaces
2937 are conserved, unlike LyX's normal treatment of spaces.
2938 However, setting the
2939 \begin_inset Flex CharStyle:MenuItem
2942 \begin_layout Plain Layout
2944 \begin_inset space ~
2948 \begin_inset space ~
2952 \begin_inset space ~
2960 checkbox typesets a mark to unambiguously define the presence of a space.
2964 \begin_layout Subsection
2965 Cross-References Between Files
2968 \begin_layout Standard
2969 \begin_inset Box Shadowbox
2978 height_special "totalheight"
2981 \begin_layout Plain Layout
2982 This section is somewhat out of date.
2983 Need to describe default master documents and how children are opened when
2993 \begin_layout Standard
2994 It is possible to set up cross-references between the different files.
2995 First, open all the files in question: let's call them A and B in a two
2996 file example, where B is included in A.
2997 Let's say you insert a label in A, then want to reference it in B.
2998 Open the cross-reference dialog in whilst in document B, and you can select
3000 \begin_inset Quotes eld
3004 \begin_inset Quotes erd
3010 \begin_layout Subsection
3011 Bibliography Lists in all Subdocuments
3014 \begin_layout Standard
3015 \begin_inset Box Frameless
3024 height_special "totalheight"
3027 \begin_layout Plain Layout
3028 This section also needs updating.
3029 There is now material about this on the wiki, and it could be copied here.
3037 \begin_layout Standard
3038 Copy the bibliography list with all entries to all subdocuments and transform
3040 This way LyX will find the
3041 \begin_inset Flex CharStyle:Code
3044 \begin_layout Plain Layout
3050 -files and you can easily insert references without making the bibliography
3054 \begin_layout Standard
3055 As the bibliography list is in a comment, LaTeX won't use use it and the
3056 references will look like this: [?], instead of like this: [1].
3057 One solution is to use the LaTeX-package
3058 \begin_inset Flex CharStyle:Code
3061 \begin_layout Plain Layout
3067 that will only include comments by processing the files separately.
3068 To do this, add in the LaTeX preamble of every subdocument the following:
3071 \begin_layout LyX-Code
3077 \begin_layout LyX-Code
3080 includecomment{comment}
3083 \begin_layout Standard
3085 \begin_inset Flex URL
3088 \begin_layout Plain Layout
3090 http://wiki.lyx.org/FAQ/Unsorted#toc31
3098 \begin_layout Section
3099 Fancy Headers and Footers
3102 \begin_layout Standard
3103 The default page layout is rather plain; for an
3104 \begin_inset Flex CharStyle:Code
3107 \begin_layout Plain Layout
3113 document class, all you get is a centered page number at the bottom of
3115 This document uses KOMA-script's book class, so it appears to be a bit
3117 But to really put on a show, you need to set the document page style to
3119 \begin_inset Quotes eld
3123 \begin_inset Quotes erd
3126 , as mentioned in the
3131 This section describes the LaTeX code you need to insert in your LaTeX
3132 preamble in order to get the desired effects.
3135 \begin_layout Standard
3136 For more information on fancy headers, see the
3137 \begin_inset Flex CharStyle:Code
3140 \begin_layout Plain Layout
3146 package documentation.
3147 This can be found in the file
3148 \begin_inset Flex CharStyle:Code
3151 \begin_layout Plain Layout
3157 , which should have been installed with your LaTeX distribution, or
3158 \begin_inset CommandInset href
3161 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3168 \begin_layout Standard
3169 The page header is divided into three fields, not surprisingly labeled
3170 \begin_inset Quotes eld
3174 \begin_inset Quotes erd
3178 \begin_inset Quotes eld
3182 \begin_inset Quotes erd
3186 \begin_inset Quotes eld
3190 \begin_inset Quotes erd
3194 The footer is also divided into these three fields.
3195 The LaTeX commands to set these fields in the simplest manner are
3196 \begin_inset Flex CharStyle:Code
3199 \begin_layout Plain Layout
3208 \begin_inset Flex CharStyle:Code
3211 \begin_layout Plain Layout
3220 \begin_inset Flex CharStyle:Code
3223 \begin_layout Plain Layout
3232 \begin_inset Flex CharStyle:Code
3235 \begin_layout Plain Layout
3244 Suppose you wish to put your name in the upper left hand corner of each
3246 Simply insert the following command in the preamble:
3249 \begin_layout Standard
3258 \begin_layout Standard
3259 You will now see your name in the upper left.
3260 If a field has a default entry that you would like to get rid of (often
3261 the page number appears in the central footer, simply include a command
3262 with a blank argument, e.
3263 \begin_inset space \thinspace{}
3269 \begin_layout Standard
3277 \begin_layout Standard
3278 Let's get really fancy: lets put the section number with the word
3279 \begin_inset Quotes eld
3283 \begin_inset Quotes erd
3287 \begin_inset space \thinspace{}
3291 \begin_inset space \space{}
3294 Section 3) in the upper left, the page number (e.
3295 \begin_inset space \thinspace{}
3299 \begin_inset space \space{}
3302 Page 4) in the upper right, your name in the lower left, and the date in
3304 The following commands should now appear in the preamble:
3307 \begin_layout Standard
3317 \begin_layout Standard
3325 \begin_layout Standard
3335 \begin_layout Standard
3344 \begin_layout Standard
3352 \begin_layout Standard
3362 \begin_layout Standard
3364 \begin_inset Flex CharStyle:Code
3367 \begin_layout Plain Layout
3376 \begin_inset Flex CharStyle:Code
3379 \begin_layout Plain Layout
3387 access LaTeX's section and page counters, and so print out the current
3388 section and page numbers.
3390 \begin_inset Flex CharStyle:Code
3393 \begin_layout Plain Layout
3401 simply prints out today's date.
3404 \begin_layout Standard
3405 The thicknesses of the horizontal rules drawn beneath the header and above
3406 the footer can also be modified.
3407 If you don't want one of the rules, set its thickness to 0.
3408 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3414 \begin_inset Flex CharStyle:Code
3417 \begin_layout Plain Layout
3422 headrulewidth}{0.4pt}
3428 \begin_inset Flex CharStyle:Code
3431 \begin_layout Plain Layout
3436 footrulewidth}{0.4pt}
3441 to set the thicknesses.
3444 \begin_layout Standard
3445 You can switch the header/footer settings on and off for individual pages
3447 \begin_inset Flex CharStyle:Code
3450 \begin_layout Plain Layout
3453 thispagestyle{empty}
3459 \begin_inset Flex CharStyle:Code
3462 \begin_layout Plain Layout
3465 thispagestyle{plain}
3471 \begin_inset Flex CharStyle:Code
3474 \begin_layout Plain Layout
3477 thispagestyle{fancy}
3483 Simply insert them in the text on the page you want changed and mark them
3485 In fact, title pages are marked as plain by default, while following pages
3486 are marked fancy when using the global fancy setting.
3489 \begin_layout Standard
3490 As a final example, it is possible to include an image in the header or
3492 Suppose you want to put a company logo in the upper lefthand corner.
3493 You might try something like
3496 \begin_layout Standard
3505 includegraphics{logo.eps}}}
3508 \begin_layout Standard
3510 (you may need to preface this with
3511 \begin_inset Flex CharStyle:Code
3514 \begin_layout Plain Layout
3518 usepackage{graphics}
3523 if you don't include graphics elsewhere in your document).
3526 \begin_layout Section
3527 Itemize Bullet Selection
3528 \begin_inset CommandInset label
3537 \begin_layout Standard
3543 \begin_layout Subsection
3547 \begin_layout Standard
3548 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3549 Using this dialog you can easily specify what bullet shape to use at each
3550 level of an itemized list.
3551 These settings are document-wide so you won't be able to specify different
3552 sets of bullets for different paragraphs.
3556 \begin_layout Plain Layout
3557 Well, actually you can but you'll have to do it by hand.
3565 \begin_layout Subsection
3569 \begin_layout Standard
3570 Open the dialog by selecting the
3571 \begin_inset Flex CharStyle:MenuItem
3574 \begin_layout Plain Layout
3575 Document\SpecialChar \menuseparator
3581 menu item and then select the
3582 \begin_inset Flex CharStyle:MenuItem
3585 \begin_layout Plain Layout
3594 \begin_layout Standard
3595 The dialog provides you with a table of bullet shapes.
3596 A column of buttons on the left of the table provides access to the six
3597 different panels of bullet shapes.
3598 The row of buttons across the top is used to select which bullet depth
3600 A text entry under the table shows the currently selected bullet shape's
3601 LaTeX equivalent and this can be edited if desired.
3602 If you do modify the text you will also need to specify any needed packages
3603 in the LaTeX preamble.
3606 \begin_layout Standard
3607 The six panels are divided up by the packages they require.
3608 The following table shows the mappings from button name to LaTeX packages.
3611 \begin_layout Standard
3613 \begin_inset Tabular
3614 <lyxtabular version="3" rows="7" columns="2">
3615 <features tabularvalignment="middle">
3616 <column alignment="center" valignment="top" width="0pt">
3617 <column alignment="center" valignment="top" width="0pt">
3619 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3622 \begin_layout Plain Layout
3637 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3640 \begin_layout Plain Layout
3657 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3660 \begin_layout Plain Layout
3675 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3678 \begin_layout Plain Layout
3694 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3697 \begin_layout Plain Layout
3712 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3715 \begin_layout Plain Layout
3732 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3735 \begin_layout Plain Layout
3750 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3753 \begin_layout Plain Layout
3770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3773 \begin_layout Plain Layout
3788 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3791 \begin_layout Plain Layout
3808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3811 \begin_layout Plain Layout
3826 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3829 \begin_layout Plain Layout
3846 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3849 \begin_layout Plain Layout
3864 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3867 \begin_layout Plain Layout
3890 \begin_layout Standard
3891 LyX doesn't stop you using bullets from packages you don't have.
3892 If you get errors from LaTeX when you try to view or print the file, then
3893 it is likely you are missing a package.
3897 \begin_layout Plain Layout
3898 LyX doesn't restrict your use since you may be editing locally and exporting
3907 \begin_layout Subsection
3911 \begin_layout Standard
3912 Select which bullet depth you want to change then select the bullet shape
3914 Any changes will not be visible in LyX, but are visible when viewing the
3918 \begin_layout Standard
3919 You can reset a bullet shape to the default simply by clicking your right
3920 mouse button on the appropriate bullet depth button.
3924 \begin_layout Plain Layout
3929 want to have multiple sets of paragraphs with different sets of bullets
3930 in each, then you're going to have to get your hands dirty with TeX code.
3931 The bullet selection dialog can help though because it provides you with
3932 the LaTeX code for a wide range of bullet shapes.
3933 To make your own custom paragraphs you have the following options:
3936 \begin_layout Plain Layout
3940 \begin_layout Plain Layout
3956 \begin_layout Plain Layout
3960 \begin_layout Plain Layout
3982 \begin_layout Itemize
3983 Use the LaTeX command
3984 \begin_inset Flex CharStyle:Code
3987 \begin_layout Plain Layout
3995 to specify a new bullet shape for a given depth.
3996 You'll also need to save the current bullet shape so you can restore it
3998 In this itemized list the following LaTeX code was used to change the bullet
3999 used for the first depth.
4003 \begin_layout LyX-Code
4013 \begin_layout LyX-Code
4030 \begin_layout Itemize
4031 Note that the itemize depth is specified in Roman numerals as part of the
4041 \begin_layout Itemize
4045 \begin_layout Plain Layout
4058 Specify each individual entry by starting each item with the bullet shape
4059 enclosed in square brackets and set as
4060 \begin_inset Flex CharStyle:MenuItem
4063 \begin_layout Plain Layout
4070 For example, this item was started with
4071 \begin_inset Flex CharStyle:Code
4074 \begin_layout Plain Layout
4089 \begin_layout Plain Layout
4093 \begin_layout Plain Layout
4109 \begin_layout Plain Layout
4110 You'll also need to revert the labelitem back to its previous setting for
4111 the global bullet shape settings to remain in effect.
4112 The way used here was:
4115 \begin_layout LyX-Code
4130 \begin_layout Chapter
4131 LyX and the World Wide Web
4134 \begin_layout Standard
4135 LyX has long supported the export of documents to various web-friendly formats,
4137 Before verson 1.7, however, HTML export was always accomplished by the use
4138 of external converters.
4142 \begin_layout Plain Layout
4143 For details on the use of external converters with LyX, see the
4148 section of the Customization manual.
4153 These fall into two large groups: there are converters that use LaTeX as
4154 an intermediate format, such as
4155 \begin_inset Flex CharStyle:Code
4158 \begin_layout Plain Layout
4165 \begin_inset Flex CharStyle:Code
4168 \begin_layout Plain Layout
4175 \begin_inset Flex CharStyle:Code
4178 \begin_layout Plain Layout
4184 , relying upon LyX to produce the LaTeX; and there is a converter that works
4185 directly on LyX files,
4186 \begin_inset Flex CharStyle:Code
4189 \begin_layout Plain Layout
4196 All of these have different advantages and disadvantages.
4200 \begin_layout Standard
4201 The LaTeX-based converters have the advantage that, in principle, they know
4202 everything about the exported document that LaTeX does.
4203 Such converters do not care, for example, if a certain block of code was
4204 produced by LyX or was Evil Red Text.
4206 \begin_inset Flex CharStyle:Code
4209 \begin_layout Plain Layout
4215 files, counters, and references, and can often make use of the
4216 \begin_inset Flex CharStyle:Code
4219 \begin_layout Plain Layout
4225 files generated by BibTeX.
4226 On the other hand, LaTeX is a very hard language to parse---it is sometimes
4227 said that only TeX itself understands TeX---and LaTeX-based converters
4228 will often choke on what seem to be quite simple constructs; complex ones
4229 can throw them completely, and as of this writing, for example, the
4233 manual will not export with
4234 \begin_inset Flex CharStyle:Code
4237 \begin_layout Plain Layout
4243 , though the others will.
4244 The other issue concerns how math is handled.
4245 These converters typically convert the formulae into little pictures that
4246 are then linked from the HTML document.
4247 Since these are actually generated by LaTeX, they are accurate.
4248 But they do not scale well, and just getting them to look as if they are
4249 actually meant to be in your document---so that the font sizes seem to
4250 be roughly the same---can be a challenge.
4253 \begin_layout Standard
4255 \begin_inset Flex CharStyle:Code
4258 \begin_layout Plain Layout
4264 solves some of these problems.
4265 In particular, its rendering of math tends to look better than
4266 \begin_inset Flex CharStyle:Code
4269 \begin_layout Plain Layout
4275 's, at least in simpler cases, since it renders math using a neat combination
4276 of HTML and CSS rather than converting the formulae to images.
4277 But more complex formula tend to be rendered less well than with
4278 \begin_inset Flex CharStyle:Code
4281 \begin_layout Plain Layout
4287 , since there is no reasonable way of scaling parentheses in HTML, for example.
4288 More importantly (as of version 0.39, at least),
4289 \begin_inset Flex CharStyle:Code
4292 \begin_layout Plain Layout
4298 has no support for math macros, for user-defined paragraph or character
4299 styles, or for tables of contents and figures.
4300 These limitations make
4301 \begin_inset Flex CharStyle:Code
4304 \begin_layout Plain Layout
4310 unsuitable for many of the documents more advanced LyX users would produce.
4311 In principle, of course, all of these problems could be solved, but the
4312 LyX developers have decided to follow a different path and made LyX itself
4313 capable of writing XHTML, just as it is capable of writing LaTeX, DocBook,
4317 \begin_layout Standard
4318 As of this writing, XHTML output remains under development and should probably
4320 \begin_inset Quotes eld
4324 \begin_inset Quotes erd
4331 \begin_layout Plain Layout
4333 \begin_inset Flex CharStyle:Code
4336 \begin_layout Plain Layout
4337 development/HTML.notes
4342 , which can be found in the LyX source tree or
4343 \begin_inset CommandInset href
4345 name "accessed online"
4346 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
4350 , usually contains up-to-date information about the state of XHTML output.
4355 Still, the developers have chosen this approach because it has several
4356 potential advantages over the other two.
4359 \begin_layout Standard
4360 These advantages are primarily due to the fact that the XHTML output routines,
4361 since they are part of LyX, know everything LyX knows about the document
4366 \begin_layout Plain Layout
4367 Another advantege is that, since these routines are internal to LyX, they
4368 are immune to changes in LyX's file format, or to changes in the semantics
4374 So they know about the table of contents (as displayed in the Outline),
4375 about the counters associated with different paragraph styles, and about
4376 user-defined styles.
4377 The XHTML output routines know what LyX knows about internationalization,
4378 too, so they will output
4379 \begin_inset Quotes eld
4383 \begin_inset Quotes erd
4387 \begin_inset Quotes eld
4395 \begin_inset Quotes erd
4398 , depending upon the language in effect at the time.
4402 \begin_layout Standard
4403 Quite generally, the output routines know everything LyX knows about document
4404 layout, that is, about the document is to be rendered on screen.
4405 We can use this information when we output the document as XHTML.
4410 generates CSS style information corresponding to the layout information
4411 it uses to render the document on screen: if section headings are supposed
4412 to be sans-serif and bold as seen in LyX, then (by default) they will be
4413 sans-serif and bold when viewed in a web browser, too.
4414 And this is true not just for pre-defined styles, like Section, but for
4415 any style, including user-defined styles.
4416 Indeed, the XHTML output routines make no distinction between user-defined
4417 paragraph and character styles and LyX's own pre-defined styles: in each
4418 case, everything LyX knows about the styles is contained in the layout
4420 And much the same is true as regards pre-defined textual insets, such as
4421 footnotes, and custom versions.
4425 \begin_layout Standard
4426 The result is that XHTML output can be customized and extended in
4430 the same way LaTeX output can be customized and extended: through layout
4432 See chapter five of the
4436 manual for the details.
4439 \begin_layout Standard
4440 As for math, LyX renders math using MathML.
4441 This has advantages and disadvantages.
4442 The advantage is that MathML is a dialect of XML designed specifically
4443 for mathematics on the web, and it typically renders very well in browsers
4445 The first disadvantage is that not all browsers support MathML, and support
4446 is not complete even in the Gecko-based browsers, such as Firefox.
4447 A second disadvantage, as compared to rendering math by images, is that
4448 LyX can only output MathML for LaTeX constructs that it knows about, which
4449 means that the use of ERT in math---e.g., the command
4450 \begin_inset Flex CharStyle:Code
4453 \begin_layout Plain Layout
4462 \begin_inset Flex CharStyle:Code
4465 \begin_layout Plain Layout
4471 package---will produce nothing helpful.
4472 Eventually, therefore, LyX will offer the user the option to use MathML
4473 or images, and it will offer this choice on a case by case basis.
4476 \begin_layout Standard
4477 The remainder of this chapter contains more detailed information on XHTML
4478 output, its limitations, and ways around those limitations.
4481 \begin_layout Standard
4482 \begin_inset Note Note
4485 \begin_layout Plain Layout
4486 This is very imcomplete at this point!
4494 \begin_layout Section
4498 \begin_layout Standard
4499 LyX will happily export indexes as XHTML, but with certain limitations at
4503 \begin_layout Standard
4504 Index export will be most reliable when you do not attempt to use the fancy
4505 constructs that are described in the section on indexes in the
4513 \begin_layout Plain Layout
4514 The main issue here is that LyX itself does not really handle these.
4515 It just lets you enter what you would have to enter in raw LaTeX.
4520 We'll describe how they are handled using the subsection headings from
4524 \begin_layout Itemize
4525 Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
4526 these, but the entries must be separated by
4527 \begin_inset Quotes eld
4531 \begin_inset Quotes erd
4534 , that is, there must be spaces around the exclamation point.
4535 This is because it is otherwise too difficult to check for escaped exclamation
4536 points, ones in math, and so forth.
4539 \begin_layout Itemize
4540 Page Ranges: There is no support at all for page ranges, since these make
4541 no sense with XHMTL.
4542 Instead, you will just get two index entries, one at either end.
4545 \begin_layout Itemize
4546 Cross-referencing: There is no support for cross-referencing.
4547 If LyX finds an entry containing the
4548 \begin_inset Quotes eld
4551 |see\SpecialChar \ldots{}
4553 \begin_inset Quotes erd
4556 construct, it is just dropped, and the rest is treated as an ordinary index
4560 \begin_layout Itemize
4561 Index Entry Order: LyX does support attempts to fix the sorting order.
4562 It will take what is before the first `@' it finds and use that for sorting,
4563 taking what follows the first `@' to be the actual entry.
4564 At present, LyX does not check for escaped `@', so do not try to index
4568 \begin_layout Itemize
4569 Index Entry Layout: You can format entries by using the text style dialog,
4570 or by using any other method available within LyX itself.
4571 There is no support for constructs like:
4572 \begin_inset Quotes eld
4576 \begin_inset Quotes erd
4580 Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
4581 and everything that follows it.
4584 \begin_layout Itemize
4585 Multiple Indexes: There is no support for multiple indexes.
4586 Rather, all index entries will be printed as one large index.
4587 To avoid our printing several versions of the index, we print only the
4588 main index, so make sure you have one.
4591 \begin_layout Section
4592 Nomenclature and Glossary
4595 \begin_layout Standard
4596 There is at present no support for glossaries.
4599 \begin_layout Chapter
4603 \begin_layout Section
4607 \begin_layout Standard
4608 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4609 and retrieve information about the LyX internal state.
4610 This is only intended for advanced users, but they should find it useful.
4611 It is by writing to the LyX server, for example, that bibliography managers,
4612 such as JabRef, are able to
4613 \begin_inset Quotes eld
4617 \begin_inset Quotes erd
4623 \begin_layout Section
4624 Starting the LyX Server
4627 \begin_layout Standard
4628 The LyX server works through the use of a pair of named pipes.
4629 These are usually located in
4630 \begin_inset Flex CharStyle:Code
4633 \begin_layout Plain Layout
4639 , (except on Windows, where
4643 named pipes are special objects located in
4644 \begin_inset Flex CharStyle:Code
4647 \begin_layout Plain Layout
4659 ) and have the names
4660 \begin_inset Quotes eld
4664 \begin_inset Flex CharStyle:Code
4667 \begin_layout Plain Layout
4674 \begin_inset Quotes erd
4678 \begin_inset Quotes eld
4682 \begin_inset Flex CharStyle:Code
4685 \begin_layout Plain Layout
4692 \begin_inset Quotes erd
4696 External programs write into
4697 \begin_inset Flex CharStyle:Code
4700 \begin_layout Plain Layout
4706 and read back data from
4707 \begin_inset Flex CharStyle:Code
4710 \begin_layout Plain Layout
4717 The stem of the pipe names can be defined in the
4718 \begin_inset Flex CharStyle:MenuItem
4721 \begin_layout Plain Layout
4722 Tools\SpecialChar \menuseparator
4729 \begin_inset Flex CharStyle:Code
4732 \begin_layout Plain Layout
4733 "/home/myhome/lyxpipe"
4739 \begin_inset Flex CharStyle:Code
4742 \begin_layout Plain Layout
4761 configure this manually in order for the server to start.
4764 \begin_layout Standard
4766 \begin_inset Flex CharStyle:Code
4769 \begin_layout Plain Layout
4776 \begin_inset Flex CharStyle:Code
4779 \begin_layout Plain Layout
4785 ' to create the pipes.
4786 If one of the pipes already exists, LyX will assume that another LyX process
4787 is already running and will not start the server.
4788 On POSIX (Unix like) systems, if for some other reason, an unused
4789 \begin_inset Quotes eld
4793 \begin_inset Quotes erd
4796 pipe is left in existence when LyX closes, then LyX will try to delete
4798 If this fails for some reason, you will need to delete the pipes manually
4799 and then restart LyX.
4800 On Windows, pipes are deleted by the OS on program termination or crash,
4802 \begin_inset Quotes eld
4806 \begin_inset Quotes erd
4809 pipes should not be possible.
4812 \begin_layout Standard
4813 To have several LyX processes with servers at the same time, you have to
4814 use different configurations, perhaps by using separate user directories,
4816 \begin_inset Flex CharStyle:Code
4819 \begin_layout Plain Layout
4825 file, for each process.
4828 \begin_layout Standard
4829 If you are developing a client program, you might find it useful to enable
4830 debugging information from the LyX server.
4831 Do this by starting LyX as
4832 \begin_inset Flex CharStyle:Code
4835 \begin_layout Plain Layout
4844 \begin_layout Standard
4845 You can find a complete example client written in C in the source distribution
4847 \begin_inset Flex CharStyle:Code
4850 \begin_layout Plain Layout
4851 development/lyxserver/server_monitor.c
4859 \begin_layout Standard
4860 Another useful tool is command-line based client you will find in
4861 \begin_inset Flex CharStyle:Code
4864 \begin_layout Plain Layout
4865 src/client/lyxclient
4873 \begin_layout Section
4874 Normal communication
4877 \begin_layout Standard
4878 To issue a LyX call, the client writes a line of ASCII text into the input
4880 This line has the following format:
4897 \begin_layout Description
4898 clientname is a name that the client can choose arbitrarily.
4899 Its only use is that LyX will echo it if it sends an answer—so a client
4900 can dispatch results from different requesters.
4903 \begin_layout Description
4904 function is the function you want LyX to perform.
4905 It is the same as the commands you'd use in the minibuffer.
4908 \begin_layout Description
4909 argument is an optional argument which is meaningful only to some functions
4911 \begin_inset Quotes eld
4915 \begin_inset Quotes erd
4918 LFUN will insert the argument as text at the cursor position).
4921 \begin_layout Standard
4922 The answer from LyX will arrive in the output pipe and be of the form
4939 \begin_layout Standard
4948 are just echoed from the command request, while
4952 is more or less useful information filled according to how the command
4953 execution worked out.
4954 Some commands, such as
4955 \begin_inset Quotes eld
4959 \begin_inset Quotes erd
4962 , will return information about the internal state of LyX, while other will
4963 return an empty data-response.
4964 This means that the command execution went fine.
4967 \begin_layout Standard
4968 In case of errors, the response from LyX will have this form
4985 \begin_layout Standard
4990 should contain an explanation of why the command failed.
4993 \begin_layout Standard
4997 \begin_layout LyX-Code
4998 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4999 \begin_inset Newline newline
5002 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5003 \begin_inset Newline newline
5006 read a <~/.lyxpipe.out
5007 \begin_inset Newline newline
5013 \begin_layout Section
5017 \begin_layout Standard
5018 LyX can notify clients of events going on asynchronously.
5019 Currently it will only do this if the user binds a key sequence with the
5021 \begin_inset Quotes eld
5025 \begin_inset Quotes erd
5029 The format of the string LyX sends is as follows:
5033 \begin_inset Flex CharStyle:Code
5036 \begin_layout Plain Layout
5047 \begin_layout Standard
5052 is the printed representation of the key sequence that was actually typed
5056 \begin_layout Standard
5057 This mechanism can be used to extend LyX's command set and implement macros.
5058 Bind some key sequence to
5059 \begin_inset Quotes eld
5063 \begin_inset Quotes erd
5067 Then start a client that listens on the output pipe, dispatches the command
5068 according to the sequence, and starts a function that may use LyX calls
5069 and LyX requests to issue a command or a series of commands to LyX.
5072 \begin_layout Section
5073 The simple LyX Server Protocol
5076 \begin_layout Standard
5077 LyX implements a simple protocol that can be used for session management.
5078 All messages are of the form
5091 \begin_layout Standard
5097 \begin_inset Quotes eld
5101 \begin_inset Quotes erd
5105 \begin_inset Quotes eld
5109 \begin_inset Quotes erd
5114 \begin_inset Quotes eld
5118 \begin_inset Quotes erd
5121 is received from a client, LyX will report back to inform the client that
5122 it's listening to it's messages, while
5123 \begin_inset Quotes eld
5127 \begin_inset Quotes erd
5130 sent from LyX will inform clients that LyX is closing.
5133 \begin_layout Section
5134 Reverse DVI/PDF search
5137 \begin_layout Standard
5138 Some DVI/PDF viewers
5142 \begin_layout Plain Layout
5143 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5144 Skim on Mac OSX and SumatraPDF on Windows.
5153 facility (also called
5158 This means that you can tell LyX to put the cursor to a specific line in
5159 the document by clicking at the respective position in the DVI/PDF output.
5160 To achieve this, the viewer must be able to communicate with LyX.
5161 This is done via the LyX server either by using the named pipe (
5165 ), or the UNIX domain socket (
5169 ) that LyX creates in its temporary directory (this is the way the
5170 \begin_inset Flex CharStyle:Code
5173 \begin_layout Plain Layout
5179 program communicates with LyX).
5180 In some cases, you need a helper script that mediates between the viewer
5181 and LyX, in others, the viewer can communicate with LyX directly.
5182 This depends on the selected viewer and on your operating system.
5183 The same applies to the way viewers need to be configured and the way the
5184 reverse search is actually performed.
5185 In what follows, we will thus describe how to setup reverse search for
5187 Before we turn to this, though, we will explain what needs to be done generally
5188 to enable reverse search in the DVI/PDF output.
5191 \begin_layout Subsection
5192 Enabling reverse search
5195 \begin_layout Standard
5196 LaTeX provides several different methods for reverse search.
5197 Some are built-in in the
5198 \begin_inset Flex CharStyle:Code
5201 \begin_layout Plain Layout
5207 program, some are provided by external packages.
5208 Your choice depends on whether your LaTeX distribution already provides
5209 a given method (the built-in methods are rather new) and whether your viewer
5211 The available methods are described in the following.
5214 \begin_layout Subsubsection*
5215 Built-in DVI-search via src-specials (DVI only)
5218 \begin_layout Standard
5219 This method provides the DVI file with the necessary information for reverse
5221 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5222 distribution should include it), and it works reliably.
5223 To enable it, change the
5224 \begin_inset Flex CharStyle:MenuItem
5227 \begin_layout Plain Layout
5232 \begin_layout Plain Layout
5245 \begin_inset Flex CharStyle:MenuItem
5248 \begin_layout Plain Layout
5253 \begin_layout Plain Layout
5260 eX (plain)->DraftDVI
5266 \begin_inset Flex CharStyle:MenuItem
5269 \begin_layout Plain Layout
5270 Preferences\SpecialChar \menuseparator
5271 File Handling\SpecialChar \menuseparator
5278 \begin_inset Flex CharStyle:Code
5281 \begin_layout Plain Layout
5282 latex -src-specials $$i
5288 If this doesn't work, check if your TeX engine needs different options
5289 (the syntax might differ in some distributions).
5292 \begin_layout Subsubsection*
5293 External Packages (PDFSync and scrltx)
5296 \begin_layout Standard
5305 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5307 In order to enable it, load the packages in the LyX preamble:
5310 \begin_layout Itemize
5311 \begin_inset Flex CharStyle:Code
5314 \begin_layout Plain Layout
5322 for reverse PDF search,
5325 \begin_layout Itemize
5327 \begin_inset Flex CharStyle:Code
5330 \begin_layout Plain Layout
5333 usepackage[active]{srcltx}
5338 for reverse DVI search.
5341 \begin_layout Standard
5342 If you want to be able to perform both DVI and PDF reverse searches, you
5343 can also insert in the preamble the following lines
5346 \begin_layout LyX-Code
5350 \begin_inset Newline newline
5356 \begin_inset Newline newline
5362 \begin_inset Newline newline
5368 \begin_inset Newline newline
5373 usepackage[active]{srcltx}
5374 \begin_inset Newline newline
5382 \begin_layout Standard
5383 This way, you can preview the file as either DVI or PDF (pdflatex) and the
5384 right package will be used.
5387 \begin_layout Standard
5388 Note that PDFSync might affect the output layout of your document.
5389 It is therefore advised to disable PDFsync for final documents.
5392 \begin_layout Subsubsection*
5393 Built-in reverse search via SyncTeX (DVI and PDF)
5396 \begin_layout Standard
5398 \begin_inset Flex CharStyle:Code
5401 \begin_layout Plain Layout
5407 have built-in support for both PDF and DVI reverse search.
5412 facility is basically the result of the integration of the PDFSync package
5413 to the pdftex program and its merge with the
5418 You need at least TeXLive 2008 or a recent MikTeX distribution in order
5420 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
5421 already provide SyncTeX support.
5424 \begin_layout Standard
5425 To enable SyncTeX for DVI output, change the
5426 \begin_inset Flex CharStyle:MenuItem
5429 \begin_layout Plain Layout
5434 \begin_layout Plain Layout
5447 \begin_inset Flex CharStyle:MenuItem
5450 \begin_layout Plain Layout
5455 \begin_layout Plain Layout
5462 eX (plain) -> DraftDVI
5468 \begin_inset Flex CharStyle:MenuItem
5471 \begin_layout Plain Layout
5472 Preferences\SpecialChar \menuseparator
5473 File Handling\SpecialChar \menuseparator
5480 \begin_inset Flex CharStyle:Code
5483 \begin_layout Plain Layout
5484 latex -synctex=1 $$i
5489 , and for PDF output, change the
5490 \begin_inset Flex CharStyle:MenuItem
5493 \begin_layout Plain Layout
5498 \begin_layout Plain Layout
5505 eX (pdflatex) -> PDF (pdflatex)
5511 \begin_inset Flex CharStyle:Code
5514 \begin_layout Plain Layout
5515 pdflatex -synctex=1 $$i
5521 Check the documentation of your viewer whether the viewer needs to be configure
5522 d for the use with SyncTeX.
5526 \begin_layout Plain Layout
5528 \begin_inset Flex CharStyle:Code
5531 \begin_layout Plain Layout
5537 option enables gzip compression.
5538 If your viewer does not support it, you should instead use
5539 \begin_inset Flex CharStyle:Code
5542 \begin_layout Plain Layout
5556 \begin_layout Subsection
5557 Configuring and using specific viewers
5560 \begin_layout Subsubsection*
5561 Xdvi (all platforms)
5564 \begin_layout Standard
5566 \begin_inset Flex CharStyle:Code
5569 \begin_layout Plain Layout
5575 , you don't need to do anything else for performing a reverse DVI search,
5576 as LyX already provides the necessary hooks for automatically using the
5578 \begin_inset Flex CharStyle:Code
5581 \begin_layout Plain Layout
5588 Just setup your document as described above (reverse search is triggered
5589 by Ctrl-click or Alt-click on Mac OSX, respectively).
5592 \begin_layout Standard
5593 However, if for whatever reason you want to use the named pipe instead of
5594 the socket for communicating with LyX, simply change the DVI viewer in
5596 \begin_inset Flex CharStyle:MenuItem
5599 \begin_layout Plain Layout
5600 Preferences\SpecialChar \menuseparator
5601 File Handling\SpecialChar \menuseparator
5611 \begin_layout Plain Layout
5612 On Mac OSX you have to use
5613 \begin_inset Flex CharStyle:Code
5616 \begin_layout Plain Layout
5617 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5628 \begin_inset Flex CharStyle:Code
5631 \begin_layout Plain Layout
5632 xdvi -editor 'lyxeditor.sh %f %l'
5638 \begin_inset Flex CharStyle:Code
5641 \begin_layout Plain Layout
5647 is a suitable script.
5648 For example, a minimal shell script is the following one:
5651 \begin_layout LyX-Code
5653 \begin_inset Newline newline
5656 LYXPIPE="/path/to/lyxpipe"
5657 \begin_inset Newline newline
5660 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5661 \begin_inset Newline newline
5664 echo "$COMMAND" > "${LYXPIPE}".in || exit
5665 \begin_inset Newline newline
5668 read < "${LYXPIPE}".out || exit
5671 \begin_layout Standard
5673 \begin_inset Flex CharStyle:Code
5676 \begin_layout Plain Layout
5686 \begin_layout Plain Layout
5693 XServer pipe path specified in
5694 \begin_inset Flex CharStyle:MenuItem
5697 \begin_layout Plain Layout
5698 Preferences\SpecialChar \menuseparator
5708 \begin_layout Plain Layout
5710 \begin_inset Flex CharStyle:Code
5713 \begin_layout Plain Layout
5719 folder of a source distribution you can find a
5720 \begin_inset Flex CharStyle:Code
5723 \begin_layout Plain Layout
5729 script which is able to locate the
5733 based on your preferences.
5741 \begin_layout Subsubsection*
5745 \begin_layout Standard
5747 \begin_inset Flex CharStyle:Code
5750 \begin_layout Plain Layout
5751 /Applications/MacDviX_Folder/calleditor.script
5756 , add the following lines:
5759 \begin_layout LyX-Code
5764 \begin_layout Plain Layout
5771 X.app/Contents/MacOS/lyxeditor "$2" $1
5772 \begin_inset Newline newline
5778 \begin_layout Standard
5779 Modify the lines accordingly if you install LyX somewhere else than in the
5780 Applications folder.
5783 \begin_layout Standard
5784 Reverse search is triggered by Alt-click (OPTION-click).
5787 \begin_layout Subsubsection*
5791 \begin_layout Standard
5793 \begin_inset Flex CharStyle:Code
5796 \begin_layout Plain Layout
5797 open -a Skim.app $$i
5802 to the viewer setting in
5803 \begin_inset Flex CharStyle:MenuItem
5806 \begin_layout Plain Layout
5807 Preferences\SpecialChar \menuseparator
5808 File Handling\SpecialChar \menuseparator
5809 File formats\SpecialChar \menuseparator
5816 \begin_inset Flex CharStyle:MenuItem
5819 \begin_layout Plain Layout
5820 Skim\SpecialChar \menuseparator
5821 Preferences\SpecialChar \menuseparator
5831 \begin_layout Plain Layout
5841 \begin_layout Standard
5842 Reverse search is triggered by COMMAND-SHIFT-click
5845 \begin_layout Subsubsection*
5849 \begin_layout Standard
5851 \begin_inset Flex CharStyle:MenuItem
5854 \begin_layout Plain Layout
5855 Settings\SpecialChar \menuseparator
5856 Configure Okular\SpecialChar \ldots{}
5857 \SpecialChar \menuseparator
5864 \begin_inset Quotes eld
5868 \begin_inset Quotes erd
5872 \begin_inset Flex CharStyle:Code
5875 \begin_layout Plain Layout
5884 \begin_layout Standard
5885 Reverse search is triggered by SHIFT-click.
5888 \begin_layout Subsubsection*
5892 \begin_layout Standard
5893 Launch yap, choose its
5894 \begin_inset Flex CharStyle:MenuItem
5897 \begin_layout Plain Layout
5898 View\SpecialChar \menuseparator
5905 \begin_inset Quotes eld
5909 \begin_inset Quotes erd
5914 \begin_inset Quotes eld
5917 New\SpecialChar \ldots{}
5919 \begin_inset Quotes erd
5922 button and, in the window that opens, enter
5923 \begin_inset Quotes eld
5927 \begin_inset Quotes erd
5930 (or any other name you like) in the
5931 \begin_inset Quotes eld
5935 \begin_inset Quotes erd
5939 Now click on the button labeled
5940 \begin_inset Quotes eld
5943 \SpecialChar \ldots{}
5945 \begin_inset Quotes erd
5948 to open a file dialog and navigate to the directory containing the batch
5950 \begin_inset Flex CharStyle:Code
5953 \begin_layout Plain Layout
5961 \begin_inset Flex CharStyle:Code
5964 \begin_layout Plain Layout
5970 and then specify the program arguments as
5971 \begin_inset Flex CharStyle:Code
5974 \begin_layout Plain Layout
5982 \begin_inset Flex CharStyle:Code
5985 \begin_layout Plain Layout
5991 wrapper is used for communicating with LyX through the
5998 \begin_layout LyX-Code
6000 \begin_inset Newline newline
6003 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6012 \begin_inset Newline newline
6026 \begin_layout Standard
6027 Make sure that the LyXServer pipe path you specified in LyX is
6028 \begin_inset Flex CharStyle:Code
6031 \begin_layout Plain Layout
6045 , otherwise change the
6046 \begin_inset Flex CharStyle:Code
6049 \begin_layout Plain Layout
6055 wrapper accordingly.
6058 \begin_layout Standard
6059 In yap, reverse search is triggered by double-click.
6062 \begin_layout Subsubsection*
6063 SumatraPDF (Windows)
6066 \begin_layout Standard
6067 In order to use SumatraPDF for inverse search, enter
6068 \begin_inset Flex CharStyle:Code
6071 \begin_layout Plain Layout
6072 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6077 in the viewer setting in
6078 \begin_inset Flex CharStyle:MenuItem
6081 \begin_layout Plain Layout
6082 Preferences\SpecialChar \menuseparator
6083 File Handling\SpecialChar \menuseparator
6084 File formats\SpecialChar \menuseparator
6091 \begin_inset Flex CharStyle:Code
6094 \begin_layout Plain Layout
6100 is the previous wrapper.
6101 If SumatraPDF.exe is not in your command PATH, use its full file name.
6104 \begin_layout Standard
6105 Reverse search is triggered by double-click.
6108 \begin_layout Subsubsection*
6112 \begin_layout Standard
6113 First of all, make sure that yap is your default DVI viewer in the Windows
6114 environment, then launch it, choose its
6115 \begin_inset Flex CharStyle:MenuItem
6118 \begin_layout Plain Layout
6119 View\SpecialChar \menuseparator
6126 \begin_inset Quotes eld
6130 \begin_inset Quotes erd
6135 \begin_inset Quotes eld
6138 New\SpecialChar \ldots{}
6140 \begin_inset Quotes erd
6143 button and, in the window that opens, enter
6144 \begin_inset Quotes eld
6148 \begin_inset Quotes erd
6151 (or any other name you like) in the
6152 \begin_inset Quotes eld
6156 \begin_inset Quotes erd
6160 Now click on the button labeled
6161 \begin_inset Quotes eld
6164 \SpecialChar \ldots{}
6166 \begin_inset Quotes erd
6169 to open a file dialog and navigate to the directory containing the
6170 \begin_inset Flex CharStyle:Code
6173 \begin_layout Plain Layout
6179 program (which is installed by default on Cygwin along with the LyX executable).
6181 \begin_inset Flex CharStyle:Code
6184 \begin_layout Plain Layout
6190 and then specify the program arguments as
6191 \begin_inset Flex CharStyle:Code
6194 \begin_layout Plain Layout
6201 In this way, you will be using the
6205 for communicating with LyX.
6206 If, for whatever reason, you want to use the
6211 \begin_inset Flex CharStyle:Code
6214 \begin_layout Plain Layout
6220 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6223 \begin_layout Standard
6224 In yap, reverse search is triggered by double-click.
6227 \begin_layout Subsubsection*
6231 \begin_layout Standard
6232 In order to use SumatraPDF for inverse search, enter
6233 \begin_inset Flex CharStyle:Code
6236 \begin_layout Plain Layout
6242 in the viewer setting in
6243 \begin_inset Flex CharStyle:MenuItem
6246 \begin_layout Plain Layout
6247 Preferences\SpecialChar \menuseparator
6248 File Handling\SpecialChar \menuseparator
6249 File formats\SpecialChar \menuseparator
6256 \begin_inset Flex CharStyle:Code
6259 \begin_layout Plain Layout
6265 is the following script (to be placed in your command PATH,
6266 \begin_inset Flex CharStyle:Code
6269 \begin_layout Plain Layout
6275 being the best choice):
6278 \begin_layout LyX-Code
6280 \begin_inset Newline newline
6284 \begin_inset Newline newline
6287 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
6290 \begin_layout Standard
6291 This wrapper script is needed because SumatraPDF is a native Windows application
6292 and does not understand the posix paths used by the Cygwin version of LyX.
6293 If SumatraPDF.exe is not in your command PATH, use its full posix path in
6296 \begin_inset Flex CharStyle:Code
6299 \begin_layout Plain Layout
6305 enables communication via the
6311 \begin_inset Flex CharStyle:Code
6314 \begin_layout Plain Layout
6320 option if you want to use the
6324 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6327 \begin_layout Standard
6328 Reverse search is triggered by double-click.
6331 \begin_layout Chapter
6332 Special Document Classes
6335 \begin_layout Section
6339 \begin_layout Standard
6345 \begin_layout Subsection
6349 \begin_layout Standard
6350 This section describes how LyX can be used to write articles for submission
6351 to the scientific journal
6353 Astronomy and Astrophysics
6355 (www.edpsciences.fr/aa/
6356 \begin_inset Flex URL
6359 \begin_layout Plain Layout
6361 http://www.edpsciences.fr/aa/
6366 ) using Version 5.01 of the document class
6371 This package can be downloaded from the ftp site
6374 \begin_layout Standard
6375 \begin_inset VSpace medskip
6381 \begin_layout Standard
6383 \begin_inset Flex URL
6386 \begin_layout Plain Layout
6388 ftp://ftp.edpsciences.org/pub/aa/readme.html
6396 \begin_layout Standard
6397 \begin_inset VSpace medskip
6403 \begin_layout Standard
6404 A manual comes together with that package, and this text is not meant to
6405 replace the original manual but merely a short guide how to realize the
6406 correct form of your paper.
6410 \begin_layout Standard
6411 Please note that the publisher of the journal was changed from Springer
6412 to EDP Sciences starting January 1, 2001.
6413 That change implicated also some slight changes of the style files, namely
6414 the removal of the thesaurus command.
6415 The LyX class aa supports the newest version of these style files, V 5.01.
6416 If you have an older version installed, please upgrade.
6417 For compatibility, the old (version 4) layout has been kept as
6422 Please refer to the comments in
6424 LyXDir/layouts/aapaper.layout
6429 \begin_layout Subsection
6433 \begin_layout Standard
6434 It is recommended you start from the example template distributed with LyX.
6435 If you are not using a template, note the following settings:
6438 \begin_layout Itemize
6445 Document\SpecialChar \menuseparator
6448 dialog (OK, that one was obvious).
6451 \begin_layout Itemize
6452 Don't change the option
6455 \begin_inset space ~
6465 The whole layout is done by the macros, you shouldn't change anything.
6468 \begin_layout Subsection
6472 \begin_layout Standard
6473 First thing to enter is the header information.
6474 It consists of seven entries, of which some are optional.
6478 \begin_layout Itemize
6486 \begin_layout Itemize
6494 \begin_layout Itemize
6502 \begin_layout Itemize
6510 \begin_layout Itemize
6515 : [optional] if more than one author: whom to contact for offprint requests.
6518 \begin_layout Itemize
6523 : [optional] mail address for contacts.
6526 \begin_layout Itemize
6534 Received: <date>; Accepted <date>
6537 \begin_layout Standard
6538 There is no need to issue the
6544 command, this is done automatically by LyX when the header is finished.
6545 Although the order of the single header entries doesn't matter it is advised
6546 to keep the above sequence, just to get the best optics and meets the layout
6547 of the real document.
6550 \begin_layout Standard
6551 If you want to place footnotes in the header block, e.
6552 \begin_inset space \thinspace{}
6556 \begin_inset space \space{}
6559 to state your present address, just use the standard footnote via the menu
6562 Insert\SpecialChar \menuseparator
6566 LyX will automagically use the term
6575 \begin_layout Standard
6576 In addition to these topics, the macros use three additional LaTeX commands
6577 that have no counterpart in LyX:
6580 \begin_layout Itemize
6587 to separate different names for more than one author and institute, respectivel
6591 \begin_layout Itemize
6598 to mark corresponding author/institute pairs.
6599 The institutes are numbered sequentially as they appear in the
6603 field, so you have to put a marker to each author.
6606 \begin_layout Itemize
6613 to supply an email address for fast contact.
6616 \begin_layout Standard
6617 In all cases, the appropriate command has to be entered in LyX and marked
6623 \begin_layout Subsection
6627 \begin_layout Standard
6628 The abstract should immediately follow the header block.
6629 With version 5 the abstract environment was changed to a command, and there
6630 is now a resctriction to only one paragraph.
6631 In addition, it should contain an entry with the keywords.
6632 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6639 by hand and mark it as LaTeX code.
6640 Refer to the example paper.
6643 \begin_layout Subsection
6644 Supported environments
6647 \begin_layout Standard
6648 The A&A paper layout supports the following environments for structuring
6652 \begin_layout Itemize
6658 \begin_layout Itemize
6664 \begin_layout Itemize
6670 \begin_layout Itemize
6676 \begin_layout Itemize
6682 \begin_layout Itemize
6688 \begin_layout Itemize
6694 \begin_layout Itemize
6700 \begin_layout Itemize
6706 \begin_layout Itemize
6712 \begin_layout Itemize
6718 \begin_layout Itemize
6724 \begin_layout Subsection
6725 Commands not supported by LyX
6728 \begin_layout Standard
6729 Some commands are not yet supported by the
6734 Some have already been mentioned.
6735 For the sake of completeness, they are listed all together here:
6738 \begin_layout Itemize
6746 \begin_layout Itemize
6754 \begin_layout Itemize
6762 \begin_layout Itemize
6770 \begin_layout Itemize
6778 \begin_layout Itemize
6786 \begin_layout Itemize
6794 \begin_layout Itemize
6802 \begin_layout Standard
6803 If you want to use any of these commands, you have to enter them yourself.
6806 Do not forget to mark them as LaTeX code!
6809 \begin_layout Subsection
6810 Figure and Table Floats
6813 \begin_layout Standard
6814 LyX provides support for the necessary float environments
6816 figure, figure*, table
6822 , therefore we won't tell much about it here.
6826 \begin_inset space ~
6832 Just remember that tables should be left-aligned.
6833 For that, select the table and change the alignment in
6835 Edit\SpecialChar \menuseparator
6837 \begin_inset space ~
6843 \begin_layout Standard
6844 There is only one special thing: the figures with caption besides the figure.
6845 To create such a figure, you have to do the following:
6848 \begin_layout Enumerate
6849 Create a wide figure float:
6851 Insert\SpecialChar \menuseparator
6852 Float\SpecialChar \menuseparator
6855 , then right click in the figure and select
6861 \begin_inset space ~
6869 \begin_layout Enumerate
6870 Enter your caption text.
6873 \begin_layout Enumerate
6878 to move the cursor above the caption.
6881 \begin_layout Enumerate
6885 \begin_layout Enumerate
6886 Position the cursor behind the figure and insert a horizontal fill:
6888 Insert\SpecialChar \menuseparator
6890 \begin_inset space ~
6893 Character\SpecialChar \menuseparator
6895 \begin_inset space ~
6903 \begin_layout Enumerate
6904 Switch to LaTeX mode:
6907 \begin_inset space ~
6915 \begin_layout Enumerate
6925 Do not close the brace!
6928 \begin_layout Enumerate
6929 Position the cursor behind the caption text, switch to LaTeX mode and insert
6933 \begin_inset space ~
6945 \begin_layout Standard
6946 Also, refer to the figures in the example paper.
6949 \begin_layout Subsection
6953 \begin_layout Standard
6954 For submission, the paper has to be formated in a special double-spacing
6956 For this purpose, you have to give the option
6960 to the documentclass.
6961 This must be done using the extra class options field in the
6963 Document\SpecialChar \menuseparator
6967 Just enter the string
6974 \begin_layout Subsection
6978 \begin_layout Standard
6983 directory contains an example paper written with LyX.
6984 It is the example paper from the original macro package, translated to
6986 Use it for inspiration, and compare the original LaTeX code with LyX way
6990 \begin_layout Section
6994 \begin_layout Standard
7000 \begin_layout Subsection
7004 \begin_layout Standard
7005 AASTeX is a set of macros produced by the American Astronomical Society
7006 to facilitate electronic manuscript submission to the three journals they
7007 publish: the Astrophysical Journal (including the Letters and Supplement),
7008 the Astronomical Journal, and the Publications of the Astronomical Society
7010 LyX has proven to be an excellent tool for generating these documents,
7011 especially given its equation, citation, and figure handling capabilities.
7012 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7013 is the version described here, or higher.
7014 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7015 incompatible with LyX.
7016 The AASTeX package may be downloaded from the AASTeX Web site
7019 \begin_layout Standard
7020 \begin_inset VSpace medskip
7026 \begin_layout Standard
7028 \begin_inset Flex URL
7031 \begin_layout Plain Layout
7033 http://www.journals.uchicago.edu/AAS/AASTeX
7041 \begin_layout Standard
7042 \begin_inset VSpace medskip
7048 \begin_layout Standard
7049 A complete user guide is contained in that package and you should familiarize
7050 yourself with it thoroughly before embarking on writing a paper in LyX.
7051 LyX will not reduce the need to figure out all the AASTeX commands, it
7052 will only reduce the drudgery of typing everything in.
7053 It is your responsibility to ensure that the final exported LaTeX document
7054 conforms completely to the requirements of the journal to which you are
7055 submitting your paper.
7058 \begin_layout Subsection
7059 Starting a New Paper
7062 \begin_layout Standard
7063 I strongly suggest that you start with the AASTeX template file.
7066 File\SpecialChar \menuseparator
7073 , enter the new file name, then choose the
7078 This will show the most common fields found in a manuscript.
7079 Simply overwrite the existing text (including the brackets,
7083 ) with the correct information.
7084 Many of the AASTeX commands and environments can be implemented directly
7085 in LyX, but some cannot: most noticeably
7097 , which should stick out like a sore thumb if you actually just opened the
7099 For commands such as these, the LaTeX code must be entered directly and
7101 Such commands are referred to as TeX code, or Evil Red Text.
7102 I tried to minimize the amount of TeX code needed in an AASTeX document,
7103 but there is still a bit more required than any of us would like.
7106 \begin_layout Subsection
7107 Finishing Your Paper
7110 \begin_layout Standard
7111 When the paper is finished to your satisfaction and previews/prints correctly,
7113 \begin_inset Quotes eld
7117 \begin_inset Quotes erd
7120 actions which need to be done before you submit it to the journals.
7124 \begin_layout Enumerate
7125 Export your paper as a LaTeX file (
7127 File\SpecialChar \menuseparator
7128 Export\SpecialChar \menuseparator
7135 \begin_layout Enumerate
7140 file with your favorite text editor
7144 \begin_layout Enumerate
7145 remove the comment lines before the
7154 \begin_layout Enumerate
7159 usepackage...{fontenc}
7161 line if it appears (usually just after
7176 \begin_layout Enumerate
7177 remove everything between (and including) the
7189 commands, except for any commands you specifically put into the LaTeX preamble
7190 (which should appear immediately after the
7191 \begin_inset Quotes eld
7194 User specified LaTeX commands
7195 \begin_inset Quotes erd
7206 \begin_layout Enumerate
7207 Run the resulting file through LaTeX to make sure it still processes correctly.
7210 \begin_layout Enumerate
7211 Reread the journal requirements to make sure your filenames and formats
7215 \begin_layout Enumerate
7219 \begin_layout Subsection
7220 Comments On Specific Commands
7223 \begin_layout Standard
7224 I will not describe the detailed usage of the individual AASTeX commands:
7225 the AASTeX User Guide (
7229 ) gives a good description of each.
7230 Thus it's probably easiest for me to go down the list as found in the guide
7231 and offer comments where necessary.
7232 So let's begin \SpecialChar \ldots{}
7236 \begin_layout Subsubsection
7237 Things that work as expected
7240 \begin_layout Standard
7244 \begin_layout Plain Layout
7256 \begin_layout Standard
7257 Because they work as you might expect, I simply list them and the section
7358 begin{thebibliography}
7366 (2.13.2), all the cite commands and their variations (2.13.2), the generic
7367 graphicx figure commands (2.14.1),
7391 (2.15.4, amongst other places),
7418 \begin_layout Standard
7419 The following style options also work correctly:
7440 Simply put them in the
7446 Layout\SpecialChar \menuseparator
7452 \begin_layout Standard
7456 \begin_layout Plain Layout
7468 \begin_layout Subsubsection
7469 Things that work, but require more comment
7472 \begin_layout Standard
7473 The following items work, but require a little more discussion:
7476 \begin_layout Itemize
7477 These items are reserved for use by the journal editors, but you can put
7478 them into the LaTeX preamble if you feel compelled to do so:
7511 \begin_layout Itemize
7512 These items may be placed in the LaTeX preamble, and are included as blanks
7513 in the template file:
7534 \begin_layout Itemize
7541 (2.3) – can only be used
7542 \begin_inset Quotes eld
7546 \begin_inset Quotes erd
7549 , not in the middle of a paragraph.
7550 Use TeX code if you need to embed it.
7553 \begin_layout Itemize
7560 (2.3) – will have extra {} after it.
7561 This should not cause an error.
7564 \begin_layout Itemize
7571 (2.6) – can only be used
7572 \begin_inset Quotes eld
7576 \begin_inset Quotes erd
7579 , not in the middle of a paragraph.
7580 Use TeX code if you need to embed it.
7583 \begin_layout Itemize
7590 (2.8) – can't insert a cross-reference tag, you must type the tag name by
7594 \begin_layout Itemize
7608 \begin_layout Itemize
7615 (2.9) – will have extra {} after it.
7616 This should not cause an error.
7619 \begin_layout Itemize
7626 (2.11) – will have extra {} after it.
7627 This should not cause an error.
7630 \begin_layout Itemize
7637 (2.14.2) – you can insert an optional filename argument by placing the cursor
7638 at the beginning of the text and selecting
7640 Insert\SpecialChar \menuseparator
7645 \begin_inset Quotes eld
7649 \begin_inset Quotes erd
7652 inserts an optional argument of the type needed by
7659 Hopefully it will be renamed someday.
7662 \begin_layout Itemize
7675 for the catalog ID optional parameter
7678 \begin_layout Itemize
7691 for the catalog ID optional parameter
7694 \begin_layout Subsubsection
7695 Things not implemented, use TeX code
7698 \begin_layout Standard
7702 \begin_layout Plain Layout
7714 \begin_layout Standard
7737 setcounter{equation}
7739 (2.12), Journal name abbreviations (2.13.4),
7775 (2.15.4, insert it as the first element in the lefthand cell after where
7777 Don't use any of LyX's rules in the table),
7789 (2.15.5), much of Misc (2.17, except
7840 \begin_layout Standard
7844 \begin_layout Plain Layout
7856 \begin_layout Subsubsection
7857 Things that cannot be implemented
7860 \begin_layout Standard
7861 \SpecialChar \ldots{}
7862 at least in any meaningful sort of way, so I suggest ignoring them.
7863 They are the references environment (2.13.3), and the deluxetable environment
7865 If you really, really need to use deluxetable, I suggest editing it in
7866 a separate file with a text editor, then using
7868 Insert\SpecialChar \menuseparator
7870 \begin_inset space ~
7875 to include it in your LyX document.
7880 file to see an example of this.
7883 \begin_layout Subsection
7884 FAQs, Tips, Tricks, and Other Ruminations
7887 \begin_layout Subsubsection
7888 Getting LyX and AASTeX to cooperate
7891 \begin_layout Standard
7892 It can be a bit tricky to get LyX to recognize a new layout and document
7894 When all else fails, do this:
7897 \begin_layout Enumerate
7898 Make certain that LaTeX can find AASTeX.
7899 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7900 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7907 \begin_layout Enumerate
7919 \begin_layout Enumerate
7922 Tools\SpecialChar \menuseparator
7925 in LyX, then restart LyX.
7928 \begin_layout Enumerate
7929 Open a regular new file, not from a template.
7930 Does AASTeX appear in the class list in
7932 Document\SpecialChar \menuseparator
7938 \begin_layout Standard
7939 If you get a warning from an existing AASTeX document about not being able
7940 to find the AASTeX layout or a message about
7941 \begin_inset Quotes eld
7944 You should not mix title layouts with normal ones
7945 \begin_inset Quotes erd
7948 , things haven't been installed correctly.
7951 \begin_layout Subsubsection
7952 LaTeX error processing a table
7955 \begin_layout Standard
7956 LyX, by default, attempts to center the table caption/title.
7957 This seems to produce a bad interaction in AASTeX so you should click somewhere
7958 in the caption/title, then select
7960 Edit\SpecialChar \menuseparator
7962 \begin_inset space ~
7976 This took care of it for me.
7979 \begin_layout Subsubsection
7983 \begin_layout Standard
7984 A couple of things: 1) I have noticed some funny spacing in the reference
7985 entries in the text.
7986 When you enter the bibliography item data, make sure their is
7990 space between the last author and the parenthesis setting off the year;
7994 \begin_inset space \thinspace{}
7998 \begin_inset space \space{}
8012 2) Entering the references at all is not obvious.
8013 The easiest thing is to start typing your first reference at the end of
8014 the document, then mark it as type
8019 That will put a small gray box in front of what you just typed.
8020 Click on the box to fill in the rest of the information.
8021 For new references, go to the end of an existing reference and press return.
8022 That will create a new line with its own box, etc.
8025 \begin_layout Subsubsection
8029 \begin_layout Standard
8030 Even though AASTeX provides its own figure commands (
8036 , for example), I much prefer LaTeX's standard figure commands (with the
8045 \begin_inset space ~
8048 commands as TeX code into a Figure Float box if you desire, but I never
8049 have much luck getting the layout right.
8050 With the standard graphics, LyX will insert a
8054 usepackage{graphicx}
8056 command into the LaTeX preamble and handle the figures in the standard
8057 LaTeX2e way, interspersing the figures in the text.
8058 I believe ApJ accepts figures exactly this way now; AJ might still use
8060 \begin_inset Quotes eld
8063 stack everything at the end
8064 \begin_inset Quotes erd
8070 \begin_layout Subsubsection
8071 Things I could have done, but didn't
8074 \begin_layout Standard
8076 \begin_inset Quotes eld
8080 \begin_inset Quotes erd
8083 things I could have implemented, but chose not to.
8084 For instance, I saw no point in double-spacing the text in the LyX window,
8085 even though it is double-spaced in the paper manuscript.
8086 Also, I chose not to make separate layouts for the preprint and preprint2
8088 Since I assume you will spend most of your time in the plain manuscript
8089 mode anyway, I decided not to chew up more disk space with this.
8093 \begin_layout Subsection
8097 \begin_layout Standard
8098 Your mileage may vary.
8099 I've now had papers published by both ApJ and AJ that have had 98% of the
8100 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8102 I have had no trouble with the submission process, and I'm sure the journals
8103 were never aware that there might be a difference.
8104 So, go forth and publish!
8107 \begin_layout Section
8111 \begin_layout Standard
8114 David Johnson; updated by Richard Heck
8117 \begin_layout Standard
8118 \begin_inset VSpace bigskip
8124 \begin_layout Standard
8126 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8127 papers to be submitted to American Mathematical Society publications.
8128 The layouts are not tailored to a specific journal, but easily can be.
8129 You should refer to the AMS documentation for specific instructions for
8130 each journal (usually it will entail only changing a single line in the
8132 That documentation is available on the Web at
8133 \begin_inset Flex URL
8136 \begin_layout Plain Layout
8144 \begin_inset Flex URL
8147 \begin_layout Plain Layout
8149 ftp://ftp.ams.org/pub/tex/amslatex/
8155 These layouts are appropriate, and useful, for any mathematical writing.
8159 \begin_layout Standard
8160 There are two basic AMS LaTeX layouts:
8163 \begin_layout Itemize
8164 amsart: The standard AMS article format.
8167 \begin_layout Itemize
8168 amsbook: the standard AMS book (really, monograph) format.
8172 \begin_layout Standard
8173 The layouts themselves contain only the minimum necessary to use the AMS
8175 They do not, in particular, contain any of the `theorem' environments used
8176 for setting theorems, lemmas, and the like.
8177 These are contained, instead, in the
8178 \begin_inset Flex CharStyle:Code
8181 \begin_layout Plain Layout
8187 module, which is loaded by default when when you select one of the AMS
8189 (It can also be used with other classes and can be removed, if you would
8190 rather use something else.) Less commonly used environments are in the
8191 \begin_inset Flex CharStyle:Code
8194 \begin_layout Plain Layout
8195 Theorems (AMS-Extended)
8200 module, which must be loaded manually.
8203 \begin_layout Standard
8204 By default, theorems and the like are numbered consecutively throughout
8205 the document, but this may be modified by loading the module
8206 \begin_inset Flex CharStyle:Code
8209 \begin_layout Plain Layout
8210 Theorems (Order by Section)
8215 or, if you are using
8216 \begin_inset Flex CharStyle:Code
8219 \begin_layout Plain Layout
8226 \begin_inset Flex CharStyle:Code
8229 \begin_layout Plain Layout
8230 Theorems (Order by Chapter)
8236 These will number the results as
8237 \begin_inset Formula $n.m$
8240 , where the first number refers to the section (or chapter) and the second
8241 refers to the total number of results so far in that section (or chapter).
8242 Many environments are also available unnumbered.
8243 These are indicated by an asterisk at the end.
8244 If you happen to want
8248 unnumbered results, the the module
8249 \begin_inset Flex CharStyle:Code
8252 \begin_layout Plain Layout
8258 provides that option.
8261 \begin_layout Standard
8262 Note that these modules do not
8266 to be used with the AMS classes.
8267 It is perfectly possible to use the
8268 \begin_inset Flex CharStyle:Code
8271 \begin_layout Plain Layout
8277 module, and the others mentioned, with other classes, such as
8278 \begin_inset Flex CharStyle:Code
8281 \begin_layout Plain Layout
8288 \begin_inset Flex CharStyle:Code
8291 \begin_layout Plain Layout
8298 \begin_inset Flex CharStyle:Code
8301 \begin_layout Plain Layout
8310 \begin_layout Subsection
8311 What these layouts provide
8314 \begin_layout Standard
8315 There is a long list of included environments provided by these layouts.
8316 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
8317 variety of `theorem' environments.
8318 However, the AMS recommends the environments that are available in LyX.
8322 \begin_layout Standard
8323 The following environments—as well as the standard environments, such as
8325 \begin_inset Flex CharStyle:Noun
8328 \begin_layout Plain Layout
8335 \begin_inset Flex CharStyle:Noun
8338 \begin_layout Plain Layout
8345 \begin_inset Flex CharStyle:Noun
8348 \begin_layout Plain Layout
8355 \begin_inset Flex CharStyle:Noun
8358 \begin_layout Plain Layout
8365 \begin_inset Flex CharStyle:Noun
8368 \begin_layout Plain Layout
8375 \begin_inset Flex CharStyle:Code
8378 \begin_layout Plain Layout
8385 \begin_inset Flex CharStyle:Code
8388 \begin_layout Plain Layout
8397 \begin_layout Description
8398 Address This should be the author's permanent address.
8401 \begin_layout Description
8403 \begin_inset space ~
8406 Address This should be the author's temporary address at the time of submission,
8407 if different from the Address.
8410 \begin_layout Description
8411 Email Author's e-mail address
8414 \begin_layout Description
8415 URL Author's Web address, if desired.
8418 \begin_layout Description
8419 Keywords Key words or phrases used to identify specific topics discussed
8423 \begin_layout Description
8424 Subjectclass These refer to the AMS Subject Classifications, published and
8427 Mathematical Reviews
8430 These are also available online at the AMS cites listed above.
8433 \begin_layout Description
8437 \begin_layout Description
8441 \begin_layout Description
8445 \begin_layout Standard
8446 The following environments are provided by both the
8447 \begin_inset Flex CharStyle:Code
8450 \begin_layout Plain Layout
8457 \begin_inset Flex CharStyle:Code
8460 \begin_layout Plain Layout
8466 modules, in the latter case in both starred (unnumbered) and unstarred
8467 (numbered) versions.
8468 These same environments are provided only in the starred versions by the
8470 \begin_inset Flex CharStyle:Code
8473 \begin_layout Plain Layout
8482 \begin_layout Theorem
8483 This is typically used for the statements of major results.
8487 \begin_layout Corollary*
8488 This is used for statements which follow fairly directly from previous statement
8490 Again, these can be major results.
8495 These are smaller results needed to prove other statements.
8498 \begin_layout Proposition
8499 These are less major results which (hopefully) add to the general theory
8503 \begin_layout Conjecture
8504 These are statements provided without justification, which the author does
8505 not know how to prove, but which seem to be true (to the author, at least).
8508 \begin_layout Definition*
8509 Guess what this is for.
8510 The font is different for this environment than for the previous ones.
8514 \begin_layout Example*
8515 Used for examples illustrating proven results.
8518 \begin_layout Problem
8519 It's not really known what this is for.
8520 You should figure it out.
8523 \begin_layout Exercise*
8524 Write a description for this one.
8527 \begin_layout Remark
8528 This environment is also a type of theorem, usually a lesser sort of observation.
8531 \begin_layout Claim*
8532 Often used in the course of giving a proof of a larger result.
8536 Generally, these are used to break up long arguments, using specific instances
8542 The numbering scheme for cases is on its own, not together with other numbered
8548 At the end of this environment, a QED symbol (usually a square, but it can
8549 vary with different styles) is placed.
8550 If you want to have other environments within this one—for example, Case
8551 environments—and have the QED symbol appear only after them, then the other
8552 environments need to be nested within the proof environment.
8555 Nesting Environments
8561 for information on nesting.
8564 \begin_layout Standard
8565 And these environments are provided by
8566 \begin_inset Flex CharStyle:Code
8569 \begin_layout Plain Layout
8570 Theorems (AMS-Extended)
8578 \begin_layout Criterion*
8579 A required condition.
8582 \begin_layout Algorithm*
8583 A general procedure to be used.
8586 \begin_layout Axiom*
8587 This is a property or statement taken as true within the system being discussed.
8590 \begin_layout Condition*
8591 Sometimes used to state a condition assumed within the present context of
8596 Similar to a Remark.
8599 \begin_layout Notation*
8600 Used for the explanation of, yes, notation.
8603 \begin_layout Summary
8604 Do we really need to tell you?
8607 \begin_layout Acknowledgement*
8611 \begin_layout Conclusion*
8612 Sometimes used at the end of a long train of argument.
8616 Used in a way similar to Proposition, though perhaps lower on the scale.
8619 \begin_layout Standard
8620 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8622 They need to be available on your system in order to use these environments.
8625 \begin_layout Section
8633 \begin_layout Standard
8639 \begin_layout Subsection
8643 \begin_layout Standard
8644 These are the layout files for some of the journals of the American Geophysical
8646 It is assumed that you have both the AGU's own class files and AGUplus
8647 installed (everything to be found at
8648 \begin_inset Flex URL
8651 \begin_layout Plain Layout
8653 ftp://ftp.agu.org/journals/latex/journals
8661 \begin_layout Subsection
8665 \begin_layout Standard
8675 They are still called this in the LyX GUI, though their LaTeX equivalents
8676 in the AGU classes are
8687 \begin_layout Standard
8688 Newly defined styles are
8725 These are mostly manuscript attributes and defined in the AGU class documentati
8729 \begin_layout Standard
8730 I suspect this is still badly incomplete.
8733 \begin_layout Subsection
8737 \begin_layout Standard
8754 \begin_layout Subsection
8758 \begin_layout Itemize
8761 Journal of Geophysical Research
8770 \begin_layout Standard
8771 Add your own, it isn't so hard! Look at the
8782 \begin_layout Subsection
8783 Bugs and things to remember
8786 \begin_layout Standard
8787 In order to use the new layouts, you must remember to do the following for
8791 \begin_layout Enumerate
8797 This can be done in the
8799 Layout\SpecialChar \menuseparator
8804 Document\SpecialChar \menuseparator
8808 (AGU articles are always in English, right? So
8815 \begin_layout Enumerate
8825 (Yes, this is a bug.)
8828 \begin_layout Enumerate
8829 Make sure you use the
8833 bibliography style, by entering
8837 into the second field of the BibTeX inset.
8838 None of the standard styles will do.
8841 \begin_layout Section
8845 \begin_layout Standard
8851 \begin_layout Subsection
8855 \begin_layout Standard
8856 Broadway is for writing plays.
8857 The format is more decorative than Hollywood, and much less standardized.
8858 This format should be suitable for workshops.
8861 \begin_layout Subsection
8865 \begin_layout Standard
8866 The same as in Hollywood.
8869 \begin_layout Subsection
8873 \begin_layout Standard
8878 names as labels then cross-reference the label to insert the name.
8879 The cross-reference dialog will show the current cast of characters.
8882 \begin_layout Subsection
8883 Paper size and Margins
8886 \begin_layout Standard
8887 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8890 \begin_layout Subsection
8894 \begin_layout Standard
8895 The following environments are available.
8896 You can use broadway.bind to get the bind keys shown at the right.
8899 \begin_layout Itemize
8903 \begin_inset Newline newline
8908 You should not have to use this, but it is here for anything that does not
8912 \begin_layout Itemize
8916 \begin_inset space \hfill{}
8920 \begin_inset Newline newline
8925 Used to describe stage setting and the action.
8926 First use of speaker names in all CAPs.
8929 \begin_layout Itemize
8933 \begin_inset space \hfill{}
8937 \begin_inset Newline newline
8942 Automatically numbered.
8943 On screen it will be arabic, but will print as Roman.
8946 \begin_layout Itemize
8950 \begin_inset space \hfill{}
8954 \begin_inset Newline newline
8964 It is just centered text.
8967 \begin_layout Itemize
8971 \begin_inset space \hfill{}
8975 \begin_inset Newline newline
8980 Not automatically numbered.
8981 You supply the number.
8982 This is because I couldn't figure out how.
8985 \begin_layout Itemize
8989 \begin_inset space \hfill{}
8993 \begin_inset Newline newline
8998 A special case of Narrative to describe the setting and action as the curtain
9002 \begin_layout Itemize
9006 \begin_inset space \hfill{}
9010 \begin_inset Newline newline
9015 The speaker's (actor's) title, centered in all CAPS.
9018 \begin_layout Itemize
9022 \begin_inset space \hfill{}
9026 \begin_inset Newline newline
9031 Instructions to the speaker.
9032 The parentheses are automatically inserted.
9033 The ( will appear on screen, but both will be in the printed play.
9034 This environment is only used within
9041 \begin_layout Itemize
9045 \begin_inset space \hfill{}
9049 \begin_inset Newline newline
9054 What the Speaker says.
9057 \begin_layout Itemize
9061 \begin_inset space \hfill{}
9065 \begin_inset Newline newline
9070 The curtain comes down.
9073 \begin_layout Itemize
9077 \begin_inset space \hfill{}
9083 \begin_layout Itemize
9087 \begin_inset space \hfill{}
9093 \begin_layout Itemize
9097 \begin_inset space \hfill{}
9103 \begin_layout Standard
9107 \begin_layout Section
9111 \begin_layout Standard
9116 can be used to type letters according to German conventions.
9117 A template file is included in
9119 .../lyx/share/templates
9121 for you to use as a starting point.
9124 \begin_layout Section
9132 \begin_layout Standard
9138 \begin_layout Subsection
9142 \begin_layout Standard
9143 This is the layout file for the European Geophysical Society journals.
9148 can be downloaded from the web site of the EGS under
9149 \begin_inset Flex URL
9152 \begin_layout Plain Layout
9162 \begin_layout Subsection
9166 \begin_layout Standard
9169 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9177 The current layout file is unfortunately very unmodular and would benefit
9178 from using the various
9185 \begin_layout Section
9189 \begin_layout Standard
9195 \begin_layout Standard
9196 Elsevier Science Publishers B.V.
9197 provides a standard LaTeX document class (
9201 ) for submitting articles to their various journals.
9202 The style file can be downloaded directly from their web site:
9203 \begin_inset Flex URL
9206 \begin_layout Plain Layout
9208 http://authors.elsevier.com/
9214 Instructions are supplied along with the class file, which details the
9215 requirements of the publishers.
9216 LyX includes package that allows for the use of this class, by a layout
9217 and a template file.
9218 Installation of the class file is the same as for any other LaTeX package;
9219 instructions are provided in the Elsevier documentation.
9222 \begin_layout Standard
9232 As the Elsevier class file is based mainly on the standard article class,
9233 most of the normal functionality is provided.
9234 The Elsevier class defines a number of mathematical environments, which
9235 are similar to the AMS environments.
9236 These commands are all described in the Elsevier documentation, and are
9240 \begin_layout Standard
9241 The easiest way to use the Elsevier style is to base documents on the included
9243 It is best not to use options such as fancy headings or the geometry package,
9244 as elements such as these are defined by Elsevier in their style file.
9245 Ideally, no extra packages except those mentioned in the Elsevier documentation
9247 Essentially, Elsevier require as
9248 \begin_inset Quotes eld
9252 \begin_inset Quotes erd
9255 a LaTeX file as possible, as their intention is to take the supplied file
9256 and replace the class file with one for the particular journal to which
9257 the paper has been submitted.
9258 This also means that not too much time should be spent on the formating
9260 When it comes to be published, this will change anyway.
9261 The rest of the usage for this layout is substantially the same as for
9262 the normal article class.
9263 For details of what Elsevier do and don't allow, refer to their documentation.
9266 \begin_layout Section
9272 \begin_inset CommandInset label
9281 \begin_layout Standard
9287 \begin_layout Subsection
9291 \begin_layout Standard
9292 This section describes how to use LyX to make slides for overhead projectors.
9293 There are two document classes that can do this: the default slides class
9299 This section documents the latter.
9302 \begin_layout Standard
9303 I'm going to say this again, nice and clear, so that there's no misunderstanding
9307 \begin_layout Standard
9308 \begin_inset VSpace bigskip
9314 \begin_layout Standard
9318 This section documents the class
9319 \begin_inset Quotes eld
9327 \begin_inset Quotes erd
9335 \begin_layout Standard
9336 \begin_inset VSpace bigskip
9342 \begin_layout Standard
9343 If you're looking for the documentation for
9344 \begin_inset Quotes eld
9352 \begin_inset Quotes erd
9356 \begin_inset space ~
9360 \begin_inset CommandInset ref
9362 reference "sec:slitex"
9367 If your machine doesn't have the
9372 \begin_inset Quotes eld
9380 \begin_inset Quotes erd
9383 ] installed, you'll probably have to use the default
9387 class, which isn't quite as good as
9392 \begin_layout Standard
9397 class is designed for use with version 2.1 of the
9401 LaTeX class file which is now an integral part of LaTeX2e.
9404 \begin_layout Subsection
9408 \begin_layout Standard
9409 Obviously, to use this document class, you need to select
9410 \begin_inset Quotes eld
9418 \begin_inset Quotes erd
9428 \begin_inset space ~
9434 There are some settings in the
9437 \begin_inset space ~
9442 dialog that you should know about that are specific to this class:
9445 \begin_layout Itemize
9446 Don't change the options
9457 \begin_inset space ~
9463 They're ignored by the
9470 \begin_layout Itemize
9471 The default font size is 20
9472 \begin_inset space \thinspace{}
9475 pt with the other options being 17
9476 \begin_inset space \thinspace{}
9480 \begin_inset space \thinspace{}
9484 \begin_inset space \thinspace{}
9490 \begin_layout Itemize
9499 but all math equations are still typeset in the usual roman font.
9502 \begin_layout Itemize
9507 supports A4 and Letter paper sizes as well as a special size for working
9509 \begin_inset space \thinspace{}
9513 It doesn't support A5, B5, legal or executive paper sizes.
9516 \begin_layout Itemize
9517 Don't bother changing the
9521 settings because they are ignored anyway.
9522 All floats appear where they are defined in the text.
9525 \begin_layout Itemize
9530 setting behaves a bit differently for this class.
9535 provides extensive footer and header capabilities including a user-defined
9538 \begin_inset space ~
9542 \begin_inset CommandInset ref
9544 reference "sec:foilfoot"
9549 The title page is treated differently to all other pages in the document
9558 has the logo centered at the bottom of the page (if one is defined).
9559 The possible page style choices and what they do are as follows:
9563 \begin_layout Labeling
9564 \labelwidthstring MMMMMMM
9571 The final output contains no page numbers, or other headers or footers
9572 (except footnotes of course).
9576 \begin_layout Labeling
9577 \labelwidthstring MMMMMMM
9584 The final output contains page numbers centered at the bottom of the page.
9585 No other headings or footers (other than footnotes).
9588 \begin_layout Labeling
9589 \labelwidthstring MMMMMMM
9594 Page numbers in lower right corner.
9595 Additional headers and footers are also shown.
9596 This is also the default.
9599 \begin_layout Labeling
9600 \labelwidthstring MMMMMMM
9605 Gives you access to the
9609 package although its use with
9613 is discouraged by the writer of the
9617 package because of some potential page layout clashes.
9621 \begin_layout Subsubsection
9625 \begin_layout Standard
9626 The following options may be used in the extra class options in the
9628 Document\SpecialChar \menuseparator
9634 \begin_layout Labeling
9635 \labelwidthstring MMMMMMx
9640 This sets up the page layout for 7.33
9641 \begin_inset space \thinspace{}
9645 \begin_inset space \thinspace{}
9648 in paper, which is about the same aspect ratio as a 35
9649 \begin_inset space \thinspace{}
9652 mm slide, making it a bit easier to work with this medium.
9655 \begin_layout Labeling
9656 \labelwidthstring MMMMMMx
9661 Places a rule across the page below the header on every page except the
9665 \begin_layout Labeling
9666 \labelwidthstring MMMMMMx
9671 Places a rule across the page above the footer on every page except the
9675 \begin_layout Labeling
9676 \labelwidthstring MMMMMMx
9681 This is automatically set each time you create a new
9690 to use the dvips driver to rotate those pages that are set as landscape
9694 \begin_layout Labeling
9695 \labelwidthstring MMMMMMx
9700 Simply changes the page dimensions to those of a landscape page but doesn't
9702 Thus if you use this option you need to use an external program to rotate
9703 each page or feed your paper through your printer as landscape.
9704 Note that this option effectively reverses the roles of the
9712 environments (don't worry these are described in the next section).
9715 \begin_layout Labeling
9716 \labelwidthstring MMMMMMx
9721 Equation numbers on the left.
9724 \begin_layout Labeling
9725 \labelwidthstring MMMMMMx
9730 Flush-left equations.
9733 \begin_layout Subsection
9734 Supported Environments
9737 \begin_layout Standard
9738 Most of the environments commonly supported in other classes are also supported
9744 There are several additional environments provided by
9748 as well as a couple added by LyX.
9749 The following environments are shared with other classes:
9752 \begin_layout Standard
9756 \begin_layout Plain Layout
9768 \begin_layout Itemize
9774 \begin_layout Itemize
9780 \begin_layout Itemize
9786 \begin_layout Itemize
9792 \begin_layout Itemize
9798 \begin_layout Itemize
9804 \begin_layout Itemize
9810 \begin_layout Itemize
9816 \begin_layout Itemize
9822 \begin_layout Itemize
9828 \begin_layout Itemize
9834 \begin_layout Itemize
9840 \begin_layout Itemize
9846 \begin_layout Itemize
9852 \begin_layout Itemize
9858 \begin_layout Itemize
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Standard
9880 \begin_layout Plain Layout
9892 \begin_layout Standard
9893 That is, all the major environments apart from the sectioning environments.
9894 Since foils are essentially self-contained sections, with a title and body,
9899 provides specific commands for starting new foils and these are:
9902 \begin_layout Itemize
9908 \begin_layout Itemize
9914 \begin_layout Standard
9915 LyX also provides slightly modified versions of these two environments called:
9918 \begin_layout Itemize
9924 \begin_layout Itemize
9930 \begin_layout Standard
9931 and the differences will be explained in the next section.
9934 \begin_layout Standard
9935 Since foils are often used in presenting ideas or new theorems and such
9940 also provides a comprehensive box of goodies for presenting them:
9943 \begin_layout Standard
9947 \begin_layout Plain Layout
9959 \begin_layout Itemize
9965 \begin_layout Itemize
9971 \begin_layout Itemize
9977 \begin_layout Itemize
9983 \begin_layout Itemize
9989 \begin_layout Itemize
9995 \begin_layout Itemize
10001 \begin_layout Itemize
10007 \begin_layout Itemize
10013 \begin_layout Itemize
10019 \begin_layout Itemize
10025 \begin_layout Standard
10029 \begin_layout Plain Layout
10041 \begin_layout Standard
10042 The starred versions are unnumbered while the unstarred versions are numbered.
10043 There are also two list environments added by LyX and these are:
10046 \begin_layout Itemize
10052 \begin_layout Itemize
10058 \begin_layout Standard
10063 provides some powerful header and footer capabilities that are best set
10064 in the preamble although they may be set at any point in a document.
10065 If you want to change these settings in your document the best place to
10066 do so is at the very top of a foil, i.
10067 \begin_inset space \thinspace{}
10073 \begin_inset space \space{}
10078 straight after the foilhead.
10081 \begin_layout Standard
10082 For this purpose, the following command styles are provided [
10089 \begin_layout Standard
10093 \begin_layout Plain Layout
10097 begin{multicols}{2}
10105 \begin_layout Itemize
10109 \begin_inset space ~
10115 \begin_layout Itemize
10121 \begin_layout Itemize
10125 \begin_inset space ~
10131 \begin_layout Itemize
10135 \begin_inset space ~
10141 \begin_layout Itemize
10145 \begin_inset space ~
10152 \begin_layout Standard
10153 \begin_inset space ~
10160 \begin_layout Standard
10164 \begin_layout Plain Layout
10176 \begin_layout Standard
10177 There are also a few commands provided by
10181 that aren't directly supported by LyX but I'll tell you what they do and
10182 how to use them in section
10183 \begin_inset space ~
10187 \begin_inset CommandInset ref
10189 reference "sec:unsuppfoils"
10196 \begin_layout Subsection
10197 Building a Set of Foils
10200 \begin_layout Standard
10201 This section will give a simple introduction to using the different environments
10202 to build a set of foils.
10203 If you want to see an example set of foils, take a look at the
10207 file you find in LyX's
10214 \begin_layout Subsubsection
10215 Give It a Title Page
10218 \begin_layout Standard
10219 Unlike other classes that provide
10239 creates the title on a page of its own.
10240 If you leave out the
10244 environment LaTeX will substitute the current date (every time you regenerate
10248 \begin_layout Subsubsection
10252 \begin_layout Standard
10253 As I mentioned earlier, there are four ways of starting a new foil.
10254 For portrait foils you should use
10263 The difference between these two environments is the amount of space between
10264 the title of the foil (the foilhead) and the body of the foil.
10267 \begin_layout Standard
10268 Landscape foils are generated using the
10274 ShortRotatefoilhead
10277 Again the only difference is the spacing between foilhead and body.
10278 Both of the short versions have 0.5 inches less separation between the foilhead
10283 \begin_layout Standard
10284 One problem with the support for landscape foils is the requirement that
10285 you have to use the
10289 driver to generate the PostScript output otherwise the foils won't be rotated.
10290 It is possible to get landscape foils even if you haven't got the
10294 driver provided you can feed your foils sideways through your printer ;-)
10297 \begin_layout Subsubsection
10298 Theorems, Lemmas, Proofs and more
10301 \begin_layout Standard
10302 Due to a small bug in LyX you can't have two of the same type of these environme
10303 nts directly following each other.
10304 They must be separated by something.
10305 If you try, you will just be extending the previous environment as if you
10306 had merged the two environments together.
10307 So, how do you get around this problem? The simplest option is to insert
10308 some text between the two environments or add a
10312 environment between the two with just a
10313 \begin_inset Quotes eld
10321 \begin_inset Quotes erd
10325 This will force LyX to produce two separate environments and hence the
10326 correct LaTeX output.
10327 An example is provided in the example file included with the LyX distribution.
10328 Remember, this problem only occurs if you are trying to place two of the
10329 same type of theorem-like environments one directly after the other.
10332 \begin_layout Subsubsection
10336 \begin_layout Standard
10337 You get all the commonly supported list styles found in other classes as
10338 well as two new ones.
10339 I'll only describe the new ones here.
10340 If you want to find out more about the other list environments check out
10346 If you intend to use itemized lists you might also want to read about the
10350 \begin_inset space ~
10354 \begin_inset space ~
10359 dialog described above in section
10360 \begin_inset space ~
10364 \begin_inset CommandInset ref
10366 reference "sec:bullet"
10373 \begin_layout Standard
10374 The two new list styles,
10382 , are designed to make it easier for you to create lists of do's and don'ts
10383 or right and wrong by providing dedicated environments that use a tick
10384 or a cross as the label of the list.
10385 These lists are in fact dedicated variants of the
10390 They do however require that you have the
10394 packages installed.
10397 \begin_layout Subsubsection
10401 \begin_layout Standard
10406 redefines the floating tables and figures so that they appear exactly where
10407 they are in the text rather than pushing them to the top of the page or
10408 to some user specified location.
10409 In fact if you change the float placement settings they are simply ignored.
10412 \begin_layout Subsubsection
10413 Page Headers and Footers
10414 \begin_inset CommandInset label
10416 name "sec:foilfoot"
10423 \begin_layout Standard
10427 \begin_inset space ~
10436 are two commands used to control the left-footer text string.
10437 The first is meant to allow you to include a graphic logo on your foils
10439 \begin_inset Quotes eld
10447 \begin_inset Quotes erd
10451 While the second is meant to provide a classification for the audience,
10455 \begin_inset space \thinspace{}
10461 \begin_inset space \space{}
10465 It is empty by default.
10468 \begin_layout Standard
10469 The remaining page corners can be filled by
10472 \begin_inset space ~
10477 (which defaults to page numbers),
10480 \begin_inset space ~
10488 \begin_inset space ~
10496 \begin_layout Subsection
10502 \begin_inset CommandInset label
10504 name "sec:unsuppfoils"
10511 \begin_layout Standard
10512 All the commands mentioned below need to be set in a
10520 within another environment.
10523 \begin_layout Subsubsection
10527 \begin_layout Standard
10528 All lengths are adjusted using the
10551 should be replaced by the name given to the length you want to change and
10556 is the length value.
10557 All lengths should be specified in units of length such as inches (
10569 ) or relative to some document or font-based length such as
10579 \begin_layout Standard
10580 It's possible to change the spacing between a foilhead and the body of the
10581 foil by adjusting the length specified by
10588 For example, to make
10593 \begin_inset space \space{}
10596 in closer to their bodies put the following in the preamble:
10602 foilheadskip}{-0.5in}
10605 \begin_layout Standard
10606 The spacings around floats can be adjusted by setting these lengths:
10609 \begin_layout Labeling
10610 \labelwidthstring MMMMMMMMMMM
10617 Separation between the text and the top of the float
10620 \begin_layout Labeling
10621 \labelwidthstring MMMMMMMMMMM
10628 Separation between the float and the caption
10631 \begin_layout Labeling
10632 \labelwidthstring MMMMMMMMMMM
10639 Separation between the caption and the following text
10642 \begin_layout Labeling
10643 \labelwidthstring MMMMMMMMMMM
10650 You can make the captions narrower than the surrounding text by adjusting
10652 Best done relative to
10661 \begin_layout Standard
10662 There are also several title page related lengths that you may find useful
10663 if you have a long title or several authors:
10666 \begin_layout Labeling
10667 \labelwidthstring MMMMMMMMMMM
10674 Separation from headers to
10679 \begin_layout Labeling
10680 \labelwidthstring MMMMMMMMMMM
10698 \begin_layout Labeling
10699 \labelwidthstring MMMMMMMMMMM
10713 \begin_layout Labeling
10714 \labelwidthstring MMMMMMMMMMM
10730 \begin_layout Labeling
10731 \labelwidthstring MMMMMMMMMMM
10747 \begin_layout Standard
10748 The last length related command affects all the list environments.
10759 a list environment then all the vertical spacing between the list items
10761 Note that this is a command not a length so it doesn't require
10767 like the stuff mentioned above.
10770 \begin_layout Subsubsection
10771 Headers and Footers
10774 \begin_layout Standard
10787 commands control whether the logo in the
10791 definition appear on a given page.
10798 in the preamble then none of the foils will have the logo on them.
10799 If you don't want the logo on a particular page place the
10805 directly after the foilhead of that page and the
10811 directly after the next foilhead.
10814 \begin_layout Standard
10815 If you decide to use the
10819 page style setting in the
10822 \begin_inset space ~
10827 dialog you should probably add
10837 to your preamble so headers and footers on landscape pages are correctly
10838 placed when rotated.
10839 This is due to some clashes between the page layouts provided by the
10850 \begin_layout Section
10851 Hollywood (Hollywood spec scripts)
10854 \begin_layout Standard
10860 \begin_layout Subsection
10864 \begin_layout Standard
10865 Getting the format of a Hollywood script right is a
10866 \begin_inset Quotes eld
10870 \begin_inset Quotes erd
10873 It is designed to make the readers focus on content and to be easy and
10874 familiar for the actors to read.
10875 Each page of a script should be one minute of film.
10876 Nothing goes in a script that you cannot see or hear on screen.
10877 The courier 12 pt font should be used throughout.
10881 \begin_layout Subsection
10885 \begin_layout Standard
10886 Speakers' lines should NEVER break in mid-sentence.
10887 If a speaker's lines continue over a page break, repeat the
10891 title followed by (Cont'd).
10894 \begin_layout Subsection
10898 \begin_layout Standard
10903 names as labels then cross-reference the label to insert the name.
10904 The cross-reference dialog will show the current cast of characters.
10905 You can use this to insert the speaker name in narratives also.
10908 \begin_layout Subsection
10909 Paper size and Margins
10912 \begin_layout Standard
10913 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10916 \begin_layout Subsection
10920 \begin_layout Standard
10921 The following environments are available.
10922 You can use hollywood.bind to get the bind keys shown at the right.
10925 \begin_layout Itemize
10929 \begin_inset Newline newline
10934 Used where nothing else works.
10938 \begin_layout Itemize
10944 \begin_inset space \hfill{}
10952 \begin_inset Newline newline
10955 Usually followed by something like
10956 \begin_inset Quotes eld
10959 on Sally waking up.
10960 \begin_inset Quotes erd
10966 \begin_layout Itemize
10970 \begin_inset space \hfill{}
10974 \begin_inset Newline newline
10979 Introduces a new INTERIOR camera set-up.
10980 Always followed by DAY or NIGHT, or something similar to define the lighting
10982 Everthing on this line in CAPS.
10985 \begin_layout Itemize
10989 \begin_inset space \hfill{}
10993 \begin_inset Newline newline
10998 Introduces a new EXTERIOR camera set-up.
10999 Everthing on this line in CAPS.
11002 \begin_layout Itemize
11006 \begin_inset space \hfill{}
11010 \begin_inset Newline newline
11015 The character speaking.
11018 \begin_layout Itemize
11022 \begin_inset space \hfill{}
11026 \begin_inset Newline newline
11031 Instructions to the speaker.
11032 The () are automatically inserted, but only the ( will show in LyX.
11033 Both will be printed.
11036 \begin_layout Itemize
11040 \begin_inset space \hfill{}
11044 \begin_inset Newline newline
11056 \begin_layout Itemize
11060 \begin_inset space \hfill{}
11064 \begin_inset Newline newline
11069 Camera movement instruction.
11071 \begin_inset space \thinspace{}
11075 \begin_inset space \space{}
11081 \begin_layout Itemize
11085 \begin_inset space \hfill{}
11091 \begin_layout Itemize
11095 \begin_inset space \hfill{}
11101 \begin_layout Itemize
11105 \begin_inset space \hfill{}
11111 \begin_layout Itemize
11115 \begin_inset space \hfill{}
11121 \begin_layout Subsection
11125 \begin_layout Itemize
11129 \begin_layout Itemize
11133 \begin_layout Itemize
11135 \begin_inset space \thinspace{}
11142 \begin_layout Itemize
11147 \begin_layout Itemize
11148 PAN — camera movement
11151 \begin_layout Itemize
11152 INSERT — cut to close-up of
11155 \begin_layout Section
11159 \begin_layout Standard
11162 Panayotis Papasotiriou
11165 \begin_layout Subsection
11169 \begin_layout Standard
11170 The ijmpc package is a set of macros that facilitates electronic manuscript
11173 International Journal of Modern Physics C
11176 Similarly, the ijmpd package is for creating manuscripts to be submitted
11179 International Journal of Modern Physics D
11182 Both journals are published by World Scientific.
11183 The corresponding document classes are named
11192 These files, together with instructions for the authors, can be downloaded
11194 \begin_inset Flex URL
11197 \begin_layout Plain Layout
11199 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11205 \begin_inset Flex URL
11208 \begin_layout Plain Layout
11210 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11216 Both packages are modified versions of the standard
11217 \begin_inset Quotes eld
11221 \begin_inset Quotes erd
11224 package, and they are almost (but not exactly) identical.
11225 Most of their features are supported by LyX.
11226 I have used LyX successfully to write articles submitted to both journals
11227 without any problem.
11230 \begin_layout Subsection
11234 \begin_layout Standard
11235 As usual, the easiest way to write a paper is to start with a template.
11238 File\SpecialChar \menuseparator
11257 This will give an (almost) empty document that includes the most common
11258 fields found in a manuscript.
11259 Simply overwrite the existing text (including the brackets,
11264 You should keep in mind the following remarks.
11267 \begin_layout Enumerate
11268 LyX won't let you change the font size and the page style of the document,
11269 because such modifications are not allowed by both packages.
11272 \begin_layout Enumerate
11273 The language of the document should not be changed.
11274 Before previewing your paper, be sure that the babel package is not used.
11275 To do this, click on
11277 Tools\SpecialChar \menuseparator
11288 checkbox in the language settings, and click on
11296 , if you wish to make this change permanent).
11299 \begin_layout Enumerate
11301 \begin_inset Quotes eld
11305 \begin_inset Quotes erd
11308 style must be used to define keywords.
11311 \begin_layout Enumerate
11312 The ijmpc package provides a style named
11313 \begin_inset Quotes eld
11316 Classification Codes
11317 \begin_inset Quotes erd
11320 , which can be used to define classification codes, such as PACS numbers.
11321 Note that this facility is not supported by the ijmpd package.
11324 \begin_layout Enumerate
11325 Several new environments are available:
11326 \begin_inset Quotes eld
11330 \begin_inset Quotes erd
11334 \begin_inset Quotes eld
11338 \begin_inset Quotes erd
11342 \begin_inset Quotes eld
11346 \begin_inset Quotes erd
11350 \begin_inset Quotes eld
11354 \begin_inset Quotes erd
11358 \begin_inset Quotes eld
11362 \begin_inset Quotes erd
11366 \begin_inset Quotes eld
11370 \begin_inset Quotes erd
11374 \begin_inset Quotes eld
11378 \begin_inset Quotes erd
11382 \begin_inset Quotes eld
11386 \begin_inset Quotes erd
11390 \begin_inset Quotes eld
11394 \begin_inset Quotes erd
11398 \begin_inset Quotes eld
11402 \begin_inset Quotes erd
11406 \begin_inset Quotes eld
11410 \begin_inset Quotes erd
11414 \begin_inset Quotes eld
11418 \begin_inset Quotes erd
11422 \begin_inset Quotes eld
11426 \begin_inset Quotes erd
11430 \begin_inset Quotes eld
11434 \begin_inset Quotes erd
11438 Their use is more or less obvious.
11439 LyX supports all these environments; it will use the proper label, text
11440 style, and numbering scheme for each of them.
11443 \begin_layout Enumerate
11444 Both packages use basic citations; the natbib package should not be used.
11445 In LyX, citation references are shown as usual; in the output, citations
11446 are shown as superscripts.
11447 If you want to use a citation as normal text, you should use the
11452 \begin_inset space \thinspace{}
11456 \begin_inset space \space{}
11460 \begin_inset Quotes eld
11464 \begin_inset space \space{}
11474 \begin_inset Quotes erd
11480 \begin_layout Enumerate
11482 \begin_inset Quotes eld
11486 \begin_inset Quotes erd
11489 section in both packages.
11490 To put acknowledgments, just use the
11491 \begin_inset Quotes eld
11495 \begin_inset Quotes erd
11501 \begin_layout Enumerate
11502 Appendices may be added to the paper,
11506 the Acknowledgments and
11511 LyX provides a special environment, called
11512 \begin_inset Quotes eld
11516 \begin_inset Quotes erd
11519 which marks the beginning of the appendices.
11520 This environment should be left blank; it just sends a LaTeX command, but
11521 nothing is really printed.
11523 \begin_inset Quotes eld
11527 \begin_inset Quotes erd
11530 is printed with blue letters, as a signal that all sections after that
11531 point are appendices.
11532 To write an appendix, use the
11533 \begin_inset Quotes eld
11537 \begin_inset Quotes erd
11541 LyX will number each appendix with capital letters, as required by both
11544 \begin_inset Quotes eld
11548 \begin_inset Quotes erd
11555 be present before the first appendix; if not, all appendices will be numbered
11556 as normal sections in the output.
11559 \begin_layout Enumerate
11560 The ijmpc and the ijmpd packages use the
11564 command to implement table captions.
11565 As a result, a table created by LyX is printed correctly, but its caption
11567 However, you can use some TeX code to overpass this problem, so that captions
11568 are printed as expected.
11569 To do so, create a float table as usual, remove the caption, and replace
11570 it with the TeX code
11580 (sic); you must also the TeX code
11584 immediately after the tabular material.
11585 Study the example table included in the template files to see how this
11586 trick is implemented.
11587 Alternatively, If you need table captions, you should implement the whole
11592 file, then include this file to the LyX document (
11594 Insert\SpecialChar \menuseparator
11595 File\SpecialChar \menuseparator
11597 \begin_inset space ~
11603 Details on how to create a table float can be found in the files
11611 , included in the corresponding packages.
11614 \begin_layout Subsection
11615 Preparing a paper for submission
11618 \begin_layout Standard
11619 Before you submit your paper you must export the LyX document as a LaTeX
11622 File\SpecialChar \menuseparator
11623 Export\SpecialChar \menuseparator
11630 \begin_layout Plain Layout
11631 Actually you have the choice between LaTeX (plain) and pdflatex.
11632 If you intend to use pdflatex to prepare the paper, you should use the
11633 pdflatex option so that included graphics are converted to PDF format,
11634 ready for use by pdflatex.
11639 , then make the following changes to the resulting
11646 \begin_layout Enumerate
11647 Remove the comment lines before the
11656 \begin_layout Enumerate
11657 Remove everything between (and including) the
11669 commands, except for any commands you specifically put into the LaTeX preamble.
11672 \begin_layout Standard
11677 file should be saved and processed through LaTeX as many times as necessary.
11678 You may also want to check the resulting
11685 \begin_layout Subsection
11689 \begin_layout Standard
11690 The use of TeX code is reduced to two commands, which must be placed at
11691 the top of the document.
11692 If you started writing your paper by using the
11700 template, the TeX code needed is already in its place; you usually don't
11702 You may only modify the first TeX code to specify the information printed
11703 to the top of odd and even pages (authors' names and short paper's title,
11705 This TeX code must have the form
11709 markboth{Authors' Names}{Short Paper's Title}
11714 \begin_layout Section
11718 \begin_layout Standard
11724 \begin_layout Subsection
11728 \begin_layout Standard
11729 The iopart package provides a document class to create electronic manuscript
11730 submission to the journals published by the Institute of Physics.
11731 Instructions for the authors how to create a paper using the iopart class
11732 can be downloaded together with the iopart package from the site
11733 \begin_inset Flex URL
11736 \begin_layout Plain Layout
11738 ftp://ftp.iop.org/pub/journals/latex2e
11746 \begin_layout Subsection
11750 \begin_layout Standard
11751 The easiest way to write a paper is to start with the file
11755 that is available in LyX's examples files folder.
11756 Open this file, save it under a new name, and start writing.
11757 The example file explains how to use the special text environments.
11758 Here are the most important advices:
11761 \begin_layout Itemize
11762 To be able to compile your document to a PDF, PS, or DVI, assure that the
11765 Use AMS math package
11767 in the document settings under
11774 \begin_layout Itemize
11777 The title environment defines the kind of your paper.
11778 So use one of the following environments for the title:
11782 \begin_layout Itemize
11791 \begin_layout Itemize
11800 \begin_layout Itemize
11806 for a Topical review
11809 \begin_layout Itemize
11818 \begin_layout Itemize
11827 \begin_layout Itemize
11833 for a Paper (same as Title)
11836 \begin_layout Itemize
11842 for a Preliminary communication
11845 \begin_layout Itemize
11851 for a Rapid communication
11854 \begin_layout Itemize
11860 for a Letter to the editor
11864 \begin_layout Itemize
11867 All title environments except of
11871 can have an optional short title.
11874 \begin_layout Itemize
11875 There is a general title environment
11879 which is not directly supported by the LyX.
11880 This can be used as TeX code when your document doesn't fit into one of
11881 the other title types.
11884 \begin_layout Standard
11885 For more informations like hints for special table and formula formatting,
11886 look at the IOP author guidelines.
11889 \begin_layout Section
11893 \begin_layout Standard
11896 Panayotis Papasotiriou
11899 \begin_layout Subsection
11903 \begin_layout Standard
11904 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11905 that facilitates electronic manuscript submission to the journals they
11907 Most known of them (at least in my domain of interest) are
11909 Astrophysics and Space Science
11915 , but there are many others (see a complete list at
11916 \begin_inset Flex URL
11919 \begin_layout Plain Layout
11921 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11927 The Kluwer package may be downloaded from the site
11928 \begin_inset Flex URL
11931 \begin_layout Plain Layout
11933 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11939 A complete user guide is contained in that package (but it can also be
11940 downloaded separately).
11943 \begin_layout Standard
11944 LyX supports many features of the package but not everything.
11945 However, the TeX code needed is reduced to some
11946 \begin_inset Quotes eld
11950 \begin_inset Quotes erd
11953 commands of the package (see
11954 \begin_inset space ~
11958 \begin_inset CommandInset ref
11960 reference "subsec:kluwer_peculiarities"
11965 I have recently used LyX to write an article submitted to the
11967 Astrophysics and Space Science
11969 without any problem.
11972 \begin_layout Subsection
11976 \begin_layout Standard
11977 The easiest way to write a paper is to start with the Kluwer template file.
11980 File\SpecialChar \menuseparator
11992 This will give an (almost) empty document that includes the most common
11993 fields found in a manuscript and a short description of their use.
11994 As in most templates, simply overwrite the existing text (including the
11999 ) with the correct information.
12002 \begin_layout Subsection
12003 Preparing a paper for submission
12006 \begin_layout Standard
12007 As in the AASTeX package, before you submit your paper to a journal you
12009 \begin_inset Quotes eld
12013 \begin_inset Quotes erd
12019 \begin_layout Enumerate
12020 Export your paper as a LaTeX file.
12021 To do this, click on
12023 File\SpecialChar \menuseparator
12024 Export\SpecialChar \menuseparator
12031 \begin_layout Enumerate
12036 file with a text editor and make the following changes
12040 \begin_layout Enumerate
12041 remove the comment lines before the
12050 \begin_layout Enumerate
12051 remove everything between (and including) the
12063 commands, except for any commands you specifically put into the LaTeX preamble.
12066 \begin_layout Standard
12075 \begin_layout Enumerate
12080 file through LaTeX as many times as necessary (usually up to three).
12083 \begin_layout Enumerate
12089 \begin_inset space \thinspace{}
12093 \begin_inset space \space{}
12100 , and check if everything is OK (it should, if you didn't make any mistake).
12103 \begin_layout Subsection
12104 \begin_inset Quotes eld
12108 \begin_inset Quotes erd
12111 of the Kluwer package
12112 \begin_inset CommandInset label
12114 name "subsec:kluwer_peculiarities"
12121 \begin_layout Standard
12122 The Kluwer package has the following
12123 \begin_inset Quotes eld
12127 \begin_inset Quotes erd
12133 \begin_layout Enumerate
12134 It is possible to write multiple articles in the same LaTeX file
12138 \begin_layout Plain Layout
12139 I can't imagine any good reason to do this.
12145 Each article must be included in the environment
12146 \begin_inset Quotes eld
12150 \begin_inset Quotes erd
12154 Unfortunately, this environment cannot be omitted, even if you write just
12156 Therefore, each article starts with the command
12162 and, obviously, ends with the command
12169 Although this can be implemented in LyX, I didn't included it, since it
12170 looks ugly and can confuse the novice user.
12171 Therefore, you need to enter them directly and mark them as LaTeX code
12173 \begin_inset Quotes eld
12177 \begin_inset Quotes erd
12183 \begin_layout Enumerate
12184 Information given at the beginning of the article (i.
12185 \begin_inset space \thinspace{}
12189 \begin_inset space \space{}
12192 title, subtitle, author, institution, running title, running author, abstract
12193 and keywords) must be included in an environment called
12194 \begin_inset Quotes eld
12198 \begin_inset Quotes erd
12202 This is not implemented in LyX, so you must enter title, subtitle etc.
12203 \begin_inset space ~
12206 between two TeX code lines (
12221 \begin_layout Enumerate
12222 According to the user manual, the label of each bibliography item must be
12246 \begin_layout Standard
12251 template takes care of all these
12252 \begin_inset Quotes eld
12256 \begin_inset Quotes erd
12260 If you start a new paper using this template you don't need to do anything
12265 \begin_layout Enumerate
12266 don't delete the TeX code included in the template, and
12269 \begin_layout Enumerate
12270 copy the example bibliography item included in the template and modify it
12271 as necessary to enter new bibliography items.
12274 \begin_layout Section
12278 \begin_layout Standard
12284 \begin_layout Subsection
12288 \begin_layout Standard
12289 The LyX document classes
12291 article (koma-script)
12295 report (koma-script)
12313 correspond to the LaTeX document classes
12330 \begin_inset space ~
12333 of the Koma-Script family.
12334 They are replacements for the standard document classes
12350 , resp., and fit better to European typography conventions in a number of
12354 \begin_layout Itemize
12355 Standard character size is 11pt in
12357 article (koma-script)
12361 report (koma-script)
12369 letter (koma-script)
12374 \begin_layout Itemize
12375 Headings, labels of the description environment, and a number of elements
12378 letter (koma-script)
12380 document class are set in a bold sans serif font.
12384 \begin_layout Plain Layout
12385 There is a big difference between the bold sans serif old cm fonts and new
12386 ec fonts, especially in the appearance of headings.
12387 In comparison, the ec bold sans serif fonts look a bit thin.
12388 Here the LaTeX package
12396 helps to produce the
12397 \begin_inset Quotes eld
12401 \begin_inset Quotes erd
12404 appearance when using the ec fonts.
12409 The numbering of chapter headings is made in the same way as the numbering
12410 of section headings, that is without the extra line
12411 \begin_inset Quotes eld
12414 Chapter\SpecialChar \ldots{}
12416 \begin_inset Quotes erd
12420 In addition, the appearance of the headings can be modified by using a
12421 number of options (in LyX to be entered in the field
12424 \begin_inset space ~
12431 Layout\SpecialChar \menuseparator
12435 A detailed German description of these options can be found in the Koma-Script
12443 \begin_layout Itemize
12444 The main means in the Koma-Script document classes to design the type area
12453 (in LyX to be entered in the extra class options field in the dialog
12455 Document\SpecialChar \menuseparator
12459 They make a clearer modification of page margins possible as do the options
12462 Document\SpecialChar \menuseparator
12466 A detailed German description of these and other type area options can
12467 be found in the Koma-Script documentation
12474 \begin_layout Itemize
12475 The LaTeX document classes of the Koma-Script family define a number of
12476 additional commands.
12477 Those part of it which makes sense in LyX is implemented in corresponding
12481 \begin_layout Standard
12482 A detailed German description of the LaTeX document classes of the Koma-Script
12483 family can be found in the Koma-Script documentation
12491 \begin_layout Plain Layout
12492 There is an English translation
12496 , but it is not a complete one.
12501 The following sections describe only those aspects, which are relevant
12505 \begin_layout Subsection
12506 article (koma-script), report (koma-script), and book (koma-script)
12509 \begin_layout Standard
12510 The document classes
12512 article (koma-script)
12516 report (koma-script)
12526 are implemented in the layout files
12539 They contain all the paragraph types of the corresponding standard document
12552 , resp., partly modified, with the exception of the LyX specific
12556 -type, which is replaced by the new
12560 -type having the same functionality.
12565 -Type there is a number of new paragraph types added.
12572 letter (koma-script)
12577 \begin_layout Itemize
12586 : are equivalents to
12594 , resp., additionally inserting an entry in the table of contents.
12603 are not contained in
12605 article (koma-script)
12610 \begin_layout Itemize
12619 : behave exactly as
12627 , resp., additionally clearing running heads.
12632 is not contained in
12634 article (koma-script)
12640 \begin_layout Plain Layout
12653 report (koma-script)
12655 , but since this is identical to
12659 , is has not been implemented in LyX.
12667 \begin_layout Itemize
12672 : generates a heading directly above the following paragraph in the standard
12673 character size without affecting the structure of the document.
12676 \begin_layout Itemize
12685 are special captions which respect the different space settings needed
12686 for captions placed above or below an element (if you follow strict typographic
12687 rules, you might want to place table captions always above the table).
12688 You can also use the class option
12692 , which will switch
12705 You need at least Koma-Script version 2.8q to use this.
12708 \begin_layout Itemize
12713 : can be used to set a bonmot, e.
12714 \begin_inset space \thinspace{}
12718 \begin_inset space \space{}
12721 at the beginning of a chapter.
12722 If you use the optional argument (
12724 Insert\SpecialChar \menuseparator
12726 \begin_inset space ~
12731 ), you can insert the dictum's author there.
12732 Dictum and author are separated by a line.
12733 You need at least Koma-Script version 2.8q to use this.
12738 is not contained in
12740 article (koma-script)
12745 \begin_layout Standard
12746 The following types, together with the standard types
12758 , form the title area of the document.
12759 They must be entered ahead of the first
12760 \begin_inset Quotes eld
12764 \begin_inset Quotes erd
12771 \begin_layout Plain Layout
12772 The corresponding LaTeX commands must appear before the
12783 When such a type is used more than once, the latter usage overwrites the
12784 former one, that means, for every type only the latest usage is valid.
12785 The order of the different types however has, like
12797 , no effect on the appearance of the produced document.
12800 \begin_layout Itemize
12805 : produces a centered paragraph above the ordinary title (
12817 ) for the subject of the document.
12820 \begin_layout Itemize
12825 : produces a centered paragraph below the ordinary title (
12837 ) for the publishers' name.
12840 \begin_layout Itemize
12847 report (koma-script)
12853 produces a centered paragraph on its own page behind the title page, or
12856 article (koma-script)
12858 produces a centered paragraph below the ordinary title (
12874 ) for a dedication.
12877 \begin_layout Itemize
12882 : produces a left aligned paragraph above the ordinary title (
12898 ) for a document`s head.
12901 \begin_layout Itemize
12906 : produces in a double-sided print in
12908 report (koma-script)
12914 a left-aligned paragraph at the top of the title page`s back or has no
12915 effect in a single-sided print or in
12917 article (koma-script)
12922 \begin_layout Itemize
12927 : produces in a double-sided print in
12929 report (koma-script)
12935 a left-aligned paragraph at the bottom of the title page`s back or has
12936 no effect in a single-sided print or in
12938 article (koma-script)
12943 \begin_layout Itemize
12948 : produces a special
12949 \begin_inset Quotes eld
12953 \begin_inset Quotes erd
12956 page ahead of the actual document containing a paragraph without special
12960 \begin_layout Standard
12961 The layout files for the document classes
12963 article (koma-script)
12967 report (koma-script)
12973 do include the file
12978 This is thought of as a place to define your own types.
12983 in your personal layout directory and edit the file!
12986 \begin_layout Subsection
12987 letter (koma-script)
12990 \begin_layout Standard
12994 \begin_layout Plain Layout
13006 \begin_layout Standard
13010 letter (koma-script)
13012 is implemented in the layout file
13017 It contains all the paragraph types of the corresponding standard document
13022 , partly modified, with the exception of the LyX specific types
13034 type, which is replaced by the new
13039 In addition, it contains, in contrast to the standard document class, the
13057 Furthermore, there are a number of new letter specific types.
13060 \begin_layout Standard
13064 \begin_layout Plain Layout
13076 \begin_layout Standard
13077 The appearance of the letter produced by this document class can be controlled
13078 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13082 \begin_layout Plain Layout
13083 For example, the standard appearance of the letter`s heading, consisting
13084 of name and address, is quite self-willed.
13086 \begin_inset Quotes eld
13090 \begin_inset Quotes erd
13093 heading is produced by the following LaTeX commands in the preamble:
13096 \begin_layout LyX-Code
13106 \begin_layout LyX-Code
13122 \begin_layout LyX-Code
13132 \begin_layout LyX-Code
13152 A detailed German description of such LaTeX commands can be found in the
13153 Koma-Script documentation
13158 With it, the letter's author can produce his personal letter layout.
13161 \begin_layout Standard
13170 define the beginning of the letter and must be used in every letter.
13171 To emphasize them in the LyX document class, they are marked with the letter
13181 \begin_inset space ~
13184 in the left margin.
13185 It is possible to write any number of letters in one file.
13190 type produces a new letter using the same addressee and a
13194 type produces a new addressee.
13211 are ordinary paragraph types and can also be used several times in one
13212 and the same letter.
13215 \begin_layout Itemize
13220 : produces a paragraph for the addressee and implicitly defines the beginning
13224 \begin_layout Itemize
13229 : produces a paragraph for the form of address and implicitly produces a
13233 \begin_layout Itemize
13238 : produces a paragraph for a close.
13241 \begin_layout Itemize
13246 : produces a paragraph for a postscript.
13249 \begin_layout Itemize
13254 : produces a paragraph for a distribution list.
13257 \begin_layout Itemize
13262 : produces a paragraph for enclosures.
13265 \begin_layout Standard
13306 are input types provided with a label to enter information, which will
13307 be processed by the document class.
13311 \begin_layout Plain Layout
13312 It could be seen as a matter of inconsequence, that the types
13320 described above are not such input types as well.
13321 Because of the special meaning of those types, however, I have implemented
13322 them as ordinary paragraph types with a one letter mark in the left margin.
13323 Moreover, it would affect my feeling of symmetry, if the
13331 type had such a serious different appearance.
13336 The types must be used ahead of the corresponding
13343 \begin_layout Standard
13344 An implementation of these types in a WYSIWYG fashion does not seem to make
13345 sense, because the real appearance of the produced letter does not only
13346 depend on the usage of the particular type, but also on other factors.
13347 For example, a signature entered in the
13351 type will in the standard behavior appear in the produced letter only,
13352 when in the same letter also a
13357 The entered value of the
13361 type will in the standard behavior not appear in the produced letter at
13363 The possibility to design the letter`s heading freely is already indicated
13364 in a footnote above.
13367 \begin_layout Standard
13368 The input types can also be used as empty paragraphs.
13369 This makes sense e.
13370 \begin_inset space \thinspace{}
13374 \begin_inset space \space{}
13386 type is not used at all, in the standard behavior the value of the
13390 type is used as signature, whereas if an empty
13394 type is used, no signature value is defined.
13397 \begin_layout Standard
13398 By using the input types it is possible to write a letter template, containing
13399 filled input types with your personal dates (name, address, etc.) and empty
13400 input types for other dates you want to enter.
13403 \begin_layout Itemize
13408 : sender's name, in the standard behavior appears as a centered paragraph
13409 in small caps in the letter`s heading.
13412 \begin_layout Itemize
13417 : sender's signature, in the standard behavior appears below the
13426 type is used, the value of the
13430 type appears instead.
13433 \begin_layout Itemize
13438 : sender's address, in the standard behavior appears in a centered paragraph
13439 in the letter`s heading below the sender's name.
13442 \begin_layout Itemize
13447 : sender's telephone number, in the standard behavior only sets the LaTeX
13457 \begin_layout Itemize
13462 : place of the letter`s making.
13465 \begin_layout Itemize
13470 : date of the letter`s making.
13479 , in the standard behavior, produce the place and the date in a right-aligned
13480 line below the addressee's field.
13485 type is used, neither place nor date appear, independent of the value of
13495 type is used, the date of the letter `s production is used.
13498 \begin_layout Itemize
13503 : sender`s back address, in the standard behavior appears above the addressee's
13504 field in a small sans serif font.
13507 \begin_layout Itemize
13512 : special mail information, in the standard behavior appears underlined
13513 above the addressee's field below the back address.
13516 \begin_layout Itemize
13521 : additional information, in the standard behavior appears on right side
13522 below the addressee`s field.
13525 \begin_layout Itemize
13530 : the letter's title, in the standard behavior appears in a big, bold, sans
13531 serif font above the subject.
13534 \begin_layout Itemize
13539 : the letter's subject, in the standard behavior appears in a bold font
13547 \begin_layout Standard
13568 produce a business letter like line above the
13572 line containing the fields
13573 \begin_inset Quotes eld
13577 \begin_inset Quotes erd
13581 \begin_inset Quotes eld
13585 \begin_inset Quotes erd
13589 \begin_inset Quotes eld
13593 \begin_inset Quotes erd
13597 \begin_inset Quotes eld
13601 \begin_inset Quotes erd
13605 \begin_inset Quotes eld
13609 \begin_inset Quotes erd
13613 \begin_inset Quotes eld
13617 \begin_inset Quotes erd
13621 For the date field, the value of the
13627 \begin_inset Quotes eld
13630 business letter types
13631 \begin_inset Quotes erd
13634 is used, the value of the
13638 type however does not appear, but only the LaTeX variable
13645 The ordinary output of place and date in a right-aligned line below the
13646 addressee`s field is suppressed.
13647 The types are implemented as input types provided with a label and must
13648 be used ahead of the corresponding
13655 \begin_layout Itemize
13663 \begin_layout Itemize
13671 \begin_layout Itemize
13679 \begin_layout Itemize
13687 \begin_layout Itemize
13695 \begin_layout Subsection
13696 The new letter class: letter (koma-script v.2)
13699 \begin_layout Standard
13705 \begin_layout Standard
13706 \begin_inset VSpace medskip
13712 \begin_layout Standard
13714 Koma-Script version 2.8 has introduced a new letter class
13718 which supersedes the now unsupported
13723 It has — on the LaTeX side — a completely new interface and is not compatible
13724 with the old class.
13725 Therefore, LyX supports both, though it is recommended to use the new class.
13728 \begin_layout Standard
13729 This class covers the same functionality as
13731 letter (koma-script),
13734 The basic items are
13738 (receiver's address, same as
13742 in the old layout),
13755 will start a new letter (i.
13756 \begin_inset space \thinspace{}
13760 \begin_inset space \space{}
13763 you can write several letters per document).
13764 New elements are sender's
13780 and the possibility to use a
13786 Insert\SpecialChar \menuseparator
13792 \begin_layout Standard
13793 The biggest improvement is, though, that the letter's layout is configurable
13794 at almost any needs.
13795 This can be done via the preamble or with a special style file (Letter
13796 Class Option, extension
13800 ), that will be read in as a class option.
13804 \begin_layout Plain Layout
13805 The KOMA package comes with some default
13810 There is, for instance, a
13814 file that follows german typesetting rules, or a
13818 that provides the default layout of the old
13823 The latter can be loaded with the class option
13832 ayout\SpecialChar \menuseparator
13837 ocument\SpecialChar \menuseparator
13849 template that is included in LyX for examples.
13850 A detailed description is to be found in the Koma-Script documentation
13858 \begin_layout Subsection
13862 \begin_layout Standard
13863 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13867 \begin_layout Itemize
13868 The chapter number of a
13872 type appears on a line of its own above the chapter heading instead of
13873 appearing in the same line ahead of it.
13874 The cause for that is the LyX internal behavior for the labeltype
13878 in the layout file.
13881 \begin_layout Itemize
13882 The headings of the types
13890 are only put in the
13891 \begin_inset Quotes eld
13895 \begin_inset Quotes erd
13898 LaTeX table of contents, but not in the LyX table of contents (
13900 Document\SpecialChar \menuseparator
13902 \begin_inset space ~
13906 \begin_inset space ~
13914 \begin_layout Itemize
13915 The paragraphs in a
13919 document class appear in a skip separation mode, not indented.
13920 This is the standard behavior, no special LaTeX commands are needed for
13924 Document\SpecialChar \menuseparator
13927 dialog the corresponding radio button indicates
13936 value always has the effect that extra LaTeX commands are inserted in the
13937 document to produce the gap, which is not what is wanted in this case.
13940 \begin_layout Section
13941 Latex8 (IEEE Conference Papers)
13944 \begin_layout Standard
13950 \begin_layout Subsection
13954 \begin_layout Standard
13955 Since this class is specifically for writing submissions to IEEE sponsored
13956 conferences I strongly recommend that you get a copy of their Authors Kit.
13961 package and associated bibliography style file is included in the kit.
13962 The Authors Kit is usually sent out by email once your initial submission
13964 There is a lot of useful information in the Authors Kit explaining formatting
13965 restrictions and so on and I will assume you have read this since that
13966 means I don't have to repeat it all here.
13969 \begin_layout Subsection
13973 \begin_layout Standard
13974 [AR\SpecialChar \@.
13978 \begin_layout Subsection
13979 Supported Environments
13982 \begin_layout Itemize
13988 \begin_layout Itemize
13994 \begin_layout Itemize
14000 \begin_layout Itemize
14006 \begin_layout Itemize
14012 \begin_layout Itemize
14018 \begin_layout Itemize
14024 \begin_layout Itemize
14030 \begin_layout Itemize
14036 \begin_layout Subsection
14037 Differences Between Screen and Paper
14040 \begin_layout Standard
14041 There are slight differences in appearance mainly with the presentation
14042 of section counters.
14043 On screen the trailing period of the section counter is missing but it
14044 will appear in the output so don't let this worry you.
14047 \begin_layout Section
14051 \begin_layout Standard
14057 \begin_layout Subsection
14061 \begin_layout Standard
14062 Memoir is a very powerful and constantly evolving class.
14063 It has been designed with regard to fictional and non-fictional literature.
14064 Its aim is to let the user have maximum control over the typesetting of
14066 Memoir is based on the standard book class, but it can also emulate the
14067 article class (see below).
14070 \begin_layout Standard
14071 Peter Wilson, the developer of Memoir, is known as the author of lots of
14072 useful packages in the LaTeX world.
14073 Most of them have been merged with Memoir.
14074 Therefore, it is much easier to layout the table of contents, appendices,
14075 chapter designs and such.
14076 LyX, though, does not support all of these goodies natively.
14077 Some of them might be added to forthcoming releases
14081 \begin_layout Plain Layout
14082 You are invited to send suggestions to
14083 \begin_inset Flex URL
14086 \begin_layout Plain Layout
14088 lyx-devel@lists.lyx.org
14098 , lots will probably never, due to the limitations of LyX's framework.
14099 Of course you can still use all features with the help of some native LaTeX
14104 \begin_layout Plain Layout
14109 \begin_layout Plain Layout
14119 \begin_inset space ~
14123 \begin_inset CommandInset ref
14125 reference "sec:Inserting-TeX-Code"
14135 In this section, we can only list those features which are natively supported
14137 For detailed descriptions (and for the rest of features) we are recommending
14138 to have a look at the detailed manual of the Memoir class
14142 \begin_layout Plain Layout
14147 \begin_layout Plain Layout
14157 \begin_inset Flex URL
14160 \begin_layout Plain Layout
14162 CTAN:/macros/latex/memoir/memman.pdf
14172 , which is not only a user guide for the class, but also both a comprehensive
14173 description on good typesetting and a superb example for good typesetting
14177 \begin_layout Subsection
14178 Basic features and restrictions
14181 \begin_layout Standard
14182 Memoir supports basically all features of the standard book classes.
14183 There are, however, some differences, as follows:
14186 \begin_layout Description
14188 \begin_inset space ~
14191 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14194 \begin_layout Description
14196 \begin_inset space ~
14199 style: The fancy page style is not supported, due to a command clash between
14200 Memoir and the fancyhdr package (they are both defining a command with
14201 the same name, which confuses LaTeX).
14202 Instead, Memoir comes with a bunch of own page styles (see
14204 Layout\SpecialChar \menuseparator
14205 Document\SpecialChar \menuseparator
14207 \begin_inset space ~
14213 If you want to use these for the chapter pages, you have to use the command
14220 in the main text or in preamble (e.
14221 \begin_inset space \thinspace{}
14225 \begin_inset space \space{}
14232 chapterstyle{companion}
14237 \begin_layout Description
14238 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14239 an optional argument in the standard classes.
14240 With this, you can specify an alternative version of the title for the
14241 table of contents and the headers (for instance, if the title is too long).
14242 In LyX, you can do this via
14244 Insert\SpecialChar \menuseparator
14246 \begin_inset space ~
14251 at the beginning of a chapter/section.
14252 Memoir features a second optional argument and thus separates the table
14253 of contents from the header.
14254 You can define three variants of a title with this: one for the main text,
14255 one for the table of contents, and one for the headers.
14256 Simply insert two optional arguments if you need this feature, the first
14257 one containing the short title for the Table of Contents, the second one
14258 containing an alternative short title for the headers.
14261 \begin_layout Description
14262 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14263 of contents, the list of figures and the list of table start a new page
14265 Memoir does not follow this route.
14266 You have to insert a page break yourself, if you want to have one.
14269 \begin_layout Description
14270 Titlepage: For some unknown reason, Memoir uses pagination on the title
14271 page (in the standard classes, title pages are
14272 \begin_inset Quotes eld
14276 \begin_inset Quotes erd
14280 \begin_inset space \thinspace{}
14284 \begin_inset space \space{}
14288 If you want an empty title page, type
14292 aliaspagestyle{title}{empty}
14297 \begin_layout Description
14298 Article: With the class option
14304 Layout\SpecialChar \menuseparator
14305 Document\SpecialChar \menuseparator
14307 \begin_inset space ~
14312 ), you can emulate article style.
14313 That is, counters (footnotes, figures, tables etc.) will not be reset on
14314 new chapters, chapters don't start a new page (but are—in contrary to
14315 \begin_inset Quotes eld
14319 \begin_inset Quotes erd
14322 article classes—still allowed), parts, though, use their own page, as in
14326 \begin_layout Description
14327 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14328 font commands, which have been used in the old LaTeX version 2.09 (e.
14329 \begin_inset space \thinspace{}
14333 \begin_inset space \space{}
14349 It produces an error and stops LaTeX whenever such a command appears.
14354 reallows the commands and spits out warnings instead (which does at least
14356 Since a lot of packages and particularly BibTeX style files are still using
14357 those commands, we have decided to use this option by default.
14360 \begin_layout Subsection
14364 \begin_layout Standard
14365 We will only describe the features supported by LyX (which is not much currently
14367 Please consult the Memoir manual
14371 \begin_layout Plain Layout
14376 \begin_layout Plain Layout
14386 \begin_inset Flex URL
14389 \begin_layout Plain Layout
14391 CTAN:/macros/latex/memoir/memman.pdf
14404 \begin_layout Description
14405 Abstract: You may wonder why an abstract is an extra feature.
14406 Well, it is in book class.
14407 Usually books don't have abstracts.
14408 Memoir, however, has.
14409 You can use it wherever and how often you like.
14412 \begin_layout Description
14413 Chapterprecis: You may know this from belletristic: The contents of a chapter
14414 is shortly described below the title and also in the table of contents
14416 \begin_inset space \thinspace{}
14420 \begin_inset space \space{}
14425 Our hero arrives in Troia; he loses some friends; he finds others
14428 Chapterprecis does exactly this.
14429 It is therefore only sensible below a chapter.
14432 \begin_layout Description
14433 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14434 The epigraph environment provides an elegant way of typesetting such a
14436 The motto itself (text) and its author (source) are divided by a short
14438 Unfortunately, we have to fool LyX a bit here again, since the environment
14439 needs two arguments (text and source).
14440 In this case, we have to use curly brackets (in TeX mode) between the two
14451 <author of the slogan>.
14454 \begin_layout Description
14455 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14456 complex figurative poems).
14457 LyX can only support a few of them.
14458 One is poemtitle, which is a centered title for poems, which will also
14459 be added to the table of contents (verse is the standard environment for
14461 Memoir has some enhanced versions of verse, but you need to use TeX code,
14462 because they have to be nested inside regular verse environments, which
14463 is not possible with LyX).
14466 \begin_layout Description
14467 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14470 \begin_layout Section
14471 Article (mwart), book (mwbk) and report (mwrep)
14472 \begin_inset OptArg
14475 \begin_layout Plain Layout
14488 \begin_layout Standard
14494 \begin_layout Standard
14495 The LyX document classes
14511 correspond to the LaTeX document classes
14524 They are replacements for the standard document classes
14536 , resp., and fit better to Polish typography conventions in a number of points.
14540 \begin_layout Standard
14544 \begin_layout Itemize
14545 Unnumbered titles (with star, e.
14546 \begin_inset space \thinspace{}
14550 \begin_inset space \space{}
14557 ) are added into table of contents,
14560 \begin_layout Itemize
14561 Additional page styles:
14565 \begin_layout Description
14566 uheadings header with separated lines,
14569 \begin_layout Description
14570 myheadings custom header, contents headers via commands:
14585 \begin_layout Description
14586 myuheadings custom header with separated lines,
14589 \begin_layout Description
14590 outer page number is placed on outer side of page
14594 \begin_layout Itemize
14599 \begin_layout Description
14600 rmheadings serif titles — default,
14603 \begin_layout Description
14604 sfheadings sansserif titles,
14607 \begin_layout Description
14608 authortitle on title page first placed is author next title — default,
14611 \begin_layout Description
14612 titleauthor on title page first placed is title next author,
14615 \begin_layout Description
14616 withmarginpar reserve place on page for margins.
14620 \begin_layout Section
14624 \begin_layout Standard
14629 provides an alternative to the standard
14634 It provides similar functionality, but you might prefer this layout with
14635 sans serif sections, headings, and more.
14638 \begin_layout Section
14642 \begin_layout Standard
14648 \begin_layout Standard
14649 \begin_inset VSpace bigskip
14655 \begin_layout Standard
14660 \begin_inset space ~
14665 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14666 \begin_inset Formula $\beta$
14669 release of May, 1999) class.
14672 \begin_layout Standard
14677 textclass, which works with RevTeX 3.1.
14678 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14679 That means that it doesn't interact very well with LyX, which requires
14680 LaTeX2e, although it has been kludged to work.
14681 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14685 \begin_inset space ~
14690 textclass should also be pretty easy to use.
14693 \begin_layout Standard
14694 These documents are supposed to be used in
14698 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14699 macros, and assume you'll know what to put in the preamble if necessary.
14702 \begin_layout Subsection
14706 \begin_layout Standard
14707 All you need to do is install RevTeX 4, as described in the package's README
14709 The package can be found at The RevTeX 4 Web Site
14710 \begin_inset Flex URL
14713 \begin_layout Plain Layout
14715 http://publish.aps.org/revtex4/
14721 Install it somewhere that LaTeX can see it.
14722 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14724 \begin_inset space \thinspace{}
14728 \begin_inset space \space{}
14731 not the directory where you installed the class file.) Then, if you reconfigure
14732 LyX, it will find the class file and let you use the RevTeX4 textclass.
14735 \begin_layout Standard
14736 Probably the easiest way to get started is either to import a RevTeX 4 document
14744 \begin_inset space ~
14749 template, found in the templates directory.
14752 \begin_layout Subsection
14756 \begin_layout Standard
14757 Optional arguments to
14764 \begin_inset Quotes eld
14768 \begin_inset Quotes erd
14772 \begin_inset Quotes eld
14776 \begin_inset Quotes erd
14786 \begin_inset space ~
14794 \begin_inset space ~
14800 Remember that in RevTeX, at least one optional argument is required!
14803 \begin_layout Standard
14804 Other preamble matter, like
14811 \begin_inset space ~
14817 \begin_inset space ~
14822 dialog, also as usual.
14825 \begin_layout Subsection
14829 \begin_layout Standard
14830 The layouts basically correspond to the commands in RevTeX4.0.
14831 For example, the Email layout corresponds to
14838 Note that (at least as of RevTeX 4.0 Beta), the
14846 layouts are exactly equivalent, so you shouldn't need to use both.
14850 \begin_layout Plain Layout
14851 In case you're curious, both were included so that
14855 would be able to translate both
14875 \begin_layout Subsection
14879 \begin_layout Standard
14880 There are a couple of important unique aspects of RevTeX 4 which might cause
14881 bugs that will be even more confusing in LyX.
14884 \begin_layout Standard
14902 The LyX equivalent is that there is a separate Thanks layout.
14907 write footnotes in the
14911 layout, or weird things may happen.
14912 See the RevTeX 4 documentation for more details.
14915 \begin_layout Standard
14919 \begin_inset space ~
14927 \begin_inset space ~
14936 layouts must be placed
14944 layout and the corresponding
14961 , the LaTeX won't compile.
14964 \begin_layout Subsection
14968 \begin_layout Standard
14969 The main problem with this layout is that you can't use the optional arguments
14970 to layouts like Email and Title.
14971 (The problem is not unique to this layout; you can't use optional arguments
14972 to the Section layouts either.) This means that after you export that file
14973 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14974 need to edit the LaTeX file with a text editor to add the optional arguments
14976 \begin_inset space \thinspace{}
14980 \begin_inset space \space{}
14983 the running title for the page headers.
14984 Lacking these layouts makes the
14990 (and the equivalent
14996 ) useless, so the corresponding layouts don't exist, and will have to be
15001 \begin_layout Plain Layout
15006 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15007 has not been updated yet to take advantage of it.
15015 \begin_layout Section
15016 Springer Journals (
15023 \begin_layout Standard
15029 \begin_layout Subsection
15033 \begin_layout Standard
15034 These are the layout files for some of the journal formats used by Springer
15035 Verlag and listed on
15036 \begin_inset Flex URL
15039 \begin_layout Plain Layout
15041 http://www.springer.de/author/tex/help-journals.html
15046 , where you should also go to fetch the class files (yes, these are LaTeX2e
15048 It is a modular system: the things common to all journals are implemented
15053 , which journal-specific layout files (such as, e.
15054 \begin_inset space \thinspace{}
15058 \begin_inset space \space{}
15065 for Journal of Geodesy) can include.
15068 \begin_layout Standard
15069 This means that implementing support for any other Springer journal on this
15070 list is as simple as writing your own
15078 file following the outline given in
15086 \begin_layout Standard
15087 It is reasonably well tested only for the Journal of Geodesy.
15096 come with the standard LyX distribution.
15097 Install the relevant class file (downloaded from Springer) in a proper
15098 directory, reconfigure LaTeX (in the teTeX case by running
15102 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15103 and it should work.
15106 \begin_layout Subsection
15110 \begin_layout Standard
15111 A large number of theorem-like styles —
15117 \SpecialChar \ldots{}
15123 \begin_layout Standard
15126 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15127 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15130 See the Springer class file documentation for details.
15133 \begin_layout Subsection
15137 \begin_layout Itemize
15149 \begin_layout Itemize
15152 Probability Theory and Related Fields
15158 — Jean-Marc Lasgouttes
15161 \begin_layout Standard
15162 Add your own, it isn't so hard!
15165 \begin_layout Subsection
15169 \begin_layout Standard
15170 These files are partly based on the older
15174 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15175 file from Springer.
15180 layout, are now defunct.
15181 Jean-Marc Lasgouttes helped out big in making me find my way around the
15182 LyX layout file mechanism.
15185 \begin_layout Subsection
15189 \begin_layout Standard
15191 But probably less than in the old hacked-LaTeX
15198 \begin_layout Standard
15200 \begin_inset space \thinspace{}
15203 g.: does not display the number for theorem-like layouts, just #.
15206 \begin_layout Section
15212 \begin_inset CommandInset label
15221 \begin_layout Standard
15229 \begin_layout Subsection
15233 \begin_layout Standard
15234 This section describes how to use LyX to make slides for overhead projectors.
15235 There are two document classes that can do this: the default slides class
15241 This section documents the former.
15244 \begin_layout Standard
15245 I'm going to say this again, nice and clear, so that there's no misunderstanding
15249 \begin_layout Standard
15250 \begin_inset VSpace bigskip
15256 \begin_layout Standard
15260 This section documents the class
15261 \begin_inset Quotes eld
15269 \begin_inset Quotes erd
15277 \begin_layout Standard
15278 \begin_inset VSpace bigskip
15284 \begin_layout Standard
15285 If you're looking for the documentation for
15286 \begin_inset Quotes eld
15294 \begin_inset Quotes erd
15297 , check out section
15298 \begin_inset space ~
15302 \begin_inset CommandInset ref
15304 reference "sec:foiltex"
15314 \begin_inset Quotes eld
15322 \begin_inset Quotes erd
15325 ] is actually somewhat better than the default
15333 \begin_layout Plain Layout
15334 \SpecialChar \ldots{}
15335 or so I've been told repeatedly by its advocates.
15336 Having never used it, I have no idea if this claim is true or not.
15341 which this section documents.
15344 \begin_layout Standard
15345 This class is the LaTeX2e improvement of the old
15350 Every LaTeX2e distribution includes this class [which I'll just refer to
15352 \begin_inset Quotes eld
15360 \begin_inset Quotes erd
15363 from now on], so you're bound to have it.
15364 As I noted earlier, there are other classes, such as
15368 , which also produce slides for overhead projectors and do a better job
15370 However, there are some things which
15374 can do which the others can't, such as generate overlays.
15375 Read on to learn more!
15378 \begin_layout Subsection
15380 \begin_inset CommandInset label
15382 name "sec:slidesetup"
15389 \begin_layout Standard
15390 Obviously, to use this document class, you need to select
15391 \begin_inset Quotes eld
15399 \begin_inset Quotes erd
15402 from the class list in the
15404 Document\SpecialChar \menuseparator
15408 There are some other special things you should know about this class:
15411 \begin_layout Itemize
15412 Don't bother changing the options
15417 They're not supported by the
15424 \begin_layout Itemize
15428 \begin_inset space ~
15433 behaves a bit differently for this class.
15434 The possible choices and what they do are as follows:
15438 \begin_layout Description
15443 The final output contains page numbers in the lower right corner.
15446 \begin_layout Description
15455 , but also prints out any time markers you've put in.
15456 This is the default.
15459 \begin_layout Description
15464 The final output contains no page numbers, time markers, or alignment markers.
15468 \begin_layout Itemize
15473 class has an extra option:
15479 \begin_inset Quotes eld
15487 \begin_inset Quotes erd
15490 in the extra class options.
15494 \begin_layout Standard
15495 Using this options allows you to add time markers to
15501 \begin_inset space ~
15505 \begin_inset CommandInset ref
15507 reference "sec:slideNote"
15515 \begin_layout Standard
15516 You can also use the template file
15517 \begin_inset Quotes eld
15525 \begin_inset Quotes erd
15528 to automatically set up a document to use the
15534 File\SpecialChar \menuseparator
15536 \begin_inset space ~
15540 \begin_inset space ~
15545 to open your new document].
15546 The template file also contains some examples of the special paragraph
15547 environments used by this class.
15548 I'll describe those next.
15551 \begin_layout Subsection
15552 Paragraph Environments
15555 \begin_layout Subsubsection
15556 Supported Environments
15559 \begin_layout Standard
15560 The first thing you'll notice when you start up a new
15564 document is the font size and type: it's the equivalent of the size
15565 \begin_inset Quotes eld
15573 \begin_inset Quotes erd
15579 \begin_inset space ~
15585 This is also what's used in the output.
15587 \begin_inset Quotes eld
15591 \begin_inset Quotes erd
15594 to remind you that this is a slide.
15595 Your final slides will use a larger font; ergo, you'll have less space.
15596 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
15599 \begin_layout Standard
15600 The next thing that becomes obvious is the changes to the paragraph environment
15601 pull-down box [at the far-left end of the toolbar].
15602 Most of the paragraph environments you're used to seeing are missing.
15603 There are also five new ones.
15608 class itself only supports certain paragraph environments:
15611 \begin_layout Itemize
15617 \begin_layout Itemize
15623 \begin_layout Itemize
15629 \begin_layout Itemize
15635 \begin_layout Itemize
15641 \begin_layout Itemize
15647 \begin_layout Itemize
15653 \begin_layout Itemize
15659 \begin_layout Itemize
15665 \begin_layout Itemize
15671 \begin_layout Itemize
15677 \begin_layout Standard
15678 All of the other standard environments, including the section-heading environmen
15679 ts, aren't used in the
15686 \begin_layout Standard
15687 On the other hand, you'll notice the following new environments:
15690 \begin_layout Itemize
15696 \begin_layout Itemize
15702 \begin_layout Itemize
15708 \begin_layout Itemize
15714 \begin_layout Itemize
15720 \begin_layout Standard
15721 These five are kind of quirky, due to a
15722 \begin_inset Quotes eld
15726 \begin_inset Quotes erd
15730 You see, LyX doesn't permit you to nest any other paragraph environment
15731 into an empty environment.
15732 Now, that's fine and dandy, but it means that you wouldn't be able to start
15733 a slide with anything except plain text.
15734 To deal with this, I've performed a little
15735 \begin_inset Quotes eld
15739 \begin_inset Quotes erd
15745 \begin_layout Subsubsection
15746 Quirks of the New Environments
15747 \begin_inset CommandInset label
15749 name "sec:slideQuirk"
15756 \begin_layout Standard
15757 All five of the new paragraph environments are somewhat quirky due to inherent
15758 limitiations in the current version of LyX.
15759 As I just mentioned, LyX forbids environments that begin with another environme
15761 To get around this, the
15765 environment isn't a paragraph environment as described in the
15773 \begin_layout Standard
15774 You should consider
15787 \begin_inset Quotes eld
15790 pseudo-environments.
15791 \begin_inset Quotes erd
15794 They look like a section heading or a
15795 \begin_inset Quotes eld
15803 \begin_inset Quotes erd
15806 but really begin a [and, if necessary, end the previous] paragraph environment.
15816 \begin_inset Quotes eld
15820 \begin_inset Quotes erd
15823 These two perform some action.
15826 \begin_layout Standard
15827 A common feature of all five environments,
15847 , is a rather long-ish label.
15848 The text following this label — ordinarily the contents of the paragraph
15849 environment — is utterly irrelevant for
15870 LyX completely ignores it.
15871 In fact, you can leave these five environments completely empty.
15875 \begin_layout Standard
15880 to put any text after the rather long-ish label, you might want to.
15881 This could be a short description of the contents of the
15886 In that case, enter in your descriptive comment and hit
15890 as you normally would.
15893 \begin_layout Standard
15894 If, on the other hand, you don't want to enter in any descriptive text,
15895 you'll hit another LyX quirk.
15896 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15897 environment until you put something in the old one.
15901 \begin_layout Itemize
15902 Start entering the text that will
15930 \begin_layout Itemize
15931 Now move to the beginning of that paragraph.
15935 \begin_layout Itemize
15944 \begin_layout Itemize
15945 Finally, change this new, empty paragraph to a
15969 \begin_layout Standard
15970 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15974 \begin_layout Subsection
15975 Making a Presentation with
15988 \begin_layout Subsubsection
15996 \begin_layout Standard
15997 If you're expecting this section to teach you how to actually make a presentatio
15998 n, you'll be sorely disappointed.
15999 Naturally, I'll describe all of the ways the
16003 class can assist you in preparing the materials for a presentation.
16004 Filling in the contents, however, is up to you.
16009 the LyX philosophy.]
16012 \begin_layout Standard
16017 environment [in the manner described in section
16018 \begin_inset space ~
16022 \begin_inset CommandInset ref
16024 reference "sec:slideQuirk"
16028 ] tells LyX to begin a new slide [duh].
16029 The label for this environment/
16030 \begin_inset Quotes erd
16034 \begin_inset Quotes erd
16038 \begin_inset Quotes eld
16042 \begin_inset Quotes erd
16045 in cool blue, followed by the label,
16046 \begin_inset Quotes eld
16050 \begin_inset Quotes erd
16054 Any text or paragraph environments that follow this one go on the new slide.
16058 \begin_layout Standard
16059 Slides are probably the only time you'll need to forcibly end pages in LyX
16060 (this can be specified in the
16065 In fact, you'll want to, once you finish entering the contents of one slide.
16066 If you've entered more text than can physically fit on a slide, the extra
16067 overflows onto a new slide.
16068 I don't recommend doing this, however, since the overflow slide won't have
16069 any page number on it.
16070 Furthermore, it may interfere with any
16074 you've made to accompany the oversized
16081 \begin_layout Standard
16090 environments work the same way as the
16095 They both create an
16096 \begin_inset Quotes eld
16100 \begin_inset Quotes erd
16103 followed by a label [
16104 \begin_inset Quotes eld
16108 \begin_inset Quotes erd
16112 \begin_inset Quotes eld
16116 \begin_inset Quotes erd
16120 The color is a stunning magenta instead of blue, and the
16121 \begin_inset Quotes eld
16125 \begin_inset Quotes erd
16128 will look different, in style and in length.
16129 The label fonts of all three also differ from one another.
16132 \begin_layout Standard
16137 , if the contents of a
16145 exceed the physical size of a slide or sheet of paper, the extra will overflow
16147 Again, you should avoid this.
16148 It defeats the whole purpose of
16159 \begin_layout Subsubsection
16169 \begin_layout Standard
16174 is a slide that sits atop another slide.
16175 Perhaps you wish to discuss a figure on the main
16179 before displaying the text associated with it.
16180 One way to accomplish this is tape a flap of dark paper over the part of
16185 you want to display later.
16186 This method fails, however, if you wish to overlap one graph with another,
16188 You would then have to fumble while speaking to align the two separate,
16193 s to align the two graphs.
16198 environment in both cases makes life much easier.
16201 \begin_layout Standard
16206 receives the page number of its
16207 \begin_inset Quotes eld
16211 \begin_inset Quotes erd
16219 \begin_inset Quotes eld
16227 \begin_inset Quotes erd
16234 \begin_layout Plain Layout
16235 Presumably, mutliple
16240 \begin_inset Quotes eld
16248 \begin_inset Quotes erd
16252 \begin_inset Quotes eld
16260 \begin_inset Quotes erd
16264 \begin_inset Quotes eld
16272 \begin_inset Quotes erd
16276 \begin_inset space ~
16279 appended to the page number of the parent
16289 Clearly, you want the contents of both the
16297 to each fit on a single physical slide! You should probably consider an
16303 \begin_inset Quotes eld
16307 \begin_inset Quotes erd
16319 class provides a visual cue for this: the label at the start of an
16323 is shorter than that at the start of a
16328 Lastly, when you generate printable output, you'll find alignment markers
16329 in all four corners of both the
16333 page and its parent
16338 These will assist you in lining up the two physical slides.
16341 \begin_layout Standard
16342 The major problem in overlaying two slides is aligning the contents of the
16343 two transparencies.
16344 How much space should you leave for that graph on the second slide? Worse
16345 still, what if you want a graph and a sentence on second slide, but there
16346 is text on the main transparency that goes in between them? You could try
16347 and insert vertical space of the right size.
16348 The better way is to use
16359 \begin_layout Standard
16360 As their names imply,
16368 are two command-like paragraph environments that make all subsequent text
16369 invisible and visible, respectively.
16371 \begin_inset space ~
16375 \begin_inset CommandInset ref
16377 reference "sec:slideQuirk"
16381 that you don't place anything
16385 these two environments, however.
16390 , it inserts a centered, sky-blue label into the page reading
16391 \begin_inset Quotes eld
16394 <Invisible Text Follows>
16395 \begin_inset Quotes erd
16399 For paragraphs following this label, the parts of the
16407 ; it doesn't matter which] where they would be contain instead blank space.
16411 \begin_layout Standard
16416 , the corresponding centered label is
16417 \begin_inset Quotes eld
16420 <Visible Text Follows>
16421 \begin_inset Quotes erd
16425 Paragraphs following this label behave normally.
16426 Note that the beginning of a new
16438 automatically shuts off an
16443 It's therefore not necessary to use
16454 \begin_layout Standard
16455 By now, it should be obvious how to create overlay transparencies using
16456 the proper combination of
16475 \begin_layout Enumerate
16480 , including everything that will appear on it, whether on the main slide
16488 \begin_layout Enumerate
16489 Before each figure or paragraph that will appear only on the
16498 If necessary, insert a
16502 environment after the
16509 \begin_layout Enumerate
16514 immediately following the
16521 \begin_layout Enumerate
16522 Copy the contents of this
16533 \begin_layout Enumerate
16538 , change all of the
16549 \begin_layout Standard
16551 You've just made an
16558 \begin_layout Standard
16559 There's one problem with the way I've designed the LyX
16563 class: you can't make text in the middle of a paragraph invisible, nor
16564 make text in the middle of an invisible paragraph visible again.
16565 To accomplish this feat, you'll need to use some inlined LaTeX codes.
16569 \begin_layout Plain Layout
16570 The commands of interest are:
16573 \begin_layout Itemize
16578 invisible \SpecialChar \ldots{}
16582 \begin_layout Itemize
16587 visible \SpecialChar \ldots{}
16591 \begin_layout Plain Layout
16592 \SpecialChar \ldots{}
16593 and need to be marked as TeX.
16595 \begin_inset Quotes eld
16599 \begin_inset Quotes erd
16602 you wish to change goes in between the brackets [and after the
16615 If you don't know how to mark text as TeX, see the appropriate section
16628 \begin_layout Subsubsection
16638 \begin_inset CommandInset label
16640 name "sec:slideNote"
16647 \begin_layout Standard
16656 is associated with a
16657 \begin_inset Quotes eld
16661 \begin_inset Quotes erd
16673 class provides visual cues.
16678 is shorter than that of a
16682 [yet longer than that of an
16686 ] and, like the label of an
16690 is shockingly magenta.
16691 Additionally, the printed
16695 has the page number of its
16696 \begin_inset Quotes eld
16700 \begin_inset Quotes erd
16708 \begin_inset Quotes eld
16716 \begin_inset Quotes erd
16720 \begin_inset Quotes eld
16728 \begin_inset Quotes erd
16732 \begin_inset Quotes eld
16740 \begin_inset Quotes erd
16744 You can have multiple
16748 s associated with a single
16760 , you'll probably want to break up long
16764 s so that they fit on a single sheet of paper.
16767 \begin_layout Standard
16772 is obvious: it contains anything additional you might want to say about
16778 It could also be used as a sheet of reminders for a particular
16783 In the case of the latter, you might want to make use of time markers.
16789 \begin_inset Quotes eld
16793 \begin_inset Quotes erd
16796 support for time markers, a
16801 So, you'll have to resort to using the LaTeX codes.
16804 \begin_layout Standard
16805 To use time markers, you'll need to specify the extra class option
16806 \begin_inset Quotes eld
16814 \begin_inset Quotes erd
16818 \begin_inset space ~
16822 \begin_inset CommandInset ref
16824 reference "sec:slidesetup"
16829 This option turns on timing marks, which will appear in the lower-left-hand
16835 To set what appears in the time marker, you use the LaTeX commands
16836 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16850 \begin_inset Quotes eld
16860 \begin_inset Quotes erd
16864 The arguments of both commands are time measured in seconds.
16866 \begin_inset Quotes eld
16876 \begin_inset Quotes erd
16879 sets the time marker to a given time.
16881 \begin_inset Quotes eld
16891 \begin_inset Quotes erd
16894 increments the time marker by the specified amount.
16895 Using time markers and
16899 s in this fashion, you can remind yourself how much time to spend on a particula
16907 \begin_layout Standard
16908 There's one last feature to describe.
16909 Clearly, you'd like to print out all of your
16917 s on transparencies while printing all of your
16934 with which it is associated.
16935 What's a person to do?
16938 \begin_layout Standard
16939 Luckily, there are two LaTeX commands that allow you to select what to print
16941 Both must be placed into the preamble of your document.
16943 \begin_inset Quotes eld
16955 \begin_inset Quotes erd
16958 will cause the output to contain only the
16967 Correspondingly, the command
16968 \begin_inset Quotes eld
16980 \begin_inset Quotes erd
16983 prevents the output of anything but
16988 I'd advise placing both commands in the preamble and initially comment
16990 You can then preview your entire presentation as you write.
16991 When you're done writing, you can then uncomment one of the two to select
16992 what you want to print.
16993 I like to uncomment
16994 \begin_inset Quotes eld
17006 \begin_inset Quotes erd
17009 , print to a file with
17010 \begin_inset Quotes eld
17018 \begin_inset Quotes erd
17021 in its name, comment it back out, then uncomment
17022 \begin_inset Quotes eld
17034 \begin_inset Quotes erd
17038 \begin_inset Quotes eld
17046 \begin_inset Quotes erd
17050 I can then send either file to a printer, loading transparencies or plain
17051 paper as appropriate.
17054 \begin_layout Standard
17055 You can also provide other arguments to the
17056 \begin_inset Quotes eld
17066 \begin_inset Quotes erd
17070 \begin_inset Quotes eld
17080 \begin_inset Quotes erd
17084 See a good LaTeX book for details.
17087 \begin_layout Subsection
17092 Class Template File
17095 \begin_layout Standard
17096 I have also provided a template file,
17097 \begin_inset Quotes eld
17105 \begin_inset Quotes erd
17113 To use it, begin your new presentation with
17118 ile\SpecialChar \menuseparator
17120 \begin_inset space ~
17124 \begin_inset space ~
17134 Your new LyX presentation file will contain an example
17155 additionally contain an example of the use of
17164 Lastly, the preamble will contain:
17167 \begin_layout LyX-Code
17168 % Uncomment to print out only slides and overlays
17171 \begin_layout LyX-Code
17175 \begin_layout LyX-Code
17181 \begin_inset Newline newline
17187 \begin_layout LyX-Code
17188 % Uncomment to print out only notes
17191 \begin_layout LyX-Code
17195 \begin_layout LyX-Code
17203 \begin_layout Standard
17204 One final thing: I created this class to support the LaTeX2e
17205 \begin_inset Quotes eld
17213 \begin_inset Quotes erd
17216 class, one of the built-in LaTeX2e classes.
17217 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17218 built-in slide class.
17219 It's here if you want it or need it.
17220 There exist other LaTeX2e classes for creating presentations, such as the
17226 \begin_inset space ~
17230 \begin_inset CommandInset ref
17232 reference "sec:foiltex"
17237 \begin_inset Quotes eld
17245 \begin_inset Quotes erd
17248 package [present on some TeX distributions].
17249 The latter is not yet supported under LyX.
17253 \begin_layout Plain Layout
17254 Perhaps you can take on the task\SpecialChar \ldots{}
17260 I know nothing about these other classes.
17261 Try them out to see what sort of alternative they provide.
17264 \begin_layout Chapter
17265 LyX Features needing Extra Software
17268 \begin_layout Section
17272 \begin_layout Standard
17278 \begin_layout Subsection
17282 \begin_layout Standard
17291 \begin_layout Plain Layout
17296 is not yet available when you are using the LaTeX distribution MiKTeX.
17301 , you'll find in the
17308 \begin_inset space ~
17319 \begin_inset CommandInset href
17321 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17328 \begin_layout Standard
17333 package is a program that was written by
17334 \begin_inset Flex CharStyle:Noun
17337 \begin_layout Plain Layout
17339 \begin_inset space ~
17347 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17348 and easy to forget.
17349 The program runs over your LaTeX file, checks the integrity of the file,
17350 and flags some common errors.
17351 In other technical words, it is
17358 \begin_layout Standard
17359 Well, what is a syntax checker doing in LyX which is supposed to produce
17360 correct LaTeX anyways? The answer is simple: Just as
17364 not only checks the
17368 of C programs, but also does
17372 checks for type-errors,
17376 catches some common
17380 errors, in addition to the syntactical ones.
17385 is capable of detecting several common errors, such as
17388 \begin_layout Itemize
17389 Ellipsis detection:
17390 \begin_inset Newline newline
17393 Use \SpecialChar \ldots{}
17397 \begin_layout Itemize
17398 No space in front of/after parenthesis:
17399 \begin_inset Newline newline
17405 \begin_layout Itemize
17406 Enforcement of normal space after common abbreviations:
17407 \begin_inset Newline newline
17411 \begin_inset space \thinspace{}
17415 \begin_inset space \space{}
17418 is too wide spacing.
17421 \begin_layout Itemize
17422 Enforcement of end-of-sentence space when the last sentence ends with a
17424 \begin_inset Newline newline
17428 And this is wrong spacing.
17431 \begin_layout Itemize
17432 Space in front of labels and similar commands:
17433 \begin_inset Newline newline
17436 The label should stick right up to the text to avoid falling to a wrong
17439 \begin_inset CommandInset label
17449 \begin_layout Plain Layout
17450 This footnote is in danger of falling off to a wrong page
17455 The label is separated too much.
17458 \begin_layout Itemize
17459 Space in front of references, instead of hard spaces:
17460 \begin_inset Newline newline
17463 In you are in bad luck, the text will break right between the referenced
17464 text and reference number, and that's a pity.
17466 \begin_inset CommandInset ref
17468 reference "sec:chktex"
17475 \begin_layout Itemize
17477 \begin_inset Quotes eld
17481 \begin_inset Quotes erd
17485 \begin_inset Formula $\times$
17489 \begin_inset Newline newline
17492 2x2 looks cheap compared to
17493 \begin_inset Formula $2\times2$
17499 \begin_layout Standard
17500 and more \SpecialChar \ldots{}
17501 It is an invaluable tool when you are
17502 \begin_inset Quotes eld
17506 \begin_inset Quotes erd
17509 your document before printing, and you should run it right after the obligatory
17510 spelling check, and before you go fine tuning the typesetting.
17513 \begin_layout Subsection
17517 \begin_layout Standard
17518 If you have the program installed, usage is as simple as choosing
17520 Tools\SpecialChar \menuseparator
17522 \begin_inset space ~
17528 This will make LyX generate a LaTeX file of your document, start
17532 to check it, and then make LyX insert
17533 \begin_inset Quotes eld
17537 \begin_inset Quotes erd
17540 with the warnings from
17544 , if there were any.
17545 The warnings will be placed close to the point of the mistake, and you
17546 can quickly find them by using the
17548 Navigate\SpecialChar \menuseparator
17551 menu item, or the shortcut key
17560 Open the error boxes by clicking on them with the mouse, or use the shortcut
17569 bindings, or the corresponding
17578 Read the warning and correct the mistake, if it is a mistake.
17579 If you have trouble understanding what the warning is about, you can safely
17581 Remember that there is a hidden layer between the document on screen and
17582 the technical details in invoking
17586 , and this gap can make some warnings seem arcane or just right down plain
17590 \begin_layout Standard
17591 This document is an excellent testing bed for the feature, and it should
17592 provide quite a few warnings for you to fiddle with.
17593 Since computers are only so smart, expect most of the warnings to be false
17597 \begin_layout Subsection
17598 How to fine tune it
17601 \begin_layout Standard
17602 Sometimes, you'll find that
17606 makes more noise than suits your mood.
17607 Then you can choose not to use it, wait until your mood changes, or try
17612 to get better along with you.
17613 Another choice in the most desperate situations is to use
17615 View\SpecialChar \menuseparator
17617 \begin_inset space ~
17621 \begin_inset space ~
17625 \begin_inset space ~
17630 , which will get rid of all warnings instantly.
17633 \begin_layout Standard
17642 very configurable and extensible, you shouldn't expect to solve all problems
17648 Since LyX has to generate a somewhat special LaTeX file to be able to match
17649 the line numbers from the
17657 \begin_layout Plain Layout
17658 You can inspect the specific output from
17664 Edit\SpecialChar \menuseparator
17666 \begin_inset space ~
17670 \begin_inset space ~
17684 to the internal document structure, some of the warnings will not seen
17685 to appear correctly.
17686 There are two things you can do about this:
17689 \begin_layout Itemize
17694 invocation command line in
17710 installation configuration file (usually with the file
17715 See below to learn what warnings can be enabled and disabled on the command
17720 \begin_layout Itemize
17721 Export your document as a raw LaTeX file using
17723 File\SpecialChar \menuseparator
17724 Export\SpecialChar \menuseparator
17732 Invoked in this way, it can be a hassle to find the corresponding place
17733 in the document inside LyX, but with a little patience, you should be able
17737 \begin_layout Standard
17738 Here follows the warning messages that can be enabled and disabled in
17747 to disable a warning, and
17751 to enable a warning.
17752 The emphasized entries are disabled by default, because the default is
17755 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17760 \begin_layout Standard
17761 Notice that you should only use the options that enable and disable warnings,
17762 because LyX relies on some of the other command line parameters to be set
17763 in a specific way to have a chance to communicate with
17770 \begin_layout Enumerate
17774 Command terminated with space.
17777 \begin_layout Enumerate
17780 Non-breaking space (
17781 \begin_inset Quotes eld
17789 \begin_inset Quotes erd
17792 ) should have been used.
17795 \begin_layout Enumerate
17799 You should enclose the previous parenthesis with
17800 \begin_inset Quotes eld
17808 \begin_inset Quotes erd
17814 \begin_layout Enumerate
17817 Italic correction (
17818 \begin_inset Quotes eld
17828 \begin_inset Quotes erd
17831 ) found in non-italic buffer.
17834 \begin_layout Enumerate
17837 Italic correction (
17838 \begin_inset Quotes eld
17848 \begin_inset Quotes erd
17851 ) found more than once.
17854 \begin_layout Enumerate
17858 No italic correction (
17859 \begin_inset Quotes eld
17869 \begin_inset Quotes erd
17875 \begin_layout Enumerate
17879 \begin_inset Quotes eld
17887 \begin_inset Quotes erd
17891 \begin_inset Quotes eld
17899 \begin_inset Quotes erd
17905 \begin_layout Enumerate
17908 Wrong length of dash may have been used.
17911 \begin_layout Enumerate
17915 \begin_inset Quotes eld
17923 \begin_inset Quotes erd
17927 \begin_inset Quotes eld
17935 \begin_inset Quotes erd
17941 \begin_layout Enumerate
17945 \begin_inset Quotes eld
17953 \begin_inset Quotes erd
17959 \begin_layout Enumerate
17963 \begin_inset Quotes eld
17971 \begin_inset Quotes erd
17974 to achieve an ellipsis.
17977 \begin_layout Enumerate
17980 Inter-word spacing (
17981 \begin_inset Quotes eld
17991 \begin_inset Quotes eld
17994 ) should perhaps be used.
17997 \begin_layout Enumerate
18000 Inter-sentence spacing (
18001 \begin_inset Quotes eld
18011 \begin_inset Quotes erd
18014 ) should perhaps be used.
18017 \begin_layout Enumerate
18020 Could not find argument for command.
18023 \begin_layout Enumerate
18027 \begin_inset Quotes eld
18035 \begin_inset Quotes erd
18041 \begin_layout Enumerate
18044 Math mode still on at end of LaTeX file.
18047 \begin_layout Enumerate
18051 \begin_inset Quotes eld
18059 \begin_inset Quotes erd
18062 doesn't match the number of
18063 \begin_inset Quotes eld
18071 \begin_inset Quotes erd
18077 \begin_layout Enumerate
18080 You should use either
18083 \begin_inset Quotes eld
18091 \begin_inset Quotes erd
18096 as an alternative to
18097 \begin_inset Quotes eld
18105 \begin_inset Quotes erd
18111 \begin_layout Enumerate
18118 " (ASCII 39) instead of "
18125 \begin_layout Enumerate
18128 User-specified pattern found.
18131 \begin_layout Enumerate
18134 This command might not be intended.
18137 \begin_layout Enumerate
18144 \begin_layout Enumerate
18162 \begin_layout Enumerate
18165 Delete this space to maintain correct page references.
18168 \begin_layout Enumerate
18172 You might wish to put this between a pair of
18173 \begin_inset Quotes eld
18181 \begin_inset Quotes erd
18187 \begin_layout Enumerate
18190 You ought to remove spaces in front of punctuation.
18193 \begin_layout Enumerate
18196 Could not execute LaTeX command.
18199 \begin_layout Enumerate
18208 in front of small punctuation.
18211 \begin_layout Enumerate
18219 may look prettier here.
18222 \begin_layout Enumerate
18226 Multiple spaces detected in output.
18229 \begin_layout Enumerate
18232 This text may be ignored.
18235 \begin_layout Enumerate
18241 \begin_inset Quotes eld
18246 to begin quotation, not
18253 \begin_layout Enumerate
18260 to end quotation, not
18263 \begin_inset Quotes eld
18271 \begin_layout Enumerate
18277 \begin_layout Enumerate
18280 You should perhaps use
18281 \begin_inset Quotes eld
18289 \begin_inset Quotes erd
18295 \begin_layout Enumerate
18298 You should put a space in front of/after parenthesis.
18301 \begin_layout Enumerate
18304 You should avoid spaces in front of/after parenthesis.
18307 \begin_layout Enumerate
18311 You should not use punctuation in front of/after quotes.
18314 \begin_layout Enumerate
18317 Double space found.
18320 \begin_layout Enumerate
18323 You should put punctuation outside inner/inside display math mode.
18326 \begin_layout Enumerate
18329 You ought to not use primitive TeX in LaTeX code.
18332 \begin_layout Enumerate
18335 You should remove spaces in front of
18336 \begin_inset Quotes eld
18344 \begin_inset Quotes erd
18350 \begin_layout Enumerate
18353 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18364 is normally not followed by
18365 \begin_inset Quotes eld
18373 \begin_inset Quotes erd
18379 \begin_layout Standard
18380 In later versions of LyX, we hope to provide a more complete interface to
18381 this tool (and it's smaller cousin
18385 ) to exploit the full power of it.
18386 But it's not exactly useless as it is now: go try it on one of your existing
18387 documents of a certain length and be surprised.
18390 \begin_layout Section
18391 Version Control in LyX
18394 \begin_layout Standard
18397 Lars Gullik Bjønnes,
18404 \begin_layout Subsection
18408 \begin_layout Standard
18409 A friend of mine wanted to try LyX for a group project.
18410 When he didn't find support for version control or file locking, he dropped
18412 This angered me a bit, so I thought that I should at least make support
18413 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
18414 This has now been done.
18415 LyX now supports some of the most basic RCS commands.
18416 If you need to something a bit more sophisticated you will have to do that
18417 manually in an xterm.
18420 \begin_layout Standard
18421 Before you begin to use the version control features in LyX, you should
18423 \begin_inset Quotes eld
18427 \begin_inset Quotes erd
18430 (a man file, read it with
18435 This file describes all the basic features of RCS.
18436 You should especially notice the comment about a RCS directory, and the
18437 notion of a master RCS file (the file ending in
18444 \begin_layout Standard
18445 Later basic CVS/SVN support was added.
18446 You should be familiar with CVS/SVN usage before start using it under LyX.
18447 Most of the log messages are not currently displayed after operations -
18448 you can check them in terminal window if unsure.
18451 \begin_layout Standard
18452 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18453 package—no guarantees are made for older versions.
18456 \begin_layout Standard
18457 For introducing your own external commands consult vc-command in the manual
18461 \begin_layout Subsection
18462 RCS commands in LyX
18465 \begin_layout Standard
18466 The following sections describe the RCS commands supported by LyX.
18467 You can find them in the
18469 File\SpecialChar \menuseparator
18471 \begin_inset space ~
18477 LyX was tested against RCS 5.7.
18480 \begin_layout Subsubsection
18486 \begin_layout Standard
18487 If your document is not under revision control, this is the only item shown
18489 And if it is under revision control, the
18493 item is not visible.
18497 \begin_layout Standard
18498 This command registers your document with RCS (unless you are under the
18499 directory managed by CVS)\SpecialChar \@.
18500 You are asked interactively to supply an initial
18501 description of the document.
18502 The document is now set in Read-Only mode and you have to
18505 \begin_inset space ~
18509 \begin_inset space ~
18513 \begin_inset space ~
18518 , before making any changes to it.
18519 A document under revision control has a
18520 \begin_inset Quotes eld
18523 [RCS:<version> <locker>]
18524 \begin_inset Quotes erd
18527 item tagged to the filename in the minibuffer.
18530 \begin_layout Standard
18531 RCS command that is run:
18533 ci -q -u -i -t-"<initial description>" <file-name>
18536 \begin_layout Standard
18541 to understand the switches.
18545 \begin_layout Subsubsection
18551 \begin_layout Standard
18552 When you are finished editing a file, you check in your changes.
18553 When you do this, you are asked for a description of the changes.
18554 This is stored in the history log.
18555 The version number is bumped, your changes are applied to the master RCS
18556 file, the document is unlocked and set to Read-Only mode.
18560 \begin_layout Standard
18563 ci -q -u -m"<description>" <file-name>
18566 \begin_layout Subsubsection
18572 \begin_layout Standard
18573 By doing this you lock the document so that only you can edit it.
18574 This will also make the document Read-Write only for you.
18575 You will usually continue editing for a while and when you are finished
18576 you check in your changes.
18577 The status line is changed to reflect that you have locked the file.
18581 \begin_layout Standard
18584 co -q -l <file-name>
18587 \begin_layout Subsubsection
18590 Revert To Repository Version
18593 \begin_layout Standard
18594 This will discard all changes made to the document since the last check
18596 You get a warning before changes are discarded.
18599 \begin_layout Standard
18602 co -f -u<version> <file-name>
18605 \begin_layout Subsubsection
18611 \begin_layout Standard
18612 This makes as if the last check in never happened.
18613 No changes are made to the document loaded into LyX, but the last version
18614 is removed from the master RCS file.
18618 \begin_layout Standard
18621 rcs -o<version> <file-name>
18624 \begin_layout Subsubsection
18630 \begin_layout Standard
18631 This show the complete history of the RCS document.
18636 is shown in a browser.
18644 \begin_layout Subsection
18645 CVS commands in LyX
18648 \begin_layout Standard
18649 CVS is now partially supported by LyX.
18650 You can find the commands in the
18652 File\SpecialChar \menuseparator
18654 \begin_inset space ~
18662 \begin_layout Subsubsection
18668 \begin_layout Standard
18669 If your document is not under revision control, this is the only item shown
18671 And if it is under revision control, the
18678 item is not visible.
18682 \begin_layout Standard
18683 This command registers in CVS your document ONLY in case you have already
18684 the documents directory under CVS control (in particular
18689 This means you have to checkout the archive by yourself.
18693 \begin_layout Standard
18694 Then you are asked interactively to supply an initial description of the
18696 Don't forget that registered file is not yet commited.
18699 \begin_layout Standard
18700 CVS command that is run:
18703 \begin_inset Quotes erd
18707 \begin_inset Quotes eld
18711 \begin_inset Quotes erd
18717 \begin_layout Standard
18722 to understand the switches.
18726 \begin_layout Subsubsection
18732 \begin_layout Standard
18733 When you are finished editing a file, you commit your changes.
18734 When you do this, you are asked for a description of the changes.
18735 After that changes are commited.
18738 \begin_layout Standard
18741 cvs -q commit -m"<description>" "<file-name>"
18744 \begin_layout Subsubsection
18747 Revert To Repository Version
18750 \begin_layout Standard
18751 This will discard all changes made to the document since the last check
18753 You get a warning before changes are discarded.
18754 Firstly the file is deleted, secondly CVS update command is run.
18757 \begin_layout Standard
18761 \begin_inset Quotes eld
18765 \begin_inset Quotes erd
18771 \begin_layout Subsubsection
18777 \begin_layout Standard
18778 This show the complete history of the CVS document.
18782 \begin_inset Quotes eld
18786 \begin_inset Quotes erd
18791 is shown in a browser.
18794 \begin_layout Subsection
18795 SVN commands in LyX
18798 \begin_layout Standard
18799 SVN is now partially supported by LyX.
18800 You can find the commands in the
18802 File\SpecialChar \menuseparator
18804 \begin_inset space ~
18810 Please note that if you use password protected access to repository via
18811 ssh, you will be asked in terminal window.
18812 LyX was tested against SVN 1.5 and 1.6
18816 \begin_layout Plain Layout
18817 Most of the commands will work with 1.4 too, see
18818 \begin_inset CommandInset ref
18820 reference "sub:SVN-Repo-Update"
18832 \begin_layout Subsubsection
18838 \begin_layout Standard
18839 If your document is not under revision control, this is the only item shown
18841 And if it is under revision control, the
18848 item is not visible.
18852 \begin_layout Standard
18853 This command registers in SVN your document ONLY in case you have already
18854 the documents directory under SVN control (in particular
18859 This means you have to checkout the archive by yourself.
18863 \begin_layout Standard
18864 Then you are asked interactively to supply an initial description of the
18866 Don't forget that registered file is not yet commited.
18869 \begin_layout Standard
18870 SVN command that is run:
18873 \begin_inset Quotes eld
18877 \begin_inset Quotes erd
18883 \begin_layout Standard
18888 to understand the switches.
18892 \begin_layout Subsubsection
18898 \begin_layout Standard
18899 When you are finished editing a file, you commit your changes.
18900 When you do this, you are asked for a description of the changes.
18901 After that changes are commited.
18904 \begin_layout Standard
18909 \begin_layout Plain Layout
18910 In case locking is not enabled.
18912 \begin_inset CommandInset ref
18914 reference "subsec:SVN-File-Locking"
18925 svn commit -q -m"<description>" <file-name>
18928 \begin_layout Subsubsection
18934 \begin_layout Standard
18935 Updates the changes of this file from the repository.
18936 Be sure you understand SVN merging and conflicts resolving before using
18937 this function, because all conflicts has to be resolved manually by you!
18940 \begin_layout Standard
18945 \begin_layout Plain Layout
18954 \begin_inset Quotes eld
18958 \begin_inset Quotes erd
18964 \begin_layout Subsubsection
18967 Revert To Repository Version
18970 \begin_layout Standard
18971 This will discard all changes made to the document since the last check
18973 You get a warning before changes are discarded.
18977 \begin_layout Standard
18981 \begin_inset Quotes eld
18985 \begin_inset Quotes erd
18991 \begin_layout Subsubsection
18992 \begin_inset CommandInset label
18994 name "sub:SVN-Repo-Update"
18998 Update of the local directory checkout from repository
19002 \begin_layout Plain Layout
19003 Note that this command will work only with subversion
19004 \begin_inset Formula $\geqq1.5$
19015 \begin_layout Standard
19016 All the commands above have one shortcomming - they deal with the current
19018 Once your document contains pictures, includes external
19019 \begin_inset Flex CharStyle:Code
19022 \begin_layout Plain Layout
19028 files and so on administration becomes more complicated.
19029 LyX now supports updating the whole tree in which resides the document
19033 \begin_layout Plain Layout
19034 One need to organize the files structure so that all external files are
19035 in the same directory or subdirectories of the document.
19042 This become especially useful once you cooperate with people which neither
19043 know about subversion management nor they have ambition to commit additional
19044 material to the repository.
19048 \begin_layout Standard
19049 \begin_inset Flex CharStyle:Code
19052 \begin_layout Plain Layout
19053 Update local directory from repository
19058 command updates the whole directory and in case of merge conflicts local
19059 version of the files are left, so no unintended data loss occurs.
19060 If local changes are detected user is warned before update starts.
19063 \begin_layout Labeling
19064 \labelwidthstring 00.00.0000
19066 \begin_inset space ~
19070 \begin_inset space ~
19074 \begin_inset Newline newline
19078 \begin_inset Flex CharStyle:Code
19081 \begin_layout Plain Layout
19087 (Ask if changes are detected.)
19088 \begin_inset Newline newline
19092 \begin_inset Flex CharStyle:Code
19095 \begin_layout Plain Layout
19096 svn update --accept mine-full $path
19104 \begin_layout Standard
19106 \begin_inset Flex CharStyle:Code
19109 \begin_layout Plain Layout
19115 stands for the path to the document.
19118 \begin_layout Subsubsection
19124 \begin_layout Standard
19125 This show the complete history of the SVN document.
19129 \begin_inset Quotes eld
19133 \begin_inset Quotes erd
19138 is shown in a browser.
19141 \begin_layout Subsubsection
19143 \begin_inset CommandInset label
19145 name "subsec:SVN-File-Locking"
19152 \begin_layout Standard
19153 The file exchange through various revision control systems brings the problem
19154 of merge conflicts in case two different users try to edit the same (parts
19156 When such conflict happens it needs manual resolving and one reasonable
19157 alternative is to provide some kind of locking mechanism, which guarantees
19158 that only one user is allowed to edit file at the given time.
19161 \begin_layout Standard
19162 SVN has two mechanisms to provide such kind of mutual exclusivity for file
19163 access - locks and automatical setting of write permissions (see sec.
19165 \begin_inset CommandInset ref
19167 reference "subsec:Automatical-Locking-Property"
19172 \begin_inset Flex CharStyle:Code
19175 \begin_layout Plain Layout
19185 \begin_layout Plain Layout
19186 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
19192 In a case this property is detected for a given document LyX starts to
19193 use SVN locks for document editing automatically and the whole check-in/out
19194 mechanism switches to the same regimen as for RCS.
19195 This in particular means there are two different modes how file is used
19199 \begin_layout Itemize
19201 The loaded file is in the read-only mode.
19202 For editation on needs to check-out.
19207 consists of update from repository and gaining write lock.
19208 If the lock is not possible to obtain, we remain in unlocked state.
19211 \begin_layout Itemize
19213 The loaded file is in the 'normal' edit mode.
19214 No other user is allowed to edit the file.
19219 consists of commiting changes and releasing write-lock.
19220 If no changes have been made to the document, no commit will be produced
19224 \begin_layout Plain Layout
19225 Don't be puzzled by the fact that you will be asked for commit message anyway.
19230 and only the write-lock will be released.
19233 \begin_layout Standard
19237 \begin_layout Labeling
19238 \labelwidthstring 00.00.0000
19241 svn commit -q -m"<description>" "<file-name>"
19242 \begin_inset Newline newline
19245 svn unlock "<file-name>"
19248 \begin_layout Labeling
19249 \labelwidthstring 00.00.0000
19252 svn update "<file-name>"
19253 \begin_inset Newline newline
19256 svn lock "<file-name>"
19259 \begin_layout Subsubsection
19262 \begin_inset CommandInset label
19264 name "subsec:Automatical-Locking-Property"
19270 Automatical Locking Property
19273 \begin_layout Standard
19274 The above mentioned automatical setting of write permissions of the .lyx
19275 file can be set through
19280 ile\SpecialChar \menuseparator
19286 \begin_inset space ~
19289 Control\SpecialChar \menuseparator
19294 oggle locking property
19297 This command is active only when the file is not locked on the svn server
19299 you need to check-out before proceeding).
19302 \begin_layout Labeling
19303 \labelwidthstring 00.00.0000
19305 \begin_inset space ~
19311 \begin_layout Labeling
19312 \labelwidthstring 00.00.0000
19315 svn propset svn:needs-lock ON "<file-name>"
19318 \begin_layout Labeling
19319 \labelwidthstring 00.00.0000
19322 svn propdel svn:needs-lock "<file-name>"
19325 \begin_layout Subsubsection
19326 Revision Information in Documents
19329 \begin_layout Standard
19330 Currently there is no way how to provide such kind of information directly
19332 There are possibilities how to activate it with the help of svn features,
19333 but each has its own drawbacks.
19336 \begin_layout Standard
19337 One possibility is to use svn keywords
19341 \begin_layout Plain Layout
19342 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
19348 In short -- you set file keywords property (e.g.
19351 svn propset svn:keywords 'Rev' file.lyx
19353 ) and then paste keyword ERT
19357 \begin_layout Plain Layout
19358 This is an easy way how to ensure that LyX won't break the line in the middle
19364 tag in your document (e.g.
19369 \begin_layout Plain Layout
19377 This way svn client will automatically substitute revision number (e.g.
19382 \begin_layout Plain Layout
19389 ) after each update and commit.
19390 There are more problems with this approach.
19391 Firstly, the '$' character is used in TeX world for math equations, so
19392 any occurence of math formula
19393 \begin_inset Formula $Rev$
19397 \begin_inset Formula $Rev:59$
19400 in your LyX document.
19401 Similarly for other keywords like Id, Date, Author, etc.
19402 Secondly svn output is dependent on your locales, so its very easy that
19403 svn would produce some problematic strings once Date is used.
19404 Thirdly you get the whole 'Rev: 59' string in your document instead of
19406 Until subversion implements user's custom keywords it will be hard to use
19407 this approach reliably or let LyX to support it directly .
19410 \begin_layout Standard
19411 The second possibility would be to write your own external-material template
19413 \begin_inset Flex CharStyle:Code
19416 \begin_layout Plain Layout
19422 utility or parses the output of
19423 \begin_inset Flex CharStyle:Code
19426 \begin_layout Plain Layout
19432 command and returns the result back, when typeseting the document.
19435 \begin_layout Subsection
19436 SVN and Windows Environment
19439 \begin_layout Quote
19440 My inclination is to say that if the user cannot figure out the command
19441 line operations on their own fairly quickly, they would be well advised
19442 to use TortoiseSVN.
19448 \begin_layout Subsubsection
19452 \begin_layout Standard
19453 In addition to installing LyX, and having access to a Subversion repository,
19454 the user will need to install the Subversion client program.
19455 A Windows installer for the client program is available from
19456 \begin_inset CommandInset href
19459 target "http://www.collab.net/nonav/downloads/subversion/"
19464 The user may also want to install
19465 \begin_inset CommandInset href
19468 target "http://tortoisesvn.tigris.org/"
19472 , which integrates Subversion operations into the context (rightclick) menu
19473 of Windows Explorer.
19474 Operations done outside LyX will typically be more convenient using the
19475 Explorer context menu.
19476 Note that TortoiseSVN is not a replacement for the client program, which
19477 is what LyX itself will use.
19480 \begin_layout Subsubsection
19481 Bringing a document under Subversion control
19484 \begin_layout Standard
19485 Before a LyX document can be brought under version control in Subversion,
19486 its parent directory needs to be under version control.
19487 If the document is being added to a project already in the repository,
19488 this is accomplished by checking the project out to the directory where
19489 the new document will be placed.
19490 If the project itself is not yet under version control (for instance, if
19491 this document starts a new project), the directory must be imported into
19493 This is done outside LyX.
19494 Both import and checkout are easily accomplished from the Explorer context
19495 menu using TortoiseSVN, or alternatively can be done using the command
19496 line client at a DOS prompt.
19497 The procedure for importing the project using TortoiseSVN is described
19498 below, assuming an existing repository and a new project being started
19506 For information on using the Subversion client program, run
19513 \begin_layout Enumerate
19520 in Windows Explorer, right click it, and select
19522 TortoiseSVN > Repo-browser
19525 If necessary, adjust the URL for the repository, then click OK.
19528 \begin_layout Enumerate
19529 Right click the level of the repository under which you want to place the
19530 new project folder (typically the top level) and click
19532 Create folder\SpecialChar \ldots{}
19535 Supply a name for the project folder and click OK.
19536 Add a message for the log file if desired, then click OK again.
19537 The new project folder should appear in the repository.
19538 Finally, click OK again to exit the repository browser.
19541 \begin_layout Enumerate
19542 Once again right click
19548 , this time selecting SVN Checkout\SpecialChar \ldots{}
19549 Select the URL of the project folder
19550 you just created in the repository, and set the checkout directory to
19558 You will be warned about a non-empty folder; click OK to proceed.
19559 You should now have a
19570 \begin_layout Enumerate
19571 Create or open your document in LyX and click
19576 ile\SpecialChar \menuseparator
19582 \begin_inset space ~
19585 Control\SpecialChar \menuseparator
19593 Add a log message and click OK to commit the document to version control.
19596 \begin_layout Standard
19597 From this point onward, you should have full functionality in the
19602 ile\SpecialChar \menuseparator
19608 \begin_inset space ~
19614 You also have the option of checking the document in and out, viewing its
19616 using the TortoiseSVN context menu in Windows Explorer or the Subversion
19617 client program from a command prompt.
19620 \begin_layout Subsubsection
19621 SSH tunel used with SVN under Windows
19624 \begin_layout Standard
19625 Compared to linux setting svn client to communicate over ssh under Windows
19626 is rather troublesome task.
19627 We will at least make some hints how to setup client side but former knowledge
19628 about ssh and Windows command line is needed, also be prepared for a great
19629 deal of frustration...
19632 \begin_layout Enumerate
19633 Get svn client for windows, as described in previous sections.
19634 When it is fresh install run some svn command (e.g.
19636 \begin_inset Flex CharStyle:Code
19639 \begin_layout Plain Layout
19645 ) to have created config files, which you will need to change later on.
19648 \begin_layout Enumerate
19649 Choose ssh client for Windows.
19650 There are more possibilities, we will use the one from Putty tools
19654 \begin_layout Plain Layout
19655 \begin_inset Flex URL
19658 \begin_layout Plain Layout
19660 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
19671 You will need to automatize connection, so client doesn't ask for any password
19673 To keep things easy we will use only keys without any additional password
19678 \begin_layout Enumerate
19680 \begin_inset Flex CharStyle:Code
19683 \begin_layout Plain Layout
19690 Save your private .ppk key file and put the public one on the server side.
19691 In case the SVN server runs on linux, note that the format of the public
19692 key is not compatible with linux openssh and you will need to direcly copy-past
19693 e the key from the “
19695 Public key for pasting into OpenSSH authorized_keys file
19697 :” edit field into the server's
19698 \begin_inset Flex CharStyle:Code
19701 \begin_layout Plain Layout
19702 ~/.ssh/authorized_keys
19708 \begin_inset Flex CharStyle:Code
19711 \begin_layout Plain Layout
19720 \begin_layout Enumerate
19722 \begin_inset Flex CharStyle:Code
19725 \begin_layout Plain Layout
19732 In the SVN config file
19736 \begin_layout Plain Layout
19737 Exact path depends on Windows version, usually somewhere around
19738 \begin_inset Flex CharStyle:Code
19741 \begin_layout Plain Layout
19744 Documents and Settings
19758 \begin_inset Flex CharStyle:Code
19761 \begin_layout Plain Layout
19776 , section [tunnels], setup ssh command, e.g.
19778 \begin_inset Flex CharStyle:Code
19781 \begin_layout Plain Layout
19782 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
19791 \begin_layout Plain Layout
19792 It will usually take a lot of time to get exact command right and it depends
19794 For example do not have some remote server saved as a default session in
19796 If things fail, try to connect via plink without SVN first.
19805 \begin_layout Enumerate
19806 Checkout the SVN archive, e.g.
19808 \begin_inset Flex CharStyle:Code
19811 \begin_layout Plain Layout
19812 svn co svn+ssh://user@server/repository_path
19820 \begin_layout Subsection
19824 \begin_layout Standard
19825 With the recent addition of the vc-command function LyX power users are
19826 allowed to create their own commands for revision control.
19829 \begin_layout Standard
19830 As an example you can see how two TortoiseSVN commands could be integrated
19834 \begin_layout Description
19836 \begin_inset Flex CharStyle:Code
19839 \begin_layout Plain Layout
19840 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
19848 \begin_layout Description
19850 \begin_inset Flex CharStyle:Code
19853 \begin_layout Plain Layout
19854 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
19862 \begin_layout Section
19863 Literate Programming
19866 \begin_layout Standard
19871 (kayvan@sylvan.com)
19875 original documentation written by
19877 Edmar Wienskoski Jr.
19880 (edmar-w-jr@technologist.com)
19883 \begin_layout Subsection
19887 \begin_layout Standard
19888 The main purpose of this documentation is to show you how to use LyX for
19889 literate programming.
19890 Where it is assumed that you are familiar with this programming technique,
19892 \begin_inset Quotes eld
19896 \begin_inset Quotes erd
19900 \begin_inset Quotes eld
19904 \begin_inset Quotes erd
19908 If that is not the case, please follow the web links provided in the following
19910 There is a lot of good documentation out there covering old development
19911 history to the latest tools tips.
19914 \begin_layout Standard
19915 It is also assumed that you are familiar with LyX itself to a point that
19916 you are comfortable changing your LyX preferences, and X resources file.
19917 If that is not the case please refer to other LyX documentation to cover
19918 your specific needs.
19921 \begin_layout Subsection
19922 Literate Programming
19925 \begin_layout Standard
19926 From the Literate Programming FAQ:
19929 \begin_layout Quotation
19930 Literate programming is the combination of documentation and source together
19931 in a fashion suited for reading by human beings.
19932 In fact, literate programs should be enjoyable reading, even inviting!
19933 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
19934 and documentation in a single file.
19935 Literate programming tools then parse the file to produce either readable
19936 documentation or compilable source.
19937 The WEB style of literate programming was created by D.
19938 \begin_inset space \thinspace{}
19942 Knuth during the development of his TeX typesetting software.
19946 \begin_layout Standard
19947 Another excerpt says:
19950 \begin_layout Quotation
19953 How is literate programming different from verbose commenting?
19956 \begin_layout Quotation
19957 There are three distinguishing characteristics.
19958 In order of importance, they are:
19962 \begin_layout Itemize
19963 flexible order of elaboration
19966 \begin_layout Itemize
19967 automatic support for browsing
19970 \begin_layout Itemize
19971 typeset documentation, especially diagrams and mathematics
19975 \begin_layout Standard
19976 Now that I sparked your curiosity, take a look in the references.
19979 \begin_layout Subsubsection
19983 \begin_layout Standard
19984 The complete Literate Programming FAQ can be found at:
19987 \begin_layout Quote
19988 Literate Programming FAQ
19989 \begin_inset Flex URL
19992 \begin_layout Plain Layout
19994 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
20002 \begin_layout Standard
20003 The FAQ lists 23 (twenty three!) different literate programming tools.
20004 Where some are specialized or
20005 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20012 for particular programming languages, while other have general scope.
20017 for my own use for several reasons:
20020 \begin_layout Itemize
20021 It can generate the documentation either in LaTeX or HTML.
20024 \begin_layout Itemize
20025 It has a open architecture, i.
20026 \begin_inset space \thinspace{}
20030 \begin_inset space \space{}
20033 it is easy to plug in new filters and to perform special processing that
20038 \begin_layout Itemize
20039 There is a good selection of filters available already (the HTML is one
20043 \begin_layout Itemize
20047 \begin_layout Standard
20048 The Noweb web page can be found at:
20051 \begin_layout Quote
20053 \begin_inset Flex URL
20056 \begin_layout Plain Layout
20058 http://www.cs.virginia.edu/~nr/noweb/
20066 \begin_layout Standard
20067 Starting from there you can reach many other interesting links and even
20068 some literate program examples.
20071 \begin_layout Subsection
20072 LyX and Literate Programming
20075 \begin_layout Standard
20076 The LyX support for Literate Programming is provided by using the generic
20077 LyX converters mechanism.
20078 This support is provided in a
20079 \begin_inset Quotes eld
20083 \begin_inset Quotes erd
20087 \begin_inset space \thinspace{}
20091 \begin_inset space \space{}
20094 you will be able to use this new LyX feature with some other literate programmin
20095 g tool of your choice by just changing your LyX preferences.
20098 \begin_layout Subsubsection
20099 Generating documents and code (weaving and tangling)
20102 \begin_layout Paragraph
20103 Selecting the document class
20106 \begin_layout Standard
20107 If you have installed Noweb and LyX successfully, whenever you open a new
20108 document or try to change the document class of an existing one, you will
20109 find that there are three new document classes available:
20112 \begin_layout Itemize
20116 \begin_layout Itemize
20120 \begin_layout Itemize
20124 \begin_layout Standard
20125 You must select one of them to create your literate documents from.
20129 \begin_layout Standard
20130 Note that literate documents are not limited to these three classes.
20131 New classes can be generated from other styles like letter or in combination
20132 with other class variations like Article (AMS).
20133 If you have special needs that cannot be covered by one of the existing
20134 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20135 will arrange to insert a new entry, or teach you how to do it.
20139 \begin_layout Plain Layout
20140 It is very simple, it involves the creation of a file with four lines, and
20141 re-running of the auto configuration.
20146 Moreover, if you use a literate tool other than Noweb you may need to create
20147 a new set of document classes for it.
20150 \begin_layout Paragraph
20154 \begin_layout Standard
20155 LyX enables you to write code with a layout named
20163 \begin_layout Plain Layout
20164 The equivalent Noweb term is
20165 \begin_inset Quotes eld
20169 \begin_inset Quotes erd
20173 For historical reasons, I got used to the term
20174 \begin_inset Quotes eld
20178 \begin_inset Quotes erd
20181 introduced by other literate tool named Nuweb, which I used for many years
20182 before rendering myself to Noweb.
20187 Noweb delimits scraps like this:
20190 \begin_layout LyX-Code
20194 \begin_layout LyX-Code
20198 \begin_layout LyX-Code
20202 \begin_layout LyX-Code
20206 \begin_layout LyX-Code
20210 \begin_layout Standard
20211 The problem is that whatever is written in between the << and the
20215 must be taken literally, i.
20216 \begin_inset space \thinspace{}
20220 \begin_inset space \space{}
20223 LyX should be prevented from making any special interpretation of what has
20225 This is handled by a special layout named Scrap, that works like a normal
20226 paragraph but has a free spacing capability.
20229 \begin_layout Standard
20230 The down side of the Scrap paragraph layout is that consecutive paragraphs
20231 of code will be spaced with one empty line in the source code and also
20232 in the printed documentation.
20233 The work around is to enter each line of code within a single Scrap, with
20234 a newline (ctrl-return).
20235 The example above will look like this:
20239 \begin_layout Plain Layout
20240 If you have a printed version of this document you will not see any difference
20241 between the previous example and this one.
20249 \begin_layout LyX-Code
20251 \begin_inset Newline newline
20255 \begin_inset Newline newline
20259 \begin_inset Newline newline
20263 \begin_inset Newline newline
20269 \begin_layout Standard
20270 This layout works fine.
20271 The only real inconvenience is that you have to type ctrl-return instead
20276 \begin_layout Plain Layout
20277 It is in my list of
20278 \begin_inset Quotes eld
20282 \begin_inset Quotes erd
20293 \begin_layout Standard
20294 As a special note, you can also use the
20295 \begin_inset Quotes eld
20299 \begin_inset Quotes erd
20302 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20306 \begin_layout LyX-Code
20308 \begin_inset Newline newline
20311 def some_function(args):
20312 \begin_inset Newline newline
20315 "This is the doc string for this function."
20316 \begin_inset Newline newline
20319 print "My args: ", args
20322 \begin_layout LyX-Code
20323 @ %def some_function
20326 \begin_layout Standard
20327 For an example of this usage and the resulting cross-reference output, look
20328 at the Literate python program in
20330 LIBDIR/examples/listerrors.lyx
20332 which should make this all clear.
20335 \begin_layout Paragraph
20336 Generating the documentation
20339 \begin_layout Standard
20340 At this point you already have a new document file with a proper document
20341 class, and with some code and text on it.
20342 How do I print it? The answer is simple, you select
20344 View\SpecialChar \menuseparator
20348 Just like you would do for a plain document.
20349 No special procedure is required.
20352 \begin_layout Standard
20353 To help orientate you, I will now explain what happens inside LyX:
20356 \begin_layout Enumerate
20359 Update\SpecialChar \menuseparator
20362 menu option is chosen, a LaTeX file is generated.
20367 \begin_layout Standard
20368 If the document is of any literate class the generated file will be named
20369 with an extension name defined by the
20370 \begin_inset Quotes eld
20374 \begin_inset Quotes erd
20377 format (defined in the Preferences panel), otherwise the file will have
20386 \begin_layout Enumerate
20387 Note that the only difference so far is in the name of the file, no special
20388 processing is required by LyX.
20389 Given that you formatted the code using the Scrap layout that, by itself,
20390 takes care of the business.
20393 \begin_layout Enumerate
20394 If the document is of any literate class LyX will then use the internal
20395 LyX to Noweb converter, followed by the Noweb to LaTeX converter
20399 \begin_layout Plain Layout
20400 The converters are defined in the
20402 Tools\SpecialChar \menuseparator
20406 \begin_inset Quotes eld
20410 \begin_inset Quotes erd
20422 manual for general information about converters.
20427 to generate the LaTeX file.
20431 \begin_layout Standard
20432 Otherwise it will just skip this step.
20436 \begin_layout Enumerate
20437 Finally, LaTeX is invoked and the regular post processing continues as in
20441 \begin_layout Standard
20442 Independence from a particular
20443 \begin_inset Quotes eld
20447 \begin_inset Quotes erd
20450 is easily achieved by changing the commands that are run by the various
20454 \begin_layout Paragraph
20455 Generating the code
20458 \begin_layout Standard
20459 When the build menu option is chosen or the corresponding button in the
20460 toolbar is pressed, a LaTeX file is generated just like step 1 above.
20461 Next, LyX invokes the
20466 This converter needs to be defined by the user and is not installed by
20467 default, though the Program format is.
20468 This converter (like any other converter) will have two parts:
20471 \begin_layout Enumerate
20472 The converter program itself.
20473 This program performs the conversion from the one format to the other (in
20474 this case, from the Noweb format to the Program pseudo-format).
20477 \begin_layout Enumerate
20478 The error log parser.
20479 This is a program whose sole purpose is to rewrite error messages in a
20480 format that LyX understands.
20481 This makes it possible for LyX to place error boxes in the right places
20482 in the file buffer.
20485 \begin_layout Standard
20486 The first part, the
20487 \begin_inset Quotes eld
20491 \begin_inset Quotes erd
20494 setting, should be set to
20495 \begin_inset Quotes eld
20503 \begin_inset Quotes erd
20507 This basically means that LyX will call
20508 \begin_inset Quotes eld
20512 \begin_inset Quotes erd
20515 (a program or script) with the name of the Noweb file (normally a file
20516 in the LyX temp directory).
20520 \begin_layout Standard
20521 This is an implementation of
20522 \begin_inset Quotes eld
20526 \begin_inset Quotes erd
20529 that you can place in a directory on your path:
20532 \begin_layout LyX-Code
20536 \begin_layout LyX-Code
20540 \begin_layout LyX-Code
20541 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
20544 \begin_layout Standard
20545 The next part of the converter setting is the
20546 \begin_inset Quotes eld
20550 \begin_inset Quotes erd
20553 which is to be set to
20554 \begin_inset Quotes eld
20559 parselog=listerrors
20562 \begin_inset Quotes erd
20566 This will run any errors that are generated by the
20567 \begin_inset Quotes eld
20571 \begin_inset Quotes erd
20574 process through the
20575 \begin_inset Quotes eld
20579 \begin_inset Quotes erd
20585 \begin_layout Standard
20586 The converter code looks in
20594 then on the path for the
20595 \begin_inset Quotes eld
20599 \begin_inset Quotes erd
20605 \begin_layout Standard
20606 The build will normally take place in LyX's temporary directory, so the
20607 files produced by the conversion will be in that directory.
20608 LyX will copy out what it regards as the `main' file, but the
20612 conversion may produce several files, and so most of these would then be
20613 deleted when LyX was closed.
20614 The present solution is to use a `copier',
20618 \begin_layout Plain Layout
20627 manual for information on these.
20636 script in its default mode, so that the entire contents of the temporary
20637 directory is copied.
20638 More will get copied than is needed, to be sure, but nothing will be lost.
20639 If, however, you know what extensions the generated files will have, this
20640 can be improved by using the
20649 This option takes a comma-separated list of extensions to copy.
20650 So, for example, if the conversion will generate only files with the extensions
20659 , then the correct definition would be:
20662 \begin_layout LyX-Code
20663 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
20666 \begin_layout Standard
20667 The result will be that only files with these two extensions will be copied
20671 \begin_layout Paragraph
20672 Build instructions in the document
20675 \begin_layout Standard
20676 The last piece of the integration between LyX and noweb is the
20677 \begin_inset Quotes eld
20681 \begin_inset Quotes erd
20685 Generally, the instructions for building your program should be embedded
20686 in a scrap of its own.
20688 \begin_inset Quotes eld
20692 \begin_inset Quotes erd
20695 above uses the notangle command to look for this scrap (called
20696 \begin_inset Quotes eld
20700 \begin_inset Quotes erd
20703 ) and runs its contents through
20704 \begin_inset Quotes eld
20708 \begin_inset Quotes erd
20714 \begin_layout Standard
20715 Typically, such a scrap would look something like this:
20718 \begin_layout LyX-Code
20720 \begin_inset Newline newline
20724 \begin_inset Newline newline
20728 \begin_inset Newline newline
20731 if [ -z "${NOWEB_SOURCE}" ]
20732 \begin_inset Newline newline
20736 \begin_inset Newline newline
20739 NOWEB_SOURCE=myfile.nw
20740 \begin_inset Newline newline
20744 \begin_inset Newline newline
20748 code to extract files ...]
20749 \begin_inset Newline newline
20753 code to compile files ...]
20754 \begin_inset Newline newline
20760 \begin_layout Standard
20763 LIBDIR/examples/listerrors.lyx
20767 LIBDIR/examples/Literate.lyx
20769 which implement two versions of the
20770 \begin_inset Quotes eld
20774 \begin_inset Quotes erd
20777 program for some illustrations of how all of these pieces go together or
20780 LIBDIR/examples/noweb2lyx.lyx.
20783 Interestingly, these three files show off the language-indepence of the
20784 LyX literate programming support since they are written in Python, C and
20788 \begin_layout Subsubsection
20792 \begin_layout Standard
20793 All the Literate Programming support is configured by the
20795 Tools\SpecialChar \menuseparator
20799 \begin_inset Quotes eld
20803 \begin_inset Quotes erd
20807 The important parts are:
20810 \begin_layout Description
20812 \begin_inset space ~
20816 \begin_inset Quotes eld
20820 \begin_inset Quotes erd
20824 \begin_inset space ~
20827 format Set up via the Formats tab, this is where the Noweb-specific pieces
20837 , the file extension is set to
20842 This tells LyX to create a file with a
20846 extension in the first step of the conversion process.
20849 \begin_layout Description
20851 \begin_inset space ~
20859 \begin_inset space ~
20862 format This is an empty format whose sole purpose is to be the endpoint
20863 of a conversion (which then allows us to set up a converter for it).
20866 \begin_layout Description
20875 This converter performs the
20876 \begin_inset Quotes eld
20880 \begin_inset Quotes erd
20883 of the literate document.
20884 For Noweb, it is set to
20885 \begin_inset Quotes eld
20890 noweave -delay -index $$i > $$o
20893 \begin_inset Quotes erd
20899 \begin_layout Description
20909 \begin_inset Quotes eld
20913 \begin_inset Quotes erd
20917 As stated above, the Converter is set to
20918 \begin_inset Quotes eld
20926 \begin_inset Quotes erd
20929 , with Flags set to
20930 \begin_inset Quotes eld
20935 originaldir,parselog=listerrors
20938 \begin_inset Quotes erd
20944 \begin_layout Subsubsection
20948 \begin_layout Standard
20949 There is also a new function implemented in the LyX server, the
20950 \begin_inset Quotes eld
20953 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
20957 \begin_layout Standard
20958 When debugging code with ddd/gdb, it is possible to invoke a text editor
20959 at the current execution position with a single key stroke.
20960 The default ddd configuration for that is shift-ctrl-V.
20961 It happens that you can define the editor command line invocation in ddd
20964 Edit\SpecialChar \menuseparator
20965 Preferences\SpecialChar \menuseparator
20968 dialog and changing the "Edit Sources" entry.
20971 \begin_layout Standard
20972 I take advantage of the new created LyX server function and this ddd feature,
20974 \begin_inset Quotes eld
20978 \begin_inset Quotes erd
20984 \begin_layout LyX-Code
20985 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20988 \begin_layout Standard
20989 With this, whenever you are using ddd and find a point in the program that
20990 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20991 ddd you forward this information to LyX through the LyX server and then
20992 the LyX window will show the same file with the cursor at the same position
20993 ddd was pointing to.
20994 No more guessing or long scrolling to locate a point in the program back
20998 \begin_layout Standard
20999 Note however that you must enable the LyX server to get this feature working
21000 (it is disabled by default).
21001 You can enable it in
21013 ) by entering in the
21018 \begin_inset Quotes eld
21023 /home/<your-home-directory>/.lyx/lyxpipe
21026 \begin_inset Quotes erd
21032 \begin_layout Standard
21033 Read the LyX server documentation in the
21035 Customization Manual
21037 for further information.
21040 \begin_layout Subsubsection
21044 \begin_layout Standard
21045 There are six new buttons that can be added to your LyX toolbar.
21046 Five of these buttons are short cuts to layout styles:
21067 The last one is a short cut to the
21068 \begin_inset Quotes eld
21072 \begin_inset Quotes erd
21079 \begin_layout Standard
21080 LyX has a range of buttons that are available for tool bar customization.
21081 In my toolbar I like to combine the six short cuts above with two more:
21086 \SpecialChar \menuseparator
21091 \SpecialChar \menuseparator
21098 View\SpecialChar \menuseparator
21102 Here is how it looks like:
21105 \begin_layout LyX-Code
21109 \begin_layout LyX-Code
21113 \begin_layout LyX-Code
21114 Icon "layout Standard"
21117 \begin_layout LyX-Code
21118 Icon "layout Section"
21121 \begin_layout LyX-Code
21122 Icon "layout LaTeX"
21125 \begin_layout LyX-Code
21126 Icon "layout LyX-Code"
21129 \begin_layout LyX-Code
21130 Icon "layout Scrap"
21133 \begin_layout LyX-Code
21137 \begin_layout LyX-Code
21141 \begin_layout LyX-Code
21142 Icon "buffer-typeset"
21145 \begin_layout LyX-Code
21146 Icon "build-program"
21149 \begin_layout LyX-Code
21153 \begin_layout LyX-Code
21157 \begin_layout LyX-Code
21161 \begin_layout LyX-Code
21165 \begin_layout LyX-Code
21169 \begin_layout Subsubsection
21170 Colors customization
21173 \begin_layout Standard
21174 There are a number of colors in LyX that can be customized in
21179 One of the things that bothers people is the LaTeX font color.
21180 The default color is red, since the scraps uses LaTeX font, and there is
21181 a lot of scraps in literate documents, you may get tired of seeing everything
21183 You can change it by going to the tabs
21192 \begin_layout Standard
21193 The next thing is the visible presence of the newline character in the screen.
21194 You can choose the color of this particular character and make it blend
21196 I recommend you choosing a color that is close to the background but not
21197 equal, that way you still can see it is there, but it is not bothering
21202 \begin_layout Chapter
21203 Secrets of the LaTeX Masters
21204 \begin_inset CommandInset label
21213 \begin_layout Standard
21214 Though LyX is a powerful tool, it cannot hope to support everything that
21215 can be done with pure TeX/LaTeX.
21216 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21217 as long as you are not afraid to use that
21218 \begin_inset Quotes eld
21222 \begin_inset Quotes erd
21225 button on the toolbar or add things to the LaTeX preamble.
21226 This section lists some tips, tricks, and otherwise cool ideas to give
21227 your document that extra little flair.
21230 Do try this at home
21232 , just start with something a little smaller and less important than your
21236 \begin_layout Standard
21237 Most ideas in this section require less common files in your LaTeX installation.
21238 If you have a system like teTeX, most will already be available.
21239 A few, however, will need to be downloaded from one of the CTAN archives.
21240 Often, there are several ways to do something, or several LaTeX style files
21241 which do the same thing.
21242 We do not endorse one choice over another, we simply claim that we have
21243 done a particular task with a particular file.
21244 Put on your wizard hat, keep an eye out for dragons, and let us begin.
21247 \begin_layout Section
21251 \begin_layout Standard
21254 Lars Gullik Bjønnes
21257 \begin_layout Subsection
21261 \begin_layout Standard
21262 The aim for this chapter
21266 \begin_layout Plain Layout
21267 Editor's note: Lars' original chapter was a masterful description of how
21273 However, it was too long to flow smoothly in this document.
21274 I have therefore chosen to excerpt the most important sections here (sorry,
21275 Lars); you can read the original chapter (and more of the story!) in the
21278 examples/multicol.lyx
21286 is to show how the LaTeX package
21290 can be used in a LyX document.
21291 As LyX doesn't support the
21295 package natively yet, we have to use some small hacks.
21296 By reading this section it should be obvious how to do this.
21299 \begin_layout Subsection
21303 \begin_layout Standard
21308 package allows switching between one and multicolumn format on the same
21310 Footnotes are handled correctly (for the most part), but will be placed
21311 at the bottom of the page and not under each column.
21312 LaTeX's float mechanism, however, is partly disabled in the current implementat
21314 At the moment only page-wide floats can be used within the scope of the
21318 \begin_layout Subsection
21322 \begin_layout Subsubsection
21326 \begin_layout Standard
21327 If you want to have two columns in your text, you have use LaTeX mode to
21332 begin{multicols}{2}
21334 at the point where you want the two column layout to start, and then
21340 where you want it to end.
21344 \begin_layout Standard
21348 \begin_layout Plain Layout
21352 begin{multicols}{2}
21360 \begin_layout Standard
21365 The Adventure of the Empty House
21368 \begin_inset Newline newline
21373 Sir Arthur Conan Doyle
21376 \begin_layout Standard
21379 It was in the spring of the year 1894 that all London was interested, and
21380 the fashionable world dismayed, by the murder of the Honourable Ronald
21381 Adair under most unusual and inexplicable circumstances.
21382 The public has already learned those particulars of the crime which came
21383 out in the police investigation, but a good deal was suppressed upon that
21384 occasion, since the case for the prosecution was so overwhelmingly strong
21385 that it was not necessary to bring forward all the facts.
21386 Only now, at the end of nearly ten years, am I allowed to supply those
21387 missing links which make up the whole of that remarkable chain.
21388 The crime was of interest in itself, but that interest was as nothing to
21389 me compared to the inconceivable sequel, which afforded me the greatest
21390 shock and surprise of any event in my adventurous life.
21391 Even now, after this long interval, I find myself thrilling as I think
21392 of it, and feeling once more that sudden flood of joy, amazement, and increduli
21393 ty which utterly submerged my mind.
21394 Let me say to that public, which has shown some interest in those glimpses
21395 which I have occasionally given them of the thoughts and actions of a very
21396 remarkable man, that they are not to blame me if I have not shared my knowledge
21397 with them, for I should have considered it my first duty to do so, had
21398 I not been barred by a positive prohibition from his own lips, which was
21399 only withdrawn upon the third of last month.
21402 \begin_layout Standard
21406 \begin_layout Plain Layout
21418 \begin_layout Subsubsection
21422 \begin_layout Standard
21423 The same pattern is used when you want more than two columns:
21426 \begin_layout Standard
21430 \begin_layout Plain Layout
21434 begin{multicols}{3}
21442 \begin_layout Standard
21445 It can be imagined that my close intimacy with Sherlock Holmes had interested
21446 me deeply in crime, and that after his disappearance I never failed to
21447 read with care the various problems which came before the public.
21448 And I even attempted, more than once, for my own private satisfaction,
21449 to employ his methods in their solution, though with indifferent success.
21450 There was none, however, which appealed to me like this tragedy of Ronald
21452 As I read the evidence at the inquest, which led up to a verdict of willful
21453 murder against some person or persons unknown, I realized more clearly
21454 than I had ever done the loss which the community had sustained by the
21455 death of Sherlock Holmes.
21456 There were points about this strange business which would, I was sure,
21457 have specially appealed to him, and the efforts of the police would have
21458 been supplemented, or more probably anticipated, by the trained observation
21459 and the alert mind of the first criminal agent in Europe.
21460 All day, as I drove upon my round, I turned over the case in my mind and
21461 found no explanation which appeared to me to be adequate.
21462 At the risk of telling a twice-told tale, I will recapitulate the facts
21463 as they were known to the public at the conclusion of the inquest.
21466 \begin_layout Standard
21470 \begin_layout Plain Layout
21482 \begin_layout Standard
21483 You can have more than 3 columns if you want to, but that might not be very
21484 pleasant for the eye.
21487 \begin_layout Subsubsection
21488 Columns inside columns
21491 \begin_layout Standard
21492 You can even have columns inside columns:
21495 \begin_layout Standard
21499 \begin_layout Plain Layout
21503 begin{multicols}{2}
21511 \begin_layout Standard
21514 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21515 at that time governor of one of the Australian colonies.
21516 Adair's mother had returned from Australia to undergo the operation for
21517 cataract, and she, her son Ronald, and her daughter Hilda were living together
21521 \begin_layout Standard
21525 \begin_layout Plain Layout
21529 begin{multicols}{2}
21537 \begin_layout Standard
21540 The youth moved in the best society–had, so far as was known, no enemies
21541 and no particular vices.
21542 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
21543 had been broken off by mutual consent some months before, and there was
21544 no sign that it had left any very profound feeling behind it.
21545 For the rest {sic} the man's life moved in a narrow and conventional circle,
21546 for his habits were quiet and his nature unemotional.
21547 Yet it was upon this easy-going young aristocrat that death came, in most
21548 strange and unexpected form, between the hours of ten and eleven-twenty
21549 on the night of March 30, 1894.
21552 \begin_layout Standard
21556 \begin_layout Plain Layout
21568 \begin_layout Standard
21571 Ronald Adair was fond of cards–playing continually, but never for such stakes
21573 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
21574 It was shown that, after dinner on the day of his death, he had played
21575 a rubber of whist at the latter club.
21576 He had also played there in the afternoon.
21581 The evidence of those who had played with him– Mr.
21582 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
21583 and that there was a fairly equal fall of the cards.
21584 Adair might have lost five pounds, but not more.
21585 His fortune was a considerable one, and such a loss could not in any way
21587 He had played nearly every day at one club or other, but he was a cautious
21588 player, and usually rose a winner.
21589 It came out in evidence that, in partnership with Colonel Moran, he had
21590 actually won as much as four hundred and twenty pounds in a sitting, some
21591 weeks before, from Godfrey Milner and Lord Balmoral.
21592 So much for his recent history as it came out at the inquest.
21595 \begin_layout Standard
21599 \begin_layout Plain Layout
21611 \begin_layout Standard
21612 Please do read the file
21614 examples/multicol.lyx
21616 for more advanced examples including column and header spacing, vertical
21617 separator lines, and more.
21620 \begin_layout Section
21625 Paragraph Environment
21626 \begin_inset OptArg
21629 \begin_layout Plain Layout
21630 Numbering in Enumerate
21638 \begin_layout Standard
21644 \begin_layout Standard
21645 \begin_inset VSpace bigskip
21651 \begin_layout Standard
21653 The default numbering for the
21657 paragraph environment begins with Arabic numbers and ends with uppercase
21659 Suppose, however, you wanted a different type of numbering scheme.
21660 Here's a quickie example of how to change the numbering scheme:
21663 \begin_layout LyX-Code
21673 \begin_layout LyX-Code
21683 \begin_layout LyX-Code
21693 \begin_layout LyX-Code
21703 \begin_layout Standard
21704 \SpecialChar \ldots{}
21705 which changes the numbering scheme to uppercase Roman numerals, uppercase
21706 letters, Arabic numbers, and lowercase letter.
21709 \begin_layout Standard
21710 Additionally, the previous example also adds a little bit extra to the numbering
21712 For example, the first level label actually looks like:
21713 \begin_inset Quotes eld
21717 \begin_inset Quotes erd
21721 For ease of reading, we'll describe what the numbering schemes look like
21722 using a notation something like this: <
21723 \begin_inset Quotes eld
21727 \begin_inset Quotes erd
21731 \begin_inset space ~
21735 \begin_inset Quotes erd
21739 \begin_inset Quotes erd
21743 \begin_inset space ~
21747 \begin_inset Quotes erd
21751 \begin_inset Quotes erd
21755 \begin_inset space ~
21759 \begin_inset Quotes eld
21763 \begin_inset Quotes erd
21770 \begin_layout Standard
21771 As you can see in the example, there is a label command for each nesting
21778 \SpecialChar \ldots{}
21785 , as well as a counter,
21789 \SpecialChar \ldots{}
21795 There are also five
21796 \begin_inset Quotes eld
21800 \begin_inset Quotes erd
21833 , each of which take one counter as an argument.
21834 You can add characters before or after these, but there's no need to add
21838 \begin_layout Standard
21839 You can get really fancy with these.
21843 \begin_layout LyX-Code
21857 \begin_layout LyX-Code
21869 \begin_layout LyX-Code
21879 \begin_layout LyX-Code
21889 \begin_layout Standard
21890 produces the somewhat out of hand numbering scheme: <
21891 \begin_inset Quotes eld
21895 \begin_inset Quotes erd
21899 \begin_inset space ~
21903 \begin_inset Quotes erd
21907 \begin_inset Quotes erd
21911 \begin_inset space ~
21915 \begin_inset Quotes erd
21919 \begin_inset Quotes erd
21923 \begin_inset space ~
21927 \begin_inset Quotes eld
21931 \begin_inset Quotes erd
21938 \begin_layout Standard
21942 \begin_layout Section
21946 \begin_layout Standard
21952 \begin_layout Standard
21953 \begin_inset VSpace bigskip
21959 \begin_layout Standard
21964 \begin_layout Plain Layout
21970 tmpfont}{cmr17 scaled 2500}{
21982 \begin_layout Standard
21987 \begin_layout Plain Layout
21998 hose of you who like the style of old books probably also like
21999 \begin_inset Quotes eld
22003 \begin_inset Quotes erd
22006 —those large capital letters which begin each new chapter or section.
22007 Implementing them with plain LyX/LaTeX is straightforward (assuming you
22008 know some plain TeX!) but does require a lot of work and many iterations,
22009 as you can see by all the ugly TeX-mode stuff at the beginning of this
22013 \begin_layout Standard
22017 \begin_layout Plain Layout
22023 bigdrop{-1em}{3}{ptmri}{T}+
22028 here is a much easier way of doing this, of course.
22037 ) package from CTAN allows a simple way to add such letters to your documents.
22038 Since this package is not a standard part of teTeX, I can't demonstrate
22039 it within this document, but if you copy this paragraph to a new document,
22041 \begin_inset Quotes eld
22051 \begin_inset Quotes erd
22054 and the pluses from the TeX code at the beginning of the paragraph, and
22059 usepackage{dropcaps}
22061 to your LaTeX preamble, you will get a nice Times Roman Italic
22062 \begin_inset Quotes eld
22066 \begin_inset Quotes erd
22069 , whose height is three lines of text and which protrudes 1 em into the
22071 (Make certain you have copied
22072 \begin_inset Quotes eld
22080 \begin_inset Quotes erd
22083 into a directory where TeX can see it.) The first argument is the amount
22084 of indentation; in this case the negative sign moves it into the margin.
22085 The second argument is the height of the letter in number of lines of text.
22086 The third argument is the font name: virtually anything which has a tfm
22087 file should work (wade through the
22089 .../texmf/fonts/tfm
22091 directory for possibilities).
22092 My personal favorite is
22093 \begin_inset Quotes eld
22101 \begin_inset Quotes erd
22104 , a fancy German font specifically designed for dropped capitals.
22105 The fourth argument is the letter (or letters) to be dropped.
22110 package also offers the
22116 command, as well as a slightly simplified
22125 \begin_layout Section
22126 Non-standard Paragraph Shapes
22129 \begin_layout Standard
22135 \begin_layout Standard
22136 \begin_inset VSpace bigskip
22142 \begin_layout Standard
22146 \begin_layout Plain Layout
22158 \begin_layout Standard
22162 \begin_layout Plain Layout
22171 \begin_layout Plain Layout
22185 \begin_layout Standard
22190 \begin_layout Plain Layout
22201 \begin_layout Plain Layout
22210 \begin_layout Plain Layout
22219 \begin_layout Plain Layout
22228 \begin_layout Plain Layout
22237 \begin_layout Plain Layout
22246 \begin_layout Plain Layout
22255 \begin_layout Plain Layout
22264 \begin_layout Plain Layout
22273 \begin_layout Plain Layout
22282 \begin_layout Plain Layout
22291 \begin_layout Plain Layout
22300 \begin_layout Plain Layout
22309 \begin_layout Plain Layout
22318 \begin_layout Plain Layout
22327 \begin_layout Plain Layout
22336 \begin_layout Plain Layout
22345 \begin_layout Plain Layout
22354 \begin_layout Plain Layout
22363 \begin_layout Plain Layout
22369 There are times when the tyranny of rectangular paragraphs must be overthrown.
22370 In such situations, a call to the delightful plain TeX command
22377 As you can see, completely arbitrary shapes can be laid out with a suitable
22378 set of linelength definitions.
22379 While this parshape may look a bit silly and useless, one could conceive
22380 of situations such as finely tuned dropped capitals, word wrapping around
22381 non-rectangular graphics, etc.
22382 which will benefit from such handcrafting.
22385 \begin_layout Standard
22386 \begin_inset VSpace bigskip
22392 \begin_layout Standard
22397 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
22404 is the number of lines of text which define the paragraph.
22405 If there turn out to be fewer lines, the shape is truncated; if there are
22406 more, the excess lines have the same dimensions as the last line of the
22416 entries specify the indentation of the line from the left margin, and the
22417 length of the line as measured from that point.
22418 The shape applies only to the current paragraph; everything is reset to
22419 normal for the next paragraph.
22422 \begin_layout Standard
22426 \begin_layout Plain Layout
22438 \begin_layout Section
22442 \begin_layout Standard
22443 As you can see, the examples in this section range from the useful to the
22445 While I don't expect that anyone will ever need the paragraph shape demonstrate
22446 d in the last section, the important point is that you can do almost anything
22447 you want in LyX if you are willing to figure out how to do it in TeX and
22449 TeX is a fantastically powerful typesetting system and all that power is
22450 available to you since LyX uses it as its backend.