1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \use_default_options false
56 InsetLayout CharStyle:MenuItem
65 \newcommand*{\menuitem}[1]{{\sffamily #1}}
74 \font_typewriter default
75 \font_default_family default
83 \default_output_format default
84 \bibtex_command default
85 \index_command default
89 \pdf_title "LyX's Additional Features manual"
90 \pdf_author "LyX Team"
91 \pdf_subject "LyX's additional features documentation"
92 \pdf_keywords "LyX, Documentation, Additional"
94 \pdf_bookmarksnumbered true
95 \pdf_bookmarksopen false
96 \pdf_bookmarksopenlevel 1
101 \pdf_pdfusetitle false
102 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
111 \paperorientation portrait
119 \paragraph_separation indent
120 \paragraph_indentation default
121 \quotes_language english
124 \paperpagestyle headings
125 \tracking_changes false
126 \output_changes false
127 \html_use_mathml true
134 Additional LyX Features
142 \begin_layout Plain Layout
144 Principal maintainer of this file is
149 If you have comments or error corrections, please send them to the LyX
150 Documentation mailing list,
151 \begin_inset Flex CharStyle:Code
154 \begin_layout Plain Layout
156 <lyx-docs@lists.lyx.org>
169 \begin_layout Standard
170 \begin_inset CommandInset toc
171 LatexCommand tableofcontents
178 \begin_layout Chapter
182 \begin_layout Standard
183 This manual is essentially Part II of the
185 User's Guide\SpecialChar \@.
188 The reason for separating this document out is simple: the
192 is already quite lengthy, and it contains information on all of the basic
193 features one needs to know in order to prepare most documents.
194 However, the LyX Team has worked to LyX extensible through various configuratio
195 n files and external packages.
196 That means that if you want to support the Fizzwizzle LaTeX package, you
197 can create a layout file (or module) for it without having to alter LyX
199 We've already had contributions of several new features this way.
200 This is the place where all of those get documented.
203 \begin_layout Standard
204 This manual also documents some special features, like fax support, version
205 control, and SGML support, which require additional software to work properly.
206 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
207 spruce up your documents by directly using the powerful features of LaTeX.
212 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
215 \begin_layout Standard
216 If you haven't read the
220 yet, you are definitely in the wrong manual.
225 is the first place to go, since it describes the notation and format of
227 You should also be thoroughly familiar with the
231 and all of the basic features of LyX before attempting to read this one.
234 \begin_layout Standard
235 Since all the topics in this manual depend heavily on LyX's interaction
236 with LaTeX, this first chapter covers the inner workings of LyX and how
237 to direct LyX to generate exactly the LaTeX code you want.
238 It is obviously for more seasoned LyX users.
241 \begin_layout Chapter
245 \begin_layout Section
249 \begin_layout Standard
250 This chapter is for both TeX-nicians and the LaTeX-curious.
251 In it, we'll explain how LyX and LaTeX work together to produce printable
253 This is the only place in any of the manuals where we assume you know something
257 \begin_layout Standard
258 At one time, LyX was called a
259 \begin_inset Quotes eld
262 WYSIWYM frontend to LaTeX,
263 \begin_inset Quotes erd
266 but that's no longer true.
267 There are frontends to LaTeX out there.
271 \begin_layout Plain Layout
272 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
273 There are also the LaTeX modes for vi and emacs, of course.
278 These are basically text editors with the ability to run LaTeX and mark
279 any errors in the file you're editing.
288 run LaTeX, and it also indicates errors in the file, it also does much,
290 For one thing, you don't need to know LaTeX to use LyX effectively.
291 And LyX has added its own extensions to LaTeX.
292 Try the following sometime: select
293 \begin_inset Flex CharStyle:MenuItem
296 \begin_layout Plain Layout
297 Export\SpecialChar \menuseparator
304 \begin_inset Flex CharStyle:MenuItem
307 \begin_layout Plain Layout
314 \begin_inset Flex CharStyle:MenuItem
317 \begin_layout Plain Layout
318 View\SpecialChar \menuseparator
324 ), then look at the preamble of the resulting
325 \begin_inset Flex CharStyle:Code
328 \begin_layout Plain Layout
335 You'll notice a variety of new macros defined specifically by LyX.
336 These macros are defined automatically, according to the features you use
340 \begin_layout Standard
341 There are several commands that automatically invoke LaTeX.
345 \begin_layout Itemize
346 \begin_inset Flex CharStyle:MenuItem
349 \begin_layout Plain Layout
350 View\SpecialChar \menuseparator
359 \begin_layout Itemize
360 \begin_inset Flex CharStyle:MenuItem
363 \begin_layout Plain Layout
364 View\SpecialChar \menuseparator
365 Update\SpecialChar \menuseparator
374 \begin_layout Itemize
375 \begin_inset Flex CharStyle:MenuItem
378 \begin_layout Plain Layout
379 File\SpecialChar \menuseparator
388 \begin_layout Itemize
389 \begin_inset Flex CharStyle:MenuItem
392 \begin_layout Plain Layout
393 File\SpecialChar \menuseparator
402 \begin_layout Standard
403 They will only invoke LaTeX if the file has changed since the last time
408 \begin_layout Standard
409 When LyX runs LaTeX on the file you're editing, it performs these steps:
412 \begin_layout Enumerate
413 Convert the document to LaTeX and save to a file with the extension
414 \begin_inset Flex CharStyle:Code
417 \begin_layout Plain Layout
424 \begin_inset Flex CharStyle:Code
427 \begin_layout Plain Layout
436 \begin_layout Enumerate
438 \begin_inset Flex CharStyle:Code
441 \begin_layout Plain Layout
447 file (maybe several times), and run any other commands (such as
448 \begin_inset Flex CharStyle:Code
451 \begin_layout Plain Layout
458 \begin_inset Flex CharStyle:Code
461 \begin_layout Plain Layout
467 ) needed to compile the LaTeX file.
470 \begin_layout Enumerate
471 If there are any errors, show the error log.
474 \begin_layout Standard
475 If you've run LaTeX using
476 \begin_inset Flex CharStyle:MenuItem
479 \begin_layout Plain Layout
482 \SpecialChar \menuseparator
490 , LyX then runs a DVI viewer to display the DVI-file.
492 \begin_inset Flex CharStyle:MenuItem
495 \begin_layout Plain Layout
498 \SpecialChar \menuseparator
506 , LyX performs further steps:
509 \begin_layout Itemize
511 \begin_inset Flex CharStyle:Code
514 \begin_layout Plain Layout
520 to convert the DVI file to PostScript.
523 \begin_layout Itemize
524 Run a PostScript viewer, such as
525 \begin_inset Flex CharStyle:Code
528 \begin_layout Plain Layout
534 , to display the PostScript file.
537 \begin_layout Standard
538 LyX does similar things when viewing, or exporting, other formats.
541 \begin_layout Section
542 Translating LaTeX files into LyX
545 \begin_layout Standard
546 You can import a LaTeX file into LyX by using the
547 \begin_inset Flex CharStyle:MenuItem
550 \begin_layout Plain Layout
551 File\SpecialChar \menuseparator
552 Import\SpecialChar \menuseparator
559 This will call a program named
560 \begin_inset Flex CharStyle:Code
563 \begin_layout Plain Layout
569 which will create a file
570 \begin_inset Flex CharStyle:Code
573 \begin_layout Plain Layout
580 \begin_inset Flex CharStyle:Code
583 \begin_layout Plain Layout
590 LyX will then open that file.
594 \begin_layout Plain Layout
595 \begin_inset Flex CharStyle:Code
598 \begin_layout Plain Layout
604 can also be run from the command line, of course.
612 \begin_layout Standard
613 \begin_inset Flex CharStyle:Code
616 \begin_layout Plain Layout
622 will translate most legal LaTeX, but not everything.
623 It will put things it doesn't understand into TeX code, so after translating
625 \begin_inset Flex CharStyle:Code
628 \begin_layout Plain Layout
634 , you can look for TeX code and hand-edit it until it looks right.
637 \begin_layout Standard
638 If you don't know what TeX code is, read the next section.
641 \begin_layout Section
642 \begin_inset CommandInset label
644 name "sec:Inserting-TeX-Code"
648 Inserting TeX Code into LyX Documents
651 \begin_layout Standard
652 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
653 You can always insert TeX code into any LyX document.
654 LyX cannot, and will never be able to, display every possible LaTeX construct.
655 If ever you need to insert LaTeX commands into your LyX document, you can
657 \begin_inset Flex CharStyle:Code
660 \begin_layout Plain Layout
666 box, which you can insert into your document with
667 \begin_inset Flex CharStyle:MenuItem
670 \begin_layout Plain Layout
671 Insert\SpecialChar \menuseparator
680 \begin_layout Standard
681 Here's an example of inserting LaTeX commands in a LyX document.
682 The code looks like this:
685 \begin_layout LyX-Code
689 \begin_inset Newline newline
695 \begin_inset Newline newline
698 This is an example for a minipage environment.
700 \begin_inset Newline newline
703 can put nearly everything in it, even (non-floating)
704 \begin_inset Newline newline
709 \begin_inset Newline newline
715 \begin_inset Newline newline
719 \begin_inset Newline newline
725 \begin_inset Newline newline
731 \begin_inset Newline newline
737 \begin_inset Newline newline
742 \begin_inset Newline newline
748 \begin_inset Newline newline
754 \begin_inset Newline newline
760 \begin_inset Newline newline
768 \begin_layout LyX-Code
772 \begin_layout Standard
774 \begin_inset Flex CharStyle:Code
777 \begin_layout Plain Layout
783 box containing this text is directly after this paragraph.
784 Those of you reading the manual in LyX will only see the TeX code inset.
785 Those reading a printed version of the manuals will see the actual results:
788 \begin_layout Standard
792 \begin_layout Plain Layout
799 \begin_layout Plain Layout
806 \begin_layout Plain Layout
808 This is an example for a minipage environment.
809 You can put nearly everything in it, even (non-floating) figures and tables.
813 \begin_layout Plain Layout
820 \begin_layout Plain Layout
825 \begin_layout Plain Layout
832 \begin_layout Plain Layout
839 \begin_layout Plain Layout
846 \begin_layout Plain Layout
852 \begin_layout Plain Layout
859 \begin_layout Plain Layout
866 \begin_layout Plain Layout
873 \begin_layout Plain Layout
885 \begin_layout Standard
886 In addition to using TeX code, you can also create a separate file containing
887 some complex LaTeX structure and then use
888 \begin_inset Flex CharStyle:MenuItem
891 \begin_layout Plain Layout
892 Insert\SpecialChar \menuseparator
902 to include your file (you should select the type
903 \begin_inset Flex CharStyle:Code
906 \begin_layout Plain Layout
913 We recommend that you only do this if you have a
914 \begin_inset Flex CharStyle:Code
917 \begin_layout Plain Layout
928 Otherwise, you'll have a big job tracking down LaTeX errors.
931 \begin_layout Standard
932 There are a few last points to emphasize:
935 \begin_layout Itemize
940 check if your LaTeX code is correct.
943 \begin_layout Itemize
944 Beware reinventing the wheel.
947 \begin_layout Standard
948 On that last point, LyX does have quite a few features tucked into it, and
950 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
951 feature before you decide you have to do it by hand.
952 Moreover, there are numerous LaTeX packages out there to do all sorts of
953 things, from labels to envelopes to fancy multipage tables.
955 \begin_inset CommandInset href
958 target "http://www.ctan.org/"
962 for details, and see chapter
963 \begin_inset CommandInset ref
965 reference "cha:secrets"
972 \begin_layout Standard
973 If you do need to do some wild and fancy things within your document, be
974 sure to check out a good LaTeX book for assistance.
975 There are a number of them listed in the bibliography of the
982 \begin_layout Section
983 LyX and the LaTeX Preamble
986 \begin_layout Subsection
987 About the LaTeX Preamble
990 \begin_layout Standard
991 If you already know LaTeX, there is no need to explain here what the preamble
993 If you don't, the following will give you some ideas—we recommend again
994 that you consult a LaTeX book for further information.
995 In any case, you should read the points below, because they explain what
996 you can do and what you don't need to do in the LaTeX preamble of a LyX
1000 \begin_layout Standard
1001 The LaTeX preamble comes at the very beginning of a document,
1009 \begin_layout Itemize
1010 Declare the document class.
1012 \begin_inset Newline newline
1015 LyX already does this for you.
1016 If you're a seasoned LaTeX-nician, and you have a custom document class
1017 you want to use, check out the
1019 Customization Manual
1021 for information on how to make LyX interface to it.
1024 \begin_layout Itemize
1025 Declare the usage of packages.
1027 \begin_inset Newline newline
1030 LaTeX packages provide special commands, which are only available within
1031 a document when the package has been declared in the preamble.
1032 For example, the package
1033 \begin_inset Flex CharStyle:Code
1036 \begin_layout Plain Layout
1042 forces all paragraphs to be indented.
1043 There are other packages for labels, envelopes, margins, etc.
1047 \begin_layout Itemize
1048 Set counters, variables, lengths and widths.
1050 \begin_inset Newline newline
1053 There are several LaTeX counters and variables which
1057 be set globally from within the preamble in order to have the desired effect.
1058 (There are variables which you can set and reset inside the document, too.)
1059 Margins are a good example of something which must be set in the preamble.
1060 Another example is the label format for lists.
1061 You can actually set these just about anywhere, but it's best to do it
1062 just once, inside the preamble.
1065 \begin_layout Itemize
1066 Declare user defined commands (with
1067 \begin_inset Flex CharStyle:Code
1070 \begin_layout Plain Layout
1079 \begin_inset Flex CharStyle:Code
1082 \begin_layout Plain Layout
1091 \begin_inset Newline newline
1094 These are abbreviations for LaTeX commands which appear very often inside
1096 Although the preamble is a good place to declare such commands, they
1100 be declared anywhere (before they are used for the first time, of course).
1101 This can be useful if there is a lot of raw LaTeX code in your document,
1102 which normally should not be the case.
1105 \begin_layout Standard
1106 LyX adds its own set of definitions to the preamble of the
1107 \begin_inset Flex CharStyle:Code
1110 \begin_layout Plain Layout
1117 This makes LaTeX files generated by LyX portable.
1120 \begin_layout Subsection
1121 Changing the Preamble
1124 \begin_layout Standard
1125 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1126 can't change them without patching LyX itself.
1127 You can, however, add your own stuff to the preamble by selecting
1128 \begin_inset Flex CharStyle:MenuItem
1131 \begin_layout Plain Layout
1133 \begin_inset space ~
1142 \begin_inset Flex CharStyle:MenuItem
1145 \begin_layout Plain Layout
1146 Document\SpecialChar \menuseparator
1153 LyX adds anything in the
1154 \begin_inset Flex CharStyle:MenuItem
1157 \begin_layout Plain Layout
1163 dialog to its own built-in preamble.
1164 Before adding your own declarations in the preamble, you should make sure
1165 that LyX doesn't already support what you want to do.
1166 (Remember what we said about reinventing the wheel?) Also,
1168 make sure your preamble code is correct
1171 LyX doesn't check it for you.
1172 If there is an error, you're likely to get an error like
1173 \begin_inset Quotes eld
1177 \begin_inset Flex CharStyle:Code
1180 \begin_layout Plain Layout
1189 \begin_inset Quotes erd
1193 If you see this error, check your preamble.
1196 \begin_layout Subsection
1200 \begin_layout Standard
1201 Here are some examples of what you can add to a preamble, and what they
1205 \begin_layout Subsubsection
1209 \begin_layout Standard
1210 There are two variables under LaTeX that control page position:
1211 \begin_inset Flex CharStyle:Code
1214 \begin_layout Plain Layout
1223 \begin_inset Flex CharStyle:Code
1226 \begin_layout Plain Layout
1235 Their names should be self-explanatory.
1236 These variables are useful if you think for a moment about computer labels.
1237 Sometimes, the size of a print medium and the area of the medium that you
1238 can actually print on aren't the same.
1240 \begin_inset Flex CharStyle:Code
1243 \begin_layout Plain Layout
1252 \begin_inset Flex CharStyle:Code
1255 \begin_layout Plain Layout
1266 \begin_layout Standard
1267 The default values for
1268 \begin_inset Flex CharStyle:Code
1271 \begin_layout Plain Layout
1280 \begin_inset Flex CharStyle:Code
1283 \begin_layout Plain Layout
1292 \begin_inset space \thinspace{}
1296 \begin_inset space \thinspace{}
1300 \begin_inset space \space{}
1303 the page isn't shifted.
1304 Unfortunately, some DVI drivers always seem to shift the page.
1305 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1306 If you're using LyX on a system that you don't personally maintain, and
1307 your sysadmin is a doofus,
1308 \begin_inset Flex CharStyle:Code
1311 \begin_layout Plain Layout
1320 \begin_inset Flex CharStyle:Code
1323 \begin_layout Plain Layout
1332 Suppose you're left and top margins are always 0.5
1333 \begin_inset space \thinspace{}
1337 You can add this to the preamble:
1340 \begin_layout LyX-Code
1348 \begin_layout LyX-Code
1356 \begin_layout Standard
1357 and your margins should now be correct.
1360 \begin_layout Subsubsection
1364 \begin_layout Standard
1365 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1366 There's a rather nice package, available at your nearest CTAN archive,
1367 for printing sheets of labels:
1368 \begin_inset Flex CharStyle:Code
1371 \begin_layout Plain Layout
1378 Now, your system may not have this package installed by default.
1379 We leave that up to you to check.
1380 You'll also want to read the documentation for it; we're not going to do
1382 Since this is an example, however, we'll give you an example of how you
1386 \begin_layout Standard
1387 First, make sure you're using the
1388 \begin_inset Flex CharStyle:Code
1391 \begin_layout Plain Layout
1398 Next, you need to put the following in your preamble:
1401 \begin_layout LyX-Code
1407 \begin_layout LyX-Code
1413 \begin_layout LyX-Code
1419 \begin_layout LyX-Code
1425 \begin_layout LyX-Code
1431 \begin_layout LyX-Code
1437 \begin_layout LyX-Code
1443 \begin_layout Standard
1444 This sets things up for Avery label sheets, stock #5360.
1445 You're now ready to print labels, but you'll need to insert LaTeX code,
1446 placing the commands
1447 \begin_inset Flex CharStyle:Code
1450 \begin_layout Plain Layout
1459 \begin_inset Flex CharStyle:Code
1462 \begin_layout Plain Layout
1470 around each label text.
1471 This and other special features of
1472 \begin_inset Flex CharStyle:Code
1475 \begin_layout Plain Layout
1481 are explained in its documentation.
1484 \begin_layout Standard
1485 Someday, someone may write a LyX layout file to support this package directly.
1486 Maybe that someone is you.
1489 \begin_layout Subsubsection
1490 Example #3: Paragraph Indentation
1493 \begin_layout Standard
1494 Americans are trained to indent the first line of
1499 As with all of their other weird quirks, most Americans will whine and
1500 moan until they can have their way and indent the first line of all paragraphs.
1509 \begin_layout Standard
1510 Of course, this behavior isn't standard typography.
1511 In books, you typically only indent the first line of a paragraph
1515 it follows another one.
1516 The idea behind indenting the first line of a paragraph is to distinguish
1517 neighboring paragraphs from one another.
1518 If there is no previous paragraph—for example, if it follows a figure or
1519 is the first paragraph in a section—then there is no need for indentation.
1523 \begin_layout Standard
1524 If you're a typical American (we're still joking!), though, you don't care
1525 about such esoteric things; you want your indentation! Add this to the
1529 \begin_layout LyX-Code
1532 usepackage{indentfirst}
1535 \begin_layout Standard
1536 If your TeX distribution isn't braindead, you'll have this package, and
1537 all of your paragraphs will get the indentation the Founding Fathers intended
1541 \begin_layout Subsubsection
1542 Example #4: This Document
1545 \begin_layout Standard
1546 You can also check out the preamble of this document to get an idea of some
1547 of the advanced things you can do.
1548 Also, there are more examples and an assortment of LaTeX
1549 \begin_inset Quotes eld
1553 \begin_inset Quotes erd
1557 \begin_inset space ~
1561 \begin_inset CommandInset ref
1563 reference "cha:secrets"
1571 \begin_layout Section
1572 LyX and LaTeX Errors
1575 \begin_layout Standard
1576 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1578 It then uses the logfile from the LaTeX run to do a post-mortem.
1579 After analyzing the logfile,LyX displays a dialog listing the errors.
1580 Clicking on any one of them will take you to the position in your LyX file
1581 where the error occurred.
1585 \begin_layout Plain Layout
1587 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1589 There are also cases where LaTeX reports the error on one line, but the
1590 actual error is earlier.
1591 This is not unlike forgetting a closing brace in a program: You'll get
1592 an error, but only later.
1600 \begin_layout Standard
1601 Some folks also like to look at the log file directly: It is available from
1603 \begin_inset Flex CharStyle:MenuItem
1606 \begin_layout Plain Layout
1609 \SpecialChar \menuseparator
1613 \begin_inset space ~
1622 There are some fairly common error messages and warnings.
1623 We'll cover those here.
1624 You should look at a good LaTeX book for a complete listing.
1627 \begin_layout Itemize
1628 \begin_inset Flex CharStyle:Code
1631 \begin_layout Plain Layout
1638 \begin_inset Newline newline
1641 Anything beginning with these words is a warning message for the purpose
1643 \begin_inset Quotes eld
1647 \begin_inset Quotes erd
1650 the LaTeX code itself.
1651 You'll get messages like this if you added or changed cross-references
1652 or bibliography entries, in which case, LaTeX is trying to tell you that
1653 you need to make another run.
1654 You can by-and-large ignore these.
1657 \begin_layout Itemize
1658 \begin_inset Flex CharStyle:Code
1661 \begin_layout Plain Layout
1668 \begin_inset Newline newline
1671 Another warning message, this time about fonts which LaTeX couldn't find.
1672 The rest of the message will often say something about a replacement font
1674 You can safely ignore these, too.
1677 \begin_layout Itemize
1678 \begin_inset Flex CharStyle:Code
1681 \begin_layout Plain Layout
1690 \begin_inset Newline newline
1698 They are warnings about lines that were too long and run past the right
1700 Almost always, this is unnoticeable in the final output.
1701 (It can be just a point or two.) Or, only one or two characters extend past
1703 LaTeX seems to generate at least one of these messages for just about any
1705 \begin_inset Newline newline
1708 You can ignore these messages.
1709 Your eyes will tell you if there's a problem with something that's too
1710 wide; just look at the output.
1714 \begin_layout Plain Layout
1715 You can also enable the `draft' option in
1716 \begin_inset Flex CharStyle:MenuItem
1719 \begin_layout Plain Layout
1722 \SpecialChar \menuseparator
1730 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1738 \begin_layout Itemize
1739 \begin_inset Flex CharStyle:Code
1742 \begin_layout Plain Layout
1751 \begin_inset Newline newline
1754 Not quite as common as its cousin.
1755 LaTeX seems to like to print lines that are a bit too wide as opposed to
1756 ones that are a bit too narrow.
1757 We have no idea why.
1760 \begin_layout Itemize
1761 \begin_inset Flex CharStyle:Code
1764 \begin_layout Plain Layout
1773 \begin_inset Flex CharStyle:Code
1776 \begin_layout Plain Layout
1785 \begin_inset Newline newline
1788 Warnings about troubles breaking the page.
1789 Once again, just look at the output.
1790 Your eyes will tell you where something has gone wrong.
1793 \begin_layout Itemize
1794 \begin_inset Flex CharStyle:Code
1797 \begin_layout Plain Layout
1799 \begin_inset Quotes els
1803 \begin_inset Quotes ers
1812 \begin_inset Newline newline
1816 \begin_inset Quotes eld
1820 \begin_inset Quotes erd
1823 isn't installed on this system.
1824 This usually appears because some package your document needs isn't installed.
1825 If you didn't touch the preamble or didn't use the
1826 \begin_inset Flex CharStyle:Code
1829 \begin_layout Plain Layout
1837 command, then one of the packages LyX tried to load is missing.
1839 \begin_inset Flex CharStyle:MenuItem
1842 \begin_layout Plain Layout
1843 Help\SpecialChar \menuseparator
1849 to get a list of packages that LyX knows about.
1850 This file is updated whenever you reconfigure LyX (using
1851 \begin_inset Flex CharStyle:MenuItem
1854 \begin_layout Plain Layout
1855 Tools\SpecialChar \menuseparator
1861 ) and tells you which packages have been detected and what they do.
1862 \begin_inset Newline newline
1866 \begin_inset Flex CharStyle:Code
1869 \begin_layout Plain Layout
1877 command and the package in question isn't installed, then you'll need to
1878 install it yourself.
1881 \begin_layout Itemize
1882 \begin_inset Flex CharStyle:Code
1885 \begin_layout Plain Layout
1886 LaTeX Error: Unknown option
1892 \begin_inset Newline newline
1895 Error messages beginning with this are trying to tell you that you specified
1896 a bad or undefined option to a package.
1897 Check the package's documentation.
1900 \begin_layout Itemize
1901 \begin_inset Flex CharStyle:Code
1904 \begin_layout Plain Layout
1905 Undefined control sequence
1911 \begin_inset Newline newline
1914 If you've inserted LaTeX code into your document, but made a typo, you'll
1916 You may have forgotten to load a package.
1917 In any case, this error message usually means that you used an undefined
1922 \begin_layout Standard
1923 There are other error and warning messages.
1924 Some are self-explanatory.
1925 These are usually LaTeX messages.
1926 Others are downright cryptic.
1927 These are usually TeX error messages, and we really have
1931 what they mean or how to decipher them.
1935 \begin_layout Standard
1936 There's a general sequence you should follow if you get error messages:
1939 \begin_layout Enumerate
1940 Look at the LaTeX code you inserted for typos.
1943 \begin_layout Enumerate
1944 If there are no typos, check that you used the command(s) correctly.
1947 \begin_layout Enumerate
1948 If you get a bunch of error boxes piled up at the very top of the document—and
1949 especially if you see a
1950 \begin_inset Quotes eld
1954 \begin_inset Flex CharStyle:Code
1957 \begin_layout Plain Layout
1966 \begin_inset Quotes erd
1969 error—it means that there are errors in the preamble.
1970 Start debugging your preamble.
1973 \begin_layout Enumerate
1974 If you didn't add anything to the preamble and didn't add any LaTeX code
1975 to the document, the first suspect is your LaTeX distribution itself.
1976 Check for missing packages and install them.
1979 \begin_layout Enumerate
1980 Okay, so there are no missing packages.
1981 Did you use any of the fine-tuning options in LyX? Specifically, did you
1986 any of them, like trying to manually insert lots of
1987 \begin_inset Flex CharStyle:Code
1990 \begin_layout Plain Layout
1992 \begin_inset space ~
2001 \begin_inset Flex CharStyle:Code
2004 \begin_layout Plain Layout
2011 \begin_inset Flex CharStyle:Code
2014 \begin_layout Plain Layout
2020 ? Did you try to kludge something together with these instead of using the
2021 appropriate paragraph environment?
2024 \begin_layout Enumerate
2025 All right, you didn't use any of the fine-tuning options, you played by
2027 Did you try to pull a fancy maneuver? Did you do something funky inside
2028 a table or an equation, like inserting a graphic into a table cell?
2031 \begin_layout Enumerate
2032 Do you have long sections of text where LaTeX cannot find a place to break
2033 a line? By default, LaTeX is rather strict about how much extra inter-word
2034 spacing it will add in order to break a line.
2035 Preferably, you should rework the paragraph to avoid the problem.
2036 If this isn't an option, you can wrap your text in
2037 \begin_inset Flex CharStyle:Code
2040 \begin_layout Plain Layout
2048 to make LaTeX's line breaking more, well, sloppy.
2051 \begin_layout Enumerate
2052 Did you go overboard with the nesting? LyX (currently) doesn't check to
2053 make sure you're in the limits for nesting environments.
2054 If you nested a bunch of environments to the
2055 \begin_inset Formula $17^{\mathrm{th}}$
2058 level, that's the problem.
2059 (The limit in LaTeX is five.)
2062 \begin_layout Enumerate
2063 Okay, you didn't get any error messages, but your output looks awful.
2064 If you have a table or figure that's too wide or long for the page, you
2069 \begin_layout Enumerate
2070 rescale the figure so it fits.
2073 \begin_layout Enumerate
2074 trim down the table so it fits.
2078 \begin_layout Enumerate
2079 If something else is wrong with the output, and you didn't try to pull anything
2080 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2083 \begin_layout Standard
2084 If all this doesn't help—well, then
2088 you might have found a bug in LyX\SpecialChar \ldots{}
2092 \begin_layout Chapter
2096 \begin_layout Section
2097 Customizing Bibliographies with BibTeX
2100 \begin_layout Standard
2101 The basics how to use BibTeX are explained in section
2103 Bibliography databases (BibTeX)
2110 The following subsections explain special bibliography features supported
2114 \begin_layout Subsection
2115 Alternative Citation Styles
2118 \begin_layout Standard
2119 Standard BibTeX uses numbers (e.
2120 \begin_inset space \thinspace{}
2124 \begin_inset space \space{}
2128 \begin_inset Quotes eld
2132 \begin_inset Quotes erd
2135 ) to refer to a cited work.
2136 However, in many scientific disciplines, other citation styles are in use.
2137 The most common one is the author-year style (e.
2138 \begin_inset space \thinspace{}
2142 \begin_inset space \space{}
2146 \begin_inset Quotes eld
2150 \begin_inset Quotes erd
2154 LyX supports two packages that provide this style,
2155 \begin_inset Flex CharStyle:Code
2158 \begin_layout Plain Layout
2165 \begin_inset Flex CharStyle:Code
2168 \begin_layout Plain Layout
2175 Both packages have their pros and cons, which cannot be listed in detail.
2176 If you only want to have simple author-year (or author-numerical) style,
2177 or if you want to use one of the countless style files for
2178 \begin_inset Flex CharStyle:Code
2181 \begin_layout Plain Layout
2187 , than the established
2188 \begin_inset Flex CharStyle:Code
2191 \begin_layout Plain Layout
2197 package is probably your choice.
2198 If you need special features like short title references, ibidem etc., you
2200 \begin_inset Flex CharStyle:Code
2203 \begin_layout Plain Layout
2212 \begin_layout Standard
2213 The handling of both packages in LyX is basically the same.
2215 \begin_inset Flex CharStyle:MenuItem
2218 \begin_layout Plain Layout
2219 Document\SpecialChar \menuseparator
2226 \begin_inset Flex CharStyle:MenuItem
2229 \begin_layout Plain Layout
2236 \begin_inset Flex CharStyle:MenuItem
2239 \begin_layout Plain Layout
2246 \begin_inset Flex CharStyle:MenuItem
2249 \begin_layout Plain Layout
2256 With both packages, you will get some extra features in the citation dialog
2257 and you can select the style of the reference (
2258 \begin_inset Quotes eld
2262 \begin_inset Quotes erd
2266 \begin_inset Quotes eld
2270 \begin_inset Quotes erd
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2282 \begin_inset Quotes eld
2286 \begin_inset Quotes erd
2290 Note that both packages need specifically designed style files.
2291 They both ship their own, but there are lots of additional style files,
2292 and there is even an interactive style file builder
2296 \begin_layout Plain Layout
2298 \begin_inset Flex URL
2301 \begin_layout Plain Layout
2303 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2314 \begin_inset Flex CharStyle:Code
2317 \begin_layout Plain Layout
2326 \begin_layout Subsection
2327 Sectioned Bibliographies
2330 \begin_layout Standard
2331 Sometimes you might need to divide your bibliography into several sections.
2332 If you are for instance a historian, the possibility to separate sources
2333 and scientific works is most likely a
2334 \begin_inset Quotes eld
2338 \begin_inset Quotes erd
2342 Unfortunately, BibTeX itself does not allow you to do this.
2343 But with the help of some LaTeX packages, BibTeX can be extended to fit
2347 \begin_layout Standard
2348 LyX provides native support for one of these packages,
2356 \begin_layout Plain Layout
2358 \begin_inset Flex URL
2361 \begin_layout Plain Layout
2363 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2373 The advantage of this package (compared to other packages like
2377 ) is that you don't need to define new citation commands.
2378 Instead, you need to prepare different bibliographic databases which include
2379 the entries for the different sections of the bibliography.
2380 For example: If you want to divide your bibliography into the sections
2382 \begin_inset Quotes eld
2386 \begin_inset Quotes erd
2390 \begin_inset Quotes eld
2394 \begin_inset Quotes erd
2397 , you first need to create two bibliographic databases, e.
2398 \begin_inset space \thinspace{}
2402 \begin_inset space \space{}
2406 \begin_inset Flex CharStyle:Code
2409 \begin_layout Plain Layout
2416 \begin_inset Flex CharStyle:Code
2419 \begin_layout Plain Layout
2429 \begin_layout Standard
2431 \begin_inset Flex CharStyle:MenuItem
2434 \begin_layout Plain Layout
2435 Document\SpecialChar \menuseparator
2442 \begin_inset Flex CharStyle:MenuItem
2445 \begin_layout Plain Layout
2452 \begin_inset Flex CharStyle:MenuItem
2455 \begin_layout Plain Layout
2456 Sectioned bibliography
2462 Now you can insert multiple BibTeX bibliographies, one for each section
2463 of your bibliography.
2464 Returning to our example: Insert the BibTeX bibliography
2465 \begin_inset Flex CharStyle:Code
2468 \begin_layout Plain Layout
2474 and a second one for the database
2475 \begin_inset Flex CharStyle:Code
2478 \begin_layout Plain Layout
2485 You are free to use the same or different styles for each section.
2486 Additionally, you can chose if the bibliography section should contain
2488 \begin_inset Quotes eld
2491 all cited references
2492 \begin_inset Quotes erd
2495 of the specified database(s) (which is the default),
2496 \begin_inset Quotes eld
2499 all uncited references
2500 \begin_inset Quotes erd
2504 \begin_inset Quotes eld
2508 \begin_inset Quotes erd
2512 This might be useful if you would like to separate your bibliography into
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2538 The titles for the sections can be added as ordinary sections or subsections.
2540 \begin_inset Flex CharStyle:Code
2543 \begin_layout Plain Layout
2549 removes the bibliography title, you have manually re-add that, too (as
2550 a chapter* or section*, for instance).
2553 \begin_layout Subsection
2554 Multiple Bibliographies
2557 \begin_layout Standard
2558 Multiple bibliographies, e.
2559 \begin_inset space \thinspace{}
2563 \begin_inset space \space{}
2566 a bibliography for each section or chapter of the document, are not supported
2569 \begin_inset Flex CharStyle:Code
2572 \begin_layout Plain Layout
2578 package, which is used for the creation of sectioned bibliographies in
2579 LyX (see the previous section), provides an easy way to solve this task,
2580 if you are willing to use some
2581 \begin_inset Flex CharStyle:MenuItem
2584 \begin_layout Plain Layout
2591 \begin_inset space ~
2595 \begin_inset CommandInset ref
2597 reference "sec:Inserting-TeX-Code"
2605 \begin_layout Plain Layout
2606 An alternative approach is to use the
2607 \begin_inset Flex CharStyle:Code
2610 \begin_layout Plain Layout
2617 \begin_inset Flex CharStyle:Code
2620 \begin_layout Plain Layout
2626 package, respectively.
2634 \begin_layout Standard
2636 \begin_inset Flex CharStyle:MenuItem
2639 \begin_layout Plain Layout
2640 Document\SpecialChar \menuseparator
2647 \begin_inset Flex CharStyle:MenuItem
2650 \begin_layout Plain Layout
2657 \begin_inset Flex CharStyle:MenuItem
2660 \begin_layout Plain Layout
2661 Sectioned bibliography
2667 In the document, you have to enclose the sections, which shall contain
2668 their own bibliography (including the BibTeX bibliography itself), between
2670 \begin_inset Flex CharStyle:Code
2673 \begin_layout Plain Layout
2682 \begin_inset Flex CharStyle:Code
2685 \begin_layout Plain Layout
2693 (those commands have to be inserted as TeX code).
2694 The bibliography will contain all references which have been cited in the
2696 \begin_inset Flex CharStyle:Code
2699 \begin_layout Plain Layout
2710 If you are using this approach, then every citation reference has to be
2712 \begin_inset Flex CharStyle:Code
2715 \begin_layout Plain Layout
2723 \begin_inset Flex CharStyle:Code
2726 \begin_layout Plain Layout
2735 \begin_layout Section
2739 \begin_layout Subsection
2743 \begin_layout Standard
2744 When you are working on a large file with many sections, it is often convenient
2745 to break up the document into several files, or perhaps you have something
2746 where a table may change from time to time, but the preceding text does
2748 In these cases, you should seriously consider using multipart documents.
2749 For example, scientific papers often have five major sections: the introduction
2750 , observations, results, discussion, and conclusion.
2751 Each of these could be its own separate LyX file, with one
2752 \begin_inset Quotes eld
2756 \begin_inset Quotes erd
2759 file which contains the title, authors, abstract, references, etc., plus
2760 the five included files.
2761 It is important to note that each of these files is a full LyX file which
2762 can be formatted and printed on its own, as well as included in a master
2764 Each of these files must have the same document class, however—don't attempt
2765 to mix book classes with article classes.
2766 You may also include LaTeX files; however, these files must not have their
2768 \begin_inset space \thinspace{}
2772 \begin_inset space \space{}
2775 everything up to and including the
2776 \begin_inset Flex CharStyle:Code
2779 \begin_layout Plain Layout
2788 \begin_inset Flex CharStyle:Code
2791 \begin_layout Plain Layout
2799 line must be deleted) or else errors will be generated when you try to
2803 \begin_layout Standard
2804 LyX allows you to include files quite easily with
2805 \begin_inset Flex CharStyle:MenuItem
2808 \begin_layout Plain Layout
2809 Insert\SpecialChar \menuseparator
2811 \begin_inset space ~
2820 When you click on this selection a small box is inserted into the file
2821 at the current cursor location.
2822 Clicking on the box raises a dialog which allows you to select the file
2823 to be included, and the method of its inclusion.
2827 \begin_layout Standard
2828 The file selection box should by now be obvious.
2829 The three inclusion methods are
2830 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2846 \begin_inset Quotes eld
2850 \begin_inset Quotes erd
2854 The difference between
2855 \begin_inset Quotes eld
2859 \begin_inset Quotes erd
2863 \begin_inset Quotes eld
2867 \begin_inset Quotes erd
2870 is really only meaningful to LaTeXperts, but the practical difference is
2871 that files which are
2872 \begin_inset Quotes eld
2876 \begin_inset Quotes erd
2879 are typeset beginning on a new page, while files which are
2880 \begin_inset Quotes eld
2884 \begin_inset Quotes erd
2887 are typeset starting on the current page.
2890 \begin_layout Standard
2891 Generally, the master file is converted into a full LaTeX file before typesettin
2892 g, while the included files are converted to LaTeX files which do not have
2893 all the preamble information.
2896 \begin_layout Standard
2898 \begin_inset Quotes eld
2902 \begin_inset Quotes erd
2905 included file allows you to include a file typeset exactly as it appears
2907 \begin_inset space \thinspace{}
2911 \begin_inset space \space{}
2915 \begin_inset Flex CharStyle:Code
2918 \begin_layout Plain Layout
2924 mode, with the characters set in a fixed-width typewriter font.
2925 Normally, spaces in this file are invisible, though two consecutive spaces
2926 are conserved, unlike LyX's normal treatment of spaces.
2927 However, setting the
2928 \begin_inset Flex CharStyle:MenuItem
2931 \begin_layout Plain Layout
2933 \begin_inset space ~
2937 \begin_inset space ~
2941 \begin_inset space ~
2949 checkbox typesets a mark to unambiguously define the presence of a space.
2953 \begin_layout Subsection
2954 Cross-References Between Files
2957 \begin_layout Standard
2958 \begin_inset Box Shadowbox
2967 height_special "totalheight"
2970 \begin_layout Plain Layout
2971 This section is somewhat out of date.
2972 Need to describe default master documents and how children are opened when
2982 \begin_layout Standard
2983 It is possible to set up cross-references between the different files.
2984 First, open all the files in question: let's call them A and B in a two
2985 file example, where B is included in A.
2986 Let's say you insert a label in A, then want to reference it in B.
2987 Open the cross-reference dialog in whilst in document B, and you can select
2989 \begin_inset Quotes eld
2993 \begin_inset Quotes erd
2999 \begin_layout Subsection
3000 Bibliography Lists in all Subdocuments
3003 \begin_layout Standard
3004 \begin_inset Box Frameless
3013 height_special "totalheight"
3016 \begin_layout Plain Layout
3017 This section also needs updating.
3018 There is now material about this on the wiki, and it could be copied here.
3026 \begin_layout Standard
3027 Copy the bibliography list with all entries to all subdocuments and transform
3029 This way LyX will find the
3030 \begin_inset Flex CharStyle:Code
3033 \begin_layout Plain Layout
3039 -files and you can easily insert references without making the bibliography
3043 \begin_layout Standard
3044 As the bibliography list is in a comment, LaTeX won't use use it and the
3045 references will look like this: [?], instead of like this: [1].
3046 One solution is to use the LaTeX-package
3047 \begin_inset Flex CharStyle:Code
3050 \begin_layout Plain Layout
3056 that will only include comments by processing the files separately.
3057 To do this, add in the LaTeX preamble of every subdocument the following:
3060 \begin_layout LyX-Code
3066 \begin_layout LyX-Code
3069 includecomment{comment}
3072 \begin_layout Standard
3074 \begin_inset Flex URL
3077 \begin_layout Plain Layout
3079 http://wiki.lyx.org/FAQ/Unsorted#toc31
3087 \begin_layout Section
3088 Fancy Headers and Footers
3091 \begin_layout Standard
3092 The default page layout is rather plain; for an
3093 \begin_inset Flex CharStyle:Code
3096 \begin_layout Plain Layout
3102 document class, all you get is a centered page number at the bottom of
3104 This document uses KOMA-script's book class, so it appears to be a bit
3106 But to really put on a show, you need to set the document page style to
3108 \begin_inset Quotes eld
3112 \begin_inset Quotes erd
3115 , as mentioned in the
3120 This section describes the LaTeX code you need to insert in your LaTeX
3121 preamble in order to get the desired effects.
3124 \begin_layout Standard
3125 For more information on fancy headers, see the
3126 \begin_inset Flex CharStyle:Code
3129 \begin_layout Plain Layout
3135 package documentation.
3136 This can be found in the file
3137 \begin_inset Flex CharStyle:Code
3140 \begin_layout Plain Layout
3146 , which should have been installed with your LaTeX distribution, or
3147 \begin_inset CommandInset href
3150 target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
3157 \begin_layout Standard
3158 The page header is divided into three fields, not surprisingly labeled
3159 \begin_inset Quotes eld
3163 \begin_inset Quotes erd
3167 \begin_inset Quotes eld
3171 \begin_inset Quotes erd
3175 \begin_inset Quotes eld
3179 \begin_inset Quotes erd
3183 The footer is also divided into these three fields.
3184 The LaTeX commands to set these fields in the simplest manner are
3185 \begin_inset Flex CharStyle:Code
3188 \begin_layout Plain Layout
3197 \begin_inset Flex CharStyle:Code
3200 \begin_layout Plain Layout
3209 \begin_inset Flex CharStyle:Code
3212 \begin_layout Plain Layout
3221 \begin_inset Flex CharStyle:Code
3224 \begin_layout Plain Layout
3233 Suppose you wish to put your name in the upper left hand corner of each
3235 Simply insert the following command in the preamble:
3238 \begin_layout Standard
3247 \begin_layout Standard
3248 You will now see your name in the upper left.
3249 If a field has a default entry that you would like to get rid of (often
3250 the page number appears in the central footer, simply include a command
3251 with a blank argument, e.
3252 \begin_inset space \thinspace{}
3258 \begin_layout Standard
3266 \begin_layout Standard
3267 Let's get really fancy: lets put the section number with the word
3268 \begin_inset Quotes eld
3272 \begin_inset Quotes erd
3276 \begin_inset space \thinspace{}
3280 \begin_inset space \space{}
3283 Section 3) in the upper left, the page number (e.
3284 \begin_inset space \thinspace{}
3288 \begin_inset space \space{}
3291 Page 4) in the upper right, your name in the lower left, and the date in
3293 The following commands should now appear in the preamble:
3296 \begin_layout Standard
3306 \begin_layout Standard
3314 \begin_layout Standard
3324 \begin_layout Standard
3333 \begin_layout Standard
3341 \begin_layout Standard
3351 \begin_layout Standard
3353 \begin_inset Flex CharStyle:Code
3356 \begin_layout Plain Layout
3365 \begin_inset Flex CharStyle:Code
3368 \begin_layout Plain Layout
3376 access LaTeX's section and page counters, and so print out the current
3377 section and page numbers.
3379 \begin_inset Flex CharStyle:Code
3382 \begin_layout Plain Layout
3390 simply prints out today's date.
3393 \begin_layout Standard
3394 The thicknesses of the horizontal rules drawn beneath the header and above
3395 the footer can also be modified.
3396 If you don't want one of the rules, set its thickness to 0.
3397 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3403 \begin_inset Flex CharStyle:Code
3406 \begin_layout Plain Layout
3411 headrulewidth}{0.4pt}
3417 \begin_inset Flex CharStyle:Code
3420 \begin_layout Plain Layout
3425 footrulewidth}{0.4pt}
3430 to set the thicknesses.
3433 \begin_layout Standard
3434 You can switch the header/footer settings on and off for individual pages
3436 \begin_inset Flex CharStyle:Code
3439 \begin_layout Plain Layout
3442 thispagestyle{empty}
3448 \begin_inset Flex CharStyle:Code
3451 \begin_layout Plain Layout
3454 thispagestyle{plain}
3460 \begin_inset Flex CharStyle:Code
3463 \begin_layout Plain Layout
3466 thispagestyle{fancy}
3472 Simply insert them in the text on the page you want changed and mark them
3474 In fact, title pages are marked as plain by default, while following pages
3475 are marked fancy when using the global fancy setting.
3478 \begin_layout Standard
3479 As a final example, it is possible to include an image in the header or
3481 Suppose you want to put a company logo in the upper lefthand corner.
3482 You might try something like
3485 \begin_layout Standard
3494 includegraphics{logo.eps}}}
3497 \begin_layout Standard
3499 (you may need to preface this with
3500 \begin_inset Flex CharStyle:Code
3503 \begin_layout Plain Layout
3507 usepackage{graphics}
3512 if you don't include graphics elsewhere in your document).
3515 \begin_layout Section
3516 Itemize Bullet Selection
3517 \begin_inset CommandInset label
3526 \begin_layout Standard
3532 \begin_layout Subsection
3536 \begin_layout Standard
3537 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3538 Using this dialog you can easily specify what bullet shape to use at each
3539 level of an itemized list.
3540 These settings are document-wide so you won't be able to specify different
3541 sets of bullets for different paragraphs.
3545 \begin_layout Plain Layout
3546 Well, actually you can but you'll have to do it by hand.
3554 \begin_layout Subsection
3558 \begin_layout Standard
3559 Open the dialog by selecting the
3560 \begin_inset Flex CharStyle:MenuItem
3563 \begin_layout Plain Layout
3564 Document\SpecialChar \menuseparator
3570 menu item and then select the
3571 \begin_inset Flex CharStyle:MenuItem
3574 \begin_layout Plain Layout
3583 \begin_layout Standard
3584 The dialog provides you with a table of bullet shapes.
3585 A column of buttons on the left of the table provides access to the six
3586 different panels of bullet shapes.
3587 The row of buttons across the top is used to select which bullet depth
3589 A text entry under the table shows the currently selected bullet shape's
3590 LaTeX equivalent and this can be edited if desired.
3591 If you do modify the text you will also need to specify any needed packages
3592 in the LaTeX preamble.
3595 \begin_layout Standard
3596 The six panels are divided up by the packages they require.
3597 The following table shows the mappings from button name to LaTeX packages.
3600 \begin_layout Standard
3602 \begin_inset Tabular
3603 <lyxtabular version="3" rows="7" columns="2">
3604 <features tabularvalignment="middle">
3605 <column alignment="center" valignment="top" width="0pt">
3606 <column alignment="center" valignment="top" width="0pt">
3608 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3611 \begin_layout Plain Layout
3626 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3629 \begin_layout Plain Layout
3646 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3649 \begin_layout Plain Layout
3664 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3667 \begin_layout Plain Layout
3683 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3686 \begin_layout Plain Layout
3701 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3704 \begin_layout Plain Layout
3721 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3724 \begin_layout Plain Layout
3739 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3742 \begin_layout Plain Layout
3759 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3762 \begin_layout Plain Layout
3777 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3780 \begin_layout Plain Layout
3797 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3800 \begin_layout Plain Layout
3815 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3818 \begin_layout Plain Layout
3835 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3838 \begin_layout Plain Layout
3853 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3856 \begin_layout Plain Layout
3879 \begin_layout Standard
3880 LyX doesn't stop you using bullets from packages you don't have.
3881 If you get errors from LaTeX when you try to view or print the file, then
3882 it is likely you are missing a package.
3886 \begin_layout Plain Layout
3887 LyX doesn't restrict your use since you may be editing locally and exporting
3896 \begin_layout Subsection
3900 \begin_layout Standard
3901 Select which bullet depth you want to change then select the bullet shape
3903 Any changes will not be visible in LyX, but are visible when viewing the
3907 \begin_layout Standard
3908 You can reset a bullet shape to the default simply by clicking your right
3909 mouse button on the appropriate bullet depth button.
3913 \begin_layout Plain Layout
3918 want to have multiple sets of paragraphs with different sets of bullets
3919 in each, then you're going to have to get your hands dirty with TeX code.
3920 The bullet selection dialog can help though because it provides you with
3921 the LaTeX code for a wide range of bullet shapes.
3922 To make your own custom paragraphs you have the following options:
3925 \begin_layout Plain Layout
3929 \begin_layout Plain Layout
3945 \begin_layout Plain Layout
3949 \begin_layout Plain Layout
3971 \begin_layout Itemize
3972 Use the LaTeX command
3973 \begin_inset Flex CharStyle:Code
3976 \begin_layout Plain Layout
3984 to specify a new bullet shape for a given depth.
3985 You'll also need to save the current bullet shape so you can restore it
3987 In this itemized list the following LaTeX code was used to change the bullet
3988 used for the first depth.
3992 \begin_layout LyX-Code
4002 \begin_layout LyX-Code
4019 \begin_layout Itemize
4020 Note that the itemize depth is specified in Roman numerals as part of the
4030 \begin_layout Itemize
4034 \begin_layout Plain Layout
4047 Specify each individual entry by starting each item with the bullet shape
4048 enclosed in square brackets and set as
4049 \begin_inset Flex CharStyle:MenuItem
4052 \begin_layout Plain Layout
4059 For example, this item was started with
4060 \begin_inset Flex CharStyle:Code
4063 \begin_layout Plain Layout
4078 \begin_layout Plain Layout
4082 \begin_layout Plain Layout
4098 \begin_layout Plain Layout
4099 You'll also need to revert the labelitem back to its previous setting for
4100 the global bullet shape settings to remain in effect.
4101 The way used here was:
4104 \begin_layout LyX-Code
4119 \begin_layout Chapter
4123 \begin_layout Section
4127 \begin_layout Standard
4128 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
4129 and retrieve information about the LyX internal state.
4130 This is only intended for advanced users, but they should find it useful.
4131 It is by writing to the LyX server, for example, that bibliography managers,
4132 such as JabRef, are able to
4133 \begin_inset Quotes eld
4137 \begin_inset Quotes erd
4143 \begin_layout Section
4144 Starting the LyX Server
4147 \begin_layout Standard
4148 The LyX server works through the use of a pair of named pipes.
4149 These are usually located in
4150 \begin_inset Flex CharStyle:Code
4153 \begin_layout Plain Layout
4163 \begin_layout Plain Layout
4168 named pipes are special objects located in
4169 \begin_inset Flex CharStyle:Code
4172 \begin_layout Plain Layout
4190 \begin_inset Quotes eld
4194 \begin_inset Flex CharStyle:Code
4197 \begin_layout Plain Layout
4204 \begin_inset Quotes erd
4208 \begin_inset Quotes eld
4212 \begin_inset Flex CharStyle:Code
4215 \begin_layout Plain Layout
4222 \begin_inset Quotes erd
4226 External programs write into
4227 \begin_inset Flex CharStyle:Code
4230 \begin_layout Plain Layout
4236 and read back data from
4237 \begin_inset Flex CharStyle:Code
4240 \begin_layout Plain Layout
4247 The stem of the pipe names can be defined in the
4248 \begin_inset Flex CharStyle:MenuItem
4251 \begin_layout Plain Layout
4252 Tools\SpecialChar \menuseparator
4259 \begin_inset Flex CharStyle:Code
4262 \begin_layout Plain Layout
4263 "/home/myhome/lyxpipe"
4269 \begin_inset Flex CharStyle:Code
4272 \begin_layout Plain Layout
4291 configure this manually in order for the server to start.
4294 \begin_layout Standard
4296 \begin_inset Flex CharStyle:Code
4299 \begin_layout Plain Layout
4306 \begin_inset Flex CharStyle:Code
4309 \begin_layout Plain Layout
4315 ' to create the pipes.
4316 If one of the pipes already exists, LyX will assume that another LyX process
4317 is already running and will not start the server.
4318 On POSIX (Unix like) systems, if for some other reason, an unused
4319 \begin_inset Quotes eld
4323 \begin_inset Quotes erd
4326 pipe is left in existence when LyX closes, then LyX will try to delete
4328 If this fails for some reason, you will need to delete the pipes manually
4329 and then restart LyX.
4330 On Windows, pipes are deleted by the OS on program termination or crash,
4332 \begin_inset Quotes eld
4336 \begin_inset Quotes erd
4339 pipes should not be possible.
4342 \begin_layout Standard
4343 To have several LyX processes with servers at the same time, you have to
4344 use different configurations, perhaps by using separate user directories,
4346 \begin_inset Flex CharStyle:Code
4349 \begin_layout Plain Layout
4355 file, for each process.
4358 \begin_layout Standard
4359 If you are developing a client program, you might find it useful to enable
4360 debugging information from the LyX server.
4361 Do this by starting LyX as
4362 \begin_inset Flex CharStyle:Code
4365 \begin_layout Plain Layout
4374 \begin_layout Standard
4375 You can find a complete example client written in C in the source distribution
4377 \begin_inset Flex CharStyle:Code
4380 \begin_layout Plain Layout
4381 development/lyxserver/server_monitor.c
4389 \begin_layout Standard
4390 Another useful tool is command-line based client you will find in
4391 \begin_inset Flex CharStyle:Code
4394 \begin_layout Plain Layout
4395 src/client/lyxclient
4403 \begin_layout Section
4404 Normal communication
4407 \begin_layout Standard
4408 To issue a LyX call, the client writes a line of ASCII text into the input
4410 This line has the following format:
4427 \begin_layout Description
4428 clientname is a name that the client can choose arbitrarily.
4429 Its only use is that LyX will echo it if it sends an answer—so a client
4430 can dispatch results from different requesters.
4433 \begin_layout Description
4434 function is the function you want LyX to perform.
4435 It is the same as the commands you'd use in the minibuffer.
4438 \begin_layout Description
4439 argument is an optional argument which is meaningful only to some functions
4441 \begin_inset Quotes eld
4445 \begin_inset Quotes erd
4448 LFUN will insert the argument as text at the cursor position).
4451 \begin_layout Standard
4452 The answer from LyX will arrive in the output pipe and be of the form
4469 \begin_layout Standard
4478 are just echoed from the command request, while
4482 is more or less useful information filled according to how the command
4483 execution worked out.
4484 Some commands, such as
4485 \begin_inset Quotes eld
4489 \begin_inset Quotes erd
4492 , will return information about the internal state of LyX, while other will
4493 return an empty data-response.
4494 This means that the command execution went fine.
4497 \begin_layout Standard
4498 In case of errors, the response from LyX will have this form
4515 \begin_layout Standard
4520 should contain an explanation of why the command failed.
4523 \begin_layout Standard
4527 \begin_layout LyX-Code
4528 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
4529 \begin_inset Newline newline
4532 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
4533 \begin_inset Newline newline
4536 read a <~/.lyxpipe.out
4537 \begin_inset Newline newline
4543 \begin_layout Section
4547 \begin_layout Standard
4548 LyX can notify clients of events going on asynchronously.
4549 Currently it will only do this if the user binds a key sequence with the
4551 \begin_inset Quotes eld
4555 \begin_inset Quotes erd
4559 The format of the string LyX sends is as follows:
4563 \begin_inset Flex CharStyle:Code
4566 \begin_layout Plain Layout
4577 \begin_layout Standard
4582 is the printed representation of the key sequence that was actually typed
4586 \begin_layout Standard
4587 This mechanism can be used to extend LyX's command set and implement macros.
4588 Bind some key sequence to
4589 \begin_inset Quotes eld
4593 \begin_inset Quotes erd
4597 Then start a client that listens on the output pipe, dispatches the command
4598 according to the sequence, and starts a function that may use LyX calls
4599 and LyX requests to issue a command or a series of commands to LyX.
4602 \begin_layout Section
4603 The simple LyX Server Protocol
4606 \begin_layout Standard
4607 LyX implements a simple protocol that can be used for session management.
4608 All messages are of the form
4621 \begin_layout Standard
4627 \begin_inset Quotes eld
4631 \begin_inset Quotes erd
4635 \begin_inset Quotes eld
4639 \begin_inset Quotes erd
4644 \begin_inset Quotes eld
4648 \begin_inset Quotes erd
4651 is received from a client, LyX will report back to inform the client that
4652 it's listening to it's messages, while
4653 \begin_inset Quotes eld
4657 \begin_inset Quotes erd
4660 sent from LyX will inform clients that LyX is closing.
4663 \begin_layout Section
4664 Reverse DVI/PDF search
4667 \begin_layout Standard
4668 Some DVI/PDF viewers
4672 \begin_layout Plain Layout
4673 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
4674 Skim on Mac OSX and SumatraPDF on Windows.
4683 facility (also called
4688 This means that you can tell LyX to put the cursor to a specific line in
4689 the document by clicking at the respective position in the DVI/PDF output.
4690 To achieve this, the viewer must be able to communicate with LyX.
4691 This is done via the LyX server either by using the named pipe (
4695 ), or the UNIX domain socket (
4699 ) that LyX creates in its temporary directory (this is the way the
4700 \begin_inset Flex CharStyle:Code
4703 \begin_layout Plain Layout
4709 program communicates with LyX).
4710 In some cases, you need a helper script that mediates between the viewer
4711 and LyX, in others, the viewer can communicate with LyX directly.
4712 This depends on the selected viewer and on your operating system.
4713 The same applies to the way viewers need to be configured and the way the
4714 reverse search is actually performed.
4715 In what follows, we will thus describe how to setup reverse search for
4717 Before we turn to this, though, we will explain what needs to be done generally
4718 to enable reverse search in the DVI/PDF output.
4721 \begin_layout Subsection
4722 Enabling reverse search
4725 \begin_layout Standard
4726 LaTeX provides several different methods for reverse search.
4727 Some are built-in in the
4728 \begin_inset Flex CharStyle:Code
4731 \begin_layout Plain Layout
4737 program, some are provided by external packages.
4738 Your choice depends on whether your LaTeX distribution already provides
4739 a given method (the built-in methods are rather new) and whether your viewer
4741 The available methods are described in the following.
4744 \begin_layout Subsubsection*
4745 Built-in DVI-search via src-specials (DVI only)
4748 \begin_layout Standard
4749 This method provides the DVI file with the necessary information for reverse
4751 It is available in LaTeX since quite some time (any somewhat recent LaTeX
4752 distribution should include it), and it works reliably.
4753 To enable it, change the
4754 \begin_inset Flex CharStyle:MenuItem
4757 \begin_layout Plain Layout
4762 \begin_layout Plain Layout
4775 \begin_inset Flex CharStyle:MenuItem
4778 \begin_layout Plain Layout
4783 \begin_layout Plain Layout
4790 eX (plain)->DraftDVI
4796 \begin_inset Flex CharStyle:MenuItem
4799 \begin_layout Plain Layout
4800 Preferences\SpecialChar \menuseparator
4801 File Handling\SpecialChar \menuseparator
4808 \begin_inset Flex CharStyle:Code
4811 \begin_layout Plain Layout
4812 latex -src-specials $$i
4818 If this doesn't work, check if your TeX engine needs different options
4819 (the syntax might differ in some distributions).
4822 \begin_layout Subsubsection*
4823 External Packages (PDFSync and scrltx)
4826 \begin_layout Standard
4835 provide reverse search facility for PDF output (via pdflatex) and DVI output,
4837 In order to enable it, load the packages in the LyX preamble:
4840 \begin_layout Itemize
4841 \begin_inset Flex CharStyle:Code
4844 \begin_layout Plain Layout
4852 for reverse PDF search,
4855 \begin_layout Itemize
4857 \begin_inset Flex CharStyle:Code
4860 \begin_layout Plain Layout
4863 usepackage[active]{srcltx}
4868 for reverse DVI search.
4871 \begin_layout Standard
4872 If you want to be able to perform both DVI and PDF reverse searches, you
4873 can also insert in the preamble the following lines
4876 \begin_layout LyX-Code
4880 \begin_inset Newline newline
4886 \begin_inset Newline newline
4892 \begin_inset Newline newline
4898 \begin_inset Newline newline
4903 usepackage[active]{srcltx}
4904 \begin_inset Newline newline
4912 \begin_layout Standard
4913 This way, you can preview the file as either DVI or PDF (pdflatex) and the
4914 right package will be used.
4917 \begin_layout Standard
4918 Note that PDFSync might affect the output layout of your document.
4919 It is therefore advised to disable PDFsync for final documents.
4922 \begin_layout Subsubsection*
4923 Built-in reverse search via SyncTeX (DVI and PDF)
4926 \begin_layout Standard
4928 \begin_inset Flex CharStyle:Code
4931 \begin_layout Plain Layout
4937 have built-in support for both PDF and DVI reverse search.
4942 facility is basically the result of the integration of the PDFSync package
4943 to the pdftex program and its merge with the
4948 You need at least TeXLive 2008 or a recent MikTeX distribution in order
4950 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
4951 already provide SyncTeX support.
4954 \begin_layout Standard
4955 To enable SyncTeX for DVI output, change the
4956 \begin_inset Flex CharStyle:MenuItem
4959 \begin_layout Plain Layout
4964 \begin_layout Plain Layout
4977 \begin_inset Flex CharStyle:MenuItem
4980 \begin_layout Plain Layout
4985 \begin_layout Plain Layout
4992 eX (plain) -> DraftDVI
4998 \begin_inset Flex CharStyle:MenuItem
5001 \begin_layout Plain Layout
5002 Preferences\SpecialChar \menuseparator
5003 File Handling\SpecialChar \menuseparator
5010 \begin_inset Flex CharStyle:Code
5013 \begin_layout Plain Layout
5014 latex -synctex=1 $$i
5019 , and for PDF output, change the
5020 \begin_inset Flex CharStyle:MenuItem
5023 \begin_layout Plain Layout
5028 \begin_layout Plain Layout
5035 eX (pdflatex) -> PDF (pdflatex)
5041 \begin_inset Flex CharStyle:Code
5044 \begin_layout Plain Layout
5045 pdflatex -synctex=1 $$i
5051 Check the documentation of your viewer whether the viewer needs to be configure
5052 d for the use with SyncTeX.
5056 \begin_layout Plain Layout
5058 \begin_inset Flex CharStyle:Code
5061 \begin_layout Plain Layout
5067 option enables gzip compression.
5068 If your viewer does not support it, you should instead use
5069 \begin_inset Flex CharStyle:Code
5072 \begin_layout Plain Layout
5086 \begin_layout Subsection
5087 Configuring and using specific viewers
5090 \begin_layout Subsubsection*
5091 Xdvi (all platforms)
5094 \begin_layout Standard
5096 \begin_inset Flex CharStyle:Code
5099 \begin_layout Plain Layout
5105 , you don't need to do anything else for performing a reverse DVI search,
5106 as LyX already provides the necessary hooks for automatically using the
5108 \begin_inset Flex CharStyle:Code
5111 \begin_layout Plain Layout
5118 Just setup your document as described above (reverse search is triggered
5119 by Ctrl-click or Alt-click on Mac OSX, respectively).
5122 \begin_layout Standard
5123 However, if for whatever reason you want to use the named pipe instead of
5124 the socket for communicating with LyX, simply change the DVI viewer in
5126 \begin_inset Flex CharStyle:MenuItem
5129 \begin_layout Plain Layout
5130 Preferences\SpecialChar \menuseparator
5131 File Handling\SpecialChar \menuseparator
5141 \begin_layout Plain Layout
5142 On Mac OSX you have to use
5143 \begin_inset Flex CharStyle:Code
5146 \begin_layout Plain Layout
5147 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
5158 \begin_inset Flex CharStyle:Code
5161 \begin_layout Plain Layout
5162 xdvi -editor 'lyxeditor.sh %f %l'
5168 \begin_inset Flex CharStyle:Code
5171 \begin_layout Plain Layout
5177 is a suitable script.
5178 For example, a minimal shell script is the following one:
5181 \begin_layout LyX-Code
5183 \begin_inset Newline newline
5186 LYXPIPE="/path/to/lyxpipe"
5187 \begin_inset Newline newline
5190 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
5191 \begin_inset Newline newline
5194 echo "$COMMAND" > "${LYXPIPE}".in || exit
5195 \begin_inset Newline newline
5198 read < "${LYXPIPE}".out || exit
5201 \begin_layout Standard
5203 \begin_inset Flex CharStyle:Code
5206 \begin_layout Plain Layout
5216 \begin_layout Plain Layout
5223 XServer pipe path specified in
5224 \begin_inset Flex CharStyle:MenuItem
5227 \begin_layout Plain Layout
5228 Preferences\SpecialChar \menuseparator
5238 \begin_layout Plain Layout
5240 \begin_inset Flex CharStyle:Code
5243 \begin_layout Plain Layout
5249 folder of a source distribution you can find a
5250 \begin_inset Flex CharStyle:Code
5253 \begin_layout Plain Layout
5259 script which is able to locate the
5263 based on your preferences.
5271 \begin_layout Subsubsection*
5275 \begin_layout Standard
5277 \begin_inset Flex CharStyle:Code
5280 \begin_layout Plain Layout
5281 /Applications/MacDviX_Folder/calleditor.script
5286 , add the following lines:
5289 \begin_layout LyX-Code
5294 \begin_layout Plain Layout
5301 X.app/Contents/MacOS/lyxeditor "$2" $1
5302 \begin_inset Newline newline
5308 \begin_layout Standard
5309 Modify the lines accordingly if you install LyX somewhere else than in the
5310 Applications folder.
5313 \begin_layout Standard
5314 Reverse search is triggered by Alt-click (OPTION-click).
5317 \begin_layout Subsubsection*
5321 \begin_layout Standard
5323 \begin_inset Flex CharStyle:Code
5326 \begin_layout Plain Layout
5327 open -a Skim.app $$i
5332 to the viewer setting in
5333 \begin_inset Flex CharStyle:MenuItem
5336 \begin_layout Plain Layout
5337 Preferences\SpecialChar \menuseparator
5338 File Handling\SpecialChar \menuseparator
5339 File formats\SpecialChar \menuseparator
5346 \begin_inset Flex CharStyle:MenuItem
5349 \begin_layout Plain Layout
5350 Skim\SpecialChar \menuseparator
5351 Preferences\SpecialChar \menuseparator
5361 \begin_layout Plain Layout
5371 \begin_layout Standard
5372 Reverse search is triggered by COMMAND-SHIFT-click
5375 \begin_layout Subsubsection*
5379 \begin_layout Standard
5381 \begin_inset Flex CharStyle:MenuItem
5384 \begin_layout Plain Layout
5385 Settings\SpecialChar \menuseparator
5386 Configure Okular\SpecialChar \ldots{}
5387 \SpecialChar \menuseparator
5394 \begin_inset Quotes eld
5398 \begin_inset Quotes erd
5402 \begin_inset Flex CharStyle:Code
5405 \begin_layout Plain Layout
5414 \begin_layout Standard
5415 Reverse search is triggered by SHIFT-click.
5418 \begin_layout Subsubsection*
5422 \begin_layout Standard
5423 Launch yap, choose its
5424 \begin_inset Flex CharStyle:MenuItem
5427 \begin_layout Plain Layout
5428 View\SpecialChar \menuseparator
5435 \begin_inset Quotes eld
5439 \begin_inset Quotes erd
5444 \begin_inset Quotes eld
5447 New\SpecialChar \ldots{}
5449 \begin_inset Quotes erd
5452 button and, in the window that opens, enter
5453 \begin_inset Quotes eld
5457 \begin_inset Quotes erd
5460 (or any other name you like) in the
5461 \begin_inset Quotes eld
5465 \begin_inset Quotes erd
5469 Now click on the button labeled
5470 \begin_inset Quotes eld
5473 \SpecialChar \ldots{}
5475 \begin_inset Quotes erd
5478 to open a file dialog and navigate to the directory containing the batch
5480 \begin_inset Flex CharStyle:Code
5483 \begin_layout Plain Layout
5491 \begin_inset Flex CharStyle:Code
5494 \begin_layout Plain Layout
5500 and then specify the program arguments as
5501 \begin_inset Flex CharStyle:Code
5504 \begin_layout Plain Layout
5512 \begin_inset Flex CharStyle:Code
5515 \begin_layout Plain Layout
5521 wrapper is used for communicating with LyX through the
5528 \begin_layout LyX-Code
5530 \begin_inset Newline newline
5533 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
5542 \begin_inset Newline newline
5556 \begin_layout Standard
5557 Make sure that the LyXServer pipe path you specified in LyX is
5558 \begin_inset Flex CharStyle:Code
5561 \begin_layout Plain Layout
5575 , otherwise change the
5576 \begin_inset Flex CharStyle:Code
5579 \begin_layout Plain Layout
5585 wrapper accordingly.
5588 \begin_layout Standard
5589 In yap, reverse search is triggered by double-click.
5592 \begin_layout Subsubsection*
5593 SumatraPDF (Windows)
5596 \begin_layout Standard
5597 In order to use SumatraPDF for inverse search, enter
5598 \begin_inset Flex CharStyle:Code
5601 \begin_layout Plain Layout
5602 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
5607 in the viewer setting in
5608 \begin_inset Flex CharStyle:MenuItem
5611 \begin_layout Plain Layout
5612 Preferences\SpecialChar \menuseparator
5613 File Handling\SpecialChar \menuseparator
5614 File formats\SpecialChar \menuseparator
5621 \begin_inset Flex CharStyle:Code
5624 \begin_layout Plain Layout
5630 is the previous wrapper.
5631 If SumatraPDF.exe is not in your command PATH, use its full file name.
5634 \begin_layout Standard
5635 Reverse search is triggered by double-click.
5638 \begin_layout Subsubsection*
5642 \begin_layout Standard
5643 First of all, make sure that yap is your default DVI viewer in the Windows
5644 environment, then launch it, choose its
5645 \begin_inset Flex CharStyle:MenuItem
5648 \begin_layout Plain Layout
5649 View\SpecialChar \menuseparator
5656 \begin_inset Quotes eld
5660 \begin_inset Quotes erd
5665 \begin_inset Quotes eld
5668 New\SpecialChar \ldots{}
5670 \begin_inset Quotes erd
5673 button and, in the window that opens, enter
5674 \begin_inset Quotes eld
5678 \begin_inset Quotes erd
5681 (or any other name you like) in the
5682 \begin_inset Quotes eld
5686 \begin_inset Quotes erd
5690 Now click on the button labeled
5691 \begin_inset Quotes eld
5694 \SpecialChar \ldots{}
5696 \begin_inset Quotes erd
5699 to open a file dialog and navigate to the directory containing the
5700 \begin_inset Flex CharStyle:Code
5703 \begin_layout Plain Layout
5709 program (which is installed by default on Cygwin along with the LyX executable).
5711 \begin_inset Flex CharStyle:Code
5714 \begin_layout Plain Layout
5720 and then specify the program arguments as
5721 \begin_inset Flex CharStyle:Code
5724 \begin_layout Plain Layout
5731 In this way, you will be using the
5735 for communicating with LyX.
5736 If, for whatever reason, you want to use the
5741 \begin_inset Flex CharStyle:Code
5744 \begin_layout Plain Layout
5750 option and be sure to specify the LyXServer pipe path in the LyX preferences.
5753 \begin_layout Standard
5754 In yap, reverse search is triggered by double-click.
5757 \begin_layout Subsubsection*
5761 \begin_layout Standard
5762 In order to use SumatraPDF for inverse search, enter
5763 \begin_inset Flex CharStyle:Code
5766 \begin_layout Plain Layout
5772 in the viewer setting in
5773 \begin_inset Flex CharStyle:MenuItem
5776 \begin_layout Plain Layout
5777 Preferences\SpecialChar \menuseparator
5778 File Handling\SpecialChar \menuseparator
5779 File formats\SpecialChar \menuseparator
5786 \begin_inset Flex CharStyle:Code
5789 \begin_layout Plain Layout
5795 is the following script (to be placed in your command PATH,
5796 \begin_inset Flex CharStyle:Code
5799 \begin_layout Plain Layout
5805 being the best choice):
5808 \begin_layout LyX-Code
5810 \begin_inset Newline newline
5814 \begin_inset Newline newline
5817 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
5820 \begin_layout Standard
5821 This wrapper script is needed because SumatraPDF is a native Windows application
5822 and does not understand the posix paths used by the Cygwin version of LyX.
5823 If SumatraPDF.exe is not in your command PATH, use its full posix path in
5826 \begin_inset Flex CharStyle:Code
5829 \begin_layout Plain Layout
5835 enables communication via the
5841 \begin_inset Flex CharStyle:Code
5844 \begin_layout Plain Layout
5850 option if you want to use the
5854 , and be sure to specify the LyXServer pipe path in the LyX preferences.
5857 \begin_layout Standard
5858 Reverse search is triggered by double-click.
5861 \begin_layout Chapter
5862 Special Document Classes
5865 \begin_layout Section
5869 \begin_layout Standard
5875 \begin_layout Subsection
5879 \begin_layout Standard
5880 This section describes how LyX can be used to write articles for submission
5881 to the scientific journal
5883 Astronomy and Astrophysics
5885 (www.edpsciences.fr/aa/
5886 \begin_inset Flex URL
5889 \begin_layout Plain Layout
5891 http://www.edpsciences.fr/aa/
5896 ) using Version 5.01 of the document class
5901 This package can be downloaded from the ftp site
5904 \begin_layout Standard
5905 \begin_inset VSpace medskip
5911 \begin_layout Standard
5913 \begin_inset Flex URL
5916 \begin_layout Plain Layout
5918 ftp://ftp.edpsciences.org/pub/aa/readme.html
5926 \begin_layout Standard
5927 \begin_inset VSpace medskip
5933 \begin_layout Standard
5934 A manual comes together with that package, and this text is not meant to
5935 replace the original manual but merely a short guide how to realize the
5936 correct form of your paper.
5940 \begin_layout Standard
5941 Please note that the publisher of the journal was changed from Springer
5942 to EDP Sciences starting January 1, 2001.
5943 That change implicated also some slight changes of the style files, namely
5944 the removal of the thesaurus command.
5945 The LyX class aa supports the newest version of these style files, V 5.01.
5946 If you have an older version installed, please upgrade.
5947 For compatibility, the old (version 4) layout has been kept as
5952 Please refer to the comments in
5954 LyXDir/layouts/aapaper.layout
5959 \begin_layout Subsection
5963 \begin_layout Standard
5964 It is recommended you start from the example template distributed with LyX.
5965 If you are not using a template, note the following settings:
5968 \begin_layout Itemize
5975 Document\SpecialChar \menuseparator
5978 dialog (OK, that one was obvious).
5981 \begin_layout Itemize
5982 Don't change the option
5985 \begin_inset space ~
5995 The whole layout is done by the macros, you shouldn't change anything.
5998 \begin_layout Subsection
6002 \begin_layout Standard
6003 First thing to enter is the header information.
6004 It consists of seven entries, of which some are optional.
6008 \begin_layout Itemize
6016 \begin_layout Itemize
6024 \begin_layout Itemize
6032 \begin_layout Itemize
6040 \begin_layout Itemize
6045 : [optional] if more than one author: whom to contact for offprint requests.
6048 \begin_layout Itemize
6053 : [optional] mail address for contacts.
6056 \begin_layout Itemize
6064 Received: <date>; Accepted <date>
6067 \begin_layout Standard
6068 There is no need to issue the
6074 command, this is done automatically by LyX when the header is finished.
6075 Although the order of the single header entries doesn't matter it is advised
6076 to keep the above sequence, just to get the best optics and meets the layout
6077 of the real document.
6080 \begin_layout Standard
6081 If you want to place footnotes in the header block, e.
6082 \begin_inset space \thinspace{}
6086 \begin_inset space \space{}
6089 to state your present address, just use the standard footnote via the menu
6092 Insert\SpecialChar \menuseparator
6096 LyX will automagically use the term
6105 \begin_layout Standard
6106 In addition to these topics, the macros use three additional LaTeX commands
6107 that have no counterpart in LyX:
6110 \begin_layout Itemize
6117 to separate different names for more than one author and institute, respectivel
6121 \begin_layout Itemize
6128 to mark corresponding author/institute pairs.
6129 The institutes are numbered sequentially as they appear in the
6133 field, so you have to put a marker to each author.
6136 \begin_layout Itemize
6143 to supply an email address for fast contact.
6146 \begin_layout Standard
6147 In all cases, the appropriate command has to be entered in LyX and marked
6153 \begin_layout Subsection
6157 \begin_layout Standard
6158 The abstract should immediately follow the header block.
6159 With version 5 the abstract environment was changed to a command, and there
6160 is now a resctriction to only one paragraph.
6161 In addition, it should contain an entry with the keywords.
6162 This is not yet implemented for LyX, therefore you have to enter the LaTeX
6169 by hand and mark it as LaTeX code.
6170 Refer to the example paper.
6173 \begin_layout Subsection
6174 Supported environments
6177 \begin_layout Standard
6178 The A&A paper layout supports the following environments for structuring
6182 \begin_layout Itemize
6188 \begin_layout Itemize
6194 \begin_layout Itemize
6200 \begin_layout Itemize
6206 \begin_layout Itemize
6212 \begin_layout Itemize
6218 \begin_layout Itemize
6224 \begin_layout Itemize
6230 \begin_layout Itemize
6236 \begin_layout Itemize
6242 \begin_layout Itemize
6248 \begin_layout Itemize
6254 \begin_layout Subsection
6255 Commands not supported by LyX
6258 \begin_layout Standard
6259 Some commands are not yet supported by the
6264 Some have already been mentioned.
6265 For the sake of completeness, they are listed all together here:
6268 \begin_layout Itemize
6276 \begin_layout Itemize
6284 \begin_layout Itemize
6292 \begin_layout Itemize
6300 \begin_layout Itemize
6308 \begin_layout Itemize
6316 \begin_layout Itemize
6324 \begin_layout Itemize
6332 \begin_layout Standard
6333 If you want to use any of these commands, you have to enter them yourself.
6336 Do not forget to mark them as LaTeX code!
6339 \begin_layout Subsection
6340 Figure and Table Floats
6343 \begin_layout Standard
6344 LyX provides support for the necessary float environments
6346 figure, figure*, table
6352 , therefore we won't tell much about it here.
6356 \begin_inset space ~
6362 Just remember that tables should be left-aligned.
6363 For that, select the table and change the alignment in
6365 Edit\SpecialChar \menuseparator
6367 \begin_inset space ~
6373 \begin_layout Standard
6374 There is only one special thing: the figures with caption besides the figure.
6375 To create such a figure, you have to do the following:
6378 \begin_layout Enumerate
6379 Create a wide figure float:
6381 Insert\SpecialChar \menuseparator
6382 Float\SpecialChar \menuseparator
6385 , then right click in the figure and select
6391 \begin_inset space ~
6399 \begin_layout Enumerate
6400 Enter your caption text.
6403 \begin_layout Enumerate
6408 to move the cursor above the caption.
6411 \begin_layout Enumerate
6415 \begin_layout Enumerate
6416 Position the cursor behind the figure and insert a horizontal fill:
6418 Insert\SpecialChar \menuseparator
6420 \begin_inset space ~
6423 Character\SpecialChar \menuseparator
6425 \begin_inset space ~
6433 \begin_layout Enumerate
6434 Switch to LaTeX mode:
6437 \begin_inset space ~
6445 \begin_layout Enumerate
6455 Do not close the brace!
6458 \begin_layout Enumerate
6459 Position the cursor behind the caption text, switch to LaTeX mode and insert
6463 \begin_inset space ~
6475 \begin_layout Standard
6476 Also, refer to the figures in the example paper.
6479 \begin_layout Subsection
6483 \begin_layout Standard
6484 For submission, the paper has to be formated in a special double-spacing
6486 For this purpose, you have to give the option
6490 to the documentclass.
6491 This must be done using the extra class options field in the
6493 Document\SpecialChar \menuseparator
6497 Just enter the string
6504 \begin_layout Subsection
6508 \begin_layout Standard
6513 directory contains an example paper written with LyX.
6514 It is the example paper from the original macro package, translated to
6516 Use it for inspiration, and compare the original LaTeX code with LyX way
6520 \begin_layout Section
6524 \begin_layout Standard
6530 \begin_layout Subsection
6534 \begin_layout Standard
6535 AASTeX is a set of macros produced by the American Astronomical Society
6536 to facilitate electronic manuscript submission to the three journals they
6537 publish: the Astrophysical Journal (including the Letters and Supplement),
6538 the Astronomical Journal, and the Publications of the Astronomical Society
6540 LyX has proven to be an excellent tool for generating these documents,
6541 especially given its equation, citation, and figure handling capabilities.
6542 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6543 is the version described here, or higher.
6544 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6545 incompatible with LyX.
6546 The AASTeX package may be downloaded from the AASTeX Web site
6549 \begin_layout Standard
6550 \begin_inset VSpace medskip
6556 \begin_layout Standard
6558 \begin_inset Flex URL
6561 \begin_layout Plain Layout
6563 http://www.journals.uchicago.edu/AAS/AASTeX
6571 \begin_layout Standard
6572 \begin_inset VSpace medskip
6578 \begin_layout Standard
6579 A complete user guide is contained in that package and you should familiarize
6580 yourself with it thoroughly before embarking on writing a paper in LyX.
6581 LyX will not reduce the need to figure out all the AASTeX commands, it
6582 will only reduce the drudgery of typing everything in.
6583 It is your responsibility to ensure that the final exported LaTeX document
6584 conforms completely to the requirements of the journal to which you are
6585 submitting your paper.
6588 \begin_layout Subsection
6589 Starting a New Paper
6592 \begin_layout Standard
6593 I strongly suggest that you start with the AASTeX template file.
6596 File\SpecialChar \menuseparator
6603 , enter the new file name, then choose the
6608 This will show the most common fields found in a manuscript.
6609 Simply overwrite the existing text (including the brackets,
6613 ) with the correct information.
6614 Many of the AASTeX commands and environments can be implemented directly
6615 in LyX, but some cannot: most noticeably
6627 , which should stick out like a sore thumb if you actually just opened the
6629 For commands such as these, the LaTeX code must be entered directly and
6631 Such commands are referred to as TeX code, or Evil Red Text.
6632 I tried to minimize the amount of TeX code needed in an AASTeX document,
6633 but there is still a bit more required than any of us would like.
6636 \begin_layout Subsection
6637 Finishing Your Paper
6640 \begin_layout Standard
6641 When the paper is finished to your satisfaction and previews/prints correctly,
6643 \begin_inset Quotes eld
6647 \begin_inset Quotes erd
6650 actions which need to be done before you submit it to the journals.
6654 \begin_layout Enumerate
6655 Export your paper as a LaTeX file (
6657 File\SpecialChar \menuseparator
6658 Export\SpecialChar \menuseparator
6665 \begin_layout Enumerate
6670 file with your favorite text editor
6674 \begin_layout Enumerate
6675 remove the comment lines before the
6684 \begin_layout Enumerate
6689 usepackage...{fontenc}
6691 line if it appears (usually just after
6706 \begin_layout Enumerate
6707 remove everything between (and including) the
6719 commands, except for any commands you specifically put into the LaTeX preamble
6720 (which should appear immediately after the
6721 \begin_inset Quotes eld
6724 User specified LaTeX commands
6725 \begin_inset Quotes erd
6736 \begin_layout Enumerate
6737 Run the resulting file through LaTeX to make sure it still processes correctly.
6740 \begin_layout Enumerate
6741 Reread the journal requirements to make sure your filenames and formats
6745 \begin_layout Enumerate
6749 \begin_layout Subsection
6750 Comments On Specific Commands
6753 \begin_layout Standard
6754 I will not describe the detailed usage of the individual AASTeX commands:
6755 the AASTeX User Guide (
6759 ) gives a good description of each.
6760 Thus it's probably easiest for me to go down the list as found in the guide
6761 and offer comments where necessary.
6762 So let's begin \SpecialChar \ldots{}
6766 \begin_layout Subsubsection
6767 Things that work as expected
6770 \begin_layout Standard
6774 \begin_layout Plain Layout
6786 \begin_layout Standard
6787 Because they work as you might expect, I simply list them and the section
6888 begin{thebibliography}
6896 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6897 graphicx figure commands (2.14.1),
6921 (2.15.4, amongst other places),
6948 \begin_layout Standard
6949 The following style options also work correctly:
6970 Simply put them in the
6976 Layout\SpecialChar \menuseparator
6982 \begin_layout Standard
6986 \begin_layout Plain Layout
6998 \begin_layout Subsubsection
6999 Things that work, but require more comment
7002 \begin_layout Standard
7003 The following items work, but require a little more discussion:
7006 \begin_layout Itemize
7007 These items are reserved for use by the journal editors, but you can put
7008 them into the LaTeX preamble if you feel compelled to do so:
7041 \begin_layout Itemize
7042 These items may be placed in the LaTeX preamble, and are included as blanks
7043 in the template file:
7064 \begin_layout Itemize
7071 (2.3) – can only be used
7072 \begin_inset Quotes eld
7076 \begin_inset Quotes erd
7079 , not in the middle of a paragraph.
7080 Use TeX code if you need to embed it.
7083 \begin_layout Itemize
7090 (2.3) – will have extra {} after it.
7091 This should not cause an error.
7094 \begin_layout Itemize
7101 (2.6) – can only be used
7102 \begin_inset Quotes eld
7106 \begin_inset Quotes erd
7109 , not in the middle of a paragraph.
7110 Use TeX code if you need to embed it.
7113 \begin_layout Itemize
7120 (2.8) – can't insert a cross-reference tag, you must type the tag name by
7124 \begin_layout Itemize
7131 (2.8) – same as for
7138 \begin_layout Itemize
7145 (2.9) – will have extra {} after it.
7146 This should not cause an error.
7149 \begin_layout Itemize
7156 (2.11) – will have extra {} after it.
7157 This should not cause an error.
7160 \begin_layout Itemize
7167 (2.14.2) – you can insert an optional filename argument by placing the cursor
7168 at the beginning of the text and selecting
7170 Insert\SpecialChar \menuseparator
7175 \begin_inset Quotes eld
7179 \begin_inset Quotes erd
7182 inserts an optional argument of the type needed by
7189 Hopefully it will be renamed someday.
7192 \begin_layout Itemize
7199 (2.17.1) – same as
7205 for the catalog ID optional parameter
7208 \begin_layout Itemize
7215 (2.17.1) – same as
7221 for the catalog ID optional parameter
7224 \begin_layout Subsubsection
7225 Things not implemented, use TeX code
7228 \begin_layout Standard
7232 \begin_layout Plain Layout
7244 \begin_layout Standard
7267 setcounter{equation}
7269 (2.12), Journal name abbreviations (2.13.4),
7305 (2.15.4, insert it as the first element in the lefthand cell after where
7307 Don't use any of LyX's rules in the table),
7319 (2.15.5), much of Misc (2.17, except
7370 \begin_layout Standard
7374 \begin_layout Plain Layout
7386 \begin_layout Subsubsection
7387 Things that cannot be implemented
7390 \begin_layout Standard
7391 \SpecialChar \ldots{}
7392 at least in any meaningful sort of way, so I suggest ignoring them.
7393 They are the references environment (2.13.3), and the deluxetable environment
7395 If you really, really need to use deluxetable, I suggest editing it in
7396 a separate file with a text editor, then using
7398 Insert\SpecialChar \menuseparator
7400 \begin_inset space ~
7405 to include it in your LyX document.
7410 file to see an example of this.
7413 \begin_layout Subsection
7414 FAQs, Tips, Tricks, and Other Ruminations
7417 \begin_layout Subsubsection
7418 Getting LyX and AASTeX to cooperate
7421 \begin_layout Standard
7422 It can be a bit tricky to get LyX to recognize a new layout and document
7424 When all else fails, do this:
7427 \begin_layout Enumerate
7428 Make certain that LaTeX can find AASTeX.
7429 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7430 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7437 \begin_layout Enumerate
7449 \begin_layout Enumerate
7452 Tools\SpecialChar \menuseparator
7455 in LyX, then restart LyX.
7458 \begin_layout Enumerate
7459 Open a regular new file, not from a template.
7460 Does AASTeX appear in the class list in
7462 Document\SpecialChar \menuseparator
7468 \begin_layout Standard
7469 If you get a warning from an existing AASTeX document about not being able
7470 to find the AASTeX layout or a message about
7471 \begin_inset Quotes eld
7474 You should not mix title layouts with normal ones
7475 \begin_inset Quotes erd
7478 , things haven't been installed correctly.
7481 \begin_layout Subsubsection
7482 LaTeX error processing a table
7485 \begin_layout Standard
7486 LyX, by default, attempts to center the table caption/title.
7487 This seems to produce a bad interaction in AASTeX so you should click somewhere
7488 in the caption/title, then select
7490 Edit\SpecialChar \menuseparator
7492 \begin_inset space ~
7506 This took care of it for me.
7509 \begin_layout Subsubsection
7513 \begin_layout Standard
7514 A couple of things: 1) I have noticed some funny spacing in the reference
7515 entries in the text.
7516 When you enter the bibliography item data, make sure their is
7520 space between the last author and the parenthesis setting off the year;
7524 \begin_inset space \thinspace{}
7528 \begin_inset space \space{}
7542 2) Entering the references at all is not obvious.
7543 The easiest thing is to start typing your first reference at the end of
7544 the document, then mark it as type
7549 That will put a small gray box in front of what you just typed.
7550 Click on the box to fill in the rest of the information.
7551 For new references, go to the end of an existing reference and press return.
7552 That will create a new line with its own box, etc.
7555 \begin_layout Subsubsection
7559 \begin_layout Standard
7560 Even though AASTeX provides its own figure commands (
7566 , for example), I much prefer LaTeX's standard figure commands (with the
7575 \begin_inset space ~
7578 commands as TeX code into a Figure Float box if you desire, but I never
7579 have much luck getting the layout right.
7580 With the standard graphics, LyX will insert a
7584 usepackage{graphicx}
7586 command into the LaTeX preamble and handle the figures in the standard
7587 LaTeX2e way, interspersing the figures in the text.
7588 I believe ApJ accepts figures exactly this way now; AJ might still use
7590 \begin_inset Quotes eld
7593 stack everything at the end
7594 \begin_inset Quotes erd
7600 \begin_layout Subsubsection
7601 Things I could have done, but didn't
7604 \begin_layout Standard
7606 \begin_inset Quotes eld
7610 \begin_inset Quotes erd
7613 things I could have implemented, but chose not to.
7614 For instance, I saw no point in double-spacing the text in the LyX window,
7615 even though it is double-spaced in the paper manuscript.
7616 Also, I chose not to make separate layouts for the preprint and preprint2
7618 Since I assume you will spend most of your time in the plain manuscript
7619 mode anyway, I decided not to chew up more disk space with this.
7623 \begin_layout Subsection
7627 \begin_layout Standard
7628 Your mileage may vary.
7629 I've now had papers published by both ApJ and AJ that have had 98% of the
7630 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7632 I have had no trouble with the submission process, and I'm sure the journals
7633 were never aware that there might be a difference.
7634 So, go forth and publish!
7637 \begin_layout Section
7641 \begin_layout Standard
7644 David Johnson; updated by Richard Heck
7647 \begin_layout Standard
7648 \begin_inset VSpace bigskip
7654 \begin_layout Standard
7656 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
7657 papers to be submitted to American Mathematical Society publications.
7658 The layouts are not tailored to a specific journal, but easily can be.
7659 You should refer to the AMS documentation for specific instructions for
7660 each journal (usually it will entail only changing a single line in the
7662 That documentation is available on the Web at
7663 \begin_inset Flex URL
7666 \begin_layout Plain Layout
7674 \begin_inset Flex URL
7677 \begin_layout Plain Layout
7679 ftp://ftp.ams.org/pub/tex/amslatex/
7685 These layouts are appropriate, and useful, for any mathematical writing.
7689 \begin_layout Standard
7690 There are two basic AMS LaTeX layouts:
7693 \begin_layout Itemize
7694 amsart: The standard AMS article format.
7697 \begin_layout Itemize
7698 amsbook: the standard AMS book (really, monograph) format.
7702 \begin_layout Standard
7703 The layouts themselves contain only the minimum necessary to use the AMS
7705 They do not, in particular, contain any of the `theorem' environments used
7706 for setting theorems, lemmas, and the like.
7707 These are contained, instead, in the
7708 \begin_inset Flex CharStyle:Code
7711 \begin_layout Plain Layout
7717 module, which is loaded by default when when you select one of the AMS
7719 (It can also be used with other classes and can be removed, if you would
7720 rather use something else.) Less commonly used environments are in the
7721 \begin_inset Flex CharStyle:Code
7724 \begin_layout Plain Layout
7725 Theorems (AMS-Extended)
7730 module, which must be loaded manually.
7733 \begin_layout Standard
7734 By default, theorems and the like are numbered consecutively throughout
7735 the document, but this may be modified by loading the module
7736 \begin_inset Flex CharStyle:Code
7739 \begin_layout Plain Layout
7740 Theorems (Order by Section)
7745 or, if you are using
7746 \begin_inset Flex CharStyle:Code
7749 \begin_layout Plain Layout
7756 \begin_inset Flex CharStyle:Code
7759 \begin_layout Plain Layout
7760 Theorems (Order by Chapter)
7766 These will number the results as
7767 \begin_inset Formula $n.m$
7770 , where the first number refers to the section (or chapter) and the second
7771 refers to the total number of results so far in that section (or chapter).
7772 Many environments are also available unnumbered.
7773 These are indicated by an asterisk at the end.
7774 If you happen to want
7778 unnumbered results, the the module
7779 \begin_inset Flex CharStyle:Code
7782 \begin_layout Plain Layout
7788 provides that option.
7791 \begin_layout Standard
7792 Note that these modules do not
7796 to be used with the AMS classes.
7797 It is perfectly possible to use the
7798 \begin_inset Flex CharStyle:Code
7801 \begin_layout Plain Layout
7807 module, and the others mentioned, with other classes, such as
7808 \begin_inset Flex CharStyle:Code
7811 \begin_layout Plain Layout
7818 \begin_inset Flex CharStyle:Code
7821 \begin_layout Plain Layout
7828 \begin_inset Flex CharStyle:Code
7831 \begin_layout Plain Layout
7840 \begin_layout Subsection
7841 What these layouts provide
7844 \begin_layout Standard
7845 There is a long list of included environments provided by these layouts.
7846 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
7847 variety of `theorem' environments.
7848 However, the AMS recommends the environments that are available in LyX.
7852 \begin_layout Standard
7853 The following environments—as well as the standard environments, such as
7855 \begin_inset Flex CharStyle:Noun
7858 \begin_layout Plain Layout
7865 \begin_inset Flex CharStyle:Noun
7868 \begin_layout Plain Layout
7875 \begin_inset Flex CharStyle:Noun
7878 \begin_layout Plain Layout
7885 \begin_inset Flex CharStyle:Noun
7888 \begin_layout Plain Layout
7895 \begin_inset Flex CharStyle:Noun
7898 \begin_layout Plain Layout
7905 \begin_inset Flex CharStyle:Code
7908 \begin_layout Plain Layout
7915 \begin_inset Flex CharStyle:Code
7918 \begin_layout Plain Layout
7927 \begin_layout Description
7928 Address This should be the author's permanent address.
7931 \begin_layout Description
7933 \begin_inset space ~
7936 Address This should be the author's temporary address at the time of submission,
7937 if different from the Address.
7940 \begin_layout Description
7941 Email Author's e-mail address
7944 \begin_layout Description
7945 URL Author's Web address, if desired.
7948 \begin_layout Description
7949 Keywords Key words or phrases used to identify specific topics discussed
7953 \begin_layout Description
7954 Subjectclass These refer to the AMS Subject Classifications, published and
7957 Mathematical Reviews
7960 These are also available online at the AMS cites listed above.
7963 \begin_layout Description
7967 \begin_layout Description
7971 \begin_layout Description
7975 \begin_layout Standard
7976 The following environments are provided by both the
7977 \begin_inset Flex CharStyle:Code
7980 \begin_layout Plain Layout
7987 \begin_inset Flex CharStyle:Code
7990 \begin_layout Plain Layout
7996 modules, in the latter case in both starred (unnumbered) and unstarred
7997 (numbered) versions.
7998 These same environments are provided only in the starred versions by the
8000 \begin_inset Flex CharStyle:Code
8003 \begin_layout Plain Layout
8012 \begin_layout Theorem
8013 This is typically used for the statements of major results.
8017 \begin_layout Corollary*
8018 This is used for statements which follow fairly directly from previous statement
8020 Again, these can be major results.
8025 These are smaller results needed to prove other statements.
8028 \begin_layout Proposition
8029 These are less major results which (hopefully) add to the general theory
8033 \begin_layout Conjecture
8034 These are statements provided without justification, which the author does
8035 not know how to prove, but which seem to be true (to the author, at least).
8038 \begin_layout Definition*
8039 Guess what this is for.
8040 The font is different for this environment than for the previous ones.
8044 \begin_layout Example*
8045 Used for examples illustrating proven results.
8048 \begin_layout Problem
8049 It's not really known what this is for.
8050 You should figure it out.
8053 \begin_layout Exercise*
8054 Write a description for this one.
8057 \begin_layout Remark
8058 This environment is also a type of theorem, usually a lesser sort of observation.
8061 \begin_layout Claim*
8062 Often used in the course of giving a proof of a larger result.
8066 Generally, these are used to break up long arguments, using specific instances
8072 The numbering scheme for cases is on its own, not together with other numbered
8078 At the end of this environment, a QED symbol (usually a square, but it can
8079 vary with different styles) is placed.
8080 If you want to have other environments within this one—for example, Case
8081 environments—and have the QED symbol appear only after them, then the other
8082 environments need to be nested within the proof environment.
8085 Nesting Environments
8091 for information on nesting.
8094 \begin_layout Standard
8095 And these environments are provided by
8096 \begin_inset Flex CharStyle:Code
8099 \begin_layout Plain Layout
8100 Theorems (AMS-Extended)
8108 \begin_layout Criterion*
8109 A required condition.
8112 \begin_layout Algorithm*
8113 A general procedure to be used.
8116 \begin_layout Axiom*
8117 This is a property or statement taken as true within the system being discussed.
8120 \begin_layout Condition*
8121 Sometimes used to state a condition assumed within the present context of
8126 Similar to a Remark.
8129 \begin_layout Notation*
8130 Used for the explanation of, yes, notation.
8133 \begin_layout Summary
8134 Do we really need to tell you?
8137 \begin_layout Acknowledgement*
8141 \begin_layout Conclusion*
8142 Sometimes used at the end of a long train of argument.
8146 Used in a way similar to Proposition, though perhaps lower on the scale.
8149 \begin_layout Standard
8150 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
8152 They need to be available on your system in order to use these environments.
8155 \begin_layout Section
8163 \begin_layout Standard
8169 \begin_layout Subsection
8173 \begin_layout Standard
8174 These are the layout files for some of the journals of the American Geophysical
8176 It is assumed that you have both the AGU's own class files and AGUplus
8177 installed (everything to be found at
8178 \begin_inset Flex URL
8181 \begin_layout Plain Layout
8183 ftp://ftp.agu.org/journals/latex/journals
8191 \begin_layout Subsection
8195 \begin_layout Standard
8205 They are still called this in the LyX GUI, though their LaTeX equivalents
8206 in the AGU classes are
8217 \begin_layout Standard
8218 Newly defined styles are
8255 These are mostly manuscript attributes and defined in the AGU class documentati
8259 \begin_layout Standard
8260 I suspect this is still badly incomplete.
8263 \begin_layout Subsection
8267 \begin_layout Standard
8284 \begin_layout Subsection
8288 \begin_layout Itemize
8291 Journal of Geophysical Research
8300 \begin_layout Standard
8301 Add your own, it isn't so hard! Look at the
8312 \begin_layout Subsection
8313 Bugs and things to remember
8316 \begin_layout Standard
8317 In order to use the new layouts, you must remember to do the following for
8321 \begin_layout Enumerate
8327 This can be done in the
8329 Layout\SpecialChar \menuseparator
8334 Document\SpecialChar \menuseparator
8338 (AGU articles are always in English, right? So
8345 \begin_layout Enumerate
8355 (Yes, this is a bug.)
8358 \begin_layout Enumerate
8359 Make sure you use the
8363 bibliography style, by entering
8367 into the second field of the BibTeX inset.
8368 None of the standard styles will do.
8371 \begin_layout Section
8375 \begin_layout Standard
8381 \begin_layout Subsection
8385 \begin_layout Standard
8386 Broadway is for writing plays.
8387 The format is more decorative than Hollywood, and much less standardized.
8388 This format should be suitable for workshops.
8391 \begin_layout Subsection
8395 \begin_layout Standard
8396 The same as in Hollywood.
8399 \begin_layout Subsection
8403 \begin_layout Standard
8408 names as labels then cross-reference the label to insert the name.
8409 The cross-reference dialog will show the current cast of characters.
8412 \begin_layout Subsection
8413 Paper size and Margins
8416 \begin_layout Standard
8417 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
8420 \begin_layout Subsection
8424 \begin_layout Standard
8425 The following environments are available.
8426 You can use broadway.bind to get the bind keys shown at the right.
8429 \begin_layout Itemize
8433 \begin_inset Newline newline
8438 You should not have to use this, but it is here for anything that does not
8442 \begin_layout Itemize
8446 \begin_inset space \hfill{}
8450 \begin_inset Newline newline
8455 Used to describe stage setting and the action.
8456 First use of speaker names in all CAPs.
8459 \begin_layout Itemize
8463 \begin_inset space \hfill{}
8467 \begin_inset Newline newline
8472 Automatically numbered.
8473 On screen it will be arabic, but will print as Roman.
8476 \begin_layout Itemize
8480 \begin_inset space \hfill{}
8484 \begin_inset Newline newline
8494 It is just centered text.
8497 \begin_layout Itemize
8501 \begin_inset space \hfill{}
8505 \begin_inset Newline newline
8510 Not automatically numbered.
8511 You supply the number.
8512 This is because I couldn't figure out how.
8515 \begin_layout Itemize
8519 \begin_inset space \hfill{}
8523 \begin_inset Newline newline
8528 A special case of Narrative to describe the setting and action as the curtain
8532 \begin_layout Itemize
8536 \begin_inset space \hfill{}
8540 \begin_inset Newline newline
8545 The speaker's (actor's) title, centered in all CAPS.
8548 \begin_layout Itemize
8552 \begin_inset space \hfill{}
8556 \begin_inset Newline newline
8561 Instructions to the speaker.
8562 The parentheses are automatically inserted.
8563 The ( will appear on screen, but both will be in the printed play.
8564 This environment is only used within
8571 \begin_layout Itemize
8575 \begin_inset space \hfill{}
8579 \begin_inset Newline newline
8584 What the Speaker says.
8587 \begin_layout Itemize
8591 \begin_inset space \hfill{}
8595 \begin_inset Newline newline
8600 The curtain comes down.
8603 \begin_layout Itemize
8607 \begin_inset space \hfill{}
8613 \begin_layout Itemize
8617 \begin_inset space \hfill{}
8623 \begin_layout Itemize
8627 \begin_inset space \hfill{}
8633 \begin_layout Standard
8637 \begin_layout Section
8641 \begin_layout Standard
8646 can be used to type letters according to German conventions.
8647 A template file is included in
8649 .../lyx/share/templates
8651 for you to use as a starting point.
8654 \begin_layout Section
8662 \begin_layout Standard
8668 \begin_layout Subsection
8672 \begin_layout Standard
8673 This is the layout file for the European Geophysical Society journals.
8678 can be downloaded from the web site of the EGS under
8679 \begin_inset Flex URL
8682 \begin_layout Plain Layout
8692 \begin_layout Subsection
8696 \begin_layout Standard
8699 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
8707 The current layout file is unfortunately very unmodular and would benefit
8708 from using the various
8715 \begin_layout Section
8719 \begin_layout Standard
8725 \begin_layout Standard
8726 Elsevier Science Publishers B.V.
8727 provides a standard LaTeX document class (
8731 ) for submitting articles to their various journals.
8732 The style file can be downloaded directly from their web site:
8733 \begin_inset Flex URL
8736 \begin_layout Plain Layout
8738 http://authors.elsevier.com/
8744 Instructions are supplied along with the class file, which details the
8745 requirements of the publishers.
8746 LyX includes package that allows for the use of this class, by a layout
8747 and a template file.
8748 Installation of the class file is the same as for any other LaTeX package;
8749 instructions are provided in the Elsevier documentation.
8752 \begin_layout Standard
8762 As the Elsevier class file is based mainly on the standard article class,
8763 most of the normal functionality is provided.
8764 The Elsevier class defines a number of mathematical environments, which
8765 are similar to the AMS environments.
8766 These commands are all described in the Elsevier documentation, and are
8770 \begin_layout Standard
8771 The easiest way to use the Elsevier style is to base documents on the included
8773 It is best not to use options such as fancy headings or the geometry package,
8774 as elements such as these are defined by Elsevier in their style file.
8775 Ideally, no extra packages except those mentioned in the Elsevier documentation
8777 Essentially, Elsevier require as
8778 \begin_inset Quotes eld
8782 \begin_inset Quotes erd
8785 a LaTeX file as possible, as their intention is to take the supplied file
8786 and replace the class file with one for the particular journal to which
8787 the paper has been submitted.
8788 This also means that not too much time should be spent on the formating
8790 When it comes to be published, this will change anyway.
8791 The rest of the usage for this layout is substantially the same as for
8792 the normal article class.
8793 For details of what Elsevier do and don't allow, refer to their documentation.
8796 \begin_layout Section
8802 \begin_inset CommandInset label
8811 \begin_layout Standard
8817 \begin_layout Subsection
8821 \begin_layout Standard
8822 This section describes how to use LyX to make slides for overhead projectors.
8823 There are two document classes that can do this: the default slides class
8829 This section documents the latter.
8832 \begin_layout Standard
8833 I'm going to say this again, nice and clear, so that there's no misunderstanding
8837 \begin_layout Standard
8838 \begin_inset VSpace bigskip
8844 \begin_layout Standard
8848 This section documents the class
8849 \begin_inset Quotes eld
8857 \begin_inset Quotes erd
8865 \begin_layout Standard
8866 \begin_inset VSpace bigskip
8872 \begin_layout Standard
8873 If you're looking for the documentation for
8874 \begin_inset Quotes eld
8882 \begin_inset Quotes erd
8886 \begin_inset space ~
8890 \begin_inset CommandInset ref
8892 reference "sec:slitex"
8897 If your machine doesn't have the
8902 \begin_inset Quotes eld
8910 \begin_inset Quotes erd
8913 ] installed, you'll probably have to use the default
8917 class, which isn't quite as good as
8922 \begin_layout Standard
8927 class is designed for use with version 2.1 of the
8931 LaTeX class file which is now an integral part of LaTeX2e.
8934 \begin_layout Subsection
8938 \begin_layout Standard
8939 Obviously, to use this document class, you need to select
8940 \begin_inset Quotes eld
8948 \begin_inset Quotes erd
8958 \begin_inset space ~
8964 There are some settings in the
8967 \begin_inset space ~
8972 dialog that you should know about that are specific to this class:
8975 \begin_layout Itemize
8976 Don't change the options
8987 \begin_inset space ~
8993 They're ignored by the
9000 \begin_layout Itemize
9001 The default font size is 20
9002 \begin_inset space \thinspace{}
9005 pt with the other options being 17
9006 \begin_inset space \thinspace{}
9010 \begin_inset space \thinspace{}
9014 \begin_inset space \thinspace{}
9020 \begin_layout Itemize
9029 but all math equations are still typeset in the usual roman font.
9032 \begin_layout Itemize
9037 supports A4 and Letter paper sizes as well as a special size for working
9039 \begin_inset space \thinspace{}
9043 It doesn't support A5, B5, legal or executive paper sizes.
9046 \begin_layout Itemize
9047 Don't bother changing the
9051 settings because they are ignored anyway.
9052 All floats appear where they are defined in the text.
9055 \begin_layout Itemize
9060 setting behaves a bit differently for this class.
9065 provides extensive footer and header capabilities including a user-defined
9068 \begin_inset space ~
9072 \begin_inset CommandInset ref
9074 reference "sec:foilfoot"
9079 The title page is treated differently to all other pages in the document
9088 has the logo centered at the bottom of the page (if one is defined).
9089 The possible page style choices and what they do are as follows:
9093 \begin_layout Labeling
9094 \labelwidthstring MMMMMMM
9101 The final output contains no page numbers, or other headers or footers
9102 (except footnotes of course).
9106 \begin_layout Labeling
9107 \labelwidthstring MMMMMMM
9114 The final output contains page numbers centered at the bottom of the page.
9115 No other headings or footers (other than footnotes).
9118 \begin_layout Labeling
9119 \labelwidthstring MMMMMMM
9124 Page numbers in lower right corner.
9125 Additional headers and footers are also shown.
9126 This is also the default.
9129 \begin_layout Labeling
9130 \labelwidthstring MMMMMMM
9135 Gives you access to the
9139 package although its use with
9143 is discouraged by the writer of the
9147 package because of some potential page layout clashes.
9151 \begin_layout Subsubsection
9155 \begin_layout Standard
9156 The following options may be used in the extra class options in the
9158 Document\SpecialChar \menuseparator
9164 \begin_layout Labeling
9165 \labelwidthstring MMMMMMx
9170 This sets up the page layout for 7.33
9171 \begin_inset space \thinspace{}
9175 \begin_inset space \thinspace{}
9178 in paper, which is about the same aspect ratio as a 35
9179 \begin_inset space \thinspace{}
9182 mm slide, making it a bit easier to work with this medium.
9185 \begin_layout Labeling
9186 \labelwidthstring MMMMMMx
9191 Places a rule across the page below the header on every page except the
9195 \begin_layout Labeling
9196 \labelwidthstring MMMMMMx
9201 Places a rule across the page above the footer on every page except the
9205 \begin_layout Labeling
9206 \labelwidthstring MMMMMMx
9211 This is automatically set each time you create a new
9220 to use the dvips driver to rotate those pages that are set as landscape
9224 \begin_layout Labeling
9225 \labelwidthstring MMMMMMx
9230 Simply changes the page dimensions to those of a landscape page but doesn't
9232 Thus if you use this option you need to use an external program to rotate
9233 each page or feed your paper through your printer as landscape.
9234 Note that this option effectively reverses the roles of the
9242 environments (don't worry these are described in the next section).
9245 \begin_layout Labeling
9246 \labelwidthstring MMMMMMx
9251 Equation numbers on the left.
9254 \begin_layout Labeling
9255 \labelwidthstring MMMMMMx
9260 Flush-left equations.
9263 \begin_layout Subsection
9264 Supported Environments
9267 \begin_layout Standard
9268 Most of the environments commonly supported in other classes are also supported
9274 There are several additional environments provided by
9278 as well as a couple added by LyX.
9279 The following environments are shared with other classes:
9282 \begin_layout Standard
9286 \begin_layout Plain Layout
9298 \begin_layout Itemize
9304 \begin_layout Itemize
9310 \begin_layout Itemize
9316 \begin_layout Itemize
9322 \begin_layout Itemize
9328 \begin_layout Itemize
9334 \begin_layout Itemize
9340 \begin_layout Itemize
9346 \begin_layout Itemize
9352 \begin_layout Itemize
9358 \begin_layout Itemize
9364 \begin_layout Itemize
9370 \begin_layout Itemize
9376 \begin_layout Itemize
9382 \begin_layout Itemize
9388 \begin_layout Itemize
9394 \begin_layout Itemize
9400 \begin_layout Itemize
9406 \begin_layout Standard
9410 \begin_layout Plain Layout
9422 \begin_layout Standard
9423 That is, all the major environments apart from the sectioning environments.
9424 Since foils are essentially self-contained sections, with a title and body,
9429 provides specific commands for starting new foils and these are:
9432 \begin_layout Itemize
9438 \begin_layout Itemize
9444 \begin_layout Standard
9445 LyX also provides slightly modified versions of these two environments called:
9448 \begin_layout Itemize
9454 \begin_layout Itemize
9460 \begin_layout Standard
9461 and the differences will be explained in the next section.
9464 \begin_layout Standard
9465 Since foils are often used in presenting ideas or new theorems and such
9470 also provides a comprehensive box of goodies for presenting them:
9473 \begin_layout Standard
9477 \begin_layout Plain Layout
9489 \begin_layout Itemize
9495 \begin_layout Itemize
9501 \begin_layout Itemize
9507 \begin_layout Itemize
9513 \begin_layout Itemize
9519 \begin_layout Itemize
9525 \begin_layout Itemize
9531 \begin_layout Itemize
9537 \begin_layout Itemize
9543 \begin_layout Itemize
9549 \begin_layout Itemize
9555 \begin_layout Standard
9559 \begin_layout Plain Layout
9571 \begin_layout Standard
9572 The starred versions are unnumbered while the unstarred versions are numbered.
9573 There are also two list environments added by LyX and these are:
9576 \begin_layout Itemize
9582 \begin_layout Itemize
9588 \begin_layout Standard
9593 provides some powerful header and footer capabilities that are best set
9594 in the preamble although they may be set at any point in a document.
9595 If you want to change these settings in your document the best place to
9596 do so is at the very top of a foil, i.
9597 \begin_inset space \thinspace{}
9603 \begin_inset space \space{}
9608 straight after the foilhead.
9611 \begin_layout Standard
9612 For this purpose, the following command styles are provided [
9619 \begin_layout Standard
9623 \begin_layout Plain Layout
9635 \begin_layout Itemize
9639 \begin_inset space ~
9645 \begin_layout Itemize
9651 \begin_layout Itemize
9655 \begin_inset space ~
9661 \begin_layout Itemize
9665 \begin_inset space ~
9671 \begin_layout Itemize
9675 \begin_inset space ~
9682 \begin_layout Standard
9683 \begin_inset space ~
9690 \begin_layout Standard
9694 \begin_layout Plain Layout
9706 \begin_layout Standard
9707 There are also a few commands provided by
9711 that aren't directly supported by LyX but I'll tell you what they do and
9712 how to use them in section
9713 \begin_inset space ~
9717 \begin_inset CommandInset ref
9719 reference "sec:unsuppfoils"
9726 \begin_layout Subsection
9727 Building a Set of Foils
9730 \begin_layout Standard
9731 This section will give a simple introduction to using the different environments
9732 to build a set of foils.
9733 If you want to see an example set of foils, take a look at the
9737 file you find in LyX's
9744 \begin_layout Subsubsection
9745 Give It a Title Page
9748 \begin_layout Standard
9749 Unlike other classes that provide
9769 creates the title on a page of its own.
9770 If you leave out the
9774 environment LaTeX will substitute the current date (every time you regenerate
9778 \begin_layout Subsubsection
9782 \begin_layout Standard
9783 As I mentioned earlier, there are four ways of starting a new foil.
9784 For portrait foils you should use
9793 The difference between these two environments is the amount of space between
9794 the title of the foil (the foilhead) and the body of the foil.
9797 \begin_layout Standard
9798 Landscape foils are generated using the
9807 Again the only difference is the spacing between foilhead and body.
9808 Both of the short versions have 0.5 inches less separation between the foilhead
9813 \begin_layout Standard
9814 One problem with the support for landscape foils is the requirement that
9819 driver to generate the PostScript output otherwise the foils won't be rotated.
9820 It is possible to get landscape foils even if you haven't got the
9824 driver provided you can feed your foils sideways through your printer ;-)
9827 \begin_layout Subsubsection
9828 Theorems, Lemmas, Proofs and more
9831 \begin_layout Standard
9832 Due to a small bug in LyX you can't have two of the same type of these environme
9833 nts directly following each other.
9834 They must be separated by something.
9835 If you try, you will just be extending the previous environment as if you
9836 had merged the two environments together.
9837 So, how do you get around this problem? The simplest option is to insert
9838 some text between the two environments or add a
9842 environment between the two with just a
9843 \begin_inset Quotes eld
9851 \begin_inset Quotes erd
9855 This will force LyX to produce two separate environments and hence the
9856 correct LaTeX output.
9857 An example is provided in the example file included with the LyX distribution.
9858 Remember, this problem only occurs if you are trying to place two of the
9859 same type of theorem-like environments one directly after the other.
9862 \begin_layout Subsubsection
9866 \begin_layout Standard
9867 You get all the commonly supported list styles found in other classes as
9868 well as two new ones.
9869 I'll only describe the new ones here.
9870 If you want to find out more about the other list environments check out
9876 If you intend to use itemized lists you might also want to read about the
9880 \begin_inset space ~
9884 \begin_inset space ~
9889 dialog described above in section
9890 \begin_inset space ~
9894 \begin_inset CommandInset ref
9896 reference "sec:bullet"
9903 \begin_layout Standard
9904 The two new list styles,
9912 , are designed to make it easier for you to create lists of do's and don'ts
9913 or right and wrong by providing dedicated environments that use a tick
9914 or a cross as the label of the list.
9915 These lists are in fact dedicated variants of the
9920 They do however require that you have the
9927 \begin_layout Subsubsection
9931 \begin_layout Standard
9936 redefines the floating tables and figures so that they appear exactly where
9937 they are in the text rather than pushing them to the top of the page or
9938 to some user specified location.
9939 In fact if you change the float placement settings they are simply ignored.
9942 \begin_layout Subsubsection
9943 Page Headers and Footers
9944 \begin_inset CommandInset label
9953 \begin_layout Standard
9957 \begin_inset space ~
9966 are two commands used to control the left-footer text string.
9967 The first is meant to allow you to include a graphic logo on your foils
9969 \begin_inset Quotes eld
9977 \begin_inset Quotes erd
9981 While the second is meant to provide a classification for the audience,
9985 \begin_inset space \thinspace{}
9991 \begin_inset space \space{}
9995 It is empty by default.
9998 \begin_layout Standard
9999 The remaining page corners can be filled by
10002 \begin_inset space ~
10007 (which defaults to page numbers),
10010 \begin_inset space ~
10018 \begin_inset space ~
10026 \begin_layout Subsection
10032 \begin_inset CommandInset label
10034 name "sec:unsuppfoils"
10041 \begin_layout Standard
10042 All the commands mentioned below need to be set in a
10050 within another environment.
10053 \begin_layout Subsubsection
10057 \begin_layout Standard
10058 All lengths are adjusted using the
10081 should be replaced by the name given to the length you want to change and
10086 is the length value.
10087 All lengths should be specified in units of length such as inches (
10099 ) or relative to some document or font-based length such as
10109 \begin_layout Standard
10110 It's possible to change the spacing between a foilhead and the body of the
10111 foil by adjusting the length specified by
10118 For example, to make
10123 \begin_inset space \space{}
10126 in closer to their bodies put the following in the preamble:
10132 foilheadskip}{-0.5in}
10135 \begin_layout Standard
10136 The spacings around floats can be adjusted by setting these lengths:
10139 \begin_layout Labeling
10140 \labelwidthstring MMMMMMMMMMM
10147 Separation between the text and the top of the float
10150 \begin_layout Labeling
10151 \labelwidthstring MMMMMMMMMMM
10158 Separation between the float and the caption
10161 \begin_layout Labeling
10162 \labelwidthstring MMMMMMMMMMM
10169 Separation between the caption and the following text
10172 \begin_layout Labeling
10173 \labelwidthstring MMMMMMMMMMM
10180 You can make the captions narrower than the surrounding text by adjusting
10182 Best done relative to
10191 \begin_layout Standard
10192 There are also several title page related lengths that you may find useful
10193 if you have a long title or several authors:
10196 \begin_layout Labeling
10197 \labelwidthstring MMMMMMMMMMM
10204 Separation from headers to
10209 \begin_layout Labeling
10210 \labelwidthstring MMMMMMMMMMM
10228 \begin_layout Labeling
10229 \labelwidthstring MMMMMMMMMMM
10243 \begin_layout Labeling
10244 \labelwidthstring MMMMMMMMMMM
10260 \begin_layout Labeling
10261 \labelwidthstring MMMMMMMMMMM
10277 \begin_layout Standard
10278 The last length related command affects all the list environments.
10289 a list environment then all the vertical spacing between the list items
10291 Note that this is a command not a length so it doesn't require
10297 like the stuff mentioned above.
10300 \begin_layout Subsubsection
10301 Headers and Footers
10304 \begin_layout Standard
10317 commands control whether the logo in the
10321 definition appear on a given page.
10328 in the preamble then none of the foils will have the logo on them.
10329 If you don't want the logo on a particular page place the
10335 directly after the foilhead of that page and the
10341 directly after the next foilhead.
10344 \begin_layout Standard
10345 If you decide to use the
10349 page style setting in the
10352 \begin_inset space ~
10357 dialog you should probably add
10367 to your preamble so headers and footers on landscape pages are correctly
10368 placed when rotated.
10369 This is due to some clashes between the page layouts provided by the
10380 \begin_layout Section
10381 Hollywood (Hollywood spec scripts)
10384 \begin_layout Standard
10390 \begin_layout Subsection
10394 \begin_layout Standard
10395 Getting the format of a Hollywood script right is a
10396 \begin_inset Quotes eld
10400 \begin_inset Quotes erd
10403 It is designed to make the readers focus on content and to be easy and
10404 familiar for the actors to read.
10405 Each page of a script should be one minute of film.
10406 Nothing goes in a script that you cannot see or hear on screen.
10407 The courier 12 pt font should be used throughout.
10411 \begin_layout Subsection
10415 \begin_layout Standard
10416 Speakers' lines should NEVER break in mid-sentence.
10417 If a speaker's lines continue over a page break, repeat the
10421 title followed by (Cont'd).
10424 \begin_layout Subsection
10428 \begin_layout Standard
10433 names as labels then cross-reference the label to insert the name.
10434 The cross-reference dialog will show the current cast of characters.
10435 You can use this to insert the speaker name in narratives also.
10438 \begin_layout Subsection
10439 Paper size and Margins
10442 \begin_layout Standard
10443 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10446 \begin_layout Subsection
10450 \begin_layout Standard
10451 The following environments are available.
10452 You can use hollywood.bind to get the bind keys shown at the right.
10455 \begin_layout Itemize
10459 \begin_inset Newline newline
10464 Used where nothing else works.
10468 \begin_layout Itemize
10474 \begin_inset space \hfill{}
10482 \begin_inset Newline newline
10485 Usually followed by something like
10486 \begin_inset Quotes eld
10489 on Sally waking up.
10490 \begin_inset Quotes erd
10496 \begin_layout Itemize
10500 \begin_inset space \hfill{}
10504 \begin_inset Newline newline
10509 Introduces a new INTERIOR camera set-up.
10510 Always followed by DAY or NIGHT, or something similar to define the lighting
10512 Everthing on this line in CAPS.
10515 \begin_layout Itemize
10519 \begin_inset space \hfill{}
10523 \begin_inset Newline newline
10528 Introduces a new EXTERIOR camera set-up.
10529 Everthing on this line in CAPS.
10532 \begin_layout Itemize
10536 \begin_inset space \hfill{}
10540 \begin_inset Newline newline
10545 The character speaking.
10548 \begin_layout Itemize
10552 \begin_inset space \hfill{}
10556 \begin_inset Newline newline
10561 Instructions to the speaker.
10562 The () are automatically inserted, but only the ( will show in LyX.
10563 Both will be printed.
10566 \begin_layout Itemize
10570 \begin_inset space \hfill{}
10574 \begin_inset Newline newline
10586 \begin_layout Itemize
10590 \begin_inset space \hfill{}
10594 \begin_inset Newline newline
10599 Camera movement instruction.
10601 \begin_inset space \thinspace{}
10605 \begin_inset space \space{}
10611 \begin_layout Itemize
10615 \begin_inset space \hfill{}
10621 \begin_layout Itemize
10625 \begin_inset space \hfill{}
10631 \begin_layout Itemize
10635 \begin_inset space \hfill{}
10641 \begin_layout Itemize
10645 \begin_inset space \hfill{}
10651 \begin_layout Subsection
10655 \begin_layout Itemize
10656 (O.S) — off screen
10659 \begin_layout Itemize
10660 (V.0) — voice over
10663 \begin_layout Itemize
10665 \begin_inset space \thinspace{}
10672 \begin_layout Itemize
10677 \begin_layout Itemize
10678 PAN — camera movement
10681 \begin_layout Itemize
10682 INSERT — cut to close-up of
10685 \begin_layout Section
10689 \begin_layout Standard
10692 Panayotis Papasotiriou
10695 \begin_layout Subsection
10699 \begin_layout Standard
10700 The ijmpc package is a set of macros that facilitates electronic manuscript
10703 International Journal of Modern Physics C
10706 Similarly, the ijmpd package is for creating manuscripts to be submitted
10709 International Journal of Modern Physics D
10712 Both journals are published by World Scientific.
10713 The corresponding document classes are named
10722 These files, together with instructions for the authors, can be downloaded
10724 \begin_inset Flex URL
10727 \begin_layout Plain Layout
10729 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
10735 \begin_inset Flex URL
10738 \begin_layout Plain Layout
10740 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
10746 Both packages are modified versions of the standard
10747 \begin_inset Quotes eld
10751 \begin_inset Quotes erd
10754 package, and they are almost (but not exactly) identical.
10755 Most of their features are supported by LyX.
10756 I have used LyX successfully to write articles submitted to both journals
10757 without any problem.
10760 \begin_layout Subsection
10764 \begin_layout Standard
10765 As usual, the easiest way to write a paper is to start with a template.
10768 File\SpecialChar \menuseparator
10787 This will give an (almost) empty document that includes the most common
10788 fields found in a manuscript.
10789 Simply overwrite the existing text (including the brackets,
10794 You should keep in mind the following remarks.
10797 \begin_layout Enumerate
10798 LyX won't let you change the font size and the page style of the document,
10799 because such modifications are not allowed by both packages.
10802 \begin_layout Enumerate
10803 The language of the document should not be changed.
10804 Before previewing your paper, be sure that the babel package is not used.
10805 To do this, click on
10807 Tools\SpecialChar \menuseparator
10818 checkbox in the language settings, and click on
10826 , if you wish to make this change permanent).
10829 \begin_layout Enumerate
10831 \begin_inset Quotes eld
10835 \begin_inset Quotes erd
10838 style must be used to define keywords.
10841 \begin_layout Enumerate
10842 The ijmpc package provides a style named
10843 \begin_inset Quotes eld
10846 Classification Codes
10847 \begin_inset Quotes erd
10850 , which can be used to define classification codes, such as PACS numbers.
10851 Note that this facility is not supported by the ijmpd package.
10854 \begin_layout Enumerate
10855 Several new environments are available:
10856 \begin_inset Quotes eld
10860 \begin_inset Quotes erd
10864 \begin_inset Quotes eld
10868 \begin_inset Quotes erd
10872 \begin_inset Quotes eld
10876 \begin_inset Quotes erd
10880 \begin_inset Quotes eld
10884 \begin_inset Quotes erd
10888 \begin_inset Quotes eld
10892 \begin_inset Quotes erd
10896 \begin_inset Quotes eld
10900 \begin_inset Quotes erd
10904 \begin_inset Quotes eld
10908 \begin_inset Quotes erd
10912 \begin_inset Quotes eld
10916 \begin_inset Quotes erd
10920 \begin_inset Quotes eld
10924 \begin_inset Quotes erd
10928 \begin_inset Quotes eld
10932 \begin_inset Quotes erd
10936 \begin_inset Quotes eld
10940 \begin_inset Quotes erd
10944 \begin_inset Quotes eld
10948 \begin_inset Quotes erd
10952 \begin_inset Quotes eld
10956 \begin_inset Quotes erd
10960 \begin_inset Quotes eld
10964 \begin_inset Quotes erd
10968 Their use is more or less obvious.
10969 LyX supports all these environments; it will use the proper label, text
10970 style, and numbering scheme for each of them.
10973 \begin_layout Enumerate
10974 Both packages use basic citations; the natbib package should not be used.
10975 In LyX, citation references are shown as usual; in the output, citations
10976 are shown as superscripts.
10977 If you want to use a citation as normal text, you should use the
10982 \begin_inset space \thinspace{}
10986 \begin_inset space \space{}
10990 \begin_inset Quotes eld
10994 \begin_inset space \space{}
11004 \begin_inset Quotes erd
11010 \begin_layout Enumerate
11012 \begin_inset Quotes eld
11016 \begin_inset Quotes erd
11019 section in both packages.
11020 To put acknowledgments, just use the
11021 \begin_inset Quotes eld
11025 \begin_inset Quotes erd
11031 \begin_layout Enumerate
11032 Appendices may be added to the paper,
11036 the Acknowledgments and
11041 LyX provides a special environment, called
11042 \begin_inset Quotes eld
11046 \begin_inset Quotes erd
11049 which marks the beginning of the appendices.
11050 This environment should be left blank; it just sends a LaTeX command, but
11051 nothing is really printed.
11053 \begin_inset Quotes eld
11057 \begin_inset Quotes erd
11060 is printed with blue letters, as a signal that all sections after that
11061 point are appendices.
11062 To write an appendix, use the
11063 \begin_inset Quotes eld
11067 \begin_inset Quotes erd
11071 LyX will number each appendix with capital letters, as required by both
11074 \begin_inset Quotes eld
11078 \begin_inset Quotes erd
11085 be present before the first appendix; if not, all appendices will be numbered
11086 as normal sections in the output.
11089 \begin_layout Enumerate
11090 The ijmpc and the ijmpd packages use the
11094 command to implement table captions.
11095 As a result, a table created by LyX is printed correctly, but its caption
11097 However, you can use some TeX code to overpass this problem, so that captions
11098 are printed as expected.
11099 To do so, create a float table as usual, remove the caption, and replace
11100 it with the TeX code
11110 (sic); you must also the TeX code
11114 immediately after the tabular material.
11115 Study the example table included in the template files to see how this
11116 trick is implemented.
11117 Alternatively, If you need table captions, you should implement the whole
11122 file, then include this file to the LyX document (
11124 Insert\SpecialChar \menuseparator
11125 File\SpecialChar \menuseparator
11127 \begin_inset space ~
11133 Details on how to create a table float can be found in the files
11141 , included in the corresponding packages.
11144 \begin_layout Subsection
11145 Preparing a paper for submission
11148 \begin_layout Standard
11149 Before you submit your paper you must export the LyX document as a LaTeX
11152 File\SpecialChar \menuseparator
11153 Export\SpecialChar \menuseparator
11160 \begin_layout Plain Layout
11161 Actually you have the choice between LaTeX (plain) and pdflatex.
11162 If you intend to use pdflatex to prepare the paper, you should use the
11163 pdflatex option so that included graphics are converted to PDF format,
11164 ready for use by pdflatex.
11169 , then make the following changes to the resulting
11176 \begin_layout Enumerate
11177 Remove the comment lines before the
11186 \begin_layout Enumerate
11187 Remove everything between (and including) the
11199 commands, except for any commands you specifically put into the LaTeX preamble.
11202 \begin_layout Standard
11207 file should be saved and processed through LaTeX as many times as necessary.
11208 You may also want to check the resulting
11215 \begin_layout Subsection
11219 \begin_layout Standard
11220 The use of TeX code is reduced to two commands, which must be placed at
11221 the top of the document.
11222 If you started writing your paper by using the
11230 template, the TeX code needed is already in its place; you usually don't
11232 You may only modify the first TeX code to specify the information printed
11233 to the top of odd and even pages (authors' names and short paper's title,
11235 This TeX code must have the form
11239 markboth{Authors' Names}{Short Paper's Title}
11244 \begin_layout Section
11248 \begin_layout Standard
11254 \begin_layout Subsection
11258 \begin_layout Standard
11259 The iopart package provides a document class to create electronic manuscript
11260 submission to the journals published by the Institute of Physics.
11261 Instructions for the authors how to create a paper using the iopart class
11262 can be downloaded together with the iopart package from the site
11263 \begin_inset Flex URL
11266 \begin_layout Plain Layout
11268 ftp://ftp.iop.org/pub/journals/latex2e
11276 \begin_layout Subsection
11280 \begin_layout Standard
11281 The easiest way to write a paper is to start with the file
11285 that is available in LyX's examples files folder.
11286 Open this file, save it under a new name, and start writing.
11287 The example file explains how to use the special text environments.
11288 Here are the most important advices:
11291 \begin_layout Itemize
11292 To be able to compile your document to a PDF, PS, or DVI, assure that the
11295 Use AMS math package
11297 in the document settings under
11304 \begin_layout Itemize
11307 The title environment defines the kind of your paper.
11308 So use one of the following environments for the title:
11312 \begin_layout Itemize
11321 \begin_layout Itemize
11330 \begin_layout Itemize
11336 for a Topical review
11339 \begin_layout Itemize
11348 \begin_layout Itemize
11357 \begin_layout Itemize
11363 for a Paper (same as Title)
11366 \begin_layout Itemize
11372 for a Preliminary communication
11375 \begin_layout Itemize
11381 for a Rapid communication
11384 \begin_layout Itemize
11390 for a Letter to the editor
11394 \begin_layout Itemize
11397 All title environments except of
11401 can have an optional short title.
11404 \begin_layout Itemize
11405 There is a general title environment
11409 which is not directly supported by the LyX.
11410 This can be used as TeX code when your document doesn't fit into one of
11411 the other title types.
11414 \begin_layout Standard
11415 For more informations like hints for special table and formula formatting,
11416 look at the IOP author guidelines.
11419 \begin_layout Section
11423 \begin_layout Standard
11426 Panayotis Papasotiriou
11429 \begin_layout Subsection
11433 \begin_layout Standard
11434 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
11435 that facilitates electronic manuscript submission to the journals they
11437 Most known of them (at least in my domain of interest) are
11439 Astrophysics and Space Science
11445 , but there are many others (see a complete list at
11446 \begin_inset Flex URL
11449 \begin_layout Plain Layout
11451 http://www.wkap.nl/jrnllist.htm/JRNLHOME
11457 The Kluwer package may be downloaded from the site
11458 \begin_inset Flex URL
11461 \begin_layout Plain Layout
11463 http://www.wkap.nl/kaphtml.htm/STYLEFILES
11469 A complete user guide is contained in that package (but it can also be
11470 downloaded separately).
11473 \begin_layout Standard
11474 LyX supports many features of the package but not everything.
11475 However, the TeX code needed is reduced to some
11476 \begin_inset Quotes eld
11480 \begin_inset Quotes erd
11483 commands of the package (see
11484 \begin_inset space ~
11488 \begin_inset CommandInset ref
11490 reference "subsec:kluwer_peculiarities"
11495 I have recently used LyX to write an article submitted to the
11497 Astrophysics and Space Science
11499 without any problem.
11502 \begin_layout Subsection
11506 \begin_layout Standard
11507 The easiest way to write a paper is to start with the Kluwer template file.
11510 File\SpecialChar \menuseparator
11522 This will give an (almost) empty document that includes the most common
11523 fields found in a manuscript and a short description of their use.
11524 As in most templates, simply overwrite the existing text (including the
11529 ) with the correct information.
11532 \begin_layout Subsection
11533 Preparing a paper for submission
11536 \begin_layout Standard
11537 As in the AASTeX package, before you submit your paper to a journal you
11539 \begin_inset Quotes eld
11543 \begin_inset Quotes erd
11549 \begin_layout Enumerate
11550 Export your paper as a LaTeX file.
11551 To do this, click on
11553 File\SpecialChar \menuseparator
11554 Export\SpecialChar \menuseparator
11561 \begin_layout Enumerate
11566 file with a text editor and make the following changes
11570 \begin_layout Enumerate
11571 remove the comment lines before the
11580 \begin_layout Enumerate
11581 remove everything between (and including) the
11593 commands, except for any commands you specifically put into the LaTeX preamble.
11596 \begin_layout Standard
11605 \begin_layout Enumerate
11610 file through LaTeX as many times as necessary (usually up to three).
11613 \begin_layout Enumerate
11619 \begin_inset space \thinspace{}
11623 \begin_inset space \space{}
11630 , and check if everything is OK (it should, if you didn't make any mistake).
11633 \begin_layout Subsection
11634 \begin_inset Quotes eld
11638 \begin_inset Quotes erd
11641 of the Kluwer package
11642 \begin_inset CommandInset label
11644 name "subsec:kluwer_peculiarities"
11651 \begin_layout Standard
11652 The Kluwer package has the following
11653 \begin_inset Quotes eld
11657 \begin_inset Quotes erd
11663 \begin_layout Enumerate
11664 It is possible to write multiple articles in the same LaTeX file
11668 \begin_layout Plain Layout
11669 I can't imagine any good reason to do this.
11675 Each article must be included in the environment
11676 \begin_inset Quotes eld
11680 \begin_inset Quotes erd
11684 Unfortunately, this environment cannot be omitted, even if you write just
11686 Therefore, each article starts with the command
11692 and, obviously, ends with the command
11699 Although this can be implemented in LyX, I didn't included it, since it
11700 looks ugly and can confuse the novice user.
11701 Therefore, you need to enter them directly and mark them as LaTeX code
11703 \begin_inset Quotes eld
11707 \begin_inset Quotes erd
11713 \begin_layout Enumerate
11714 Information given at the beginning of the article (i.
11715 \begin_inset space \thinspace{}
11719 \begin_inset space \space{}
11722 title, subtitle, author, institution, running title, running author, abstract
11723 and keywords) must be included in an environment called
11724 \begin_inset Quotes eld
11728 \begin_inset Quotes erd
11732 This is not implemented in LyX, so you must enter title, subtitle etc.
11733 \begin_inset space ~
11736 between two TeX code lines (
11751 \begin_layout Enumerate
11752 According to the user manual, the label of each bibliography item must be
11776 \begin_layout Standard
11781 template takes care of all these
11782 \begin_inset Quotes eld
11786 \begin_inset Quotes erd
11790 If you start a new paper using this template you don't need to do anything
11795 \begin_layout Enumerate
11796 don't delete the TeX code included in the template, and
11799 \begin_layout Enumerate
11800 copy the example bibliography item included in the template and modify it
11801 as necessary to enter new bibliography items.
11804 \begin_layout Section
11808 \begin_layout Standard
11814 \begin_layout Subsection
11818 \begin_layout Standard
11819 The LyX document classes
11821 article (koma-script)
11825 report (koma-script)
11843 correspond to the LaTeX document classes
11860 \begin_inset space ~
11863 of the Koma-Script family.
11864 They are replacements for the standard document classes
11880 , resp., and fit better to European typography conventions in a number of
11884 \begin_layout Itemize
11885 Standard character size is 11pt in
11887 article (koma-script)
11891 report (koma-script)
11899 letter (koma-script)
11904 \begin_layout Itemize
11905 Headings, labels of the description environment, and a number of elements
11908 letter (koma-script)
11910 document class are set in a bold sans serif font.
11914 \begin_layout Plain Layout
11915 There is a big difference between the bold sans serif old cm fonts and new
11916 ec fonts, especially in the appearance of headings.
11917 In comparison, the ec bold sans serif fonts look a bit thin.
11918 Here the LaTeX package
11926 helps to produce the
11927 \begin_inset Quotes eld
11931 \begin_inset Quotes erd
11934 appearance when using the ec fonts.
11939 The numbering of chapter headings is made in the same way as the numbering
11940 of section headings, that is without the extra line
11941 \begin_inset Quotes eld
11944 Chapter\SpecialChar \ldots{}
11946 \begin_inset Quotes erd
11950 In addition, the appearance of the headings can be modified by using a
11951 number of options (in LyX to be entered in the field
11954 \begin_inset space ~
11961 Layout\SpecialChar \menuseparator
11965 A detailed German description of these options can be found in the Koma-Script
11973 \begin_layout Itemize
11974 The main means in the Koma-Script document classes to design the type area
11983 (in LyX to be entered in the extra class options field in the dialog
11985 Document\SpecialChar \menuseparator
11989 They make a clearer modification of page margins possible as do the options
11992 Document\SpecialChar \menuseparator
11996 A detailed German description of these and other type area options can
11997 be found in the Koma-Script documentation
12004 \begin_layout Itemize
12005 The LaTeX document classes of the Koma-Script family define a number of
12006 additional commands.
12007 Those part of it which makes sense in LyX is implemented in corresponding
12011 \begin_layout Standard
12012 A detailed German description of the LaTeX document classes of the Koma-Script
12013 family can be found in the Koma-Script documentation
12021 \begin_layout Plain Layout
12022 There is an English translation
12026 , but it is not a complete one.
12031 The following sections describe only those aspects, which are relevant
12035 \begin_layout Subsection
12036 article (koma-script), report (koma-script), and book (koma-script)
12039 \begin_layout Standard
12040 The document classes
12042 article (koma-script)
12046 report (koma-script)
12056 are implemented in the layout files
12069 They contain all the paragraph types of the corresponding standard document
12082 , resp., partly modified, with the exception of the LyX specific
12086 -type, which is replaced by the new
12090 -type having the same functionality.
12095 -Type there is a number of new paragraph types added.
12102 letter (koma-script)
12107 \begin_layout Itemize
12116 : are equivalents to
12124 , resp., additionally inserting an entry in the table of contents.
12133 are not contained in
12135 article (koma-script)
12140 \begin_layout Itemize
12149 : behave exactly as
12157 , resp., additionally clearing running heads.
12162 is not contained in
12164 article (koma-script)
12170 \begin_layout Plain Layout
12183 report (koma-script)
12185 , but since this is identical to
12189 , is has not been implemented in LyX.
12197 \begin_layout Itemize
12202 : generates a heading directly above the following paragraph in the standard
12203 character size without affecting the structure of the document.
12206 \begin_layout Itemize
12215 are special captions which respect the different space settings needed
12216 for captions placed above or below an element (if you follow strict typographic
12217 rules, you might want to place table captions always above the table).
12218 You can also use the class option
12222 , which will switch
12235 You need at least Koma-Script version 2.8q to use this.
12238 \begin_layout Itemize
12243 : can be used to set a bonmot, e.
12244 \begin_inset space \thinspace{}
12248 \begin_inset space \space{}
12251 at the beginning of a chapter.
12252 If you use the optional argument (
12254 Insert\SpecialChar \menuseparator
12256 \begin_inset space ~
12261 ), you can insert the dictum's author there.
12262 Dictum and author are separated by a line.
12263 You need at least Koma-Script version 2.8q to use this.
12268 is not contained in
12270 article (koma-script)
12275 \begin_layout Standard
12276 The following types, together with the standard types
12288 , form the title area of the document.
12289 They must be entered ahead of the first
12290 \begin_inset Quotes eld
12294 \begin_inset Quotes erd
12301 \begin_layout Plain Layout
12302 The corresponding LaTeX commands must appear before the
12313 When such a type is used more than once, the latter usage overwrites the
12314 former one, that means, for every type only the latest usage is valid.
12315 The order of the different types however has, like
12327 , no effect on the appearance of the produced document.
12330 \begin_layout Itemize
12335 : produces a centered paragraph above the ordinary title (
12347 ) for the subject of the document.
12350 \begin_layout Itemize
12355 : produces a centered paragraph below the ordinary title (
12367 ) for the publishers' name.
12370 \begin_layout Itemize
12377 report (koma-script)
12383 produces a centered paragraph on its own page behind the title page, or
12386 article (koma-script)
12388 produces a centered paragraph below the ordinary title (
12404 ) for a dedication.
12407 \begin_layout Itemize
12412 : produces a left aligned paragraph above the ordinary title (
12428 ) for a document`s head.
12431 \begin_layout Itemize
12436 : produces in a double-sided print in
12438 report (koma-script)
12444 a left-aligned paragraph at the top of the title page`s back or has no
12445 effect in a single-sided print or in
12447 article (koma-script)
12452 \begin_layout Itemize
12457 : produces in a double-sided print in
12459 report (koma-script)
12465 a left-aligned paragraph at the bottom of the title page`s back or has
12466 no effect in a single-sided print or in
12468 article (koma-script)
12473 \begin_layout Itemize
12478 : produces a special
12479 \begin_inset Quotes eld
12483 \begin_inset Quotes erd
12486 page ahead of the actual document containing a paragraph without special
12490 \begin_layout Standard
12491 The layout files for the document classes
12493 article (koma-script)
12497 report (koma-script)
12503 do include the file
12508 This is thought of as a place to define your own types.
12513 in your personal layout directory and edit the file!
12516 \begin_layout Subsection
12517 letter (koma-script)
12520 \begin_layout Standard
12524 \begin_layout Plain Layout
12536 \begin_layout Standard
12540 letter (koma-script)
12542 is implemented in the layout file
12547 It contains all the paragraph types of the corresponding standard document
12552 , partly modified, with the exception of the LyX specific types
12564 type, which is replaced by the new
12569 In addition, it contains, in contrast to the standard document class, the
12587 Furthermore, there are a number of new letter specific types.
12590 \begin_layout Standard
12594 \begin_layout Plain Layout
12606 \begin_layout Standard
12607 The appearance of the letter produced by this document class can be controlled
12608 by a number of LaTeX commands, which you can put in the LaTeX preamble.
12612 \begin_layout Plain Layout
12613 For example, the standard appearance of the letter`s heading, consisting
12614 of name and address, is quite self-willed.
12616 \begin_inset Quotes eld
12620 \begin_inset Quotes erd
12623 heading is produced by the following LaTeX commands in the preamble:
12626 \begin_layout LyX-Code
12636 \begin_layout LyX-Code
12652 \begin_layout LyX-Code
12662 \begin_layout LyX-Code
12682 A detailed German description of such LaTeX commands can be found in the
12683 Koma-Script documentation
12688 With it, the letter's author can produce his personal letter layout.
12691 \begin_layout Standard
12700 define the beginning of the letter and must be used in every letter.
12701 To emphasize them in the LyX document class, they are marked with the letter
12711 \begin_inset space ~
12714 in the left margin.
12715 It is possible to write any number of letters in one file.
12720 type produces a new letter using the same addressee and a
12724 type produces a new addressee.
12741 are ordinary paragraph types and can also be used several times in one
12742 and the same letter.
12745 \begin_layout Itemize
12750 : produces a paragraph for the addressee and implicitly defines the beginning
12754 \begin_layout Itemize
12759 : produces a paragraph for the form of address and implicitly produces a
12763 \begin_layout Itemize
12768 : produces a paragraph for a close.
12771 \begin_layout Itemize
12776 : produces a paragraph for a postscript.
12779 \begin_layout Itemize
12784 : produces a paragraph for a distribution list.
12787 \begin_layout Itemize
12792 : produces a paragraph for enclosures.
12795 \begin_layout Standard
12836 are input types provided with a label to enter information, which will
12837 be processed by the document class.
12841 \begin_layout Plain Layout
12842 It could be seen as a matter of inconsequence, that the types
12850 described above are not such input types as well.
12851 Because of the special meaning of those types, however, I have implemented
12852 them as ordinary paragraph types with a one letter mark in the left margin.
12853 Moreover, it would affect my feeling of symmetry, if the
12861 type had such a serious different appearance.
12866 The types must be used ahead of the corresponding
12873 \begin_layout Standard
12874 An implementation of these types in a WYSIWYG fashion does not seem to make
12875 sense, because the real appearance of the produced letter does not only
12876 depend on the usage of the particular type, but also on other factors.
12877 For example, a signature entered in the
12881 type will in the standard behavior appear in the produced letter only,
12882 when in the same letter also a
12887 The entered value of the
12891 type will in the standard behavior not appear in the produced letter at
12893 The possibility to design the letter`s heading freely is already indicated
12894 in a footnote above.
12897 \begin_layout Standard
12898 The input types can also be used as empty paragraphs.
12899 This makes sense e.
12900 \begin_inset space \thinspace{}
12904 \begin_inset space \space{}
12916 type is not used at all, in the standard behavior the value of the
12920 type is used as signature, whereas if an empty
12924 type is used, no signature value is defined.
12927 \begin_layout Standard
12928 By using the input types it is possible to write a letter template, containing
12929 filled input types with your personal dates (name, address, etc.) and empty
12930 input types for other dates you want to enter.
12933 \begin_layout Itemize
12938 : sender's name, in the standard behavior appears as a centered paragraph
12939 in small caps in the letter`s heading.
12942 \begin_layout Itemize
12947 : sender's signature, in the standard behavior appears below the
12956 type is used, the value of the
12960 type appears instead.
12963 \begin_layout Itemize
12968 : sender's address, in the standard behavior appears in a centered paragraph
12969 in the letter`s heading below the sender's name.
12972 \begin_layout Itemize
12977 : sender's telephone number, in the standard behavior only sets the LaTeX
12987 \begin_layout Itemize
12992 : place of the letter`s making.
12995 \begin_layout Itemize
13000 : date of the letter`s making.
13009 , in the standard behavior, produce the place and the date in a right-aligned
13010 line below the addressee's field.
13015 type is used, neither place nor date appear, independent of the value of
13025 type is used, the date of the letter `s production is used.
13028 \begin_layout Itemize
13033 : sender`s back address, in the standard behavior appears above the addressee's
13034 field in a small sans serif font.
13037 \begin_layout Itemize
13042 : special mail information, in the standard behavior appears underlined
13043 above the addressee's field below the back address.
13046 \begin_layout Itemize
13051 : additional information, in the standard behavior appears on right side
13052 below the addressee`s field.
13055 \begin_layout Itemize
13060 : the letter's title, in the standard behavior appears in a big, bold, sans
13061 serif font above the subject.
13064 \begin_layout Itemize
13069 : the letter's subject, in the standard behavior appears in a bold font
13077 \begin_layout Standard
13098 produce a business letter like line above the
13102 line containing the fields
13103 \begin_inset Quotes eld
13107 \begin_inset Quotes erd
13111 \begin_inset Quotes eld
13115 \begin_inset Quotes erd
13119 \begin_inset Quotes eld
13123 \begin_inset Quotes erd
13127 \begin_inset Quotes eld
13131 \begin_inset Quotes erd
13135 \begin_inset Quotes eld
13139 \begin_inset Quotes erd
13143 \begin_inset Quotes eld
13147 \begin_inset Quotes erd
13151 For the date field, the value of the
13157 \begin_inset Quotes eld
13160 business letter types
13161 \begin_inset Quotes erd
13164 is used, the value of the
13168 type however does not appear, but only the LaTeX variable
13175 The ordinary output of place and date in a right-aligned line below the
13176 addressee`s field is suppressed.
13177 The types are implemented as input types provided with a label and must
13178 be used ahead of the corresponding
13185 \begin_layout Itemize
13193 \begin_layout Itemize
13201 \begin_layout Itemize
13209 \begin_layout Itemize
13217 \begin_layout Itemize
13225 \begin_layout Subsection
13226 The new letter class: letter (koma-script v.2)
13229 \begin_layout Standard
13232 Jürgen Spitzmüller
13235 \begin_layout Standard
13236 \begin_inset VSpace medskip
13242 \begin_layout Standard
13244 Koma-Script version 2.8 has introduced a new letter class
13248 which supersedes the now unsupported
13253 It has — on the LaTeX side — a completely new interface and is not compatible
13254 with the old class.
13255 Therefore, LyX supports both, though it is recommended to use the new class.
13258 \begin_layout Standard
13259 This class covers the same functionality as
13261 letter (koma-script),
13264 The basic items are
13268 (receiver's address, same as
13272 in the old layout),
13285 will start a new letter (i.
13286 \begin_inset space \thinspace{}
13290 \begin_inset space \space{}
13293 you can write several letters per document).
13294 New elements are sender's
13310 and the possibility to use a
13316 Insert\SpecialChar \menuseparator
13322 \begin_layout Standard
13323 The biggest improvement is, though, that the letter's layout is configurable
13324 at almost any needs.
13325 This can be done via the preamble or with a special style file (Letter
13326 Class Option, extension
13330 ), that will be read in as a class option.
13334 \begin_layout Plain Layout
13335 The KOMA package comes with some default
13340 There is, for instance, a
13344 file that follows german typesetting rules, or a
13348 that provides the default layout of the old
13353 The latter can be loaded with the class option
13362 ayout\SpecialChar \menuseparator
13367 ocument\SpecialChar \menuseparator
13379 template that is included in LyX for examples.
13380 A detailed description is to be found in the Koma-Script documentation
13388 \begin_layout Subsection
13392 \begin_layout Standard
13393 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
13397 \begin_layout Itemize
13398 The chapter number of a
13402 type appears on a line of its own above the chapter heading instead of
13403 appearing in the same line ahead of it.
13404 The cause for that is the LyX internal behavior for the labeltype
13408 in the layout file.
13411 \begin_layout Itemize
13412 The headings of the types
13420 are only put in the
13421 \begin_inset Quotes eld
13425 \begin_inset Quotes erd
13428 LaTeX table of contents, but not in the LyX table of contents (
13430 Document\SpecialChar \menuseparator
13432 \begin_inset space ~
13436 \begin_inset space ~
13444 \begin_layout Itemize
13445 The paragraphs in a
13449 document class appear in a skip separation mode, not indented.
13450 This is the standard behavior, no special LaTeX commands are needed for
13454 Document\SpecialChar \menuseparator
13457 dialog the corresponding radio button indicates
13466 value always has the effect that extra LaTeX commands are inserted in the
13467 document to produce the gap, which is not what is wanted in this case.
13470 \begin_layout Section
13471 Latex8 (IEEE Conference Papers)
13474 \begin_layout Standard
13480 \begin_layout Subsection
13484 \begin_layout Standard
13485 Since this class is specifically for writing submissions to IEEE sponsored
13486 conferences I strongly recommend that you get a copy of their Authors Kit.
13491 package and associated bibliography style file is included in the kit.
13492 The Authors Kit is usually sent out by email once your initial submission
13494 There is a lot of useful information in the Authors Kit explaining formatting
13495 restrictions and so on and I will assume you have read this since that
13496 means I don't have to repeat it all here.
13499 \begin_layout Subsection
13503 \begin_layout Standard
13504 [AR\SpecialChar \@.
13508 \begin_layout Subsection
13509 Supported Environments
13512 \begin_layout Itemize
13518 \begin_layout Itemize
13524 \begin_layout Itemize
13530 \begin_layout Itemize
13536 \begin_layout Itemize
13542 \begin_layout Itemize
13548 \begin_layout Itemize
13554 \begin_layout Itemize
13560 \begin_layout Itemize
13566 \begin_layout Subsection
13567 Differences Between Screen and Paper
13570 \begin_layout Standard
13571 There are slight differences in appearance mainly with the presentation
13572 of section counters.
13573 On screen the trailing period of the section counter is missing but it
13574 will appear in the output so don't let this worry you.
13577 \begin_layout Section
13581 \begin_layout Standard
13584 Jürgen Spitzmüller
13587 \begin_layout Subsection
13591 \begin_layout Standard
13592 Memoir is a very powerful and constantly evolving class.
13593 It has been designed with regard to fictional and non-fictional literature.
13594 Its aim is to let the user have maximum control over the typesetting of
13596 Memoir is based on the standard book class, but it can also emulate the
13597 article class (see below).
13600 \begin_layout Standard
13601 Peter Wilson, the developer of Memoir, is known as the author of lots of
13602 useful packages in the LaTeX world.
13603 Most of them have been merged with Memoir.
13604 Therefore, it is much easier to layout the table of contents, appendices,
13605 chapter designs and such.
13606 LyX, though, does not support all of these goodies natively.
13607 Some of them might be added to forthcoming releases
13611 \begin_layout Plain Layout
13612 You are invited to send suggestions to
13613 \begin_inset Flex URL
13616 \begin_layout Plain Layout
13618 lyx-devel@lists.lyx.org
13628 , lots will probably never, due to the limitations of LyX's framework.
13629 Of course you can still use all features with the help of some native LaTeX
13634 \begin_layout Plain Layout
13639 \begin_layout Plain Layout
13649 \begin_inset space ~
13653 \begin_inset CommandInset ref
13655 reference "sec:Inserting-TeX-Code"
13665 In this section, we can only list those features which are natively supported
13667 For detailed descriptions (and for the rest of features) we are recommending
13668 to have a look at the detailed manual of the Memoir class
13672 \begin_layout Plain Layout
13677 \begin_layout Plain Layout
13687 \begin_inset Flex URL
13690 \begin_layout Plain Layout
13692 CTAN:/macros/latex/memoir/memman.pdf
13702 , which is not only a user guide for the class, but also both a comprehensive
13703 description on good typesetting and a superb example for good typesetting
13707 \begin_layout Subsection
13708 Basic features and restrictions
13711 \begin_layout Standard
13712 Memoir supports basically all features of the standard book classes.
13713 There are, however, some differences, as follows:
13716 \begin_layout Description
13718 \begin_inset space ~
13721 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
13724 \begin_layout Description
13726 \begin_inset space ~
13729 style: The fancy page style is not supported, due to a command clash between
13730 Memoir and the fancyhdr package (they are both defining a command with
13731 the same name, which confuses LaTeX).
13732 Instead, Memoir comes with a bunch of own page styles (see
13734 Layout\SpecialChar \menuseparator
13735 Document\SpecialChar \menuseparator
13737 \begin_inset space ~
13743 If you want to use these for the chapter pages, you have to use the command
13750 in the main text or in preamble (e.
13751 \begin_inset space \thinspace{}
13755 \begin_inset space \space{}
13762 chapterstyle{companion}
13767 \begin_layout Description
13768 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13769 an optional argument in the standard classes.
13770 With this, you can specify an alternative version of the title for the
13771 table of contents and the headers (for instance, if the title is too long).
13772 In LyX, you can do this via
13774 Insert\SpecialChar \menuseparator
13776 \begin_inset space ~
13781 at the beginning of a chapter/section.
13782 Memoir features a second optional argument and thus separates the table
13783 of contents from the header.
13784 You can define three variants of a title with this: one for the main text,
13785 one for the table of contents, and one for the headers.
13786 Simply insert two optional arguments if you need this feature, the first
13787 one containing the short title for the Table of Contents, the second one
13788 containing an alternative short title for the headers.
13791 \begin_layout Description
13792 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13793 of contents, the list of figures and the list of table start a new page
13795 Memoir does not follow this route.
13796 You have to insert a page break yourself, if you want to have one.
13799 \begin_layout Description
13800 Titlepage: For some unknown reason, Memoir uses pagination on the title
13801 page (in the standard classes, title pages are
13802 \begin_inset Quotes eld
13806 \begin_inset Quotes erd
13810 \begin_inset space \thinspace{}
13814 \begin_inset space \space{}
13818 If you want an empty title page, type
13822 aliaspagestyle{title}{empty}
13827 \begin_layout Description
13828 Article: With the class option
13834 Layout\SpecialChar \menuseparator
13835 Document\SpecialChar \menuseparator
13837 \begin_inset space ~
13842 ), you can emulate article style.
13843 That is, counters (footnotes, figures, tables etc.) will not be reset on
13844 new chapters, chapters don't start a new page (but are—in contrary to
13845 \begin_inset Quotes eld
13849 \begin_inset Quotes erd
13852 article classes—still allowed), parts, though, use their own page, as in
13856 \begin_layout Description
13857 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
13858 font commands, which have been used in the old LaTeX version 2.09 (e.
13859 \begin_inset space \thinspace{}
13863 \begin_inset space \space{}
13879 It produces an error and stops LaTeX whenever such a command appears.
13884 reallows the commands and spits out warnings instead (which does at least
13886 Since a lot of packages and particularly BibTeX style files are still using
13887 those commands, we have decided to use this option by default.
13890 \begin_layout Subsection
13894 \begin_layout Standard
13895 We will only describe the features supported by LyX (which is not much currently
13897 Please consult the Memoir manual
13901 \begin_layout Plain Layout
13906 \begin_layout Plain Layout
13916 \begin_inset Flex URL
13919 \begin_layout Plain Layout
13921 CTAN:/macros/latex/memoir/memman.pdf
13934 \begin_layout Description
13935 Abstract: You may wonder why an abstract is an extra feature.
13936 Well, it is in book class.
13937 Usually books don't have abstracts.
13938 Memoir, however, has.
13939 You can use it wherever and how often you like.
13942 \begin_layout Description
13943 Chapterprecis: You may know this from belletristic: The contents of a chapter
13944 is shortly described below the title and also in the table of contents
13946 \begin_inset space \thinspace{}
13950 \begin_inset space \space{}
13955 Our hero arrives in Troia; he loses some friends; he finds others
13958 Chapterprecis does exactly this.
13959 It is therefore only sensible below a chapter.
13962 \begin_layout Description
13963 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
13964 The epigraph environment provides an elegant way of typesetting such a
13966 The motto itself (text) and its author (source) are divided by a short
13968 Unfortunately, we have to fool LyX a bit here again, since the environment
13969 needs two arguments (text and source).
13970 In this case, we have to use curly brackets (in TeX mode) between the two
13981 <author of the slogan>.
13984 \begin_layout Description
13985 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
13986 complex figurative poems).
13987 LyX can only support a few of them.
13988 One is poemtitle, which is a centered title for poems, which will also
13989 be added to the table of contents (verse is the standard environment for
13991 Memoir has some enhanced versions of verse, but you need to use TeX code,
13992 because they have to be nested inside regular verse environments, which
13993 is not possible with LyX).
13996 \begin_layout Description
13997 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14000 \begin_layout Section
14001 Article (mwart), book (mwbk) and report (mwrep)
14002 \begin_inset OptArg
14005 \begin_layout Plain Layout
14018 \begin_layout Standard
14024 \begin_layout Standard
14025 The LyX document classes
14041 correspond to the LaTeX document classes
14054 They are replacements for the standard document classes
14066 , resp., and fit better to Polish typography conventions in a number of points.
14070 \begin_layout Standard
14074 \begin_layout Itemize
14075 Unnumbered titles (with star, e.
14076 \begin_inset space \thinspace{}
14080 \begin_inset space \space{}
14087 ) are added into table of contents,
14090 \begin_layout Itemize
14091 Additional page styles:
14095 \begin_layout Description
14096 uheadings header with separated lines,
14099 \begin_layout Description
14100 myheadings custom header, contents headers via commands:
14115 \begin_layout Description
14116 myuheadings custom header with separated lines,
14119 \begin_layout Description
14120 outer page number is placed on outer side of page
14124 \begin_layout Itemize
14129 \begin_layout Description
14130 rmheadings serif titles — default,
14133 \begin_layout Description
14134 sfheadings sansserif titles,
14137 \begin_layout Description
14138 authortitle on title page first placed is author next title — default,
14141 \begin_layout Description
14142 titleauthor on title page first placed is title next author,
14145 \begin_layout Description
14146 withmarginpar reserve place on page for margins.
14150 \begin_layout Section
14154 \begin_layout Standard
14159 provides an alternative to the standard
14164 It provides similar functionality, but you might prefer this layout with
14165 sans serif sections, headings, and more.
14168 \begin_layout Section
14172 \begin_layout Standard
14178 \begin_layout Standard
14179 \begin_inset VSpace bigskip
14185 \begin_layout Standard
14190 \begin_inset space ~
14195 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14196 \begin_inset Formula $\beta$
14199 release of May, 1999) class.
14202 \begin_layout Standard
14207 textclass, which works with RevTeX 3.1.
14208 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14209 That means that it doesn't interact very well with LyX, which requires
14210 LaTeX2e, although it has been kludged to work.
14211 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14215 \begin_inset space ~
14220 textclass should also be pretty easy to use.
14223 \begin_layout Standard
14224 These documents are supposed to be used in
14228 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14229 macros, and assume you'll know what to put in the preamble if necessary.
14232 \begin_layout Subsection
14236 \begin_layout Standard
14237 All you need to do is install RevTeX 4, as described in the package's README
14239 The package can be found at The RevTeX 4 Web Site
14240 \begin_inset Flex URL
14243 \begin_layout Plain Layout
14245 http://publish.aps.org/revtex4/
14251 Install it somewhere that LaTeX can see it.
14252 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14254 \begin_inset space \thinspace{}
14258 \begin_inset space \space{}
14261 not the directory where you installed the class file.) Then, if you reconfigure
14262 LyX, it will find the class file and let you use the RevTeX4 textclass.
14265 \begin_layout Standard
14266 Probably the easiest way to get started is either to import a RevTeX 4 document
14274 \begin_inset space ~
14279 template, found in the templates directory.
14282 \begin_layout Subsection
14286 \begin_layout Standard
14287 Optional arguments to
14294 \begin_inset Quotes eld
14298 \begin_inset Quotes erd
14302 \begin_inset Quotes eld
14306 \begin_inset Quotes erd
14316 \begin_inset space ~
14324 \begin_inset space ~
14330 Remember that in RevTeX, at least one optional argument is required!
14333 \begin_layout Standard
14334 Other preamble matter, like
14341 \begin_inset space ~
14347 \begin_inset space ~
14352 dialog, also as usual.
14355 \begin_layout Subsection
14359 \begin_layout Standard
14360 The layouts basically correspond to the commands in RevTeX4.0.
14361 For example, the Email layout corresponds to
14368 Note that (at least as of RevTeX 4.0 Beta), the
14376 layouts are exactly equivalent, so you shouldn't need to use both.
14380 \begin_layout Plain Layout
14381 In case you're curious, both were included so that
14385 would be able to translate both
14405 \begin_layout Subsection
14409 \begin_layout Standard
14410 There are a couple of important unique aspects of RevTeX 4 which might cause
14411 bugs that will be even more confusing in LyX.
14414 \begin_layout Standard
14432 The LyX equivalent is that there is a separate Thanks layout.
14437 write footnotes in the
14441 layout, or weird things may happen.
14442 See the RevTeX 4 documentation for more details.
14445 \begin_layout Standard
14449 \begin_inset space ~
14457 \begin_inset space ~
14466 layouts must be placed
14474 layout and the corresponding
14491 , the LaTeX won't compile.
14494 \begin_layout Subsection
14498 \begin_layout Standard
14499 The main problem with this layout is that you can't use the optional arguments
14500 to layouts like Email and Title.
14501 (The problem is not unique to this layout; you can't use optional arguments
14502 to the Section layouts either.) This means that after you export that file
14503 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14504 need to edit the LaTeX file with a text editor to add the optional arguments
14506 \begin_inset space \thinspace{}
14510 \begin_inset space \space{}
14513 the running title for the page headers.
14514 Lacking these layouts makes the
14520 (and the equivalent
14526 ) useless, so the corresponding layouts don't exist, and will have to be
14531 \begin_layout Plain Layout
14536 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14537 has not been updated yet to take advantage of it.
14545 \begin_layout Section
14546 Springer Journals (
14553 \begin_layout Standard
14559 \begin_layout Subsection
14563 \begin_layout Standard
14564 These are the layout files for some of the journal formats used by Springer
14565 Verlag and listed on
14566 \begin_inset Flex URL
14569 \begin_layout Plain Layout
14571 http://www.springer.de/author/tex/help-journals.html
14576 , where you should also go to fetch the class files (yes, these are LaTeX2e
14578 It is a modular system: the things common to all journals are implemented
14583 , which journal-specific layout files (such as, e.
14584 \begin_inset space \thinspace{}
14588 \begin_inset space \space{}
14595 for Journal of Geodesy) can include.
14598 \begin_layout Standard
14599 This means that implementing support for any other Springer journal on this
14600 list is as simple as writing your own
14608 file following the outline given in
14616 \begin_layout Standard
14617 It is reasonably well tested only for the Journal of Geodesy.
14626 come with the standard LyX distribution.
14627 Install the relevant class file (downloaded from Springer) in a proper
14628 directory, reconfigure LaTeX (in the teTeX case by running
14632 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
14633 and it should work.
14636 \begin_layout Subsection
14640 \begin_layout Standard
14641 A large number of theorem-like styles —
14647 \SpecialChar \ldots{}
14653 \begin_layout Standard
14656 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
14657 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
14660 See the Springer class file documentation for details.
14663 \begin_layout Subsection
14667 \begin_layout Itemize
14679 \begin_layout Itemize
14682 Probability Theory and Related Fields
14688 — Jean-Marc Lasgouttes
14691 \begin_layout Standard
14692 Add your own, it isn't so hard!
14695 \begin_layout Subsection
14699 \begin_layout Standard
14700 These files are partly based on the older
14704 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
14705 file from Springer.
14710 layout, are now defunct.
14711 Jean-Marc Lasgouttes helped out big in making me find my way around the
14712 LyX layout file mechanism.
14715 \begin_layout Subsection
14719 \begin_layout Standard
14721 But probably less than in the old hacked-LaTeX
14728 \begin_layout Standard
14730 \begin_inset space \thinspace{}
14733 g.: does not display the number for theorem-like layouts, just #.
14736 \begin_layout Section
14742 \begin_inset CommandInset label
14751 \begin_layout Standard
14759 \begin_layout Subsection
14763 \begin_layout Standard
14764 This section describes how to use LyX to make slides for overhead projectors.
14765 There are two document classes that can do this: the default slides class
14771 This section documents the former.
14774 \begin_layout Standard
14775 I'm going to say this again, nice and clear, so that there's no misunderstanding
14779 \begin_layout Standard
14780 \begin_inset VSpace bigskip
14786 \begin_layout Standard
14790 This section documents the class
14791 \begin_inset Quotes eld
14799 \begin_inset Quotes erd
14807 \begin_layout Standard
14808 \begin_inset VSpace bigskip
14814 \begin_layout Standard
14815 If you're looking for the documentation for
14816 \begin_inset Quotes eld
14824 \begin_inset Quotes erd
14827 , check out section
14828 \begin_inset space ~
14832 \begin_inset CommandInset ref
14834 reference "sec:foiltex"
14844 \begin_inset Quotes eld
14852 \begin_inset Quotes erd
14855 ] is actually somewhat better than the default
14863 \begin_layout Plain Layout
14864 \SpecialChar \ldots{}
14865 or so I've been told repeatedly by its advocates.
14866 Having never used it, I have no idea if this claim is true or not.
14871 which this section documents.
14874 \begin_layout Standard
14875 This class is the LaTeX2e improvement of the old
14880 Every LaTeX2e distribution includes this class [which I'll just refer to
14882 \begin_inset Quotes eld
14890 \begin_inset Quotes erd
14893 from now on], so you're bound to have it.
14894 As I noted earlier, there are other classes, such as
14898 , which also produce slides for overhead projectors and do a better job
14900 However, there are some things which
14904 can do which the others can't, such as generate overlays.
14905 Read on to learn more!
14908 \begin_layout Subsection
14910 \begin_inset CommandInset label
14912 name "sec:slidesetup"
14919 \begin_layout Standard
14920 Obviously, to use this document class, you need to select
14921 \begin_inset Quotes eld
14929 \begin_inset Quotes erd
14932 from the class list in the
14934 Document\SpecialChar \menuseparator
14938 There are some other special things you should know about this class:
14941 \begin_layout Itemize
14942 Don't bother changing the options
14947 They're not supported by the
14954 \begin_layout Itemize
14958 \begin_inset space ~
14963 behaves a bit differently for this class.
14964 The possible choices and what they do are as follows:
14968 \begin_layout Description
14973 The final output contains page numbers in the lower right corner.
14976 \begin_layout Description
14985 , but also prints out any time markers you've put in.
14986 This is the default.
14989 \begin_layout Description
14994 The final output contains no page numbers, time markers, or alignment markers.
14998 \begin_layout Itemize
15003 class has an extra option:
15009 \begin_inset Quotes eld
15017 \begin_inset Quotes erd
15020 in the extra class options.
15024 \begin_layout Standard
15025 Using this options allows you to add time markers to
15031 \begin_inset space ~
15035 \begin_inset CommandInset ref
15037 reference "sec:slideNote"
15045 \begin_layout Standard
15046 You can also use the template file
15047 \begin_inset Quotes eld
15055 \begin_inset Quotes erd
15058 to automatically set up a document to use the
15064 File\SpecialChar \menuseparator
15066 \begin_inset space ~
15070 \begin_inset space ~
15075 to open your new document].
15076 The template file also contains some examples of the special paragraph
15077 environments used by this class.
15078 I'll describe those next.
15081 \begin_layout Subsection
15082 Paragraph Environments
15085 \begin_layout Subsubsection
15086 Supported Environments
15089 \begin_layout Standard
15090 The first thing you'll notice when you start up a new
15094 document is the font size and type: it's the equivalent of the size
15095 \begin_inset Quotes eld
15103 \begin_inset Quotes erd
15109 \begin_inset space ~
15115 This is also what's used in the output.
15117 \begin_inset Quotes eld
15121 \begin_inset Quotes erd
15124 to remind you that this is a slide.
15125 Your final slides will use a larger font; ergo, you'll have less space.
15126 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
15129 \begin_layout Standard
15130 The next thing that becomes obvious is the changes to the paragraph environment
15131 pull-down box [at the far-left end of the toolbar].
15132 Most of the paragraph environments you're used to seeing are missing.
15133 There are also five new ones.
15138 class itself only supports certain paragraph environments:
15141 \begin_layout Itemize
15147 \begin_layout Itemize
15153 \begin_layout Itemize
15159 \begin_layout Itemize
15165 \begin_layout Itemize
15171 \begin_layout Itemize
15177 \begin_layout Itemize
15183 \begin_layout Itemize
15189 \begin_layout Itemize
15195 \begin_layout Itemize
15201 \begin_layout Itemize
15207 \begin_layout Standard
15208 All of the other standard environments, including the section-heading environmen
15209 ts, aren't used in the
15216 \begin_layout Standard
15217 On the other hand, you'll notice the following new environments:
15220 \begin_layout Itemize
15226 \begin_layout Itemize
15232 \begin_layout Itemize
15238 \begin_layout Itemize
15244 \begin_layout Itemize
15250 \begin_layout Standard
15251 These five are kind of quirky, due to a
15252 \begin_inset Quotes eld
15256 \begin_inset Quotes erd
15260 You see, LyX doesn't permit you to nest any other paragraph environment
15261 into an empty environment.
15262 Now, that's fine and dandy, but it means that you wouldn't be able to start
15263 a slide with anything except plain text.
15264 To deal with this, I've performed a little
15265 \begin_inset Quotes eld
15269 \begin_inset Quotes erd
15275 \begin_layout Subsubsection
15276 Quirks of the New Environments
15277 \begin_inset CommandInset label
15279 name "sec:slideQuirk"
15286 \begin_layout Standard
15287 All five of the new paragraph environments are somewhat quirky due to inherent
15288 limitiations in the current version of LyX.
15289 As I just mentioned, LyX forbids environments that begin with another environme
15291 To get around this, the
15295 environment isn't a paragraph environment as described in the
15303 \begin_layout Standard
15304 You should consider
15317 \begin_inset Quotes eld
15320 pseudo-environments.
15321 \begin_inset Quotes erd
15324 They look like a section heading or a
15325 \begin_inset Quotes eld
15333 \begin_inset Quotes erd
15336 but really begin a [and, if necessary, end the previous] paragraph environment.
15346 \begin_inset Quotes eld
15350 \begin_inset Quotes erd
15353 These two perform some action.
15356 \begin_layout Standard
15357 A common feature of all five environments,
15377 , is a rather long-ish label.
15378 The text following this label — ordinarily the contents of the paragraph
15379 environment — is utterly irrelevant for
15400 LyX completely ignores it.
15401 In fact, you can leave these five environments completely empty.
15405 \begin_layout Standard
15410 to put any text after the rather long-ish label, you might want to.
15411 This could be a short description of the contents of the
15416 In that case, enter in your descriptive comment and hit
15420 as you normally would.
15423 \begin_layout Standard
15424 If, on the other hand, you don't want to enter in any descriptive text,
15425 you'll hit another LyX quirk.
15426 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
15427 environment until you put something in the old one.
15431 \begin_layout Itemize
15432 Start entering the text that will
15460 \begin_layout Itemize
15461 Now move to the beginning of that paragraph.
15465 \begin_layout Itemize
15474 \begin_layout Itemize
15475 Finally, change this new, empty paragraph to a
15499 \begin_layout Standard
15500 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
15504 \begin_layout Subsection
15505 Making a Presentation with
15518 \begin_layout Subsubsection
15526 \begin_layout Standard
15527 If you're expecting this section to teach you how to actually make a presentatio
15528 n, you'll be sorely disappointed.
15529 Naturally, I'll describe all of the ways the
15533 class can assist you in preparing the materials for a presentation.
15534 Filling in the contents, however, is up to you.
15539 the LyX philosophy.]
15542 \begin_layout Standard
15547 environment [in the manner described in section
15548 \begin_inset space ~
15552 \begin_inset CommandInset ref
15554 reference "sec:slideQuirk"
15558 ] tells LyX to begin a new slide [duh].
15559 The label for this environment/
15560 \begin_inset Quotes erd
15564 \begin_inset Quotes erd
15568 \begin_inset Quotes eld
15572 \begin_inset Quotes erd
15575 in cool blue, followed by the label,
15576 \begin_inset Quotes eld
15580 \begin_inset Quotes erd
15584 Any text or paragraph environments that follow this one go on the new slide.
15588 \begin_layout Standard
15589 Slides are probably the only time you'll need to forcibly end pages in LyX
15590 (this can be specified in the
15595 In fact, you'll want to, once you finish entering the contents of one slide.
15596 If you've entered more text than can physically fit on a slide, the extra
15597 overflows onto a new slide.
15598 I don't recommend doing this, however, since the overflow slide won't have
15599 any page number on it.
15600 Furthermore, it may interfere with any
15604 you've made to accompany the oversized
15611 \begin_layout Standard
15620 environments work the same way as the
15625 They both create an
15626 \begin_inset Quotes eld
15630 \begin_inset Quotes erd
15633 followed by a label [
15634 \begin_inset Quotes eld
15638 \begin_inset Quotes erd
15642 \begin_inset Quotes eld
15646 \begin_inset Quotes erd
15650 The color is a stunning magenta instead of blue, and the
15651 \begin_inset Quotes eld
15655 \begin_inset Quotes erd
15658 will look different, in style and in length.
15659 The label fonts of all three also differ from one another.
15662 \begin_layout Standard
15667 , if the contents of a
15675 exceed the physical size of a slide or sheet of paper, the extra will overflow
15677 Again, you should avoid this.
15678 It defeats the whole purpose of
15689 \begin_layout Subsubsection
15699 \begin_layout Standard
15704 is a slide that sits atop another slide.
15705 Perhaps you wish to discuss a figure on the main
15709 before displaying the text associated with it.
15710 One way to accomplish this is tape a flap of dark paper over the part of
15715 you want to display later.
15716 This method fails, however, if you wish to overlap one graph with another,
15718 You would then have to fumble while speaking to align the two separate,
15723 s to align the two graphs.
15728 environment in both cases makes life much easier.
15731 \begin_layout Standard
15736 receives the page number of its
15737 \begin_inset Quotes eld
15741 \begin_inset Quotes erd
15749 \begin_inset Quotes eld
15757 \begin_inset Quotes erd
15764 \begin_layout Plain Layout
15765 Presumably, mutliple
15770 \begin_inset Quotes eld
15778 \begin_inset Quotes erd
15782 \begin_inset Quotes eld
15790 \begin_inset Quotes erd
15794 \begin_inset Quotes eld
15802 \begin_inset Quotes erd
15806 \begin_inset space ~
15809 appended to the page number of the parent
15819 Clearly, you want the contents of both the
15827 to each fit on a single physical slide! You should probably consider an
15833 \begin_inset Quotes eld
15837 \begin_inset Quotes erd
15849 class provides a visual cue for this: the label at the start of an
15853 is shorter than that at the start of a
15858 Lastly, when you generate printable output, you'll find alignment markers
15859 in all four corners of both the
15863 page and its parent
15868 These will assist you in lining up the two physical slides.
15871 \begin_layout Standard
15872 The major problem in overlaying two slides is aligning the contents of the
15873 two transparencies.
15874 How much space should you leave for that graph on the second slide? Worse
15875 still, what if you want a graph and a sentence on second slide, but there
15876 is text on the main transparency that goes in between them? You could try
15877 and insert vertical space of the right size.
15878 The better way is to use
15889 \begin_layout Standard
15890 As their names imply,
15898 are two command-like paragraph environments that make all subsequent text
15899 invisible and visible, respectively.
15901 \begin_inset space ~
15905 \begin_inset CommandInset ref
15907 reference "sec:slideQuirk"
15911 that you don't place anything
15915 these two environments, however.
15920 , it inserts a centered, sky-blue label into the page reading
15921 \begin_inset Quotes eld
15924 <Invisible Text Follows>
15925 \begin_inset Quotes erd
15929 For paragraphs following this label, the parts of the
15937 ; it doesn't matter which] where they would be contain instead blank space.
15941 \begin_layout Standard
15946 , the corresponding centered label is
15947 \begin_inset Quotes eld
15950 <Visible Text Follows>
15951 \begin_inset Quotes erd
15955 Paragraphs following this label behave normally.
15956 Note that the beginning of a new
15968 automatically shuts off an
15973 It's therefore not necessary to use
15984 \begin_layout Standard
15985 By now, it should be obvious how to create overlay transparencies using
15986 the proper combination of
16005 \begin_layout Enumerate
16010 , including everything that will appear on it, whether on the main slide
16018 \begin_layout Enumerate
16019 Before each figure or paragraph that will appear only on the
16028 If necessary, insert a
16032 environment after the
16039 \begin_layout Enumerate
16044 immediately following the
16051 \begin_layout Enumerate
16052 Copy the contents of this
16063 \begin_layout Enumerate
16068 , change all of the
16079 \begin_layout Standard
16081 You've just made an
16088 \begin_layout Standard
16089 There's one problem with the way I've designed the LyX
16093 class: you can't make text in the middle of a paragraph invisible, nor
16094 make text in the middle of an invisible paragraph visible again.
16095 To accomplish this feat, you'll need to use some inlined LaTeX codes.
16099 \begin_layout Plain Layout
16100 The commands of interest are:
16103 \begin_layout Itemize
16108 invisible \SpecialChar \ldots{}
16112 \begin_layout Itemize
16117 visible \SpecialChar \ldots{}
16121 \begin_layout Plain Layout
16122 \SpecialChar \ldots{}
16123 and need to be marked as TeX.
16125 \begin_inset Quotes eld
16129 \begin_inset Quotes erd
16132 you wish to change goes in between the brackets [and after the
16145 If you don't know how to mark text as TeX, see the appropriate section
16158 \begin_layout Subsubsection
16168 \begin_inset CommandInset label
16170 name "sec:slideNote"
16177 \begin_layout Standard
16186 is associated with a
16187 \begin_inset Quotes eld
16191 \begin_inset Quotes erd
16203 class provides visual cues.
16208 is shorter than that of a
16212 [yet longer than that of an
16216 ] and, like the label of an
16220 is shockingly magenta.
16221 Additionally, the printed
16225 has the page number of its
16226 \begin_inset Quotes eld
16230 \begin_inset Quotes erd
16238 \begin_inset Quotes eld
16246 \begin_inset Quotes erd
16250 \begin_inset Quotes eld
16258 \begin_inset Quotes erd
16262 \begin_inset Quotes eld
16270 \begin_inset Quotes erd
16274 You can have multiple
16278 s associated with a single
16290 , you'll probably want to break up long
16294 s so that they fit on a single sheet of paper.
16297 \begin_layout Standard
16302 is obvious: it contains anything additional you might want to say about
16308 It could also be used as a sheet of reminders for a particular
16313 In the case of the latter, you might want to make use of time markers.
16319 \begin_inset Quotes eld
16323 \begin_inset Quotes erd
16326 support for time markers, a
16331 So, you'll have to resort to using the LaTeX codes.
16334 \begin_layout Standard
16335 To use time markers, you'll need to specify the extra class option
16336 \begin_inset Quotes eld
16344 \begin_inset Quotes erd
16348 \begin_inset space ~
16352 \begin_inset CommandInset ref
16354 reference "sec:slidesetup"
16359 This option turns on timing marks, which will appear in the lower-left-hand
16365 To set what appears in the time marker, you use the LaTeX commands
16366 \begin_inset Quotes eld
16376 \begin_inset Quotes erd
16380 \begin_inset Quotes eld
16390 \begin_inset Quotes erd
16394 The arguments of both commands are time measured in seconds.
16396 \begin_inset Quotes eld
16406 \begin_inset Quotes erd
16409 sets the time marker to a given time.
16411 \begin_inset Quotes eld
16421 \begin_inset Quotes erd
16424 increments the time marker by the specified amount.
16425 Using time markers and
16429 s in this fashion, you can remind yourself how much time to spend on a particula
16437 \begin_layout Standard
16438 There's one last feature to describe.
16439 Clearly, you'd like to print out all of your
16447 s on transparencies while printing all of your
16464 with which it is associated.
16465 What's a person to do?
16468 \begin_layout Standard
16469 Luckily, there are two LaTeX commands that allow you to select what to print
16471 Both must be placed into the preamble of your document.
16473 \begin_inset Quotes eld
16485 \begin_inset Quotes erd
16488 will cause the output to contain only the
16497 Correspondingly, the command
16498 \begin_inset Quotes eld
16510 \begin_inset Quotes erd
16513 prevents the output of anything but
16518 I'd advise placing both commands in the preamble and initially comment
16520 You can then preview your entire presentation as you write.
16521 When you're done writing, you can then uncomment one of the two to select
16522 what you want to print.
16523 I like to uncomment
16524 \begin_inset Quotes eld
16536 \begin_inset Quotes erd
16539 , print to a file with
16540 \begin_inset Quotes eld
16548 \begin_inset Quotes erd
16551 in its name, comment it back out, then uncomment
16552 \begin_inset Quotes eld
16564 \begin_inset Quotes erd
16568 \begin_inset Quotes eld
16576 \begin_inset Quotes erd
16580 I can then send either file to a printer, loading transparencies or plain
16581 paper as appropriate.
16584 \begin_layout Standard
16585 You can also provide other arguments to the
16586 \begin_inset Quotes eld
16596 \begin_inset Quotes erd
16600 \begin_inset Quotes eld
16610 \begin_inset Quotes erd
16614 See a good LaTeX book for details.
16617 \begin_layout Subsection
16622 Class Template File
16625 \begin_layout Standard
16626 I have also provided a template file,
16627 \begin_inset Quotes eld
16635 \begin_inset Quotes erd
16643 To use it, begin your new presentation with
16648 ile\SpecialChar \menuseparator
16650 \begin_inset space ~
16654 \begin_inset space ~
16664 Your new LyX presentation file will contain an example
16685 additionally contain an example of the use of
16694 Lastly, the preamble will contain:
16697 \begin_layout LyX-Code
16698 % Uncomment to print out only slides and overlays
16701 \begin_layout LyX-Code
16705 \begin_layout LyX-Code
16711 \begin_inset Newline newline
16717 \begin_layout LyX-Code
16718 % Uncomment to print out only notes
16721 \begin_layout LyX-Code
16725 \begin_layout LyX-Code
16733 \begin_layout Standard
16734 One final thing: I created this class to support the LaTeX2e
16735 \begin_inset Quotes eld
16743 \begin_inset Quotes erd
16746 class, one of the built-in LaTeX2e classes.
16747 Neither I nor the rest of the LyX Team endorse or oppose the use of this
16748 built-in slide class.
16749 It's here if you want it or need it.
16750 There exist other LaTeX2e classes for creating presentations, such as the
16756 \begin_inset space ~
16760 \begin_inset CommandInset ref
16762 reference "sec:foiltex"
16767 \begin_inset Quotes eld
16775 \begin_inset Quotes erd
16778 package [present on some TeX distributions].
16779 The latter is not yet supported under LyX.
16783 \begin_layout Plain Layout
16784 Perhaps you can take on the task\SpecialChar \ldots{}
16790 I know nothing about these other classes.
16791 Try them out to see what sort of alternative they provide.
16794 \begin_layout Chapter
16795 LyX Features needing Extra Software
16798 \begin_layout Section
16802 \begin_layout Standard
16808 \begin_layout Subsection
16812 \begin_layout Standard
16821 \begin_layout Plain Layout
16826 is not yet available when you are using the LaTeX distribution MiKTeX.
16831 , you'll find in the
16838 \begin_inset space ~
16849 \begin_inset CommandInset href
16851 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
16858 \begin_layout Standard
16863 package is a program that was written by
16864 \begin_inset Flex CharStyle:Noun
16867 \begin_layout Plain Layout
16869 \begin_inset space ~
16877 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16878 and easy to forget.
16879 The program runs over your LaTeX file, checks the integrity of the file,
16880 and flags some common errors.
16881 In other technical words, it is
16888 \begin_layout Standard
16889 Well, what is a syntax checker doing in LyX which is supposed to produce
16890 correct LaTeX anyways? The answer is simple: Just as
16894 not only checks the
16898 of C programs, but also does
16902 checks for type-errors,
16906 catches some common
16910 errors, in addition to the syntactical ones.
16915 is capable of detecting several common errors, such as
16918 \begin_layout Itemize
16919 Ellipsis detection:
16920 \begin_inset Newline newline
16923 Use \SpecialChar \ldots{}
16927 \begin_layout Itemize
16928 No space in front of/after parenthesis:
16929 \begin_inset Newline newline
16935 \begin_layout Itemize
16936 Enforcement of normal space after common abbreviations:
16937 \begin_inset Newline newline
16941 \begin_inset space \thinspace{}
16945 \begin_inset space \space{}
16948 is too wide spacing.
16951 \begin_layout Itemize
16952 Enforcement of end-of-sentence space when the last sentence ends with a
16954 \begin_inset Newline newline
16958 And this is wrong spacing.
16961 \begin_layout Itemize
16962 Space in front of labels and similar commands:
16963 \begin_inset Newline newline
16966 The label should stick right up to the text to avoid falling to a wrong
16969 \begin_inset CommandInset label
16979 \begin_layout Plain Layout
16980 This footnote is in danger of falling off to a wrong page
16985 The label is separated too much.
16988 \begin_layout Itemize
16989 Space in front of references, instead of hard spaces:
16990 \begin_inset Newline newline
16993 In you are in bad luck, the text will break right between the referenced
16994 text and reference number, and that's a pity.
16996 \begin_inset CommandInset ref
16998 reference "sec:chktex"
17005 \begin_layout Itemize
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17015 \begin_inset Formula $\times$
17019 \begin_inset Newline newline
17022 2x2 looks cheap compared to
17023 \begin_inset Formula $2\times2$
17029 \begin_layout Standard
17030 and more \SpecialChar \ldots{}
17031 It is an invaluable tool when you are
17032 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17039 your document before printing, and you should run it right after the obligatory
17040 spelling check, and before you go fine tuning the typesetting.
17043 \begin_layout Subsection
17047 \begin_layout Standard
17048 If you have the program installed, usage is as simple as choosing
17050 Tools\SpecialChar \menuseparator
17052 \begin_inset space ~
17058 This will make LyX generate a LaTeX file of your document, start
17062 to check it, and then make LyX insert
17063 \begin_inset Quotes eld
17067 \begin_inset Quotes erd
17070 with the warnings from
17074 , if there were any.
17075 The warnings will be placed close to the point of the mistake, and you
17076 can quickly find them by using the
17078 Navigate\SpecialChar \menuseparator
17081 menu item, or the shortcut key
17090 Open the error boxes by clicking on them with the mouse, or use the shortcut
17099 bindings, or the corresponding
17108 Read the warning and correct the mistake, if it is a mistake.
17109 If you have trouble understanding what the warning is about, you can safely
17111 Remember that there is a hidden layer between the document on screen and
17112 the technical details in invoking
17116 , and this gap can make some warnings seem arcane or just right down plain
17120 \begin_layout Standard
17121 This document is an excellent testing bed for the feature, and it should
17122 provide quite a few warnings for you to fiddle with.
17123 Since computers are only so smart, expect most of the warnings to be false
17127 \begin_layout Subsection
17128 How to fine tune it
17131 \begin_layout Standard
17132 Sometimes, you'll find that
17136 makes more noise than suits your mood.
17137 Then you can choose not to use it, wait until your mood changes, or try
17142 to get better along with you.
17143 Another choice in the most desperate situations is to use
17145 View\SpecialChar \menuseparator
17147 \begin_inset space ~
17151 \begin_inset space ~
17155 \begin_inset space ~
17160 , which will get rid of all warnings instantly.
17163 \begin_layout Standard
17172 very configurable and extensible, you shouldn't expect to solve all problems
17178 Since LyX has to generate a somewhat special LaTeX file to be able to match
17179 the line numbers from the
17187 \begin_layout Plain Layout
17188 You can inspect the specific output from
17194 Edit\SpecialChar \menuseparator
17196 \begin_inset space ~
17200 \begin_inset space ~
17214 to the internal document structure, some of the warnings will not seen
17215 to appear correctly.
17216 There are two things you can do about this:
17219 \begin_layout Itemize
17224 invocation command line in
17240 installation configuration file (usually with the file
17245 See below to learn what warnings can be enabled and disabled on the command
17250 \begin_layout Itemize
17251 Export your document as a raw LaTeX file using
17253 File\SpecialChar \menuseparator
17254 Export\SpecialChar \menuseparator
17262 Invoked in this way, it can be a hassle to find the corresponding place
17263 in the document inside LyX, but with a little patience, you should be able
17267 \begin_layout Standard
17268 Here follows the warning messages that can be enabled and disabled in
17277 to disable a warning, and
17281 to enable a warning.
17282 The emphasized entries are disabled by default, because the default is
17285 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
17290 \begin_layout Standard
17291 Notice that you should only use the options that enable and disable warnings,
17292 because LyX relies on some of the other command line parameters to be set
17293 in a specific way to have a chance to communicate with
17300 \begin_layout Enumerate
17304 Command terminated with space.
17307 \begin_layout Enumerate
17310 Non-breaking space (
17311 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17322 ) should have been used.
17325 \begin_layout Enumerate
17329 You should enclose the previous parenthesis with
17330 \begin_inset Quotes eld
17338 \begin_inset Quotes erd
17344 \begin_layout Enumerate
17347 Italic correction (
17348 \begin_inset Quotes eld
17358 \begin_inset Quotes erd
17361 ) found in non-italic buffer.
17364 \begin_layout Enumerate
17367 Italic correction (
17368 \begin_inset Quotes eld
17378 \begin_inset Quotes erd
17381 ) found more than once.
17384 \begin_layout Enumerate
17388 No italic correction (
17389 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17405 \begin_layout Enumerate
17409 \begin_inset Quotes eld
17417 \begin_inset Quotes erd
17421 \begin_inset Quotes eld
17429 \begin_inset Quotes erd
17435 \begin_layout Enumerate
17438 Wrong length of dash may have been used.
17441 \begin_layout Enumerate
17445 \begin_inset Quotes eld
17453 \begin_inset Quotes erd
17457 \begin_inset Quotes eld
17465 \begin_inset Quotes erd
17471 \begin_layout Enumerate
17475 \begin_inset Quotes eld
17483 \begin_inset Quotes erd
17489 \begin_layout Enumerate
17493 \begin_inset Quotes eld
17501 \begin_inset Quotes erd
17504 to achieve an ellipsis.
17507 \begin_layout Enumerate
17510 Inter-word spacing (
17511 \begin_inset Quotes eld
17521 \begin_inset Quotes eld
17524 ) should perhaps be used.
17527 \begin_layout Enumerate
17530 Inter-sentence spacing (
17531 \begin_inset Quotes eld
17541 \begin_inset Quotes erd
17544 ) should perhaps be used.
17547 \begin_layout Enumerate
17550 Could not find argument for command.
17553 \begin_layout Enumerate
17557 \begin_inset Quotes eld
17565 \begin_inset Quotes erd
17571 \begin_layout Enumerate
17574 Math mode still on at end of LaTeX file.
17577 \begin_layout Enumerate
17581 \begin_inset Quotes eld
17589 \begin_inset Quotes erd
17592 doesn't match the number of
17593 \begin_inset Quotes eld
17601 \begin_inset Quotes erd
17607 \begin_layout Enumerate
17610 You should use either
17613 \begin_inset Quotes eld
17621 \begin_inset Quotes erd
17626 as an alternative to
17627 \begin_inset Quotes eld
17635 \begin_inset Quotes erd
17641 \begin_layout Enumerate
17648 " (ASCII 39) instead of "
17655 \begin_layout Enumerate
17658 User-specified pattern found.
17661 \begin_layout Enumerate
17664 This command might not be intended.
17667 \begin_layout Enumerate
17674 \begin_layout Enumerate
17692 \begin_layout Enumerate
17695 Delete this space to maintain correct page references.
17698 \begin_layout Enumerate
17702 You might wish to put this between a pair of
17703 \begin_inset Quotes eld
17711 \begin_inset Quotes erd
17717 \begin_layout Enumerate
17720 You ought to remove spaces in front of punctuation.
17723 \begin_layout Enumerate
17726 Could not execute LaTeX command.
17729 \begin_layout Enumerate
17738 in front of small punctuation.
17741 \begin_layout Enumerate
17749 may look prettier here.
17752 \begin_layout Enumerate
17756 Multiple spaces detected in output.
17759 \begin_layout Enumerate
17762 This text may be ignored.
17765 \begin_layout Enumerate
17771 \begin_inset Quotes eld
17776 to begin quotation, not
17783 \begin_layout Enumerate
17790 to end quotation, not
17793 \begin_inset Quotes eld
17801 \begin_layout Enumerate
17807 \begin_layout Enumerate
17810 You should perhaps use
17811 \begin_inset Quotes eld
17819 \begin_inset Quotes erd
17825 \begin_layout Enumerate
17828 You should put a space in front of/after parenthesis.
17831 \begin_layout Enumerate
17834 You should avoid spaces in front of/after parenthesis.
17837 \begin_layout Enumerate
17841 You should not use punctuation in front of/after quotes.
17844 \begin_layout Enumerate
17847 Double space found.
17850 \begin_layout Enumerate
17853 You should put punctuation outside inner/inside display math mode.
17856 \begin_layout Enumerate
17859 You ought to not use primitive TeX in LaTeX code.
17862 \begin_layout Enumerate
17865 You should remove spaces in front of
17866 \begin_inset Quotes eld
17874 \begin_inset Quotes erd
17880 \begin_layout Enumerate
17883 \begin_inset Quotes eld
17891 \begin_inset Quotes erd
17894 is normally not followed by
17895 \begin_inset Quotes eld
17903 \begin_inset Quotes erd
17909 \begin_layout Standard
17910 In later versions of LyX, we hope to provide a more complete interface to
17911 this tool (and it's smaller cousin
17915 ) to exploit the full power of it.
17916 But it's not exactly useless as it is now: go try it on one of your existing
17917 documents of a certain length and be surprised.
17920 \begin_layout Section
17921 Version Control in LyX
17924 \begin_layout Standard
17927 Lars Gullik Bjønnes,
17934 \begin_layout Subsection
17938 \begin_layout Standard
17939 A friend of mine wanted to try LyX for a group project.
17940 When he didn't find support for version control or file locking, he dropped
17942 This angered me a bit, so I thought that I should at least make support
17943 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17944 This has now been done.
17945 LyX now supports some of the most basic RCS commands.
17946 If you need to something a bit more sophisticated you will have to do that
17947 manually in an xterm.
17950 \begin_layout Standard
17951 Before you begin to use the version control features in LyX, you should
17953 \begin_inset Quotes eld
17957 \begin_inset Quotes erd
17960 (a man file, read it with
17965 This file describes all the basic features of RCS.
17966 You should especially notice the comment about a RCS directory, and the
17967 notion of a master RCS file (the file ending in
17974 \begin_layout Standard
17975 Later basic CVS/SVN support was added.
17976 You should be familiar with CVS/SVN usage before start using it under LyX.
17977 Most of the log messages are not currently displayed after operations -
17978 you can check them in terminal window if unsure.
17981 \begin_layout Standard
17982 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
17983 package—no guarantees are made for older versions.
17986 \begin_layout Standard
17987 For introducing your own external commands consult vc-command in the manual
17991 \begin_layout Subsection
17992 RCS commands in LyX
17995 \begin_layout Standard
17996 The following sections describe the RCS commands supported by LyX.
17997 You can find them in the
17999 File\SpecialChar \menuseparator
18001 \begin_inset space ~
18007 LyX was tested against RCS 5.7.
18010 \begin_layout Subsubsection
18016 \begin_layout Standard
18017 If your document is not under revision control, this is the only item shown
18019 And if it is under revision control, the
18023 item is not visible.
18027 \begin_layout Standard
18028 This command registers your document with RCS (unless you are under the
18029 directory managed by CVS)\SpecialChar \@.
18030 You are asked interactively to supply an initial
18031 description of the document.
18032 The document is now set in Read-Only mode and you have to
18035 \begin_inset space ~
18039 \begin_inset space ~
18043 \begin_inset space ~
18048 , before making any changes to it.
18049 A document under revision control has a
18050 \begin_inset Quotes eld
18053 [RCS:<version> <locker>]
18054 \begin_inset Quotes erd
18057 item tagged to the filename in the minibuffer.
18060 \begin_layout Standard
18061 RCS command that is run:
18063 ci -q -u -i -t-"<initial description>" <file-name>
18066 \begin_layout Standard
18071 to understand the switches.
18075 \begin_layout Subsubsection
18081 \begin_layout Standard
18082 When you are finished editing a file, you check in your changes.
18083 When you do this, you are asked for a description of the changes.
18084 This is stored in the history log.
18085 The version number is bumped, your changes are applied to the master RCS
18086 file, the document is unlocked and set to Read-Only mode.
18090 \begin_layout Standard
18093 ci -q -u -m"<description>" <file-name>
18096 \begin_layout Subsubsection
18102 \begin_layout Standard
18103 By doing this you lock the document so that only you can edit it.
18104 This will also make the document Read-Write only for you.
18105 You will usually continue editing for a while and when you are finished
18106 you check in your changes.
18107 The status line is changed to reflect that you have locked the file.
18111 \begin_layout Standard
18114 co -q -l <file-name>
18117 \begin_layout Subsubsection
18120 Revert To Repository Version
18123 \begin_layout Standard
18124 This will discard all changes made to the document since the last check
18126 You get a warning before changes are discarded.
18129 \begin_layout Standard
18132 co -f -u<version> <file-name>
18135 \begin_layout Subsubsection
18141 \begin_layout Standard
18142 This makes as if the last check in never happened.
18143 No changes are made to the document loaded into LyX, but the last version
18144 is removed from the master RCS file.
18148 \begin_layout Standard
18151 rcs -o<version> <file-name>
18154 \begin_layout Subsubsection
18160 \begin_layout Standard
18161 This show the complete history of the RCS document.
18166 is shown in a browser.
18174 \begin_layout Subsection
18175 CVS commands in LyX
18178 \begin_layout Standard
18179 CVS is now partially supported by LyX.
18180 You can find the commands in the
18182 File\SpecialChar \menuseparator
18184 \begin_inset space ~
18192 \begin_layout Subsubsection
18198 \begin_layout Standard
18199 If your document is not under revision control, this is the only item shown
18201 And if it is under revision control, the
18208 item is not visible.
18212 \begin_layout Standard
18213 This command registers in CVS your document ONLY in case you have already
18214 the documents directory under CVS control (in particular
18219 This means you have to checkout the archive by yourself.
18223 \begin_layout Standard
18224 Then you are asked interactively to supply an initial description of the
18226 Don't forget that registered file is not yet commited.
18229 \begin_layout Standard
18230 CVS command that is run:
18233 \begin_inset Quotes erd
18237 \begin_inset Quotes eld
18241 \begin_inset Quotes erd
18247 \begin_layout Standard
18252 to understand the switches.
18256 \begin_layout Subsubsection
18262 \begin_layout Standard
18263 When you are finished editing a file, you commit your changes.
18264 When you do this, you are asked for a description of the changes.
18265 After that changes are commited.
18268 \begin_layout Standard
18271 cvs -q commit -m"<description>" "<file-name>"
18274 \begin_layout Subsubsection
18277 Revert To Repository Version
18280 \begin_layout Standard
18281 This will discard all changes made to the document since the last check
18283 You get a warning before changes are discarded.
18284 Firstly the file is deleted, secondly CVS update command is run.
18287 \begin_layout Standard
18291 \begin_inset Quotes eld
18295 \begin_inset Quotes erd
18301 \begin_layout Subsubsection
18307 \begin_layout Standard
18308 This show the complete history of the CVS document.
18312 \begin_inset Quotes eld
18316 \begin_inset Quotes erd
18321 is shown in a browser.
18324 \begin_layout Subsection
18325 SVN commands in LyX
18328 \begin_layout Standard
18329 SVN is now partially supported by LyX.
18330 You can find the commands in the
18332 File\SpecialChar \menuseparator
18334 \begin_inset space ~
18340 Please note that if you use password protected access to repository via
18341 ssh, you will be asked in terminal window.
18342 LyX was tested against SVN 1.5 and 1.6
18346 \begin_layout Plain Layout
18347 Most of the commands will work with 1.4 too, see
18348 \begin_inset CommandInset ref
18350 reference "sub:SVN-Repo-Update"
18362 \begin_layout Subsubsection
18368 \begin_layout Standard
18369 If your document is not under revision control, this is the only item shown
18371 And if it is under revision control, the
18378 item is not visible.
18382 \begin_layout Standard
18383 This command registers in SVN your document ONLY in case you have already
18384 the documents directory under SVN control (in particular
18389 This means you have to checkout the archive by yourself.
18393 \begin_layout Standard
18394 Then you are asked interactively to supply an initial description of the
18396 Don't forget that registered file is not yet commited.
18399 \begin_layout Standard
18400 SVN command that is run:
18403 \begin_inset Quotes eld
18407 \begin_inset Quotes erd
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 commit your changes.
18430 When you do this, you are asked for a description of the changes.
18431 After that changes are commited.
18434 \begin_layout Standard
18439 \begin_layout Plain Layout
18440 In case locking is not enabled.
18442 \begin_inset CommandInset ref
18444 reference "subsec:SVN-File-Locking"
18455 svn commit -q -m"<description>" <file-name>
18458 \begin_layout Subsubsection
18464 \begin_layout Standard
18465 Updates the changes of this file from the repository.
18466 Be sure you understand SVN merging and conflicts resolving before using
18467 this function, because all conflicts has to be resolved manually by you!
18470 \begin_layout Standard
18475 \begin_layout Plain Layout
18484 \begin_inset Quotes eld
18488 \begin_inset Quotes erd
18494 \begin_layout Subsubsection
18497 Revert To Repository Version
18500 \begin_layout Standard
18501 This will discard all changes made to the document since the last check
18503 You get a warning before changes are discarded.
18507 \begin_layout Standard
18511 \begin_inset Quotes eld
18515 \begin_inset Quotes erd
18521 \begin_layout Subsubsection
18522 \begin_inset CommandInset label
18524 name "sub:SVN-Repo-Update"
18528 Update of the local directory checkout from repository
18532 \begin_layout Plain Layout
18533 Note that this command will work only with subversion
18534 \begin_inset Formula $\geqq1.5$
18545 \begin_layout Standard
18546 All the commands above have one shortcomming - they deal with the current
18548 Once your document contains pictures, includes external
18549 \begin_inset Flex CharStyle:Code
18552 \begin_layout Plain Layout
18558 files and so on administration becomes more complicated.
18559 LyX now supports updating the whole tree in which resides the document
18563 \begin_layout Plain Layout
18564 One need to organize the files structure so that all external files are
18565 in the same directory or subdirectories of the document.
18572 This become especially useful once you cooperate with people which neither
18573 know about subversion management nor they have ambition to commit additional
18574 material to the repository.
18578 \begin_layout Standard
18579 \begin_inset Flex CharStyle:Code
18582 \begin_layout Plain Layout
18583 Update local directory from repository
18588 command updates the whole directory and in case of merge conflicts local
18589 version of the files are left, so no unintended data loss occurs.
18590 If local changes are detected user is warned before update starts.
18593 \begin_layout Labeling
18594 \labelwidthstring 00.00.0000
18596 \begin_inset space ~
18600 \begin_inset space ~
18604 \begin_inset Newline newline
18608 \begin_inset Flex CharStyle:Code
18611 \begin_layout Plain Layout
18617 (Ask if changes are detected.)
18618 \begin_inset Newline newline
18622 \begin_inset Flex CharStyle:Code
18625 \begin_layout Plain Layout
18626 svn update --accept mine-full $path
18634 \begin_layout Standard
18636 \begin_inset Flex CharStyle:Code
18639 \begin_layout Plain Layout
18645 stands for the path to the document.
18648 \begin_layout Subsubsection
18654 \begin_layout Standard
18655 This show the complete history of the SVN document.
18659 \begin_inset Quotes eld
18663 \begin_inset Quotes erd
18668 is shown in a browser.
18671 \begin_layout Subsubsection
18673 \begin_inset CommandInset label
18675 name "subsec:SVN-File-Locking"
18682 \begin_layout Standard
18683 The file exchange through various revision control systems brings the problem
18684 of merge conflicts in case two different users try to edit the same (parts
18686 When such conflict happens it needs manual resolving and one reasonable
18687 alternative is to provide some kind of locking mechanism, which guarantees
18688 that only one user is allowed to edit file at the given time.
18691 \begin_layout Standard
18692 SVN has two mechanisms to provide such kind of mutual exclusivity for file
18693 access - locks and automatical setting of write permissions (see sec.
18695 \begin_inset CommandInset ref
18697 reference "subsec:Automatical-Locking-Property"
18702 \begin_inset Flex CharStyle:Code
18705 \begin_layout Plain Layout
18715 \begin_layout Plain Layout
18716 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
18722 In a case this property is detected for a given document LyX starts to
18723 use SVN locks for document editing automatically and the whole check-in/out
18724 mechanism switches to the same regimen as for RCS.
18725 This in particular means there are two different modes how file is used
18729 \begin_layout Itemize
18731 The loaded file is in the read-only mode.
18732 For editation on needs to check-out.
18737 consists of update from repository and gaining write lock.
18738 If the lock is not possible to obtain, we remain in unlocked state.
18741 \begin_layout Itemize
18743 The loaded file is in the 'normal' edit mode.
18744 No other user is allowed to edit the file.
18749 consists of commiting changes and releasing write-lock.
18750 If no changes have been made to the document, no commit will be produced
18754 \begin_layout Plain Layout
18755 Don't be puzzled by the fact that you will be asked for commit message anyway.
18760 and only the write-lock will be released.
18763 \begin_layout Standard
18767 \begin_layout Labeling
18768 \labelwidthstring 00.00.0000
18771 svn commit -q -m"<description>" "<file-name>"
18772 \begin_inset Newline newline
18775 svn unlock "<file-name>"
18778 \begin_layout Labeling
18779 \labelwidthstring 00.00.0000
18782 svn update "<file-name>"
18783 \begin_inset Newline newline
18786 svn lock "<file-name>"
18789 \begin_layout Subsubsection
18792 \begin_inset CommandInset label
18794 name "subsec:Automatical-Locking-Property"
18800 Automatical Locking Property
18803 \begin_layout Standard
18804 The above mentioned automatical setting of write permissions of the .lyx
18805 file can be set through
18810 ile\SpecialChar \menuseparator
18816 \begin_inset space ~
18819 Control\SpecialChar \menuseparator
18824 oggle locking property
18827 This command is active only when the file is not locked on the svn server
18829 you need to check-out before proceeding).
18832 \begin_layout Labeling
18833 \labelwidthstring 00.00.0000
18835 \begin_inset space ~
18841 \begin_layout Labeling
18842 \labelwidthstring 00.00.0000
18845 svn propset svn:needs-lock ON "<file-name>"
18848 \begin_layout Labeling
18849 \labelwidthstring 00.00.0000
18852 svn propdel svn:needs-lock "<file-name>"
18855 \begin_layout Subsubsection
18856 Revision Information in Documents
18859 \begin_layout Standard
18860 Currently there is no way how to provide such kind of information directly
18862 There are possibilities how to activate it with the help of svn features,
18863 but each has its own drawbacks.
18866 \begin_layout Standard
18867 One possibility is to use svn keywords
18871 \begin_layout Plain Layout
18872 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
18878 In short -- you set file keywords property (e.g.
18881 svn propset svn:keywords 'Rev' file.lyx
18883 ) and then paste keyword ERT
18887 \begin_layout Plain Layout
18888 This is an easy way how to ensure that LyX won't break the line in the middle
18894 tag in your document (e.g.
18899 \begin_layout Plain Layout
18907 This way svn client will automatically substitute revision number (e.g.
18912 \begin_layout Plain Layout
18919 ) after each update and commit.
18920 There are more problems with this approach.
18921 Firstly, the '$' character is used in TeX world for math equations, so
18922 any occurence of math formula
18923 \begin_inset Formula $Rev$
18927 \begin_inset Formula $Rev:59$
18930 in your LyX document.
18931 Similarly for other keywords like Id, Date, Author, etc.
18932 Secondly svn output is dependent on your locales, so its very easy that
18933 svn would produce some problematic strings once Date is used.
18934 Thirdly you get the whole 'Rev: 59' string in your document instead of
18936 Until subversion implements user's custom keywords it will be hard to use
18937 this approach reliably or let LyX to support it directly .
18940 \begin_layout Standard
18941 The second possibility would be to write your own external-material template
18943 \begin_inset Flex CharStyle:Code
18946 \begin_layout Plain Layout
18952 utility or parses the output of
18953 \begin_inset Flex CharStyle:Code
18956 \begin_layout Plain Layout
18962 command and returns the result back, when typeseting the document.
18965 \begin_layout Subsection
18966 SVN and Windows Environment
18969 \begin_layout Quote
18970 My inclination is to say that if the user cannot figure out the command
18971 line operations on their own fairly quickly, they would be well advised
18972 to use TortoiseSVN.
18978 \begin_layout Subsubsection
18982 \begin_layout Standard
18983 In addition to installing LyX, and having access to a Subversion repository,
18984 the user will need to install the Subversion client program.
18985 A Windows installer for the client program is available from
18986 \begin_inset CommandInset href
18989 target "http://www.collab.net/nonav/downloads/subversion/"
18994 The user may also want to install
18995 \begin_inset CommandInset href
18998 target "http://tortoisesvn.tigris.org/"
19002 , which integrates Subversion operations into the context (rightclick) menu
19003 of Windows Explorer.
19004 Operations done outside LyX will typically be more convenient using the
19005 Explorer context menu.
19006 Note that TortoiseSVN is not a replacement for the client program, which
19007 is what LyX itself will use.
19010 \begin_layout Subsubsection
19011 Bringing a document under Subversion control
19014 \begin_layout Standard
19015 Before a LyX document can be brought under version control in Subversion,
19016 its parent directory needs to be under version control.
19017 If the document is being added to a project already in the repository,
19018 this is accomplished by checking the project out to the directory where
19019 the new document will be placed.
19020 If the project itself is not yet under version control (for instance, if
19021 this document starts a new project), the directory must be imported into
19023 This is done outside LyX.
19024 Both import and checkout are easily accomplished from the Explorer context
19025 menu using TortoiseSVN, or alternatively can be done using the command
19026 line client at a DOS prompt.
19027 The procedure for importing the project using TortoiseSVN is described
19028 below, assuming an existing repository and a new project being started
19036 For information on using the Subversion client program, run
19043 \begin_layout Enumerate
19050 in Windows Explorer, right click it, and select
19052 TortoiseSVN > Repo-browser
19055 If necessary, adjust the URL for the repository, then click OK.
19058 \begin_layout Enumerate
19059 Right click the level of the repository under which you want to place the
19060 new project folder (typically the top level) and click
19062 Create folder\SpecialChar \ldots{}
19065 Supply a name for the project folder and click OK.
19066 Add a message for the log file if desired, then click OK again.
19067 The new project folder should appear in the repository.
19068 Finally, click OK again to exit the repository browser.
19071 \begin_layout Enumerate
19072 Once again right click
19078 , this time selecting SVN Checkout\SpecialChar \ldots{}
19079 Select the URL of the project folder
19080 you just created in the repository, and set the checkout directory to
19088 You will be warned about a non-empty folder; click OK to proceed.
19089 You should now have a
19100 \begin_layout Enumerate
19101 Create or open your document in LyX and click
19106 ile\SpecialChar \menuseparator
19112 \begin_inset space ~
19115 Control\SpecialChar \menuseparator
19123 Add a log message and click OK to commit the document to version control.
19126 \begin_layout Standard
19127 From this point onward, you should have full functionality in the
19132 ile\SpecialChar \menuseparator
19138 \begin_inset space ~
19144 You also have the option of checking the document in and out, viewing its
19146 using the TortoiseSVN context menu in Windows Explorer or the Subversion
19147 client program from a command prompt.
19150 \begin_layout Subsection
19154 \begin_layout Standard
19155 With the recent addition of the vc-command function LyX power users are
19156 allowed to create their own commands for revision control.
19159 \begin_layout Standard
19160 As an example you can see how two TortoiseSVN commands could be integrated
19164 \begin_layout Description
19166 \begin_inset Flex CharStyle:Code
19169 \begin_layout Plain Layout
19170 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
19178 \begin_layout Description
19180 \begin_inset Flex CharStyle:Code
19183 \begin_layout Plain Layout
19184 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
19192 \begin_layout Section
19193 Literate Programming
19196 \begin_layout Standard
19201 (kayvan@sylvan.com)
19205 original documentation written by
19207 Edmar Wienskoski Jr.
19210 (edmar-w-jr@technologist.com)
19213 \begin_layout Subsection
19217 \begin_layout Standard
19218 The main purpose of this documentation is to show you how to use LyX for
19219 literate programming.
19220 Where it is assumed that you are familiar with this programming technique,
19222 \begin_inset Quotes eld
19226 \begin_inset Quotes erd
19230 \begin_inset Quotes eld
19234 \begin_inset Quotes erd
19238 If that is not the case, please follow the web links provided in the following
19240 There is a lot of good documentation out there covering old development
19241 history to the latest tools tips.
19244 \begin_layout Standard
19245 It is also assumed that you are familiar with LyX itself to a point that
19246 you are comfortable changing your LyX preferences, and X resources file.
19247 If that is not the case please refer to other LyX documentation to cover
19248 your specific needs.
19251 \begin_layout Subsection
19252 Literate Programming
19255 \begin_layout Standard
19256 From the Literate Programming FAQ:
19259 \begin_layout Quotation
19260 Literate programming is the combination of documentation and source together
19261 in a fashion suited for reading by human beings.
19262 In fact, literate programs should be enjoyable reading, even inviting!
19263 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
19264 and documentation in a single file.
19265 Literate programming tools then parse the file to produce either readable
19266 documentation or compilable source.
19267 The WEB style of literate programming was created by D.
19268 \begin_inset space \thinspace{}
19272 Knuth during the development of his TeX typesetting software.
19276 \begin_layout Standard
19277 Another excerpt says:
19280 \begin_layout Quotation
19283 How is literate programming different from verbose commenting?
19286 \begin_layout Quotation
19287 There are three distinguishing characteristics.
19288 In order of importance, they are:
19292 \begin_layout Itemize
19293 flexible order of elaboration
19296 \begin_layout Itemize
19297 automatic support for browsing
19300 \begin_layout Itemize
19301 typeset documentation, especially diagrams and mathematics
19305 \begin_layout Standard
19306 Now that I sparked your curiosity, take a look in the references.
19309 \begin_layout Subsubsection
19313 \begin_layout Standard
19314 The complete Literate Programming FAQ can be found at:
19317 \begin_layout Quote
19318 Literate Programming FAQ
19319 \begin_inset Flex URL
19322 \begin_layout Plain Layout
19324 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
19332 \begin_layout Standard
19333 The FAQ lists 23 (twenty three!) different literate programming tools.
19334 Where some are specialized or
19335 \begin_inset Quotes eld
19339 \begin_inset Quotes erd
19342 for particular programming languages, while other have general scope.
19347 for my own use for several reasons:
19350 \begin_layout Itemize
19351 It can generate the documentation either in LaTeX or HTML.
19354 \begin_layout Itemize
19355 It has a open architecture, i.
19356 \begin_inset space \thinspace{}
19360 \begin_inset space \space{}
19363 it is easy to plug in new filters and to perform special processing that
19368 \begin_layout Itemize
19369 There is a good selection of filters available already (the HTML is one
19373 \begin_layout Itemize
19377 \begin_layout Standard
19378 The Noweb web page can be found at:
19381 \begin_layout Quote
19383 \begin_inset Flex URL
19386 \begin_layout Plain Layout
19388 http://www.cs.virginia.edu/~nr/noweb/
19396 \begin_layout Standard
19397 Starting from there you can reach many other interesting links and even
19398 some literate program examples.
19401 \begin_layout Subsection
19402 LyX and Literate Programming
19405 \begin_layout Standard
19406 The LyX support for Literate Programming is provided by using the generic
19407 LyX converters mechanism.
19408 This support is provided in a
19409 \begin_inset Quotes eld
19413 \begin_inset Quotes erd
19417 \begin_inset space \thinspace{}
19421 \begin_inset space \space{}
19424 you will be able to use this new LyX feature with some other literate programmin
19425 g tool of your choice by just changing your LyX preferences.
19428 \begin_layout Subsubsection
19429 Generating documents and code (weaving and tangling)
19432 \begin_layout Paragraph
19433 Selecting the document class
19436 \begin_layout Standard
19437 If you have installed Noweb and LyX successfully, whenever you open a new
19438 document or try to change the document class of an existing one, you will
19439 find that there are three new document classes available:
19442 \begin_layout Itemize
19446 \begin_layout Itemize
19450 \begin_layout Itemize
19454 \begin_layout Standard
19455 You must select one of them to create your literate documents from.
19459 \begin_layout Standard
19460 Note that literate documents are not limited to these three classes.
19461 New classes can be generated from other styles like letter or in combination
19462 with other class variations like Article (AMS).
19463 If you have special needs that cannot be covered by one of the existing
19464 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
19465 will arrange to insert a new entry, or teach you how to do it.
19469 \begin_layout Plain Layout
19470 It is very simple, it involves the creation of a file with four lines, and
19471 re-running of the auto configuration.
19476 Moreover, if you use a literate tool other than Noweb you may need to create
19477 a new set of document classes for it.
19480 \begin_layout Paragraph
19484 \begin_layout Standard
19485 LyX enables you to write code with a layout named
19493 \begin_layout Plain Layout
19494 The equivalent Noweb term is
19495 \begin_inset Quotes eld
19499 \begin_inset Quotes erd
19503 For historical reasons, I got used to the term
19504 \begin_inset Quotes eld
19508 \begin_inset Quotes erd
19511 introduced by other literate tool named Nuweb, which I used for many years
19512 before rendering myself to Noweb.
19517 Noweb delimits scraps like this:
19520 \begin_layout LyX-Code
19524 \begin_layout LyX-Code
19528 \begin_layout LyX-Code
19532 \begin_layout LyX-Code
19536 \begin_layout LyX-Code
19540 \begin_layout Standard
19541 The problem is that whatever is written in between the << and the
19545 must be taken literally, i.
19546 \begin_inset space \thinspace{}
19550 \begin_inset space \space{}
19553 LyX should be prevented from making any special interpretation of what has
19555 This is handled by a special layout named Scrap, that works like a normal
19556 paragraph but has a free spacing capability.
19559 \begin_layout Standard
19560 The down side of the Scrap paragraph layout is that consecutive paragraphs
19561 of code will be spaced with one empty line in the source code and also
19562 in the printed documentation.
19563 The work around is to enter each line of code within a single Scrap, with
19564 a newline (ctrl-return).
19565 The example above will look like this:
19569 \begin_layout Plain Layout
19570 If you have a printed version of this document you will not see any difference
19571 between the previous example and this one.
19579 \begin_layout LyX-Code
19581 \begin_inset Newline newline
19585 \begin_inset Newline newline
19589 \begin_inset Newline newline
19593 \begin_inset Newline newline
19599 \begin_layout Standard
19600 This layout works fine.
19601 The only real inconvenience is that you have to type ctrl-return instead
19606 \begin_layout Plain Layout
19607 It is in my list of
19608 \begin_inset Quotes eld
19612 \begin_inset Quotes erd
19623 \begin_layout Standard
19624 As a special note, you can also use the
19625 \begin_inset Quotes eld
19629 \begin_inset Quotes erd
19632 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
19636 \begin_layout LyX-Code
19638 \begin_inset Newline newline
19641 def some_function(args):
19642 \begin_inset Newline newline
19645 "This is the doc string for this function."
19646 \begin_inset Newline newline
19649 print "My args: ", args
19652 \begin_layout LyX-Code
19653 @ %def some_function
19656 \begin_layout Standard
19657 For an example of this usage and the resulting cross-reference output, look
19658 at the Literate python program in
19660 LIBDIR/examples/listerrors.lyx
19662 which should make this all clear.
19665 \begin_layout Paragraph
19666 Generating the documentation
19669 \begin_layout Standard
19670 At this point you already have a new document file with a proper document
19671 class, and with some code and text on it.
19672 How do I print it? The answer is simple, you select
19674 View\SpecialChar \menuseparator
19678 Just like you would do for a plain document.
19679 No special procedure is required.
19682 \begin_layout Standard
19683 To help orientate you, I will now explain what happens inside LyX:
19686 \begin_layout Enumerate
19689 Update\SpecialChar \menuseparator
19692 menu option is chosen, a LaTeX file is generated.
19697 \begin_layout Standard
19698 If the document is of any literate class the generated file will be named
19699 with an extension name defined by the
19700 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19707 format (defined in the Preferences panel), otherwise the file will have
19716 \begin_layout Enumerate
19717 Note that the only difference so far is in the name of the file, no special
19718 processing is required by LyX.
19719 Given that you formatted the code using the Scrap layout that, by itself,
19720 takes care of the business.
19723 \begin_layout Enumerate
19724 If the document is of any literate class LyX will then use the internal
19725 LyX to Noweb converter, followed by the Noweb to LaTeX converter
19729 \begin_layout Plain Layout
19730 The converters are defined in the
19732 Tools\SpecialChar \menuseparator
19736 \begin_inset Quotes eld
19740 \begin_inset Quotes erd
19752 manual for general information about converters.
19757 to generate the LaTeX file.
19761 \begin_layout Standard
19762 Otherwise it will just skip this step.
19766 \begin_layout Enumerate
19767 Finally, LaTeX is invoked and the regular post processing continues as in
19771 \begin_layout Standard
19772 Independence from a particular
19773 \begin_inset Quotes eld
19777 \begin_inset Quotes erd
19780 is easily achieved by changing the commands that are run by the various
19784 \begin_layout Paragraph
19785 Generating the code
19788 \begin_layout Standard
19789 When the build menu option is chosen or the corresponding button in the
19790 toolbar is pressed, a LaTeX file is generated just like step 1 above.
19791 Next, LyX invokes the
19796 This converter needs to be defined by the user and is not installed by
19797 default, though the Program format is.
19798 This converter (like any other converter) will have two parts:
19801 \begin_layout Enumerate
19802 The converter program itself.
19803 This program performs the conversion from the one format to the other (in
19804 this case, from the Noweb format to the Program pseudo-format).
19807 \begin_layout Enumerate
19808 The error log parser.
19809 This is a program whose sole purpose is to rewrite error messages in a
19810 format that LyX understands.
19811 This makes it possible for LyX to place error boxes in the right places
19812 in the file buffer.
19815 \begin_layout Standard
19816 The first part, the
19817 \begin_inset Quotes eld
19821 \begin_inset Quotes erd
19824 setting, should be set to
19825 \begin_inset Quotes eld
19833 \begin_inset Quotes erd
19837 This basically means that LyX will call
19838 \begin_inset Quotes eld
19842 \begin_inset Quotes erd
19845 (a program or script) with the name of the Noweb file (normally a file
19846 in the LyX temp directory).
19850 \begin_layout Standard
19851 This is an implementation of
19852 \begin_inset Quotes eld
19856 \begin_inset Quotes erd
19859 that you can place in a directory on your path:
19862 \begin_layout LyX-Code
19866 \begin_layout LyX-Code
19870 \begin_layout LyX-Code
19871 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
19874 \begin_layout Standard
19875 The next part of the converter setting is the
19876 \begin_inset Quotes eld
19880 \begin_inset Quotes erd
19883 which is to be set to
19884 \begin_inset Quotes eld
19889 parselog=listerrors
19892 \begin_inset Quotes erd
19896 This will run any errors that are generated by the
19897 \begin_inset Quotes eld
19901 \begin_inset Quotes erd
19904 process through the
19905 \begin_inset Quotes eld
19909 \begin_inset Quotes erd
19915 \begin_layout Standard
19916 The converter code looks in
19924 then on the path for the
19925 \begin_inset Quotes eld
19929 \begin_inset Quotes erd
19935 \begin_layout Standard
19936 The build will normally take place in LyX's temporary directory, so the
19937 files produced by the conversion will be in that directory.
19938 LyX will copy out what it regards as the `main' file, but the
19942 conversion may produce several files, and so most of these would then be
19943 deleted when LyX was closed.
19944 The present solution is to use a `copier',
19948 \begin_layout Plain Layout
19957 manual for information on these.
19966 script in its default mode, so that the entire contents of the temporary
19967 directory is copied.
19968 More will get copied than is needed, to be sure, but nothing will be lost.
19969 If, however, you know what extensions the generated files will have, this
19970 can be improved by using the
19979 This option takes a comma-separated list of extensions to copy.
19980 So, for example, if the conversion will generate only files with the extensions
19989 , then the correct definition would be:
19992 \begin_layout LyX-Code
19993 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
19996 \begin_layout Standard
19997 The result will be that only files with these two extensions will be copied
20001 \begin_layout Paragraph
20002 Build instructions in the document
20005 \begin_layout Standard
20006 The last piece of the integration between LyX and noweb is the
20007 \begin_inset Quotes eld
20011 \begin_inset Quotes erd
20015 Generally, the instructions for building your program should be embedded
20016 in a scrap of its own.
20018 \begin_inset Quotes eld
20022 \begin_inset Quotes erd
20025 above uses the notangle command to look for this scrap (called
20026 \begin_inset Quotes eld
20030 \begin_inset Quotes erd
20033 ) and runs its contents through
20034 \begin_inset Quotes eld
20038 \begin_inset Quotes erd
20044 \begin_layout Standard
20045 Typically, such a scrap would look something like this:
20048 \begin_layout LyX-Code
20050 \begin_inset Newline newline
20054 \begin_inset Newline newline
20058 \begin_inset Newline newline
20061 if [ -z "${NOWEB_SOURCE}" ]
20062 \begin_inset Newline newline
20066 \begin_inset Newline newline
20069 NOWEB_SOURCE=myfile.nw
20070 \begin_inset Newline newline
20074 \begin_inset Newline newline
20078 code to extract files ...]
20079 \begin_inset Newline newline
20083 code to compile files ...]
20084 \begin_inset Newline newline
20090 \begin_layout Standard
20093 LIBDIR/examples/listerrors.lyx
20097 LIBDIR/examples/Literate.lyx
20099 which implement two versions of the
20100 \begin_inset Quotes eld
20104 \begin_inset Quotes erd
20107 program for some illustrations of how all of these pieces go together or
20110 LIBDIR/examples/noweb2lyx.lyx.
20113 Interestingly, these three files show off the language-indepence of the
20114 LyX literate programming support since they are written in Python, C and
20118 \begin_layout Subsubsection
20122 \begin_layout Standard
20123 All the Literate Programming support is configured by the
20125 Tools\SpecialChar \menuseparator
20129 \begin_inset Quotes eld
20133 \begin_inset Quotes erd
20137 The important parts are:
20140 \begin_layout Description
20142 \begin_inset space ~
20146 \begin_inset Quotes eld
20150 \begin_inset Quotes erd
20154 \begin_inset space ~
20157 format Set up via the Formats tab, this is where the Noweb-specific pieces
20167 , the file extension is set to
20172 This tells LyX to create a file with a
20176 extension in the first step of the conversion process.
20179 \begin_layout Description
20181 \begin_inset space ~
20189 \begin_inset space ~
20192 format This is an empty format whose sole purpose is to be the endpoint
20193 of a conversion (which then allows us to set up a converter for it).
20196 \begin_layout Description
20205 This converter performs the
20206 \begin_inset Quotes eld
20210 \begin_inset Quotes erd
20213 of the literate document.
20214 For Noweb, it is set to
20215 \begin_inset Quotes eld
20220 noweave -delay -index $$i > $$o
20223 \begin_inset Quotes erd
20229 \begin_layout Description
20239 \begin_inset Quotes eld
20243 \begin_inset Quotes erd
20247 As stated above, the Converter is set to
20248 \begin_inset Quotes eld
20256 \begin_inset Quotes erd
20259 , with Flags set to
20260 \begin_inset Quotes eld
20265 originaldir,parselog=listerrors
20268 \begin_inset Quotes erd
20274 \begin_layout Subsubsection
20278 \begin_layout Standard
20279 There is also a new function implemented in the LyX server, the
20280 \begin_inset Quotes eld
20283 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
20287 \begin_layout Standard
20288 When debugging code with ddd/gdb, it is possible to invoke a text editor
20289 at the current execution position with a single key stroke.
20290 The default ddd configuration for that is shift-ctrl-V.
20291 It happens that you can define the editor command line invocation in ddd
20294 Edit\SpecialChar \menuseparator
20295 Preferences\SpecialChar \menuseparator
20298 dialog and changing the "Edit Sources" entry.
20301 \begin_layout Standard
20302 I take advantage of the new created LyX server function and this ddd feature,
20304 \begin_inset Quotes eld
20308 \begin_inset Quotes erd
20314 \begin_layout LyX-Code
20315 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
20318 \begin_layout Standard
20319 With this, whenever you are using ddd and find a point in the program that
20320 you want to edit, you just press shift-ctrl-V (in the ddd window), and
20321 ddd you forward this information to LyX through the LyX server and then
20322 the LyX window will show the same file with the cursor at the same position
20323 ddd was pointing to.
20324 No more guessing or long scrolling to locate a point in the program back
20328 \begin_layout Standard
20329 Note however that you must enable the LyX server to get this feature working
20330 (it is disabled by default).
20331 You can enable it in
20343 ) by entering in the
20348 \begin_inset Quotes eld
20353 /home/<your-home-directory>/.lyx/lyxpipe
20356 \begin_inset Quotes erd
20362 \begin_layout Standard
20363 Read the LyX server documentation in the
20365 Customization Manual
20367 for further information.
20370 \begin_layout Subsubsection
20374 \begin_layout Standard
20375 There are six new buttons that can be added to your LyX toolbar.
20376 Five of these buttons are short cuts to layout styles:
20397 The last one is a short cut to the
20398 \begin_inset Quotes eld
20402 \begin_inset Quotes erd
20409 \begin_layout Standard
20410 LyX has a range of buttons that are available for tool bar customization.
20411 In my toolbar I like to combine the six short cuts above with two more:
20416 \SpecialChar \menuseparator
20421 \SpecialChar \menuseparator
20428 View\SpecialChar \menuseparator
20432 Here is how it looks like:
20435 \begin_layout LyX-Code
20439 \begin_layout LyX-Code
20443 \begin_layout LyX-Code
20444 Icon "layout Standard"
20447 \begin_layout LyX-Code
20448 Icon "layout Section"
20451 \begin_layout LyX-Code
20452 Icon "layout LaTeX"
20455 \begin_layout LyX-Code
20456 Icon "layout LyX-Code"
20459 \begin_layout LyX-Code
20460 Icon "layout Scrap"
20463 \begin_layout LyX-Code
20467 \begin_layout LyX-Code
20471 \begin_layout LyX-Code
20472 Icon "buffer-typeset"
20475 \begin_layout LyX-Code
20476 Icon "build-program"
20479 \begin_layout LyX-Code
20483 \begin_layout LyX-Code
20487 \begin_layout LyX-Code
20491 \begin_layout LyX-Code
20495 \begin_layout LyX-Code
20499 \begin_layout Subsubsection
20500 Colors customization
20503 \begin_layout Standard
20504 There are a number of colors in LyX that can be customized in
20509 One of the things that bothers people is the LaTeX font color.
20510 The default color is red, since the scraps uses LaTeX font, and there is
20511 a lot of scraps in literate documents, you may get tired of seeing everything
20513 You can change it by going to the tabs
20522 \begin_layout Standard
20523 The next thing is the visible presence of the newline character in the screen.
20524 You can choose the color of this particular character and make it blend
20526 I recommend you choosing a color that is close to the background but not
20527 equal, that way you still can see it is there, but it is not bothering
20532 \begin_layout Chapter
20533 Secrets of the LaTeX Masters
20534 \begin_inset CommandInset label
20543 \begin_layout Standard
20544 Though LyX is a powerful tool, it cannot hope to support everything that
20545 can be done with pure TeX/LaTeX.
20546 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
20547 as long as you are not afraid to use that
20548 \begin_inset Quotes eld
20552 \begin_inset Quotes erd
20555 button on the toolbar or add things to the LaTeX preamble.
20556 This section lists some tips, tricks, and otherwise cool ideas to give
20557 your document that extra little flair.
20560 Do try this at home
20562 , just start with something a little smaller and less important than your
20566 \begin_layout Standard
20567 Most ideas in this section require less common files in your LaTeX installation.
20568 If you have a system like teTeX, most will already be available.
20569 A few, however, will need to be downloaded from one of the CTAN archives.
20570 Often, there are several ways to do something, or several LaTeX style files
20571 which do the same thing.
20572 We do not endorse one choice over another, we simply claim that we have
20573 done a particular task with a particular file.
20574 Put on your wizard hat, keep an eye out for dragons, and let us begin.
20577 \begin_layout Section
20581 \begin_layout Standard
20584 Lars Gullik Bjønnes
20587 \begin_layout Subsection
20591 \begin_layout Standard
20592 The aim for this chapter
20596 \begin_layout Plain Layout
20597 Editor's note: Lars' original chapter was a masterful description of how
20603 However, it was too long to flow smoothly in this document.
20604 I have therefore chosen to excerpt the most important sections here (sorry,
20605 Lars); you can read the original chapter (and more of the story!) in the
20608 examples/multicol.lyx
20616 is to show how the LaTeX package
20620 can be used in a LyX document.
20621 As LyX doesn't support the
20625 package natively yet, we have to use some small hacks.
20626 By reading this section it should be obvious how to do this.
20629 \begin_layout Subsection
20633 \begin_layout Standard
20638 package allows switching between one and multicolumn format on the same
20640 Footnotes are handled correctly (for the most part), but will be placed
20641 at the bottom of the page and not under each column.
20642 LaTeX's float mechanism, however, is partly disabled in the current implementat
20644 At the moment only page-wide floats can be used within the scope of the
20648 \begin_layout Subsection
20652 \begin_layout Subsubsection
20656 \begin_layout Standard
20657 If you want to have two columns in your text, you have use LaTeX mode to
20662 begin{multicols}{2}
20664 at the point where you want the two column layout to start, and then
20670 where you want it to end.
20674 \begin_layout Standard
20678 \begin_layout Plain Layout
20682 begin{multicols}{2}
20690 \begin_layout Standard
20695 The Adventure of the Empty House
20698 \begin_inset Newline newline
20703 Sir Arthur Conan Doyle
20706 \begin_layout Standard
20709 It was in the spring of the year 1894 that all London was interested, and
20710 the fashionable world dismayed, by the murder of the Honourable Ronald
20711 Adair under most unusual and inexplicable circumstances.
20712 The public has already learned those particulars of the crime which came
20713 out in the police investigation, but a good deal was suppressed upon that
20714 occasion, since the case for the prosecution was so overwhelmingly strong
20715 that it was not necessary to bring forward all the facts.
20716 Only now, at the end of nearly ten years, am I allowed to supply those
20717 missing links which make up the whole of that remarkable chain.
20718 The crime was of interest in itself, but that interest was as nothing to
20719 me compared to the inconceivable sequel, which afforded me the greatest
20720 shock and surprise of any event in my adventurous life.
20721 Even now, after this long interval, I find myself thrilling as I think
20722 of it, and feeling once more that sudden flood of joy, amazement, and increduli
20723 ty which utterly submerged my mind.
20724 Let me say to that public, which has shown some interest in those glimpses
20725 which I have occasionally given them of the thoughts and actions of a very
20726 remarkable man, that they are not to blame me if I have not shared my knowledge
20727 with them, for I should have considered it my first duty to do so, had
20728 I not been barred by a positive prohibition from his own lips, which was
20729 only withdrawn upon the third of last month.
20732 \begin_layout Standard
20736 \begin_layout Plain Layout
20748 \begin_layout Subsubsection
20752 \begin_layout Standard
20753 The same pattern is used when you want more than two columns:
20756 \begin_layout Standard
20760 \begin_layout Plain Layout
20764 begin{multicols}{3}
20772 \begin_layout Standard
20775 It can be imagined that my close intimacy with Sherlock Holmes had interested
20776 me deeply in crime, and that after his disappearance I never failed to
20777 read with care the various problems which came before the public.
20778 And I even attempted, more than once, for my own private satisfaction,
20779 to employ his methods in their solution, though with indifferent success.
20780 There was none, however, which appealed to me like this tragedy of Ronald
20782 As I read the evidence at the inquest, which led up to a verdict of willful
20783 murder against some person or persons unknown, I realized more clearly
20784 than I had ever done the loss which the community had sustained by the
20785 death of Sherlock Holmes.
20786 There were points about this strange business which would, I was sure,
20787 have specially appealed to him, and the efforts of the police would have
20788 been supplemented, or more probably anticipated, by the trained observation
20789 and the alert mind of the first criminal agent in Europe.
20790 All day, as I drove upon my round, I turned over the case in my mind and
20791 found no explanation which appeared to me to be adequate.
20792 At the risk of telling a twice-told tale, I will recapitulate the facts
20793 as they were known to the public at the conclusion of the inquest.
20796 \begin_layout Standard
20800 \begin_layout Plain Layout
20812 \begin_layout Standard
20813 You can have more than 3 columns if you want to, but that might not be very
20814 pleasant for the eye.
20817 \begin_layout Subsubsection
20818 Columns inside columns
20821 \begin_layout Standard
20822 You can even have columns inside columns:
20825 \begin_layout Standard
20829 \begin_layout Plain Layout
20833 begin{multicols}{2}
20841 \begin_layout Standard
20844 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20845 at that time governor of one of the Australian colonies.
20846 Adair's mother had returned from Australia to undergo the operation for
20847 cataract, and she, her son Ronald, and her daughter Hilda were living together
20851 \begin_layout Standard
20855 \begin_layout Plain Layout
20859 begin{multicols}{2}
20867 \begin_layout Standard
20870 The youth moved in the best society–had, so far as was known, no enemies
20871 and no particular vices.
20872 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
20873 had been broken off by mutual consent some months before, and there was
20874 no sign that it had left any very profound feeling behind it.
20875 For the rest {sic} the man's life moved in a narrow and conventional circle,
20876 for his habits were quiet and his nature unemotional.
20877 Yet it was upon this easy-going young aristocrat that death came, in most
20878 strange and unexpected form, between the hours of ten and eleven-twenty
20879 on the night of March 30, 1894.
20882 \begin_layout Standard
20886 \begin_layout Plain Layout
20898 \begin_layout Standard
20901 Ronald Adair was fond of cards–playing continually, but never for such stakes
20903 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
20904 It was shown that, after dinner on the day of his death, he had played
20905 a rubber of whist at the latter club.
20906 He had also played there in the afternoon.
20911 The evidence of those who had played with him– Mr.
20912 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
20913 and that there was a fairly equal fall of the cards.
20914 Adair might have lost five pounds, but not more.
20915 His fortune was a considerable one, and such a loss could not in any way
20917 He had played nearly every day at one club or other, but he was a cautious
20918 player, and usually rose a winner.
20919 It came out in evidence that, in partnership with Colonel Moran, he had
20920 actually won as much as four hundred and twenty pounds in a sitting, some
20921 weeks before, from Godfrey Milner and Lord Balmoral.
20922 So much for his recent history as it came out at the inquest.
20925 \begin_layout Standard
20929 \begin_layout Plain Layout
20941 \begin_layout Standard
20942 Please do read the file
20944 examples/multicol.lyx
20946 for more advanced examples including column and header spacing, vertical
20947 separator lines, and more.
20950 \begin_layout Section
20955 Paragraph Environment
20956 \begin_inset OptArg
20959 \begin_layout Plain Layout
20960 Numbering in Enumerate
20968 \begin_layout Standard
20974 \begin_layout Standard
20975 \begin_inset VSpace bigskip
20981 \begin_layout Standard
20983 The default numbering for the
20987 paragraph environment begins with Arabic numbers and ends with uppercase
20989 Suppose, however, you wanted a different type of numbering scheme.
20990 Here's a quickie example of how to change the numbering scheme:
20993 \begin_layout LyX-Code
21003 \begin_layout LyX-Code
21013 \begin_layout LyX-Code
21023 \begin_layout LyX-Code
21033 \begin_layout Standard
21034 \SpecialChar \ldots{}
21035 which changes the numbering scheme to uppercase Roman numerals, uppercase
21036 letters, Arabic numbers, and lowercase letter.
21039 \begin_layout Standard
21040 Additionally, the previous example also adds a little bit extra to the numbering
21042 For example, the first level label actually looks like:
21043 \begin_inset Quotes eld
21047 \begin_inset Quotes erd
21051 For ease of reading, we'll describe what the numbering schemes look like
21052 using a notation something like this: <
21053 \begin_inset Quotes eld
21057 \begin_inset Quotes erd
21061 \begin_inset space ~
21065 \begin_inset Quotes erd
21069 \begin_inset Quotes erd
21073 \begin_inset space ~
21077 \begin_inset Quotes erd
21081 \begin_inset Quotes erd
21085 \begin_inset space ~
21089 \begin_inset Quotes eld
21093 \begin_inset Quotes erd
21100 \begin_layout Standard
21101 As you can see in the example, there is a label command for each nesting
21108 \SpecialChar \ldots{}
21115 , as well as a counter,
21119 \SpecialChar \ldots{}
21125 There are also five
21126 \begin_inset Quotes eld
21130 \begin_inset Quotes erd
21163 , each of which take one counter as an argument.
21164 You can add characters before or after these, but there's no need to add
21168 \begin_layout Standard
21169 You can get really fancy with these.
21173 \begin_layout LyX-Code
21187 \begin_layout LyX-Code
21199 \begin_layout LyX-Code
21209 \begin_layout LyX-Code
21219 \begin_layout Standard
21220 produces the somewhat out of hand numbering scheme: <
21221 \begin_inset Quotes eld
21225 \begin_inset Quotes erd
21229 \begin_inset space ~
21233 \begin_inset Quotes erd
21237 \begin_inset Quotes erd
21241 \begin_inset space ~
21245 \begin_inset Quotes erd
21249 \begin_inset Quotes erd
21253 \begin_inset space ~
21257 \begin_inset Quotes eld
21261 \begin_inset Quotes erd
21268 \begin_layout Standard
21272 \begin_layout Section
21276 \begin_layout Standard
21282 \begin_layout Standard
21283 \begin_inset VSpace bigskip
21289 \begin_layout Standard
21294 \begin_layout Plain Layout
21300 tmpfont}{cmr17 scaled 2500}{
21312 \begin_layout Standard
21317 \begin_layout Plain Layout
21328 hose of you who like the style of old books probably also like
21329 \begin_inset Quotes eld
21333 \begin_inset Quotes erd
21336 —those large capital letters which begin each new chapter or section.
21337 Implementing them with plain LyX/LaTeX is straightforward (assuming you
21338 know some plain TeX!) but does require a lot of work and many iterations,
21339 as you can see by all the ugly TeX-mode stuff at the beginning of this
21343 \begin_layout Standard
21347 \begin_layout Plain Layout
21353 bigdrop{-1em}{3}{ptmri}{T}+
21358 here is a much easier way of doing this, of course.
21367 ) package from CTAN allows a simple way to add such letters to your documents.
21368 Since this package is not a standard part of teTeX, I can't demonstrate
21369 it within this document, but if you copy this paragraph to a new document,
21371 \begin_inset Quotes eld
21381 \begin_inset Quotes erd
21384 and the pluses from the TeX code at the beginning of the paragraph, and
21389 usepackage{dropcaps}
21391 to your LaTeX preamble, you will get a nice Times Roman Italic
21392 \begin_inset Quotes eld
21396 \begin_inset Quotes erd
21399 , whose height is three lines of text and which protrudes 1 em into the
21401 (Make certain you have copied
21402 \begin_inset Quotes eld
21410 \begin_inset Quotes erd
21413 into a directory where TeX can see it.) The first argument is the amount
21414 of indentation; in this case the negative sign moves it into the margin.
21415 The second argument is the height of the letter in number of lines of text.
21416 The third argument is the font name: virtually anything which has a tfm
21417 file should work (wade through the
21419 .../texmf/fonts/tfm
21421 directory for possibilities).
21422 My personal favorite is
21423 \begin_inset Quotes eld
21431 \begin_inset Quotes erd
21434 , a fancy German font specifically designed for dropped capitals.
21435 The fourth argument is the letter (or letters) to be dropped.
21440 package also offers the
21446 command, as well as a slightly simplified
21455 \begin_layout Section
21456 Non-standard Paragraph Shapes
21459 \begin_layout Standard
21465 \begin_layout Standard
21466 \begin_inset VSpace bigskip
21472 \begin_layout Standard
21476 \begin_layout Plain Layout
21488 \begin_layout Standard
21492 \begin_layout Plain Layout
21501 \begin_layout Plain Layout
21515 \begin_layout Standard
21520 \begin_layout Plain Layout
21531 \begin_layout Plain Layout
21540 \begin_layout Plain Layout
21549 \begin_layout Plain Layout
21558 \begin_layout Plain Layout
21567 \begin_layout Plain Layout
21576 \begin_layout Plain Layout
21585 \begin_layout Plain Layout
21594 \begin_layout Plain Layout
21603 \begin_layout Plain Layout
21612 \begin_layout Plain Layout
21621 \begin_layout Plain Layout
21630 \begin_layout Plain Layout
21639 \begin_layout Plain Layout
21648 \begin_layout Plain Layout
21657 \begin_layout Plain Layout
21666 \begin_layout Plain Layout
21675 \begin_layout Plain Layout
21684 \begin_layout Plain Layout
21693 \begin_layout Plain Layout
21699 There are times when the tyranny of rectangular paragraphs must be overthrown.
21700 In such situations, a call to the delightful plain TeX command
21707 As you can see, completely arbitrary shapes can be laid out with a suitable
21708 set of linelength definitions.
21709 While this parshape may look a bit silly and useless, one could conceive
21710 of situations such as finely tuned dropped capitals, word wrapping around
21711 non-rectangular graphics, etc.
21712 which will benefit from such handcrafting.
21715 \begin_layout Standard
21716 \begin_inset VSpace bigskip
21722 \begin_layout Standard
21727 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
21734 is the number of lines of text which define the paragraph.
21735 If there turn out to be fewer lines, the shape is truncated; if there are
21736 more, the excess lines have the same dimensions as the last line of the
21746 entries specify the indentation of the line from the left margin, and the
21747 length of the line as measured from that point.
21748 The shape applies only to the current paragraph; everything is reset to
21749 normal for the next paragraph.
21752 \begin_layout Standard
21756 \begin_layout Plain Layout
21768 \begin_layout Section
21772 \begin_layout Standard
21773 As you can see, the examples in this section range from the useful to the
21775 While I don't expect that anyone will ever need the paragraph shape demonstrate
21776 d in the last section, the important point is that you can do almost anything
21777 you want in LyX if you are willing to figure out how to do it in TeX and
21779 TeX is a fantastically powerful typesetting system and all that power is
21780 available to you since LyX uses it as its backend.