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 Chapter
4480 \begin_layout Section
4484 \begin_layout Standard
4485 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4486 and retrieve information about the LyX internal state.
4487 This is only intended for advanced users, but they should find it useful.
4488 It is by writing to the LyX server, for example, that bibliography managers,
4489 such as JabRef, are able to
4490 \begin_inset Quotes eld
4494 \begin_inset Quotes erd
4500 \begin_layout Section
4501 Starting the LyX Server
4504 \begin_layout Standard
4505 The LyX server works through the use of a pair of named pipes.
4506 These are usually located in
4507 \begin_inset Flex CharStyle:Code
4510 \begin_layout Plain Layout
4516 , (except on Windows, where
4520 named pipes are special objects located in
4521 \begin_inset Flex CharStyle:Code
4524 \begin_layout Plain Layout
4536 ) and have the names
4537 \begin_inset Quotes eld
4541 \begin_inset Flex CharStyle:Code
4544 \begin_layout Plain Layout
4551 \begin_inset Quotes erd
4555 \begin_inset Quotes eld
4559 \begin_inset Flex CharStyle:Code
4562 \begin_layout Plain Layout
4569 \begin_inset Quotes erd
4573 External programs write into
4574 \begin_inset Flex CharStyle:Code
4577 \begin_layout Plain Layout
4583 and read back data from
4584 \begin_inset Flex CharStyle:Code
4587 \begin_layout Plain Layout
4594 The stem of the pipe names can be defined in the
4595 \begin_inset Flex CharStyle:MenuItem
4598 \begin_layout Plain Layout
4599 Tools\SpecialChar \menuseparator
4606 \begin_inset Flex CharStyle:Code
4609 \begin_layout Plain Layout
4610 "/home/myhome/lyxpipe"
4616 \begin_inset Flex CharStyle:Code
4619 \begin_layout Plain Layout
4638 configure this manually in order for the server to start.
4641 \begin_layout Standard
4643 \begin_inset Flex CharStyle:Code
4646 \begin_layout Plain Layout
4653 \begin_inset Flex CharStyle:Code
4656 \begin_layout Plain Layout
4662 ' to create the pipes.
4663 If one of the pipes already exists, LyX will assume that another LyX process
4664 is already running and will not start the server.
4665 On POSIX (Unix like) systems, if for some other reason, an unused
4666 \begin_inset Quotes eld
4670 \begin_inset Quotes erd
4673 pipe is left in existence when LyX closes, then LyX will try to delete
4675 If this fails for some reason, you will need to delete the pipes manually
4676 and then restart LyX.
4677 On Windows, pipes are deleted by the OS on program termination or crash,
4679 \begin_inset Quotes eld
4683 \begin_inset Quotes erd
4686 pipes should not be possible.
4689 \begin_layout Standard
4690 To have several LyX processes with servers at the same time, you have to
4691 use different configurations, perhaps by using separate user directories,
4693 \begin_inset Flex CharStyle:Code
4696 \begin_layout Plain Layout
4702 file, for each process.
4705 \begin_layout Standard
4706 If you are developing a client program, you might find it useful to enable
4707 debugging information from the LyX server.
4708 Do this by starting LyX as
4709 \begin_inset Flex CharStyle:Code
4712 \begin_layout Plain Layout
4721 \begin_layout Standard
4722 You can find a complete example client written in C in the source distribution
4724 \begin_inset Flex CharStyle:Code
4727 \begin_layout Plain Layout
4728 development/lyxserver/server_monitor.c
4736 \begin_layout Standard
4737 Another useful tool is command-line based client you will find in
4738 \begin_inset Flex CharStyle:Code
4741 \begin_layout Plain Layout
4742 src/client/lyxclient
4750 \begin_layout Section
4751 Normal communication
4754 \begin_layout Standard
4755 To issue a LyX call, the client writes a line of ASCII text into the input
4757 This line has the following format:
4774 \begin_layout Description
4775 clientname is a name that the client can choose arbitrarily.
4776 Its only use is that LyX will echo it if it sends an answer—so a client
4777 can dispatch results from different requesters.
4780 \begin_layout Description
4781 function is the function you want LyX to perform.
4782 It is the same as the commands you'd use in the minibuffer.
4785 \begin_layout Description
4786 argument is an optional argument which is meaningful only to some functions
4788 \begin_inset Quotes eld
4792 \begin_inset Quotes erd
4795 LFUN will insert the argument as text at the cursor position).
4798 \begin_layout Standard
4799 The answer from LyX will arrive in the output pipe and be of the form
4816 \begin_layout Standard
4825 are just echoed from the command request, while
4829 is more or less useful information filled according to how the command
4830 execution worked out.
4831 Some commands, such as
4832 \begin_inset Quotes eld
4836 \begin_inset Quotes erd
4839 , will return information about the internal state of LyX, while other will
4840 return an empty data-response.
4841 This means that the command execution went fine.
4844 \begin_layout Standard
4845 In case of errors, the response from LyX will have this form
4862 \begin_layout Standard
4867 should contain an explanation of why the command failed.
4870 \begin_layout Standard
4874 \begin_layout LyX-Code
4875 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4876 \begin_inset Newline newline
4879 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4880 \begin_inset Newline newline
4883 read a <~/.lyxpipe.out
4884 \begin_inset Newline newline
4890 \begin_layout Section
4894 \begin_layout Standard
4895 LyX can notify clients of events going on asynchronously.
4896 Currently it will only do this if the user binds a key sequence with the
4898 \begin_inset Quotes eld
4902 \begin_inset Quotes erd
4906 The format of the string LyX sends is as follows:
4910 \begin_inset Flex CharStyle:Code
4913 \begin_layout Plain Layout
4924 \begin_layout Standard
4929 is the printed representation of the key sequence that was actually typed
4933 \begin_layout Standard
4934 This mechanism can be used to extend LyX's command set and implement macros.
4935 Bind some key sequence to
4936 \begin_inset Quotes eld
4940 \begin_inset Quotes erd
4944 Then start a client that listens on the output pipe, dispatches the command
4945 according to the sequence, and starts a function that may use LyX calls
4946 and LyX requests to issue a command or a series of commands to LyX.
4949 \begin_layout Section
4950 The simple LyX Server Protocol
4953 \begin_layout Standard
4954 LyX implements a simple protocol that can be used for session management.
4955 All messages are of the form
4968 \begin_layout Standard
4974 \begin_inset Quotes eld
4978 \begin_inset Quotes erd
4982 \begin_inset Quotes eld
4986 \begin_inset Quotes erd
4991 \begin_inset Quotes eld
4995 \begin_inset Quotes erd
4998 is received from a client, LyX will report back to inform the client that
4999 it's listening to it's messages, while
5000 \begin_inset Quotes eld
5004 \begin_inset Quotes erd
5007 sent from LyX will inform clients that LyX is closing.
5010 \begin_layout Section
5011 Reverse DVI/PDF search
5014 \begin_layout Standard
5015 Some DVI/PDF viewers
5019 \begin_layout Plain Layout
5020 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5021 Skim on Mac OSX and SumatraPDF on Windows.
5030 facility (also called
5035 This means that you can tell LyX to put the cursor to a specific line in
5036 the document by clicking at the respective position in the DVI/PDF output.
5037 To achieve this, the viewer must be able to communicate with LyX.
5038 This is done via the LyX server either by using the named pipe (
5042 ), or the UNIX domain socket (
5046 ) that LyX creates in its temporary directory (this is the way the
5047 \begin_inset Flex CharStyle:Code
5050 \begin_layout Plain Layout
5056 program communicates with LyX).
5057 In some cases, you need a helper script that mediates between the viewer
5058 and LyX, in others, the viewer can communicate with LyX directly.
5059 This depends on the selected viewer and on your operating system.
5060 The same applies to the way viewers need to be configured and the way the
5061 reverse search is actually performed.
5062 In what follows, we will thus describe how to setup reverse search for
5064 Before we turn to this, though, we will explain what needs to be done generally
5065 to enable reverse search in the DVI/PDF output.
5068 \begin_layout Subsection
5069 Enabling reverse search
5072 \begin_layout Standard
5073 LaTeX provides several different methods for reverse search.
5074 Some are built-in in the
5075 \begin_inset Flex CharStyle:Code
5078 \begin_layout Plain Layout
5084 program, some are provided by external packages.
5085 Your choice depends on whether your LaTeX distribution already provides
5086 a given method (the built-in methods are rather new) and whether your viewer
5088 The available methods are described in the following.
5091 \begin_layout Subsubsection*
5092 Built-in DVI-search via src-specials (DVI only)
5095 \begin_layout Standard
5096 This method provides the DVI file with the necessary information for reverse
5098 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5099 distribution should include it), and it works reliably.
5100 To enable it, change the
5101 \begin_inset Flex CharStyle:MenuItem
5104 \begin_layout Plain Layout
5109 \begin_layout Plain Layout
5122 \begin_inset Flex CharStyle:MenuItem
5125 \begin_layout Plain Layout
5130 \begin_layout Plain Layout
5137 eX (plain)->DraftDVI
5143 \begin_inset Flex CharStyle:MenuItem
5146 \begin_layout Plain Layout
5147 Preferences\SpecialChar \menuseparator
5148 File Handling\SpecialChar \menuseparator
5155 \begin_inset Flex CharStyle:Code
5158 \begin_layout Plain Layout
5159 latex -src-specials $$i
5165 If this doesn't work, check if your TeX engine needs different options
5166 (the syntax might differ in some distributions).
5169 \begin_layout Subsubsection*
5170 External Packages (PDFSync and scrltx)
5173 \begin_layout Standard
5182 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5184 In order to enable it, load the packages in the LyX preamble:
5187 \begin_layout Itemize
5188 \begin_inset Flex CharStyle:Code
5191 \begin_layout Plain Layout
5199 for reverse PDF search,
5202 \begin_layout Itemize
5204 \begin_inset Flex CharStyle:Code
5207 \begin_layout Plain Layout
5210 usepackage[active]{srcltx}
5215 for reverse DVI search.
5218 \begin_layout Standard
5219 If you want to be able to perform both DVI and PDF reverse searches, you
5220 can also insert in the preamble the following lines
5223 \begin_layout LyX-Code
5227 \begin_inset Newline newline
5233 \begin_inset Newline newline
5239 \begin_inset Newline newline
5245 \begin_inset Newline newline
5250 usepackage[active]{srcltx}
5251 \begin_inset Newline newline
5259 \begin_layout Standard
5260 This way, you can preview the file as either DVI or PDF (pdflatex) and the
5261 right package will be used.
5264 \begin_layout Standard
5265 Note that PDFSync might affect the output layout of your document.
5266 It is therefore advised to disable PDFsync for final documents.
5269 \begin_layout Subsubsection*
5270 Built-in reverse search via SyncTeX (DVI and PDF)
5273 \begin_layout Standard
5275 \begin_inset Flex CharStyle:Code
5278 \begin_layout Plain Layout
5284 have built-in support for both PDF and DVI reverse search.
5289 facility is basically the result of the integration of the PDFSync package
5290 to the pdftex program and its merge with the
5295 You need at least TeXLive 2008 or a recent MikTeX distribution in order
5297 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
5298 already provide SyncTeX support.
5301 \begin_layout Standard
5302 To enable SyncTeX for DVI output, change the
5303 \begin_inset Flex CharStyle:MenuItem
5306 \begin_layout Plain Layout
5311 \begin_layout Plain Layout
5324 \begin_inset Flex CharStyle:MenuItem
5327 \begin_layout Plain Layout
5332 \begin_layout Plain Layout
5339 eX (plain) -> DraftDVI
5345 \begin_inset Flex CharStyle:MenuItem
5348 \begin_layout Plain Layout
5349 Preferences\SpecialChar \menuseparator
5350 File Handling\SpecialChar \menuseparator
5357 \begin_inset Flex CharStyle:Code
5360 \begin_layout Plain Layout
5361 latex -synctex=1 $$i
5366 , and for PDF output, change the
5367 \begin_inset Flex CharStyle:MenuItem
5370 \begin_layout Plain Layout
5375 \begin_layout Plain Layout
5382 eX (pdflatex) -> PDF (pdflatex)
5388 \begin_inset Flex CharStyle:Code
5391 \begin_layout Plain Layout
5392 pdflatex -synctex=1 $$i
5398 Check the documentation of your viewer whether the viewer needs to be configure
5399 d for the use with SyncTeX.
5403 \begin_layout Plain Layout
5405 \begin_inset Flex CharStyle:Code
5408 \begin_layout Plain Layout
5414 option enables gzip compression.
5415 If your viewer does not support it, you should instead use
5416 \begin_inset Flex CharStyle:Code
5419 \begin_layout Plain Layout
5433 \begin_layout Subsection
5434 Configuring and using specific viewers
5437 \begin_layout Subsubsection*
5438 Xdvi (all platforms)
5441 \begin_layout Standard
5443 \begin_inset Flex CharStyle:Code
5446 \begin_layout Plain Layout
5452 , you don't need to do anything else for performing a reverse DVI search,
5453 as LyX already provides the necessary hooks for automatically using the
5455 \begin_inset Flex CharStyle:Code
5458 \begin_layout Plain Layout
5465 Just setup your document as described above (reverse search is triggered
5466 by Ctrl-click or Alt-click on Mac OSX, respectively).
5469 \begin_layout Standard
5470 However, if for whatever reason you want to use the named pipe instead of
5471 the socket for communicating with LyX, simply change the DVI viewer in
5473 \begin_inset Flex CharStyle:MenuItem
5476 \begin_layout Plain Layout
5477 Preferences\SpecialChar \menuseparator
5478 File Handling\SpecialChar \menuseparator
5488 \begin_layout Plain Layout
5489 On Mac OSX you have to use
5490 \begin_inset Flex CharStyle:Code
5493 \begin_layout Plain Layout
5494 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5505 \begin_inset Flex CharStyle:Code
5508 \begin_layout Plain Layout
5509 xdvi -editor 'lyxeditor.sh %f %l'
5515 \begin_inset Flex CharStyle:Code
5518 \begin_layout Plain Layout
5524 is a suitable script.
5525 For example, a minimal shell script is the following one:
5528 \begin_layout LyX-Code
5530 \begin_inset Newline newline
5533 LYXPIPE="/path/to/lyxpipe"
5534 \begin_inset Newline newline
5537 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5538 \begin_inset Newline newline
5541 echo "$COMMAND" > "${LYXPIPE}".in || exit
5542 \begin_inset Newline newline
5545 read < "${LYXPIPE}".out || exit
5548 \begin_layout Standard
5550 \begin_inset Flex CharStyle:Code
5553 \begin_layout Plain Layout
5563 \begin_layout Plain Layout
5570 XServer pipe path specified in
5571 \begin_inset Flex CharStyle:MenuItem
5574 \begin_layout Plain Layout
5575 Preferences\SpecialChar \menuseparator
5585 \begin_layout Plain Layout
5587 \begin_inset Flex CharStyle:Code
5590 \begin_layout Plain Layout
5596 folder of a source distribution you can find a
5597 \begin_inset Flex CharStyle:Code
5600 \begin_layout Plain Layout
5606 script which is able to locate the
5610 based on your preferences.
5618 \begin_layout Subsubsection*
5622 \begin_layout Standard
5624 \begin_inset Flex CharStyle:Code
5627 \begin_layout Plain Layout
5628 /Applications/MacDviX_Folder/calleditor.script
5633 , add the following lines:
5636 \begin_layout LyX-Code
5641 \begin_layout Plain Layout
5648 X.app/Contents/MacOS/lyxeditor "$2" $1
5649 \begin_inset Newline newline
5655 \begin_layout Standard
5656 Modify the lines accordingly if you install LyX somewhere else than in the
5657 Applications folder.
5660 \begin_layout Standard
5661 Reverse search is triggered by Alt-click (OPTION-click).
5664 \begin_layout Subsubsection*
5668 \begin_layout Standard
5670 \begin_inset Flex CharStyle:Code
5673 \begin_layout Plain Layout
5674 open -a Skim.app $$i
5679 to the viewer setting in
5680 \begin_inset Flex CharStyle:MenuItem
5683 \begin_layout Plain Layout
5684 Preferences\SpecialChar \menuseparator
5685 File Handling\SpecialChar \menuseparator
5686 File formats\SpecialChar \menuseparator
5693 \begin_inset Flex CharStyle:MenuItem
5696 \begin_layout Plain Layout
5697 Skim\SpecialChar \menuseparator
5698 Preferences\SpecialChar \menuseparator
5708 \begin_layout Plain Layout
5718 \begin_layout Standard
5719 Reverse search is triggered by COMMAND-SHIFT-click
5722 \begin_layout Subsubsection*
5726 \begin_layout Standard
5728 \begin_inset Flex CharStyle:MenuItem
5731 \begin_layout Plain Layout
5732 Settings\SpecialChar \menuseparator
5733 Configure Okular\SpecialChar \ldots{}
5734 \SpecialChar \menuseparator
5741 \begin_inset Quotes eld
5745 \begin_inset Quotes erd
5749 \begin_inset Flex CharStyle:Code
5752 \begin_layout Plain Layout
5761 \begin_layout Standard
5762 Reverse search is triggered by SHIFT-click.
5765 \begin_layout Subsubsection*
5769 \begin_layout Standard
5770 Launch yap, choose its
5771 \begin_inset Flex CharStyle:MenuItem
5774 \begin_layout Plain Layout
5775 View\SpecialChar \menuseparator
5782 \begin_inset Quotes eld
5786 \begin_inset Quotes erd
5791 \begin_inset Quotes eld
5794 New\SpecialChar \ldots{}
5796 \begin_inset Quotes erd
5799 button and, in the window that opens, enter
5800 \begin_inset Quotes eld
5804 \begin_inset Quotes erd
5807 (or any other name you like) in the
5808 \begin_inset Quotes eld
5812 \begin_inset Quotes erd
5816 Now click on the button labeled
5817 \begin_inset Quotes eld
5820 \SpecialChar \ldots{}
5822 \begin_inset Quotes erd
5825 to open a file dialog and navigate to the directory containing the batch
5827 \begin_inset Flex CharStyle:Code
5830 \begin_layout Plain Layout
5838 \begin_inset Flex CharStyle:Code
5841 \begin_layout Plain Layout
5847 and then specify the program arguments as
5848 \begin_inset Flex CharStyle:Code
5851 \begin_layout Plain Layout
5859 \begin_inset Flex CharStyle:Code
5862 \begin_layout Plain Layout
5868 wrapper is used for communicating with LyX through the
5875 \begin_layout LyX-Code
5877 \begin_inset Newline newline
5880 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
5889 \begin_inset Newline newline
5903 \begin_layout Standard
5904 Make sure that the LyXServer pipe path you specified in LyX is
5905 \begin_inset Flex CharStyle:Code
5908 \begin_layout Plain Layout
5922 , otherwise change the
5923 \begin_inset Flex CharStyle:Code
5926 \begin_layout Plain Layout
5932 wrapper accordingly.
5935 \begin_layout Standard
5936 In yap, reverse search is triggered by double-click.
5939 \begin_layout Subsubsection*
5940 SumatraPDF (Windows)
5943 \begin_layout Standard
5944 In order to use SumatraPDF for inverse search, enter
5945 \begin_inset Flex CharStyle:Code
5948 \begin_layout Plain Layout
5949 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
5954 in the viewer setting in
5955 \begin_inset Flex CharStyle:MenuItem
5958 \begin_layout Plain Layout
5959 Preferences\SpecialChar \menuseparator
5960 File Handling\SpecialChar \menuseparator
5961 File formats\SpecialChar \menuseparator
5968 \begin_inset Flex CharStyle:Code
5971 \begin_layout Plain Layout
5977 is the previous wrapper.
5978 If SumatraPDF.exe is not in your command PATH, use its full file name.
5981 \begin_layout Standard
5982 Reverse search is triggered by double-click.
5985 \begin_layout Subsubsection*
5989 \begin_layout Standard
5990 First of all, make sure that yap is your default DVI viewer in the Windows
5991 environment, then launch it, choose its
5992 \begin_inset Flex CharStyle:MenuItem
5995 \begin_layout Plain Layout
5996 View\SpecialChar \menuseparator
6003 \begin_inset Quotes eld
6007 \begin_inset Quotes erd
6012 \begin_inset Quotes eld
6015 New\SpecialChar \ldots{}
6017 \begin_inset Quotes erd
6020 button and, in the window that opens, enter
6021 \begin_inset Quotes eld
6025 \begin_inset Quotes erd
6028 (or any other name you like) in the
6029 \begin_inset Quotes eld
6033 \begin_inset Quotes erd
6037 Now click on the button labeled
6038 \begin_inset Quotes eld
6041 \SpecialChar \ldots{}
6043 \begin_inset Quotes erd
6046 to open a file dialog and navigate to the directory containing the
6047 \begin_inset Flex CharStyle:Code
6050 \begin_layout Plain Layout
6056 program (which is installed by default on Cygwin along with the LyX executable).
6058 \begin_inset Flex CharStyle:Code
6061 \begin_layout Plain Layout
6067 and then specify the program arguments as
6068 \begin_inset Flex CharStyle:Code
6071 \begin_layout Plain Layout
6078 In this way, you will be using the
6082 for communicating with LyX.
6083 If, for whatever reason, you want to use the
6088 \begin_inset Flex CharStyle:Code
6091 \begin_layout Plain Layout
6097 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6100 \begin_layout Standard
6101 In yap, reverse search is triggered by double-click.
6104 \begin_layout Subsubsection*
6108 \begin_layout Standard
6109 In order to use SumatraPDF for inverse search, enter
6110 \begin_inset Flex CharStyle:Code
6113 \begin_layout Plain Layout
6119 in the viewer setting in
6120 \begin_inset Flex CharStyle:MenuItem
6123 \begin_layout Plain Layout
6124 Preferences\SpecialChar \menuseparator
6125 File Handling\SpecialChar \menuseparator
6126 File formats\SpecialChar \menuseparator
6133 \begin_inset Flex CharStyle:Code
6136 \begin_layout Plain Layout
6142 is the following script (to be placed in your command PATH,
6143 \begin_inset Flex CharStyle:Code
6146 \begin_layout Plain Layout
6152 being the best choice):
6155 \begin_layout LyX-Code
6157 \begin_inset Newline newline
6161 \begin_inset Newline newline
6164 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
6167 \begin_layout Standard
6168 This wrapper script is needed because SumatraPDF is a native Windows application
6169 and does not understand the posix paths used by the Cygwin version of LyX.
6170 If SumatraPDF.exe is not in your command PATH, use its full posix path in
6173 \begin_inset Flex CharStyle:Code
6176 \begin_layout Plain Layout
6182 enables communication via the
6188 \begin_inset Flex CharStyle:Code
6191 \begin_layout Plain Layout
6197 option if you want to use the
6201 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6204 \begin_layout Standard
6205 Reverse search is triggered by double-click.
6208 \begin_layout Chapter
6209 Special Document Classes
6212 \begin_layout Section
6216 \begin_layout Standard
6222 \begin_layout Subsection
6226 \begin_layout Standard
6227 This section describes how LyX can be used to write articles for submission
6228 to the scientific journal
6230 Astronomy and Astrophysics
6232 (www.edpsciences.fr/aa/
6233 \begin_inset Flex URL
6236 \begin_layout Plain Layout
6238 http://www.edpsciences.fr/aa/
6243 ) using Version 5.01 of the document class
6248 This package can be downloaded from the ftp site
6251 \begin_layout Standard
6252 \begin_inset VSpace medskip
6258 \begin_layout Standard
6260 \begin_inset Flex URL
6263 \begin_layout Plain Layout
6265 ftp://ftp.edpsciences.org/pub/aa/readme.html
6273 \begin_layout Standard
6274 \begin_inset VSpace medskip
6280 \begin_layout Standard
6281 A manual comes together with that package, and this text is not meant to
6282 replace the original manual but merely a short guide how to realize the
6283 correct form of your paper.
6287 \begin_layout Standard
6288 Please note that the publisher of the journal was changed from Springer
6289 to EDP Sciences starting January 1, 2001.
6290 That change implicated also some slight changes of the style files, namely
6291 the removal of the thesaurus command.
6292 The LyX class aa supports the newest version of these style files, V 5.01.
6293 If you have an older version installed, please upgrade.
6294 For compatibility, the old (version 4) layout has been kept as
6299 Please refer to the comments in
6301 LyXDir/layouts/aapaper.layout
6306 \begin_layout Subsection
6310 \begin_layout Standard
6311 It is recommended you start from the example template distributed with LyX.
6312 If you are not using a template, note the following settings:
6315 \begin_layout Itemize
6322 Document\SpecialChar \menuseparator
6325 dialog (OK, that one was obvious).
6328 \begin_layout Itemize
6329 Don't change the option
6332 \begin_inset space ~
6342 The whole layout is done by the macros, you shouldn't change anything.
6345 \begin_layout Subsection
6349 \begin_layout Standard
6350 First thing to enter is the header information.
6351 It consists of seven entries, of which some are optional.
6355 \begin_layout Itemize
6363 \begin_layout Itemize
6371 \begin_layout Itemize
6379 \begin_layout Itemize
6387 \begin_layout Itemize
6392 : [optional] if more than one author: whom to contact for offprint requests.
6395 \begin_layout Itemize
6400 : [optional] mail address for contacts.
6403 \begin_layout Itemize
6411 Received: <date>; Accepted <date>
6414 \begin_layout Standard
6415 There is no need to issue the
6421 command, this is done automatically by LyX when the header is finished.
6422 Although the order of the single header entries doesn't matter it is advised
6423 to keep the above sequence, just to get the best optics and meets the layout
6424 of the real document.
6427 \begin_layout Standard
6428 If you want to place footnotes in the header block, e.
6429 \begin_inset space \thinspace{}
6433 \begin_inset space \space{}
6436 to state your present address, just use the standard footnote via the menu
6439 Insert\SpecialChar \menuseparator
6443 LyX will automagically use the term
6452 \begin_layout Standard
6453 In addition to these topics, the macros use three additional LaTeX commands
6454 that have no counterpart in LyX:
6457 \begin_layout Itemize
6464 to separate different names for more than one author and institute, respectivel
6468 \begin_layout Itemize
6475 to mark corresponding author/institute pairs.
6476 The institutes are numbered sequentially as they appear in the
6480 field, so you have to put a marker to each author.
6483 \begin_layout Itemize
6490 to supply an email address for fast contact.
6493 \begin_layout Standard
6494 In all cases, the appropriate command has to be entered in LyX and marked
6500 \begin_layout Subsection
6504 \begin_layout Standard
6505 The abstract should immediately follow the header block.
6506 With version 5 the abstract environment was changed to a command, and there
6507 is now a resctriction to only one paragraph.
6508 In addition, it should contain an entry with the keywords.
6509 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6516 by hand and mark it as LaTeX code.
6517 Refer to the example paper.
6520 \begin_layout Subsection
6521 Supported environments
6524 \begin_layout Standard
6525 The A&A paper layout supports the following environments for structuring
6529 \begin_layout Itemize
6535 \begin_layout Itemize
6541 \begin_layout Itemize
6547 \begin_layout Itemize
6553 \begin_layout Itemize
6559 \begin_layout Itemize
6565 \begin_layout Itemize
6571 \begin_layout Itemize
6577 \begin_layout Itemize
6583 \begin_layout Itemize
6589 \begin_layout Itemize
6595 \begin_layout Itemize
6601 \begin_layout Subsection
6602 Commands not supported by LyX
6605 \begin_layout Standard
6606 Some commands are not yet supported by the
6611 Some have already been mentioned.
6612 For the sake of completeness, they are listed all together here:
6615 \begin_layout Itemize
6623 \begin_layout Itemize
6631 \begin_layout Itemize
6639 \begin_layout Itemize
6647 \begin_layout Itemize
6655 \begin_layout Itemize
6663 \begin_layout Itemize
6671 \begin_layout Itemize
6679 \begin_layout Standard
6680 If you want to use any of these commands, you have to enter them yourself.
6683 Do not forget to mark them as LaTeX code!
6686 \begin_layout Subsection
6687 Figure and Table Floats
6690 \begin_layout Standard
6691 LyX provides support for the necessary float environments
6693 figure, figure*, table
6699 , therefore we won't tell much about it here.
6703 \begin_inset space ~
6709 Just remember that tables should be left-aligned.
6710 For that, select the table and change the alignment in
6712 Edit\SpecialChar \menuseparator
6714 \begin_inset space ~
6720 \begin_layout Standard
6721 There is only one special thing: the figures with caption besides the figure.
6722 To create such a figure, you have to do the following:
6725 \begin_layout Enumerate
6726 Create a wide figure float:
6728 Insert\SpecialChar \menuseparator
6729 Float\SpecialChar \menuseparator
6732 , then right click in the figure and select
6738 \begin_inset space ~
6746 \begin_layout Enumerate
6747 Enter your caption text.
6750 \begin_layout Enumerate
6755 to move the cursor above the caption.
6758 \begin_layout Enumerate
6762 \begin_layout Enumerate
6763 Position the cursor behind the figure and insert a horizontal fill:
6765 Insert\SpecialChar \menuseparator
6767 \begin_inset space ~
6770 Character\SpecialChar \menuseparator
6772 \begin_inset space ~
6780 \begin_layout Enumerate
6781 Switch to LaTeX mode:
6784 \begin_inset space ~
6792 \begin_layout Enumerate
6802 Do not close the brace!
6805 \begin_layout Enumerate
6806 Position the cursor behind the caption text, switch to LaTeX mode and insert
6810 \begin_inset space ~
6822 \begin_layout Standard
6823 Also, refer to the figures in the example paper.
6826 \begin_layout Subsection
6830 \begin_layout Standard
6831 For submission, the paper has to be formated in a special double-spacing
6833 For this purpose, you have to give the option
6837 to the documentclass.
6838 This must be done using the extra class options field in the
6840 Document\SpecialChar \menuseparator
6844 Just enter the string
6851 \begin_layout Subsection
6855 \begin_layout Standard
6860 directory contains an example paper written with LyX.
6861 It is the example paper from the original macro package, translated to
6863 Use it for inspiration, and compare the original LaTeX code with LyX way
6867 \begin_layout Section
6871 \begin_layout Standard
6877 \begin_layout Subsection
6881 \begin_layout Standard
6882 AASTeX is a set of macros produced by the American Astronomical Society
6883 to facilitate electronic manuscript submission to the three journals they
6884 publish: the Astrophysical Journal (including the Letters and Supplement),
6885 the Astronomical Journal, and the Publications of the Astronomical Society
6887 LyX has proven to be an excellent tool for generating these documents,
6888 especially given its equation, citation, and figure handling capabilities.
6889 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6890 is the version described here, or higher.
6891 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6892 incompatible with LyX.
6893 The AASTeX package may be downloaded from the AASTeX Web site
6896 \begin_layout Standard
6897 \begin_inset VSpace medskip
6903 \begin_layout Standard
6905 \begin_inset Flex URL
6908 \begin_layout Plain Layout
6910 http://www.journals.uchicago.edu/AAS/AASTeX
6918 \begin_layout Standard
6919 \begin_inset VSpace medskip
6925 \begin_layout Standard
6926 A complete user guide is contained in that package and you should familiarize
6927 yourself with it thoroughly before embarking on writing a paper in LyX.
6928 LyX will not reduce the need to figure out all the AASTeX commands, it
6929 will only reduce the drudgery of typing everything in.
6930 It is your responsibility to ensure that the final exported LaTeX document
6931 conforms completely to the requirements of the journal to which you are
6932 submitting your paper.
6935 \begin_layout Subsection
6936 Starting a New Paper
6939 \begin_layout Standard
6940 I strongly suggest that you start with the AASTeX template file.
6943 File\SpecialChar \menuseparator
6950 , enter the new file name, then choose the
6955 This will show the most common fields found in a manuscript.
6956 Simply overwrite the existing text (including the brackets,
6960 ) with the correct information.
6961 Many of the AASTeX commands and environments can be implemented directly
6962 in LyX, but some cannot: most noticeably
6974 , which should stick out like a sore thumb if you actually just opened the
6976 For commands such as these, the LaTeX code must be entered directly and
6978 Such commands are referred to as TeX code, or Evil Red Text.
6979 I tried to minimize the amount of TeX code needed in an AASTeX document,
6980 but there is still a bit more required than any of us would like.
6983 \begin_layout Subsection
6984 Finishing Your Paper
6987 \begin_layout Standard
6988 When the paper is finished to your satisfaction and previews/prints correctly,
6990 \begin_inset Quotes eld
6994 \begin_inset Quotes erd
6997 actions which need to be done before you submit it to the journals.
7001 \begin_layout Enumerate
7002 Export your paper as a LaTeX file (
7004 File\SpecialChar \menuseparator
7005 Export\SpecialChar \menuseparator
7012 \begin_layout Enumerate
7017 file with your favorite text editor
7021 \begin_layout Enumerate
7022 remove the comment lines before the
7031 \begin_layout Enumerate
7036 usepackage...{fontenc}
7038 line if it appears (usually just after
7053 \begin_layout Enumerate
7054 remove everything between (and including) the
7066 commands, except for any commands you specifically put into the LaTeX preamble
7067 (which should appear immediately after the
7068 \begin_inset Quotes eld
7071 User specified LaTeX commands
7072 \begin_inset Quotes erd
7083 \begin_layout Enumerate
7084 Run the resulting file through LaTeX to make sure it still processes correctly.
7087 \begin_layout Enumerate
7088 Reread the journal requirements to make sure your filenames and formats
7092 \begin_layout Enumerate
7096 \begin_layout Subsection
7097 Comments On Specific Commands
7100 \begin_layout Standard
7101 I will not describe the detailed usage of the individual AASTeX commands:
7102 the AASTeX User Guide (
7106 ) gives a good description of each.
7107 Thus it's probably easiest for me to go down the list as found in the guide
7108 and offer comments where necessary.
7109 So let's begin \SpecialChar \ldots{}
7113 \begin_layout Subsubsection
7114 Things that work as expected
7117 \begin_layout Standard
7121 \begin_layout Plain Layout
7133 \begin_layout Standard
7134 Because they work as you might expect, I simply list them and the section
7235 begin{thebibliography}
7243 (2.13.2), all the cite commands and their variations (2.13.2), the generic
7244 graphicx figure commands (2.14.1),
7268 (2.15.4, amongst other places),
7295 \begin_layout Standard
7296 The following style options also work correctly:
7317 Simply put them in the
7323 Layout\SpecialChar \menuseparator
7329 \begin_layout Standard
7333 \begin_layout Plain Layout
7345 \begin_layout Subsubsection
7346 Things that work, but require more comment
7349 \begin_layout Standard
7350 The following items work, but require a little more discussion:
7353 \begin_layout Itemize
7354 These items are reserved for use by the journal editors, but you can put
7355 them into the LaTeX preamble if you feel compelled to do so:
7388 \begin_layout Itemize
7389 These items may be placed in the LaTeX preamble, and are included as blanks
7390 in the template file:
7411 \begin_layout Itemize
7418 (2.3) – can only be used
7419 \begin_inset Quotes eld
7423 \begin_inset Quotes erd
7426 , not in the middle of a paragraph.
7427 Use TeX code if you need to embed it.
7430 \begin_layout Itemize
7437 (2.3) – will have extra {} after it.
7438 This should not cause an error.
7441 \begin_layout Itemize
7448 (2.6) – can only be used
7449 \begin_inset Quotes eld
7453 \begin_inset Quotes erd
7456 , not in the middle of a paragraph.
7457 Use TeX code if you need to embed it.
7460 \begin_layout Itemize
7467 (2.8) – can't insert a cross-reference tag, you must type the tag name by
7471 \begin_layout Itemize
7485 \begin_layout Itemize
7492 (2.9) – will have extra {} after it.
7493 This should not cause an error.
7496 \begin_layout Itemize
7503 (2.11) – will have extra {} after it.
7504 This should not cause an error.
7507 \begin_layout Itemize
7514 (2.14.2) – you can insert an optional filename argument by placing the cursor
7515 at the beginning of the text and selecting
7517 Insert\SpecialChar \menuseparator
7522 \begin_inset Quotes eld
7526 \begin_inset Quotes erd
7529 inserts an optional argument of the type needed by
7536 Hopefully it will be renamed someday.
7539 \begin_layout Itemize
7552 for the catalog ID optional parameter
7555 \begin_layout Itemize
7568 for the catalog ID optional parameter
7571 \begin_layout Subsubsection
7572 Things not implemented, use TeX code
7575 \begin_layout Standard
7579 \begin_layout Plain Layout
7591 \begin_layout Standard
7614 setcounter{equation}
7616 (2.12), Journal name abbreviations (2.13.4),
7652 (2.15.4, insert it as the first element in the lefthand cell after where
7654 Don't use any of LyX's rules in the table),
7666 (2.15.5), much of Misc (2.17, except
7717 \begin_layout Standard
7721 \begin_layout Plain Layout
7733 \begin_layout Subsubsection
7734 Things that cannot be implemented
7737 \begin_layout Standard
7738 \SpecialChar \ldots{}
7739 at least in any meaningful sort of way, so I suggest ignoring them.
7740 They are the references environment (2.13.3), and the deluxetable environment
7742 If you really, really need to use deluxetable, I suggest editing it in
7743 a separate file with a text editor, then using
7745 Insert\SpecialChar \menuseparator
7747 \begin_inset space ~
7752 to include it in your LyX document.
7757 file to see an example of this.
7760 \begin_layout Subsection
7761 FAQs, Tips, Tricks, and Other Ruminations
7764 \begin_layout Subsubsection
7765 Getting LyX and AASTeX to cooperate
7768 \begin_layout Standard
7769 It can be a bit tricky to get LyX to recognize a new layout and document
7771 When all else fails, do this:
7774 \begin_layout Enumerate
7775 Make certain that LaTeX can find AASTeX.
7776 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7777 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7784 \begin_layout Enumerate
7796 \begin_layout Enumerate
7799 Tools\SpecialChar \menuseparator
7802 in LyX, then restart LyX.
7805 \begin_layout Enumerate
7806 Open a regular new file, not from a template.
7807 Does AASTeX appear in the class list in
7809 Document\SpecialChar \menuseparator
7815 \begin_layout Standard
7816 If you get a warning from an existing AASTeX document about not being able
7817 to find the AASTeX layout or a message about
7818 \begin_inset Quotes eld
7821 You should not mix title layouts with normal ones
7822 \begin_inset Quotes erd
7825 , things haven't been installed correctly.
7828 \begin_layout Subsubsection
7829 LaTeX error processing a table
7832 \begin_layout Standard
7833 LyX, by default, attempts to center the table caption/title.
7834 This seems to produce a bad interaction in AASTeX so you should click somewhere
7835 in the caption/title, then select
7837 Edit\SpecialChar \menuseparator
7839 \begin_inset space ~
7853 This took care of it for me.
7856 \begin_layout Subsubsection
7860 \begin_layout Standard
7861 A couple of things: 1) I have noticed some funny spacing in the reference
7862 entries in the text.
7863 When you enter the bibliography item data, make sure their is
7867 space between the last author and the parenthesis setting off the year;
7871 \begin_inset space \thinspace{}
7875 \begin_inset space \space{}
7889 2) Entering the references at all is not obvious.
7890 The easiest thing is to start typing your first reference at the end of
7891 the document, then mark it as type
7896 That will put a small gray box in front of what you just typed.
7897 Click on the box to fill in the rest of the information.
7898 For new references, go to the end of an existing reference and press return.
7899 That will create a new line with its own box, etc.
7902 \begin_layout Subsubsection
7906 \begin_layout Standard
7907 Even though AASTeX provides its own figure commands (
7913 , for example), I much prefer LaTeX's standard figure commands (with the
7922 \begin_inset space ~
7925 commands as TeX code into a Figure Float box if you desire, but I never
7926 have much luck getting the layout right.
7927 With the standard graphics, LyX will insert a
7931 usepackage{graphicx}
7933 command into the LaTeX preamble and handle the figures in the standard
7934 LaTeX2e way, interspersing the figures in the text.
7935 I believe ApJ accepts figures exactly this way now; AJ might still use
7937 \begin_inset Quotes eld
7940 stack everything at the end
7941 \begin_inset Quotes erd
7947 \begin_layout Subsubsection
7948 Things I could have done, but didn't
7951 \begin_layout Standard
7953 \begin_inset Quotes eld
7957 \begin_inset Quotes erd
7960 things I could have implemented, but chose not to.
7961 For instance, I saw no point in double-spacing the text in the LyX window,
7962 even though it is double-spaced in the paper manuscript.
7963 Also, I chose not to make separate layouts for the preprint and preprint2
7965 Since I assume you will spend most of your time in the plain manuscript
7966 mode anyway, I decided not to chew up more disk space with this.
7970 \begin_layout Subsection
7974 \begin_layout Standard
7975 Your mileage may vary.
7976 I've now had papers published by both ApJ and AJ that have had 98% of the
7977 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7979 I have had no trouble with the submission process, and I'm sure the journals
7980 were never aware that there might be a difference.
7981 So, go forth and publish!
7984 \begin_layout Section
7988 \begin_layout Standard
7991 David Johnson; updated by Richard Heck
7994 \begin_layout Standard
7995 \begin_inset VSpace bigskip
8001 \begin_layout Standard
8003 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8004 papers to be submitted to American Mathematical Society publications.
8005 The layouts are not tailored to a specific journal, but easily can be.
8006 You should refer to the AMS documentation for specific instructions for
8007 each journal (usually it will entail only changing a single line in the
8009 That documentation is available on the Web at
8010 \begin_inset Flex URL
8013 \begin_layout Plain Layout
8021 \begin_inset Flex URL
8024 \begin_layout Plain Layout
8026 ftp://ftp.ams.org/pub/tex/amslatex/
8032 These layouts are appropriate, and useful, for any mathematical writing.
8036 \begin_layout Standard
8037 There are two basic AMS LaTeX layouts:
8040 \begin_layout Itemize
8041 amsart: The standard AMS article format.
8044 \begin_layout Itemize
8045 amsbook: the standard AMS book (really, monograph) format.
8049 \begin_layout Standard
8050 The layouts themselves contain only the minimum necessary to use the AMS
8052 They do not, in particular, contain any of the `theorem' environments used
8053 for setting theorems, lemmas, and the like.
8054 These are contained, instead, in the
8055 \begin_inset Flex CharStyle:Code
8058 \begin_layout Plain Layout
8064 module, which is loaded by default when when you select one of the AMS
8066 (It can also be used with other classes and can be removed, if you would
8067 rather use something else.) Less commonly used environments are in the
8068 \begin_inset Flex CharStyle:Code
8071 \begin_layout Plain Layout
8072 Theorems (AMS-Extended)
8077 module, which must be loaded manually.
8080 \begin_layout Standard
8081 By default, theorems and the like are numbered consecutively throughout
8082 the document, but this may be modified by loading the module
8083 \begin_inset Flex CharStyle:Code
8086 \begin_layout Plain Layout
8087 Theorems (Order by Section)
8092 or, if you are using
8093 \begin_inset Flex CharStyle:Code
8096 \begin_layout Plain Layout
8103 \begin_inset Flex CharStyle:Code
8106 \begin_layout Plain Layout
8107 Theorems (Order by Chapter)
8113 These will number the results as
8114 \begin_inset Formula $n.m$
8117 , where the first number refers to the section (or chapter) and the second
8118 refers to the total number of results so far in that section (or chapter).
8119 Many environments are also available unnumbered.
8120 These are indicated by an asterisk at the end.
8121 If you happen to want
8125 unnumbered results, the the module
8126 \begin_inset Flex CharStyle:Code
8129 \begin_layout Plain Layout
8135 provides that option.
8138 \begin_layout Standard
8139 Note that these modules do not
8143 to be used with the AMS classes.
8144 It is perfectly possible to use the
8145 \begin_inset Flex CharStyle:Code
8148 \begin_layout Plain Layout
8154 module, and the others mentioned, with other classes, such as
8155 \begin_inset Flex CharStyle:Code
8158 \begin_layout Plain Layout
8165 \begin_inset Flex CharStyle:Code
8168 \begin_layout Plain Layout
8175 \begin_inset Flex CharStyle:Code
8178 \begin_layout Plain Layout
8187 \begin_layout Subsection
8188 What these layouts provide
8191 \begin_layout Standard
8192 There is a long list of included environments provided by these layouts.
8193 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
8194 variety of `theorem' environments.
8195 However, the AMS recommends the environments that are available in LyX.
8199 \begin_layout Standard
8200 The following environments—as well as the standard environments, such as
8202 \begin_inset Flex CharStyle:Noun
8205 \begin_layout Plain Layout
8212 \begin_inset Flex CharStyle:Noun
8215 \begin_layout Plain Layout
8222 \begin_inset Flex CharStyle:Noun
8225 \begin_layout Plain Layout
8232 \begin_inset Flex CharStyle:Noun
8235 \begin_layout Plain Layout
8242 \begin_inset Flex CharStyle:Noun
8245 \begin_layout Plain Layout
8252 \begin_inset Flex CharStyle:Code
8255 \begin_layout Plain Layout
8262 \begin_inset Flex CharStyle:Code
8265 \begin_layout Plain Layout
8274 \begin_layout Description
8275 Address This should be the author's permanent address.
8278 \begin_layout Description
8280 \begin_inset space ~
8283 Address This should be the author's temporary address at the time of submission,
8284 if different from the Address.
8287 \begin_layout Description
8288 Email Author's e-mail address
8291 \begin_layout Description
8292 URL Author's Web address, if desired.
8295 \begin_layout Description
8296 Keywords Key words or phrases used to identify specific topics discussed
8300 \begin_layout Description
8301 Subjectclass These refer to the AMS Subject Classifications, published and
8304 Mathematical Reviews
8307 These are also available online at the AMS cites listed above.
8310 \begin_layout Description
8314 \begin_layout Description
8318 \begin_layout Description
8322 \begin_layout Standard
8323 The following environments are provided by both the
8324 \begin_inset Flex CharStyle:Code
8327 \begin_layout Plain Layout
8334 \begin_inset Flex CharStyle:Code
8337 \begin_layout Plain Layout
8343 modules, in the latter case in both starred (unnumbered) and unstarred
8344 (numbered) versions.
8345 These same environments are provided only in the starred versions by the
8347 \begin_inset Flex CharStyle:Code
8350 \begin_layout Plain Layout
8359 \begin_layout Theorem
8360 This is typically used for the statements of major results.
8364 \begin_layout Corollary*
8365 This is used for statements which follow fairly directly from previous statement
8367 Again, these can be major results.
8372 These are smaller results needed to prove other statements.
8375 \begin_layout Proposition
8376 These are less major results which (hopefully) add to the general theory
8380 \begin_layout Conjecture
8381 These are statements provided without justification, which the author does
8382 not know how to prove, but which seem to be true (to the author, at least).
8385 \begin_layout Definition*
8386 Guess what this is for.
8387 The font is different for this environment than for the previous ones.
8391 \begin_layout Example*
8392 Used for examples illustrating proven results.
8395 \begin_layout Problem
8396 It's not really known what this is for.
8397 You should figure it out.
8400 \begin_layout Exercise*
8401 Write a description for this one.
8404 \begin_layout Remark
8405 This environment is also a type of theorem, usually a lesser sort of observation.
8408 \begin_layout Claim*
8409 Often used in the course of giving a proof of a larger result.
8413 Generally, these are used to break up long arguments, using specific instances
8419 The numbering scheme for cases is on its own, not together with other numbered
8425 At the end of this environment, a QED symbol (usually a square, but it can
8426 vary with different styles) is placed.
8427 If you want to have other environments within this one—for example, Case
8428 environments—and have the QED symbol appear only after them, then the other
8429 environments need to be nested within the proof environment.
8432 Nesting Environments
8438 for information on nesting.
8441 \begin_layout Standard
8442 And these environments are provided by
8443 \begin_inset Flex CharStyle:Code
8446 \begin_layout Plain Layout
8447 Theorems (AMS-Extended)
8455 \begin_layout Criterion*
8456 A required condition.
8459 \begin_layout Algorithm*
8460 A general procedure to be used.
8463 \begin_layout Axiom*
8464 This is a property or statement taken as true within the system being discussed.
8467 \begin_layout Condition*
8468 Sometimes used to state a condition assumed within the present context of
8473 Similar to a Remark.
8476 \begin_layout Notation*
8477 Used for the explanation of, yes, notation.
8480 \begin_layout Summary
8481 Do we really need to tell you?
8484 \begin_layout Acknowledgement*
8488 \begin_layout Conclusion*
8489 Sometimes used at the end of a long train of argument.
8493 Used in a way similar to Proposition, though perhaps lower on the scale.
8496 \begin_layout Standard
8497 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8499 They need to be available on your system in order to use these environments.
8502 \begin_layout Section
8510 \begin_layout Standard
8516 \begin_layout Subsection
8520 \begin_layout Standard
8521 These are the layout files for some of the journals of the American Geophysical
8523 It is assumed that you have both the AGU's own class files and AGUplus
8524 installed (everything to be found at
8525 \begin_inset Flex URL
8528 \begin_layout Plain Layout
8530 ftp://ftp.agu.org/journals/latex/journals
8538 \begin_layout Subsection
8542 \begin_layout Standard
8552 They are still called this in the LyX GUI, though their LaTeX equivalents
8553 in the AGU classes are
8564 \begin_layout Standard
8565 Newly defined styles are
8602 These are mostly manuscript attributes and defined in the AGU class documentati
8606 \begin_layout Standard
8607 I suspect this is still badly incomplete.
8610 \begin_layout Subsection
8614 \begin_layout Standard
8631 \begin_layout Subsection
8635 \begin_layout Itemize
8638 Journal of Geophysical Research
8647 \begin_layout Standard
8648 Add your own, it isn't so hard! Look at the
8659 \begin_layout Subsection
8660 Bugs and things to remember
8663 \begin_layout Standard
8664 In order to use the new layouts, you must remember to do the following for
8668 \begin_layout Enumerate
8674 This can be done in the
8676 Layout\SpecialChar \menuseparator
8681 Document\SpecialChar \menuseparator
8685 (AGU articles are always in English, right? So
8692 \begin_layout Enumerate
8702 (Yes, this is a bug.)
8705 \begin_layout Enumerate
8706 Make sure you use the
8710 bibliography style, by entering
8714 into the second field of the BibTeX inset.
8715 None of the standard styles will do.
8718 \begin_layout Section
8722 \begin_layout Standard
8728 \begin_layout Subsection
8732 \begin_layout Standard
8733 Broadway is for writing plays.
8734 The format is more decorative than Hollywood, and much less standardized.
8735 This format should be suitable for workshops.
8738 \begin_layout Subsection
8742 \begin_layout Standard
8743 The same as in Hollywood.
8746 \begin_layout Subsection
8750 \begin_layout Standard
8755 names as labels then cross-reference the label to insert the name.
8756 The cross-reference dialog will show the current cast of characters.
8759 \begin_layout Subsection
8760 Paper size and Margins
8763 \begin_layout Standard
8764 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8767 \begin_layout Subsection
8771 \begin_layout Standard
8772 The following environments are available.
8773 You can use broadway.bind to get the bind keys shown at the right.
8776 \begin_layout Itemize
8780 \begin_inset Newline newline
8785 You should not have to use this, but it is here for anything that does not
8789 \begin_layout Itemize
8793 \begin_inset space \hfill{}
8797 \begin_inset Newline newline
8802 Used to describe stage setting and the action.
8803 First use of speaker names in all CAPs.
8806 \begin_layout Itemize
8810 \begin_inset space \hfill{}
8814 \begin_inset Newline newline
8819 Automatically numbered.
8820 On screen it will be arabic, but will print as Roman.
8823 \begin_layout Itemize
8827 \begin_inset space \hfill{}
8831 \begin_inset Newline newline
8841 It is just centered text.
8844 \begin_layout Itemize
8848 \begin_inset space \hfill{}
8852 \begin_inset Newline newline
8857 Not automatically numbered.
8858 You supply the number.
8859 This is because I couldn't figure out how.
8862 \begin_layout Itemize
8866 \begin_inset space \hfill{}
8870 \begin_inset Newline newline
8875 A special case of Narrative to describe the setting and action as the curtain
8879 \begin_layout Itemize
8883 \begin_inset space \hfill{}
8887 \begin_inset Newline newline
8892 The speaker's (actor's) title, centered in all CAPS.
8895 \begin_layout Itemize
8899 \begin_inset space \hfill{}
8903 \begin_inset Newline newline
8908 Instructions to the speaker.
8909 The parentheses are automatically inserted.
8910 The ( will appear on screen, but both will be in the printed play.
8911 This environment is only used within
8918 \begin_layout Itemize
8922 \begin_inset space \hfill{}
8926 \begin_inset Newline newline
8931 What the Speaker says.
8934 \begin_layout Itemize
8938 \begin_inset space \hfill{}
8942 \begin_inset Newline newline
8947 The curtain comes down.
8950 \begin_layout Itemize
8954 \begin_inset space \hfill{}
8960 \begin_layout Itemize
8964 \begin_inset space \hfill{}
8970 \begin_layout Itemize
8974 \begin_inset space \hfill{}
8980 \begin_layout Standard
8984 \begin_layout Section
8988 \begin_layout Standard
8993 can be used to type letters according to German conventions.
8994 A template file is included in
8996 .../lyx/share/templates
8998 for you to use as a starting point.
9001 \begin_layout Section
9009 \begin_layout Standard
9015 \begin_layout Subsection
9019 \begin_layout Standard
9020 This is the layout file for the European Geophysical Society journals.
9025 can be downloaded from the web site of the EGS under
9026 \begin_inset Flex URL
9029 \begin_layout Plain Layout
9039 \begin_layout Subsection
9043 \begin_layout Standard
9046 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9054 The current layout file is unfortunately very unmodular and would benefit
9055 from using the various
9062 \begin_layout Section
9066 \begin_layout Standard
9072 \begin_layout Standard
9073 Elsevier Science Publishers B.V.
9074 provides a standard LaTeX document class (
9078 ) for submitting articles to their various journals.
9079 The style file can be downloaded directly from their web site:
9080 \begin_inset Flex URL
9083 \begin_layout Plain Layout
9085 http://authors.elsevier.com/
9091 Instructions are supplied along with the class file, which details the
9092 requirements of the publishers.
9093 LyX includes package that allows for the use of this class, by a layout
9094 and a template file.
9095 Installation of the class file is the same as for any other LaTeX package;
9096 instructions are provided in the Elsevier documentation.
9099 \begin_layout Standard
9109 As the Elsevier class file is based mainly on the standard article class,
9110 most of the normal functionality is provided.
9111 The Elsevier class defines a number of mathematical environments, which
9112 are similar to the AMS environments.
9113 These commands are all described in the Elsevier documentation, and are
9117 \begin_layout Standard
9118 The easiest way to use the Elsevier style is to base documents on the included
9120 It is best not to use options such as fancy headings or the geometry package,
9121 as elements such as these are defined by Elsevier in their style file.
9122 Ideally, no extra packages except those mentioned in the Elsevier documentation
9124 Essentially, Elsevier require as
9125 \begin_inset Quotes eld
9129 \begin_inset Quotes erd
9132 a LaTeX file as possible, as their intention is to take the supplied file
9133 and replace the class file with one for the particular journal to which
9134 the paper has been submitted.
9135 This also means that not too much time should be spent on the formating
9137 When it comes to be published, this will change anyway.
9138 The rest of the usage for this layout is substantially the same as for
9139 the normal article class.
9140 For details of what Elsevier do and don't allow, refer to their documentation.
9143 \begin_layout Section
9149 \begin_inset CommandInset label
9158 \begin_layout Standard
9164 \begin_layout Subsection
9168 \begin_layout Standard
9169 This section describes how to use LyX to make slides for overhead projectors.
9170 There are two document classes that can do this: the default slides class
9176 This section documents the latter.
9179 \begin_layout Standard
9180 I'm going to say this again, nice and clear, so that there's no misunderstanding
9184 \begin_layout Standard
9185 \begin_inset VSpace bigskip
9191 \begin_layout Standard
9195 This section documents the class
9196 \begin_inset Quotes eld
9204 \begin_inset Quotes erd
9212 \begin_layout Standard
9213 \begin_inset VSpace bigskip
9219 \begin_layout Standard
9220 If you're looking for the documentation for
9221 \begin_inset Quotes eld
9229 \begin_inset Quotes erd
9233 \begin_inset space ~
9237 \begin_inset CommandInset ref
9239 reference "sec:slitex"
9244 If your machine doesn't have the
9249 \begin_inset Quotes eld
9257 \begin_inset Quotes erd
9260 ] installed, you'll probably have to use the default
9264 class, which isn't quite as good as
9269 \begin_layout Standard
9274 class is designed for use with version 2.1 of the
9278 LaTeX class file which is now an integral part of LaTeX2e.
9281 \begin_layout Subsection
9285 \begin_layout Standard
9286 Obviously, to use this document class, you need to select
9287 \begin_inset Quotes eld
9295 \begin_inset Quotes erd
9305 \begin_inset space ~
9311 There are some settings in the
9314 \begin_inset space ~
9319 dialog that you should know about that are specific to this class:
9322 \begin_layout Itemize
9323 Don't change the options
9334 \begin_inset space ~
9340 They're ignored by the
9347 \begin_layout Itemize
9348 The default font size is 20
9349 \begin_inset space \thinspace{}
9352 pt with the other options being 17
9353 \begin_inset space \thinspace{}
9357 \begin_inset space \thinspace{}
9361 \begin_inset space \thinspace{}
9367 \begin_layout Itemize
9376 but all math equations are still typeset in the usual roman font.
9379 \begin_layout Itemize
9384 supports A4 and Letter paper sizes as well as a special size for working
9386 \begin_inset space \thinspace{}
9390 It doesn't support A5, B5, legal or executive paper sizes.
9393 \begin_layout Itemize
9394 Don't bother changing the
9398 settings because they are ignored anyway.
9399 All floats appear where they are defined in the text.
9402 \begin_layout Itemize
9407 setting behaves a bit differently for this class.
9412 provides extensive footer and header capabilities including a user-defined
9415 \begin_inset space ~
9419 \begin_inset CommandInset ref
9421 reference "sec:foilfoot"
9426 The title page is treated differently to all other pages in the document
9435 has the logo centered at the bottom of the page (if one is defined).
9436 The possible page style choices and what they do are as follows:
9440 \begin_layout Labeling
9441 \labelwidthstring MMMMMMM
9448 The final output contains no page numbers, or other headers or footers
9449 (except footnotes of course).
9453 \begin_layout Labeling
9454 \labelwidthstring MMMMMMM
9461 The final output contains page numbers centered at the bottom of the page.
9462 No other headings or footers (other than footnotes).
9465 \begin_layout Labeling
9466 \labelwidthstring MMMMMMM
9471 Page numbers in lower right corner.
9472 Additional headers and footers are also shown.
9473 This is also the default.
9476 \begin_layout Labeling
9477 \labelwidthstring MMMMMMM
9482 Gives you access to the
9486 package although its use with
9490 is discouraged by the writer of the
9494 package because of some potential page layout clashes.
9498 \begin_layout Subsubsection
9502 \begin_layout Standard
9503 The following options may be used in the extra class options in the
9505 Document\SpecialChar \menuseparator
9511 \begin_layout Labeling
9512 \labelwidthstring MMMMMMx
9517 This sets up the page layout for 7.33
9518 \begin_inset space \thinspace{}
9522 \begin_inset space \thinspace{}
9525 in paper, which is about the same aspect ratio as a 35
9526 \begin_inset space \thinspace{}
9529 mm slide, making it a bit easier to work with this medium.
9532 \begin_layout Labeling
9533 \labelwidthstring MMMMMMx
9538 Places a rule across the page below the header on every page except the
9542 \begin_layout Labeling
9543 \labelwidthstring MMMMMMx
9548 Places a rule across the page above the footer on every page except the
9552 \begin_layout Labeling
9553 \labelwidthstring MMMMMMx
9558 This is automatically set each time you create a new
9567 to use the dvips driver to rotate those pages that are set as landscape
9571 \begin_layout Labeling
9572 \labelwidthstring MMMMMMx
9577 Simply changes the page dimensions to those of a landscape page but doesn't
9579 Thus if you use this option you need to use an external program to rotate
9580 each page or feed your paper through your printer as landscape.
9581 Note that this option effectively reverses the roles of the
9589 environments (don't worry these are described in the next section).
9592 \begin_layout Labeling
9593 \labelwidthstring MMMMMMx
9598 Equation numbers on the left.
9601 \begin_layout Labeling
9602 \labelwidthstring MMMMMMx
9607 Flush-left equations.
9610 \begin_layout Subsection
9611 Supported Environments
9614 \begin_layout Standard
9615 Most of the environments commonly supported in other classes are also supported
9621 There are several additional environments provided by
9625 as well as a couple added by LyX.
9626 The following environments are shared with other classes:
9629 \begin_layout Standard
9633 \begin_layout Plain Layout
9645 \begin_layout Itemize
9651 \begin_layout Itemize
9657 \begin_layout Itemize
9663 \begin_layout Itemize
9669 \begin_layout Itemize
9675 \begin_layout Itemize
9681 \begin_layout Itemize
9687 \begin_layout Itemize
9693 \begin_layout Itemize
9699 \begin_layout Itemize
9705 \begin_layout Itemize
9711 \begin_layout Itemize
9717 \begin_layout Itemize
9723 \begin_layout Itemize
9729 \begin_layout Itemize
9735 \begin_layout Itemize
9741 \begin_layout Itemize
9747 \begin_layout Itemize
9753 \begin_layout Standard
9757 \begin_layout Plain Layout
9769 \begin_layout Standard
9770 That is, all the major environments apart from the sectioning environments.
9771 Since foils are essentially self-contained sections, with a title and body,
9776 provides specific commands for starting new foils and these are:
9779 \begin_layout Itemize
9785 \begin_layout Itemize
9791 \begin_layout Standard
9792 LyX also provides slightly modified versions of these two environments called:
9795 \begin_layout Itemize
9801 \begin_layout Itemize
9807 \begin_layout Standard
9808 and the differences will be explained in the next section.
9811 \begin_layout Standard
9812 Since foils are often used in presenting ideas or new theorems and such
9817 also provides a comprehensive box of goodies for presenting them:
9820 \begin_layout Standard
9824 \begin_layout Plain Layout
9836 \begin_layout Itemize
9842 \begin_layout Itemize
9848 \begin_layout Itemize
9854 \begin_layout Itemize
9860 \begin_layout Itemize
9866 \begin_layout Itemize
9872 \begin_layout Itemize
9878 \begin_layout Itemize
9884 \begin_layout Itemize
9890 \begin_layout Itemize
9896 \begin_layout Itemize
9902 \begin_layout Standard
9906 \begin_layout Plain Layout
9918 \begin_layout Standard
9919 The starred versions are unnumbered while the unstarred versions are numbered.
9920 There are also two list environments added by LyX and these are:
9923 \begin_layout Itemize
9929 \begin_layout Itemize
9935 \begin_layout Standard
9940 provides some powerful header and footer capabilities that are best set
9941 in the preamble although they may be set at any point in a document.
9942 If you want to change these settings in your document the best place to
9943 do so is at the very top of a foil, i.
9944 \begin_inset space \thinspace{}
9950 \begin_inset space \space{}
9955 straight after the foilhead.
9958 \begin_layout Standard
9959 For this purpose, the following command styles are provided [
9966 \begin_layout Standard
9970 \begin_layout Plain Layout
9982 \begin_layout Itemize
9986 \begin_inset space ~
9992 \begin_layout Itemize
9998 \begin_layout Itemize
10002 \begin_inset space ~
10008 \begin_layout Itemize
10012 \begin_inset space ~
10018 \begin_layout Itemize
10022 \begin_inset space ~
10029 \begin_layout Standard
10030 \begin_inset space ~
10037 \begin_layout Standard
10041 \begin_layout Plain Layout
10053 \begin_layout Standard
10054 There are also a few commands provided by
10058 that aren't directly supported by LyX but I'll tell you what they do and
10059 how to use them in section
10060 \begin_inset space ~
10064 \begin_inset CommandInset ref
10066 reference "sec:unsuppfoils"
10073 \begin_layout Subsection
10074 Building a Set of Foils
10077 \begin_layout Standard
10078 This section will give a simple introduction to using the different environments
10079 to build a set of foils.
10080 If you want to see an example set of foils, take a look at the
10084 file you find in LyX's
10091 \begin_layout Subsubsection
10092 Give It a Title Page
10095 \begin_layout Standard
10096 Unlike other classes that provide
10116 creates the title on a page of its own.
10117 If you leave out the
10121 environment LaTeX will substitute the current date (every time you regenerate
10125 \begin_layout Subsubsection
10129 \begin_layout Standard
10130 As I mentioned earlier, there are four ways of starting a new foil.
10131 For portrait foils you should use
10140 The difference between these two environments is the amount of space between
10141 the title of the foil (the foilhead) and the body of the foil.
10144 \begin_layout Standard
10145 Landscape foils are generated using the
10151 ShortRotatefoilhead
10154 Again the only difference is the spacing between foilhead and body.
10155 Both of the short versions have 0.5 inches less separation between the foilhead
10160 \begin_layout Standard
10161 One problem with the support for landscape foils is the requirement that
10162 you have to use the
10166 driver to generate the PostScript output otherwise the foils won't be rotated.
10167 It is possible to get landscape foils even if you haven't got the
10171 driver provided you can feed your foils sideways through your printer ;-)
10174 \begin_layout Subsubsection
10175 Theorems, Lemmas, Proofs and more
10178 \begin_layout Standard
10179 Due to a small bug in LyX you can't have two of the same type of these environme
10180 nts directly following each other.
10181 They must be separated by something.
10182 If you try, you will just be extending the previous environment as if you
10183 had merged the two environments together.
10184 So, how do you get around this problem? The simplest option is to insert
10185 some text between the two environments or add a
10189 environment between the two with just a
10190 \begin_inset Quotes eld
10198 \begin_inset Quotes erd
10202 This will force LyX to produce two separate environments and hence the
10203 correct LaTeX output.
10204 An example is provided in the example file included with the LyX distribution.
10205 Remember, this problem only occurs if you are trying to place two of the
10206 same type of theorem-like environments one directly after the other.
10209 \begin_layout Subsubsection
10213 \begin_layout Standard
10214 You get all the commonly supported list styles found in other classes as
10215 well as two new ones.
10216 I'll only describe the new ones here.
10217 If you want to find out more about the other list environments check out
10223 If you intend to use itemized lists you might also want to read about the
10227 \begin_inset space ~
10231 \begin_inset space ~
10236 dialog described above in section
10237 \begin_inset space ~
10241 \begin_inset CommandInset ref
10243 reference "sec:bullet"
10250 \begin_layout Standard
10251 The two new list styles,
10259 , are designed to make it easier for you to create lists of do's and don'ts
10260 or right and wrong by providing dedicated environments that use a tick
10261 or a cross as the label of the list.
10262 These lists are in fact dedicated variants of the
10267 They do however require that you have the
10271 packages installed.
10274 \begin_layout Subsubsection
10278 \begin_layout Standard
10283 redefines the floating tables and figures so that they appear exactly where
10284 they are in the text rather than pushing them to the top of the page or
10285 to some user specified location.
10286 In fact if you change the float placement settings they are simply ignored.
10289 \begin_layout Subsubsection
10290 Page Headers and Footers
10291 \begin_inset CommandInset label
10293 name "sec:foilfoot"
10300 \begin_layout Standard
10304 \begin_inset space ~
10313 are two commands used to control the left-footer text string.
10314 The first is meant to allow you to include a graphic logo on your foils
10316 \begin_inset Quotes eld
10324 \begin_inset Quotes erd
10328 While the second is meant to provide a classification for the audience,
10332 \begin_inset space \thinspace{}
10338 \begin_inset space \space{}
10342 It is empty by default.
10345 \begin_layout Standard
10346 The remaining page corners can be filled by
10349 \begin_inset space ~
10354 (which defaults to page numbers),
10357 \begin_inset space ~
10365 \begin_inset space ~
10373 \begin_layout Subsection
10379 \begin_inset CommandInset label
10381 name "sec:unsuppfoils"
10388 \begin_layout Standard
10389 All the commands mentioned below need to be set in a
10397 within another environment.
10400 \begin_layout Subsubsection
10404 \begin_layout Standard
10405 All lengths are adjusted using the
10428 should be replaced by the name given to the length you want to change and
10433 is the length value.
10434 All lengths should be specified in units of length such as inches (
10446 ) or relative to some document or font-based length such as
10456 \begin_layout Standard
10457 It's possible to change the spacing between a foilhead and the body of the
10458 foil by adjusting the length specified by
10465 For example, to make
10470 \begin_inset space \space{}
10473 in closer to their bodies put the following in the preamble:
10479 foilheadskip}{-0.5in}
10482 \begin_layout Standard
10483 The spacings around floats can be adjusted by setting these lengths:
10486 \begin_layout Labeling
10487 \labelwidthstring MMMMMMMMMMM
10494 Separation between the text and the top of the float
10497 \begin_layout Labeling
10498 \labelwidthstring MMMMMMMMMMM
10505 Separation between the float and the caption
10508 \begin_layout Labeling
10509 \labelwidthstring MMMMMMMMMMM
10516 Separation between the caption and the following text
10519 \begin_layout Labeling
10520 \labelwidthstring MMMMMMMMMMM
10527 You can make the captions narrower than the surrounding text by adjusting
10529 Best done relative to
10538 \begin_layout Standard
10539 There are also several title page related lengths that you may find useful
10540 if you have a long title or several authors:
10543 \begin_layout Labeling
10544 \labelwidthstring MMMMMMMMMMM
10551 Separation from headers to
10556 \begin_layout Labeling
10557 \labelwidthstring MMMMMMMMMMM
10575 \begin_layout Labeling
10576 \labelwidthstring MMMMMMMMMMM
10590 \begin_layout Labeling
10591 \labelwidthstring MMMMMMMMMMM
10607 \begin_layout Labeling
10608 \labelwidthstring MMMMMMMMMMM
10624 \begin_layout Standard
10625 The last length related command affects all the list environments.
10636 a list environment then all the vertical spacing between the list items
10638 Note that this is a command not a length so it doesn't require
10644 like the stuff mentioned above.
10647 \begin_layout Subsubsection
10648 Headers and Footers
10651 \begin_layout Standard
10664 commands control whether the logo in the
10668 definition appear on a given page.
10675 in the preamble then none of the foils will have the logo on them.
10676 If you don't want the logo on a particular page place the
10682 directly after the foilhead of that page and the
10688 directly after the next foilhead.
10691 \begin_layout Standard
10692 If you decide to use the
10696 page style setting in the
10699 \begin_inset space ~
10704 dialog you should probably add
10714 to your preamble so headers and footers on landscape pages are correctly
10715 placed when rotated.
10716 This is due to some clashes between the page layouts provided by the
10727 \begin_layout Section
10728 Hollywood (Hollywood spec scripts)
10731 \begin_layout Standard
10737 \begin_layout Subsection
10741 \begin_layout Standard
10742 Getting the format of a Hollywood script right is a
10743 \begin_inset Quotes eld
10747 \begin_inset Quotes erd
10750 It is designed to make the readers focus on content and to be easy and
10751 familiar for the actors to read.
10752 Each page of a script should be one minute of film.
10753 Nothing goes in a script that you cannot see or hear on screen.
10754 The courier 12 pt font should be used throughout.
10758 \begin_layout Subsection
10762 \begin_layout Standard
10763 Speakers' lines should NEVER break in mid-sentence.
10764 If a speaker's lines continue over a page break, repeat the
10768 title followed by (Cont'd).
10771 \begin_layout Subsection
10775 \begin_layout Standard
10780 names as labels then cross-reference the label to insert the name.
10781 The cross-reference dialog will show the current cast of characters.
10782 You can use this to insert the speaker name in narratives also.
10785 \begin_layout Subsection
10786 Paper size and Margins
10789 \begin_layout Standard
10790 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10793 \begin_layout Subsection
10797 \begin_layout Standard
10798 The following environments are available.
10799 You can use hollywood.bind to get the bind keys shown at the right.
10802 \begin_layout Itemize
10806 \begin_inset Newline newline
10811 Used where nothing else works.
10815 \begin_layout Itemize
10821 \begin_inset space \hfill{}
10829 \begin_inset Newline newline
10832 Usually followed by something like
10833 \begin_inset Quotes eld
10836 on Sally waking up.
10837 \begin_inset Quotes erd
10843 \begin_layout Itemize
10847 \begin_inset space \hfill{}
10851 \begin_inset Newline newline
10856 Introduces a new INTERIOR camera set-up.
10857 Always followed by DAY or NIGHT, or something similar to define the lighting
10859 Everthing on this line in CAPS.
10862 \begin_layout Itemize
10866 \begin_inset space \hfill{}
10870 \begin_inset Newline newline
10875 Introduces a new EXTERIOR camera set-up.
10876 Everthing on this line in CAPS.
10879 \begin_layout Itemize
10883 \begin_inset space \hfill{}
10887 \begin_inset Newline newline
10892 The character speaking.
10895 \begin_layout Itemize
10899 \begin_inset space \hfill{}
10903 \begin_inset Newline newline
10908 Instructions to the speaker.
10909 The () are automatically inserted, but only the ( will show in LyX.
10910 Both will be printed.
10913 \begin_layout Itemize
10917 \begin_inset space \hfill{}
10921 \begin_inset Newline newline
10933 \begin_layout Itemize
10937 \begin_inset space \hfill{}
10941 \begin_inset Newline newline
10946 Camera movement instruction.
10948 \begin_inset space \thinspace{}
10952 \begin_inset space \space{}
10958 \begin_layout Itemize
10962 \begin_inset space \hfill{}
10968 \begin_layout Itemize
10972 \begin_inset space \hfill{}
10978 \begin_layout Itemize
10982 \begin_inset space \hfill{}
10988 \begin_layout Itemize
10992 \begin_inset space \hfill{}
10998 \begin_layout Subsection
11002 \begin_layout Itemize
11006 \begin_layout Itemize
11010 \begin_layout Itemize
11012 \begin_inset space \thinspace{}
11019 \begin_layout Itemize
11024 \begin_layout Itemize
11025 PAN — camera movement
11028 \begin_layout Itemize
11029 INSERT — cut to close-up of
11032 \begin_layout Section
11036 \begin_layout Standard
11039 Panayotis Papasotiriou
11042 \begin_layout Subsection
11046 \begin_layout Standard
11047 The ijmpc package is a set of macros that facilitates electronic manuscript
11050 International Journal of Modern Physics C
11053 Similarly, the ijmpd package is for creating manuscripts to be submitted
11056 International Journal of Modern Physics D
11059 Both journals are published by World Scientific.
11060 The corresponding document classes are named
11069 These files, together with instructions for the authors, can be downloaded
11071 \begin_inset Flex URL
11074 \begin_layout Plain Layout
11076 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11082 \begin_inset Flex URL
11085 \begin_layout Plain Layout
11087 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11093 Both packages are modified versions of the standard
11094 \begin_inset Quotes eld
11098 \begin_inset Quotes erd
11101 package, and they are almost (but not exactly) identical.
11102 Most of their features are supported by LyX.
11103 I have used LyX successfully to write articles submitted to both journals
11104 without any problem.
11107 \begin_layout Subsection
11111 \begin_layout Standard
11112 As usual, the easiest way to write a paper is to start with a template.
11115 File\SpecialChar \menuseparator
11134 This will give an (almost) empty document that includes the most common
11135 fields found in a manuscript.
11136 Simply overwrite the existing text (including the brackets,
11141 You should keep in mind the following remarks.
11144 \begin_layout Enumerate
11145 LyX won't let you change the font size and the page style of the document,
11146 because such modifications are not allowed by both packages.
11149 \begin_layout Enumerate
11150 The language of the document should not be changed.
11151 Before previewing your paper, be sure that the babel package is not used.
11152 To do this, click on
11154 Tools\SpecialChar \menuseparator
11165 checkbox in the language settings, and click on
11173 , if you wish to make this change permanent).
11176 \begin_layout Enumerate
11178 \begin_inset Quotes eld
11182 \begin_inset Quotes erd
11185 style must be used to define keywords.
11188 \begin_layout Enumerate
11189 The ijmpc package provides a style named
11190 \begin_inset Quotes eld
11193 Classification Codes
11194 \begin_inset Quotes erd
11197 , which can be used to define classification codes, such as PACS numbers.
11198 Note that this facility is not supported by the ijmpd package.
11201 \begin_layout Enumerate
11202 Several new environments are available:
11203 \begin_inset Quotes eld
11207 \begin_inset Quotes erd
11211 \begin_inset Quotes eld
11215 \begin_inset Quotes erd
11219 \begin_inset Quotes eld
11223 \begin_inset Quotes erd
11227 \begin_inset Quotes eld
11231 \begin_inset Quotes erd
11235 \begin_inset Quotes eld
11239 \begin_inset Quotes erd
11243 \begin_inset Quotes eld
11247 \begin_inset Quotes erd
11251 \begin_inset Quotes eld
11255 \begin_inset Quotes erd
11259 \begin_inset Quotes eld
11263 \begin_inset Quotes erd
11267 \begin_inset Quotes eld
11271 \begin_inset Quotes erd
11275 \begin_inset Quotes eld
11279 \begin_inset Quotes erd
11283 \begin_inset Quotes eld
11287 \begin_inset Quotes erd
11291 \begin_inset Quotes eld
11295 \begin_inset Quotes erd
11299 \begin_inset Quotes eld
11303 \begin_inset Quotes erd
11307 \begin_inset Quotes eld
11311 \begin_inset Quotes erd
11315 Their use is more or less obvious.
11316 LyX supports all these environments; it will use the proper label, text
11317 style, and numbering scheme for each of them.
11320 \begin_layout Enumerate
11321 Both packages use basic citations; the natbib package should not be used.
11322 In LyX, citation references are shown as usual; in the output, citations
11323 are shown as superscripts.
11324 If you want to use a citation as normal text, you should use the
11329 \begin_inset space \thinspace{}
11333 \begin_inset space \space{}
11337 \begin_inset Quotes eld
11341 \begin_inset space \space{}
11351 \begin_inset Quotes erd
11357 \begin_layout Enumerate
11359 \begin_inset Quotes eld
11363 \begin_inset Quotes erd
11366 section in both packages.
11367 To put acknowledgments, just use the
11368 \begin_inset Quotes eld
11372 \begin_inset Quotes erd
11378 \begin_layout Enumerate
11379 Appendices may be added to the paper,
11383 the Acknowledgments and
11388 LyX provides a special environment, called
11389 \begin_inset Quotes eld
11393 \begin_inset Quotes erd
11396 which marks the beginning of the appendices.
11397 This environment should be left blank; it just sends a LaTeX command, but
11398 nothing is really printed.
11400 \begin_inset Quotes eld
11404 \begin_inset Quotes erd
11407 is printed with blue letters, as a signal that all sections after that
11408 point are appendices.
11409 To write an appendix, use the
11410 \begin_inset Quotes eld
11414 \begin_inset Quotes erd
11418 LyX will number each appendix with capital letters, as required by both
11421 \begin_inset Quotes eld
11425 \begin_inset Quotes erd
11432 be present before the first appendix; if not, all appendices will be numbered
11433 as normal sections in the output.
11436 \begin_layout Enumerate
11437 The ijmpc and the ijmpd packages use the
11441 command to implement table captions.
11442 As a result, a table created by LyX is printed correctly, but its caption
11444 However, you can use some TeX code to overpass this problem, so that captions
11445 are printed as expected.
11446 To do so, create a float table as usual, remove the caption, and replace
11447 it with the TeX code
11457 (sic); you must also the TeX code
11461 immediately after the tabular material.
11462 Study the example table included in the template files to see how this
11463 trick is implemented.
11464 Alternatively, If you need table captions, you should implement the whole
11469 file, then include this file to the LyX document (
11471 Insert\SpecialChar \menuseparator
11472 File\SpecialChar \menuseparator
11474 \begin_inset space ~
11480 Details on how to create a table float can be found in the files
11488 , included in the corresponding packages.
11491 \begin_layout Subsection
11492 Preparing a paper for submission
11495 \begin_layout Standard
11496 Before you submit your paper you must export the LyX document as a LaTeX
11499 File\SpecialChar \menuseparator
11500 Export\SpecialChar \menuseparator
11507 \begin_layout Plain Layout
11508 Actually you have the choice between LaTeX (plain) and pdflatex.
11509 If you intend to use pdflatex to prepare the paper, you should use the
11510 pdflatex option so that included graphics are converted to PDF format,
11511 ready for use by pdflatex.
11516 , then make the following changes to the resulting
11523 \begin_layout Enumerate
11524 Remove the comment lines before the
11533 \begin_layout Enumerate
11534 Remove everything between (and including) the
11546 commands, except for any commands you specifically put into the LaTeX preamble.
11549 \begin_layout Standard
11554 file should be saved and processed through LaTeX as many times as necessary.
11555 You may also want to check the resulting
11562 \begin_layout Subsection
11566 \begin_layout Standard
11567 The use of TeX code is reduced to two commands, which must be placed at
11568 the top of the document.
11569 If you started writing your paper by using the
11577 template, the TeX code needed is already in its place; you usually don't
11579 You may only modify the first TeX code to specify the information printed
11580 to the top of odd and even pages (authors' names and short paper's title,
11582 This TeX code must have the form
11586 markboth{Authors' Names}{Short Paper's Title}
11591 \begin_layout Section
11595 \begin_layout Standard
11601 \begin_layout Subsection
11605 \begin_layout Standard
11606 The iopart package provides a document class to create electronic manuscript
11607 submission to the journals published by the Institute of Physics.
11608 Instructions for the authors how to create a paper using the iopart class
11609 can be downloaded together with the iopart package from the site
11610 \begin_inset Flex URL
11613 \begin_layout Plain Layout
11615 ftp://ftp.iop.org/pub/journals/latex2e
11623 \begin_layout Subsection
11627 \begin_layout Standard
11628 The easiest way to write a paper is to start with the file
11632 that is available in LyX's examples files folder.
11633 Open this file, save it under a new name, and start writing.
11634 The example file explains how to use the special text environments.
11635 Here are the most important advices:
11638 \begin_layout Itemize
11639 To be able to compile your document to a PDF, PS, or DVI, assure that the
11642 Use AMS math package
11644 in the document settings under
11651 \begin_layout Itemize
11654 The title environment defines the kind of your paper.
11655 So use one of the following environments for the title:
11659 \begin_layout Itemize
11668 \begin_layout Itemize
11677 \begin_layout Itemize
11683 for a Topical review
11686 \begin_layout Itemize
11695 \begin_layout Itemize
11704 \begin_layout Itemize
11710 for a Paper (same as Title)
11713 \begin_layout Itemize
11719 for a Preliminary communication
11722 \begin_layout Itemize
11728 for a Rapid communication
11731 \begin_layout Itemize
11737 for a Letter to the editor
11741 \begin_layout Itemize
11744 All title environments except of
11748 can have an optional short title.
11751 \begin_layout Itemize
11752 There is a general title environment
11756 which is not directly supported by the LyX.
11757 This can be used as TeX code when your document doesn't fit into one of
11758 the other title types.
11761 \begin_layout Standard
11762 For more informations like hints for special table and formula formatting,
11763 look at the IOP author guidelines.
11766 \begin_layout Section
11770 \begin_layout Standard
11773 Panayotis Papasotiriou
11776 \begin_layout Subsection
11780 \begin_layout Standard
11781 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11782 that facilitates electronic manuscript submission to the journals they
11784 Most known of them (at least in my domain of interest) are
11786 Astrophysics and Space Science
11792 , but there are many others (see a complete list at
11793 \begin_inset Flex URL
11796 \begin_layout Plain Layout
11798 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11804 The Kluwer package may be downloaded from the site
11805 \begin_inset Flex URL
11808 \begin_layout Plain Layout
11810 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11816 A complete user guide is contained in that package (but it can also be
11817 downloaded separately).
11820 \begin_layout Standard
11821 LyX supports many features of the package but not everything.
11822 However, the TeX code needed is reduced to some
11823 \begin_inset Quotes eld
11827 \begin_inset Quotes erd
11830 commands of the package (see
11831 \begin_inset space ~
11835 \begin_inset CommandInset ref
11837 reference "subsec:kluwer_peculiarities"
11842 I have recently used LyX to write an article submitted to the
11844 Astrophysics and Space Science
11846 without any problem.
11849 \begin_layout Subsection
11853 \begin_layout Standard
11854 The easiest way to write a paper is to start with the Kluwer template file.
11857 File\SpecialChar \menuseparator
11869 This will give an (almost) empty document that includes the most common
11870 fields found in a manuscript and a short description of their use.
11871 As in most templates, simply overwrite the existing text (including the
11876 ) with the correct information.
11879 \begin_layout Subsection
11880 Preparing a paper for submission
11883 \begin_layout Standard
11884 As in the AASTeX package, before you submit your paper to a journal you
11886 \begin_inset Quotes eld
11890 \begin_inset Quotes erd
11896 \begin_layout Enumerate
11897 Export your paper as a LaTeX file.
11898 To do this, click on
11900 File\SpecialChar \menuseparator
11901 Export\SpecialChar \menuseparator
11908 \begin_layout Enumerate
11913 file with a text editor and make the following changes
11917 \begin_layout Enumerate
11918 remove the comment lines before the
11927 \begin_layout Enumerate
11928 remove everything between (and including) the
11940 commands, except for any commands you specifically put into the LaTeX preamble.
11943 \begin_layout Standard
11952 \begin_layout Enumerate
11957 file through LaTeX as many times as necessary (usually up to three).
11960 \begin_layout Enumerate
11966 \begin_inset space \thinspace{}
11970 \begin_inset space \space{}
11977 , and check if everything is OK (it should, if you didn't make any mistake).
11980 \begin_layout Subsection
11981 \begin_inset Quotes eld
11985 \begin_inset Quotes erd
11988 of the Kluwer package
11989 \begin_inset CommandInset label
11991 name "subsec:kluwer_peculiarities"
11998 \begin_layout Standard
11999 The Kluwer package has the following
12000 \begin_inset Quotes eld
12004 \begin_inset Quotes erd
12010 \begin_layout Enumerate
12011 It is possible to write multiple articles in the same LaTeX file
12015 \begin_layout Plain Layout
12016 I can't imagine any good reason to do this.
12022 Each article must be included in the environment
12023 \begin_inset Quotes eld
12027 \begin_inset Quotes erd
12031 Unfortunately, this environment cannot be omitted, even if you write just
12033 Therefore, each article starts with the command
12039 and, obviously, ends with the command
12046 Although this can be implemented in LyX, I didn't included it, since it
12047 looks ugly and can confuse the novice user.
12048 Therefore, you need to enter them directly and mark them as LaTeX code
12050 \begin_inset Quotes eld
12054 \begin_inset Quotes erd
12060 \begin_layout Enumerate
12061 Information given at the beginning of the article (i.
12062 \begin_inset space \thinspace{}
12066 \begin_inset space \space{}
12069 title, subtitle, author, institution, running title, running author, abstract
12070 and keywords) must be included in an environment called
12071 \begin_inset Quotes eld
12075 \begin_inset Quotes erd
12079 This is not implemented in LyX, so you must enter title, subtitle etc.
12080 \begin_inset space ~
12083 between two TeX code lines (
12098 \begin_layout Enumerate
12099 According to the user manual, the label of each bibliography item must be
12123 \begin_layout Standard
12128 template takes care of all these
12129 \begin_inset Quotes eld
12133 \begin_inset Quotes erd
12137 If you start a new paper using this template you don't need to do anything
12142 \begin_layout Enumerate
12143 don't delete the TeX code included in the template, and
12146 \begin_layout Enumerate
12147 copy the example bibliography item included in the template and modify it
12148 as necessary to enter new bibliography items.
12151 \begin_layout Section
12155 \begin_layout Standard
12161 \begin_layout Subsection
12165 \begin_layout Standard
12166 The LyX document classes
12168 article (koma-script)
12172 report (koma-script)
12190 correspond to the LaTeX document classes
12207 \begin_inset space ~
12210 of the Koma-Script family.
12211 They are replacements for the standard document classes
12227 , resp., and fit better to European typography conventions in a number of
12231 \begin_layout Itemize
12232 Standard character size is 11pt in
12234 article (koma-script)
12238 report (koma-script)
12246 letter (koma-script)
12251 \begin_layout Itemize
12252 Headings, labels of the description environment, and a number of elements
12255 letter (koma-script)
12257 document class are set in a bold sans serif font.
12261 \begin_layout Plain Layout
12262 There is a big difference between the bold sans serif old cm fonts and new
12263 ec fonts, especially in the appearance of headings.
12264 In comparison, the ec bold sans serif fonts look a bit thin.
12265 Here the LaTeX package
12273 helps to produce the
12274 \begin_inset Quotes eld
12278 \begin_inset Quotes erd
12281 appearance when using the ec fonts.
12286 The numbering of chapter headings is made in the same way as the numbering
12287 of section headings, that is without the extra line
12288 \begin_inset Quotes eld
12291 Chapter\SpecialChar \ldots{}
12293 \begin_inset Quotes erd
12297 In addition, the appearance of the headings can be modified by using a
12298 number of options (in LyX to be entered in the field
12301 \begin_inset space ~
12308 Layout\SpecialChar \menuseparator
12312 A detailed German description of these options can be found in the Koma-Script
12320 \begin_layout Itemize
12321 The main means in the Koma-Script document classes to design the type area
12330 (in LyX to be entered in the extra class options field in the dialog
12332 Document\SpecialChar \menuseparator
12336 They make a clearer modification of page margins possible as do the options
12339 Document\SpecialChar \menuseparator
12343 A detailed German description of these and other type area options can
12344 be found in the Koma-Script documentation
12351 \begin_layout Itemize
12352 The LaTeX document classes of the Koma-Script family define a number of
12353 additional commands.
12354 Those part of it which makes sense in LyX is implemented in corresponding
12358 \begin_layout Standard
12359 A detailed German description of the LaTeX document classes of the Koma-Script
12360 family can be found in the Koma-Script documentation
12368 \begin_layout Plain Layout
12369 There is an English translation
12373 , but it is not a complete one.
12378 The following sections describe only those aspects, which are relevant
12382 \begin_layout Subsection
12383 article (koma-script), report (koma-script), and book (koma-script)
12386 \begin_layout Standard
12387 The document classes
12389 article (koma-script)
12393 report (koma-script)
12403 are implemented in the layout files
12416 They contain all the paragraph types of the corresponding standard document
12429 , resp., partly modified, with the exception of the LyX specific
12433 -type, which is replaced by the new
12437 -type having the same functionality.
12442 -Type there is a number of new paragraph types added.
12449 letter (koma-script)
12454 \begin_layout Itemize
12463 : are equivalents to
12471 , resp., additionally inserting an entry in the table of contents.
12480 are not contained in
12482 article (koma-script)
12487 \begin_layout Itemize
12496 : behave exactly as
12504 , resp., additionally clearing running heads.
12509 is not contained in
12511 article (koma-script)
12517 \begin_layout Plain Layout
12530 report (koma-script)
12532 , but since this is identical to
12536 , is has not been implemented in LyX.
12544 \begin_layout Itemize
12549 : generates a heading directly above the following paragraph in the standard
12550 character size without affecting the structure of the document.
12553 \begin_layout Itemize
12562 are special captions which respect the different space settings needed
12563 for captions placed above or below an element (if you follow strict typographic
12564 rules, you might want to place table captions always above the table).
12565 You can also use the class option
12569 , which will switch
12582 You need at least Koma-Script version 2.8q to use this.
12585 \begin_layout Itemize
12590 : can be used to set a bonmot, e.
12591 \begin_inset space \thinspace{}
12595 \begin_inset space \space{}
12598 at the beginning of a chapter.
12599 If you use the optional argument (
12601 Insert\SpecialChar \menuseparator
12603 \begin_inset space ~
12608 ), you can insert the dictum's author there.
12609 Dictum and author are separated by a line.
12610 You need at least Koma-Script version 2.8q to use this.
12615 is not contained in
12617 article (koma-script)
12622 \begin_layout Standard
12623 The following types, together with the standard types
12635 , form the title area of the document.
12636 They must be entered ahead of the first
12637 \begin_inset Quotes eld
12641 \begin_inset Quotes erd
12648 \begin_layout Plain Layout
12649 The corresponding LaTeX commands must appear before the
12660 When such a type is used more than once, the latter usage overwrites the
12661 former one, that means, for every type only the latest usage is valid.
12662 The order of the different types however has, like
12674 , no effect on the appearance of the produced document.
12677 \begin_layout Itemize
12682 : produces a centered paragraph above the ordinary title (
12694 ) for the subject of the document.
12697 \begin_layout Itemize
12702 : produces a centered paragraph below the ordinary title (
12714 ) for the publishers' name.
12717 \begin_layout Itemize
12724 report (koma-script)
12730 produces a centered paragraph on its own page behind the title page, or
12733 article (koma-script)
12735 produces a centered paragraph below the ordinary title (
12751 ) for a dedication.
12754 \begin_layout Itemize
12759 : produces a left aligned paragraph above the ordinary title (
12775 ) for a document`s head.
12778 \begin_layout Itemize
12783 : produces in a double-sided print in
12785 report (koma-script)
12791 a left-aligned paragraph at the top of the title page`s back or has no
12792 effect in a single-sided print or in
12794 article (koma-script)
12799 \begin_layout Itemize
12804 : produces in a double-sided print in
12806 report (koma-script)
12812 a left-aligned paragraph at the bottom of the title page`s back or has
12813 no effect in a single-sided print or in
12815 article (koma-script)
12820 \begin_layout Itemize
12825 : produces a special
12826 \begin_inset Quotes eld
12830 \begin_inset Quotes erd
12833 page ahead of the actual document containing a paragraph without special
12837 \begin_layout Standard
12838 The layout files for the document classes
12840 article (koma-script)
12844 report (koma-script)
12850 do include the file
12855 This is thought of as a place to define your own types.
12860 in your personal layout directory and edit the file!
12863 \begin_layout Subsection
12864 letter (koma-script)
12867 \begin_layout Standard
12871 \begin_layout Plain Layout
12883 \begin_layout Standard
12887 letter (koma-script)
12889 is implemented in the layout file
12894 It contains all the paragraph types of the corresponding standard document
12899 , partly modified, with the exception of the LyX specific types
12911 type, which is replaced by the new
12916 In addition, it contains, in contrast to the standard document class, the
12934 Furthermore, there are a number of new letter specific types.
12937 \begin_layout Standard
12941 \begin_layout Plain Layout
12953 \begin_layout Standard
12954 The appearance of the letter produced by this document class can be controlled
12955 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12959 \begin_layout Plain Layout
12960 For example, the standard appearance of the letter`s heading, consisting
12961 of name and address, is quite self-willed.
12963 \begin_inset Quotes eld
12967 \begin_inset Quotes erd
12970 heading is produced by the following LaTeX commands in the preamble:
12973 \begin_layout LyX-Code
12983 \begin_layout LyX-Code
12999 \begin_layout LyX-Code
13009 \begin_layout LyX-Code
13029 A detailed German description of such LaTeX commands can be found in the
13030 Koma-Script documentation
13035 With it, the letter's author can produce his personal letter layout.
13038 \begin_layout Standard
13047 define the beginning of the letter and must be used in every letter.
13048 To emphasize them in the LyX document class, they are marked with the letter
13058 \begin_inset space ~
13061 in the left margin.
13062 It is possible to write any number of letters in one file.
13067 type produces a new letter using the same addressee and a
13071 type produces a new addressee.
13088 are ordinary paragraph types and can also be used several times in one
13089 and the same letter.
13092 \begin_layout Itemize
13097 : produces a paragraph for the addressee and implicitly defines the beginning
13101 \begin_layout Itemize
13106 : produces a paragraph for the form of address and implicitly produces a
13110 \begin_layout Itemize
13115 : produces a paragraph for a close.
13118 \begin_layout Itemize
13123 : produces a paragraph for a postscript.
13126 \begin_layout Itemize
13131 : produces a paragraph for a distribution list.
13134 \begin_layout Itemize
13139 : produces a paragraph for enclosures.
13142 \begin_layout Standard
13183 are input types provided with a label to enter information, which will
13184 be processed by the document class.
13188 \begin_layout Plain Layout
13189 It could be seen as a matter of inconsequence, that the types
13197 described above are not such input types as well.
13198 Because of the special meaning of those types, however, I have implemented
13199 them as ordinary paragraph types with a one letter mark in the left margin.
13200 Moreover, it would affect my feeling of symmetry, if the
13208 type had such a serious different appearance.
13213 The types must be used ahead of the corresponding
13220 \begin_layout Standard
13221 An implementation of these types in a WYSIWYG fashion does not seem to make
13222 sense, because the real appearance of the produced letter does not only
13223 depend on the usage of the particular type, but also on other factors.
13224 For example, a signature entered in the
13228 type will in the standard behavior appear in the produced letter only,
13229 when in the same letter also a
13234 The entered value of the
13238 type will in the standard behavior not appear in the produced letter at
13240 The possibility to design the letter`s heading freely is already indicated
13241 in a footnote above.
13244 \begin_layout Standard
13245 The input types can also be used as empty paragraphs.
13246 This makes sense e.
13247 \begin_inset space \thinspace{}
13251 \begin_inset space \space{}
13263 type is not used at all, in the standard behavior the value of the
13267 type is used as signature, whereas if an empty
13271 type is used, no signature value is defined.
13274 \begin_layout Standard
13275 By using the input types it is possible to write a letter template, containing
13276 filled input types with your personal dates (name, address, etc.) and empty
13277 input types for other dates you want to enter.
13280 \begin_layout Itemize
13285 : sender's name, in the standard behavior appears as a centered paragraph
13286 in small caps in the letter`s heading.
13289 \begin_layout Itemize
13294 : sender's signature, in the standard behavior appears below the
13303 type is used, the value of the
13307 type appears instead.
13310 \begin_layout Itemize
13315 : sender's address, in the standard behavior appears in a centered paragraph
13316 in the letter`s heading below the sender's name.
13319 \begin_layout Itemize
13324 : sender's telephone number, in the standard behavior only sets the LaTeX
13334 \begin_layout Itemize
13339 : place of the letter`s making.
13342 \begin_layout Itemize
13347 : date of the letter`s making.
13356 , in the standard behavior, produce the place and the date in a right-aligned
13357 line below the addressee's field.
13362 type is used, neither place nor date appear, independent of the value of
13372 type is used, the date of the letter `s production is used.
13375 \begin_layout Itemize
13380 : sender`s back address, in the standard behavior appears above the addressee's
13381 field in a small sans serif font.
13384 \begin_layout Itemize
13389 : special mail information, in the standard behavior appears underlined
13390 above the addressee's field below the back address.
13393 \begin_layout Itemize
13398 : additional information, in the standard behavior appears on right side
13399 below the addressee`s field.
13402 \begin_layout Itemize
13407 : the letter's title, in the standard behavior appears in a big, bold, sans
13408 serif font above the subject.
13411 \begin_layout Itemize
13416 : the letter's subject, in the standard behavior appears in a bold font
13424 \begin_layout Standard
13445 produce a business letter like line above the
13449 line containing the fields
13450 \begin_inset Quotes eld
13454 \begin_inset Quotes erd
13458 \begin_inset Quotes eld
13462 \begin_inset Quotes erd
13466 \begin_inset Quotes eld
13470 \begin_inset Quotes erd
13474 \begin_inset Quotes eld
13478 \begin_inset Quotes erd
13482 \begin_inset Quotes eld
13486 \begin_inset Quotes erd
13490 \begin_inset Quotes eld
13494 \begin_inset Quotes erd
13498 For the date field, the value of the
13504 \begin_inset Quotes eld
13507 business letter types
13508 \begin_inset Quotes erd
13511 is used, the value of the
13515 type however does not appear, but only the LaTeX variable
13522 The ordinary output of place and date in a right-aligned line below the
13523 addressee`s field is suppressed.
13524 The types are implemented as input types provided with a label and must
13525 be used ahead of the corresponding
13532 \begin_layout Itemize
13540 \begin_layout Itemize
13548 \begin_layout Itemize
13556 \begin_layout Itemize
13564 \begin_layout Itemize
13572 \begin_layout Subsection
13573 The new letter class: letter (koma-script v.2)
13576 \begin_layout Standard
13582 \begin_layout Standard
13583 \begin_inset VSpace medskip
13589 \begin_layout Standard
13591 Koma-Script version 2.8 has introduced a new letter class
13595 which supersedes the now unsupported
13600 It has — on the LaTeX side — a completely new interface and is not compatible
13601 with the old class.
13602 Therefore, LyX supports both, though it is recommended to use the new class.
13605 \begin_layout Standard
13606 This class covers the same functionality as
13608 letter (koma-script),
13611 The basic items are
13615 (receiver's address, same as
13619 in the old layout),
13632 will start a new letter (i.
13633 \begin_inset space \thinspace{}
13637 \begin_inset space \space{}
13640 you can write several letters per document).
13641 New elements are sender's
13657 and the possibility to use a
13663 Insert\SpecialChar \menuseparator
13669 \begin_layout Standard
13670 The biggest improvement is, though, that the letter's layout is configurable
13671 at almost any needs.
13672 This can be done via the preamble or with a special style file (Letter
13673 Class Option, extension
13677 ), that will be read in as a class option.
13681 \begin_layout Plain Layout
13682 The KOMA package comes with some default
13687 There is, for instance, a
13691 file that follows german typesetting rules, or a
13695 that provides the default layout of the old
13700 The latter can be loaded with the class option
13709 ayout\SpecialChar \menuseparator
13714 ocument\SpecialChar \menuseparator
13726 template that is included in LyX for examples.
13727 A detailed description is to be found in the Koma-Script documentation
13735 \begin_layout Subsection
13739 \begin_layout Standard
13740 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13744 \begin_layout Itemize
13745 The chapter number of a
13749 type appears on a line of its own above the chapter heading instead of
13750 appearing in the same line ahead of it.
13751 The cause for that is the LyX internal behavior for the labeltype
13755 in the layout file.
13758 \begin_layout Itemize
13759 The headings of the types
13767 are only put in the
13768 \begin_inset Quotes eld
13772 \begin_inset Quotes erd
13775 LaTeX table of contents, but not in the LyX table of contents (
13777 Document\SpecialChar \menuseparator
13779 \begin_inset space ~
13783 \begin_inset space ~
13791 \begin_layout Itemize
13792 The paragraphs in a
13796 document class appear in a skip separation mode, not indented.
13797 This is the standard behavior, no special LaTeX commands are needed for
13801 Document\SpecialChar \menuseparator
13804 dialog the corresponding radio button indicates
13813 value always has the effect that extra LaTeX commands are inserted in the
13814 document to produce the gap, which is not what is wanted in this case.
13817 \begin_layout Section
13818 Latex8 (IEEE Conference Papers)
13821 \begin_layout Standard
13827 \begin_layout Subsection
13831 \begin_layout Standard
13832 Since this class is specifically for writing submissions to IEEE sponsored
13833 conferences I strongly recommend that you get a copy of their Authors Kit.
13838 package and associated bibliography style file is included in the kit.
13839 The Authors Kit is usually sent out by email once your initial submission
13841 There is a lot of useful information in the Authors Kit explaining formatting
13842 restrictions and so on and I will assume you have read this since that
13843 means I don't have to repeat it all here.
13846 \begin_layout Subsection
13850 \begin_layout Standard
13851 [AR\SpecialChar \@.
13855 \begin_layout Subsection
13856 Supported Environments
13859 \begin_layout Itemize
13865 \begin_layout Itemize
13871 \begin_layout Itemize
13877 \begin_layout Itemize
13883 \begin_layout Itemize
13889 \begin_layout Itemize
13895 \begin_layout Itemize
13901 \begin_layout Itemize
13907 \begin_layout Itemize
13913 \begin_layout Subsection
13914 Differences Between Screen and Paper
13917 \begin_layout Standard
13918 There are slight differences in appearance mainly with the presentation
13919 of section counters.
13920 On screen the trailing period of the section counter is missing but it
13921 will appear in the output so don't let this worry you.
13924 \begin_layout Section
13928 \begin_layout Standard
13934 \begin_layout Subsection
13938 \begin_layout Standard
13939 Memoir is a very powerful and constantly evolving class.
13940 It has been designed with regard to fictional and non-fictional literature.
13941 Its aim is to let the user have maximum control over the typesetting of
13943 Memoir is based on the standard book class, but it can also emulate the
13944 article class (see below).
13947 \begin_layout Standard
13948 Peter Wilson, the developer of Memoir, is known as the author of lots of
13949 useful packages in the LaTeX world.
13950 Most of them have been merged with Memoir.
13951 Therefore, it is much easier to layout the table of contents, appendices,
13952 chapter designs and such.
13953 LyX, though, does not support all of these goodies natively.
13954 Some of them might be added to forthcoming releases
13958 \begin_layout Plain Layout
13959 You are invited to send suggestions to
13960 \begin_inset Flex URL
13963 \begin_layout Plain Layout
13965 lyx-devel@lists.lyx.org
13975 , lots will probably never, due to the limitations of LyX's framework.
13976 Of course you can still use all features with the help of some native LaTeX
13981 \begin_layout Plain Layout
13986 \begin_layout Plain Layout
13996 \begin_inset space ~
14000 \begin_inset CommandInset ref
14002 reference "sec:Inserting-TeX-Code"
14012 In this section, we can only list those features which are natively supported
14014 For detailed descriptions (and for the rest of features) we are recommending
14015 to have a look at the detailed manual of the Memoir class
14019 \begin_layout Plain Layout
14024 \begin_layout Plain Layout
14034 \begin_inset Flex URL
14037 \begin_layout Plain Layout
14039 CTAN:/macros/latex/memoir/memman.pdf
14049 , which is not only a user guide for the class, but also both a comprehensive
14050 description on good typesetting and a superb example for good typesetting
14054 \begin_layout Subsection
14055 Basic features and restrictions
14058 \begin_layout Standard
14059 Memoir supports basically all features of the standard book classes.
14060 There are, however, some differences, as follows:
14063 \begin_layout Description
14065 \begin_inset space ~
14068 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14071 \begin_layout Description
14073 \begin_inset space ~
14076 style: The fancy page style is not supported, due to a command clash between
14077 Memoir and the fancyhdr package (they are both defining a command with
14078 the same name, which confuses LaTeX).
14079 Instead, Memoir comes with a bunch of own page styles (see
14081 Layout\SpecialChar \menuseparator
14082 Document\SpecialChar \menuseparator
14084 \begin_inset space ~
14090 If you want to use these for the chapter pages, you have to use the command
14097 in the main text or in preamble (e.
14098 \begin_inset space \thinspace{}
14102 \begin_inset space \space{}
14109 chapterstyle{companion}
14114 \begin_layout Description
14115 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14116 an optional argument in the standard classes.
14117 With this, you can specify an alternative version of the title for the
14118 table of contents and the headers (for instance, if the title is too long).
14119 In LyX, you can do this via
14121 Insert\SpecialChar \menuseparator
14123 \begin_inset space ~
14128 at the beginning of a chapter/section.
14129 Memoir features a second optional argument and thus separates the table
14130 of contents from the header.
14131 You can define three variants of a title with this: one for the main text,
14132 one for the table of contents, and one for the headers.
14133 Simply insert two optional arguments if you need this feature, the first
14134 one containing the short title for the Table of Contents, the second one
14135 containing an alternative short title for the headers.
14138 \begin_layout Description
14139 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14140 of contents, the list of figures and the list of table start a new page
14142 Memoir does not follow this route.
14143 You have to insert a page break yourself, if you want to have one.
14146 \begin_layout Description
14147 Titlepage: For some unknown reason, Memoir uses pagination on the title
14148 page (in the standard classes, title pages are
14149 \begin_inset Quotes eld
14153 \begin_inset Quotes erd
14157 \begin_inset space \thinspace{}
14161 \begin_inset space \space{}
14165 If you want an empty title page, type
14169 aliaspagestyle{title}{empty}
14174 \begin_layout Description
14175 Article: With the class option
14181 Layout\SpecialChar \menuseparator
14182 Document\SpecialChar \menuseparator
14184 \begin_inset space ~
14189 ), you can emulate article style.
14190 That is, counters (footnotes, figures, tables etc.) will not be reset on
14191 new chapters, chapters don't start a new page (but are—in contrary to
14192 \begin_inset Quotes eld
14196 \begin_inset Quotes erd
14199 article classes—still allowed), parts, though, use their own page, as in
14203 \begin_layout Description
14204 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14205 font commands, which have been used in the old LaTeX version 2.09 (e.
14206 \begin_inset space \thinspace{}
14210 \begin_inset space \space{}
14226 It produces an error and stops LaTeX whenever such a command appears.
14231 reallows the commands and spits out warnings instead (which does at least
14233 Since a lot of packages and particularly BibTeX style files are still using
14234 those commands, we have decided to use this option by default.
14237 \begin_layout Subsection
14241 \begin_layout Standard
14242 We will only describe the features supported by LyX (which is not much currently
14244 Please consult the Memoir manual
14248 \begin_layout Plain Layout
14253 \begin_layout Plain Layout
14263 \begin_inset Flex URL
14266 \begin_layout Plain Layout
14268 CTAN:/macros/latex/memoir/memman.pdf
14281 \begin_layout Description
14282 Abstract: You may wonder why an abstract is an extra feature.
14283 Well, it is in book class.
14284 Usually books don't have abstracts.
14285 Memoir, however, has.
14286 You can use it wherever and how often you like.
14289 \begin_layout Description
14290 Chapterprecis: You may know this from belletristic: The contents of a chapter
14291 is shortly described below the title and also in the table of contents
14293 \begin_inset space \thinspace{}
14297 \begin_inset space \space{}
14302 Our hero arrives in Troia; he loses some friends; he finds others
14305 Chapterprecis does exactly this.
14306 It is therefore only sensible below a chapter.
14309 \begin_layout Description
14310 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14311 The epigraph environment provides an elegant way of typesetting such a
14313 The motto itself (text) and its author (source) are divided by a short
14315 Unfortunately, we have to fool LyX a bit here again, since the environment
14316 needs two arguments (text and source).
14317 In this case, we have to use curly brackets (in TeX mode) between the two
14328 <author of the slogan>.
14331 \begin_layout Description
14332 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14333 complex figurative poems).
14334 LyX can only support a few of them.
14335 One is poemtitle, which is a centered title for poems, which will also
14336 be added to the table of contents (verse is the standard environment for
14338 Memoir has some enhanced versions of verse, but you need to use TeX code,
14339 because they have to be nested inside regular verse environments, which
14340 is not possible with LyX).
14343 \begin_layout Description
14344 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14347 \begin_layout Section
14348 Article (mwart), book (mwbk) and report (mwrep)
14349 \begin_inset OptArg
14352 \begin_layout Plain Layout
14365 \begin_layout Standard
14371 \begin_layout Standard
14372 The LyX document classes
14388 correspond to the LaTeX document classes
14401 They are replacements for the standard document classes
14413 , resp., and fit better to Polish typography conventions in a number of points.
14417 \begin_layout Standard
14421 \begin_layout Itemize
14422 Unnumbered titles (with star, e.
14423 \begin_inset space \thinspace{}
14427 \begin_inset space \space{}
14434 ) are added into table of contents,
14437 \begin_layout Itemize
14438 Additional page styles:
14442 \begin_layout Description
14443 uheadings header with separated lines,
14446 \begin_layout Description
14447 myheadings custom header, contents headers via commands:
14462 \begin_layout Description
14463 myuheadings custom header with separated lines,
14466 \begin_layout Description
14467 outer page number is placed on outer side of page
14471 \begin_layout Itemize
14476 \begin_layout Description
14477 rmheadings serif titles — default,
14480 \begin_layout Description
14481 sfheadings sansserif titles,
14484 \begin_layout Description
14485 authortitle on title page first placed is author next title — default,
14488 \begin_layout Description
14489 titleauthor on title page first placed is title next author,
14492 \begin_layout Description
14493 withmarginpar reserve place on page for margins.
14497 \begin_layout Section
14501 \begin_layout Standard
14506 provides an alternative to the standard
14511 It provides similar functionality, but you might prefer this layout with
14512 sans serif sections, headings, and more.
14515 \begin_layout Section
14519 \begin_layout Standard
14525 \begin_layout Standard
14526 \begin_inset VSpace bigskip
14532 \begin_layout Standard
14537 \begin_inset space ~
14542 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14543 \begin_inset Formula $\beta$
14546 release of May, 1999) class.
14549 \begin_layout Standard
14554 textclass, which works with RevTeX 3.1.
14555 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14556 That means that it doesn't interact very well with LyX, which requires
14557 LaTeX2e, although it has been kludged to work.
14558 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14562 \begin_inset space ~
14567 textclass should also be pretty easy to use.
14570 \begin_layout Standard
14571 These documents are supposed to be used in
14575 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14576 macros, and assume you'll know what to put in the preamble if necessary.
14579 \begin_layout Subsection
14583 \begin_layout Standard
14584 All you need to do is install RevTeX 4, as described in the package's README
14586 The package can be found at The RevTeX 4 Web Site
14587 \begin_inset Flex URL
14590 \begin_layout Plain Layout
14592 http://publish.aps.org/revtex4/
14598 Install it somewhere that LaTeX can see it.
14599 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14601 \begin_inset space \thinspace{}
14605 \begin_inset space \space{}
14608 not the directory where you installed the class file.) Then, if you reconfigure
14609 LyX, it will find the class file and let you use the RevTeX4 textclass.
14612 \begin_layout Standard
14613 Probably the easiest way to get started is either to import a RevTeX 4 document
14621 \begin_inset space ~
14626 template, found in the templates directory.
14629 \begin_layout Subsection
14633 \begin_layout Standard
14634 Optional arguments to
14641 \begin_inset Quotes eld
14645 \begin_inset Quotes erd
14649 \begin_inset Quotes eld
14653 \begin_inset Quotes erd
14663 \begin_inset space ~
14671 \begin_inset space ~
14677 Remember that in RevTeX, at least one optional argument is required!
14680 \begin_layout Standard
14681 Other preamble matter, like
14688 \begin_inset space ~
14694 \begin_inset space ~
14699 dialog, also as usual.
14702 \begin_layout Subsection
14706 \begin_layout Standard
14707 The layouts basically correspond to the commands in RevTeX4.0.
14708 For example, the Email layout corresponds to
14715 Note that (at least as of RevTeX 4.0 Beta), the
14723 layouts are exactly equivalent, so you shouldn't need to use both.
14727 \begin_layout Plain Layout
14728 In case you're curious, both were included so that
14732 would be able to translate both
14752 \begin_layout Subsection
14756 \begin_layout Standard
14757 There are a couple of important unique aspects of RevTeX 4 which might cause
14758 bugs that will be even more confusing in LyX.
14761 \begin_layout Standard
14779 The LyX equivalent is that there is a separate Thanks layout.
14784 write footnotes in the
14788 layout, or weird things may happen.
14789 See the RevTeX 4 documentation for more details.
14792 \begin_layout Standard
14796 \begin_inset space ~
14804 \begin_inset space ~
14813 layouts must be placed
14821 layout and the corresponding
14838 , the LaTeX won't compile.
14841 \begin_layout Subsection
14845 \begin_layout Standard
14846 The main problem with this layout is that you can't use the optional arguments
14847 to layouts like Email and Title.
14848 (The problem is not unique to this layout; you can't use optional arguments
14849 to the Section layouts either.) This means that after you export that file
14850 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14851 need to edit the LaTeX file with a text editor to add the optional arguments
14853 \begin_inset space \thinspace{}
14857 \begin_inset space \space{}
14860 the running title for the page headers.
14861 Lacking these layouts makes the
14867 (and the equivalent
14873 ) useless, so the corresponding layouts don't exist, and will have to be
14878 \begin_layout Plain Layout
14883 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14884 has not been updated yet to take advantage of it.
14892 \begin_layout Section
14893 Springer Journals (
14900 \begin_layout Standard
14906 \begin_layout Subsection
14910 \begin_layout Standard
14911 These are the layout files for some of the journal formats used by Springer
14912 Verlag and listed on
14913 \begin_inset Flex URL
14916 \begin_layout Plain Layout
14918 http://www.springer.de/author/tex/help-journals.html
14923 , where you should also go to fetch the class files (yes, these are LaTeX2e
14925 It is a modular system: the things common to all journals are implemented
14930 , which journal-specific layout files (such as, e.
14931 \begin_inset space \thinspace{}
14935 \begin_inset space \space{}
14942 for Journal of Geodesy) can include.
14945 \begin_layout Standard
14946 This means that implementing support for any other Springer journal on this
14947 list is as simple as writing your own
14955 file following the outline given in
14963 \begin_layout Standard
14964 It is reasonably well tested only for the Journal of Geodesy.
14973 come with the standard LyX distribution.
14974 Install the relevant class file (downloaded from Springer) in a proper
14975 directory, reconfigure LaTeX (in the teTeX case by running
14979 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14980 and it should work.
14983 \begin_layout Subsection
14987 \begin_layout Standard
14988 A large number of theorem-like styles —
14994 \SpecialChar \ldots{}
15000 \begin_layout Standard
15003 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15004 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15007 See the Springer class file documentation for details.
15010 \begin_layout Subsection
15014 \begin_layout Itemize
15026 \begin_layout Itemize
15029 Probability Theory and Related Fields
15035 — Jean-Marc Lasgouttes
15038 \begin_layout Standard
15039 Add your own, it isn't so hard!
15042 \begin_layout Subsection
15046 \begin_layout Standard
15047 These files are partly based on the older
15051 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15052 file from Springer.
15057 layout, are now defunct.
15058 Jean-Marc Lasgouttes helped out big in making me find my way around the
15059 LyX layout file mechanism.
15062 \begin_layout Subsection
15066 \begin_layout Standard
15068 But probably less than in the old hacked-LaTeX
15075 \begin_layout Standard
15077 \begin_inset space \thinspace{}
15080 g.: does not display the number for theorem-like layouts, just #.
15083 \begin_layout Section
15089 \begin_inset CommandInset label
15098 \begin_layout Standard
15106 \begin_layout Subsection
15110 \begin_layout Standard
15111 This section describes how to use LyX to make slides for overhead projectors.
15112 There are two document classes that can do this: the default slides class
15118 This section documents the former.
15121 \begin_layout Standard
15122 I'm going to say this again, nice and clear, so that there's no misunderstanding
15126 \begin_layout Standard
15127 \begin_inset VSpace bigskip
15133 \begin_layout Standard
15137 This section documents the class
15138 \begin_inset Quotes eld
15146 \begin_inset Quotes erd
15154 \begin_layout Standard
15155 \begin_inset VSpace bigskip
15161 \begin_layout Standard
15162 If you're looking for the documentation for
15163 \begin_inset Quotes eld
15171 \begin_inset Quotes erd
15174 , check out section
15175 \begin_inset space ~
15179 \begin_inset CommandInset ref
15181 reference "sec:foiltex"
15191 \begin_inset Quotes eld
15199 \begin_inset Quotes erd
15202 ] is actually somewhat better than the default
15210 \begin_layout Plain Layout
15211 \SpecialChar \ldots{}
15212 or so I've been told repeatedly by its advocates.
15213 Having never used it, I have no idea if this claim is true or not.
15218 which this section documents.
15221 \begin_layout Standard
15222 This class is the LaTeX2e improvement of the old
15227 Every LaTeX2e distribution includes this class [which I'll just refer to
15229 \begin_inset Quotes eld
15237 \begin_inset Quotes erd
15240 from now on], so you're bound to have it.
15241 As I noted earlier, there are other classes, such as
15245 , which also produce slides for overhead projectors and do a better job
15247 However, there are some things which
15251 can do which the others can't, such as generate overlays.
15252 Read on to learn more!
15255 \begin_layout Subsection
15257 \begin_inset CommandInset label
15259 name "sec:slidesetup"
15266 \begin_layout Standard
15267 Obviously, to use this document class, you need to select
15268 \begin_inset Quotes eld
15276 \begin_inset Quotes erd
15279 from the class list in the
15281 Document\SpecialChar \menuseparator
15285 There are some other special things you should know about this class:
15288 \begin_layout Itemize
15289 Don't bother changing the options
15294 They're not supported by the
15301 \begin_layout Itemize
15305 \begin_inset space ~
15310 behaves a bit differently for this class.
15311 The possible choices and what they do are as follows:
15315 \begin_layout Description
15320 The final output contains page numbers in the lower right corner.
15323 \begin_layout Description
15332 , but also prints out any time markers you've put in.
15333 This is the default.
15336 \begin_layout Description
15341 The final output contains no page numbers, time markers, or alignment markers.
15345 \begin_layout Itemize
15350 class has an extra option:
15356 \begin_inset Quotes eld
15364 \begin_inset Quotes erd
15367 in the extra class options.
15371 \begin_layout Standard
15372 Using this options allows you to add time markers to
15378 \begin_inset space ~
15382 \begin_inset CommandInset ref
15384 reference "sec:slideNote"
15392 \begin_layout Standard
15393 You can also use the template file
15394 \begin_inset Quotes eld
15402 \begin_inset Quotes erd
15405 to automatically set up a document to use the
15411 File\SpecialChar \menuseparator
15413 \begin_inset space ~
15417 \begin_inset space ~
15422 to open your new document].
15423 The template file also contains some examples of the special paragraph
15424 environments used by this class.
15425 I'll describe those next.
15428 \begin_layout Subsection
15429 Paragraph Environments
15432 \begin_layout Subsubsection
15433 Supported Environments
15436 \begin_layout Standard
15437 The first thing you'll notice when you start up a new
15441 document is the font size and type: it's the equivalent of the size
15442 \begin_inset Quotes eld
15450 \begin_inset Quotes erd
15456 \begin_inset space ~
15462 This is also what's used in the output.
15464 \begin_inset Quotes eld
15468 \begin_inset Quotes erd
15471 to remind you that this is a slide.
15472 Your final slides will use a larger font; ergo, you'll have less space.
15473 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
15476 \begin_layout Standard
15477 The next thing that becomes obvious is the changes to the paragraph environment
15478 pull-down box [at the far-left end of the toolbar].
15479 Most of the paragraph environments you're used to seeing are missing.
15480 There are also five new ones.
15485 class itself only supports certain paragraph environments:
15488 \begin_layout Itemize
15494 \begin_layout Itemize
15500 \begin_layout Itemize
15506 \begin_layout Itemize
15512 \begin_layout Itemize
15518 \begin_layout Itemize
15524 \begin_layout Itemize
15530 \begin_layout Itemize
15536 \begin_layout Itemize
15542 \begin_layout Itemize
15548 \begin_layout Itemize
15554 \begin_layout Standard
15555 All of the other standard environments, including the section-heading environmen
15556 ts, aren't used in the
15563 \begin_layout Standard
15564 On the other hand, you'll notice the following new environments:
15567 \begin_layout Itemize
15573 \begin_layout Itemize
15579 \begin_layout Itemize
15585 \begin_layout Itemize
15591 \begin_layout Itemize
15597 \begin_layout Standard
15598 These five are kind of quirky, due to a
15599 \begin_inset Quotes eld
15603 \begin_inset Quotes erd
15607 You see, LyX doesn't permit you to nest any other paragraph environment
15608 into an empty environment.
15609 Now, that's fine and dandy, but it means that you wouldn't be able to start
15610 a slide with anything except plain text.
15611 To deal with this, I've performed a little
15612 \begin_inset Quotes eld
15616 \begin_inset Quotes erd
15622 \begin_layout Subsubsection
15623 Quirks of the New Environments
15624 \begin_inset CommandInset label
15626 name "sec:slideQuirk"
15633 \begin_layout Standard
15634 All five of the new paragraph environments are somewhat quirky due to inherent
15635 limitiations in the current version of LyX.
15636 As I just mentioned, LyX forbids environments that begin with another environme
15638 To get around this, the
15642 environment isn't a paragraph environment as described in the
15650 \begin_layout Standard
15651 You should consider
15664 \begin_inset Quotes eld
15667 pseudo-environments.
15668 \begin_inset Quotes erd
15671 They look like a section heading or a
15672 \begin_inset Quotes eld
15680 \begin_inset Quotes erd
15683 but really begin a [and, if necessary, end the previous] paragraph environment.
15693 \begin_inset Quotes eld
15697 \begin_inset Quotes erd
15700 These two perform some action.
15703 \begin_layout Standard
15704 A common feature of all five environments,
15724 , is a rather long-ish label.
15725 The text following this label — ordinarily the contents of the paragraph
15726 environment — is utterly irrelevant for
15747 LyX completely ignores it.
15748 In fact, you can leave these five environments completely empty.
15752 \begin_layout Standard
15757 to put any text after the rather long-ish label, you might want to.
15758 This could be a short description of the contents of the
15763 In that case, enter in your descriptive comment and hit
15767 as you normally would.
15770 \begin_layout Standard
15771 If, on the other hand, you don't want to enter in any descriptive text,
15772 you'll hit another LyX quirk.
15773 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15774 environment until you put something in the old one.
15778 \begin_layout Itemize
15779 Start entering the text that will
15807 \begin_layout Itemize
15808 Now move to the beginning of that paragraph.
15812 \begin_layout Itemize
15821 \begin_layout Itemize
15822 Finally, change this new, empty paragraph to a
15846 \begin_layout Standard
15847 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15851 \begin_layout Subsection
15852 Making a Presentation with
15865 \begin_layout Subsubsection
15873 \begin_layout Standard
15874 If you're expecting this section to teach you how to actually make a presentatio
15875 n, you'll be sorely disappointed.
15876 Naturally, I'll describe all of the ways the
15880 class can assist you in preparing the materials for a presentation.
15881 Filling in the contents, however, is up to you.
15886 the LyX philosophy.]
15889 \begin_layout Standard
15894 environment [in the manner described in section
15895 \begin_inset space ~
15899 \begin_inset CommandInset ref
15901 reference "sec:slideQuirk"
15905 ] tells LyX to begin a new slide [duh].
15906 The label for this environment/
15907 \begin_inset Quotes erd
15911 \begin_inset Quotes erd
15915 \begin_inset Quotes eld
15919 \begin_inset Quotes erd
15922 in cool blue, followed by the label,
15923 \begin_inset Quotes eld
15927 \begin_inset Quotes erd
15931 Any text or paragraph environments that follow this one go on the new slide.
15935 \begin_layout Standard
15936 Slides are probably the only time you'll need to forcibly end pages in LyX
15937 (this can be specified in the
15942 In fact, you'll want to, once you finish entering the contents of one slide.
15943 If you've entered more text than can physically fit on a slide, the extra
15944 overflows onto a new slide.
15945 I don't recommend doing this, however, since the overflow slide won't have
15946 any page number on it.
15947 Furthermore, it may interfere with any
15951 you've made to accompany the oversized
15958 \begin_layout Standard
15967 environments work the same way as the
15972 They both create an
15973 \begin_inset Quotes eld
15977 \begin_inset Quotes erd
15980 followed by a label [
15981 \begin_inset Quotes eld
15985 \begin_inset Quotes erd
15989 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
15997 The color is a stunning magenta instead of blue, and the
15998 \begin_inset Quotes eld
16002 \begin_inset Quotes erd
16005 will look different, in style and in length.
16006 The label fonts of all three also differ from one another.
16009 \begin_layout Standard
16014 , if the contents of a
16022 exceed the physical size of a slide or sheet of paper, the extra will overflow
16024 Again, you should avoid this.
16025 It defeats the whole purpose of
16036 \begin_layout Subsubsection
16046 \begin_layout Standard
16051 is a slide that sits atop another slide.
16052 Perhaps you wish to discuss a figure on the main
16056 before displaying the text associated with it.
16057 One way to accomplish this is tape a flap of dark paper over the part of
16062 you want to display later.
16063 This method fails, however, if you wish to overlap one graph with another,
16065 You would then have to fumble while speaking to align the two separate,
16070 s to align the two graphs.
16075 environment in both cases makes life much easier.
16078 \begin_layout Standard
16083 receives the page number of its
16084 \begin_inset Quotes eld
16088 \begin_inset Quotes erd
16096 \begin_inset Quotes eld
16104 \begin_inset Quotes erd
16111 \begin_layout Plain Layout
16112 Presumably, mutliple
16117 \begin_inset Quotes eld
16125 \begin_inset Quotes erd
16129 \begin_inset Quotes eld
16137 \begin_inset Quotes erd
16141 \begin_inset Quotes eld
16149 \begin_inset Quotes erd
16153 \begin_inset space ~
16156 appended to the page number of the parent
16166 Clearly, you want the contents of both the
16174 to each fit on a single physical slide! You should probably consider an
16180 \begin_inset Quotes eld
16184 \begin_inset Quotes erd
16196 class provides a visual cue for this: the label at the start of an
16200 is shorter than that at the start of a
16205 Lastly, when you generate printable output, you'll find alignment markers
16206 in all four corners of both the
16210 page and its parent
16215 These will assist you in lining up the two physical slides.
16218 \begin_layout Standard
16219 The major problem in overlaying two slides is aligning the contents of the
16220 two transparencies.
16221 How much space should you leave for that graph on the second slide? Worse
16222 still, what if you want a graph and a sentence on second slide, but there
16223 is text on the main transparency that goes in between them? You could try
16224 and insert vertical space of the right size.
16225 The better way is to use
16236 \begin_layout Standard
16237 As their names imply,
16245 are two command-like paragraph environments that make all subsequent text
16246 invisible and visible, respectively.
16248 \begin_inset space ~
16252 \begin_inset CommandInset ref
16254 reference "sec:slideQuirk"
16258 that you don't place anything
16262 these two environments, however.
16267 , it inserts a centered, sky-blue label into the page reading
16268 \begin_inset Quotes eld
16271 <Invisible Text Follows>
16272 \begin_inset Quotes erd
16276 For paragraphs following this label, the parts of the
16284 ; it doesn't matter which] where they would be contain instead blank space.
16288 \begin_layout Standard
16293 , the corresponding centered label is
16294 \begin_inset Quotes eld
16297 <Visible Text Follows>
16298 \begin_inset Quotes erd
16302 Paragraphs following this label behave normally.
16303 Note that the beginning of a new
16315 automatically shuts off an
16320 It's therefore not necessary to use
16331 \begin_layout Standard
16332 By now, it should be obvious how to create overlay transparencies using
16333 the proper combination of
16352 \begin_layout Enumerate
16357 , including everything that will appear on it, whether on the main slide
16365 \begin_layout Enumerate
16366 Before each figure or paragraph that will appear only on the
16375 If necessary, insert a
16379 environment after the
16386 \begin_layout Enumerate
16391 immediately following the
16398 \begin_layout Enumerate
16399 Copy the contents of this
16410 \begin_layout Enumerate
16415 , change all of the
16426 \begin_layout Standard
16428 You've just made an
16435 \begin_layout Standard
16436 There's one problem with the way I've designed the LyX
16440 class: you can't make text in the middle of a paragraph invisible, nor
16441 make text in the middle of an invisible paragraph visible again.
16442 To accomplish this feat, you'll need to use some inlined LaTeX codes.
16446 \begin_layout Plain Layout
16447 The commands of interest are:
16450 \begin_layout Itemize
16455 invisible \SpecialChar \ldots{}
16459 \begin_layout Itemize
16464 visible \SpecialChar \ldots{}
16468 \begin_layout Plain Layout
16469 \SpecialChar \ldots{}
16470 and need to be marked as TeX.
16472 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16479 you wish to change goes in between the brackets [and after the
16492 If you don't know how to mark text as TeX, see the appropriate section
16505 \begin_layout Subsubsection
16515 \begin_inset CommandInset label
16517 name "sec:slideNote"
16524 \begin_layout Standard
16533 is associated with a
16534 \begin_inset Quotes eld
16538 \begin_inset Quotes erd
16550 class provides visual cues.
16555 is shorter than that of a
16559 [yet longer than that of an
16563 ] and, like the label of an
16567 is shockingly magenta.
16568 Additionally, the printed
16572 has the page number of its
16573 \begin_inset Quotes eld
16577 \begin_inset Quotes erd
16585 \begin_inset Quotes eld
16593 \begin_inset Quotes erd
16597 \begin_inset Quotes eld
16605 \begin_inset Quotes erd
16609 \begin_inset Quotes eld
16617 \begin_inset Quotes erd
16621 You can have multiple
16625 s associated with a single
16637 , you'll probably want to break up long
16641 s so that they fit on a single sheet of paper.
16644 \begin_layout Standard
16649 is obvious: it contains anything additional you might want to say about
16655 It could also be used as a sheet of reminders for a particular
16660 In the case of the latter, you might want to make use of time markers.
16666 \begin_inset Quotes eld
16670 \begin_inset Quotes erd
16673 support for time markers, a
16678 So, you'll have to resort to using the LaTeX codes.
16681 \begin_layout Standard
16682 To use time markers, you'll need to specify the extra class option
16683 \begin_inset Quotes eld
16691 \begin_inset Quotes erd
16695 \begin_inset space ~
16699 \begin_inset CommandInset ref
16701 reference "sec:slidesetup"
16706 This option turns on timing marks, which will appear in the lower-left-hand
16712 To set what appears in the time marker, you use the LaTeX commands
16713 \begin_inset Quotes eld
16723 \begin_inset Quotes erd
16727 \begin_inset Quotes eld
16737 \begin_inset Quotes erd
16741 The arguments of both commands are time measured in seconds.
16743 \begin_inset Quotes eld
16753 \begin_inset Quotes erd
16756 sets the time marker to a given time.
16758 \begin_inset Quotes eld
16768 \begin_inset Quotes erd
16771 increments the time marker by the specified amount.
16772 Using time markers and
16776 s in this fashion, you can remind yourself how much time to spend on a particula
16784 \begin_layout Standard
16785 There's one last feature to describe.
16786 Clearly, you'd like to print out all of your
16794 s on transparencies while printing all of your
16811 with which it is associated.
16812 What's a person to do?
16815 \begin_layout Standard
16816 Luckily, there are two LaTeX commands that allow you to select what to print
16818 Both must be placed into the preamble of your document.
16820 \begin_inset Quotes eld
16832 \begin_inset Quotes erd
16835 will cause the output to contain only the
16844 Correspondingly, the command
16845 \begin_inset Quotes eld
16857 \begin_inset Quotes erd
16860 prevents the output of anything but
16865 I'd advise placing both commands in the preamble and initially comment
16867 You can then preview your entire presentation as you write.
16868 When you're done writing, you can then uncomment one of the two to select
16869 what you want to print.
16870 I like to uncomment
16871 \begin_inset Quotes eld
16883 \begin_inset Quotes erd
16886 , print to a file with
16887 \begin_inset Quotes eld
16895 \begin_inset Quotes erd
16898 in its name, comment it back out, then uncomment
16899 \begin_inset Quotes eld
16911 \begin_inset Quotes erd
16915 \begin_inset Quotes eld
16923 \begin_inset Quotes erd
16927 I can then send either file to a printer, loading transparencies or plain
16928 paper as appropriate.
16931 \begin_layout Standard
16932 You can also provide other arguments to the
16933 \begin_inset Quotes eld
16943 \begin_inset Quotes erd
16947 \begin_inset Quotes eld
16957 \begin_inset Quotes erd
16961 See a good LaTeX book for details.
16964 \begin_layout Subsection
16969 Class Template File
16972 \begin_layout Standard
16973 I have also provided a template file,
16974 \begin_inset Quotes eld
16982 \begin_inset Quotes erd
16990 To use it, begin your new presentation with
16995 ile\SpecialChar \menuseparator
16997 \begin_inset space ~
17001 \begin_inset space ~
17011 Your new LyX presentation file will contain an example
17032 additionally contain an example of the use of
17041 Lastly, the preamble will contain:
17044 \begin_layout LyX-Code
17045 % Uncomment to print out only slides and overlays
17048 \begin_layout LyX-Code
17052 \begin_layout LyX-Code
17058 \begin_inset Newline newline
17064 \begin_layout LyX-Code
17065 % Uncomment to print out only notes
17068 \begin_layout LyX-Code
17072 \begin_layout LyX-Code
17080 \begin_layout Standard
17081 One final thing: I created this class to support the LaTeX2e
17082 \begin_inset Quotes eld
17090 \begin_inset Quotes erd
17093 class, one of the built-in LaTeX2e classes.
17094 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17095 built-in slide class.
17096 It's here if you want it or need it.
17097 There exist other LaTeX2e classes for creating presentations, such as the
17103 \begin_inset space ~
17107 \begin_inset CommandInset ref
17109 reference "sec:foiltex"
17114 \begin_inset Quotes eld
17122 \begin_inset Quotes erd
17125 package [present on some TeX distributions].
17126 The latter is not yet supported under LyX.
17130 \begin_layout Plain Layout
17131 Perhaps you can take on the task\SpecialChar \ldots{}
17137 I know nothing about these other classes.
17138 Try them out to see what sort of alternative they provide.
17141 \begin_layout Chapter
17142 LyX Features needing Extra Software
17145 \begin_layout Section
17149 \begin_layout Standard
17155 \begin_layout Subsection
17159 \begin_layout Standard
17168 \begin_layout Plain Layout
17173 is not yet available when you are using the LaTeX distribution MiKTeX.
17178 , you'll find in the
17185 \begin_inset space ~
17196 \begin_inset CommandInset href
17198 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17205 \begin_layout Standard
17210 package is a program that was written by
17211 \begin_inset Flex CharStyle:Noun
17214 \begin_layout Plain Layout
17216 \begin_inset space ~
17224 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17225 and easy to forget.
17226 The program runs over your LaTeX file, checks the integrity of the file,
17227 and flags some common errors.
17228 In other technical words, it is
17235 \begin_layout Standard
17236 Well, what is a syntax checker doing in LyX which is supposed to produce
17237 correct LaTeX anyways? The answer is simple: Just as
17241 not only checks the
17245 of C programs, but also does
17249 checks for type-errors,
17253 catches some common
17257 errors, in addition to the syntactical ones.
17262 is capable of detecting several common errors, such as
17265 \begin_layout Itemize
17266 Ellipsis detection:
17267 \begin_inset Newline newline
17270 Use \SpecialChar \ldots{}
17274 \begin_layout Itemize
17275 No space in front of/after parenthesis:
17276 \begin_inset Newline newline
17282 \begin_layout Itemize
17283 Enforcement of normal space after common abbreviations:
17284 \begin_inset Newline newline
17288 \begin_inset space \thinspace{}
17292 \begin_inset space \space{}
17295 is too wide spacing.
17298 \begin_layout Itemize
17299 Enforcement of end-of-sentence space when the last sentence ends with a
17301 \begin_inset Newline newline
17305 And this is wrong spacing.
17308 \begin_layout Itemize
17309 Space in front of labels and similar commands:
17310 \begin_inset Newline newline
17313 The label should stick right up to the text to avoid falling to a wrong
17316 \begin_inset CommandInset label
17326 \begin_layout Plain Layout
17327 This footnote is in danger of falling off to a wrong page
17332 The label is separated too much.
17335 \begin_layout Itemize
17336 Space in front of references, instead of hard spaces:
17337 \begin_inset Newline newline
17340 In you are in bad luck, the text will break right between the referenced
17341 text and reference number, and that's a pity.
17343 \begin_inset CommandInset ref
17345 reference "sec:chktex"
17352 \begin_layout Itemize
17354 \begin_inset Quotes eld
17358 \begin_inset Quotes erd
17362 \begin_inset Formula $\times$
17366 \begin_inset Newline newline
17369 2x2 looks cheap compared to
17370 \begin_inset Formula $2\times2$
17376 \begin_layout Standard
17377 and more \SpecialChar \ldots{}
17378 It is an invaluable tool when you are
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17386 your document before printing, and you should run it right after the obligatory
17387 spelling check, and before you go fine tuning the typesetting.
17390 \begin_layout Subsection
17394 \begin_layout Standard
17395 If you have the program installed, usage is as simple as choosing
17397 Tools\SpecialChar \menuseparator
17399 \begin_inset space ~
17405 This will make LyX generate a LaTeX file of your document, start
17409 to check it, and then make LyX insert
17410 \begin_inset Quotes eld
17414 \begin_inset Quotes erd
17417 with the warnings from
17421 , if there were any.
17422 The warnings will be placed close to the point of the mistake, and you
17423 can quickly find them by using the
17425 Navigate\SpecialChar \menuseparator
17428 menu item, or the shortcut key
17437 Open the error boxes by clicking on them with the mouse, or use the shortcut
17446 bindings, or the corresponding
17455 Read the warning and correct the mistake, if it is a mistake.
17456 If you have trouble understanding what the warning is about, you can safely
17458 Remember that there is a hidden layer between the document on screen and
17459 the technical details in invoking
17463 , and this gap can make some warnings seem arcane or just right down plain
17467 \begin_layout Standard
17468 This document is an excellent testing bed for the feature, and it should
17469 provide quite a few warnings for you to fiddle with.
17470 Since computers are only so smart, expect most of the warnings to be false
17474 \begin_layout Subsection
17475 How to fine tune it
17478 \begin_layout Standard
17479 Sometimes, you'll find that
17483 makes more noise than suits your mood.
17484 Then you can choose not to use it, wait until your mood changes, or try
17489 to get better along with you.
17490 Another choice in the most desperate situations is to use
17492 View\SpecialChar \menuseparator
17494 \begin_inset space ~
17498 \begin_inset space ~
17502 \begin_inset space ~
17507 , which will get rid of all warnings instantly.
17510 \begin_layout Standard
17519 very configurable and extensible, you shouldn't expect to solve all problems
17525 Since LyX has to generate a somewhat special LaTeX file to be able to match
17526 the line numbers from the
17534 \begin_layout Plain Layout
17535 You can inspect the specific output from
17541 Edit\SpecialChar \menuseparator
17543 \begin_inset space ~
17547 \begin_inset space ~
17561 to the internal document structure, some of the warnings will not seen
17562 to appear correctly.
17563 There are two things you can do about this:
17566 \begin_layout Itemize
17571 invocation command line in
17587 installation configuration file (usually with the file
17592 See below to learn what warnings can be enabled and disabled on the command
17597 \begin_layout Itemize
17598 Export your document as a raw LaTeX file using
17600 File\SpecialChar \menuseparator
17601 Export\SpecialChar \menuseparator
17609 Invoked in this way, it can be a hassle to find the corresponding place
17610 in the document inside LyX, but with a little patience, you should be able
17614 \begin_layout Standard
17615 Here follows the warning messages that can be enabled and disabled in
17624 to disable a warning, and
17628 to enable a warning.
17629 The emphasized entries are disabled by default, because the default is
17632 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17637 \begin_layout Standard
17638 Notice that you should only use the options that enable and disable warnings,
17639 because LyX relies on some of the other command line parameters to be set
17640 in a specific way to have a chance to communicate with
17647 \begin_layout Enumerate
17651 Command terminated with space.
17654 \begin_layout Enumerate
17657 Non-breaking space (
17658 \begin_inset Quotes eld
17666 \begin_inset Quotes erd
17669 ) should have been used.
17672 \begin_layout Enumerate
17676 You should enclose the previous parenthesis with
17677 \begin_inset Quotes eld
17685 \begin_inset Quotes erd
17691 \begin_layout Enumerate
17694 Italic correction (
17695 \begin_inset Quotes eld
17705 \begin_inset Quotes erd
17708 ) found in non-italic buffer.
17711 \begin_layout Enumerate
17714 Italic correction (
17715 \begin_inset Quotes eld
17725 \begin_inset Quotes erd
17728 ) found more than once.
17731 \begin_layout Enumerate
17735 No italic correction (
17736 \begin_inset Quotes eld
17746 \begin_inset Quotes erd
17752 \begin_layout Enumerate
17756 \begin_inset Quotes eld
17764 \begin_inset Quotes erd
17768 \begin_inset Quotes eld
17776 \begin_inset Quotes erd
17782 \begin_layout Enumerate
17785 Wrong length of dash may have been used.
17788 \begin_layout Enumerate
17792 \begin_inset Quotes eld
17800 \begin_inset Quotes erd
17804 \begin_inset Quotes eld
17812 \begin_inset Quotes erd
17818 \begin_layout Enumerate
17822 \begin_inset Quotes eld
17830 \begin_inset Quotes erd
17836 \begin_layout Enumerate
17840 \begin_inset Quotes eld
17848 \begin_inset Quotes erd
17851 to achieve an ellipsis.
17854 \begin_layout Enumerate
17857 Inter-word spacing (
17858 \begin_inset Quotes eld
17868 \begin_inset Quotes eld
17871 ) should perhaps be used.
17874 \begin_layout Enumerate
17877 Inter-sentence spacing (
17878 \begin_inset Quotes eld
17888 \begin_inset Quotes erd
17891 ) should perhaps be used.
17894 \begin_layout Enumerate
17897 Could not find argument for command.
17900 \begin_layout Enumerate
17904 \begin_inset Quotes eld
17912 \begin_inset Quotes erd
17918 \begin_layout Enumerate
17921 Math mode still on at end of LaTeX file.
17924 \begin_layout Enumerate
17928 \begin_inset Quotes eld
17936 \begin_inset Quotes erd
17939 doesn't match the number of
17940 \begin_inset Quotes eld
17948 \begin_inset Quotes erd
17954 \begin_layout Enumerate
17957 You should use either
17960 \begin_inset Quotes eld
17968 \begin_inset Quotes erd
17973 as an alternative to
17974 \begin_inset Quotes eld
17982 \begin_inset Quotes erd
17988 \begin_layout Enumerate
17995 " (ASCII 39) instead of "
18002 \begin_layout Enumerate
18005 User-specified pattern found.
18008 \begin_layout Enumerate
18011 This command might not be intended.
18014 \begin_layout Enumerate
18021 \begin_layout Enumerate
18039 \begin_layout Enumerate
18042 Delete this space to maintain correct page references.
18045 \begin_layout Enumerate
18049 You might wish to put this between a pair of
18050 \begin_inset Quotes eld
18058 \begin_inset Quotes erd
18064 \begin_layout Enumerate
18067 You ought to remove spaces in front of punctuation.
18070 \begin_layout Enumerate
18073 Could not execute LaTeX command.
18076 \begin_layout Enumerate
18085 in front of small punctuation.
18088 \begin_layout Enumerate
18096 may look prettier here.
18099 \begin_layout Enumerate
18103 Multiple spaces detected in output.
18106 \begin_layout Enumerate
18109 This text may be ignored.
18112 \begin_layout Enumerate
18118 \begin_inset Quotes eld
18123 to begin quotation, not
18130 \begin_layout Enumerate
18137 to end quotation, not
18140 \begin_inset Quotes eld
18148 \begin_layout Enumerate
18154 \begin_layout Enumerate
18157 You should perhaps use
18158 \begin_inset Quotes eld
18166 \begin_inset Quotes erd
18172 \begin_layout Enumerate
18175 You should put a space in front of/after parenthesis.
18178 \begin_layout Enumerate
18181 You should avoid spaces in front of/after parenthesis.
18184 \begin_layout Enumerate
18188 You should not use punctuation in front of/after quotes.
18191 \begin_layout Enumerate
18194 Double space found.
18197 \begin_layout Enumerate
18200 You should put punctuation outside inner/inside display math mode.
18203 \begin_layout Enumerate
18206 You ought to not use primitive TeX in LaTeX code.
18209 \begin_layout Enumerate
18212 You should remove spaces in front of
18213 \begin_inset Quotes eld
18221 \begin_inset Quotes erd
18227 \begin_layout Enumerate
18230 \begin_inset Quotes eld
18238 \begin_inset Quotes erd
18241 is normally not followed by
18242 \begin_inset Quotes eld
18250 \begin_inset Quotes erd
18256 \begin_layout Standard
18257 In later versions of LyX, we hope to provide a more complete interface to
18258 this tool (and it's smaller cousin
18262 ) to exploit the full power of it.
18263 But it's not exactly useless as it is now: go try it on one of your existing
18264 documents of a certain length and be surprised.
18267 \begin_layout Section
18268 Version Control in LyX
18271 \begin_layout Standard
18274 Lars Gullik Bjønnes,
18281 \begin_layout Subsection
18285 \begin_layout Standard
18286 A friend of mine wanted to try LyX for a group project.
18287 When he didn't find support for version control or file locking, he dropped
18289 This angered me a bit, so I thought that I should at least make support
18290 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
18291 This has now been done.
18292 LyX now supports some of the most basic RCS commands.
18293 If you need to something a bit more sophisticated you will have to do that
18294 manually in an xterm.
18297 \begin_layout Standard
18298 Before you begin to use the version control features in LyX, you should
18300 \begin_inset Quotes eld
18304 \begin_inset Quotes erd
18307 (a man file, read it with
18312 This file describes all the basic features of RCS.
18313 You should especially notice the comment about a RCS directory, and the
18314 notion of a master RCS file (the file ending in
18321 \begin_layout Standard
18322 Later basic CVS/SVN support was added.
18323 You should be familiar with CVS/SVN usage before start using it under LyX.
18324 Most of the log messages are not currently displayed after operations -
18325 you can check them in terminal window if unsure.
18328 \begin_layout Standard
18329 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18330 package—no guarantees are made for older versions.
18333 \begin_layout Standard
18334 For introducing your own external commands consult vc-command in the manual
18338 \begin_layout Subsection
18339 RCS commands in LyX
18342 \begin_layout Standard
18343 The following sections describe the RCS commands supported by LyX.
18344 You can find them in the
18346 File\SpecialChar \menuseparator
18348 \begin_inset space ~
18354 LyX was tested against RCS 5.7.
18357 \begin_layout Subsubsection
18363 \begin_layout Standard
18364 If your document is not under revision control, this is the only item shown
18366 And if it is under revision control, the
18370 item is not visible.
18374 \begin_layout Standard
18375 This command registers your document with RCS (unless you are under the
18376 directory managed by CVS)\SpecialChar \@.
18377 You are asked interactively to supply an initial
18378 description of the document.
18379 The document is now set in Read-Only mode and you have to
18382 \begin_inset space ~
18386 \begin_inset space ~
18390 \begin_inset space ~
18395 , before making any changes to it.
18396 A document under revision control has a
18397 \begin_inset Quotes eld
18400 [RCS:<version> <locker>]
18401 \begin_inset Quotes erd
18404 item tagged to the filename in the minibuffer.
18407 \begin_layout Standard
18408 RCS command that is run:
18410 ci -q -u -i -t-"<initial description>" <file-name>
18413 \begin_layout Standard
18418 to understand the switches.
18422 \begin_layout Subsubsection
18428 \begin_layout Standard
18429 When you are finished editing a file, you check in your changes.
18430 When you do this, you are asked for a description of the changes.
18431 This is stored in the history log.
18432 The version number is bumped, your changes are applied to the master RCS
18433 file, the document is unlocked and set to Read-Only mode.
18437 \begin_layout Standard
18440 ci -q -u -m"<description>" <file-name>
18443 \begin_layout Subsubsection
18449 \begin_layout Standard
18450 By doing this you lock the document so that only you can edit it.
18451 This will also make the document Read-Write only for you.
18452 You will usually continue editing for a while and when you are finished
18453 you check in your changes.
18454 The status line is changed to reflect that you have locked the file.
18458 \begin_layout Standard
18461 co -q -l <file-name>
18464 \begin_layout Subsubsection
18467 Revert To Repository Version
18470 \begin_layout Standard
18471 This will discard all changes made to the document since the last check
18473 You get a warning before changes are discarded.
18476 \begin_layout Standard
18479 co -f -u<version> <file-name>
18482 \begin_layout Subsubsection
18488 \begin_layout Standard
18489 This makes as if the last check in never happened.
18490 No changes are made to the document loaded into LyX, but the last version
18491 is removed from the master RCS file.
18495 \begin_layout Standard
18498 rcs -o<version> <file-name>
18501 \begin_layout Subsubsection
18507 \begin_layout Standard
18508 This show the complete history of the RCS document.
18513 is shown in a browser.
18521 \begin_layout Subsection
18522 CVS commands in LyX
18525 \begin_layout Standard
18526 CVS is now partially supported by LyX.
18527 You can find the commands in the
18529 File\SpecialChar \menuseparator
18531 \begin_inset space ~
18539 \begin_layout Subsubsection
18545 \begin_layout Standard
18546 If your document is not under revision control, this is the only item shown
18548 And if it is under revision control, the
18555 item is not visible.
18559 \begin_layout Standard
18560 This command registers in CVS your document ONLY in case you have already
18561 the documents directory under CVS control (in particular
18566 This means you have to checkout the archive by yourself.
18570 \begin_layout Standard
18571 Then you are asked interactively to supply an initial description of the
18573 Don't forget that registered file is not yet commited.
18576 \begin_layout Standard
18577 CVS command that is run:
18580 \begin_inset Quotes erd
18584 \begin_inset Quotes eld
18588 \begin_inset Quotes erd
18594 \begin_layout Standard
18599 to understand the switches.
18603 \begin_layout Subsubsection
18609 \begin_layout Standard
18610 When you are finished editing a file, you commit your changes.
18611 When you do this, you are asked for a description of the changes.
18612 After that changes are commited.
18615 \begin_layout Standard
18618 cvs -q commit -m"<description>" "<file-name>"
18621 \begin_layout Subsubsection
18624 Revert To Repository Version
18627 \begin_layout Standard
18628 This will discard all changes made to the document since the last check
18630 You get a warning before changes are discarded.
18631 Firstly the file is deleted, secondly CVS update command is run.
18634 \begin_layout Standard
18638 \begin_inset Quotes eld
18642 \begin_inset Quotes erd
18648 \begin_layout Subsubsection
18654 \begin_layout Standard
18655 This show the complete history of the CVS document.
18659 \begin_inset Quotes eld
18663 \begin_inset Quotes erd
18668 is shown in a browser.
18671 \begin_layout Subsection
18672 SVN commands in LyX
18675 \begin_layout Standard
18676 SVN is now partially supported by LyX.
18677 You can find the commands in the
18679 File\SpecialChar \menuseparator
18681 \begin_inset space ~
18687 Please note that if you use password protected access to repository via
18688 ssh, you will be asked in terminal window.
18689 LyX was tested against SVN 1.5 and 1.6
18693 \begin_layout Plain Layout
18694 Most of the commands will work with 1.4 too, see
18695 \begin_inset CommandInset ref
18697 reference "sub:SVN-Repo-Update"
18709 \begin_layout Subsubsection
18715 \begin_layout Standard
18716 If your document is not under revision control, this is the only item shown
18718 And if it is under revision control, the
18725 item is not visible.
18729 \begin_layout Standard
18730 This command registers in SVN your document ONLY in case you have already
18731 the documents directory under SVN control (in particular
18736 This means you have to checkout the archive by yourself.
18740 \begin_layout Standard
18741 Then you are asked interactively to supply an initial description of the
18743 Don't forget that registered file is not yet commited.
18746 \begin_layout Standard
18747 SVN command that is run:
18750 \begin_inset Quotes eld
18754 \begin_inset Quotes erd
18760 \begin_layout Standard
18765 to understand the switches.
18769 \begin_layout Subsubsection
18775 \begin_layout Standard
18776 When you are finished editing a file, you commit your changes.
18777 When you do this, you are asked for a description of the changes.
18778 After that changes are commited.
18781 \begin_layout Standard
18786 \begin_layout Plain Layout
18787 In case locking is not enabled.
18789 \begin_inset CommandInset ref
18791 reference "subsec:SVN-File-Locking"
18802 svn commit -q -m"<description>" <file-name>
18805 \begin_layout Subsubsection
18811 \begin_layout Standard
18812 Updates the changes of this file from the repository.
18813 Be sure you understand SVN merging and conflicts resolving before using
18814 this function, because all conflicts has to be resolved manually by you!
18817 \begin_layout Standard
18822 \begin_layout Plain Layout
18831 \begin_inset Quotes eld
18835 \begin_inset Quotes erd
18841 \begin_layout Subsubsection
18844 Revert To Repository Version
18847 \begin_layout Standard
18848 This will discard all changes made to the document since the last check
18850 You get a warning before changes are discarded.
18854 \begin_layout Standard
18858 \begin_inset Quotes eld
18862 \begin_inset Quotes erd
18868 \begin_layout Subsubsection
18869 \begin_inset CommandInset label
18871 name "sub:SVN-Repo-Update"
18875 Update of the local directory checkout from repository
18879 \begin_layout Plain Layout
18880 Note that this command will work only with subversion
18881 \begin_inset Formula $\geqq1.5$
18892 \begin_layout Standard
18893 All the commands above have one shortcomming - they deal with the current
18895 Once your document contains pictures, includes external
18896 \begin_inset Flex CharStyle:Code
18899 \begin_layout Plain Layout
18905 files and so on administration becomes more complicated.
18906 LyX now supports updating the whole tree in which resides the document
18910 \begin_layout Plain Layout
18911 One need to organize the files structure so that all external files are
18912 in the same directory or subdirectories of the document.
18919 This become especially useful once you cooperate with people which neither
18920 know about subversion management nor they have ambition to commit additional
18921 material to the repository.
18925 \begin_layout Standard
18926 \begin_inset Flex CharStyle:Code
18929 \begin_layout Plain Layout
18930 Update local directory from repository
18935 command updates the whole directory and in case of merge conflicts local
18936 version of the files are left, so no unintended data loss occurs.
18937 If local changes are detected user is warned before update starts.
18940 \begin_layout Labeling
18941 \labelwidthstring 00.00.0000
18943 \begin_inset space ~
18947 \begin_inset space ~
18951 \begin_inset Newline newline
18955 \begin_inset Flex CharStyle:Code
18958 \begin_layout Plain Layout
18964 (Ask if changes are detected.)
18965 \begin_inset Newline newline
18969 \begin_inset Flex CharStyle:Code
18972 \begin_layout Plain Layout
18973 svn update --accept mine-full $path
18981 \begin_layout Standard
18983 \begin_inset Flex CharStyle:Code
18986 \begin_layout Plain Layout
18992 stands for the path to the document.
18995 \begin_layout Subsubsection
19001 \begin_layout Standard
19002 This show the complete history of the SVN document.
19006 \begin_inset Quotes eld
19010 \begin_inset Quotes erd
19015 is shown in a browser.
19018 \begin_layout Subsubsection
19020 \begin_inset CommandInset label
19022 name "subsec:SVN-File-Locking"
19029 \begin_layout Standard
19030 The file exchange through various revision control systems brings the problem
19031 of merge conflicts in case two different users try to edit the same (parts
19033 When such conflict happens it needs manual resolving and one reasonable
19034 alternative is to provide some kind of locking mechanism, which guarantees
19035 that only one user is allowed to edit file at the given time.
19038 \begin_layout Standard
19039 SVN has two mechanisms to provide such kind of mutual exclusivity for file
19040 access - locks and automatical setting of write permissions (see sec.
19042 \begin_inset CommandInset ref
19044 reference "subsec:Automatical-Locking-Property"
19049 \begin_inset Flex CharStyle:Code
19052 \begin_layout Plain Layout
19062 \begin_layout Plain Layout
19063 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
19069 In a case this property is detected for a given document LyX starts to
19070 use SVN locks for document editing automatically and the whole check-in/out
19071 mechanism switches to the same regimen as for RCS.
19072 This in particular means there are two different modes how file is used
19076 \begin_layout Itemize
19078 The loaded file is in the read-only mode.
19079 For editation on needs to check-out.
19084 consists of update from repository and gaining write lock.
19085 If the lock is not possible to obtain, we remain in unlocked state.
19088 \begin_layout Itemize
19090 The loaded file is in the 'normal' edit mode.
19091 No other user is allowed to edit the file.
19096 consists of commiting changes and releasing write-lock.
19097 If no changes have been made to the document, no commit will be produced
19101 \begin_layout Plain Layout
19102 Don't be puzzled by the fact that you will be asked for commit message anyway.
19107 and only the write-lock will be released.
19110 \begin_layout Standard
19114 \begin_layout Labeling
19115 \labelwidthstring 00.00.0000
19118 svn commit -q -m"<description>" "<file-name>"
19119 \begin_inset Newline newline
19122 svn unlock "<file-name>"
19125 \begin_layout Labeling
19126 \labelwidthstring 00.00.0000
19129 svn update "<file-name>"
19130 \begin_inset Newline newline
19133 svn lock "<file-name>"
19136 \begin_layout Subsubsection
19139 \begin_inset CommandInset label
19141 name "subsec:Automatical-Locking-Property"
19147 Automatical Locking Property
19150 \begin_layout Standard
19151 The above mentioned automatical setting of write permissions of the .lyx
19152 file can be set through
19157 ile\SpecialChar \menuseparator
19163 \begin_inset space ~
19166 Control\SpecialChar \menuseparator
19171 oggle locking property
19174 This command is active only when the file is not locked on the svn server
19176 you need to check-out before proceeding).
19179 \begin_layout Labeling
19180 \labelwidthstring 00.00.0000
19182 \begin_inset space ~
19188 \begin_layout Labeling
19189 \labelwidthstring 00.00.0000
19192 svn propset svn:needs-lock ON "<file-name>"
19195 \begin_layout Labeling
19196 \labelwidthstring 00.00.0000
19199 svn propdel svn:needs-lock "<file-name>"
19202 \begin_layout Subsubsection
19203 Revision Information in Documents
19206 \begin_layout Standard
19207 Currently there is no way how to provide such kind of information directly
19209 There are possibilities how to activate it with the help of svn features,
19210 but each has its own drawbacks.
19213 \begin_layout Standard
19214 One possibility is to use svn keywords
19218 \begin_layout Plain Layout
19219 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
19225 In short -- you set file keywords property (e.g.
19228 svn propset svn:keywords 'Rev' file.lyx
19230 ) and then paste keyword ERT
19234 \begin_layout Plain Layout
19235 This is an easy way how to ensure that LyX won't break the line in the middle
19241 tag in your document (e.g.
19246 \begin_layout Plain Layout
19254 This way svn client will automatically substitute revision number (e.g.
19259 \begin_layout Plain Layout
19266 ) after each update and commit.
19267 There are more problems with this approach.
19268 Firstly, the '$' character is used in TeX world for math equations, so
19269 any occurence of math formula
19270 \begin_inset Formula $Rev$
19274 \begin_inset Formula $Rev:59$
19277 in your LyX document.
19278 Similarly for other keywords like Id, Date, Author, etc.
19279 Secondly svn output is dependent on your locales, so its very easy that
19280 svn would produce some problematic strings once Date is used.
19281 Thirdly you get the whole 'Rev: 59' string in your document instead of
19283 Until subversion implements user's custom keywords it will be hard to use
19284 this approach reliably or let LyX to support it directly .
19287 \begin_layout Standard
19288 The second possibility would be to write your own external-material template
19290 \begin_inset Flex CharStyle:Code
19293 \begin_layout Plain Layout
19299 utility or parses the output of
19300 \begin_inset Flex CharStyle:Code
19303 \begin_layout Plain Layout
19309 command and returns the result back, when typeseting the document.
19312 \begin_layout Subsection
19313 SVN and Windows Environment
19316 \begin_layout Quote
19317 My inclination is to say that if the user cannot figure out the command
19318 line operations on their own fairly quickly, they would be well advised
19319 to use TortoiseSVN.
19325 \begin_layout Subsubsection
19329 \begin_layout Standard
19330 In addition to installing LyX, and having access to a Subversion repository,
19331 the user will need to install the Subversion client program.
19332 A Windows installer for the client program is available from
19333 \begin_inset CommandInset href
19336 target "http://www.collab.net/nonav/downloads/subversion/"
19341 The user may also want to install
19342 \begin_inset CommandInset href
19345 target "http://tortoisesvn.tigris.org/"
19349 , which integrates Subversion operations into the context (rightclick) menu
19350 of Windows Explorer.
19351 Operations done outside LyX will typically be more convenient using the
19352 Explorer context menu.
19353 Note that TortoiseSVN is not a replacement for the client program, which
19354 is what LyX itself will use.
19357 \begin_layout Subsubsection
19358 Bringing a document under Subversion control
19361 \begin_layout Standard
19362 Before a LyX document can be brought under version control in Subversion,
19363 its parent directory needs to be under version control.
19364 If the document is being added to a project already in the repository,
19365 this is accomplished by checking the project out to the directory where
19366 the new document will be placed.
19367 If the project itself is not yet under version control (for instance, if
19368 this document starts a new project), the directory must be imported into
19370 This is done outside LyX.
19371 Both import and checkout are easily accomplished from the Explorer context
19372 menu using TortoiseSVN, or alternatively can be done using the command
19373 line client at a DOS prompt.
19374 The procedure for importing the project using TortoiseSVN is described
19375 below, assuming an existing repository and a new project being started
19383 For information on using the Subversion client program, run
19390 \begin_layout Enumerate
19397 in Windows Explorer, right click it, and select
19399 TortoiseSVN > Repo-browser
19402 If necessary, adjust the URL for the repository, then click OK.
19405 \begin_layout Enumerate
19406 Right click the level of the repository under which you want to place the
19407 new project folder (typically the top level) and click
19409 Create folder\SpecialChar \ldots{}
19412 Supply a name for the project folder and click OK.
19413 Add a message for the log file if desired, then click OK again.
19414 The new project folder should appear in the repository.
19415 Finally, click OK again to exit the repository browser.
19418 \begin_layout Enumerate
19419 Once again right click
19425 , this time selecting SVN Checkout\SpecialChar \ldots{}
19426 Select the URL of the project folder
19427 you just created in the repository, and set the checkout directory to
19435 You will be warned about a non-empty folder; click OK to proceed.
19436 You should now have a
19447 \begin_layout Enumerate
19448 Create or open your document in LyX and click
19453 ile\SpecialChar \menuseparator
19459 \begin_inset space ~
19462 Control\SpecialChar \menuseparator
19470 Add a log message and click OK to commit the document to version control.
19473 \begin_layout Standard
19474 From this point onward, you should have full functionality in the
19479 ile\SpecialChar \menuseparator
19485 \begin_inset space ~
19491 You also have the option of checking the document in and out, viewing its
19493 using the TortoiseSVN context menu in Windows Explorer or the Subversion
19494 client program from a command prompt.
19497 \begin_layout Subsubsection
19498 SSH tunel used with SVN under Windows
19501 \begin_layout Standard
19502 Compared to linux setting svn client to communicate over ssh under Windows
19503 is rather troublesome task.
19504 We will at least make some hints how to setup client side but former knowledge
19505 about ssh and Windows command line is needed, also be prepared for a great
19506 deal of frustration...
19509 \begin_layout Enumerate
19510 Get svn client for windows, as described in previous sections.
19511 When it is fresh install run some svn command (e.g.
19513 \begin_inset Flex CharStyle:Code
19516 \begin_layout Plain Layout
19522 ) to have created config files, which you will need to change later on.
19525 \begin_layout Enumerate
19526 Choose ssh client for Windows.
19527 There are more possibilities, we will use the one from Putty tools
19531 \begin_layout Plain Layout
19532 \begin_inset Flex URL
19535 \begin_layout Plain Layout
19537 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
19548 You will need to automatize connection, so client doesn't ask for any password
19550 To keep things easy we will use only keys without any additional password
19555 \begin_layout Enumerate
19557 \begin_inset Flex CharStyle:Code
19560 \begin_layout Plain Layout
19567 Save your private .ppk key file and put the public one on the server side.
19568 In case the SVN server runs on linux, note that the format of the public
19569 key is not compatible with linux openssh and you will need to direcly copy-past
19570 e the key from the “
19571 \begin_inset Flex CharStyle:Emph
19574 \begin_layout Plain Layout
19575 Public key for pasting into OpenSSH authorized_keys file:
19580 ” edit field into the server's
19581 \begin_inset Flex CharStyle:Code
19584 \begin_layout Plain Layout
19585 ~/.ssh/authorized_keys
19591 \begin_inset Flex CharStyle:Code
19594 \begin_layout Plain Layout
19603 \begin_layout Enumerate
19605 \begin_inset Flex CharStyle:Code
19608 \begin_layout Plain Layout
19615 In the SVN config file
19619 \begin_layout Plain Layout
19620 Exact path depends on Windows version, usually somewhere around
19621 \begin_inset Flex CharStyle:Code
19624 \begin_layout Plain Layout
19627 Documents and Settings
19641 \begin_inset Flex CharStyle:Code
19644 \begin_layout Plain Layout
19659 , section [tunnels], setup ssh command, e.g.
19661 \begin_inset Flex CharStyle:Code
19664 \begin_layout Plain Layout
19665 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
19674 \begin_layout Plain Layout
19675 It will usually take a lot of time to get exact command right and it depends
19677 For example do not have some remote server saved as a default session in
19679 If things fail, try to connect via plink without SVN first.
19688 \begin_layout Enumerate
19689 Checkout the SVN archive, e.g.
19691 \begin_inset Flex CharStyle:Code
19694 \begin_layout Plain Layout
19695 svn co svn+ssh://user@server/repository_path
19703 \begin_layout Subsection
19707 \begin_layout Standard
19708 With the recent addition of the vc-command function LyX power users are
19709 allowed to create their own commands for revision control.
19712 \begin_layout Standard
19713 As an example you can see how two TortoiseSVN commands could be integrated
19717 \begin_layout Description
19719 \begin_inset Flex CharStyle:Code
19722 \begin_layout Plain Layout
19723 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
19731 \begin_layout Description
19733 \begin_inset Flex CharStyle:Code
19736 \begin_layout Plain Layout
19737 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
19745 \begin_layout Section
19746 Literate Programming
19749 \begin_layout Standard
19754 (kayvan@sylvan.com)
19758 original documentation written by
19760 Edmar Wienskoski Jr.
19763 (edmar-w-jr@technologist.com)
19766 \begin_layout Subsection
19770 \begin_layout Standard
19771 The main purpose of this documentation is to show you how to use LyX for
19772 literate programming.
19773 Where it is assumed that you are familiar with this programming technique,
19775 \begin_inset Quotes eld
19779 \begin_inset Quotes erd
19783 \begin_inset Quotes eld
19787 \begin_inset Quotes erd
19791 If that is not the case, please follow the web links provided in the following
19793 There is a lot of good documentation out there covering old development
19794 history to the latest tools tips.
19797 \begin_layout Standard
19798 It is also assumed that you are familiar with LyX itself to a point that
19799 you are comfortable changing your LyX preferences, and X resources file.
19800 If that is not the case please refer to other LyX documentation to cover
19801 your specific needs.
19804 \begin_layout Subsection
19805 Literate Programming
19808 \begin_layout Standard
19809 From the Literate Programming FAQ:
19812 \begin_layout Quotation
19813 Literate programming is the combination of documentation and source together
19814 in a fashion suited for reading by human beings.
19815 In fact, literate programs should be enjoyable reading, even inviting!
19816 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
19817 and documentation in a single file.
19818 Literate programming tools then parse the file to produce either readable
19819 documentation or compilable source.
19820 The WEB style of literate programming was created by D.
19821 \begin_inset space \thinspace{}
19825 Knuth during the development of his TeX typesetting software.
19829 \begin_layout Standard
19830 Another excerpt says:
19833 \begin_layout Quotation
19836 How is literate programming different from verbose commenting?
19839 \begin_layout Quotation
19840 There are three distinguishing characteristics.
19841 In order of importance, they are:
19845 \begin_layout Itemize
19846 flexible order of elaboration
19849 \begin_layout Itemize
19850 automatic support for browsing
19853 \begin_layout Itemize
19854 typeset documentation, especially diagrams and mathematics
19858 \begin_layout Standard
19859 Now that I sparked your curiosity, take a look in the references.
19862 \begin_layout Subsubsection
19866 \begin_layout Standard
19867 The complete Literate Programming FAQ can be found at:
19870 \begin_layout Quote
19871 Literate Programming FAQ
19872 \begin_inset Flex URL
19875 \begin_layout Plain Layout
19877 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
19885 \begin_layout Standard
19886 The FAQ lists 23 (twenty three!) different literate programming tools.
19887 Where some are specialized or
19888 \begin_inset Quotes eld
19892 \begin_inset Quotes erd
19895 for particular programming languages, while other have general scope.
19900 for my own use for several reasons:
19903 \begin_layout Itemize
19904 It can generate the documentation either in LaTeX or HTML.
19907 \begin_layout Itemize
19908 It has a open architecture, i.
19909 \begin_inset space \thinspace{}
19913 \begin_inset space \space{}
19916 it is easy to plug in new filters and to perform special processing that
19921 \begin_layout Itemize
19922 There is a good selection of filters available already (the HTML is one
19926 \begin_layout Itemize
19930 \begin_layout Standard
19931 The Noweb web page can be found at:
19934 \begin_layout Quote
19936 \begin_inset Flex URL
19939 \begin_layout Plain Layout
19941 http://www.cs.virginia.edu/~nr/noweb/
19949 \begin_layout Standard
19950 Starting from there you can reach many other interesting links and even
19951 some literate program examples.
19954 \begin_layout Subsection
19955 LyX and Literate Programming
19958 \begin_layout Standard
19959 The LyX support for Literate Programming is provided by using the generic
19960 LyX converters mechanism.
19961 This support is provided in a
19962 \begin_inset Quotes eld
19966 \begin_inset Quotes erd
19970 \begin_inset space \thinspace{}
19974 \begin_inset space \space{}
19977 you will be able to use this new LyX feature with some other literate programmin
19978 g tool of your choice by just changing your LyX preferences.
19981 \begin_layout Subsubsection
19982 Generating documents and code (weaving and tangling)
19985 \begin_layout Paragraph
19986 Selecting the document class
19989 \begin_layout Standard
19990 If you have installed Noweb and LyX successfully, whenever you open a new
19991 document or try to change the document class of an existing one, you will
19992 find that there are three new document classes available:
19995 \begin_layout Itemize
19999 \begin_layout Itemize
20003 \begin_layout Itemize
20007 \begin_layout Standard
20008 You must select one of them to create your literate documents from.
20012 \begin_layout Standard
20013 Note that literate documents are not limited to these three classes.
20014 New classes can be generated from other styles like letter or in combination
20015 with other class variations like Article (AMS).
20016 If you have special needs that cannot be covered by one of the existing
20017 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20018 will arrange to insert a new entry, or teach you how to do it.
20022 \begin_layout Plain Layout
20023 It is very simple, it involves the creation of a file with four lines, and
20024 re-running of the auto configuration.
20029 Moreover, if you use a literate tool other than Noweb you may need to create
20030 a new set of document classes for it.
20033 \begin_layout Paragraph
20037 \begin_layout Standard
20038 LyX enables you to write code with a layout named
20046 \begin_layout Plain Layout
20047 The equivalent Noweb term is
20048 \begin_inset Quotes eld
20052 \begin_inset Quotes erd
20056 For historical reasons, I got used to the term
20057 \begin_inset Quotes eld
20061 \begin_inset Quotes erd
20064 introduced by other literate tool named Nuweb, which I used for many years
20065 before rendering myself to Noweb.
20070 Noweb delimits scraps like this:
20073 \begin_layout LyX-Code
20077 \begin_layout LyX-Code
20081 \begin_layout LyX-Code
20085 \begin_layout LyX-Code
20089 \begin_layout LyX-Code
20093 \begin_layout Standard
20094 The problem is that whatever is written in between the << and the
20098 must be taken literally, i.
20099 \begin_inset space \thinspace{}
20103 \begin_inset space \space{}
20106 LyX should be prevented from making any special interpretation of what has
20108 This is handled by a special layout named Scrap, that works like a normal
20109 paragraph but has a free spacing capability.
20112 \begin_layout Standard
20113 The down side of the Scrap paragraph layout is that consecutive paragraphs
20114 of code will be spaced with one empty line in the source code and also
20115 in the printed documentation.
20116 The work around is to enter each line of code within a single Scrap, with
20117 a newline (ctrl-return).
20118 The example above will look like this:
20122 \begin_layout Plain Layout
20123 If you have a printed version of this document you will not see any difference
20124 between the previous example and this one.
20132 \begin_layout LyX-Code
20134 \begin_inset Newline newline
20138 \begin_inset Newline newline
20142 \begin_inset Newline newline
20146 \begin_inset Newline newline
20152 \begin_layout Standard
20153 This layout works fine.
20154 The only real inconvenience is that you have to type ctrl-return instead
20159 \begin_layout Plain Layout
20160 It is in my list of
20161 \begin_inset Quotes eld
20165 \begin_inset Quotes erd
20176 \begin_layout Standard
20177 As a special note, you can also use the
20178 \begin_inset Quotes eld
20182 \begin_inset Quotes erd
20185 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20189 \begin_layout LyX-Code
20191 \begin_inset Newline newline
20194 def some_function(args):
20195 \begin_inset Newline newline
20198 "This is the doc string for this function."
20199 \begin_inset Newline newline
20202 print "My args: ", args
20205 \begin_layout LyX-Code
20206 @ %def some_function
20209 \begin_layout Standard
20210 For an example of this usage and the resulting cross-reference output, look
20211 at the Literate python program in
20213 LIBDIR/examples/listerrors.lyx
20215 which should make this all clear.
20218 \begin_layout Paragraph
20219 Generating the documentation
20222 \begin_layout Standard
20223 At this point you already have a new document file with a proper document
20224 class, and with some code and text on it.
20225 How do I print it? The answer is simple, you select
20227 View\SpecialChar \menuseparator
20231 Just like you would do for a plain document.
20232 No special procedure is required.
20235 \begin_layout Standard
20236 To help orientate you, I will now explain what happens inside LyX:
20239 \begin_layout Enumerate
20242 Update\SpecialChar \menuseparator
20245 menu option is chosen, a LaTeX file is generated.
20250 \begin_layout Standard
20251 If the document is of any literate class the generated file will be named
20252 with an extension name defined by the
20253 \begin_inset Quotes eld
20257 \begin_inset Quotes erd
20260 format (defined in the Preferences panel), otherwise the file will have
20269 \begin_layout Enumerate
20270 Note that the only difference so far is in the name of the file, no special
20271 processing is required by LyX.
20272 Given that you formatted the code using the Scrap layout that, by itself,
20273 takes care of the business.
20276 \begin_layout Enumerate
20277 If the document is of any literate class LyX will then use the internal
20278 LyX to Noweb converter, followed by the Noweb to LaTeX converter
20282 \begin_layout Plain Layout
20283 The converters are defined in the
20285 Tools\SpecialChar \menuseparator
20289 \begin_inset Quotes eld
20293 \begin_inset Quotes erd
20305 manual for general information about converters.
20310 to generate the LaTeX file.
20314 \begin_layout Standard
20315 Otherwise it will just skip this step.
20319 \begin_layout Enumerate
20320 Finally, LaTeX is invoked and the regular post processing continues as in
20324 \begin_layout Standard
20325 Independence from a particular
20326 \begin_inset Quotes eld
20330 \begin_inset Quotes erd
20333 is easily achieved by changing the commands that are run by the various
20337 \begin_layout Paragraph
20338 Generating the code
20341 \begin_layout Standard
20342 When the build menu option is chosen or the corresponding button in the
20343 toolbar is pressed, a LaTeX file is generated just like step 1 above.
20344 Next, LyX invokes the
20349 This converter needs to be defined by the user and is not installed by
20350 default, though the Program format is.
20351 This converter (like any other converter) will have two parts:
20354 \begin_layout Enumerate
20355 The converter program itself.
20356 This program performs the conversion from the one format to the other (in
20357 this case, from the Noweb format to the Program pseudo-format).
20360 \begin_layout Enumerate
20361 The error log parser.
20362 This is a program whose sole purpose is to rewrite error messages in a
20363 format that LyX understands.
20364 This makes it possible for LyX to place error boxes in the right places
20365 in the file buffer.
20368 \begin_layout Standard
20369 The first part, the
20370 \begin_inset Quotes eld
20374 \begin_inset Quotes erd
20377 setting, should be set to
20378 \begin_inset Quotes eld
20386 \begin_inset Quotes erd
20390 This basically means that LyX will call
20391 \begin_inset Quotes eld
20395 \begin_inset Quotes erd
20398 (a program or script) with the name of the Noweb file (normally a file
20399 in the LyX temp directory).
20403 \begin_layout Standard
20404 This is an implementation of
20405 \begin_inset Quotes eld
20409 \begin_inset Quotes erd
20412 that you can place in a directory on your path:
20415 \begin_layout LyX-Code
20419 \begin_layout LyX-Code
20423 \begin_layout LyX-Code
20424 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
20427 \begin_layout Standard
20428 The next part of the converter setting is the
20429 \begin_inset Quotes eld
20433 \begin_inset Quotes erd
20436 which is to be set to
20437 \begin_inset Quotes eld
20442 parselog=listerrors
20445 \begin_inset Quotes erd
20449 This will run any errors that are generated by the
20450 \begin_inset Quotes eld
20454 \begin_inset Quotes erd
20457 process through the
20458 \begin_inset Quotes eld
20462 \begin_inset Quotes erd
20468 \begin_layout Standard
20469 The converter code looks in
20477 then on the path for the
20478 \begin_inset Quotes eld
20482 \begin_inset Quotes erd
20488 \begin_layout Standard
20489 The build will normally take place in LyX's temporary directory, so the
20490 files produced by the conversion will be in that directory.
20491 LyX will copy out what it regards as the `main' file, but the
20495 conversion may produce several files, and so most of these would then be
20496 deleted when LyX was closed.
20497 The present solution is to use a `copier',
20501 \begin_layout Plain Layout
20510 manual for information on these.
20519 script in its default mode, so that the entire contents of the temporary
20520 directory is copied.
20521 More will get copied than is needed, to be sure, but nothing will be lost.
20522 If, however, you know what extensions the generated files will have, this
20523 can be improved by using the
20532 This option takes a comma-separated list of extensions to copy.
20533 So, for example, if the conversion will generate only files with the extensions
20542 , then the correct definition would be:
20545 \begin_layout LyX-Code
20546 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
20549 \begin_layout Standard
20550 The result will be that only files with these two extensions will be copied
20554 \begin_layout Paragraph
20555 Build instructions in the document
20558 \begin_layout Standard
20559 The last piece of the integration between LyX and noweb is the
20560 \begin_inset Quotes eld
20564 \begin_inset Quotes erd
20568 Generally, the instructions for building your program should be embedded
20569 in a scrap of its own.
20571 \begin_inset Quotes eld
20575 \begin_inset Quotes erd
20578 above uses the notangle command to look for this scrap (called
20579 \begin_inset Quotes eld
20583 \begin_inset Quotes erd
20586 ) and runs its contents through
20587 \begin_inset Quotes eld
20591 \begin_inset Quotes erd
20597 \begin_layout Standard
20598 Typically, such a scrap would look something like this:
20601 \begin_layout LyX-Code
20603 \begin_inset Newline newline
20607 \begin_inset Newline newline
20611 \begin_inset Newline newline
20614 if [ -z "${NOWEB_SOURCE}" ]
20615 \begin_inset Newline newline
20619 \begin_inset Newline newline
20622 NOWEB_SOURCE=myfile.nw
20623 \begin_inset Newline newline
20627 \begin_inset Newline newline
20631 code to extract files ...]
20632 \begin_inset Newline newline
20636 code to compile files ...]
20637 \begin_inset Newline newline
20643 \begin_layout Standard
20646 LIBDIR/examples/listerrors.lyx
20650 LIBDIR/examples/Literate.lyx
20652 which implement two versions of the
20653 \begin_inset Quotes eld
20657 \begin_inset Quotes erd
20660 program for some illustrations of how all of these pieces go together or
20663 LIBDIR/examples/noweb2lyx.lyx.
20666 Interestingly, these three files show off the language-indepence of the
20667 LyX literate programming support since they are written in Python, C and
20671 \begin_layout Subsubsection
20675 \begin_layout Standard
20676 All the Literate Programming support is configured by the
20678 Tools\SpecialChar \menuseparator
20682 \begin_inset Quotes eld
20686 \begin_inset Quotes erd
20690 The important parts are:
20693 \begin_layout Description
20695 \begin_inset space ~
20699 \begin_inset Quotes eld
20703 \begin_inset Quotes erd
20707 \begin_inset space ~
20710 format Set up via the Formats tab, this is where the Noweb-specific pieces
20720 , the file extension is set to
20725 This tells LyX to create a file with a
20729 extension in the first step of the conversion process.
20732 \begin_layout Description
20734 \begin_inset space ~
20742 \begin_inset space ~
20745 format This is an empty format whose sole purpose is to be the endpoint
20746 of a conversion (which then allows us to set up a converter for it).
20749 \begin_layout Description
20758 This converter performs the
20759 \begin_inset Quotes eld
20763 \begin_inset Quotes erd
20766 of the literate document.
20767 For Noweb, it is set to
20768 \begin_inset Quotes eld
20773 noweave -delay -index $$i > $$o
20776 \begin_inset Quotes erd
20782 \begin_layout Description
20792 \begin_inset Quotes eld
20796 \begin_inset Quotes erd
20800 As stated above, the Converter is set to
20801 \begin_inset Quotes eld
20809 \begin_inset Quotes erd
20812 , with Flags set to
20813 \begin_inset Quotes eld
20818 originaldir,parselog=listerrors
20821 \begin_inset Quotes erd
20827 \begin_layout Subsubsection
20831 \begin_layout Standard
20832 There is also a new function implemented in the LyX server, the
20833 \begin_inset Quotes eld
20836 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
20840 \begin_layout Standard
20841 When debugging code with ddd/gdb, it is possible to invoke a text editor
20842 at the current execution position with a single key stroke.
20843 The default ddd configuration for that is shift-ctrl-V.
20844 It happens that you can define the editor command line invocation in ddd
20847 Edit\SpecialChar \menuseparator
20848 Preferences\SpecialChar \menuseparator
20851 dialog and changing the "Edit Sources" entry.
20854 \begin_layout Standard
20855 I take advantage of the new created LyX server function and this ddd feature,
20857 \begin_inset Quotes eld
20861 \begin_inset Quotes erd
20867 \begin_layout LyX-Code
20868 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20871 \begin_layout Standard
20872 With this, whenever you are using ddd and find a point in the program that
20873 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20874 ddd you forward this information to LyX through the LyX server and then
20875 the LyX window will show the same file with the cursor at the same position
20876 ddd was pointing to.
20877 No more guessing or long scrolling to locate a point in the program back
20881 \begin_layout Standard
20882 Note however that you must enable the LyX server to get this feature working
20883 (it is disabled by default).
20884 You can enable it in
20896 ) by entering in the
20901 \begin_inset Quotes eld
20906 /home/<your-home-directory>/.lyx/lyxpipe
20909 \begin_inset Quotes erd
20915 \begin_layout Standard
20916 Read the LyX server documentation in the
20918 Customization Manual
20920 for further information.
20923 \begin_layout Subsubsection
20927 \begin_layout Standard
20928 There are six new buttons that can be added to your LyX toolbar.
20929 Five of these buttons are short cuts to layout styles:
20950 The last one is a short cut to the
20951 \begin_inset Quotes eld
20955 \begin_inset Quotes erd
20962 \begin_layout Standard
20963 LyX has a range of buttons that are available for tool bar customization.
20964 In my toolbar I like to combine the six short cuts above with two more:
20969 \SpecialChar \menuseparator
20974 \SpecialChar \menuseparator
20981 View\SpecialChar \menuseparator
20985 Here is how it looks like:
20988 \begin_layout LyX-Code
20992 \begin_layout LyX-Code
20996 \begin_layout LyX-Code
20997 Icon "layout Standard"
21000 \begin_layout LyX-Code
21001 Icon "layout Section"
21004 \begin_layout LyX-Code
21005 Icon "layout LaTeX"
21008 \begin_layout LyX-Code
21009 Icon "layout LyX-Code"
21012 \begin_layout LyX-Code
21013 Icon "layout Scrap"
21016 \begin_layout LyX-Code
21020 \begin_layout LyX-Code
21024 \begin_layout LyX-Code
21025 Icon "buffer-typeset"
21028 \begin_layout LyX-Code
21029 Icon "build-program"
21032 \begin_layout LyX-Code
21036 \begin_layout LyX-Code
21040 \begin_layout LyX-Code
21044 \begin_layout LyX-Code
21048 \begin_layout LyX-Code
21052 \begin_layout Subsubsection
21053 Colors customization
21056 \begin_layout Standard
21057 There are a number of colors in LyX that can be customized in
21062 One of the things that bothers people is the LaTeX font color.
21063 The default color is red, since the scraps uses LaTeX font, and there is
21064 a lot of scraps in literate documents, you may get tired of seeing everything
21066 You can change it by going to the tabs
21075 \begin_layout Standard
21076 The next thing is the visible presence of the newline character in the screen.
21077 You can choose the color of this particular character and make it blend
21079 I recommend you choosing a color that is close to the background but not
21080 equal, that way you still can see it is there, but it is not bothering
21085 \begin_layout Chapter
21086 Secrets of the LaTeX Masters
21087 \begin_inset CommandInset label
21096 \begin_layout Standard
21097 Though LyX is a powerful tool, it cannot hope to support everything that
21098 can be done with pure TeX/LaTeX.
21099 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21100 as long as you are not afraid to use that
21101 \begin_inset Quotes eld
21105 \begin_inset Quotes erd
21108 button on the toolbar or add things to the LaTeX preamble.
21109 This section lists some tips, tricks, and otherwise cool ideas to give
21110 your document that extra little flair.
21113 Do try this at home
21115 , just start with something a little smaller and less important than your
21119 \begin_layout Standard
21120 Most ideas in this section require less common files in your LaTeX installation.
21121 If you have a system like teTeX, most will already be available.
21122 A few, however, will need to be downloaded from one of the CTAN archives.
21123 Often, there are several ways to do something, or several LaTeX style files
21124 which do the same thing.
21125 We do not endorse one choice over another, we simply claim that we have
21126 done a particular task with a particular file.
21127 Put on your wizard hat, keep an eye out for dragons, and let us begin.
21130 \begin_layout Section
21134 \begin_layout Standard
21137 Lars Gullik Bjønnes
21140 \begin_layout Subsection
21144 \begin_layout Standard
21145 The aim for this chapter
21149 \begin_layout Plain Layout
21150 Editor's note: Lars' original chapter was a masterful description of how
21156 However, it was too long to flow smoothly in this document.
21157 I have therefore chosen to excerpt the most important sections here (sorry,
21158 Lars); you can read the original chapter (and more of the story!) in the
21161 examples/multicol.lyx
21169 is to show how the LaTeX package
21173 can be used in a LyX document.
21174 As LyX doesn't support the
21178 package natively yet, we have to use some small hacks.
21179 By reading this section it should be obvious how to do this.
21182 \begin_layout Subsection
21186 \begin_layout Standard
21191 package allows switching between one and multicolumn format on the same
21193 Footnotes are handled correctly (for the most part), but will be placed
21194 at the bottom of the page and not under each column.
21195 LaTeX's float mechanism, however, is partly disabled in the current implementat
21197 At the moment only page-wide floats can be used within the scope of the
21201 \begin_layout Subsection
21205 \begin_layout Subsubsection
21209 \begin_layout Standard
21210 If you want to have two columns in your text, you have use LaTeX mode to
21215 begin{multicols}{2}
21217 at the point where you want the two column layout to start, and then
21223 where you want it to end.
21227 \begin_layout Standard
21231 \begin_layout Plain Layout
21235 begin{multicols}{2}
21243 \begin_layout Standard
21248 The Adventure of the Empty House
21251 \begin_inset Newline newline
21256 Sir Arthur Conan Doyle
21259 \begin_layout Standard
21262 It was in the spring of the year 1894 that all London was interested, and
21263 the fashionable world dismayed, by the murder of the Honourable Ronald
21264 Adair under most unusual and inexplicable circumstances.
21265 The public has already learned those particulars of the crime which came
21266 out in the police investigation, but a good deal was suppressed upon that
21267 occasion, since the case for the prosecution was so overwhelmingly strong
21268 that it was not necessary to bring forward all the facts.
21269 Only now, at the end of nearly ten years, am I allowed to supply those
21270 missing links which make up the whole of that remarkable chain.
21271 The crime was of interest in itself, but that interest was as nothing to
21272 me compared to the inconceivable sequel, which afforded me the greatest
21273 shock and surprise of any event in my adventurous life.
21274 Even now, after this long interval, I find myself thrilling as I think
21275 of it, and feeling once more that sudden flood of joy, amazement, and increduli
21276 ty which utterly submerged my mind.
21277 Let me say to that public, which has shown some interest in those glimpses
21278 which I have occasionally given them of the thoughts and actions of a very
21279 remarkable man, that they are not to blame me if I have not shared my knowledge
21280 with them, for I should have considered it my first duty to do so, had
21281 I not been barred by a positive prohibition from his own lips, which was
21282 only withdrawn upon the third of last month.
21285 \begin_layout Standard
21289 \begin_layout Plain Layout
21301 \begin_layout Subsubsection
21305 \begin_layout Standard
21306 The same pattern is used when you want more than two columns:
21309 \begin_layout Standard
21313 \begin_layout Plain Layout
21317 begin{multicols}{3}
21325 \begin_layout Standard
21328 It can be imagined that my close intimacy with Sherlock Holmes had interested
21329 me deeply in crime, and that after his disappearance I never failed to
21330 read with care the various problems which came before the public.
21331 And I even attempted, more than once, for my own private satisfaction,
21332 to employ his methods in their solution, though with indifferent success.
21333 There was none, however, which appealed to me like this tragedy of Ronald
21335 As I read the evidence at the inquest, which led up to a verdict of willful
21336 murder against some person or persons unknown, I realized more clearly
21337 than I had ever done the loss which the community had sustained by the
21338 death of Sherlock Holmes.
21339 There were points about this strange business which would, I was sure,
21340 have specially appealed to him, and the efforts of the police would have
21341 been supplemented, or more probably anticipated, by the trained observation
21342 and the alert mind of the first criminal agent in Europe.
21343 All day, as I drove upon my round, I turned over the case in my mind and
21344 found no explanation which appeared to me to be adequate.
21345 At the risk of telling a twice-told tale, I will recapitulate the facts
21346 as they were known to the public at the conclusion of the inquest.
21349 \begin_layout Standard
21353 \begin_layout Plain Layout
21365 \begin_layout Standard
21366 You can have more than 3 columns if you want to, but that might not be very
21367 pleasant for the eye.
21370 \begin_layout Subsubsection
21371 Columns inside columns
21374 \begin_layout Standard
21375 You can even have columns inside columns:
21378 \begin_layout Standard
21382 \begin_layout Plain Layout
21386 begin{multicols}{2}
21394 \begin_layout Standard
21397 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21398 at that time governor of one of the Australian colonies.
21399 Adair's mother had returned from Australia to undergo the operation for
21400 cataract, and she, her son Ronald, and her daughter Hilda were living together
21404 \begin_layout Standard
21408 \begin_layout Plain Layout
21412 begin{multicols}{2}
21420 \begin_layout Standard
21423 The youth moved in the best society–had, so far as was known, no enemies
21424 and no particular vices.
21425 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
21426 had been broken off by mutual consent some months before, and there was
21427 no sign that it had left any very profound feeling behind it.
21428 For the rest {sic} the man's life moved in a narrow and conventional circle,
21429 for his habits were quiet and his nature unemotional.
21430 Yet it was upon this easy-going young aristocrat that death came, in most
21431 strange and unexpected form, between the hours of ten and eleven-twenty
21432 on the night of March 30, 1894.
21435 \begin_layout Standard
21439 \begin_layout Plain Layout
21451 \begin_layout Standard
21454 Ronald Adair was fond of cards–playing continually, but never for such stakes
21456 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
21457 It was shown that, after dinner on the day of his death, he had played
21458 a rubber of whist at the latter club.
21459 He had also played there in the afternoon.
21464 The evidence of those who had played with him– Mr.
21465 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
21466 and that there was a fairly equal fall of the cards.
21467 Adair might have lost five pounds, but not more.
21468 His fortune was a considerable one, and such a loss could not in any way
21470 He had played nearly every day at one club or other, but he was a cautious
21471 player, and usually rose a winner.
21472 It came out in evidence that, in partnership with Colonel Moran, he had
21473 actually won as much as four hundred and twenty pounds in a sitting, some
21474 weeks before, from Godfrey Milner and Lord Balmoral.
21475 So much for his recent history as it came out at the inquest.
21478 \begin_layout Standard
21482 \begin_layout Plain Layout
21494 \begin_layout Standard
21495 Please do read the file
21497 examples/multicol.lyx
21499 for more advanced examples including column and header spacing, vertical
21500 separator lines, and more.
21503 \begin_layout Section
21508 Paragraph Environment
21509 \begin_inset OptArg
21512 \begin_layout Plain Layout
21513 Numbering in Enumerate
21521 \begin_layout Standard
21527 \begin_layout Standard
21528 \begin_inset VSpace bigskip
21534 \begin_layout Standard
21536 The default numbering for the
21540 paragraph environment begins with Arabic numbers and ends with uppercase
21542 Suppose, however, you wanted a different type of numbering scheme.
21543 Here's a quickie example of how to change the numbering scheme:
21546 \begin_layout LyX-Code
21556 \begin_layout LyX-Code
21566 \begin_layout LyX-Code
21576 \begin_layout LyX-Code
21586 \begin_layout Standard
21587 \SpecialChar \ldots{}
21588 which changes the numbering scheme to uppercase Roman numerals, uppercase
21589 letters, Arabic numbers, and lowercase letter.
21592 \begin_layout Standard
21593 Additionally, the previous example also adds a little bit extra to the numbering
21595 For example, the first level label actually looks like:
21596 \begin_inset Quotes eld
21600 \begin_inset Quotes erd
21604 For ease of reading, we'll describe what the numbering schemes look like
21605 using a notation something like this: <
21606 \begin_inset Quotes eld
21610 \begin_inset Quotes erd
21614 \begin_inset space ~
21618 \begin_inset Quotes erd
21622 \begin_inset Quotes erd
21626 \begin_inset space ~
21630 \begin_inset Quotes erd
21634 \begin_inset Quotes erd
21638 \begin_inset space ~
21642 \begin_inset Quotes eld
21646 \begin_inset Quotes erd
21653 \begin_layout Standard
21654 As you can see in the example, there is a label command for each nesting
21661 \SpecialChar \ldots{}
21668 , as well as a counter,
21672 \SpecialChar \ldots{}
21678 There are also five
21679 \begin_inset Quotes eld
21683 \begin_inset Quotes erd
21716 , each of which take one counter as an argument.
21717 You can add characters before or after these, but there's no need to add
21721 \begin_layout Standard
21722 You can get really fancy with these.
21726 \begin_layout LyX-Code
21740 \begin_layout LyX-Code
21752 \begin_layout LyX-Code
21762 \begin_layout LyX-Code
21772 \begin_layout Standard
21773 produces the somewhat out of hand numbering scheme: <
21774 \begin_inset Quotes eld
21778 \begin_inset Quotes erd
21782 \begin_inset space ~
21786 \begin_inset Quotes erd
21790 \begin_inset Quotes erd
21794 \begin_inset space ~
21798 \begin_inset Quotes erd
21802 \begin_inset Quotes erd
21806 \begin_inset space ~
21810 \begin_inset Quotes eld
21814 \begin_inset Quotes erd
21821 \begin_layout Standard
21825 \begin_layout Section
21829 \begin_layout Standard
21835 \begin_layout Standard
21836 \begin_inset VSpace bigskip
21842 \begin_layout Standard
21847 \begin_layout Plain Layout
21853 tmpfont}{cmr17 scaled 2500}{
21865 \begin_layout Standard
21870 \begin_layout Plain Layout
21881 hose of you who like the style of old books probably also like
21882 \begin_inset Quotes eld
21886 \begin_inset Quotes erd
21889 —those large capital letters which begin each new chapter or section.
21890 Implementing them with plain LyX/LaTeX is straightforward (assuming you
21891 know some plain TeX!) but does require a lot of work and many iterations,
21892 as you can see by all the ugly TeX-mode stuff at the beginning of this
21896 \begin_layout Standard
21900 \begin_layout Plain Layout
21906 bigdrop{-1em}{3}{ptmri}{T}+
21911 here is a much easier way of doing this, of course.
21920 ) package from CTAN allows a simple way to add such letters to your documents.
21921 Since this package is not a standard part of teTeX, I can't demonstrate
21922 it within this document, but if you copy this paragraph to a new document,
21924 \begin_inset Quotes eld
21934 \begin_inset Quotes erd
21937 and the pluses from the TeX code at the beginning of the paragraph, and
21942 usepackage{dropcaps}
21944 to your LaTeX preamble, you will get a nice Times Roman Italic
21945 \begin_inset Quotes eld
21949 \begin_inset Quotes erd
21952 , whose height is three lines of text and which protrudes 1 em into the
21954 (Make certain you have copied
21955 \begin_inset Quotes eld
21963 \begin_inset Quotes erd
21966 into a directory where TeX can see it.) The first argument is the amount
21967 of indentation; in this case the negative sign moves it into the margin.
21968 The second argument is the height of the letter in number of lines of text.
21969 The third argument is the font name: virtually anything which has a tfm
21970 file should work (wade through the
21972 .../texmf/fonts/tfm
21974 directory for possibilities).
21975 My personal favorite is
21976 \begin_inset Quotes eld
21984 \begin_inset Quotes erd
21987 , a fancy German font specifically designed for dropped capitals.
21988 The fourth argument is the letter (or letters) to be dropped.
21993 package also offers the
21999 command, as well as a slightly simplified
22008 \begin_layout Section
22009 Non-standard Paragraph Shapes
22012 \begin_layout Standard
22018 \begin_layout Standard
22019 \begin_inset VSpace bigskip
22025 \begin_layout Standard
22029 \begin_layout Plain Layout
22041 \begin_layout Standard
22045 \begin_layout Plain Layout
22054 \begin_layout Plain Layout
22068 \begin_layout Standard
22073 \begin_layout Plain Layout
22084 \begin_layout Plain Layout
22093 \begin_layout Plain Layout
22102 \begin_layout Plain Layout
22111 \begin_layout Plain Layout
22120 \begin_layout Plain Layout
22129 \begin_layout Plain Layout
22138 \begin_layout Plain Layout
22147 \begin_layout Plain Layout
22156 \begin_layout Plain Layout
22165 \begin_layout Plain Layout
22174 \begin_layout Plain Layout
22183 \begin_layout Plain Layout
22192 \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
22252 There are times when the tyranny of rectangular paragraphs must be overthrown.
22253 In such situations, a call to the delightful plain TeX command
22260 As you can see, completely arbitrary shapes can be laid out with a suitable
22261 set of linelength definitions.
22262 While this parshape may look a bit silly and useless, one could conceive
22263 of situations such as finely tuned dropped capitals, word wrapping around
22264 non-rectangular graphics, etc.
22265 which will benefit from such handcrafting.
22268 \begin_layout Standard
22269 \begin_inset VSpace bigskip
22275 \begin_layout Standard
22280 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
22287 is the number of lines of text which define the paragraph.
22288 If there turn out to be fewer lines, the shape is truncated; if there are
22289 more, the excess lines have the same dimensions as the last line of the
22299 entries specify the indentation of the line from the left margin, and the
22300 length of the line as measured from that point.
22301 The shape applies only to the current paragraph; everything is reset to
22302 normal for the next paragraph.
22305 \begin_layout Standard
22309 \begin_layout Plain Layout
22321 \begin_layout Section
22325 \begin_layout Standard
22326 As you can see, the examples in this section range from the useful to the
22328 While I don't expect that anyone will ever need the paragraph shape demonstrate
22329 d in the last section, the important point is that you can do almost anything
22330 you want in LyX if you are willing to figure out how to do it in TeX and
22332 TeX is a fantastically powerful typesetting system and all that power is
22333 available to you since LyX uses it as its backend.